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