mirror of https://github.com/joan2937/pigpio
Fix doc generation warnings and other doc source corrections.
This commit is contained in:
parent
3ffe6634bd
commit
c80201f964
|
@ -1715,6 +1715,12 @@ The mA which may be drawn from each GPIO whilst still guaranteeing the
|
||||||
high and low levels.
|
high and low levels.
|
||||||
<h3><a name="*param">*param</a></h3>
|
<h3><a name="*param">*param</a></h3>
|
||||||
An array of script parameters.
|
An array of script parameters.
|
||||||
|
<h3><a name="pctBOOL">pctBOOL</a>: 0-100</h3>
|
||||||
|
percent On-Off-Level (OOL) buffer to consume for wave output.
|
||||||
|
<h3><a name="pctCB">pctCB</a>: 0-100</h3>
|
||||||
|
the percent of all DMA control blocks to consume.
|
||||||
|
<h3><a name="pctTOOL">pctTOOL</a>: 0-100</h3>
|
||||||
|
the percent of OOL buffer to consume for wave input (flags).
|
||||||
<h3><a name="pi_i2c_msg_t">pi_i2c_msg_t</a></h3>
|
<h3><a name="pi_i2c_msg_t">pi_i2c_msg_t</a></h3>
|
||||||
<code>typedef struct<br>{<br> uint16_t addr; // slave address<br> uint16_t flags;<br> uint16_t len; // msg length<br> uint8_t *buf; // pointer to msg data<br>} pi_i2c_msg_t;<br></code><h3><a name="port">port</a>: 1024-32000</h3>
|
<code>typedef struct<br>{<br> uint16_t addr; // slave address<br> uint16_t flags;<br> uint16_t len; // msg length<br> uint8_t *buf; // pointer to msg data<br>} pi_i2c_msg_t;<br></code><h3><a name="port">port</a>: 1024-32000</h3>
|
||||||
The port used to bind to the pigpio socket. Defaults to 8888.
|
The port used to bind to the pigpio socket. Defaults to 8888.
|
||||||
|
@ -1873,7 +1879,7 @@ A 16-bit word value.
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -113,7 +113,7 @@ sudo apt-get install pigpio python-pigpio python3-pigpio</code><br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -197,7 +197,7 @@ Gnuplot readings 18-21 seconds
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -300,7 +300,7 @@ viewed using GTKWave.</p>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -301,7 +301,7 @@ PI_OUTPUT);<br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -232,7 +232,7 @@ before completing the level transition<br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -211,7 +211,7 @@ plot 'sonar-secs.dat' title 'Sonar'<br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -550,7 +550,7 @@ Related code.<br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -508,7 +508,7 @@ should I use?</h3>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -708,7 +708,7 @@ Hirst's <a href="https://github.com/richardghirst/PiBits" target=
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -80,7 +80,7 @@ VCD can be read by many programs, in particular <a href=
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -1160,7 +1160,7 @@ A 16-bit word value.
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -568,18 +568,16 @@ specified delay between the pulse and the next.
|
||||||
<br><br>Returns the new waveform id if OK, otherwise PI_EMPTY_WAVEFORM,
|
<br><br>Returns the new waveform id if OK, otherwise PI_EMPTY_WAVEFORM,
|
||||||
PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.
|
PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.
|
||||||
<h3><a name="wave_create_and_pad"></a><a href="#int"><small>int</small></a> wave_create_and_pad<small>(<a href="#int">int</a> <a href="#pi">pi</a>, <a href="#int">int</a> <a href="#percent">percent</a>)</small></h3>
|
<h3><a name="wave_create_and_pad"></a><a href="#int"><small>int</small></a> wave_create_and_pad<small>(<a href="#int">int</a> <a href="#pi">pi</a>, <a href="#int">int</a> <a href="#percent">percent</a>)</small></h3>
|
||||||
This function creates a waveform like wave_create but pads the consumed
|
This function creates a waveform like <a href="#wave_create">wave_create</a> but pads the consumed
|
||||||
resources. Where percent gives the percentage of the resources to use (in terms
|
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<br>
|
of the theoretical maximum, not the current amount free). This allows the reuse<br>
|
||||||
of deleted waves while a transmission is active. Upon success a wave id
|
of deleted waves while a transmission is active.
|
||||||
greater than or equal to 0 is returned, otherwise PI_EMPTY_WAVEFORM,
|
<br><br><code>pi: >=0 (as returned by <a href="#pigpio_start">pigpio_start</a>).<br>percent: 0-100, size of waveform as percentage of maximum available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
||||||
PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
|
||||||
<br><br><code>pi: >=0 (as returned by <a href="#pigpio_start">pigpio_start</a>).<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
|
||||||
function.
|
function.
|
||||||
<br><br>As many waveforms may be created as there is space available. The
|
<br><br>As many waveforms may be created as there is space available. The
|
||||||
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
||||||
<br><br>A usage would be the creation of two waves where one is filled while the other
|
<br><br>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.
|
is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
<br><br>Normal usage:
|
<br><br>Normal usage:
|
||||||
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
||||||
|
@ -1388,6 +1386,8 @@ The mA which may be drawn from each GPIO whilst still guaranteeing the
|
||||||
high and low levels.
|
high and low levels.
|
||||||
<h3><a name="*param">*param</a></h3>
|
<h3><a name="*param">*param</a></h3>
|
||||||
An array of script parameters.
|
An array of script parameters.
|
||||||
|
<h3><a name="percent">percent</a>: 0-100</h3>
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
<h3><a name="pi">pi</a></h3>
|
<h3><a name="pi">pi</a></h3>
|
||||||
An integer defining a connected Pi. The value is returned by
|
An integer defining a connected Pi. The value is returned by
|
||||||
<a href="#pigpio_start">pigpio_start</a> upon success.
|
<a href="#pigpio_start">pigpio_start</a> upon success.
|
||||||
|
@ -1515,7 +1515,7 @@ A 16-bit word value.
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -77,7 +77,7 @@ The format of the commands is identical to those used by <a href=
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -75,7 +75,7 @@ The state lines contain the new state followed by the gpio identifier.
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -106,7 +106,7 @@ The USB power mode is fixed at 1.2 amps (high power).<br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -944,7 +944,7 @@ set all the fields to zero (the pulse will be ignored).
|
||||||
<br><br>When a waveform is started each pulse is executed in order with
|
<br><br>When a waveform is started each pulse is executed in order with
|
||||||
the specified delay between the pulse and the next.
|
the specified delay between the pulse and the next.
|
||||||
<br><br><b><small>Example</small></b><br><br><code>$ pigs wvas 4 9600 0 23 45 67 89 90<br>37<br>$ pigs wvcre<br>0<br><br>$ pigs wvcre<br>-69<br>ERROR: attempt to create an empty waveform<br></code><h3><a name="WVCAP">WVCAP</a>
|
<br><br><b><small>Example</small></b><br><br><code>$ pigs wvas 4 9600 0 23 45 67 89 90<br>37<br>$ pigs wvcre<br>0<br><br>$ pigs wvcre<br>-69<br>ERROR: attempt to create an empty waveform<br></code><h3><a name="WVCAP">WVCAP</a>
|
||||||
- Create a waveform of fixed size</h3>Similar to WVCRE, this command creates a waveform but pads the consumed
|
- Create a waveform of fixed size</h3>Similar to <a href="#WVCRE">WVCRE</a>, this command creates a waveform but pads the consumed
|
||||||
resources to a fixed size, specified as a percent of total resource.
|
resources to a fixed size, specified as a percent of total resource.
|
||||||
Padded waves of equal size can be re-cycled efficiently allowing newly
|
Padded waves of equal size can be re-cycled efficiently allowing newly
|
||||||
created waves to re-use the resources of deleted waves of the same dimension.
|
created waves to re-use the resources of deleted waves of the same dimension.
|
||||||
|
@ -1260,7 +1260,7 @@ the current GPIO levels.
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -261,7 +261,7 @@ make install<br></code><br>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -1029,12 +1029,12 @@ resources. Where percent gives the percentage of the resources to use
|
||||||
This allows the reuse of deleted waves while a transmission is active.
|
This allows the reuse of deleted waves while a transmission is active.
|
||||||
<br><br>Upon success a wave id greater than or equal to 0 is returned, otherwise
|
<br><br>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_EMPTY_WAVEFORM, PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
||||||
<br><br><code>pi: >=0 (as returned by <a href="#pigpio_start">pigpio_start</a>).<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
<br><br><code>percent: 0-100, size of waveform as percentage of maximum available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
||||||
function.
|
function.
|
||||||
<br><br>As many waveforms may be created as there is space available. The
|
<br><br>As many waveforms may be created as there is space available. The
|
||||||
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
||||||
<br><br>A usage would be the creation of two waves where one is filled while the other
|
<br><br>A usage would be the creation of two waves where one is filled while the
|
||||||
is being transmitted. Each wave is assigned 50% of the available resources.
|
other is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
<br><br>Normal usage:
|
<br><br>Normal usage:
|
||||||
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
||||||
|
@ -1044,7 +1044,7 @@ This buffer structure allows the transmission of infinite wave sequences.
|
||||||
<br><br>Repeat steps 2-4 as needed.
|
<br><br>Repeat steps 2-4 as needed.
|
||||||
<br><br>Step 5. Any wave id can now be deleted and another wave of the same size
|
<br><br>Step 5. Any wave id can now be deleted and another wave of the same size
|
||||||
can be created in its place.
|
can be created in its place.
|
||||||
<br><br><b><small>Example</small></b><br><br><code>wid = pi.wave_create(50)<br></code><h3><a name="wave_delete">wave_delete<small>(<a href="#wave_id">wave_id</a>)</small></h3>
|
<br><br><b><small>Example</small></b><br><br><code>wid = pi.wave_create_and_pad(50)<br></code><h3><a name="wave_delete">wave_delete<small>(<a href="#wave_id">wave_id</a>)</small></h3>
|
||||||
This function deletes the waveform with id wave_id.
|
This function deletes the waveform with id wave_id.
|
||||||
<br><br><b><small>Parameters</small></b><br><br><samp>wave_id:= >=0 (as returned by a prior call to <a href="#wave_create">wave_create</a>).<br></samp><br><br>Wave ids are allocated in order, 0, 1, 2, etc.
|
<br><br><b><small>Parameters</small></b><br><br><samp>wave_id:= >=0 (as returned by a prior call to <a href="#wave_create">wave_create</a>).<br></samp><br><br>Wave ids are allocated in order, 0, 1, 2, etc.
|
||||||
<br><br>The wave is flagged for deletion. The resources used by the wave
|
<br><br>The wave is flagged for deletion. The resources used by the wave
|
||||||
|
@ -1210,6 +1210,7 @@ being currently defined.
|
||||||
high and low levels.
|
high and low levels.
|
||||||
<h3><a name="params"></a>params: 32 bit number</h3>When scripts are started they can receive up to 10 parameters
|
<h3><a name="params"></a>params: 32 bit number</h3>When scripts are started they can receive up to 10 parameters
|
||||||
to define their operation.
|
to define their operation.
|
||||||
|
<h3><a name="percent"></a>percent: : 0-100</h3>The size of waveform as percentage of maximum available.
|
||||||
<h3><a name="port"></a>port: </h3>The port used by the pigpio daemon, defaults to 8888.
|
<h3><a name="port"></a>port: </h3>The port used by the pigpio daemon, defaults to 8888.
|
||||||
<h3><a name="pstring"></a>pstring: </h3>The string to be passed to a <a href="#shell">shell</a> script to be executed.
|
<h3><a name="pstring"></a>pstring: </h3>The string to be passed to a <a href="#shell">shell</a> script to be executed.
|
||||||
<h3><a name="pud"></a>pud: 0-2</h3><code>PUD_DOWN = 1<br>PUD_OFF = 0<br>PUD_UP = 2<br></code><h3><a name="pulse_len"></a>pulse_len: 1-100</h3>The length of the trigger pulse in microseconds.
|
<h3><a name="pud"></a>pud: 0-2</h3><code>PUD_DOWN = 1<br>PUD_OFF = 0<br>PUD_UP = 2<br></code><h3><a name="pulse_len"></a>pulse_len: 1-100</h3>The length of the trigger pulse in microseconds.
|
||||||
|
@ -1285,7 +1286,7 @@ timeout report is issued (with level TIMEOUT).
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -2050,7 +2050,7 @@ uint8_t data[X]</td>
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -77,7 +77,7 @@
|
||||||
<table><tr>
|
<table><tr>
|
||||||
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: left;"><small>© 2012-2020</small></div></td>
|
||||||
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
<td style="width: 350px"><div style="text-align: center;">e-mail: pigpio @ abyz.me.uk</div></td>
|
||||||
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 29/04/2020</small></div></td>
|
<td style="width: 200px"><div style="text-align: right;"><small>Updated: 30/04/2020</small></div></td>
|
||||||
</tr></table>
|
</tr></table>
|
||||||
</td>
|
</td>
|
||||||
</table>
|
</table>
|
||||||
|
|
|
@ -9569,6 +9569,27 @@ An array of script parameters.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpctBOOL\fP: 0-100" 0
|
||||||
|
percent On-Off-Level (OOL) buffer to consume for wave output.
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpctCB\fP: 0-100" 0
|
||||||
|
the percent of all DMA control blocks to consume.
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpctTOOL\fP: 0-100" 0
|
||||||
|
the percent of OOL buffer to consume for wave input (flags).
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
.IP "\fBpi_i2c_msg_t\fP" 0
|
.IP "\fBpi_i2c_msg_t\fP" 0
|
||||||
|
|
||||||
.EX
|
.EX
|
||||||
|
|
|
@ -2395,13 +2395,11 @@ PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.
|
||||||
|
|
||||||
.IP "\fBint wave_create_and_pad(int pi, int percent)\fP"
|
.IP "\fBint wave_create_and_pad(int pi, int percent)\fP"
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
This function creates a waveform like wave_create but pads the consumed
|
This function creates a waveform like \fBwave_create\fP but pads the consumed
|
||||||
resources. Where percent gives the percentage of the resources to use (in terms
|
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 the theoretical maximum, not the current amount free). This allows the reuse
|
||||||
.br
|
.br
|
||||||
of deleted waves while a transmission is active. Upon success a wave id
|
of deleted waves while a transmission is active.
|
||||||
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.
|
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
@ -2410,6 +2408,8 @@ PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
||||||
.EX
|
.EX
|
||||||
pi: >=0 (as returned by \fBpigpio_start\fP).
|
pi: >=0 (as returned by \fBpigpio_start\fP).
|
||||||
.br
|
.br
|
||||||
|
percent: 0-100, size of waveform as percentage of maximum available.
|
||||||
|
.br
|
||||||
|
|
||||||
.EE
|
.EE
|
||||||
|
|
||||||
|
@ -2429,7 +2429,7 @@ wave id is passed to \fBwave_send_*\fP to specify the waveform to transmit.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
A usage would be the creation of two waves where one is filled while the other
|
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.
|
is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
@ -7499,6 +7499,13 @@ An array of script parameters.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpercent\fP: 0-100" 0
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
.IP "\fBpi\fP" 0
|
.IP "\fBpi\fP" 0
|
||||||
An integer defining a connected Pi. The value is returned by
|
An integer defining a connected Pi. The value is returned by
|
||||||
\fBpigpio_start\fP upon success.
|
\fBpigpio_start\fP upon success.
|
||||||
|
|
|
@ -5146,7 +5146,7 @@ ERROR: attempt to create an empty waveform
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
|
|
||||||
.br
|
.br
|
||||||
Similar to WVCRE, this command creates a waveform but pads the consumed
|
Similar to \fBWVCRE\fP, this command creates a waveform but pads the consumed
|
||||||
resources to a fixed size, specified as a percent of total resource.
|
resources to a fixed size, specified as a percent of total resource.
|
||||||
Padded waves of equal size can be re-cycled efficiently allowing newly
|
Padded waves of equal size can be re-cycled efficiently allowing newly
|
||||||
created waves to re-use the resources of deleted waves of the same dimension.
|
created waves to re-use the resources of deleted waves of the same dimension.
|
||||||
|
|
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
@ -2786,7 +2786,7 @@ ERROR: attempt to create an empty waveform
|
||||||
|
|
||||||
WVCAP ::
|
WVCAP ::
|
||||||
|
|
||||||
Similar to WVCRE, this command creates a waveform but pads the consumed
|
Similar to [*WVCRE*], this command creates a waveform but pads the consumed
|
||||||
resources to a fixed size, specified as a percent of total resource.
|
resources to a fixed size, specified as a percent of total resource.
|
||||||
Padded waves of equal size can be re-cycled efficiently allowing newly
|
Padded waves of equal size can be re-cycled efficiently allowing newly
|
||||||
created waves to re-use the resources of deleted waves of the same dimension.
|
created waves to re-use the resources of deleted waves of the same dimension.
|
||||||
|
|
|
@ -1675,6 +1675,12 @@ The mA which may be drawn from each GPIO whilst still guaranteeing the
|
||||||
high and low levels.
|
high and low levels.
|
||||||
<h3><a name="*param">*param</a></h3>
|
<h3><a name="*param">*param</a></h3>
|
||||||
An array of script parameters.
|
An array of script parameters.
|
||||||
|
<h3><a name="pctBOOL">pctBOOL</a>: 0-100</h3>
|
||||||
|
percent On-Off-Level (OOL) buffer to consume for wave output.
|
||||||
|
<h3><a name="pctCB">pctCB</a>: 0-100</h3>
|
||||||
|
the percent of all DMA control blocks to consume.
|
||||||
|
<h3><a name="pctTOOL">pctTOOL</a>: 0-100</h3>
|
||||||
|
the percent of OOL buffer to consume for wave input (flags).
|
||||||
<h3><a name="pi_i2c_msg_t">pi_i2c_msg_t</a></h3>
|
<h3><a name="pi_i2c_msg_t">pi_i2c_msg_t</a></h3>
|
||||||
<code>typedef struct<br>{<br> uint16_t addr; // slave address<br> uint16_t flags;<br> uint16_t len; // msg length<br> uint8_t *buf; // pointer to msg data<br>} pi_i2c_msg_t;<br></code><h3><a name="port">port</a>: 1024-32000</h3>
|
<code>typedef struct<br>{<br> uint16_t addr; // slave address<br> uint16_t flags;<br> uint16_t len; // msg length<br> uint8_t *buf; // pointer to msg data<br>} pi_i2c_msg_t;<br></code><h3><a name="port">port</a>: 1024-32000</h3>
|
||||||
The port used to bind to the pigpio socket. Defaults to 8888.
|
The port used to bind to the pigpio socket. Defaults to 8888.
|
||||||
|
|
|
@ -528,18 +528,16 @@ specified delay between the pulse and the next.
|
||||||
<br><br>Returns the new waveform id if OK, otherwise PI_EMPTY_WAVEFORM,
|
<br><br>Returns the new waveform id if OK, otherwise PI_EMPTY_WAVEFORM,
|
||||||
PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.
|
PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.
|
||||||
<h3><a name="wave_create_and_pad"></a><a href="#int"><small>int</small></a> wave_create_and_pad<small>(<a href="#int">int</a> <a href="#pi">pi</a>, <a href="#int">int</a> <a href="#percent">percent</a>)</small></h3>
|
<h3><a name="wave_create_and_pad"></a><a href="#int"><small>int</small></a> wave_create_and_pad<small>(<a href="#int">int</a> <a href="#pi">pi</a>, <a href="#int">int</a> <a href="#percent">percent</a>)</small></h3>
|
||||||
This function creates a waveform like wave_create but pads the consumed
|
This function creates a waveform like <a href="#wave_create">wave_create</a> but pads the consumed
|
||||||
resources. Where percent gives the percentage of the resources to use (in terms
|
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<br>
|
of the theoretical maximum, not the current amount free). This allows the reuse<br>
|
||||||
of deleted waves while a transmission is active. Upon success a wave id
|
of deleted waves while a transmission is active.
|
||||||
greater than or equal to 0 is returned, otherwise PI_EMPTY_WAVEFORM,
|
<br><br><code>pi: >=0 (as returned by <a href="#pigpio_start">pigpio_start</a>).<br>percent: 0-100, size of waveform as percentage of maximum available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
||||||
PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
|
||||||
<br><br><code>pi: >=0 (as returned by <a href="#pigpio_start">pigpio_start</a>).<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
|
||||||
function.
|
function.
|
||||||
<br><br>As many waveforms may be created as there is space available. The
|
<br><br>As many waveforms may be created as there is space available. The
|
||||||
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
||||||
<br><br>A usage would be the creation of two waves where one is filled while the other
|
<br><br>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.
|
is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
<br><br>Normal usage:
|
<br><br>Normal usage:
|
||||||
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
||||||
|
@ -1348,6 +1346,8 @@ The mA which may be drawn from each GPIO whilst still guaranteeing the
|
||||||
high and low levels.
|
high and low levels.
|
||||||
<h3><a name="*param">*param</a></h3>
|
<h3><a name="*param">*param</a></h3>
|
||||||
An array of script parameters.
|
An array of script parameters.
|
||||||
|
<h3><a name="percent">percent</a>: 0-100</h3>
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
<h3><a name="pi">pi</a></h3>
|
<h3><a name="pi">pi</a></h3>
|
||||||
An integer defining a connected Pi. The value is returned by
|
An integer defining a connected Pi. The value is returned by
|
||||||
<a href="#pigpio_start">pigpio_start</a> upon success.
|
<a href="#pigpio_start">pigpio_start</a> upon success.
|
||||||
|
|
|
@ -904,7 +904,7 @@ set all the fields to zero (the pulse will be ignored).
|
||||||
<br><br>When a waveform is started each pulse is executed in order with
|
<br><br>When a waveform is started each pulse is executed in order with
|
||||||
the specified delay between the pulse and the next.
|
the specified delay between the pulse and the next.
|
||||||
<br><br><b><small>Example</small></b><br><br><code>$ pigs wvas 4 9600 0 23 45 67 89 90<br>37<br>$ pigs wvcre<br>0<br><br>$ pigs wvcre<br>-69<br>ERROR: attempt to create an empty waveform<br></code><h3><a name="WVCAP">WVCAP</a>
|
<br><br><b><small>Example</small></b><br><br><code>$ pigs wvas 4 9600 0 23 45 67 89 90<br>37<br>$ pigs wvcre<br>0<br><br>$ pigs wvcre<br>-69<br>ERROR: attempt to create an empty waveform<br></code><h3><a name="WVCAP">WVCAP</a>
|
||||||
- Create a waveform of fixed size</h3>Similar to WVCRE, this command creates a waveform but pads the consumed
|
- Create a waveform of fixed size</h3>Similar to <a href="#WVCRE">WVCRE</a>, this command creates a waveform but pads the consumed
|
||||||
resources to a fixed size, specified as a percent of total resource.
|
resources to a fixed size, specified as a percent of total resource.
|
||||||
Padded waves of equal size can be re-cycled efficiently allowing newly
|
Padded waves of equal size can be re-cycled efficiently allowing newly
|
||||||
created waves to re-use the resources of deleted waves of the same dimension.
|
created waves to re-use the resources of deleted waves of the same dimension.
|
||||||
|
|
|
@ -989,12 +989,12 @@ resources. Where percent gives the percentage of the resources to use
|
||||||
This allows the reuse of deleted waves while a transmission is active.
|
This allows the reuse of deleted waves while a transmission is active.
|
||||||
<br><br>Upon success a wave id greater than or equal to 0 is returned, otherwise
|
<br><br>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_EMPTY_WAVEFORM, PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
||||||
<br><br><code>pi: >=0 (as returned by <a href="#pigpio_start">pigpio_start</a>).<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
<br><br><code>percent: 0-100, size of waveform as percentage of maximum available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
|
||||||
function.
|
function.
|
||||||
<br><br>As many waveforms may be created as there is space available. The
|
<br><br>As many waveforms may be created as there is space available. The
|
||||||
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
wave id is passed to <a href="#wave_send_*">wave_send_*</a> to specify the waveform to transmit.
|
||||||
<br><br>A usage would be the creation of two waves where one is filled while the other
|
<br><br>A usage would be the creation of two waves where one is filled while the
|
||||||
is being transmitted. Each wave is assigned 50% of the available resources.
|
other is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
<br><br>Normal usage:
|
<br><br>Normal usage:
|
||||||
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
<br><br>Step 1. <a href="#wave_clear">wave_clear</a> to clear all waveforms and added data.
|
||||||
|
@ -1004,7 +1004,7 @@ This buffer structure allows the transmission of infinite wave sequences.
|
||||||
<br><br>Repeat steps 2-4 as needed.
|
<br><br>Repeat steps 2-4 as needed.
|
||||||
<br><br>Step 5. Any wave id can now be deleted and another wave of the same size
|
<br><br>Step 5. Any wave id can now be deleted and another wave of the same size
|
||||||
can be created in its place.
|
can be created in its place.
|
||||||
<br><br><b><small>Example</small></b><br><br><code>wid = pi.wave_create(50)<br></code><h3><a name="wave_delete">wave_delete<small>(<a href="#wave_id">wave_id</a>)</small></h3>
|
<br><br><b><small>Example</small></b><br><br><code>wid = pi.wave_create_and_pad(50)<br></code><h3><a name="wave_delete">wave_delete<small>(<a href="#wave_id">wave_id</a>)</small></h3>
|
||||||
This function deletes the waveform with id wave_id.
|
This function deletes the waveform with id wave_id.
|
||||||
<br><br><b><small>Parameters</small></b><br><br><samp>wave_id:= >=0 (as returned by a prior call to <a href="#wave_create">wave_create</a>).<br></samp><br><br>Wave ids are allocated in order, 0, 1, 2, etc.
|
<br><br><b><small>Parameters</small></b><br><br><samp>wave_id:= >=0 (as returned by a prior call to <a href="#wave_create">wave_create</a>).<br></samp><br><br>Wave ids are allocated in order, 0, 1, 2, etc.
|
||||||
<br><br>The wave is flagged for deletion. The resources used by the wave
|
<br><br>The wave is flagged for deletion. The resources used by the wave
|
||||||
|
@ -1170,6 +1170,7 @@ being currently defined.
|
||||||
high and low levels.
|
high and low levels.
|
||||||
<h3><a name="params"></a>params: 32 bit number</h3>When scripts are started they can receive up to 10 parameters
|
<h3><a name="params"></a>params: 32 bit number</h3>When scripts are started they can receive up to 10 parameters
|
||||||
to define their operation.
|
to define their operation.
|
||||||
|
<h3><a name="percent"></a>percent: : 0-100</h3>The size of waveform as percentage of maximum available.
|
||||||
<h3><a name="port"></a>port: </h3>The port used by the pigpio daemon, defaults to 8888.
|
<h3><a name="port"></a>port: </h3>The port used by the pigpio daemon, defaults to 8888.
|
||||||
<h3><a name="pstring"></a>pstring: </h3>The string to be passed to a <a href="#shell">shell</a> script to be executed.
|
<h3><a name="pstring"></a>pstring: </h3>The string to be passed to a <a href="#shell">shell</a> script to be executed.
|
||||||
<h3><a name="pud"></a>pud: 0-2</h3><code>PUD_DOWN = 1<br>PUD_OFF = 0<br>PUD_UP = 2<br></code><h3><a name="pulse_len"></a>pulse_len: 1-100</h3>The length of the trigger pulse in microseconds.
|
<h3><a name="pud"></a>pud: 0-2</h3><code>PUD_DOWN = 1<br>PUD_OFF = 0<br>PUD_UP = 2<br></code><h3><a name="pulse_len"></a>pulse_len: 1-100</h3>The length of the trigger pulse in microseconds.
|
||||||
|
|
|
@ -3174,7 +3174,7 @@ CLASSES
|
||||||
| PI_EMPTY_WAVEFORM, PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
| PI_EMPTY_WAVEFORM, PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
||||||
|
|
|
|
||||||
| . .
|
| . .
|
||||||
| pi: >=0 (as returned by [*pigpio_start*]).
|
| percent: 0-100, size of waveform as percentage of maximum available.
|
||||||
| . .
|
| . .
|
||||||
|
|
|
|
||||||
| The data provided by the [*wave_add_**] functions are consumed by this
|
| The data provided by the [*wave_add_**] functions are consumed by this
|
||||||
|
@ -3183,8 +3183,8 @@ CLASSES
|
||||||
| As many waveforms may be created as there is space available. The
|
| 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.
|
| 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
|
| A usage would be the creation of two waves where one is filled while the
|
||||||
| is being transmitted. Each wave is assigned 50% of the available resources.
|
| other is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
| This buffer structure allows the transmission of infinite wave sequences.
|
| This buffer structure allows the transmission of infinite wave sequences.
|
||||||
|
|
|
|
||||||
| Normal usage:
|
| Normal usage:
|
||||||
|
@ -3203,7 +3203,7 @@ CLASSES
|
||||||
| can be created in its place.
|
| can be created in its place.
|
||||||
|
|
|
|
||||||
| ...
|
| ...
|
||||||
| wid = pi.wave_create(50)
|
| wid = pi.wave_create_and_pad(50)
|
||||||
| ...
|
| ...
|
||||||
|
|
|
|
||||||
| wave_delete(self, wave_id)
|
| wave_delete(self, wave_id)
|
||||||
|
@ -3834,6 +3834,9 @@ FUNCTIONS
|
||||||
When scripts are started they can receive up to 10 parameters
|
When scripts are started they can receive up to 10 parameters
|
||||||
to define their operation.
|
to define their operation.
|
||||||
|
|
||||||
|
percent:: 0-100
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
|
|
||||||
port:
|
port:
|
||||||
The port used by the pigpio daemon, defaults to 8888.
|
The port used by the pigpio daemon, defaults to 8888.
|
||||||
|
|
||||||
|
|
21
pigpio.3
21
pigpio.3
|
@ -9569,6 +9569,27 @@ An array of script parameters.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpctBOOL\fP: 0-100" 0
|
||||||
|
percent On-Off-Level (OOL) buffer to consume for wave output.
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpctCB\fP: 0-100" 0
|
||||||
|
the percent of all DMA control blocks to consume.
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpctTOOL\fP: 0-100" 0
|
||||||
|
the percent of OOL buffer to consume for wave input (flags).
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
.IP "\fBpi_i2c_msg_t\fP" 0
|
.IP "\fBpi_i2c_msg_t\fP" 0
|
||||||
|
|
||||||
.EX
|
.EX
|
||||||
|
|
9
pigpio.h
9
pigpio.h
|
@ -5804,6 +5804,15 @@ high and low levels.
|
||||||
*param::
|
*param::
|
||||||
An array of script parameters.
|
An array of script parameters.
|
||||||
|
|
||||||
|
pctBOOL:: 0-100
|
||||||
|
percent On-Off-Level (OOL) buffer to consume for wave output.
|
||||||
|
|
||||||
|
pctCB:: 0-100
|
||||||
|
the percent of all DMA control blocks to consume.
|
||||||
|
|
||||||
|
pctTOOL:: 0-100
|
||||||
|
the percent of OOL buffer to consume for wave input (flags).
|
||||||
|
|
||||||
pi_i2c_msg_t::
|
pi_i2c_msg_t::
|
||||||
. .
|
. .
|
||||||
typedef struct
|
typedef struct
|
||||||
|
|
19
pigpio.py
19
pigpio.py
|
@ -2312,12 +2312,12 @@ class pi():
|
||||||
resources. Where percent gives the percentage of the resources to use
|
resources. Where percent gives the percentage of the resources to use
|
||||||
(in terms of the theoretical maximum, not the current amount free).
|
(in terms of the theoretical maximum, not the current amount free).
|
||||||
This allows the reuse of deleted waves while a transmission is active.
|
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
|
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_EMPTY_WAVEFORM, PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
||||||
|
|
||||||
. .
|
. .
|
||||||
pi: >=0 (as returned by [*pigpio_start*]).
|
percent: 0-100, size of waveform as percentage of maximum available.
|
||||||
. .
|
. .
|
||||||
|
|
||||||
The data provided by the [*wave_add_**] functions are consumed by this
|
The data provided by the [*wave_add_**] functions are consumed by this
|
||||||
|
@ -2326,10 +2326,10 @@ class pi():
|
||||||
As many waveforms may be created as there is space available. The
|
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.
|
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
|
A usage would be the creation of two waves where one is filled while the
|
||||||
is being transmitted. Each wave is assigned 50% of the available resources.
|
other is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
|
|
||||||
Normal usage:
|
Normal usage:
|
||||||
|
|
||||||
Step 1. [*wave_clear*] to clear all waveforms and added data.
|
Step 1. [*wave_clear*] to clear all waveforms and added data.
|
||||||
|
@ -2341,12 +2341,12 @@ class pi():
|
||||||
Step 4. [*wave_send_**] with the id of the waveform to transmit.
|
Step 4. [*wave_send_**] with the id of the waveform to transmit.
|
||||||
|
|
||||||
Repeat steps 2-4 as needed.
|
Repeat steps 2-4 as needed.
|
||||||
|
|
||||||
Step 5. Any wave id can now be deleted and another wave of the same size
|
Step 5. Any wave id can now be deleted and another wave of the same size
|
||||||
can be created in its place.
|
can be created in its place.
|
||||||
|
|
||||||
...
|
...
|
||||||
wid = pi.wave_create(50)
|
wid = pi.wave_create_and_pad(50)
|
||||||
...
|
...
|
||||||
"""
|
"""
|
||||||
return _u2i(_pigpio_command(self.sl, _PI_CMD_WVCAP, percent, 0))
|
return _u2i(_pigpio_command(self.sl, _PI_CMD_WVCAP, percent, 0))
|
||||||
|
@ -5629,6 +5629,9 @@ def xref():
|
||||||
When scripts are started they can receive up to 10 parameters
|
When scripts are started they can receive up to 10 parameters
|
||||||
to define their operation.
|
to define their operation.
|
||||||
|
|
||||||
|
percent:: 0-100
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
|
|
||||||
port:
|
port:
|
||||||
The port used by the pigpio daemon, defaults to 8888.
|
The port used by the pigpio daemon, defaults to 8888.
|
||||||
|
|
||||||
|
|
|
@ -2395,13 +2395,11 @@ PI_NO_WAVEFORM_ID, PI_TOO_MANY_CBS, or PI_TOO_MANY_OOL.
|
||||||
|
|
||||||
.IP "\fBint wave_create_and_pad(int pi, int percent)\fP"
|
.IP "\fBint wave_create_and_pad(int pi, int percent)\fP"
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
This function creates a waveform like wave_create but pads the consumed
|
This function creates a waveform like \fBwave_create\fP but pads the consumed
|
||||||
resources. Where percent gives the percentage of the resources to use (in terms
|
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 the theoretical maximum, not the current amount free). This allows the reuse
|
||||||
.br
|
.br
|
||||||
of deleted waves while a transmission is active. Upon success a wave id
|
of deleted waves while a transmission is active.
|
||||||
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.
|
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
@ -2410,6 +2408,8 @@ PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
|
||||||
.EX
|
.EX
|
||||||
pi: >=0 (as returned by \fBpigpio_start\fP).
|
pi: >=0 (as returned by \fBpigpio_start\fP).
|
||||||
.br
|
.br
|
||||||
|
percent: 0-100, size of waveform as percentage of maximum available.
|
||||||
|
.br
|
||||||
|
|
||||||
.EE
|
.EE
|
||||||
|
|
||||||
|
@ -2429,7 +2429,7 @@ wave id is passed to \fBwave_send_*\fP to specify the waveform to transmit.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
A usage would be the creation of two waves where one is filled while the other
|
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.
|
is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
@ -7499,6 +7499,13 @@ An array of script parameters.
|
||||||
|
|
||||||
.br
|
.br
|
||||||
|
|
||||||
|
.IP "\fBpercent\fP: 0-100" 0
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
|
.br
|
||||||
|
|
||||||
.IP "\fBpi\fP" 0
|
.IP "\fBpi\fP" 0
|
||||||
An integer defining a connected Pi. The value is returned by
|
An integer defining a connected Pi. The value is returned by
|
||||||
\fBpigpio_start\fP upon success.
|
\fBpigpio_start\fP upon success.
|
||||||
|
|
|
@ -1376,15 +1376,14 @@ D*/
|
||||||
/*F*/
|
/*F*/
|
||||||
int wave_create_and_pad(int pi, int percent);
|
int wave_create_and_pad(int pi, int percent);
|
||||||
/*D
|
/*D
|
||||||
This function creates a waveform like wave_create but pads the consumed
|
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
|
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 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
|
of deleted waves while a transmission is active.
|
||||||
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*]).
|
pi: >=0 (as returned by [*pigpio_start*]).
|
||||||
|
percent: 0-100, size of waveform as percentage of maximum available.
|
||||||
. .
|
. .
|
||||||
|
|
||||||
The data provided by the [*wave_add_**] functions are consumed by this
|
The data provided by the [*wave_add_**] functions are consumed by this
|
||||||
|
@ -1394,7 +1393,7 @@ 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.
|
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
|
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.
|
is being transmitted. Each wave is assigned 50% of the resources.
|
||||||
This buffer structure allows the transmission of infinite wave sequences.
|
This buffer structure allows the transmission of infinite wave sequences.
|
||||||
|
|
||||||
Normal usage:
|
Normal usage:
|
||||||
|
@ -4128,6 +4127,9 @@ high and low levels.
|
||||||
*param::
|
*param::
|
||||||
An array of script parameters.
|
An array of script parameters.
|
||||||
|
|
||||||
|
percent:: 0-100
|
||||||
|
The size of waveform as percentage of maximum available.
|
||||||
|
|
||||||
pi::
|
pi::
|
||||||
An integer defining a connected Pi. The value is returned by
|
An integer defining a connected Pi. The value is returned by
|
||||||
[*pigpio_start*] upon success.
|
[*pigpio_start*] upon success.
|
||||||
|
|
2
pigs.1
2
pigs.1
|
@ -5146,7 +5146,7 @@ ERROR: attempt to create an empty waveform
|
||||||
.IP "" 4
|
.IP "" 4
|
||||||
|
|
||||||
.br
|
.br
|
||||||
Similar to WVCRE, this command creates a waveform but pads the consumed
|
Similar to \fBWVCRE\fP, this command creates a waveform but pads the consumed
|
||||||
resources to a fixed size, specified as a percent of total resource.
|
resources to a fixed size, specified as a percent of total resource.
|
||||||
Padded waves of equal size can be re-cycled efficiently allowing newly
|
Padded waves of equal size can be re-cycled efficiently allowing newly
|
||||||
created waves to re-use the resources of deleted waves of the same dimension.
|
created waves to re-use the resources of deleted waves of the same dimension.
|
||||||
|
|
Loading…
Reference in New Issue