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