doc/sigrok-cli.1

   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 .sp
 233 Notice that the
 234 .B sigrok\-cli
 235 application does not support "name matching". Instead it's assumed that the
 236 traces in the input stream match the order of the decoder's input signals,
 237 or that users explicitly specify the input channel to decoder signal mapping.
 238 .br
 239 .sp
 240 When multiple decoders are specified in the same
 241 .BR -P
 242 option, they will be stacked on top of each other in the specified order.
 243 .sp
 244 Example:
 245 .sp
 246  $
 247 .B "sigrok\-cli \-i <file.sr> \-P i2c,eeprom24xx"
 248 .br
 249  $
 250 .B "sigrok\-cli \-i <file.sr> \-P uart:baudrate=31250,midi"
 251 .sp
 252 When multiple
 253 .BR -P
 254 options are specified, each of them creates one decoder stack, which
 255 executes in parallel to other decoder stacks.
 256 .sp
 257 Example:
 258 .sp
 259  $
 260 .B "sigrok\-cli \-i <file.sr> \-P uart:tx=D0:rx=D1 \-P timing:data=D2"
 261 .sp
 262 .TP
 263 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
 264 By default, only the stack's topmost protocol decoder's annotation output is
 265 shown. With this option another decoder's annotation can be selected for
 266 display, by specifying its ID:
 267 .sp
 268  $
 269 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid -A i2c"
 270 .sp
 271 If a protocol decoder has multiple annotations, you can also specify
 272 which one of them to show by specifying its short description like this:
 273 .sp
 274  $
 275 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 276 .br
 277 .B "              \-A i2c=data-read"
 278 .sp
 279 Select multiple annotations by separating them with a colon:
 280 .sp
 281  $
 282 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 283 .br
 284 .B "              \-A i2c=data-read:data-write"
 285 .sp
 286 You can also select multiple protocol decoders, with an optional selected
 287 annotation each, by separating them with commas:
 288 .sp
 289  $
 290 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 291 .br
 292 .B "              \-A i2c=data-read:data-write,edid"
 293 .TP
 294 .BR "\-M, \-\-protocol\-decoder\-meta " <pdname>
 295 When given, show protocol decoder meta output instead of annotations.
 296 The argument is the name of the decoder whose meta output to show.
 297 .sp
 298  $
 299 .B "sigrok\-cli \-i <file.sr> \-M i2c"
 300 .sp
 301 Not every decoder generates meta output.
 302 .TP
 303 .BR "\-B, \-\-protocol\-decoder\-binary " <binaryspec>
 304 When given, decoder "raw" data of various kinds is written to stdout instead
 305 of annotations (this could be raw binary UART/SPI bytes, or WAV files, PCAP
 306 files, PNG files, or anything else; this is entirely dependent on the
 307 decoder and what kinds of binary output make sense for that decoder).
 308 .sp
 309 No other information is printed to stdout, so this is
 310 suitable for piping into other programs or saving to a file.
 311 .sp
 312 Protocol decoders that support binary output publish a list of binary
 313 classes, for example the UART decoder might have "TX" and "RX". To
 314 select TX for output, the argument to this option would be:
 315 .sp
 316  $
 317 .B "sigrok\-cli \-i <file.sr> \-B uart=tx"
 318 .br
 319 .sp
 320 If only the protocol decoder is specified, without binary class, all classes
 321 are written to stdout:
 322 .sp
 323  $
 324 .B "sigrok\-cli \-i <file.sr> \-B uart"
 325 .sp
 326 (this is only useful in rare cases, generally you would specify a certain
 327 binary class you're interested in)
 328 .sp
 329 Not every decoder generates binary output.
 330 .TP
 331 .BR "\-\-protocol\-decoder\-samplenum
 332 When given, decoder annotations will include sample numbers, too.
 333 This allows consumers to receive machine readable timing information.
 334 .TP
 335 .BR "\-l, \-\-loglevel " <level>
 336 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP
 337 doesn't support setting the two loglevels independently. The higher the
 338 number, the more debug output will be printed. Valid loglevels are:
 339 .sp
 340 \fB0\fP   None
 341 .br
 342 \fB1\fP   Error
 343 .br
 344 \fB2\fP   Warnings
 345 .br
 346 \fB3\fP   Informational
 347 .br
 348 \fB4\fP   Debug
 349 .br
 350 \fB5\fP   Spew
 351 .TP
 352 .B "\-\-show"
 353 .br
 354 Show information about the selected option. For example, to see options for a
 355 connected fx2lafw device:
 356 .sp
 357  $
 358 .B "sigrok\-cli \-\-driver fx2lafw \-\-show
 359 .sp
 360 In order to properly get device options for your hardware, some drivers might
 361 need a serial port specified:
 362 .sp
 363  $
 364 .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show
 365 .sp
 366 This also works for protocol decoders, input modules and output modules:
 367 .sp
 368  $
 369 .B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show
 370  $
 371 .B "sigrok\-cli \-\-input\-format csv \-\-show
 372  $
 373 .B "sigrok\-cli \-\-output\-format bits \-\-show
 374 .TP
 375 .B "\-\-scan"
 376 Scan for devices that can be detected automatically.
 377 .sp
 378 Example:
 379 .sp
 380  $
 381 .B "sigrok\-cli \-\-scan
 382 .br
 383  The following devices were found:
 384 .br
 385  demo - Demo device with 12 channels: D0 D1 D2 D3 D4 D5 D6 D7 A0 A1 A2 A3
 386 .br
 387  fx2lafw:conn=3.26 - CWAV USBee SX with 8 channels: 0 1 2 3 4 5 6 7
 388 .sp
 389 However, not all devices are auto-detectable (e.g. serial port based ones).
 390 For those you'll have to provide a \fBconn\fP option, see above.
 391 .sp
 392  $
 393 .B "sigrok\-cli \-\-driver digitek-dt4000zc:conn=/dev/ttyUSB0 \-\-scan
 394 .br
 395  The following devices were found:
 396 .br
 397  Digitek DT4000ZC with 1 channel: P1
 398 .TP
 399 .BR "\-\-time " <ms>
 400 Sample for
 401 .B <ms>
 402 milliseconds, then quit.
 403 .sp
 404 You can optionally follow the number by \fBs\fP to specify the time to
 405 sample in seconds.
 406 .sp
 407 For example,
 408 .B "\-\-time 2s"
 409 will sample for two seconds.
 410 .TP
 411 .BR "\-\-samples " <numsamples>
 412 Acquire
 413 .B <numsamples>
 414 samples, then quit.
 415 .sp
 416 You can optionally follow the number by \fBk\fP, \fBm\fP, or \fBg\fP to
 417 specify the number of samples in kilosamples, megasamples, or gigasamples,
 418 respectively.
 419 .sp
 420 For example,
 421 .B "\-\-samples 3m"
 422 will acquire 3000000 samples.
 423 .TP
 424 .BR "\-\-frames " <numframes>
 425 Acquire
 426 .B <numframes>
 427 frames, then quit.
 428 .TP
 429 .BR "\-\-continuous"
 430 Sample continuously until stopped. Not all devices support this.
 431 .TP
 432 .BR "\-\-get " <variable>
 433 Get the value of
 434 .B <variable>
 435 from the specified device and print it.
 436 .TP
 437 .BR "\-\-set"
 438 Set one or more variables specified with the \fB\-\-config\fP option, without
 439 doing any acquisition.
 440 .SH EXAMPLES
 441 In order to get exactly 100 samples from the connected fx2lafw-supported logic
 442 analyzer hardware, run the following command:
 443 .TP
 444 .B "  sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
 445 .TP
 446 If you want to sample data for 3 seconds (3000 ms), use:
 447 .TP
 448 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3000"
 449 .TP
 450 Alternatively, you can also use:
 451 .TP
 452 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
 453 .TP
 454 To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
 455 0:high, 1:rising, 2:low, 3:high, use:
 456 .TP
 457 .nf
 458 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP
 459 \fB\-\-output\-format bits \-\-channels 0\-3 \-\-wait\-trigger \\\fP
 460 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
 461 .TP
 462 To turn on internal logging on a Lascar EL-USB series device:
 463 .TP
 464 \fBsigrok\-cli \-\-driver lascar\-el\-usb:conn=10c4.0002 \\\fP
 465 \fB\-\-config datalog=on \-\-set\fP
 466 .SH "EXIT STATUS"
 467 .B sigrok\-cli
 468 exits with 0 on success, 1 on most failures.
 469 .SH "SEE ALSO"
 470 \fBpulseview\fP(1)
 471 .SH "BUGS"
 472 Please report any bugs via Bugzilla
 473 .RB "(" http://sigrok.org/bugzilla ")"
 474 or on the sigrok\-devel mailing list
 475 .RB "(" sigrok\-devel@lists.souceforge.net ")."
 476 .SH "LICENSE"
 477 .B sigrok\-cli
 478 is covered by the GNU General Public License (GPL). Some portions are
 479 licensed under the "GPL v2 or later", some under "GPL v3 or later".
 480 .SH "AUTHORS"
 481 Please see the individual source code files.
 482 .PP
 483 This manual page was written by Uwe Hermann <uwe@hermann\-uwe.de>.
 484 It is licensed under the terms of the GNU GPL (version 2 or later).