]>
Commit | Line | Data |
---|---|---|
10d98b47 | 1 | .TH SIGROK\-CLI 1 "Feb 05, 2013" |
43e5747a | 2 | .SH "NAME" |
53155b2f | 3 | sigrok\-cli \- Command-line client for the sigrok software |
43e5747a | 4 | .SH "SYNOPSIS" |
53155b2f | 5 | .B sigrok\-cli [OPTIONS] [COMMAND] |
43e5747a | 6 | .SH "DESCRIPTION" |
10d98b47 UH |
7 | \fBsigrok\-cli\fP is a cross-platform command line utility for the |
8 | \fBsigrok\fP software. | |
43e5747a | 9 | .PP |
10d98b47 UH |
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. | |
43e5747a UH |
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. | |
53155b2f | 17 | .SH OPTIONS |
43e5747a | 18 | .TP |
43e5747a UH |
19 | .B "\-h, \-\-help" |
20 | Show a help text and exit. | |
21 | .TP | |
7949dca0 UH |
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 | |
53155b2f | 28 | \fB\-\-driver\fP <drivername> |
10d98b47 UH |
29 | A driver must always be selected. Use the \fB-V\fP option to get a list of |
30 | available drivers. | |
53155b2f | 31 | .sp |
10d98b47 UH |
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: | |
53155b2f BV |
38 | .sp |
39 | .RB " $ " "sigrok\-cli \-\-driver=ols:conn=/dev/ttyACM0" | |
40 | .sp | |
10d98b47 UH |
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: | |
53155b2f BV |
44 | .sp |
45 | .RB " $ " "sigrok\-cli \-\-driver=nexus-osciprime:conn=04b4.8613" | |
43e5747a | 46 | .TP |
1b4b6a7c | 47 | .BR "\-d, \-\-device " <device> |
53155b2f | 48 | A colon-separated list of device options, where each option takes the form |
1b4b6a7c | 49 | .BR key=value . |
10d98b47 UH |
50 | For example, to set the samplerate to 1MHz on a device supported by the |
51 | fx2lafw driver, you might specify | |
1b4b6a7c | 52 | .sp |
53155b2f | 53 | .RB " $ " "sigrok\-cli \-\-driver=fx2lafw \-\-device samplerate=1m" |
1b4b6a7c | 54 | .sp |
53155b2f BV |
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. | |
1b4b6a7c UH |
57 | The following are all equivalent: |
58 | .sp | |
53155b2f | 59 | .RB " $ " "sigrok\-cli \-\-driver fx2lafw \-\-device samplerate=1000000" |
1b4b6a7c | 60 | .sp |
53155b2f | 61 | .RB " $ " "sigrok\-cli \-\-driver fx2lafw \-\-device samplerate=1m" |
1b4b6a7c | 62 | .sp |
53155b2f | 63 | .RB " $ " "sigrok\-cli \-\-driver fx2lafw \-\-device \(dqsamplerate=1 MHz\(dq" |
1b4b6a7c | 64 | .TP |
43e5747a | 65 | .BR "\-i, \-\-input\-file " <filename> |
7949dca0 | 66 | Load input from a file instead of a hardware device. If the |
43e5747a UH |
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 ), | |
943d0c08 TŠ |
75 | sigrok-cli attempts to autodetect the file format of the input file. Use the |
76 | .B \-V | |
10d98b47 UH |
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 | |
943d0c08 | 81 | .BR "key=value" . |
43e5747a UH |
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 | |
76ae913d | 87 | .B \-\-output\-format |
7949dca0 UH |
88 | option. |
89 | .TP | |
90 | .BR "\-O, \-\-output\-format " <formatname> | |
91 | Set the output format to use. Use the | |
92 | .B \-V | |
10d98b47 UH |
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 | |
7949dca0 UH |
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 , | |
85f2ddbb UH |
105 | .BR ols , |
106 | .BR gnuplot , | |
10d98b47 UH |
107 | .BR chronovu-la8 , |
108 | .BR csv ", and" | |
109 | .BR analog . | |
7949dca0 UH |
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 | |
10d98b47 UH |
119 | 0:ffff ffff ffff ffff ffff ffff ffff ffff |
120 | 1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00 | |
7949dca0 UH |
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 | |
10d98b47 UH |
126 | 0:11111111 11111111 11111111 11111111 [...] |
127 | 1:11111111 00000000 11111111 00000000 [...] | |
43e5747a | 128 | .TP |
43e5747a UH |
129 | .BR "\-p, \-\-probes " <probelist> |
130 | A comma-separated list of probes to be used in the session. | |
131 | .sp | |
10d98b47 UH |
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. | |
53155b2f | 137 | .sp |
43e5747a UH |
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 | |
10d98b47 UH |
146 | .RB " $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100" |
147 | .br | |
148 | .B " \-\-probes 1=CLK,2\-4,7" | |
43e5747a UH |
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 "\-t, \-\-triggers " <triggerlist> | |
173 | A comma-separated list of triggers to use, of the form | |
174 | .BR "<probe>=<trigger>" . | |
175 | You can use the name or number of the probe, and the trigger itself is a | |
176 | series of characters: | |
177 | .sp | |
178 | .BR "0 or 1" : | |
179 | A low or high value on the pin. | |
180 | .br | |
181 | .BR "r or f" : | |
182 | A rising or falling value on the pin. An | |
183 | .B r | |
184 | effectively corresponds to | |
185 | .BR 01 . | |
186 | .br | |
187 | .BR "c" : | |
85f2ddbb | 188 | Any kind of change on a pin (either a rising or a falling edge). |
43e5747a | 189 | .sp |
10d98b47 UH |
190 | Not every device supports all of these trigger types. Use the \fB\-\-show\fP |
191 | command to see which triggers your device supports. | |
43e5747a UH |
192 | .TP |
193 | .BR "\-w, \-\-wait-trigger" | |
10d98b47 UH |
194 | Don't output any sample data (even if it's actually received from the |
195 | hardware) before the trigger condition is met. In other words, do not output | |
196 | any pre-trigger data. This option is useful if you don't care about the data | |
197 | that came before the trigger (but the hardware delivers this data to sigrok | |
198 | nonetheless). | |
43e5747a | 199 | .TP |
85f2ddbb UH |
200 | .BR "\-a, \-\-protocol\-decoders " <list> |
201 | This option allows the user to specify a comma-separated list of protocol | |
202 | decoders to be used in this session. The decoders are specified by their | |
203 | ID, as shown in the | |
204 | .B \-\-version | |
205 | output. | |
206 | .sp | |
207 | Example: | |
208 | .sp | |
209 | $ | |
210 | .B "sigrok\-cli \-i <file.sr> \-a i2c" | |
211 | .sp | |
212 | Each protocol decoder can optionally be followed by a colon-separated list | |
213 | of options, where each option takes the form | |
214 | .BR "key=value" . | |
215 | .sp | |
216 | Example: | |
217 | .sp | |
218 | $ | |
219 | .B "sigrok\-cli \-i <file.sr> \-a uart:baudrate=115200:parity=odd" | |
220 | .sp | |
221 | The list of supported options depends entirely on the protocol decoder. Every | |
222 | protocol decoder has different options it supports. | |
223 | .sp | |
224 | Any "options" specified for a protocol decoder which are not actually | |
225 | supported options, will be interpreted as being probe name/number assignments. | |
226 | .sp | |
227 | Example: | |
228 | .sp | |
229 | $ | |
230 | .B "sigrok\-cli \-i <file.sr>" | |
231 | .br | |
232 | .B " \-a spi:wordsize=9:miso=1:mosi=5:sck=3:cs=0" | |
233 | .sp | |
234 | In this example, | |
235 | .B wordsize | |
236 | is an option supported by the | |
237 | .B spi | |
238 | protocol decoder. Additionally, the user tells sigrok to decode the SPI | |
239 | protocol using probe 1 as MISO signal for SPI, probe 5 as MOSI, probe 3 | |
240 | as SCK, and probe 0 as CS# signal. | |
241 | .TP | |
242 | .BR "\-s, \-\-protocol\-decoder\-stack " <stack> | |
243 | This option allows the user to specify a protocol decoder stack, i.e. | |
244 | the way in which one protocol decoder's output gets piped into another | |
7fb87027 | 245 | protocol decoder. If not specified, the stack will be set up in the same |
1a0be0e3 UH |
246 | order in which the protocol decoders were given with the |
247 | .B \-\-protocol-decoders | |
7fb87027 | 248 | option. |
85f2ddbb UH |
249 | .sp |
250 | The decoders are specified by their ID, as shown in the | |
251 | .B \-\-version | |
252 | output. In addition to the | |
253 | .B \-s | |
254 | option, all protocol decoders that are used in a stack, must also be specified | |
255 | (together with their options, if any) using the | |
256 | .B \-a | |
257 | parameter. | |
258 | .sp | |
259 | Example: | |
260 | .sp | |
261 | $ | |
2d4077a7 | 262 | .B "sigrok\-cli \-i <file.sr> \-a i2c:sda=4:scl=7,rtc8564" |
85f2ddbb UH |
263 | .br |
264 | .B " \-s i2c,rtc8564" | |
265 | .sp | |
266 | In this example, the | |
267 | .B \-s | |
268 | option specifies that the output of the | |
269 | .BR i2c " decoder" | |
270 | is piped into the | |
271 | .BR rtc8564 " decoder," | |
272 | i.e., the | |
273 | .BR rtc8564 " decoder" | |
274 | is stacked on top of the | |
275 | .BR i2c " decoder." | |
276 | .sp | |
277 | The respective protocol decoder options and probe name/number assignments | |
278 | must be given using the | |
279 | .B \-a | |
280 | option (you cannot specify them in the | |
281 | .B \-s | |
282 | option). | |
283 | .TP | |
b6bd032d | 284 | .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations> |
7fb87027 BV |
285 | By default, only the stack's topmost protocol decoder's annotation output is |
286 | shown. With this option another decoder's annotation can be selected for | |
1a0be0e3 | 287 | display, by specifying its ID: |
7fb87027 BV |
288 | .sp |
289 | $ | |
b6bd032d | 290 | .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid -A i2c" |
7fb87027 BV |
291 | .sp |
292 | If a protocol decoder has multiple annotation formats, you can also specify | |
293 | which of them to show by specifying its short description like this: | |
294 | .sp | |
295 | $ | |
296 | .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid" | |
297 | .br | |
b6bd032d | 298 | .B " \-A i2c=rawhex" |
7fb87027 BV |
299 | .sp |
300 | You can also select multiple protocol decoders, with an optional selected | |
301 | annotation format each, by separating them with commas: | |
302 | .sp | |
303 | $ | |
304 | .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid" | |
305 | .br | |
b6bd032d | 306 | .B " \-A i2c=rawhex,edid" |
7fb87027 | 307 | .TP |
53155b2f | 308 | .BR "\-l, \-\-loglevel " <level> |
10d98b47 UH |
309 | Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP |
310 | doesn't support setting the two loglevels independently. The higher the | |
53155b2f BV |
311 | number, the more debug output will be printed. Valid loglevels are: |
312 | .sp | |
313 | \fB0\fP None | |
314 | .br | |
315 | \fB1\fP Error | |
316 | .br | |
317 | \fB2\fP Warnings | |
318 | .br | |
319 | \fB3\fP Informational | |
320 | .br | |
321 | \fB4\fP Debug | |
322 | .br | |
323 | \fB5\fP Spew | |
324 | .TP | |
325 | .B "\-\-show" | |
326 | .br | |
10d98b47 UH |
327 | Show information about the selected option. For example, to see options for a |
328 | connected fx2lafw device: | |
53155b2f BV |
329 | .sp |
330 | $ | |
331 | .B "sigrok\-cli \-\-driver fx2lafw \-\-show | |
332 | .sp | |
10d98b47 UH |
333 | In order to properly get device options for your hardware, some drivers might |
334 | need a serial port specified: | |
53155b2f BV |
335 | .sp |
336 | $ | |
337 | .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show | |
338 | .sp | |
339 | To view the documentation for a protocol decoder: | |
340 | .sp | |
341 | $ | |
342 | .B "sigrok\-cli \-\-protocol-decoders i2c \-\-show | |
343 | .TP | |
344 | .B "\-D, \-\-list\-devices" | |
10d98b47 UH |
345 | List all devices found on the system. This actively scans for devices that |
346 | can be detected automatically. | |
347 | .sp | |
348 | Example: | |
349 | .sp | |
350 | $ | |
351 | .B "sigrok\-cli \-D | |
352 | .br | |
353 | The following devices were found: | |
354 | .br | |
355 | Demo device with 8 probes: 0 1 2 3 4 5 6 7 | |
356 | .br | |
357 | ChronoVu LA8 with 8 probes: 0 1 2 3 4 5 6 7 | |
358 | .br | |
359 | ALSA: HDA ATI SB ALC270 Analog with 2 probes: Ch_0 Ch_1 | |
360 | .br | |
361 | Saleae Logic with 8 probes: 0 1 2 3 4 5 6 7 | |
362 | .sp | |
363 | However, not all devices are auto-detectable (e.g. serial port based ones). | |
364 | For those you'll have to provide a \fBconn\fP option, see above. | |
365 | .sp | |
366 | $ | |
367 | .B "sigrok\-cli \-\-driver digitek-dt4000zc:conn=/dev/ttyUSB0 \-D | |
368 | .br | |
369 | The following devices were found: | |
370 | .br | |
371 | Digitek DT4000ZC with 1 probe: P1 | |
53155b2f | 372 | .TP |
43e5747a UH |
373 | .BR "\-\-time " <ms> |
374 | Sample for | |
375 | .B <ms> | |
10d98b47 UH |
376 | milliseconds, then quit. |
377 | .sp | |
378 | You can optionally follow the number by \fBs\fP, \fBms\fP, \fBus\fP, or | |
379 | \fBns\fP to specify the time to sample in seconds, milliseconds, microseconds, | |
380 | or nanoseconds, respectively. | |
381 | .sp | |
382 | For example, | |
43e5747a UH |
383 | .B "\-\-time 2s" |
384 | will sample for two seconds. | |
385 | .TP | |
386 | .BR "\-\-samples " <numsamples> | |
387 | Acquire | |
388 | .B <numsamples> | |
389 | samples, then quit. | |
10d98b47 UH |
390 | .sp |
391 | You can optionally follow the number by \fBk\fP, \fBm\fP, or \fBg\fP to | |
392 | specify the number of samples in kilosamples, megasamples, or gigasamples, | |
393 | respectively. | |
394 | .sp | |
395 | For example, | |
396 | .B "\-\-samples 3m" | |
397 | will acquire 3000000 samples. | |
43e5747a UH |
398 | .TP |
399 | .BR "\-\-continuous" | |
400 | Sample continuously until stopped. Not all devices support this. | |
2d73284e BV |
401 | .TP |
402 | .BR "\-\-set" | |
403 | Set one or more variables specified with the --device option, without doing | |
404 | any acquisition. | |
53155b2f BV |
405 | .SH EXAMPLES |
406 | In order to get exactly 100 samples from the connected fx2lafw-supported logic analyzer hardware, run the following command: | |
43e5747a | 407 | .TP |
53155b2f | 408 | .B " sigrok\-cli \-\-driver fx2lafw \-\-samples 100" |
43e5747a | 409 | .TP |
2d73284e | 410 | If you want to sample data for 3 seconds (3000 ms), use: |
43e5747a | 411 | .TP |
53155b2f | 412 | .B " sigrok\-cli \-\-driver fx2lafw \-\-time 3000" |
43e5747a UH |
413 | .TP |
414 | Alternatively, you can also use: | |
415 | .TP | |
53155b2f | 416 | .B " sigrok\-cli \-\-driver fx2lafw \-\-time 3s" |
43e5747a | 417 | .TP |
53155b2f BV |
418 | To capture data from the first 4 probes using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition |
419 | 0:high, 1:rising, 2:low, 3:high, use: | |
43e5747a | 420 | .TP |
53155b2f | 421 | .nf |
2d73284e BV |
422 | \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-device samplerate=10m \\\fP |
423 | \fB\-\-output\-format bits \-\-probes 0\-3 \-\-time 100 \\\fP | |
424 | \fB\-\-wait\-trigger \-\-triggers 0=1,1=r,2=0,3=1\fP | |
425 | .TP | |
426 | To turn on internal logging on a Lascar EL-USB series device: | |
427 | .TP | |
428 | \fBsigrok\-cli \-\-driver lascar\-el\-usb:conn=10c4.0002 \\\fP | |
429 | \fB\-\-device datalog=on --set\fP | |
430 | .TP | |
53155b2f | 431 | .fi |
43e5747a UH |
432 | .SH "EXIT STATUS" |
433 | .B sigrok\-cli | |
434 | exits with 0 on success, 1 on most failures. | |
435 | .SH "SEE ALSO" | |
10d98b47 | 436 | \fBpulseview\fP(1), |
4611cadf UH |
437 | \fBsigrok\-qt\fP(1), |
438 | \fBsigrok\-gtk\fP(1) | |
43e5747a | 439 | .SH "BUGS" |
10d98b47 UH |
440 | Please report any bugs via Bugzilla |
441 | .RB "(" http://sigrok.org/bugzilla ")" | |
442 | or on the sigrok\-devel mailing list | |
43e5747a UH |
443 | .RB "(" sigrok\-devel@lists.souceforge.net ")." |
444 | .SH "LICENSE" | |
445 | .B sigrok\-cli | |
446 | is covered by the GNU General Public License (GPL). Some portions are | |
447 | licensed under the "GPL v2 or later", some under "GPL v3 or later". | |
448 | .SH "AUTHORS" | |
449 | Please see the individual source code files. | |
450 | .PP | |
451 | This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>. | |
452 | It is licensed under the terms of the GNU GPL (version 2 or later). |