updated documentation (fmc-dio and wr-starting-kit)

cf02c586 · Maciej Lipinski · e770b0a4 · cf02c586 · 15d818af
Commit cf02c586 authored Oct 07, 2020 by Maciej Lipinski
Hide whitespace changes
Inline Side-by-side

Showing with 34 additions and 4 deletions

wr-starting-kit.md doc/wr-starting-kit.md +33 -3

fmc-dio fmc-dio +1 -1

No files found.
--- a/doc/wr-starting-kit.md
+++ b/doc/wr-starting-kit.md
@@ -927,7 +927,7 @@ To reset to the default mode you can reset/reprogram the FPGA or set it back wit
 ~~~~~~~~~~~~~~~~


-### Generating pulse
+### Generating a pulse and a train of pulses

 The command is used in the following formats:

@@ -968,6 +968,33 @@ try the following commands in the slave SPEC device:
 > ***Warning:*** You must ensure that WR date is synchronized with system one.
 > See setsec command in [Generating pulse](#generating-pulse) section.

+If the two optional parameters `[<period> <count>]` of the `pulse` command
+are specified, a train of pulses is generated. The number of pulses can
+be specified using `<count>`. If this parameter is set to -1, the pulses
+are generated until new configuration is specified. Setting  `<count>` to
+zero stops pulse generation.
+
+~~~~~{.sh}
+## Starting now, generate train of 5 pulses on channel 4 with pulse with of 0.1 second period of 0.5 second
+>:$ sudo wr-dio-cmd /dev/fmc-dio-1:0 pulse 4 .1 now 0.5 5
+
+
+## Starting in the middle of the next second, generate an indefinite train of pulses on channel 4 with pulse width of 1 millisecond and period of 10 milliseconds
+>:$ sudo wr-dio-cmd /dev/fmc-dio-1:0 pulse 4 .001 +1.5 .01 -1
+
+
+## Update the pulse width in channel 4 from 1 to 5 millisecond
+>:$ sudo wr-dio-cmd /dev/fmc-dio-1:0 update_width 4 .005
+
+## Stop the pulse generation
+>:$ sudo wr-dio-cmd /dev/fmc-dio-1:0 pulse 4 .001 +1.5 .05 0
+
+
+## Starting at 17:00 today, generate train of 5 pulses on channel 4 with pulse width of 2 milliseconds and period of 10 milliseconds
+>:$ sudo wr-dio-cmd /dev/fmc-dio-1:0 pulse 4 .002 $(date +%s --date 17:00) 0.01 5
+~~~~~~~~
+
+
 ### Time stamping output

 Once you have generated the pulse you can retrieve its timestamp by executing:
@@ -983,6 +1010,7 @@ ch 4,       504.500000000
 ch 4,       530.500000000
 ch 4,       534.500000000
 ch 4,       542.500000000
+...
 ~~~~~~~~

 > ***Notes:*** If you see other timestampings messages coming from channel 2
@@ -1513,8 +1541,10 @@ free-running oscillator as a time reference. However, you can also
 discipline your Master [SPEC] with external 10 MHz and 1-PPS signal by
 connecting them to appropiate LEMO connectors of [FMC-DIO] board (note: channel
 0 is the first one):
- connected 10 MHz to channel 4.
- connected 1-PPS to channel 3.
+
+* connected 10 MHz to channel 4.
+* connected 1-PPS to channel 3.
+

 ![Grandmaster setup](img/ssk_grandmaster.jpg)


--- a/fmc-dio @ 15d818af
+++ b/fmc-dio @ 15d818af
-Subproject commit 5982b79c614892a77f26dd1e073715cf91dc0fe0
+Subproject commit 15d818af48a47a70135f2fe9d76dcad7fd2a5567