Added wave_create_and_pad to pigpio.py

This commit is contained in:
Jul3k 2020-03-05 18:26:08 +01:00
parent 4ab125cfff
commit a9f5dc17d9
1 changed files with 37 additions and 0 deletions

View File

@ -571,6 +571,7 @@ _PI_CMD_EVM =115
_PI_CMD_EVT =116
_PI_CMD_PROCU=117
_PI_CMD_WVCAP=118
# pigpio error numbers
@ -2304,6 +2305,42 @@ class pi():
"""
return _u2i(_pigpio_command(self.sl, _PI_CMD_WVCRE, 0, 0))
def wave_create_and_pad(self, percent):
"""
This function creates a waveform like wave_create but pads the consumed
resources. Where percent gives the percentage of the resources to use (in terms
of the theoretical maximum, not the current amount free). This allows the reuse
of deleted waves while a transmission is active. Upon success a wave id
greater than or equal to 0 is returned, otherwise PI_EMPTY_WAVEFORM,
PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
. .
pi: >=0 (as returned by [*pigpio_start*]).
. .
The data provided by the [*wave_add_**] functions is consumed by this
function.
As many waveforms may be created as there is space available. The
wave id is passed to [*wave_send_**] to specify the waveform to transmit.
A usage would be the creation of two waves where one is filled while the other
is beeing transmitted. Each wave is assigned 50% of the available resources.
This buffer structure allows the transmission of infinite wave sequences.
Step 1. [*wave_clear*] to clear all waveforms and added data.
Step 2. [*wave_add_**] calls to supply the waveform data.
Step 3. [*wave_create_and_pad*] to create a 50% padded waveform and get a unique id
Step 4. [*wave_send_**] with the id of the waveform to transmit.
Repeat steps 2-4 as needed always waiting for the active waveform to be transmitted
before marking it as deleted.
"""
return _u2i(_pigpio_command(self.sl, _PI_CMD_WVCAP, percent, 0))
def wave_delete(self, wave_id):
"""
This function deletes the waveform with id wave_id.