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
parent 1c9b6e2790
commit 18e532b840
5 changed files with 45 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored
View File

@ -13,4 +13,10 @@ build
dist dist
*.egg-info *.egg-info
wavepad_jitter.py wavepad_jitter.py
# DOC files
DOC/dbase/pigpio.sqlite.*
DOC/tmp
DOC/MAN/*
!DOC/MAN/README*
DOC/HTML/*.html

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 WVAS u b db sb o bvs :: Add serial data to waveform :: gpioWaveAddSerial
WVCRE :: Create a waveform :: gpioWaveCreate 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 WVDEL wid :: Delete selected waveform :: gpioWaveDelete
WVTX wid :: Transmits waveform once :: gpioWaveTxSend WVTX wid :: Transmits waveform once :: gpioWaveTxSend
@ -2786,20 +2786,13 @@ ERROR: attempt to create an empty waveform
WVCAP :: WVCAP ::
Similar to [*WVCRE*], this command creates a waveform but pads the consumed 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.
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.
Upon success a wave id (>=0) is returned. On error a negative status Upon success a wave id (>=0) is returned. On error a negative status code will be returned.
code will be returned.
The data provided by the [*WVAG*] and [*WVAS*] commands are The data provided by the [*WVAG*] and [*WVAS*] commands are consumed by this command.
consumed by this command.
As many waveforms may be created as there is space available. 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.
The wave id is passed to [*WVTX*] or [*WVTXR*] to specify the
waveform to transmit.
Normal usage would be 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. 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.
Example
... ...
# Create a wave that consumes 50% of the total resource: # 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) pdc :: hardware PWM dutycycle (0-1000000)
The command expects a dutycycle. 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) pf :: hardware PWM frequency (1-125M, 1-187.5M for the BCM2711)
The command expects a frequency. 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"> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html> <html>
<head> <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"> <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>download</title> <title>download</title>
</head> </head>
@ -14,12 +14,14 @@ pigpiod).<br>
compilation of pigpio.c, takes 100 seconds on early model compilation of pigpio.c, takes 100 seconds on early model
Pis.&nbsp; Be patient.&nbsp; The overall install takes just over 3 Pis.&nbsp; Be patient.&nbsp; The overall install takes just over 3
minutes.</span><br style="font-weight: bold;"> minutes.</span><br style="font-weight: bold;">
<h3>Download and install (V75)<br></h3> <h3>Download and install latest version<br></h3>
<code>wget https://github.com/joan2937/pigpio/archive/v75.zip<br> <code>
unzip v75.zip<br> wget https://github.com/joan2937/pigpio/archive/master.zip<br>
cd pigpio-75<br> unzip master.zip<br>
cd pigpio-master<br>
make<br> make<br>
sudo make install<br></code><br> sudo make install<br>
</code>
<br> <br>
If the Python part of the install fails it may be because you need If the Python part of the install fails it may be because you need
the setup tools.<br> the setup tools.<br>

32
pigs.1
View File

@ -548,7 +548,7 @@ Add serial data to waveform
.B WVCRE .B WVCRE
Create a waveform Create a waveform
.P .P
.B WVCAP .B WVCAP percent
Create a waveform of fixed size Create a waveform of fixed size
.P .P
.B WVDEL wid .B WVDEL wid
@ -5142,27 +5142,20 @@ ERROR: attempt to create an empty waveform
.br .br
.IP "\fBWVCAP \fP - Create a waveform of fixed size" .IP "\fBWVCAP percent\fP - Create a waveform of fixed size"
.IP "" 4 .IP "" 4
.br .br
Similar to \fBWVCRE\fP, this command creates a waveform but pads the consumed 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.
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.
.br .br
Upon success a wave id (>=0) is returned. On error a negative status Upon success a wave id (>=0) is returned. On error a negative status code will be returned.
code will be returned.
.br .br
The data provided by the \fBWVAG\fP and \fBWVAS\fP commands are The data provided by the \fBWVAG\fP and \fBWVAS\fP commands are consumed by this command.
consumed by this command.
.br .br
As many waveforms may be created as there is space available. 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.
The wave id is passed to \fBWVTX\fP or \fBWVTXR\fP to specify the
waveform to transmit.
.br .br
Normal usage would be 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. Repeat steps 2 - 4 as needed.
.br .br
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.
.br
Example
.br .br
@ -5881,6 +5876,13 @@ The command expects a dutycycle.
.br .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 .IP "\fBpf\fP - hardware PWM frequency (1-125M, 1-187.5M for the BCM2711)" 0
The command expects a frequency. The command expects a frequency.