Skip to content

Commit c2d069e

Browse files
improve markdown formatting
1 parent 9c6626a commit c2d069e

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

src/wave.jl

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -280,18 +280,18 @@ end
280280
"""
281281
Transmits the waveform with id wave_id using mode mode.
282282
283-
* `wave_id`: >=0 (as returned by a prior call to `wave_create`).
284-
* `mode`: WAVE_MODE_ONE_SHOT, WAVE_MODE_REPEAT,
285-
WAVE_MODE_ONE_SHOT_SYNC, or WAVE_MODE_REPEAT_SYNC.
283+
* `wave_id`: >0= (as returned by a prior call to `wave_create`).
284+
* `mode`: `PiGPIO.WAVE_MODE_ONE_SHOT`, `PiGPIO.WAVE_MODE_REPEAT`,
285+
`PiGPIO.WAVE_MODE_ONE_SHOT_SYNC`, or `PiGPIO.WAVE_MODE_REPEAT_SYNC`.
286286
287-
WAVE_MODE_ONE_SHOT: same as `wave_send_once`.
287+
`PiGPIO.WAVE_MODE_ONE_SHOT`: same as `wave_send_once`.
288288
289-
WAVE_MODE_REPEAT same as `wave_send_repeat`.
289+
`PiGPIO.WAVE_MODE_REPEAT` same as `wave_send_repeat`.
290290
291-
WAVE_MODE_ONE_SHOT_SYNC same as `wave_send_once` but tries
291+
`PiGPIO.WAVE_MODE_ONE_SHOT_SYNC` same as `wave_send_once` but tries
292292
to sync with the previous waveform.
293293
294-
WAVE_MODE_REPEAT_SYNC same as `wave_send_repeat` but tries
294+
`PiGPIO.WAVE_MODE_REPEAT_SYNC` same as `wave_send_repeat` but tries
295295
to sync with the previous waveform.
296296
297297
WARNING: bad things may happen if you delete the previous
@@ -305,7 +305,7 @@ be cancelled.
305305
Returns the number of DMA control blocks used in the waveform.
306306
307307
```julia
308-
cbs = wave_send_using_mode(pi, wid, WAVE_MODE_REPEAT_SYNC)
308+
cbs = wave_send_using_mode(pi, wid, PiGPIO.WAVE_MODE_REPEAT_SYNC)
309309
```
310310
"""
311311
function wave_send_using_mode(self::Pi, wave_id, mode)
@@ -319,8 +319,8 @@ transmitted.
319319
Returns the waveform id or one of the following special
320320
values
321321
322-
WAVE_NOT_FOUND (9998) - transmitted wave not found.
323-
NO_TX_WAVE (9999) - no wave being transmitted.
322+
`PiGPIO.WAVE_NOT_FOUND` (9998) - transmitted wave not found.
323+
`PiGPIO.NO_TX_WAVE` (9999) - no wave being transmitted.
324324
325325
```julia
326326
wid = wave_tx_at(pi, )
@@ -351,14 +351,14 @@ end
351351
Stops the transmission of the current waveform.
352352
353353
This function is intended to stop a waveform started with
354-
wave_send_repeat.
354+
`wave_send_repeat`.
355355
356356
```julia
357357
wave_send_repeat(pi, 3)
358358
359-
time.sleep(5)
359+
sleep(5)
360360
361-
wave_tx_stop(pi, )
361+
wave_tx_stop(pi)
362362
```
363363
"""
364364
function wave_tx_stop(self::Pi)
@@ -391,11 +391,13 @@ Delays between waves may be added with the delay command.
391391
392392
The following command codes are supported
393393
394+
```
394395
Name @ Cmd & Data @ Meaning
395396
Loop Start @ 255 0 @ Identify start of a wave block
396397
Loop Repeat @ 255 1 x y @ loop x + y*256 times
397398
Delay @ 255 2 x y @ delay x + y*256 microseconds
398399
Loop Forever @ 255 3 @ loop forever
400+
```
399401
400402
If present Loop Forever must be the last entry in the chain.
401403

0 commit comments

Comments
 (0)