3ec6768e57484a43d3e9d252a348cda99594f7f2
[sigrok-cli.git] / doc / sigrok-cli.1
1 .TH SIGROK\-CLI 1 "March 28, 2019"
2 .SH "NAME"
3 sigrok\-cli \- Command-line client for the sigrok software
4 .SH "SYNOPSIS"
5 .B sigrok\-cli [OPTIONS] [COMMAND]
6 .SH "DESCRIPTION"
7 \fBsigrok\-cli\fP is a cross-platform command line utility for the
8 \fBsigrok\fP software.
9 .PP
10 It cannot display graphical output, but is still sufficient to run through
11 the whole process of hardware initialization, acquisition, protocol decoding
12 and saving the session.
13 .PP
14 It is useful for running on remote or embedded systems, netbooks, PDAs,
15 and for various other use-cases. It can display samples on standard output or
16 save them in various file formats.
17 .SH OPTIONS
18 .TP
19 .B "\-h, \-\-help"
20 Show a help text and exit.
21 .TP
22 .B "\-V, \-\-version"
23 Show
24 .B sigrok\-cli
25 version and the versions of libraries used.
26 .TP
27 .B "\-L, \-\-list\-supported"
28 Show information about supported hardware drivers, input file
29 formats, output file formats, and protocol decoders.
30 .TP
31 .B "\-\-list\-supported\-wiki"
32 Show information about supported protocol decoders in MediaWiki syntax.
33 This is generally only used by developers to easily update the list of
34 supported protocol decoders in the sigrok wiki.
35 .TP
36 \fB\-d, \-\-driver\fP <drivername>
37 Unless doing a global scan, users typically select one of the available
38 drivers. This can speedup program start, and can avoid false matches for
39 ambiguous configurations. Selecting a driver also allows to pass more
40 driver specific options. Use the
41 .BR "\-L " ( "\-\-list\-supported" ")"
42 option to get a list of available drivers.
43 .sp
44 Drivers can take options, in the form \fBkey=value\fP
45 separated by colons.
46 .sp
47 Drivers communicating with hardware via a serial port always need the port
48 specified as the \fBconn\fP option. For example, to use the
49 Openbench Logic Sniffer:
50 .sp
51 .RB "  $ " "sigrok\-cli \-\-driver=ols:conn=/dev/ttyACM0" " [...]"
52 .sp
53 Some USB devices don't use a unique VendorID/ProductID combination, and thus
54 need that specified as well. Notice that colons are used to separate the
55 driver name from the \fBconn\fP option, thus colons cannot be used within the
56 \fBconn\fP option's argument. To select a specific USB device, use either
57 \fBVendorID.ProductID\fP or \fBbus.address\fP:
58 .sp
59 USB \fBVendorID.ProductID\fP example:
60 .sp
61 .RB "  $ " "sigrok\-cli \-\-driver=uni\-t\-ut61e:conn=1a86.e008" " [...]"
62 .sp
63 USB \fBbus.address\fP example:
64 .sp
65 .RB "  $ " "sigrok\-cli \-\-driver=uni\-t\-ut61e:conn=4.6" " [...]"
66 .TP
67 .B "\-D, \-\-dont\-scan"
68 Do not automatically scan for device drivers in the absence of a
69 .BR "\-d " ( "\-\-driver" )
70 specification.
71 .TP
72 .BR "\-c, \-\-config " <deviceoption>
73 A colon-separated list of device options, where each option takes the form
74 .BR key=value .
75 For example, to set the samplerate to 1MHz on a device supported by the
76 fx2lafw driver, you might specify
77 .sp
78 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1m" " [...]"
79 .sp
80 Samplerate is an option common to most logic analyzers. The argument specifies
81 the samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz.
82 The following are all equivalent:
83 .sp
84 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1000000" " [...]"
85 .sp
86 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1m" " [...]"
87 .sp
88 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config \(dqsamplerate=1 MHz\(dq" " [...]"
89 .TP
90 .BR "\-i, \-\-input\-file " <filename>
91 Load input from a file instead of a hardware device. You can specify
92 "-" to use stdin as input. If the
93 .B \-\-input\-format
94 option is not supplied, sigrok\-cli attempts to autodetect the file format of
95 the input file.
96 .sp
97 Example for loading a sigrok session file:
98 .sp
99 .RB "  $ " "sigrok\-cli \-i example.sr" " [...]"
100 .sp
101 Example for loading a WAV file (autodetection of input format):
102 .sp
103 .RB "  $ " "sigrok\-cli \-i example.wav" " [...]
104 .sp
105 Example for loading a VCD file from stdin (autodetection of input format):
106 .sp
107 .RB "  $ " "cat example.vcd | sigrok\-cli \-i \-" " [...]
108 .TP
109 .BR "\-I, \-\-input\-format " <format>
110 When loading an input file, assume it's in the specified format. If this
111 option is not supplied (in addition to
112 .BR \-\-input\-file ),
113 sigrok-cli attempts to autodetect the file format of the input file. Use the
114 .BR "\-L " ( "\-\-list\-supported" ")"
115 option to see a list of available input formats.
116 .sp
117 The format name may optionally be followed by a colon-separated list of
118 options, where each option takes the form
119 .BR "key=value" .
120 .sp
121 Example for loading a binary file with options:
122 .sp
123 .RB "  $ " "sigrok\-cli \-i example.bin"
124 .br
125 .BR "               \-I binary:numchannels=4:samplerate=1mhz" " [...]"
126 .TP
127 .BR "\-o, \-\-output\-file " <filename>
128 Save output to a file instead of writing it to stdout. The default format
129 used when saving is the sigrok session file format. This can be changed with
130 the
131 .B \-\-output\-format
132 option.
133 .sp
134 Example for saving data in the sigrok session format:
135 .sp
136 .RB "  $ " "sigrok\-cli " "[...] " "\-o example.sr"
137 .TP
138 .BR "\-O, \-\-output\-format " <format>
139 Set the output format to use. Use the
140 .BR "\-L " ( "\-\-list\-supported" ")"
141 option to see a list of available output formats.
142 .sp
143 The format name may optionally be followed by a colon-separated list of
144 options, where each option takes the form
145 .BR "key=value" .
146 .sp
147 For example, the
148 .B bits
149 or
150 .B hex
151 formats, for an ASCII bit or ASCII hexadecimal display, can take a "width" option, specifying the number of samples (in bits) to display per line. Thus
152 .B "\-O hex:width=128"
153 will display 128 bits per line, in hexadecimal:
154 .sp
155  0:ffff ffff ffff ffff ffff ffff ffff ffff
156  1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
157 .sp
158 The lines always start with the channel number (or name, if defined), followed by a colon. If no format is specified, it defaults to
159 .BR bits:width=64 ,
160 like this:
161 .sp
162  0:11111111 11111111 11111111 11111111 [...]
163  1:11111111 00000000 11111111 00000000 [...]
164 .sp
165 Example for saving data in the CSV format with options:
166 .sp
167 .RB "  $ " "sigrok\-cli " "[...] " "\-o example.csv \-O csv:dedup:header=false"
168 .sp
169 Notice that boolean options are \fBtrue\fP when no value gets specified.
170 .TP
171 .BR "\-C, \-\-channels " <channellist>
172 A comma-separated list of channels to be used in the session.
173 .sp
174 Note that sigrok always names the channels according to how they're shown on
175 the enclosure of the hardware. If your logic analyzer numbers the channels 0\-15,
176 that's how you must specify them with this option. An oscilloscope's channels
177 would generally be referred to as "CH1", "CH2", and so on.
178 Use the \fB\-\-show\fP option to see a list of channel names for your device.
179 .sp
180 The default is to use all the channels available on a device. You can name
181 a channel like this:
182 .BR "1=CLK" .
183 A range of channels can also be given, in the form
184 .BR "1\-5" .
185 .sp
186 Example:
187 .sp
188 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
189 .br
190 .B "               \-\-channels 1=CLK,2\-4,7"
191 .br
192  CLK:11111111 11111111 11111111 11111111 [...]
193    2:11111111 11111111 11111111 11111111 [...]
194    3:11111111 11111111 11111111 11111111 [...]
195    4:11111111 11111111 11111111 11111111 [...]
196    7:11111111 11111111 11111111 11111111 [...]
197 .sp
198 The comma-separated list is processed from left to right, i.e. items farther
199 to the right override previous items. For example
200 .B "1=CS,CS=MISO"
201 will set the name of channel 1 to
202 .BR "MISO" .
203 .TP
204 .BR "\-g, \-\-channel\-group "<channel\ group>
205 Specify the channel group to operate on. Some devices organize channels into
206 groups, the settings of which can only be changed as a group. The list of
207 channel groups, if any, is displayed with the \fB\-\-show\fP command.
208 .sp
209 Examples:
210 .sp
211 .RB "  $ " "sigrok\-cli \-g CH1" " [...]"
212 .sp
213 .RB "  $ " "sigrok\-cli \-d demo \-g Logic \-c pattern=graycode" " [...]"
214 .TP
215 .BR "\-t, \-\-triggers " <triggerlist>
216 A comma-separated list of triggers to use, of the form
217 .BR "<channel>=<trigger>" .
218 You can use the name or number of the channel, and the trigger itself is a
219 series of characters:
220 .sp
221 .BR "0 or 1" :
222 A low or high value on the pin.
223 .br
224 .BR "r or f" :
225 A rising or falling value on the pin. An
226 .B r
227 effectively corresponds to
228 .BR 01 .
229 .br
230 .BR "e" :
231 Any kind of change on a pin (either a rising or a falling edge).
232 .sp
233 Not every device supports all of these trigger types. Use the \fB\-\-show\fP
234 command to see which triggers your device supports.
235 .TP
236 .BR "\-w, \-\-wait\-trigger"
237 Don't output any sample data (even if it's actually received from the
238 hardware) before the trigger condition is met. In other words, do not output
239 any pre-trigger data. This option is useful if you don't care about the data
240 that came before the trigger (but the hardware delivers this data to sigrok
241 nonetheless).
242 .TP
243 .BR "\-P, \-\-protocol\-decoders " <list>
244 This option allows the user to specify a comma-separated list of protocol
245 decoders to be used in this session. The decoders are specified by their
246 ID, as shown in the
247 .BR "\-L " ( "\-\-list\-supported" ")"
248 output.
249 .sp
250 Example:
251 .sp
252  $
253 .B "sigrok\-cli \-i <file.sr> \-P i2c"
254 .sp
255 Each protocol decoder can optionally be followed by a colon-separated list
256 of options, where each option takes the form
257 .BR "key=value" .
258 .sp
259 Example:
260 .sp
261  $
262 .B "sigrok\-cli \-i <file.sr> "
263 .br
264 .B "              \-P uart:baudrate=115200:parity_type=odd"
265 .sp
266 The list of supported options depends entirely on the protocol decoder. Every
267 protocol decoder has different options it supports.
268 .sp
269 Any "options" specified for a protocol decoder which are not actually
270 supported options, will be interpreted as being channel name/number assignments.
271 .sp
272 Example:
273 .sp
274  $
275 .B "sigrok\-cli \-i <file.sr>"
276 .br
277 .B "              \-P spi:wordsize=9:miso=1:mosi=5:clk=3:cs=0"
278 .sp
279 In this example,
280 .B wordsize
281 is an option supported by the
282 .B spi
283 protocol decoder. Additionally, the user tells sigrok to decode the SPI
284 protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3
285 as CLK, and channel 0 as CS# signal.
286 .sp
287 Notice that the
288 .B sigrok\-cli
289 application does not support "name matching". Instead it's assumed that the
290 traces in the input stream match the order of the decoder's input signals,
291 or that users explicitly specify the input channel to decoder signal mapping.
292 .br
293 .sp
294 When multiple decoders are specified in the same
295 .BR -P
296 option, they will be stacked on top of each other in the specified order.
297 .sp
298 Example:
299 .sp
300  $
301 .B "sigrok\-cli \-i <file.sr> \-P i2c,eeprom24xx"
302 .br
303  $
304 .B "sigrok\-cli \-i <file.sr> \-P uart:baudrate=31250,midi"
305 .sp
306 When multiple
307 .BR -P
308 options are specified, each of them creates one decoder stack, which
309 executes in parallel to other decoder stacks.
310 .sp
311 Example:
312 .sp
313  $
314 .B "sigrok\-cli \-i <file.sr> \-P uart:tx=D0:rx=D1 \-P timing:data=D2"
315 .sp
316 .TP
317 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
318 By default, all annotation output of all protocol decoders is
319 shown. With this option a specific decoder's annotations can be selected for
320 display, by specifying the decoder ID:
321 .sp
322  $
323 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid \-A i2c"
324 .sp
325 If a protocol decoder has multiple annotation classes, you can also specify
326 which one of them to show by specifying its short description like this:
327 .sp
328  $
329 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
330 .br
331 .B "              \-A i2c=data\-read"
332 .sp
333 Select multiple annotation classes by separating them with a colon:
334 .sp
335  $
336 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
337 .br
338 .B "              \-A i2c=data\-read:data\-write"
339 .sp
340 Annotation row names will resolve to their respective list of classes.
341 Row and class names can be used in combination. When names are ambiguous
342 then class names take precedence.
343 .sp
344  $
345 .B "sigrok\-cli \-i <file.sr> \-P i2c"
346 .br
347 .B "              \-A i2c=addr\-data:warnings"
348 .sp
349 You can also select multiple protocol decoders, with optionally selected
350 annotation classes each, by separating them with commas:
351 .sp
352  $
353 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
354 .br
355 .B "              \-A i2c=data\-read:data\-write,edid"
356 .TP
357 .BR "\-M, \-\-protocol\-decoder\-meta " <pdname>
358 When given, show protocol decoder meta output instead of annotations.
359 The argument is the name of the decoder whose meta output to show.
360 .sp
361  $
362 .B "sigrok\-cli \-i <file.sr> \-M i2c"
363 .sp
364 Not every decoder generates meta output.
365 .TP
366 .BR "\-B, \-\-protocol\-decoder\-binary " <binaryspec>
367 When given, decoder "raw" data of various kinds is written to stdout instead
368 of annotations (this could be raw binary UART/SPI bytes, or WAV files, PCAP
369 files, PNG files, or anything else; this is entirely dependent on the
370 decoder and what kinds of binary output make sense for that decoder).
371 .sp
372 No other information is printed to stdout, so this is
373 suitable for piping into other programs or saving to a file.
374 .sp
375 Protocol decoders that support binary output publish a list of binary
376 classes, for example the UART decoder might have "TX" and "RX". To
377 select TX for output, the argument to this option would be:
378 .sp
379  $
380 .B "sigrok\-cli \-i <file.sr> \-B uart=tx"
381 .br
382 .sp
383 If only the protocol decoder is specified, without binary class, all classes
384 are written to stdout:
385 .sp
386  $
387 .B "sigrok\-cli \-i <file.sr> \-B uart"
388 .sp
389 (this is only useful in rare cases, generally you would specify a certain
390 binary class you're interested in)
391 .sp
392 Not every decoder generates binary output.
393 .TP
394 .BR "\-\-protocol\-decoder\-samplenum
395 When given, decoder annotations will include sample numbers, too.
396 This allows consumers to receive machine readable timing information.
397 .TP
398 .BR "\-l, \-\-loglevel " <level>
399 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok\-cli\fP
400 doesn't support setting the two loglevels independently. The higher the
401 number, the more debug output will be printed. Valid loglevels are:
402 .sp
403 \fB0\fP   None
404 .br
405 \fB1\fP   Error
406 .br
407 \fB2\fP   Warnings
408 .br
409 \fB3\fP   Informational
410 .br
411 \fB4\fP   Debug
412 .br
413 \fB5\fP   Spew
414 .TP
415 .B "\-\-show"
416 .br
417 Show information about the selected option. For example, to see options for a
418 connected fx2lafw device:
419 .sp
420  $
421 .B "sigrok\-cli \-\-driver fx2lafw \-\-show
422 .sp
423 In order to properly get device options for your hardware, some drivers might
424 need a serial port specified:
425 .sp
426  $
427 .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show
428 .sp
429 This also works for protocol decoders, input modules and output modules:
430 .sp
431  $
432 .B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show
433  $
434 .B "sigrok\-cli \-\-input\-format csv \-\-show
435  $
436 .B "sigrok\-cli \-\-output\-format bits \-\-show
437 .sp
438 This also works for input files, including optional input format specifications:
439 .sp
440  $
441 .B "sigrok\-cli \-\-input\-file <file.sr> \-\-show
442  $
443 .B "sigrok\-cli \-\-input\-file <file.vcd> \-\-input\-format vcd \-\-show
444 .TP
445 .B "\-\-scan"
446 Scan for devices that can be detected automatically.
447 .sp
448 Example:
449 .sp
450  $
451 .B "sigrok\-cli \-\-scan
452 .br
453  The following devices were found:
454 .br
455  demo \- Demo device with 12 channels: D0 D1 D2 D3 D4 D5 D6 D7 A0 A1 A2 A3
456 .br
457  fx2lafw:conn=3.26 \- CWAV USBee SX with 8 channels: 0 1 2 3 4 5 6 7
458 .sp
459 However, not all devices are auto-detectable (e.g. serial port based ones).
460 For those you'll have to provide a \fBconn\fP option, see above.
461 .sp
462  $
463 .B "sigrok\-cli \-\-driver digitek\-dt4000zc:conn=/dev/ttyUSB0 \-\-scan
464 .br
465  The following devices were found:
466 .br
467  Digitek DT4000ZC with 1 channel: P1
468 .TP
469 .BR "\-\-time " <ms>
470 Sample for
471 .B <ms>
472 milliseconds, then quit.
473 .sp
474 You can optionally follow the number by \fBs\fP to specify the time to
475 sample in seconds.
476 .sp
477 For example,
478 .B "\-\-time 2s"
479 will sample for two seconds.
480 .TP
481 .BR "\-\-samples " <numsamples>
482 Acquire
483 .B <numsamples>
484 samples, then quit.
485 .sp
486 You can optionally follow the number by \fBk\fP, \fBm\fP, or \fBg\fP to
487 specify the number of samples in kilosamples, megasamples, or gigasamples,
488 respectively.
489 .sp
490 For example,
491 .B "\-\-samples 3m"
492 will acquire 3000000 samples.
493 .TP
494 .BR "\-\-frames " <numframes>
495 Acquire
496 .B <numframes>
497 frames, then quit.
498 .TP
499 .BR "\-\-continuous"
500 Sample continuously until stopped. Not all devices support this.
501 .TP
502 .BR "\-\-get " <variable>
503 Get the value of
504 .B <variable>
505 from the specified device and print it.
506 .TP
507 .BR "\-\-set"
508 Set one or more variables specified with the \fB\-\-config\fP option, without
509 doing any acquisition.
510 .SH EXAMPLES
511 In order to get exactly 100 samples from the connected fx2lafw-supported logic
512 analyzer hardware, run the following command:
513 .TP
514 .B "  sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
515 .TP
516 If you want to sample data for 3 seconds (3000 ms), use:
517 .TP
518 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3000"
519 .TP
520 Alternatively, you can also use:
521 .TP
522 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
523 .TP
524 To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
525 0:high, 1:rising, 2:low, 3:high, use:
526 .TP
527 .nf
528 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP
529 \fB\-\-output\-format bits \-\-channels 0\-3 \-\-wait\-trigger \\\fP
530 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
531 .TP
532 To turn on internal logging on a Lascar EL-USB series device:
533 .TP
534 \fBsigrok\-cli \-\-driver lascar\-el\-usb:conn=10c4.0002 \\\fP
535 \fB\-\-config datalog=on \-\-set\fP
536 .SH "EXIT STATUS"
537 .B sigrok\-cli
538 exits with 0 on success, 1 on most failures.
539 .SH "SEE ALSO"
540 \fBpulseview\fP(1)
541 .SH "BUGS"
542 Please report any bugs via Bugzilla
543 .RB "(" http://sigrok.org/bugzilla ")"
544 or on the sigrok\-devel mailing list
545 .RB "(" sigrok\-devel@lists.souceforge.net ")."
546 .SH "LICENSE"
547 .B sigrok\-cli
548 is covered by the GNU General Public License (GPL). Some portions are
549 licensed under the "GPL v2 or later", some under "GPL v3 or later".
550 .SH "AUTHORS"
551 Please see the individual source code files.
552 .PP
553 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
554 It is licensed under the terms of the GNU GPL (version 2 or later).