sigrok - User contributions [en]

Sigrok-cli

2011-11-01T22:44:04Z

Ksjoberg:

<pre>
NAME
sigrok-cli - Command-line client for the sigrok logic analyzer software

SYNOPSIS
sigrok-cli [-VDdptoIfh] [-V|--version] [-D|--list-devices] [-d|--device
devid[:option]] [-p|--probes probelist] [-t|--triggers triggerlist]
[-o|--output-file filename] [-i|--input-file filename] [-f|--format
formatname] [--time ms] [--samples numsamples] [--continuous]
[-h|--help]

DESCRIPTION
sigrok-cli is a cross-platform command line utility for the sigrok
logic analyzer software.

The command-line frontend for sigrok cannot display graphical output,
but is still sufficient to run through the whole process of hardware
initialization, acquisition, protocol analysis and saving the session.

It is useful for running on remote or embedded systems, netbooks, PDAs,
and for various other use-cases. It can display samples on standard
output or save them in various file formats.

OPTIONS
-V, --version
Show version, driver and module information.

-D, --list-devices
List all logic analyzer devices found on the system.

-d, --device <devid[:option]>
The device to use for acquisition, specified by ID as reported
by --list-devices.

Device-specific option are specified as a colon separated list after the
device ID. The argument takes the form of option=value. A common
option is samplerate, with the argument being the samplerate in Hz.
You can also specify the sample rate in kHz, MHz or GHz. The following
are all equivalent:

sigrok-cli --samples 100 -d demo:samplerate=1000000
sigrok-cli --samples 100 -d demo:samplerate=1m
sigrok-cli --samples 100 -d demo:"samplerate=1 MHz"

The option argument can be used multiple times as
needed.

-p, --probes <probelist>
A comma-separated list of probes to be used in the session.

The default is to use all the probes available on a device. You
can name a probe like this: 1=CLK. A range of probes can also
be given, in the form 1-5.

Example:

$ sigrok-cli --samples 100 --probes 1=CLK,2-4,7
CLK:11111111 11111111 11111111 11111111 [...]
2:11111111 11111111 11111111 11111111 [...]
3:11111111 11111111 11111111 11111111 [...]
4:11111111 11111111 11111111 11111111 [...]
7:11111111 11111111 11111111 11111111 [...]

The comma-separated list is processed from left to right, i.e.
items farther to the right override previous items. For example
1=CS,1=MISO will set the name of probe 1 to MISO.

Also, while 5=MOSI,6=MISO will only select probes 5 and 6, and
set their names to MISO and MOSI, the command line
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 1-8 probe selection.

-t, --triggers <triggerlist>
A comma-separated list of triggers to use, of the form
<probe>=<trigger>. You can use the name or number of the probe,
and the trigger itself is a series of characters:

0 or 1: A low or high value on the pin.
r or f: A rising or falling value on the pin. An r effectively
corresponds to 01.
c: Any kind of change on a pin.

Not every device supports all of these trigger types. Use the -d
<device-id> argument (with no other arguments) to see which
triggers your device supports.

-i, --input-file <filename>
Load input from a file instead of a device.

-o, --output-file <filename>
Write output to a file instead of stdout.

-f, --format <formatname>
Set the output format to use.

Supported formats currently include bits, hex, ascii, binary,
vcd, ols, gnuplot, and analog.

The bits or hex formats, for an ASCII bit display or ASCII hexa‐
decimal display, can be optionally followed by a length argument
specifying the number of samples (in bits). Thus hex128 would
display 128 bits per line, in hexadecimal:

1:ffff ffff ffff ffff ffff ffff ffff ffff
2:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00

The lines always start with the probe number (or name, if
defined), followed by a colon. If no format is specified, it
defaults to bits64, like this:

1:11111111 11111111 11111111 11111111 [...]
2:11111111 00000000 11111111 00000000 [...]

--time <ms>
Sample for <ms> milliseconds, then quit. You can optionally fol‐
low the number by s to state the number of seconds to sample
instead. For example, --time 2s will sample for two seconds.

--samples <numsamples>
Acquire <numsamples> samples, then quit.

--continuous
Sample continuously until stopped. Not all devices support this.

-h, --help
Show a help text and exit.

EXAMPLES
In order to get exactly 100 samples from the (only) detected logic ana‐
lyzer hardware, run the following command:

sigrok-cli --samples 100

If you want to sample data for 3 seconds, use:

sigrok-cli --time 3000

Alternatively, you can also use:

sigrok-cli --time 3s

To capture data from 4 probes lasting 100ms at 10 MHz starting at the
trigger condition 1:high, 2:rising, 3:low, 4:high, use:

sigrok-cli -f bits -p 1-4 --time 100 -d demo:samplerate=10m \
--wait-trigger --triggers 1=1,2=r,3=0,4=1

EXIT STATUS
sigrok-cli exits with 0 on success, 1 on most failures.

SEE ALSO
sigrok-gui(1)

BUGS
Please report any bugs on the sigrok-devel mailing list (sigrok-
devel@lists.souceforge.net).

LICENSE
sigrok-cli is covered by the GNU General Public License (GPL). Some
portions are licensed under the "GPL v2 or later", some under "GPL v3
or later".

AUTHORS
Please see the individual source code files.

This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>. It
is licensed under the terms of the GNU GPL (version 2 or later).

</pre>

Sigrok-cli

2011-11-01T22:41:48Z

Ksjoberg: Update command lines to the current option set in git.

<pre>
NAME
sigrok-cli - Command-line client for the sigrok logic analyzer software

SYNOPSIS
sigrok-cli [-VDdptoIfh] [-V|--version] [-D|--list-devices] [-d|--device
devid[:option]] [-p|--probes probelist] [-t|--triggers triggerlist]
[-o|--output-file filename] [-i|--input-file filename] [-f|--format
formatname] [--time ms] [--samples numsamples] [--continuous]
[-h|--help]

DESCRIPTION
sigrok-cli is a cross-platform command line utility for the sigrok
logic analyzer software.

The command-line frontend for sigrok cannot display graphical output,
but is still sufficient to run through the whole process of hardware
initialization, acquisition, protocol analysis and saving the session.

It is useful for running on remote or embedded systems, netbooks, PDAs,
and for various other use-cases. It can display samples on standard
output or save them in various file formats.

OPTIONS
-V, --version
Show version, driver and module information.

-D, --list-devices
List all logic analyzer devices found on the system.

-d, --device <devid[:option]>
The device to use for acquisition, specified by ID as reported
by --list-devices.

Device-specific option are specified as a colon separated list after the
device ID. The argument takes the form of option=value. A common
option is samplerate, with the argument being the samplerate in Hz.
You can also specify the sample rate in kHz, MHz or GHz. The following
are all equivalent:

sigrok-cli --samples 100 -d demo:samplerate=1000000
sigrok-cli --samples 100 -d demo:samplerate=1m
sigrok-cli --samples 100 -d demo:"samplerate=1 MHz"

The option argument can be used multiple times as
needed.

-p, --probes <probelist>
A comma-separated list of probes to be used in the session.

The default is to use all the probes available on a device. You
can name a probe like this: 1=CLK. A range of probes can also
be given, in the form 1-5.

Example:

$ sigrok-cli --samples 100 --probes 1=CLK,2-4,7
CLK:11111111 11111111 11111111 11111111 [...]
2:11111111 11111111 11111111 11111111 [...]
3:11111111 11111111 11111111 11111111 [...]
4:11111111 11111111 11111111 11111111 [...]
7:11111111 11111111 11111111 11111111 [...]

The comma-separated list is processed from left to right, i.e.
items farther to the right override previous items. For example
1=CS,1=MISO will set the name of probe 1 to MISO.

Also, while 5=MOSI,6=MISO will only select probes 5 and 6, and
set their names to MISO and MOSI, the command line
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 1-8 probe selection.

-t, --triggers <triggerlist>
A comma-separated list of triggers to use, of the form
<probe>=<trigger>. You can use the name or number of the probe,
and the trigger itself is a series of characters:

0 or 1: A low or high value on the pin.
r or f: A rising or falling value on the pin. An r effectively
corresponds to 01.
c: Any kind of change on a pin.

Not every device supports all of these trigger types. Use the -d
<device-id> argument (with no other arguments) to see which
triggers your device supports.

-i, --input-file <filename>
Load input from a file instead of a device.

-o, --output-file <filename>
Write output to a file instead of stdout.

-f, --format <formatname>
Set the output format to use.

Supported formats currently include bits, hex, ascii, binary,
vcd, ols, gnuplot, and analog.

The bits or hex formats, for an ASCII bit display or ASCII hexa‐
decimal display, can be optionally followed by a length argument
specifying the number of samples (in bits). Thus hex128 would
display 128 bits per line, in hexadecimal:

1:ffff ffff ffff ffff ffff ffff ffff ffff
2:ff00 ff00 ff00 ff00 ff00 ff00 ff00 ff00

The lines always start with the probe number (or name, if
defined), followed by a colon. If no format is specified, it
defaults to bits64, like this:

1:11111111 11111111 11111111 11111111 [...]
2:11111111 00000000 11111111 00000000 [...]

--time <ms>
Sample for <ms> milliseconds, then quit. You can optionally fol‐
low the number by s to state the number of seconds to sample
instead. For example, --time 2s will sample for two seconds.

--samples <numsamples>
Acquire <numsamples> samples, then quit.

--continuous
Sample continuously until stopped. Not all devices support this.

-h, --help
Show a help text and exit.

EXAMPLES
In order to get exactly 100 samples from the (only) detected logic ana‐
lyzer hardware, run the following command:

sigrok-cli --samples 100

If you want to sample data for 3 seconds, use:

sigrok-cli --time 3000

Alternatively, you can also use:

sigrok-cli --time 3s

To capture data from 4 probes lasting 100ms at 10 MHz starting at the
trigger condition 1:high, 2:rising, 3:low, 4:high, use:

sigrok-cli -f bits -p 1-4 --time 100 -o samplerate=10m \
--wait-trigger --triggers 1=1,2=r,3=0,4=1

EXIT STATUS
sigrok-cli exits with 0 on success, 1 on most failures.

SEE ALSO
sigrok-gui(1)

BUGS
Please report any bugs on the sigrok-devel mailing list (sigrok-
devel@lists.souceforge.net).

LICENSE
sigrok-cli is covered by the GNU General Public License (GPL). Some
portions are licensed under the "GPL v2 or later", some under "GPL v3
or later".

AUTHORS
Please see the individual source code files.

This manual page was written by Uwe Hermann <uwe@hermann-uwe.de>. It
is licensed under the terms of the GNU GPL (version 2 or later).

</pre>

Mac OS X

2011-11-01T00:00:05Z

Ksjoberg: /* How to build and run the Qt GUI */

[[File:sigrok macosx.png|right|thumb|320px|sigrok-gui on Mac OS X]]

This page describes how to build sigrok on Mac OS X.

== How to build and run the Qt GUI ==
These instructions have been tested on a clean Mac OS X 10.6.8 install.

Step 1. Install MacPorts, follow guide on http://www.macports.org/install.php. (This step will require Xcode on your machine, which is also a dependency to build sigrok)

Step 2. Install qt, download qt-mac-opensource-4.7.4.dmg from http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x

Step 3. Install git.
$ '''sudo port install git-core'''
This will also pull in a bunch of dependencies required by git-core (and some of them also by sigrok).

Step 4. Install libusb, libzip and libftdi, Sigrok build dependencies.
$ '''sudo port install libusb'''
$ '''sudo port install libzip'''
$ '''sudo port install libftdi'''

Step 5. Enter some directory where you want to store the sigrok source, and check it out.
$ '''cd some-directory'''
$ '''git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok'''

Step 6. Enter the sigrok source directory.
$ '''cd sigrok'''

Step 7. Generate the platform specific configure script.
$ '''./autogen.sh'''

Step 8. Generate the Makefiles for the current environment.
$ '''./configure'''

Step 9. Compile the Sigrok libraries and the sigrok-cli.
$ '''make'''

Step 10. Install Sigrok libraries and the sigrok-cli to /usr/local/lib/ and /usr/local/bin/
$ '''sudo make install'''

Step 11. Enter the gui directory.
$ '''cd gui'''

Step 12. Prepare the Qt project to be built using make.
$ '''PKG_CONFIG_PATH=/usr/local/lib/pkgconfig qmake -spec macx-g++'''

Step 13. Compile the sigrok-gui application.
$ '''make'''

Step 14. Open the sigrok-gui application just built.
$ '''open -a sigrok-gui.app'''

== Notes ==

To build on Snow Leopard (10.6) you need to use the [http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x Cocoa (32bit and 64bit) Qt libraries]. Don't use the default download link on that page but the one you can find further down the page.

Currently we are using [http://www.macports.org/ macports] for the libusb dependency and are relying on the fact that macports are installed in /opt/local.

== TODO ==

* Find a sane way to bundle libusb with the sigrok.app.
* Include an icon with the app.
* [[Mac OS X/Dylib|Set the relative paths in the binary's and DyLibs]]
* [[Mac OS X/Universal| Building universal DyLibs and binaries]]

== Resources ==

* [http://doc.trolltech.com/qq/qq09-mac-deployment.html Qt: Deploying Applications on Mac OS X]
* [http://developer.apple.com/mac/library/documentation/CoreFoundation/Conceptual/CFBundles/Introduction/Introduction.html#//apple_ref/doc/uid/10000123i-CH1-SW1 Documentation about bundles]