doc/sigrok-cli.1

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