doc/sigrok-cli.1

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