
Time Controller Series User Manual
Section 10: Appendix: DLT Command Reference
ID QUANTIQUE SA
1227 Geneva
T +41 22 301 83 71
90
Rue Eugène-Marziano 25
Switzerland
F +41 22 301 83 79
10
Appendix: DLT Command Reference
The DataLinkTarget (DLT) Service is responsible for the
Time Controller’s
timestamps reception on
the host computer. It is controlled by commands sent though ZMQ to the host computer on port
6060.
10.1
Command answer format
All DLT commands return an text answer in JSON (JavaScript Object Notation) which is either a JSON
object (key/value pair) or JSON list.
If for any reason, a command fails, it answers with a JSON object with an “error” key, itself
containing an object which describes the error (example below).
{"error":{"description":"unrecognised option '--xyz'"}}
10.2
Commands
10.2.1
start-save
Description
Open an acquisition which saves timestamps in a file on disk.
Command
start-save
Arguments
--id <ID>
(Optional) Associates <ID> to the newly opened acquisition.
If this argument is omitted, a unique ID is automatically
generated.
--address <ADDR>
IP Address <ADDR> of the target Time Controller.
--channel <CHAN>
Channel <CHAN> to acquire.
--filename <PATH>
Full or relative path to the timestamps file.
If the path is relative, the file is stored in the default folder
defined when the DLT was executed.
--with-ref-index
Write reference indexes in the timestamps file.
Answer
Returns the ID associated to the newly opened acquisition.
Answer example:
{"id":"10.98.99.7:5556"}
10.2.2
start-stream
Description
Open an acquisition which streams timestamps over ZMQ (exclusive pair pattern).
Command
start-stream
Arguments
--id <ID>
(Optional) Associates <ID> to the newly opened acquisition.
If this argument is omitted, a unique ID is automatically
generated.
--address <ADDR>
IP Address <ADDR> of the target Time Controller.
--channel <CHAN>
Channel <CHAN> to acquire.