updated pigs.def for WVCAP and download.html for download version
authorjoan2937 <joan@abyz.me.uk>
Mon, 4 May 2020 19:46:45 +0000 (20:46 +0100)
committerGuy McSwain <guy.mcswain@gmail.com>
Sat, 27 Jun 2020 12:25:38 +0000 (07:25 -0500)
DOC/dbase/pigpio.sqlite
DOC/src/defs/pigs.def
DOC/src/html/download.html
pigs.1

index 531ccfdfd27ef10f9bcf37d19363c790d85c0e4e..22ceb98d1881a04d738f5577804bc7869e75672a 100644 (file)
Binary files a/DOC/dbase/pigpio.sqlite and b/DOC/dbase/pigpio.sqlite differ
index 2f6d23c61fdb31e0fdf88f81e1cf9e02a95c81f1..7c3ef07edb593355f18eabf1b148340074eede4c 100644 (file)
@@ -320,7 +320,7 @@ WVAG trips     :: Add generic pulses to waveform :: gpioWaveAddGeneric
 WVAS u b db sb o bvs :: Add serial data to waveform    :: gpioWaveAddSerial
 
 WVCRE          :: Create a waveform   :: gpioWaveCreate
-WVCAP          :: Create a waveform of fixed size  :: gpioWaveCreatePad
+WVCAP percent  :: Create a waveform of fixed size :: gpioWaveCreatePad
 WVDEL wid      :: Delete selected waveform :: gpioWaveDelete
 
 WVTX wid       :: Transmits waveform once       :: gpioWaveTxSend
@@ -2786,20 +2786,13 @@ ERROR: attempt to create an empty waveform
 
 WVCAP ::
 
-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.
+Create a waveform of fixed size. Similar to [*WVCRE*], this command creates a waveform but pads the consumed resources to a fixed size, specified as a [*percent*] of the total resources. 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.
 
-Upon success a wave id (>=0) is returned.  On error a negative status
-code will be returned.
+Upon success a wave id (>=0) is returned. On error a negative status code will be returned.
 
-The data provided by the [*WVAG*] and [*WVAS*] commands are
-consumed by this command.
+The data provided by the [*WVAG*] and [*WVAS*] commands are consumed by this command.
 
-As many waveforms may be created as there is space available.
-The wave id is passed to [*WVTX*] or [*WVTXR*] to specify the
-waveform to transmit.
+As many waveforms may be created as there is space available. The wave id is passed to [*WVTX*] or [*WVTXR*] to specify the waveform to transmit.
 
 Normal usage would be
 
@@ -2813,8 +2806,9 @@ Step 4. [*WVTX*] or [*WVTXR*] 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.
+Step 5. Any wave id can now be deleted and another wave of the same size can be created in its place.
+
+Example
 
 ...
 # Create a wave that consumes 50% of the total resource:
@@ -3200,6 +3194,11 @@ must match an entry in /opt/pigpio/access.
 pdc :: hardware PWM dutycycle (0-1000000)
 The command expects a dutycycle.
 
+percent :: percent (1-100)
+The percent of wave resources to allocate to a wave.  It can be useful
+to create waves of fixed sizes to prevent wave fragmentation (where
+there are plenty of resources but not a large enough contiguous space).
+
 pf :: hardware PWM frequency (1-125M, 1-187.5M for the BCM2711)
 The command expects a frequency.
 
index 8c2c7bee458620835a9795af3ae7b611dd30f8a7..740a3c8fbe63d72e02157ec9259f4e211e3fec46 100644 (file)
@@ -1,7 +1,7 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head>
-<meta name="generator" content="Bluefish 2.2.10" >
+<meta name="generator" content="Bluefish 2.2.11" >
 <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
 <title>download</title>
 </head>
@@ -14,12 +14,14 @@ pigpiod).<br>
 compilation of pigpio.c, takes 100 seconds on early model
 Pis.&nbsp; Be patient.&nbsp; The overall install takes just over 3
 minutes.</span><br style="font-weight: bold;">
-<h3>Download and install (V75)<br></h3>
-<code>wget https://github.com/joan2937/pigpio/archive/v75.zip<br>
-unzip v75.zip<br>
-cd pigpio-75<br>
+<h3>Download and install latest version<br></h3>
+<code>
+wget https://github.com/joan2937/pigpio/archive/master.zip<br>
+unzip master.zip<br>
+cd pigpio-master<br>
 make<br>
-sudo make install<br></code><br>
+sudo make install<br>
+</code>
 <br>
 If the Python part of the install fails it may be because you need
 the setup tools.<br>
diff --git a/pigs.1 b/pigs.1
index 9b6192c28873ca3dfa43cfc1d0dbaec41bb623a3..b315910215185d126a870649e2a005218a86451f 100644 (file)
--- a/pigs.1
+++ b/pigs.1
@@ -548,8 +548,8 @@ Add serial data to waveform
 .B WVCRE  
 Create a waveform   
 .P
-.B WVCAP  
-Create a waveform of fixed size  
+.B WVCAP percent 
+Create a waveform of fixed size 
 .P
 .B WVDEL wid 
 Delete selected waveform 
@@ -5142,27 +5142,20 @@ ERROR: attempt to create an empty waveform
 
 .br
 
-.IP "\fBWVCAP \fP - Create a waveform of fixed size"
+.IP "\fBWVCAP percent\fP - Create a waveform of fixed size"
 .IP "" 4
 
 .br
-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.
+Create a waveform of fixed size. Similar to \fBWVCRE\fP, this command creates a waveform but pads the consumed resources to a fixed size, specified as a \fBpercent\fP of the total resources. 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.
 
 .br
-Upon success a wave id (>=0) is returned.  On error a negative status
-code will be returned.
+Upon success a wave id (>=0) is returned. On error a negative status code will be returned.
 
 .br
-The data provided by the \fBWVAG\fP and \fBWVAS\fP commands are
-consumed by this command.
+The data provided by the \fBWVAG\fP and \fBWVAS\fP commands are consumed by this command.
 
 .br
-As many waveforms may be created as there is space available.
-The wave id is passed to \fBWVTX\fP or \fBWVTXR\fP to specify the
-waveform to transmit.
+As many waveforms may be created as there is space available. The wave id is passed to \fBWVTX\fP or \fBWVTXR\fP to specify the waveform to transmit.
 
 .br
 Normal usage would be
@@ -5183,8 +5176,10 @@ Step 4. \fBWVTX\fP or \fBWVTXR\fP with the id of the waveform to transmit.
 Repeat steps 2 - 4 as needed.
 
 .br
-Step 5. Any wave id can now be deleted and another wave of the same size
-        can be created in its place.
+Step 5. Any wave id can now be deleted and another wave of the same size can be created in its place.
+
+.br
+Example
 
 .br
 
@@ -5881,6 +5876,13 @@ The command expects a dutycycle.
 
 .br
 
+.IP "\fBpercent\fP - percent (1-100)" 0
+The percent of wave resources to allocate to a wave.  It can be useful
+to create waves of fixed sizes to prevent wave fragmentation (where
+there are plenty of resources but not a large enough contiguous space).
+
+.br
+
 .IP "\fBpf\fP - hardware PWM frequency (1-125M, 1-187.5M for the BCM2711)" 0
 The command expects a frequency.