SQ50 patches for libsigrok
Go to file
Uwe Hermann 0e94d524c1 Shorten/simplify hw_dev_list() implementations. 2013-02-05 18:27:05 +01:00
contrib udev: Add UNI-T UT-D04 multimeter cable entry. 2013-01-20 18:47:35 +01:00
hardware Shorten/simplify hw_dev_list() implementations. 2013-02-05 18:27:05 +01:00
input Rename SR_HWOPT_* and SR_HWCAP_* to SR_CONF_* 2013-01-21 23:32:50 +01:00
output Rename sr_dev_has_hwcap() to sr_dev_has_option(). 2013-01-25 16:20:40 +01:00
.gitignore .gitignore: (Trivial) Ignore KDevelop project files 2012-10-25 19:51:46 +02:00
COPYING sr/srd: Move some files to their resp. dirs. 2011-12-30 11:14:05 +01:00
Doxyfile Doxyfile: Various additions/improvements. 2012-10-22 11:56:17 +02:00
HACKING HACKING: Document enum setup. 2012-11-02 19:05:53 +01:00
Makefile.am Factor out common hw_init() driver code. 2013-01-29 12:56:02 +01:00
NEWS sr: fx2lafw: Add basic support for USBee DX and clones 2012-08-01 00:12:00 +04:00
README README: Document alsa (optional) library. 2013-01-19 19:13:52 +01:00
autogen.sh sr/srd/cli: Fix compiling with Homebrew. 2012-05-15 20:58:20 +02:00
backend.c drivers: Trim unused config_get() calls 2013-01-25 16:05:48 +01:00
configure.ac brymen-dmm: Initial driver skeleton. 2013-02-02 11:19:27 +01:00
device.c device: Cosmetics. 2013-01-29 12:56:03 +01:00
error.c Doxygen: Add @file items for the relevant files. 2012-10-22 11:56:18 +02:00
filter.c use a dynamically expanding probe list 2013-01-08 14:14:44 +01:00
hwdriver.c brymen-dmm: Cosmetics, coding-style, consistency. 2013-02-02 12:07:45 +01:00
libsigrok-internal.h Make 'struct rs9lcd_info' non-empty. 2013-02-02 12:14:26 +01:00
libsigrok.h Header cleanup. 2013-01-25 15:16:55 +01:00
libsigrok.pc.in sr: SR_PACKAGE_VERSION_* for consistency. 2012-03-31 11:35:47 +02:00
log.c Doxygen: Add @file items for the relevant files. 2012-10-22 11:56:18 +02:00
proto.h Made sr_config_list driver argument a const pointer 2013-01-28 20:26:37 +00:00
session.c session: Use message logging helpers. 2013-01-29 12:56:02 +01:00
session_driver.c Deprecate SR_DI_HWCAPS. 2013-01-25 15:01:49 +01:00
session_file.c Rename sr_dev_has_hwcap() to sr_dev_has_option(). 2013-01-25 16:20:40 +01:00
std.c Factor out common hw_init() driver code. 2013-01-29 12:56:02 +01:00
strutil.c Deprecate SR_DI_TRIGGER_TYPES. 2013-01-25 11:52:27 +01:00
version.c Doxygen: Add @file items for the relevant files. 2012-10-22 11:56:18 +02:00
version.h.in sr: moved sigrok.h so libsigrok/libsigrok.h 2012-07-05 01:17:28 +02:00

README

-------------------------------------------------------------------------------
README
-------------------------------------------------------------------------------

The sigrok project aims at creating a portable, cross-platform,
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 hardware and reading/writing the acquired data into various
input/output file formats.


Status
------

libsigrok is in a usable state and has had official tarball releases.

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
------------

 - git
 - gcc (>= 4.0)
 - make
 - autoconf >= 2.63
 - automake >= 1.11
 - libtool
 - pkg-config >= 0.22
 - libglib >= 2.28.0
 - libzip >= 0.8
 - 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.org/libsigrok
 $ cd libsigrok
 $ ./autogen.sh
 $ ./configure
 $ make

For installing libsigrok:

 $ make install

Please see the following wiki pages for more detailed instructions:

 http://sigrok.org/wiki/Linux
 http://sigrok.org/wiki/Mac_OS_X
 http://sigrok.org/wiki/Windows
 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
-------------

There are two mailing lists for sigrok/libsigrok:

 https://lists.sourceforge.net/lists/listinfo/sigrok-devel
 https://lists.sourceforge.net/lists/listinfo/sigrok-commits


IRC
---

You can find the sigrok developers in the #sigrok IRC channel on Freenode.


Website
-------

 http://sigrok.org/wiki/Libsigrok