1 .TH SIGROK\-CLI 1 "March 28, 2019"
3 sigrok\-cli \- Command-line client for the sigrok software
5 .B sigrok\-cli [OPTIONS] [COMMAND]
7 \fBsigrok\-cli\fP is a cross-platform command line utility for the
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.
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.
20 Show a help text and exit.
25 version and the versions of libraries used.
27 .B "\-L, \-\-list\-supported"
28 Show information about supported hardware drivers, input file
29 formats, output file formats, and protocol decoders.
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.
36 \fB\-d, \-\-driver\fP <drivername>
37 A driver must always be selected (unless doing a global scan). Use the
38 .BR "\-L " ( "\-\-list\-supported" ")"
39 option to get a list of available drivers.
41 Drivers can take options, in the form \fBkey=value\fP
44 Drivers communicating with hardware via a serial port always need the port
45 specified as the \fBconn\fP option. For example, to use the
46 Openbench Logic Sniffer:
48 .RB " $ " "sigrok\-cli \-\-driver=ols:conn=/dev/ttyACM0" " [...]"
50 Some USB devices don't use a unique VendorID/ProductID combination, and thus
51 need that specified as well. This also uses the \fBconn\fP option, using
52 either \fBVendorID.ProductID\fP or \fBbus.address\fP:
54 USB \fBVendorID.ProductID\fP example:
56 .RB " $ " "sigrok\-cli \-\-driver=uni\-t\-ut61e:conn=1a86.e008" " [...]"
58 USB \fBbus.address\fP example:
60 .RB " $ " "sigrok\-cli \-\-driver=uni\-t\-ut61e:conn=4.6" " [...]"
62 .B "\-D, \-\-dont\-scan"
63 Do not automatically scan for device drivers in the absence of a
64 .BR "\-d " ( "\-\-driver" )
67 .BR "\-c, \-\-config " <deviceoption>
68 A colon-separated list of device options, where each option takes the form
70 For example, to set the samplerate to 1MHz on a device supported by the
71 fx2lafw driver, you might specify
73 .RB " $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1m" " [...]"
75 Samplerate is an option common to most logic analyzers. The argument specifies
76 the samplerate in Hz. You can also specify the samplerate in kHz, MHz or GHz.
77 The following are all equivalent:
79 .RB " $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1000000" " [...]"
81 .RB " $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1m" " [...]"
83 .RB " $ " "sigrok\-cli \-d fx2lafw \-\-config \(dqsamplerate=1 MHz\(dq" " [...]"
85 .BR "\-i, \-\-input\-file " <filename>
86 Load input from a file instead of a hardware device. You can specify
87 "-" to use stdin as input. If the
89 option is not supplied, sigrok\-cli attempts to autodetect the file format of
92 Example for loading a sigrok session file:
94 .RB " $ " "sigrok\-cli \-i example.sr" " [...]"
96 Example for loading a WAV file (autodetection of input format):
98 .RB " $ " "sigrok\-cli \-i example.wav" " [...]
100 Example for loading a VCD file from stdin (autodetection of input format):
102 .RB " $ " "cat example.vcd | sigrok\-cli \-i \-" " [...]
104 .BR "\-I, \-\-input\-format " <format>
105 When loading an input file, assume it's in the specified format. If this
106 option is not supplied (in addition to
107 .BR \-\-input\-file ),
108 sigrok-cli attempts to autodetect the file format of the input file. Use the
109 .BR "\-L " ( "\-\-list\-supported" ")"
110 option to see a list of available input formats.
112 The format name may optionally be followed by a colon-separated list of
113 options, where each option takes the form
116 Example for loading a binary file with options:
118 .RB " $ " "sigrok\-cli \-i example.bin"
120 .BR " \-I binary:numchannels=4:samplerate=1mhz" " [...]"
122 .BR "\-o, \-\-output\-file " <filename>
123 Save output to a file instead of writing it to stdout. The default format
124 used when saving is the sigrok session file format. This can be changed with
126 .B \-\-output\-format
129 Example for saving data in the sigrok session format:
131 .RB " $ " "sigrok\-cli " "[...] " "\-o example.sr"
133 .BR "\-O, \-\-output\-format " <format>
134 Set the output format to use. Use the
135 .BR "\-L " ( "\-\-list\-supported" ")"
136 option to see a list of available output formats.
138 The format name may optionally be followed by a colon-separated list of
139 options, where each option takes the form
146 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
147 .B "\-O hex:width=128"
148 will display 128 bits per line, in hexadecimal:
150 0:ffff ffff ffff ffff ffff ffff ffff ffff
151 1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
153 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 0:11111111 11111111 11111111 11111111 [...]
158 1:11111111 00000000 11111111 00000000 [...]
160 Example for saving data in the CSV format with options:
162 .RB " $ " "sigrok\-cli " "[...] " "\-o example.csv \-O csv:dedup:header=false"
164 Notice that boolean options are \fBtrue\fP when no value gets specified.
166 .BR "\-C, \-\-channels " <channellist>
167 A comma-separated list of channels to be used in the session.
169 Note that sigrok always names the channels according to how they're shown on
170 the enclosure of the hardware. If your logic analyzer numbers the channels 0\-15,
171 that's how you must specify them with this option. An oscilloscope's channels
172 would generally be referred to as "CH1", "CH2", and so on.
173 Use the \fB\-\-show\fP option to see a list of channel names for your device.
175 The default is to use all the channels available on a device. You can name
178 A range of channels can also be given, in the form
183 .RB " $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
185 .B " \-\-channels 1=CLK,2\-4,7"
187 CLK:11111111 11111111 11111111 11111111 [...]
188 2:11111111 11111111 11111111 11111111 [...]
189 3:11111111 11111111 11111111 11111111 [...]
190 4:11111111 11111111 11111111 11111111 [...]
191 7:11111111 11111111 11111111 11111111 [...]
193 The comma-separated list is processed from left to right, i.e. items farther
194 to the right override previous items. For example
196 will set the name of channel 1 to
199 .BR "\-g, \-\-channel\-group "<channel\ group>
200 Specify the channel group to operate on. Some devices organize channels into
201 groups, the settings of which can only be changed as a group. The list of
202 channel groups, if any, is displayed with the \fB\-\-show\fP command.
206 .RB " $ " "sigrok\-cli \-g CH1" " [...]"
208 .RB " $ " "sigrok\-cli \-d demo \-g Logic \-c pattern=graycode" " [...]"
210 .BR "\-t, \-\-triggers " <triggerlist>
211 A comma-separated list of triggers to use, of the form
212 .BR "<channel>=<trigger>" .
213 You can use the name or number of the channel, and the trigger itself is a
214 series of characters:
217 A low or high value on the pin.
220 A rising or falling value on the pin. An
222 effectively corresponds to
226 Any kind of change on a pin (either a rising or a falling edge).
228 Not every device supports all of these trigger types. Use the \fB\-\-show\fP
229 command to see which triggers your device supports.
231 .BR "\-w, \-\-wait\-trigger"
232 Don't output any sample data (even if it's actually received from the
233 hardware) before the trigger condition is met. In other words, do not output
234 any pre-trigger data. This option is useful if you don't care about the data
235 that came before the trigger (but the hardware delivers this data to sigrok
238 .BR "\-P, \-\-protocol\-decoders " <list>
239 This option allows the user to specify a comma-separated list of protocol
240 decoders to be used in this session. The decoders are specified by their
242 .BR "\-L " ( "\-\-list\-supported" ")"
248 .B "sigrok\-cli \-i <file.sr> \-P i2c"
250 Each protocol decoder can optionally be followed by a colon-separated list
251 of options, where each option takes the form
257 .B "sigrok\-cli \-i <file.sr> "
259 .B " \-P uart:baudrate=115200:parity_type=odd"
261 The list of supported options depends entirely on the protocol decoder. Every
262 protocol decoder has different options it supports.
264 Any "options" specified for a protocol decoder which are not actually
265 supported options, will be interpreted as being channel name/number assignments.
270 .B "sigrok\-cli \-i <file.sr>"
272 .B " \-P spi:wordsize=9:miso=1:mosi=5:clk=3:cs=0"
276 is an option supported by the
278 protocol decoder. Additionally, the user tells sigrok to decode the SPI
279 protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3
280 as CLK, and channel 0 as CS# signal.
284 application does not support "name matching". Instead it's assumed that the
285 traces in the input stream match the order of the decoder's input signals,
286 or that users explicitly specify the input channel to decoder signal mapping.
289 When multiple decoders are specified in the same
291 option, they will be stacked on top of each other in the specified order.
296 .B "sigrok\-cli \-i <file.sr> \-P i2c,eeprom24xx"
299 .B "sigrok\-cli \-i <file.sr> \-P uart:baudrate=31250,midi"
303 options are specified, each of them creates one decoder stack, which
304 executes in parallel to other decoder stacks.
309 .B "sigrok\-cli \-i <file.sr> \-P uart:tx=D0:rx=D1 \-P timing:data=D2"
312 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
313 By default, all annotation output of all protocol decoders is
314 shown. With this option a specific decoder's annotations can be selected for
315 display, by specifying the decoder ID:
318 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid \-A i2c"
320 If a protocol decoder has multiple annotation classes, you can also specify
321 which one of them to show by specifying its short description like this:
324 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
326 .B " \-A i2c=data\-read"
328 Select multiple annotation classes by separating them with a colon:
331 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
333 .B " \-A i2c=data\-read:data\-write"
335 Annotation row names will resolve to their respective list of classes.
336 Row and class names can be used in combination. When names are ambiguous
337 then class names take precedence.
340 .B "sigrok\-cli \-i <file.sr> \-P i2c"
342 .B " \-A i2c=addr\-data:warnings"
344 You can also select multiple protocol decoders, with optionally selected
345 annotation classes each, by separating them with commas:
348 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
350 .B " \-A i2c=data\-read:data\-write,edid"
352 .BR "\-M, \-\-protocol\-decoder\-meta " <pdname>
353 When given, show protocol decoder meta output instead of annotations.
354 The argument is the name of the decoder whose meta output to show.
357 .B "sigrok\-cli \-i <file.sr> \-M i2c"
359 Not every decoder generates meta output.
361 .BR "\-B, \-\-protocol\-decoder\-binary " <binaryspec>
362 When given, decoder "raw" data of various kinds is written to stdout instead
363 of annotations (this could be raw binary UART/SPI bytes, or WAV files, PCAP
364 files, PNG files, or anything else; this is entirely dependent on the
365 decoder and what kinds of binary output make sense for that decoder).
367 No other information is printed to stdout, so this is
368 suitable for piping into other programs or saving to a file.
370 Protocol decoders that support binary output publish a list of binary
371 classes, for example the UART decoder might have "TX" and "RX". To
372 select TX for output, the argument to this option would be:
375 .B "sigrok\-cli \-i <file.sr> \-B uart=tx"
378 If only the protocol decoder is specified, without binary class, all classes
379 are written to stdout:
382 .B "sigrok\-cli \-i <file.sr> \-B uart"
384 (this is only useful in rare cases, generally you would specify a certain
385 binary class you're interested in)
387 Not every decoder generates binary output.
389 .BR "\-\-protocol\-decoder\-samplenum
390 When given, decoder annotations will include sample numbers, too.
391 This allows consumers to receive machine readable timing information.
393 .BR "\-l, \-\-loglevel " <level>
394 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok\-cli\fP
395 doesn't support setting the two loglevels independently. The higher the
396 number, the more debug output will be printed. Valid loglevels are:
404 \fB3\fP Informational
412 Show information about the selected option. For example, to see options for a
413 connected fx2lafw device:
416 .B "sigrok\-cli \-\-driver fx2lafw \-\-show
418 In order to properly get device options for your hardware, some drivers might
419 need a serial port specified:
422 .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show
424 This also works for protocol decoders, input modules and output modules:
427 .B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show
429 .B "sigrok\-cli \-\-input\-format csv \-\-show
431 .B "sigrok\-cli \-\-output\-format bits \-\-show
434 Scan for devices that can be detected automatically.
439 .B "sigrok\-cli \-\-scan
441 The following devices were found:
443 demo \- Demo device with 12 channels: D0 D1 D2 D3 D4 D5 D6 D7 A0 A1 A2 A3
445 fx2lafw:conn=3.26 \- CWAV USBee SX with 8 channels: 0 1 2 3 4 5 6 7
447 However, not all devices are auto-detectable (e.g. serial port based ones).
448 For those you'll have to provide a \fBconn\fP option, see above.
451 .B "sigrok\-cli \-\-driver digitek\-dt4000zc:conn=/dev/ttyUSB0 \-\-scan
453 The following devices were found:
455 Digitek DT4000ZC with 1 channel: P1
460 milliseconds, then quit.
462 You can optionally follow the number by \fBs\fP to specify the time to
467 will sample for two seconds.
469 .BR "\-\-samples " <numsamples>
474 You can optionally follow the number by \fBk\fP, \fBm\fP, or \fBg\fP to
475 specify the number of samples in kilosamples, megasamples, or gigasamples,
480 will acquire 3000000 samples.
482 .BR "\-\-frames " <numframes>
488 Sample continuously until stopped. Not all devices support this.
490 .BR "\-\-get " <variable>
493 from the specified device and print it.
496 Set one or more variables specified with the \fB\-\-config\fP option, without
497 doing any acquisition.
499 In order to get exactly 100 samples from the connected fx2lafw-supported logic
500 analyzer hardware, run the following command:
502 .B " sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
504 If you want to sample data for 3 seconds (3000 ms), use:
506 .B " sigrok\-cli \-\-driver fx2lafw \-\-time 3000"
508 Alternatively, you can also use:
510 .B " sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
512 To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
513 0:high, 1:rising, 2:low, 3:high, use:
516 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP
517 \fB\-\-output\-format bits \-\-channels 0\-3 \-\-wait\-trigger \\\fP
518 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
520 To turn on internal logging on a Lascar EL-USB series device:
522 \fBsigrok\-cli \-\-driver lascar\-el\-usb:conn=10c4.0002 \\\fP
523 \fB\-\-config datalog=on \-\-set\fP
526 exits with 0 on success, 1 on most failures.
530 Please report any bugs via Bugzilla
531 .RB "(" http://sigrok.org/bugzilla ")"
532 or on the sigrok\-devel mailing list
533 .RB "(" sigrok\-devel@lists.souceforge.net ")."
536 is covered by the GNU General Public License (GPL). Some portions are
537 licensed under the "GPL v2 or later", some under "GPL v3 or later".
539 Please see the individual source code files.
541 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
542 It is licensed under the terms of the GNU GPL (version 2 or later).