Fix issue #356, document wave_tx_at API is not supported on chained waves.
authorGuy McSwain <guy.mcswain@gmail.com>
Fri, 26 Jun 2020 03:26:41 +0000 (22:26 -0500)
committerGuy McSwain <guy.mcswain@gmail.com>
Sat, 27 Jun 2020 12:25:45 +0000 (07:25 -0500)
pigpio.h
pigpio.py
pigpiod_if2.h
pigs.1

index 7aa6f780b23b7f8156df5d67a18063ebaea9782e..c3185155599e5200507569fbf5660c1db619a5e6 100644 (file)
--- 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:
 
index 2d418b16bb0c8fc46713b8a332e5828b12b09f14..7fc80a571fff61cbd076af9105e5b00ee8a972ad 100644 (file)
--- 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:
index 79d0223a38a12d1ce7ba040f9ab350909b09cafd..9700cc09db5809366148b1c8eb0a75a3349300a1 100644 (file)
@@ -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 b315910215185d126a870649e2a005218a86451f..8fa4337c0b05e7304d86bf905b5709efcef18302 100644 (file)
--- 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