doc/sigrok-cli.1

   1 .TH SIGROK\-CLI 1 "October 22, 2018"
   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 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" " [...]"
  56 .TP
  57 .BR "\-c, \-\-config " <deviceoption>
  58 A colon-separated list of device options, where each option takes the form
  59 .BR key=value .
  60 For example, to set the samplerate to 1MHz on a device supported by the
  61 fx2lafw driver, you might specify
  62 .sp
  63 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1m" " [...]"
  64 .sp
  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.
  67 The following are all equivalent:
  68 .sp
  69 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1000000" " [...]"
  70 .sp
  71 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config samplerate=1m" " [...]"
  72 .sp
  73 .RB "  $ " "sigrok\-cli \-d fx2lafw \-\-config \(dqsamplerate=1 MHz\(dq" " [...]"
  74 .TP
  75 .BR "\-i, \-\-input\-file " <filename>
  76 Load input from a file instead of a hardware device. You can specify
  77 "-" to use stdin as input. If the
  78 .B \-\-input\-format
  79 option is not supplied, sigrok\-cli attempts to autodetect the file format of
  80 the input file.
  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 \-" " [...]
  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 ),
  98 sigrok-cli attempts to autodetect the file format of the input file. Use the
  99 .BR "\-L " ( "\-\-list\-supported" ")"
 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
 104 .BR "key=value" .
 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" " [...]"
 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
 116 .B \-\-output\-format
 117 option.
 118 .sp
 119 Example for saving data in the sigrok session format:
 120 .sp
 121 .RB "  $ " "sigrok\-cli " "[...] " "\-o example.sr"
 122 .TP
 123 .BR "\-O, \-\-output\-format " <format>
 124 Set the output format to use. Use the
 125 .BR "\-L " ( "\-\-list\-supported" ")"
 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
 130 .BR "key=value" .
 131 .sp
 132 For example, the
 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
 137 .B "\-O hex:width=128"
 138 will display 128 bits per line, in hexadecimal:
 139 .sp
 140  0:ffff ffff ffff ffff ffff ffff ffff ffff
 141  1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
 142 .sp
 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
 144 .BR bits:width=64 ,
 145 like this:
 146 .sp
 147  0:11111111 11111111 11111111 11111111 [...]
 148  1:11111111 00000000 11111111 00000000 [...]
 149 .sp
 150 Example for saving data in the CSV format with options:
 151 .sp
 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.
 155 .TP
 156 .BR "\-C, \-\-channels " <channellist>
 157 A comma-separated list of channels to be used in the session.
 158 .sp
 159 Note that sigrok always names the channels according to how they're shown on
 160 the enclosure of the hardware. If your logic analyzer numbers the channels 0\-15,
 161 that's how you must specify them with this option. An oscilloscope's channels
 162 would generally be referred to as "CH1", "CH2", and so on.
 163 Use the \fB\-\-show\fP option to see a list of channel names for your device.
 164 .sp
 165 The default is to use all the channels available on a device. You can name
 166 a channel like this:
 167 .BR "1=CLK" .
 168 A range of channels can also be given, in the form
 169 .BR "1\-5" .
 170 .sp
 171 Example:
 172 .sp
 173 .RB "  $ " "sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
 174 .br
 175 .B "               \-\-channels 1=CLK,2\-4,7"
 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
 185 .B "1=CS,CS=MISO"
 186 will set the name of channel 1 to
 187 .BR "MISO" .
 188 .TP
 189 .BR "\-g, \-\-channel\-group "<channel\ group>
 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
 194 Examples:
 195 .sp
 196 .RB "  $ " "sigrok\-cli \-g CH1" " [...]"
 197 .sp
 198 .RB "  $ " "sigrok\-cli \-d demo \-g Logic \-c pattern=graycode" " [...]"
 199 .TP
 200 .BR "\-t, \-\-triggers " <triggerlist>
 201 A comma-separated list of triggers to use, of the form
 202 .BR "<channel>=<trigger>" .
 203 You can use the name or number of the channel, and the trigger itself is a
 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
 215 .BR "e" :
 216 Any kind of change on a pin (either a rising or a falling edge).
 217 .sp
 218 Not every device supports all of these trigger types. Use the \fB\-\-show\fP
 219 command to see which triggers your device supports.
 220 .TP
 221 .BR "\-w, \-\-wait\-trigger"
 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).
 227 .TP
 228 .BR "\-P, \-\-protocol\-decoders " <list>
 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
 232 .BR "\-L " ( "\-\-list\-supported" ")"
 233 output.
 234 .sp
 235 Example:
 236 .sp
 237  $
 238 .B "sigrok\-cli \-i <file.sr> \-P i2c"
 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  $
 247 .B "sigrok\-cli \-i <file.sr> "
 248 .br
 249 .B "              \-P uart:baudrate=115200:parity_type=odd"
 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
 255 supported options, will be interpreted as being channel name/number assignments.
 256 .sp
 257 Example:
 258 .sp
 259  $
 260 .B "sigrok\-cli \-i <file.sr>"
 261 .br
 262 .B "              \-P spi:wordsize=9:miso=1:mosi=5:clk=3:cs=0"
 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
 269 protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3
 270 as CLK, and channel 0 as CS# signal.
 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.
 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
 301 .TP
 302 .BR "\-A, \-\-protocol\-decoder\-annotations " <annotations>
 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
 305 display, by specifying its ID:
 306 .sp
 307  $
 308 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid \-A i2c"
 309 .sp
 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:
 312 .sp
 313  $
 314 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 315 .br
 316 .B "              \-A i2c=data\-read"
 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
 323 .B "              \-A i2c=data\-read:data\-write"
 324 .sp
 325 You can also select multiple protocol decoders, with an optional selected
 326 annotation each, by separating them with commas:
 327 .sp
 328  $
 329 .B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
 330 .br
 331 .B "              \-A i2c=data\-read:data\-write,edid"
 332 .TP
 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
 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
 374 .BR "\-l, \-\-loglevel " <level>
 375 Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok\-cli\fP
 376 doesn't support setting the two loglevels independently. The higher the
 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
 393 Show information about the selected option. For example, to see options for a
 394 connected fx2lafw device:
 395 .sp
 396  $
 397 .B "sigrok\-cli \-\-driver fx2lafw \-\-show
 398 .sp
 399 In order to properly get device options for your hardware, some drivers might
 400 need a serial port specified:
 401 .sp
 402  $
 403 .B "sigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-show
 404 .sp
 405 This also works for protocol decoders, input modules and output modules:
 406 .sp
 407  $
 408 .B "sigrok\-cli \-\-protocol\-decoders i2c \-\-show
 409  $
 410 .B "sigrok\-cli \-\-input\-format csv \-\-show
 411  $
 412 .B "sigrok\-cli \-\-output\-format bits \-\-show
 413 .TP
 414 .B "\-\-scan"
 415 Scan for devices that can be detected automatically.
 416 .sp
 417 Example:
 418 .sp
 419  $
 420 .B "sigrok\-cli \-\-scan
 421 .br
 422  The following devices were found:
 423 .br
 424  demo \- Demo device with 12 channels: D0 D1 D2 D3 D4 D5 D6 D7 A0 A1 A2 A3
 425 .br
 426  fx2lafw:conn=3.26 \- CWAV USBee SX with 8 channels: 0 1 2 3 4 5 6 7
 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  $
 432 .B "sigrok\-cli \-\-driver digitek\-dt4000zc:conn=/dev/ttyUSB0 \-\-scan
 433 .br
 434  The following devices were found:
 435 .br
 436  Digitek DT4000ZC with 1 channel: P1
 437 .TP
 438 .BR "\-\-time " <ms>
 439 Sample for
 440 .B <ms>
 441 milliseconds, then quit.
 442 .sp
 443 You can optionally follow the number by \fBs\fP to specify the time to
 444 sample in seconds.
 445 .sp
 446 For example,
 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.
 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.
 462 .TP
 463 .BR "\-\-frames " <numframes>
 464 Acquire
 465 .B <numframes>
 466 frames, then quit.
 467 .TP
 468 .BR "\-\-continuous"
 469 Sample continuously until stopped. Not all devices support this.
 470 .TP
 471 .BR "\-\-get " <variable>
 472 Get the value of
 473 .B <variable>
 474 from the specified device and print it.
 475 .TP
 476 .BR "\-\-set"
 477 Set one or more variables specified with the \fB\-\-config\fP option, without
 478 doing any acquisition.
 479 .SH EXAMPLES
 480 In order to get exactly 100 samples from the connected fx2lafw-supported logic
 481 analyzer hardware, run the following command:
 482 .TP
 483 .B "  sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
 484 .TP
 485 If you want to sample data for 3 seconds (3000 ms), use:
 486 .TP
 487 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3000"
 488 .TP
 489 Alternatively, you can also use:
 490 .TP
 491 .B "  sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
 492 .TP
 493 To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
 494 0:high, 1:rising, 2:low, 3:high, use:
 495 .TP
 496 .nf
 497 \fBsigrok\-cli \-\-driver ols:conn=/dev/ttyACM0 \-\-config samplerate=10m \\\fP
 498 \fB\-\-output\-format bits \-\-channels 0\-3 \-\-wait\-trigger \\\fP
 499 \fB\-\-triggers 0=1,1=r,2=0,3=1 \-\-time 100\fP
 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
 504 \fB\-\-config datalog=on \-\-set\fP
 505 .SH "EXIT STATUS"
 506 .B sigrok\-cli
 507 exits with 0 on success, 1 on most failures.
 508 .SH "SEE ALSO"
 509 \fBpulseview\fP(1)
 510 .SH "BUGS"
 511 Please report any bugs via Bugzilla
 512 .RB "(" http://sigrok.org/bugzilla ")"
 513 or on the sigrok\-devel mailing list
 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).