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