Allow setting samplerate when reading binary files
[sigrok:sigrok.git] / sigrok-cli / doc / sigrok-cli.1
1 .TH SIGROK\-CLI 1 "May 29, 2012"
2 .SH "NAME"
3 sigrok\-cli \- Command-line client for the sigrok logic analyzer software
4 .SH "SYNOPSIS"
5 .B sigrok\-cli \fR[\fB\-hVlDdiIoOptwasA\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] [\fB\-l\fR|\fB\-\-loglevel\fR level] [\fB\-D\fR|\fB\-\-list\-devices\fR] [\fB\-d\fR|\fB\-\-device\fR device] [\fB\-i\fR|\fB\-\-input\-file\fR filename] [\fB\-I\fR|\fB\-\-input\-format\fR format] [\fB\-o\fR|\fB\-\-output\-file\fR filename] [\fB\-O\fR|\fB\-\-output-format\fR format] [\fB\-p\fR|\fB\-\-probes\fR probelist] [\fB\-t\fR|\fB\-\-triggers\fR triggerlist] [\fB\-w\fR|\fB\-\-wait\-trigger\fR] [\fB\-a\fR|\fB\-\-protocol\-decoders\fR decoderlist] [\fB\-s\fR|\fB\-\-protocol\-decoder\-stack\fR stack] [\fB\-A\fR|\fB\-\-protocol\-decoder\-annotations\fR annlist] [\fB\-\-time\fR ms] [\fB\-\-samples\fR numsamples] [\fB\-\-continuous\fR]
6 .SH "DESCRIPTION"
7 .B sigrok\-cli
8 is a cross-platform command line utility for the
9 .B sigrok
10 logic analyzer software.
11 .PP
12 The command-line frontend for sigrok cannot display graphical output, but is
13 still sufficient to run through the whole process of hardware initialization,
14 acquisition, protocol decoding and saving the session.
15 .PP
16 It is useful for running on remote or embedded systems, netbooks, PDAs,
17 and for various other use-cases. It can display samples on standard output or
18 save them in various file formats.
19 .SH "OPTIONS"
20 .TP
21 .B "\-h, \-\-help"
22 Show a help text and exit.
23 .TP
24 .B "\-V, \-\-version"
25 Show
26 .B sigrok-cli
27 version, and information about supported hardware drivers, input file
28 formats, output file formats, and protocol decoders.
29 .TP
30 .BR "\-l, \-\-loglevel " <level>
31 Set the libsigrok and libsigrokdecode loglevel. At the moment
32 .B sigrok-cli
33 doesn't support setting the two loglevels independently. The higher the
34 number, the more debug output will be printed. Valid loglevels are
35 .BR 0 " (NONE),"
36 .BR 1 " (ERR),"
37 .BR 2 " (WARN),"
38 .BR 3 " (INFO),"
39 .BR 4 " (DBG), and"
40 .BR 5 " (SPEW)."
41 .TP
42 .B "\-D, \-\-list\-devices"
43 List all logic analyzer devices found on the system. This actively scans for
44 devices (USB, serial port, and others).
45 .TP
46 .BR "\-d, \-\-device " <device>
47 The device to use for acquisition. It can be specified by ID as reported by
48 .BR "\-\-list\-devices" ,
49 or by the name of the driver as reported by
50 .BR \-\-version .
51 .sp
52 A device can optionally be followed by a colon-separated list of device
53 options, where each option takes the form
54 .BR key=value .
55 For example, to set the samplerate on the first device you might specify
56 .sp
57 .RB "  $ " "sigrok\-cli \-d 0:samplerate=1m"
58 .sp
59 Samplerate is an option common to most devices. The argument specifies the
60 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 \-\-samples 100 \-d 0:samplerate=1000000"
64 .sp
65 .RB "  $ " "sigrok\-cli \-\-samples 100 \-d 0:samplerate=1m"
66 .sp
67 .RB "  $ " "sigrok\-cli \-\-samples 100 \-d ""0:samplerate=1 MHz""
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 .B \-V
81 option to see a list of available input formats. The format name may
82 optionally be followed by a colon-separated list of options, where each
83 option takes the form
84 .BR "key=value" .
85 .TP
86 .BR "\-o, \-\-output\-file " <filename>
87 Save output to a file instead of writing it to stdout. The default format
88 used when saving is the sigrok session file format. This can be changed with
89 the
90 .B \-\-output\-format
91 option.
92 .TP
93 .BR "\-O, \-\-output\-format " <formatname>
94 Set the output format to use. Use the
95 .B \-V
96 option to see a list of available output formats. The format name may
97 optionally be followed by a colon-separated list of options, where each
98 option takes the form
99 .BR "key=value" .
100 .sp
101 Supported formats currently include
102 .BR bits ,
103 .BR hex ,
104 .BR ascii ,
105 .BR binary ,
106 .BR vcd ,
107 .BR ols ,
108 .BR gnuplot ,
109 .BR chronovu-la8 ", and"
110 .BR csv .
111 .sp
112 The
113 .B bits
114 or
115 .B hex
116 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
117 .B hex:width=128
118 will display 128 bits per line, in hexadecimal:
119 .sp
120  1:ffff ffff ffff ffff ffff ffff ffff ffff
121  2:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
122 .sp
123 The lines always start with the probe number (or name, if defined), followed by a colon. If no format is specified, it defaults to
124 .BR bits:width=64 ,
125 like this:
126 .sp
127  1:11111111 11111111 11111111 11111111 [...]
128  2:11111111 00000000 11111111 00000000 [...]
129 .TP
130 .BR "\-p, \-\-probes " <probelist>
131 A comma-separated list of probes to be used in the session.
132 .sp
133 The default is to use all the probes available on a device. You can name
134 a probe like this:
135 .BR "1=CLK" .
136 A range of probes can also be given, in the form
137 .BR "1\-5" .
138 .sp
139 Example:
140 .sp
141  $
142 .B "sigrok\-cli \-\-samples 100 \-\-probes 1=CLK,2\-4,7"
143 .br
144  CLK:11111111 11111111 11111111 11111111 [...]
145    2:11111111 11111111 11111111 11111111 [...]
146    3:11111111 11111111 11111111 11111111 [...]
147    4:11111111 11111111 11111111 11111111 [...]
148    7:11111111 11111111 11111111 11111111 [...]
149 .sp
150 The comma-separated list is processed from left to right, i.e. items farther
151 to the right override previous items. For example
152 .B "1=CS,1=MISO"
153 will set the name of probe 1 to
154 .BR "MISO" .
155 .sp
156 Also, while
157 .B "5=MOSI,6=MISO"
158 will only select probes 5 and 6, and set their names to MISO and MOSI, the
159 command line
160 .B "5=MOSI,6=MISO,1\-8"
161 will select probes 1\-8 (including 5 and 6, of course), but the names specified
162 for probes 5 and 6 will be reset to the defaults by the
163 .B "1\-8"
164 probe selection.
165 .TP
166 .BR "\-t, \-\-triggers " <triggerlist>
167 A comma-separated list of triggers to use, of the form
168 .BR "<probe>=<trigger>" .
169 You can use the name or number of the probe, and the trigger itself is a
170 series of characters:
171 .sp
172 .BR "0 or 1" :
173 A low or high value on the pin.
174 .br
175 .BR "r or f" :
176 A rising or falling value on the pin. An
177 .B r
178 effectively corresponds to
179 .BR 01 .
180 .br
181 .BR "c" :
182 Any kind of change on a pin (either a rising or a falling edge).
183 .sp
184 Not every device supports all of these trigger types. Use the
185 .B "\-d <device>"
186 argument (with no other arguments) to see which triggers your device supports.
187 .TP
188 .BR "\-w, \-\-wait-trigger"
189 Don't output any sample data (even if it's actually received from the logic
190 analyzer) before the trigger condition is met. In other words, do not output
191 any pre-trigger data. This option is useful if you don't care about the data
192 that came before the trigger (but the logic analyzer hardware delivers this
193 data to sigrok nonetheless).
194 .TP
195 .BR "\-a, \-\-protocol\-decoders " <list>
196 This option allows the user to specify a comma-separated list of protocol
197 decoders to be used in this session. The decoders are specified by their
198 ID, as shown in the
199 .B \-\-version
200 output.
201 .sp
202 Example:
203 .sp
204  $
205 .B "sigrok\-cli \-i <file.sr> \-a i2c"
206 .sp
207 Each protocol decoder can optionally be followed by a colon-separated list
208 of options, where each option takes the form
209 .BR "key=value" .
210 .sp
211 Example:
212 .sp
213  $
214 .B "sigrok\-cli \-i <file.sr> \-a uart:baudrate=115200:parity=odd"
215 .sp
216 The list of supported options depends entirely on the protocol decoder. Every
217 protocol decoder has different options it supports.
218 .sp
219 Any "options" specified for a protocol decoder which are not actually
220 supported options, will be interpreted as being probe name/number assignments.
221 .sp
222 Example:
223 .sp
224  $
225 .B "sigrok\-cli \-i <file.sr>"
226 .br
227 .B "              \-a spi:wordsize=9:miso=1:mosi=5:sck=3:cs=0"
228 .sp
229 In this example,
230 .B wordsize
231 is an option supported by the
232 .B spi
233 protocol decoder. Additionally, the user tells sigrok to decode the SPI
234 protocol using probe 1 as MISO signal for SPI, probe 5 as MOSI, probe 3
235 as SCK, and probe 0 as CS# signal.
236 .TP
237 .BR "\-s, \-\-protocol\-decoder\-stack " <stack>
238 This option allows the user to specify a protocol decoder stack, i.e.
239 the way in which one protocol decoder's output gets piped into another
240 protocol decoder. If not specified, the stack will be set up in the same
241 order in which the protocol decoders were given with the
242 .B \-\-protocol-decoders
243 option.
244 .sp
245 The decoders are specified by their ID, as shown in the
246 .B \-\-version
247 output. In addition to the
248 .B \-s
249 option, all protocol decoders that are used in a stack, must also be specified
250 (together with their options, if any) using the
251 .B \-a
252 parameter.
253 .sp
254 Example:
255 .sp
256  $
257 .B "sigrok\-cli \-i <file.sr> \-a i2c:sda=4:scl=7,rtc8564"
258 .br
259 .B "              \-s i2c,rtc8564"
260 .sp
261 In this example, the
262 .B \-s
263 option specifies that the output of the
264 .BR i2c " decoder"
265 is piped into the
266 .BR rtc8564 " decoder,"
267 i.e., the
268 .BR rtc8564 " decoder"
269 is stacked on top of the
270 .BR i2c " decoder."
271 .sp
272 The respective protocol decoder options and probe name/number assignments
273 must be given using the
274 .B \-a
275 option (you cannot specify them in the
276 .B \-s
277 option).
278 .TP
279 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
280 By default, only the stack's topmost protocol decoder's annotation output is
281 shown. With this option another decoder's annotation can be selected for
282 display, by specifying its ID:
283 .sp
284  $
285 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid -A i2c"
286 .sp
287 If a protocol decoder has multiple annotation formats, you can also specify
288 which of them to show by specifying its short description like this:
289 .sp
290  $
291 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
292 .br
293 .B "              \-A i2c=rawhex"
294 .sp
295 You can also select multiple protocol decoders, with an optional selected
296 annotation format each, by separating them with commas:
297 .sp
298  $
299 .B "sigrok\-cli \-i <file.sr> \-a i2c,i2cfilter,edid"
300 .br
301 .B "              \-A i2c=rawhex,edid"
302 .TP
303 .BR "\-\-time " <ms>
304 Sample for
305 .B <ms>
306 milliseconds, then quit. You can optionally follow the number by
307 .B s
308 to state the number of seconds to sample instead. For example,
309 .B "\-\-time 2s"
310 will sample for two seconds.
311 .TP
312 .BR "\-\-samples " <numsamples>
313 Acquire
314 .B <numsamples>
315 samples, then quit.
316 .TP
317 .BR "\-\-continuous"
318 Sample continuously until stopped. Not all devices support this.
319 .SH "EXAMPLES"
320 In order to get exactly 100 samples from the (only) detected logic analyzer
321 hardware, run the following command:
322 .TP
323 .B "  sigrok\-cli \-\-samples 100"
324 .TP
325 If you want to sample data for 3 seconds, use:
326 .TP
327 .B "  sigrok\-cli \-\-time 3000"
328 .TP
329 Alternatively, you can also use:
330 .TP
331 .B "  sigrok\-cli \-\-time 3s"
332 .TP
333 To capture data from 4 probes lasting 100ms at 10 MHz starting at the trigger condition 1:high, 2:rising, 3:low, 4:high, use:
334 .TP
335 .B "  sigrok\-cli -d 0:samplerate=10m \-O bits \-p 1\-4 \-\-time 100 \\\\"
336 .B "      \-\-wait\-trigger \-\-triggers 1=1,2=r,3=0,4=1 "
337 .SH "EXIT STATUS"
338 .B sigrok\-cli
339 exits with 0 on success, 1 on most failures.
340 .SH "SEE ALSO"
341 \fBsigrok\-qt\fP(1),
342 \fBsigrok\-gtk\fP(1)
343 .SH "BUGS"
344 Please report any bugs on the sigrok\-devel mailing list
345 .RB "(" sigrok\-devel@lists.souceforge.net ")."
346 .SH "LICENSE"
347 .B sigrok\-cli
348 is covered by the GNU General Public License (GPL). Some portions are
349 licensed under the "GPL v2 or later", some under "GPL v3 or later".
350 .SH "AUTHORS"
351 Please see the individual source code files.
352 .PP
353 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
354 It is licensed under the terms of the GNU GPL (version 2 or later).