-------------------------------------------------------------------------------
The sigrok project aims at creating a portable, cross-platform,
-Free/Libre/Open-Source logic analyzer software that supports various
-logic analyzer hardware products.
+Free/Libre/Open-Source signal analysis software suite that supports various
+device types (such as logic analyzers, oscilloscopes, multimeters, and more).
libsigrok is a shared library written in C which provides the basic API
-for talking to logic analyzer hardware and reading/writing the acquired data
-into various input/output file formats.
+for talking to hardware and reading/writing the acquired data into various
+input/output file formats.
-Status and API
---------------
+Status
+------
-libsigrok is currently work in progress.
+libsigrok is in a usable state and has had official tarball releases.
-IMPORTANT: The API of libsigrok is NOT yet considered stable! Please do
- not rely on it, yet! Changes to function names, macro names etc.
- can happen at any time without prior notice!
+While the API can change from release to release, this will always be
+properly documented and reflected in the package version number and
+in the shared library / libtool / .so-file version numbers.
+
+However, there are _NO_ guarantees at all for stable APIs in git snapshots!
+Distro packagers should only use released tarballs (no git snapshots).
Requirements
- automake >= 1.11
- libtool
- pkg-config >= 0.22
- - libglib >= 2.22.0
- - libusb >= 1.0.5 (for most logic analyzer hardware)
+ - libglib >= 2.28.0
- libzip >= 0.8
- - zlib >= 1.2.3.1
- - libftdi >= 0.16 (for some logic analyzer hardware)
- - libudev >= 151 (for some logic analyzer hardware)
+ - libusb-1.0 >= 1.0.9 (optional, used by most drivers)
+ - libftdi >= 0.16 (optional, used by some drivers)
+ - libudev >= 151 (optional, used by some drivers)
+ - libasound / alsa-lib >= 1.0 (optional, only used by the alsa driver)
Building and installing
In order to get the libsigrok source code and build it, run:
- $ git clone git://sigrok.git.sourceforge.net/gitroot/sigrok/sigrok
- $ cd sigrok/libsigrok
+ $ git clone git://sigrok.org/libsigrok
+ $ cd libsigrok
$ ./autogen.sh
$ ./configure
$ make
http://sigrok.org/wiki/FreeBSD
+Firmware
+--------
+
+Some devices supported by libsigrok need a firmware to be uploaded before the
+device can be used.
+
+The default location where libsigrok expects the firmware files is:
+
+ $prefix/share/sigrok-firmware
+
+($prefix is usually /usr/local or /usr, depending on your ./configure options)
+
+For further information see:
+
+ http://sigrok.org/wiki/Firmware
+
+
Mailing lists
-------------
Website
-------
-http://sigrok.org
+ http://sigrok.org/wiki/Libsigrok