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