summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGuy McSwain <guy.mcswain@gmail.com>2020-06-25 22:26:41 -0500
committerGuy McSwain <guy.mcswain@gmail.com>2020-06-26 13:25:59 -0500
commit11c75ee5eaf0b7a32ca5abbb7dfec0bdb25c2e86 (patch)
treed997ccced6aa9705a85df8a00a6b9da5b46773e0
parent9fe95e831c2db13419c92a185e45e50b91f3ba29 (diff)
Fix issue #356, document wave_tx_at API is not supported on chained waves.
-rw-r--r--pigpio.h2
-rw-r--r--pigpio.py2
-rw-r--r--pigpiod_if2.h2
-rw-r--r--pigs.12
4 files changed, 4 insertions, 4 deletions
diff --git a/pigpio.h b/pigpio.h
index 7aa6f78..c318515 100644
--- a/pigpio.h
+++ b/pigpio.h
@@ -2181,7 +2181,7 @@ D*/
int gpioWaveTxAt(void);
/*D
This function returns the id of the waveform currently being
-transmitted.
+transmitted using [*gpioWaveTxSend*]. Chained waves are not supported.
Returns the waveform id or one of the following special values:
diff --git a/pigpio.py b/pigpio.py
index 2d418b1..7fc80a5 100644
--- a/pigpio.py
+++ b/pigpio.py
@@ -2466,7 +2466,7 @@ class pi():
def wave_tx_at(self):
"""
Returns the id of the waveform currently being
- transmitted.
+ transmitted using [*wave_send**]. Chained waves are not supported.
Returns the waveform id or one of the following special
values:
diff --git a/pigpiod_if2.h b/pigpiod_if2.h
index 79d0223..9700cc0 100644
--- a/pigpiod_if2.h
+++ b/pigpiod_if2.h
@@ -1609,7 +1609,7 @@ D*/
int wave_tx_at(int pi);
/*D
This function returns the id of the waveform currently being
-transmitted.
+transmitted by [*wave_send**]. Chained waves are not supported.
. .
pi: >=0 (as returned by [*pigpio_start*]).
diff --git a/pigs.1 b/pigs.1
index b315910..8fa4337 100644
--- a/pigs.1
+++ b/pigs.1
@@ -4823,7 +4823,7 @@ $ pigs wvas 7 38400 8 2 0 0x41 0x42
.br
This command returns the id of the waveform currently
-being transmitted.
+being transmitted. Note: chained waves are not supported.
.br
Returns the waveform id or one of the following special