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