Fix doc generation warnings and other doc source corrections.

diff --git a/DOC/HTML/cif.html b/DOC/HTML/cif.html
index 6b9761f2138c6ac1e224086210d825ef16064252..58d6eea49feef81bc93aae171d983b908728a201 100644 (file)
--- a/DOC/HTML/cif.html
+++ b/DOC/HTML/cif.html
@@ -1715,6 +1715,12 @@ The mA which may be drawn from each GPIO whilst still guaranteeing the
 high and low levels.
 <h3><a name="*param">*param</a></h3>
 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>
 <code>typedef&nbsp;struct<br>{<br>&nbsp;&nbsp;&nbsp;uint16_t&nbsp;addr;&nbsp;&nbsp;//&nbsp;slave&nbsp;address<br>&nbsp;&nbsp;&nbsp;uint16_t&nbsp;flags;<br>&nbsp;&nbsp;&nbsp;uint16_t&nbsp;len;&nbsp;&nbsp;&nbsp;//&nbsp;msg&nbsp;length<br>&nbsp;&nbsp;&nbsp;uint8_t&nbsp;&nbsp;*buf;&nbsp;&nbsp;//&nbsp;pointer&nbsp;to&nbsp;msg&nbsp;data<br>}&nbsp;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.
@@ -1873,7 +1879,7 @@ A 16-bit word value.
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/download.html b/DOC/HTML/download.html
index 5da5c77d556211818dcf5ed68012245f51955501..84ec4da51a13f1ea9af1ee61412e5109fca48898 100644 (file)
--- a/DOC/HTML/download.html
+++ b/DOC/HTML/download.html
@@ -113,7 +113,7 @@ sudo apt-get install pigpio python-pigpio python3-pigpio</code><br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/ex_LDR.html b/DOC/HTML/ex_LDR.html
index 615d9b453b342005ca5eb2ceb666a94b2bafa7f0..6b1cf2356223a176831429569aaae45fa9174ecb 100644 (file)
--- a/DOC/HTML/ex_LDR.html
+++ b/DOC/HTML/ex_LDR.html
@@ -197,7 +197,7 @@ Gnuplot readings 18-21 seconds
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/ex_ir_remote.html b/DOC/HTML/ex_ir_remote.html
index 257d6139563e0d5273a3c167fc445b0f3e07d07a..5f548cb05c41f176fb981a0455d5df2a125718ec 100644 (file)
--- a/DOC/HTML/ex_ir_remote.html
+++ b/DOC/HTML/ex_ir_remote.html
@@ -300,7 +300,7 @@ viewed using GTKWave.</p>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/ex_motor_shield.html b/DOC/HTML/ex_motor_shield.html
index 8378282db42c89fed2009e56d6a3a90eef9ff62c..e5d28f0dd74b8d9b3c63f91a19455cd82ec00b64 100644 (file)
--- a/DOC/HTML/ex_motor_shield.html
+++ b/DOC/HTML/ex_motor_shield.html
@@ -301,7 +301,7 @@ PI_OUTPUT);<br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/ex_rotary_encoder.html b/DOC/HTML/ex_rotary_encoder.html
index e6df718972736355fae768acea6d781091a728dc..b15b354baed8110565898cc717567c4a5f31570c 100644 (file)
--- a/DOC/HTML/ex_rotary_encoder.html
+++ b/DOC/HTML/ex_rotary_encoder.html
@@ -232,7 +232,7 @@ before completing the level transition<br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/ex_sonar_ranger.html b/DOC/HTML/ex_sonar_ranger.html
index 9e60c391d3a2cba20fb735f9a342283c86e532fe..1db8410f813f956287f4e0dc9d15c0c8ae0cf284 100644 (file)
--- a/DOC/HTML/ex_sonar_ranger.html
+++ b/DOC/HTML/ex_sonar_ranger.html
@@ -211,7 +211,7 @@ plot 'sonar-secs.dat' title 'Sonar'<br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/examples.html b/DOC/HTML/examples.html
index 59e39079a0a75ba6ebce75fe32eaa471c58f21d0..3d82fcafb7dc86c4bcc9b40e8f517740938587aa 100644 (file)
--- a/DOC/HTML/examples.html
+++ b/DOC/HTML/examples.html
@@ -550,7 +550,7 @@ Related code.<br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/faq.html b/DOC/HTML/faq.html
index 1286cbe0d29e18433d142d12773057063ae94538..4d06c5e0076f2601a02ff7d1d17d84c9e00de2a3 100644 (file)
--- a/DOC/HTML/faq.html
+++ b/DOC/HTML/faq.html
@@ -508,7 +508,7 @@ should I use?</h3>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/index.html b/DOC/HTML/index.html
index 2606ba4ab1a4674131b28a03f49d0b46cb344fc9..fdaeaa6b20a3f9c09c24108ea03086b0bdf69c82 100644 (file)
--- a/DOC/HTML/index.html
+++ b/DOC/HTML/index.html
@@ -708,7 +708,7 @@ Hirst's <a href="https://github.com/richardghirst/PiBits" target=
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/misc.html b/DOC/HTML/misc.html
index a6179f4698b65326a992e72a348623b4d3efe3e5..e4db51a32445deb2284934be2c338a61251bc3fb 100644 (file)
--- a/DOC/HTML/misc.html
+++ b/DOC/HTML/misc.html
@@ -80,7 +80,7 @@ VCD can be read by many programs, in particular <a href=
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/pdif.html b/DOC/HTML/pdif.html
index 8084e94252e31b0d7a67054d3959ffcae94a3f92..2256f6197daa33aec0eb7ddf24d8fc18f4aff990 100644 (file)
--- a/DOC/HTML/pdif.html
+++ b/DOC/HTML/pdif.html
@@ -1160,7 +1160,7 @@ A 16-bit word value.
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/pdif2.html b/DOC/HTML/pdif2.html
index fad8bdb88d69f7d098764b5058384f659edd4e0a..db30a8c1d1ab5ef69be875d3129c0a177587b78b 100644 (file)
--- a/DOC/HTML/pdif2.html
+++ b/DOC/HTML/pdif2.html
@@ -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,
 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>
-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
 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
-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><code>pi:&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;<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
+of deleted waves while a transmission is active.
+<br><br><code>pi:&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;<a href="#pigpio_start">pigpio_start</a>).<br>percent:&nbsp;0-100,&nbsp;size&nbsp;of&nbsp;waveform&nbsp;as&nbsp;percentage&nbsp;of&nbsp;maximum&nbsp;available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
 function.
 <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.
 <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.
 <br><br>Normal usage:
 <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.
 <h3><a name="*param">*param</a></h3>
 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>
 An integer defining a connected Pi.  The value is returned by
 <a href="#pigpio_start">pigpio_start</a> upon success.
@@ -1515,7 +1515,7 @@ A 16-bit word value.
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/pif.html b/DOC/HTML/pif.html
index 6ed3739bddc50d600e63d1c84ff3c9479ebbd46a..1cc3c17bc0ab88bda4b23aedac6aca0a76c194f1 100644 (file)
--- a/DOC/HTML/pif.html
+++ b/DOC/HTML/pif.html
@@ -77,7 +77,7 @@ The format of the commands is identical to those used by <a href=
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/pig2vcd.html b/DOC/HTML/pig2vcd.html
index 8797c156e7c2461d66c7b510ce46ccadf1b1bdbe..e64a2fbb8530b3f2864aaa971abcc5a1a9be068b 100644 (file)
--- a/DOC/HTML/pig2vcd.html
+++ b/DOC/HTML/pig2vcd.html
@@ -75,7 +75,7 @@ The state lines contain the new state followed by the gpio identifier.
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/pigpiod.html b/DOC/HTML/pigpiod.html
index b40a71eb8922383000e2d2e2bbb590a4d9342714..d522889f7867eb80d2a50b370d328dfaafe5e7bf 100644 (file)
--- a/DOC/HTML/pigpiod.html
+++ b/DOC/HTML/pigpiod.html
@@ -106,7 +106,7 @@ The USB power mode is fixed at 1.2 amps (high power).<br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/pigs.html b/DOC/HTML/pigs.html
index 3aaeaf9612187f72362553691272e9d79132c53f..d4b407939de879d67786f640cbeaf052d2fe3a38 100644 (file)
--- a/DOC/HTML/pigs.html
+++ b/DOC/HTML/pigs.html
@@ -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
 the specified delay between the pulse and the next.
 <br><br><b><small>Example</small></b><br><br><code>$&nbsp;pigs&nbsp;wvas&nbsp;4&nbsp;9600&nbsp;0&nbsp;23&nbsp;45&nbsp;67&nbsp;89&nbsp;90<br>37<br>$&nbsp;pigs&nbsp;wvcre<br>0<br><br>$&nbsp;pigs&nbsp;wvcre<br>-69<br>ERROR:&nbsp;attempt&nbsp;to&nbsp;create&nbsp;an&nbsp;empty&nbsp;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.
 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.
@@ -1260,7 +1260,7 @@ the current GPIO levels.
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/piscope.html b/DOC/HTML/piscope.html
index 643cd03c87a58bc74dc627afa7fe9cb6e4548b9a..92367318e345409fdc09ed8f7270f54efb3b2f52 100644 (file)
--- a/DOC/HTML/piscope.html
+++ b/DOC/HTML/piscope.html
@@ -261,7 +261,7 @@ make install<br></code><br>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/python.html b/DOC/HTML/python.html
index 8b3b0137e90eb7be801ee9e0d9dcd6396dc261a2..f6b5f2286bc3633012c04bd8bcc7b0bcf6cb0ca3 100644 (file)
--- a/DOC/HTML/python.html
+++ b/DOC/HTML/python.html
@@ -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.
 <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.
-<br><br><code>pi:&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;<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:&nbsp;0-100,&nbsp;size&nbsp;of&nbsp;waveform&nbsp;as&nbsp;percentage&nbsp;of&nbsp;maximum&nbsp;available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
 function.
 <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.
-<br><br>A usage would be the creation of two waves where one is filled while the other
-is being transmitted. Each wave is assigned 50% of the available resources.
+<br><br>A usage would be the creation of two waves where one is filled while the
+other is being transmitted.  Each wave is assigned 50% of the resources.
 This buffer structure allows the transmission of infinite wave sequences.
 <br><br>Normal usage:
 <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>Step 5. Any wave id can now be deleted and another wave of the same size
         can be created in its place.
-<br><br><b><small>Example</small></b><br><br><code>wid&nbsp;=&nbsp;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&nbsp;=&nbsp;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.
 <br><br><b><small>Parameters</small></b><br><br><samp>wave_id:=&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;a&nbsp;prior&nbsp;call&nbsp;to&nbsp;<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
@@ -1210,6 +1210,7 @@ being currently defined.
 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
 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="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&nbsp;=&nbsp;1<br>PUD_OFF&nbsp;=&nbsp;0<br>PUD_UP&nbsp;=&nbsp;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>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/sif.html b/DOC/HTML/sif.html
index f68905022bf7f080812a15e4f666ce3dc6a84d00..bbaa6e1d1cdfe87c55c7e36ff2e0aa355ac13783 100644 (file)
--- a/DOC/HTML/sif.html
+++ b/DOC/HTML/sif.html
@@ -2050,7 +2050,7 @@ uint8_t data[X]</td>
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/HTML/sitemap.html b/DOC/HTML/sitemap.html
index 18ecc7545bfaa16f9b540549cf3d9bf6ed0a31a0..b2706b1242624c87f1100faa1d8ec89e1c46590e 100644 (file)
--- a/DOC/HTML/sitemap.html
+++ b/DOC/HTML/sitemap.html
@@ -77,7 +77,7 @@
 <table><tr>
 <td style="width: 200px"><div style="text-align: left;"><small>&copy; 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: 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>
 </td>
 </table>

diff --git a/DOC/MAN/pigpio.3 b/DOC/MAN/pigpio.3
index 7fa74e3b28a1f99014d19e70ffa8eb2bbfc7dd35..c878cbd2ada14f3228e0a31003daf0323419c5c9 100644 (file)
--- a/DOC/MAN/pigpio.3
+++ b/DOC/MAN/pigpio.3
@@ -9569,6 +9569,27 @@ An array of script parameters.
 
 .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
 
 .EX

diff --git a/DOC/MAN/pigpiod_if2.3 b/DOC/MAN/pigpiod_if2.3
index b6924c674f03bc91e03e16877c78213be00cbde0..f07de8df019b359ccceaaa41d0f480737d4ac809 100644 (file)
--- a/DOC/MAN/pigpiod_if2.3
+++ b/DOC/MAN/pigpiod_if2.3
@@ -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 "" 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
 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
-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.
+of deleted waves while a transmission is active.
 
 .br
 
@@ -2410,6 +2408,8 @@ PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
 .EX
 pi: >=0 (as returned by \fBpigpio_start\fP).
 .br
+percent: 0-100, size of waveform as percentage of maximum available.
+.br
 
 .EE
 
@@ -2429,7 +2429,7 @@ wave id is passed to \fBwave_send_*\fP to specify the waveform to transmit.
 
 .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.
 
 .br
@@ -7499,6 +7499,13 @@ An array of script parameters.
 
 .br
 
+.IP "\fBpercent\fP: 0-100" 0
+The size of waveform as percentage of maximum available.
+
+.br
+
+.br
+
 .IP "\fBpi\fP" 0
 An integer defining a connected Pi.  The value is returned by
 \fBpigpio_start\fP upon success.

diff --git a/DOC/MAN/pigs.1 b/DOC/MAN/pigs.1
index fa99470765dfd9bb5798165c208a66bfa14fd302..9b6192c28873ca3dfa43cfc1d0dbaec41bb623a3 100644 (file)
--- a/DOC/MAN/pigs.1
+++ b/DOC/MAN/pigs.1
@@ -5146,7 +5146,7 @@ ERROR: attempt to create an empty waveform
 .IP "" 4
 
 .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.
 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.

diff --git a/DOC/dbase/pigpio.sqlite b/DOC/dbase/pigpio.sqlite
index 98a0cb19485f27af5e7bab2167beae8c23e59378..531ccfdfd27ef10f9bcf37d19363c790d85c0e4e 100644 (file)
Binary files a/DOC/dbase/pigpio.sqlite and b/DOC/dbase/pigpio.sqlite differ

diff --git a/DOC/dbase/pigpio.sqlite.2020-04-30-08-51-48 b/DOC/dbase/pigpio.sqlite.2020-04-30-08-51-48
new file mode 100644 (file)
index 0000000..98a0cb1
Binary files /dev/null and b/DOC/dbase/pigpio.sqlite.2020-04-30-08-51-48 differ

diff --git a/DOC/dbase/pigpio.sqlite.2020-04-30-08-59-05 b/DOC/dbase/pigpio.sqlite.2020-04-30-08-59-05
new file mode 100644 (file)
index 0000000..d763ce9
Binary files /dev/null and b/DOC/dbase/pigpio.sqlite.2020-04-30-08-59-05 differ

diff --git a/DOC/dbase/pigpio.sqlite.2020-04-30-09-37-19 b/DOC/dbase/pigpio.sqlite.2020-04-30-09-37-19
new file mode 100644 (file)
index 0000000..23be3f5
Binary files /dev/null and b/DOC/dbase/pigpio.sqlite.2020-04-30-09-37-19 differ

diff --git a/DOC/dbase/pigpio.sqlite.2020-04-30-09-44-25 b/DOC/dbase/pigpio.sqlite.2020-04-30-09-44-25
new file mode 100644 (file)
index 0000000..1dc038e
Binary files /dev/null and b/DOC/dbase/pigpio.sqlite.2020-04-30-09-44-25 differ

diff --git a/DOC/dbase/pigpio.sqlite.2020-04-30-09-45-49 b/DOC/dbase/pigpio.sqlite.2020-04-30-09-45-49
new file mode 100644 (file)
index 0000000..03f11ba
Binary files /dev/null and b/DOC/dbase/pigpio.sqlite.2020-04-30-09-45-49 differ

diff --git a/DOC/dbase/pigpio.sqlite.2020-04-30-09-48-51 b/DOC/dbase/pigpio.sqlite.2020-04-30-09-48-51
new file mode 100644 (file)
index 0000000..d37369e
Binary files /dev/null and b/DOC/dbase/pigpio.sqlite.2020-04-30-09-48-51 differ

diff --git a/DOC/src/defs/pigs.def b/DOC/src/defs/pigs.def
index 82fca736f2ba010ecb68e7bb0bbe50c2de19165f..2f6d23c61fdb31e0fdf88f81e1cf9e02a95c81f1 100644 (file)
--- a/DOC/src/defs/pigs.def
+++ b/DOC/src/defs/pigs.def
@@ -2786,7 +2786,7 @@ ERROR: attempt to create an empty waveform
 
 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.
 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.

diff --git a/DOC/tmp/body/cif.body b/DOC/tmp/body/cif.body
index 28205fdc77a99e602ef26122942de9236f098599..f20d1c487ca6b2ff6609fa67a294ee01da300bc0 100644 (file)
--- a/DOC/tmp/body/cif.body
+++ b/DOC/tmp/body/cif.body
@@ -1675,6 +1675,12 @@ The mA which may be drawn from each GPIO whilst still guaranteeing the
 high and low levels.
 <h3><a name="*param">*param</a></h3>
 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>
 <code>typedef&nbsp;struct<br>{<br>&nbsp;&nbsp;&nbsp;uint16_t&nbsp;addr;&nbsp;&nbsp;//&nbsp;slave&nbsp;address<br>&nbsp;&nbsp;&nbsp;uint16_t&nbsp;flags;<br>&nbsp;&nbsp;&nbsp;uint16_t&nbsp;len;&nbsp;&nbsp;&nbsp;//&nbsp;msg&nbsp;length<br>&nbsp;&nbsp;&nbsp;uint8_t&nbsp;&nbsp;*buf;&nbsp;&nbsp;//&nbsp;pointer&nbsp;to&nbsp;msg&nbsp;data<br>}&nbsp;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.

diff --git a/DOC/tmp/body/pdif2.body b/DOC/tmp/body/pdif2.body
index ecebd36cf1885da730be57609677477ae2af1c54..21d2b4b29c4548643180556d173587b30abfaed4 100644 (file)
--- a/DOC/tmp/body/pdif2.body
+++ b/DOC/tmp/body/pdif2.body
@@ -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,
 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>
-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
 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
-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><code>pi:&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;<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
+of deleted waves while a transmission is active.
+<br><br><code>pi:&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;<a href="#pigpio_start">pigpio_start</a>).<br>percent:&nbsp;0-100,&nbsp;size&nbsp;of&nbsp;waveform&nbsp;as&nbsp;percentage&nbsp;of&nbsp;maximum&nbsp;available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
 function.
 <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.
 <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.
 <br><br>Normal usage:
 <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.
 <h3><a name="*param">*param</a></h3>
 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>
 An integer defining a connected Pi.  The value is returned by
 <a href="#pigpio_start">pigpio_start</a> upon success.

diff --git a/DOC/tmp/body/pigs.body b/DOC/tmp/body/pigs.body
index f4b7a7e54cb85ec32ef12c0d3ee715d81ef9179f..4a88b42acddc0fb16401ef5463fc9c692d392263 100644 (file)
--- a/DOC/tmp/body/pigs.body
+++ b/DOC/tmp/body/pigs.body
@@ -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
 the specified delay between the pulse and the next.
 <br><br><b><small>Example</small></b><br><br><code>$&nbsp;pigs&nbsp;wvas&nbsp;4&nbsp;9600&nbsp;0&nbsp;23&nbsp;45&nbsp;67&nbsp;89&nbsp;90<br>37<br>$&nbsp;pigs&nbsp;wvcre<br>0<br><br>$&nbsp;pigs&nbsp;wvcre<br>-69<br>ERROR:&nbsp;attempt&nbsp;to&nbsp;create&nbsp;an&nbsp;empty&nbsp;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.
 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.

diff --git a/DOC/tmp/body/python.body b/DOC/tmp/body/python.body
index f0368662acca94f9991a2cae71c3b0225b71da85..4f756e46a4d226b520ae41354420f968acf5dd19 100644 (file)
--- a/DOC/tmp/body/python.body
+++ b/DOC/tmp/body/python.body
@@ -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.
 <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.
-<br><br><code>pi:&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;<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:&nbsp;0-100,&nbsp;size&nbsp;of&nbsp;waveform&nbsp;as&nbsp;percentage&nbsp;of&nbsp;maximum&nbsp;available.<br></code><br><br>The data provided by the <a href="#wave_add_*">wave_add_*</a> functions are consumed by this
 function.
 <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.
-<br><br>A usage would be the creation of two waves where one is filled while the other
-is being transmitted. Each wave is assigned 50% of the available resources.
+<br><br>A usage would be the creation of two waves where one is filled while the
+other is being transmitted.  Each wave is assigned 50% of the resources.
 This buffer structure allows the transmission of infinite wave sequences.
 <br><br>Normal usage:
 <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>Step 5. Any wave id can now be deleted and another wave of the same size
         can be created in its place.
-<br><br><b><small>Example</small></b><br><br><code>wid&nbsp;=&nbsp;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&nbsp;=&nbsp;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.
 <br><br><b><small>Parameters</small></b><br><br><samp>wave_id:=&nbsp;&gt;=0&nbsp;(as&nbsp;returned&nbsp;by&nbsp;a&nbsp;prior&nbsp;call&nbsp;to&nbsp;<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
@@ -1170,6 +1170,7 @@ being currently defined.
 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
 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="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&nbsp;=&nbsp;1<br>PUD_OFF&nbsp;=&nbsp;0<br>PUD_UP&nbsp;=&nbsp;2<br></code><h3><a name="pulse_len"></a>pulse_len: 1-100</h3>The length of the trigger pulse in microseconds.

diff --git a/DOC/tmp/pydoc/pigpio.pydoc b/DOC/tmp/pydoc/pigpio.pydoc
index 0286caf869c6ddfbb2d1993e49531d0dc58cb729..c5dbdc21297a8e420a1742d622fc63e5afcbf1a9 100644 (file)
--- a/DOC/tmp/pydoc/pigpio.pydoc
+++ b/DOC/tmp/pydoc/pigpio.pydoc
@@ -3174,7 +3174,7 @@ CLASSES
      |      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
@@ -3183,8 +3183,8 @@ CLASSES
      |      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 being transmitted. Each wave is assigned 50% of the available resources.
+     |      A usage would be the creation of two waves where one is filled while the
+     |      other is being transmitted.  Each wave is assigned 50% of the resources.
      |      This buffer structure allows the transmission of infinite wave sequences.
      |      
      |      Normal usage:
@@ -3203,7 +3203,7 @@ CLASSES
      |              can be created in its place.
      |      
      |      ...
-     |      wid = pi.wave_create(50)
+     |      wid = pi.wave_create_and_pad(50)
      |      ...
      |  
      |  wave_delete(self, wave_id)
@@ -3834,6 +3834,9 @@ FUNCTIONS
         When scripts are started they can receive up to 10 parameters
         to define their operation.
         
+        percent:: 0-100
+        The size of waveform as percentage of maximum available.
+        
         port:
         The port used by the pigpio daemon, defaults to 8888.
         

diff --git a/pigpio.3 b/pigpio.3
index 7fa74e3b28a1f99014d19e70ffa8eb2bbfc7dd35..c878cbd2ada14f3228e0a31003daf0323419c5c9 100644 (file)
--- a/pigpio.3
+++ b/pigpio.3
@@ -9569,6 +9569,27 @@ An array of script parameters.
 
 .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
 
 .EX

diff --git a/pigpio.h b/pigpio.h
index 208c802bc8aa19b189cf89dd9056e27945376837..5794e4e44915ebe11a2fe488ec259db64b12e4c4 100644 (file)
--- a/pigpio.h
+++ b/pigpio.h
@@ -5804,6 +5804,15 @@ high and low levels.
 *param::
 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::
 . .
 typedef struct

diff --git a/pigpio.py b/pigpio.py
index c9134368c9389451e11c31d315d3634799b1738d..978aff2f1446e1f2d0ff31e9e9807c5717bdac64 100644 (file)
--- a/pigpio.py
+++ b/pigpio.py
@@ -2312,12 +2312,12 @@ class pi():
       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*]).
+      percent: 0-100, size of waveform as percentage of maximum available.
       . .
 
       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
       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 being transmitted. Each wave is assigned 50% of the available resources.
+      A usage would be the creation of two waves where one is filled while the
+      other is being transmitted.  Each wave is assigned 50% of the resources.
       This buffer structure allows the transmission of infinite wave sequences.
-      
+
       Normal usage:
 
       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.
 
       Repeat steps 2-4 as needed.
-      
+
       Step 5. Any wave id can now be deleted and another wave of the same size
               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))
@@ -5629,6 +5629,9 @@ def xref():
    When scripts are started they can receive up to 10 parameters
    to define their operation.
 
+   percent:: 0-100
+   The size of waveform as percentage of maximum available.
+   
    port:
    The port used by the pigpio daemon, defaults to 8888.
 

diff --git a/pigpiod_if2.3 b/pigpiod_if2.3
index b6924c674f03bc91e03e16877c78213be00cbde0..f07de8df019b359ccceaaa41d0f480737d4ac809 100644 (file)
--- a/pigpiod_if2.3
+++ b/pigpiod_if2.3
@@ -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 "" 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
 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
-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.
+of deleted waves while a transmission is active.
 
 .br
 
@@ -2410,6 +2408,8 @@ PI_TOO_MANY_CBS, PI_TOO_MANY_OOL, or PI_NO_WAVEFORM_ID.
 .EX
 pi: >=0 (as returned by \fBpigpio_start\fP).
 .br
+percent: 0-100, size of waveform as percentage of maximum available.
+.br
 
 .EE
 
@@ -2429,7 +2429,7 @@ wave id is passed to \fBwave_send_*\fP to specify the waveform to transmit.
 
 .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.
 
 .br
@@ -7499,6 +7499,13 @@ An array of script parameters.
 
 .br
 
+.IP "\fBpercent\fP: 0-100" 0
+The size of waveform as percentage of maximum available.
+
+.br
+
+.br
+
 .IP "\fBpi\fP" 0
 An integer defining a connected Pi.  The value is returned by
 \fBpigpio_start\fP upon success.

diff --git a/pigpiod_if2.h b/pigpiod_if2.h
index 9c5592955e55b206a8a3b78fa33bcfd2abe754d0..79d0223a38a12d1ce7ba040f9ab350909b09cafd 100644 (file)
--- a/pigpiod_if2.h
+++ b/pigpiod_if2.h
@@ -1376,15 +1376,14 @@ D*/
 /*F*/
 int wave_create_and_pad(int pi, int percent);
 /*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
 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.
+of deleted waves while a transmission is active.
 
 . .
 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
@@ -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.
 
 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.
 
 Normal usage:
@@ -4128,6 +4127,9 @@ high and low levels.
 *param::
 An array of script parameters.
 
+percent:: 0-100
+The size of waveform as percentage of maximum available.
+
 pi::
 An integer defining a connected Pi.  The value is returned by
 [*pigpio_start*] upon success.

diff --git a/pigs.1 b/pigs.1
index fa99470765dfd9bb5798165c208a66bfa14fd302..9b6192c28873ca3dfa43cfc1d0dbaec41bb623a3 100644 (file)
--- a/pigs.1
+++ b/pigs.1
@@ -5146,7 +5146,7 @@ ERROR: attempt to create an empty waveform
 .IP "" 4
 
 .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.
 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.