-.TH SIGROK\-CLI 1 "Feb 05, 2013"
+.TH SIGROK\-CLI 1 "Jan 31, 2014"
.SH "NAME"
sigrok\-cli \- Command-line client for the sigrok software
.SH "SYNOPSIS"
0:ffff ffff ffff ffff ffff ffff ffff ffff
1:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00
.sp
-The lines always start with the probe number (or name, if defined), followed by a colon. If no format is specified, it defaults to
+The lines always start with the channel number (or name, if defined), followed by a colon. If no format is specified, it defaults to
.BR bits:width=64 ,
like this:
.sp
1:11111111 00000000 11111111 00000000 [...]
.TP
.BR "\-p, \-\-probes " <probelist>
-A comma-separated list of probes to be used in the session.
+A comma-separated list of channels to be used in the session.
.sp
-Note that sigrok always names the probes according to how they're shown on
-the enclosure of the hardware. If your logic analyzer numbers the probes 0-15,
-that's how you must specify them with this option. An oscilloscope's probes
+Note that sigrok always names the channels according to how they're shown on
+the enclosure of the hardware. If your logic analyzer numbers the channels 0-15,
+that's how you must specify them with this option. An oscilloscope's channels
would generally be referred to as "CH1", "CH2", and so on.
-Use the \fB\-\-show\fP option to see a list of probe names for your device.
+Use the \fB\-\-show\fP option to see a list of channel names for your device.
.sp
-The default is to use all the probes available on a device. You can name
-a probe like this:
+The default is to use all the channels available on a device. You can name
+a channel like this:
.BR "1=CLK" .
-A range of probes can also be given, in the form
+A range of channels can also be given, in the form
.BR "1\-5" .
.sp
Example:
The comma-separated list is processed from left to right, i.e. items farther
to the right override previous items. For example
.B "1=CS,1=MISO"
-will set the name of probe 1 to
+will set the name of channel 1 to
.BR "MISO" .
.sp
Also, while
.B "5=MOSI,6=MISO"
-will only select probes 5 and 6, and set their names to MISO and MOSI, the
+will only select channels 5 and 6, and set their names to MISO and MOSI, the
command line
.B "5=MOSI,6=MISO,1\-8"
-will select probes 1\-8 (including 5 and 6, of course), but the names specified
-for probes 5 and 6 will be reset to the defaults by the
+will select channels 1\-8 (including 5 and 6, of course), but the names specified
+for channels 5 and 6 will be reset to the defaults by the
.B "1\-8"
-probe selection.
+channel selection.
+.TP
+.BR "\-g, \-\-channel\-group "<channel\ group>
+Specify the channel group to operate on.
+
+Some devices organize channels into groups, the settings of which can
+only be changed as a group. The list of channel groups, if any, is displayed
+with the \-\-show command.
.TP
.BR "\-t, \-\-triggers " <triggerlist>
A comma-separated list of triggers to use, of the form
-.BR "<probe>=<trigger>" .
-You can use the name or number of the probe, and the trigger itself is a
+.BR "<channel>=<trigger>" .
+You can use the name or number of the channel, and the trigger itself is a
series of characters:
.sp
.BR "0 or 1" :
Example:
.sp
$
-.B "sigrok\-cli \-i <file.sr> \-P uart:baudrate=115200:parity=odd"
+.B "sigrok\-cli \-i <file.sr> "
+.br
+.B " \-P uart:baudrate=115200:parity_type=odd"
.sp
The list of supported options depends entirely on the protocol decoder. Every
protocol decoder has different options it supports.
.sp
Any "options" specified for a protocol decoder which are not actually
-supported options, will be interpreted as being probe name/number assignments.
+supported options, will be interpreted as being channel name/number assignments.
.sp
Example:
.sp
is an option supported by the
.B spi
protocol decoder. Additionally, the user tells sigrok to decode the SPI
-protocol using probe 1 as MISO signal for SPI, probe 5 as MOSI, probe 3
-as SCK, and probe 0 as CS# signal.
+protocol using channel 1 as MISO signal for SPI, channel 5 as MOSI, channel 3
+as SCK, and channel 0 as CS# signal.
.TP
.BR "\-S, \-\-protocol\-decoder\-stack " <stack>
This option allows the user to specify a protocol decoder stack, i.e.
is stacked on top of the
.BR i2c " decoder."
.sp
-The respective protocol decoder options and probe name/number assignments
+The respective protocol decoder options and channel name/number assignments
must be given using the
.B \-P
option (you cannot specify them in the
$
.B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid -A i2c"
.sp
-If a protocol decoder has multiple annotation formats, you can also specify
-which of them to show by specifying its short description like this:
+If a protocol decoder has multiple annotations, you can also specify
+which one of them to show by specifying its short description like this:
+.sp
+ $
+.B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
+.br
+.B " \-A i2c=data-read"
+.sp
+Select multiple annotations by separating them with a colon:
.sp
$
.B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
.br
-.B " \-A i2c=rawhex"
+.B " \-A i2c=data-read:data-write"
.sp
You can also select multiple protocol decoders, with an optional selected
-annotation format each, by separating them with commas:
+annotation each, by separating them with commas:
.sp
$
.B "sigrok\-cli \-i <file.sr> \-P i2c,i2cfilter,edid"
.br
-.B " \-A i2c=rawhex,edid"
+.B " \-A i2c=data-read:data-write,edid"
.TP
.BR "\-l, \-\-loglevel " <level>
Set the libsigrok and libsigrokdecode loglevel. At the moment \fBsigrok-cli\fP
.br
The following devices were found:
.br
- Demo device with 8 probes: 0 1 2 3 4 5 6 7
+ Demo device with 8 channels: 0 1 2 3 4 5 6 7
.br
- ChronoVu LA8 with 8 probes: 0 1 2 3 4 5 6 7
+ ChronoVu LA8 with 8 channels: 0 1 2 3 4 5 6 7
.br
- ALSA: HDA ATI SB ALC270 Analog with 2 probes: Ch_0 Ch_1
+ ALSA: HDA ATI SB ALC270 Analog with 2 channels: Ch_0 Ch_1
.br
- Saleae Logic with 8 probes: 0 1 2 3 4 5 6 7
+ Saleae Logic with 8 channels: 0 1 2 3 4 5 6 7
.sp
However, not all devices are auto-detectable (e.g. serial port based ones).
For those you'll have to provide a \fBconn\fP option, see above.
.br
The following devices were found:
.br
- Digitek DT4000ZC with 1 probe: P1
+ Digitek DT4000ZC with 1 channel: P1
.TP
.BR "\-\-time " <ms>
Sample for
Sample continuously until stopped. Not all devices support this.
.TP
.BR "\-\-set"
-Set one or more variables specified with the \fB--config\fP option, without doing
-any acquisition.
+Set one or more variables specified with the \fB\-\-config\fP option, without
+doing any acquisition.
.SH EXAMPLES
-In order to get exactly 100 samples from the connected fx2lafw-supported logic analyzer hardware, run the following command:
+In order to get exactly 100 samples from the connected fx2lafw-supported logic
+analyzer hardware, run the following command:
.TP
.B " sigrok\-cli \-\-driver fx2lafw \-\-samples 100"
.TP
.TP
.B " sigrok\-cli \-\-driver fx2lafw \-\-time 3s"
.TP
-To capture data from the first 4 probes using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
+To capture data from the first 4 channels using the Openbench Logic Sniffer lasting 100ms at 10 MHz starting at the trigger condition
0:high, 1:rising, 2:low, 3:high, use:
.TP
.nf
To turn on internal logging on a Lascar EL-USB series device:
.TP
\fBsigrok\-cli \-\-driver lascar\-el\-usb:conn=10c4.0002 \\\fP
-\fB\-\-config datalog=on --set\fP
+\fB\-\-config datalog=on \-\-set\fP
.SH "EXIT STATUS"
.B sigrok\-cli
exits with 0 on success, 1 on most failures.
projects / sigrok-cli.git / blobdiff