SQ50 patches for libsigrok
Go to file
Uwe Hermann 721ecf3d97 alsa: Cosmetics, coding style, typos. 2013-01-01 00:37:17 +01:00
contrib added VID:PIDs for all Hantek DSO-2xxx/5xxx 2012-12-28 16:46:21 +01:00
hardware alsa: Cosmetics, coding style, typos. 2013-01-01 00:37:17 +01:00
input Add compress option to input/vcd. 2012-11-22 23:15:37 +01:00
output Pass sr_datafeed_packets and payloads with const pointers 2012-12-20 07:51:21 +00: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 Makefile.am: Add missing backslash. 2012-10-22 11:54:40 +02:00
NEWS sr: fx2lafw: Add basic support for USBee DX and clones 2012-08-01 00:12:00 +04:00
README We now require libusb >= 1.0.9. 2012-10-21 22:44:00 +02:00
autogen.sh sr/srd/cli: Fix compiling with Homebrew. 2012-05-15 20:58:20 +02:00
backend.c backend.c: Return a sigrok error in sr_init() on libusb_init() errors 2012-12-05 01:34:15 +01:00
configure.ac configure.ac: Fix CFLAGS settings. 2012-12-28 12:10:01 +01:00
datastore.c Various subsystems: Use message logging helpers. 2012-11-11 18:14:17 +01:00
device.c device.c: Fix memory leak in sr_serial_dev_inst_free 2012-12-23 17:18:14 +01:00
error.c Doxygen: Add @file items for the relevant files. 2012-10-22 11:56:18 +02:00
filter.c Various subsystems: Use message logging helpers. 2012-11-11 18:14:17 +01:00
hwdriver.c nexus-osciprime: Initial driver skeleton. 2012-12-24 20:55:23 +01:00
libsigrok-internal.h add USBTMC device search helper 2012-12-30 01:44:58 +01:00
libsigrok.h Pass sr_datafeed_packets and payloads with const pointers 2012-12-20 07:51:21 +00: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 Pass sr_datafeed_packets and payloads with const pointers 2012-12-20 07:51:21 +00:00
session.c session: Fix compiler warning. 2012-12-31 21:05:11 +01:00
session_driver.c Add a struct sr_context * parameter to hw_init() 2012-12-03 12:07:40 +01:00
session_file.c Add a struct sr_context * parameter to sr_driver_init() 2012-12-03 12:07:40 +01:00
strutil.c Add support for fs and ps to sr_parse_period. 2012-11-20 21:02:14 +02: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
 - libusb >= 1.0.9 (for most hardware)
 - libzip >= 0.8
 - libftdi >= 0.16 (for some hardware)
 - libudev >= 151 (for some hardware)


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