diff --git a/.gitignore b/.gitignore index 140d796..39331b5 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,10 @@ build dist *.egg-info wavepad_jitter.py +# DOC files +DOC/dbase/pigpio.sqlite.* +DOC/tmp +DOC/MAN/* +!DOC/MAN/README* +DOC/HTML/*.html diff --git a/DOC/dbase/pigpio.sqlite b/DOC/dbase/pigpio.sqlite index 531ccfd..22ceb98 100644 Binary files a/DOC/dbase/pigpio.sqlite and b/DOC/dbase/pigpio.sqlite differ diff --git a/DOC/src/defs/pigs.def b/DOC/src/defs/pigs.def index 2f6d23c..7c3ef07 100644 --- a/DOC/src/defs/pigs.def +++ b/DOC/src/defs/pigs.def @@ -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. diff --git a/DOC/src/html/download.html b/DOC/src/html/download.html index 8c2c7be..740a3c8 100644 --- a/DOC/src/html/download.html +++ b/DOC/src/html/download.html @@ -1,7 +1,7 @@ - + download @@ -14,12 +14,14 @@ pigpiod).
compilation of pigpio.c, takes 100 seconds on early model Pis.  Be patient.  The overall install takes just over 3 minutes.
-

Download and install (V75)

-wget https://github.com/joan2937/pigpio/archive/v75.zip
-unzip v75.zip
-cd pigpio-75
+

Download and install latest version

+ +wget https://github.com/joan2937/pigpio/archive/master.zip
+unzip master.zip
+cd pigpio-master
make
-sudo make install

+sudo make install
+
If the Python part of the install fails it may be because you need the setup tools.
diff --git a/pigs.1 b/pigs.1 index 9b6192c..b315910 100644 --- 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.