MirrorSave
/
pigpio
mirror of https://github.com/joan2937/pigpio
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updated pigs.def for WVCAP and download.html for download version

This commit is contained in:
joan2937 2020-05-04 20:46:45 +01:00 committed by Guy McSwain
parent 41b3cdfc65
commit 90d206e941
4 changed files with 39 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
DOC/dbase/pigpio.sqlite
View File

Binary file not shown.

27
DOC/src/defs/pigs.def
View 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.

14
DOC/src/html/download.html
View 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>

34
pigs.1
View File

@ -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.