sigrok - User contributions [en]

Main Page

2010-12-30T18:23:44Z

Rf: add shortcut to github

<table width="100%" valign="top"><tr valign="top"><td width="80%">

<div style="margin-top:0.5em; margin-bottom:0.5em; padding:0.5em 0.5em 0.5em 0.5em; background-color:#cfdfff; align:right; border:1px solid #aabbcc;">
The '''sigrok''' project aims at creating a portable, cross-platform, Free/Libre/Open-Source logic analyzer software that supports various (usually USB-based) logic analyzer hardware products. The code is licensed under the terms of the '''GNU GPL'''.
</div>

== Design goals ==

* '''Broad hardware support'''. Supports a wide variety of logic analyzers from various vendors with different capabilities.
* '''Cross-platform'''. Works on [[Linux]], [[Mac OS X]] and [[Windows]], and on many architectures including x86, ARM, Sparc and PowerPC.
* '''Scriptable protocol decoding'''. Extendable with [[protocol decoders]] and analyzers written in Python.
* '''Format support'''. Supports various [[Input output formats|input and output formats]] (raw, ASCII, hex, CSV, gnuplot, [http://en.wikipedia.org/wiki/Value_change_dump VCD], others).

== Supported hardware ==

<gallery widths="120px" heights="70px" perrow="5">
File:Saleae Logic.jpg|'''[[Saleae Logic]]''' (supported)
File:Eeelec xla esla100.jpg|'''[[EE Electronics XLA ESLA100|EE Electronics XLA/ESLA100]]''' (supported)
File:ASIX SIGMA.jpg|'''[[ASIX SIGMA]]''' (supported)
File:Openbench logic sniffer front.jpg|'''[[Openbench Logic Sniffer]]''' (supported)
File:Zeroplus Logic Cube.jpg|'''[[ZEROPLUS Logic Cube LAP-C]]''' (work in progress)
File:Cwav usbee sx.jpg|'''[[CWAV USBee SX]]''' (coming up)
File:Braintechnology usb lps.jpg|'''[[Braintechnology USB-LPS]]''' (planned)
File:Buspirate v3 front.jpg|'''[[Buspirate]]''' (planned)
File:Intronix Logicport.jpg|'''[[Intronix Logicport]]''' (planned)
</gallery>

<table width="100%">
<tr style="vertical-align:top">
<td style="vertical-align:top" width="30%">

== [[File:Sigrok_stone.png]] Documentation ==

* [[Downloads]]
* Building: [[Linux]], [[Mac OS X]], [[Windows]]
* [[Status]]
* [[FAQ]]
* [[Supported hardware]]
* [[Command-line]]
* [[GUI|Cross-platform GUI]]
* [[Input output formats]]
* [[Protocol decoders]]
* [[Logic Analyzer Comparison]]

</td><td style="vertical-align:top" width="25%">

== [[File:Sigrok_stone.png]] Development ==
* [http://sigrok.git.sourceforge.net/git/gitweb.cgi?p=sigrok/sigrok;a=tree Browse Source Code]
* [[TODO]]
* [[Design Ideas]]
* [[Protocol decoder API]]
* [[Formats and structures]]
* [[Hardware plugin API]]
* [[Input API]]
* [[Output API]]

</td><td style="vertical-align:top" width="15%">

== [[File:Sigrok_stone.png]] Misc ==

* [[News]]
* [[Current events]]
* [[Press]]
* [[Logo]]

</td><td style="vertical-align:top" width="35%">

== [[File:Sigrok_stone.png]] Getting in touch ==

* Mailing lists: [https://lists.sourceforge.net/lists/listinfo/sigrok-devel sigrok-devel] ([http://news.gmane.org/gmane.comp.debugging.sigrok.devel archive]), [https://lists.sourceforge.net/lists/listinfo/sigrok-commits sigrok-commits]
* IRC: '''[irc://chat.freenode.net/sigrok #sigrok]''' on [http://www.freenode.net Freenode]
* identi.ca: [http://www.identi.ca/group/sigrok sigrok group]
* Sites: [http://sourceforge.net/projects/sigrok/ SF], [http://freshmeat.net/projects/sigrok Fm], [https://www.ohloh.net/p/sigrok ohloh], [http://delicious.com/url/d8996d567839064c799ac217b263b2c8 del.icio.us]

</td>
</tr>
</table>

</td><td width="20%">

[[File:Sigrok linux.png|center|thumb|sigrok-gui on Linux]]

 

'''[[File:Sigrok_stone.png]] [[News]]'''<hr />


* '''2010/05/01:''' [[News#2010.2F05.2F01_ASIX_SIGMA_now_supported|ASIX SIGMA support]]
* '''2010/04/06:''' VCD and Gnuplot output
* '''2010/04/01:''' [[ZEROPLUS Logic Cube LAP-C]] support
* '''2010/03/30:''' libsigrokdecode started
* '''2010/03/19:''' GUI: i18n support
* '''2010/03/17:''' Session save support
* '''2010/03/16:''' GUI started
* '''2010/03/14:''' Official project start


</td></tr></table>

----
'''IMPORTANT: Please note that (unless explicitly specified otherwise) all contents in this wiki (including text and images) are released to the CC-BY-SA 3.0. If you don't want that, please explicitly specify another free-ish license when adding pages or images to the wiki!'''
__NOTOC__
__NOEDITSECTION__

Sigrok-cli

2010-12-01T19:01:40Z

Rf:

The sigrok '''command-line frontend''' <tt>sigrok-cli</tt> 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 can display samples on standard output or save them in various file formats.

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.

== Usage ==
Usage:
$ '''sigrok-cli [Arguments]'''

== Arguments ==

=== Informational ===

* '''-H, --list-hw-plugins'''
Output a list of all available hardware plugins.

* '''-D, --list-devices'''
List devices found on the system.

* '''-A, --list-analyzer-plugins'''
Output a list of all available protocol analysis plugins.

* '''-V, --version'''
Show version.

=== Session control ===

* '''-L, --load-session-file <filename>'''
Session file to load previously acquired data from. Any devices or protocols listed in the file will be reused, unless overridden by other commandline arguments.

* '''-S, --save-session-file <filename>'''
Save session to file.

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

* '''--samples <num>'''
Acquire <num> samples, then quit. The number of samples may also be specified with a "k", "m" or "g" suffix, e.g. "1k" is equivalent to "1000".

* '''-d, --device <string>'''
The device to use for acquisition, specified by ID as report by '''--list-devices'''.

* '''-p --probes <string>'''
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'''. Thus a probe list given as '''1=CLK,2-4,7''' will give output like this:

CLK:11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111111
2:11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111111
3:11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111111
4:11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111111
7:11111111 11111111 11111111 11111111 11111111 11111111 11111111 11111111

* '''-t, --triggers <string>'''
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.

* '''-a, --analyzers <string>'''
A string listing the sequence of protocol analysis plugins the signal should go through. Each element of the sequence consists of the plugin's name, with a pipe ('''|''') symbol separating the elements.

=== Session options ===

* '''-o, --device-option <option string>'''
Set a device-specific option. The argument takes the form of '''option=value'''. Currently the only option supported 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 -o samplerate=1000000
$ sigrok-cli --samples 100 -o samplerate=1m
$ sigrok-cli --samples 100 -o "samplerate=1 MHz"

The '''--device-option'''' argument can be used multiple times as needed.

* '''-f, --format <format>'''
Set the output format to use. Supported formats currently include '''bits''', '''hex''', '''binary''', '''vcd''', and '''gnuplot'''. The '''bits''' or '''hex''' formats, for an ASCII bit display or hexadecimal display, 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 11111111 11111111 11111111 11111111
2:11111111 00000000 11111111 00000000 11111111 00000000 11111111 00000000

Linux

2010-12-01T18:56:56Z

Rf: add: hint ( sudo ldconfig /usr/local/lib/ )

[[File:sigrok linux.png|right|thumb|320px|sigrok-gui on Linux]]

This page describes how to build sigrok on Linux.

== Requirements ==

* git (for cloning the source code repository)
* gcc, g++, make, ...
* autoconf, automake, libtool, pkg-config
* [http://library.gnome.org/devel/glib/unstable/ libglib] >= 2.0
* [http://www.libusb.org libusb] >= 1.0.5
* [http://nih.at/libzip/ libzip] >= 0.8
* [http://www.intra2net.com/en/developer/libftdi/ libftdi] (optional, only required for some devices)

* [http://www.python.org Python] >= 2.5 (optional, only required for protocol decoders)
* [http://qt.nokia.com Qt + Qt Creator] >= 4.5 (optional, only required for building/editing the GUI)

== Installing the build-dependencies ==

On most Linux distributions there are pre-built packages for the sigrok dependencies (if not, you have to build the packages from source). The installation using a package manager is usually pretty simple.

Debian/Ubuntu:

$ '''sudo apt-get install git-core gcc g++ make autoconf automake libtool pkg-config \'''
'''libglib2.0-dev libftdi-dev libusb-1.0-0-dev libzip-dev python-dev qtcreator qt4-designer qt4-dev-tools libqt4-dev'''

Fedora:

$ '''yum install gcc-c++ libtool glib2-devel libftdi-devel libusb1-devel libzip-devel qt-devel python-devel'''

== Building ==

$ '''git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok'''
$ '''cd sigrok'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

Then, for building the GUI:

$ '''cd gui'''
$ '''qmake'''
$ '''make'''

If you get warnings claiming potential symbol conflicts when running qmake, you are likely invoking qt3. Try running qmake-qt4 to force the correct version.

== Pitfalls ==
If you get this error:
sigrok-cli: error while loading shared libraries: libsigrok.so.0: cannot open shared object file: No such file or directory
Then you have to rebuild the links to your shared libraries:
$ '''sudo ldconfig /usr/local/lib/'''

== Test it ==
$ '''sigrok-cli -H'''
Should give you something like:
<pre>Plugins for the following devices are installed:
saleae-logic
sump
zeroplus-logic-cube
asix-sigma
</pre>After plugin your device try
$''' sigrok-cli -D'''
<pre>
The following devices were found:
ID Device
0 Zeroplus Logic Cube with 32 probes
</pre>

See [[Command-line]] for further usage.

== Distribution packages ==

* Debian / Ubuntu: [[User:Uwe Hermann|Uwe Hermann]] will create [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=579600 packages for Debian unstable] (which will semi-automatically migrate to Ubuntu after a while).
* Fedora: See [[Linux/Fedora]].

Linux

2010-12-01T18:21:57Z

Rf: /* Building */

[[File:sigrok linux.png|right|thumb|320px|sigrok-gui on Linux]]

This page describes how to build sigrok on Linux.

== Requirements ==

* git (for cloning the source code repository)
* gcc, g++, make, ...
* autoconf, automake, libtool, pkg-config
* [http://library.gnome.org/devel/glib/unstable/ libglib] >= 2.0
* [http://www.libusb.org libusb] >= 1.0.5
* [http://nih.at/libzip/ libzip] >= 0.8
* [http://www.intra2net.com/en/developer/libftdi/ libftdi] (optional, only required for some devices)

* [http://www.python.org Python] >= 2.5 (optional, only required for protocol decoders)
* [http://qt.nokia.com Qt + Qt Creator] >= 4.5 (optional, only required for building/editing the GUI)

== Installing the build-dependencies ==

On most Linux distributions there are pre-built packages for the sigrok dependencies (if not, you have to build the packages from source). The installation using a package manager is usually pretty simple.

Debian/Ubuntu:

$ '''sudo apt-get install git-core gcc g++ make autoconf automake libtool pkg-config \'''
'''libglib2.0-dev libftdi-dev libusb-1.0-0-dev libzip-dev python-dev qtcreator qt4-designer qt4-dev-tools libqt4-dev'''

Fedora:

$ '''yum install gcc-c++ libtool glib2-devel libftdi-devel libusb1-devel libzip-devel qt-devel python-devel'''

== Building ==

$ '''git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok'''
$ '''cd sigrok'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

Then, for building the GUI:

$ '''cd gui'''
$ '''qmake'''
$ '''make'''

If you get warnings claiming potential symbol conflicts when running qmake, you are likely invoking qt3. Try running qmake-qt4 to force the correct version.

== Distribution packages ==

* Debian / Ubuntu: [[User:Uwe Hermann|Uwe Hermann]] will create [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=579600 packages for Debian unstable] (which will semi-automatically migrate to Ubuntu after a while).
* Fedora: See [[Linux/Fedora]].

Linux

2010-12-01T17:54:14Z

Rf: /* Installing the build-dependencies */

[[File:sigrok linux.png|right|thumb|320px|sigrok-gui on Linux]]

This page describes how to build sigrok on Linux.

== Requirements ==

* git (for cloning the source code repository)
* gcc, g++, make, ...
* autoconf, automake, libtool, pkg-config
* [http://library.gnome.org/devel/glib/unstable/ libglib] >= 2.0
* [http://www.libusb.org libusb] >= 1.0.5
* [http://nih.at/libzip/ libzip] >= 0.8
* [http://www.intra2net.com/en/developer/libftdi/ libftdi] (optional, only required for some devices)

* [http://www.python.org Python] >= 2.5 (optional, only required for protocol decoders)
* [http://qt.nokia.com Qt + Qt Creator] >= 4.5 (optional, only required for building/editing the GUI)

== Installing the build-dependencies ==

On most Linux distributions there are pre-built packages for the sigrok dependencies (if not, you have to build the packages from source). The installation using a package manager is usually pretty simple.

Debian/Ubuntu:

$ '''sudo apt-get install git-core gcc g++ make autoconf automake libtool pkg-config \'''
'''libglib2.0-dev libftdi-dev libusb-1.0-0-dev libzip-dev python-dev qtcreator qt4-designer qt4-dev-tools libqt4-dev'''

Fedora:

$ '''yum install gcc-c++ libtool glib2-devel libftdi-devel libusb1-devel libzip-devel qt-devel python-devel'''

== Building ==

$ '''git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok'''
$ '''cd sigrok'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''make install'''

Then, for building the GUI:

$ '''cd gui'''
$ '''qmake'''
$ '''make'''

If you get warnings claiming potential symbol conflicts when running qmake, you are likely invoking qt3. Try running qmake-qt4 to force the correct version.

== Distribution packages ==

* Debian / Ubuntu: [[User:Uwe Hermann|Uwe Hermann]] will create [http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=579600 packages for Debian unstable] (which will semi-automatically migrate to Ubuntu after a while).
* Fedora: See [[Linux/Fedora]].