Fix issue #356, document wave_tx_at API is not supported on chained waves.

2020-06-25 22:26:41 -05:00 · 2020-06-25 22:26:41 -05:00 · 1c5b27f41d
parent 1a98364f6f
commit 1c5b27f41d
4 changed files with 4 additions and 4 deletions
--- 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:

--- 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:
--- 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*]).
--- 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