diff options
Diffstat (limited to 'src/README.md')
| -rw-r--r-- | src/README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..f3dd05a --- /dev/null +++ b/src/README.md @@ -0,0 +1,47 @@ +# libiio + +Library for interfacing with Linux IIO devices + +libiio is used to interface to the Linux Industrial Input/Output (IIO) Subsystem. The Linux IIO subsystem is intended to provide support for devices that in some sense are analog to digital or digital to analog converters (ADCs, DACs). This includes, but is not limited to ADCs, Accelerometers, Gyros, IMUs, Capacitance to Digital Converters (CDCs), Pressure Sensors, Color, Light and Proximity Sensors, Temperature Sensors, Magnetometers, DACs, DDS (Direct Digital Synthesis), PLLs (Phase Locked Loops), Variable/Programmable Gain Amplifiers (VGA, PGA), and RF transceivers. You can use libiio natively on an embedded Linux target (local mode), or use libiio to communicate remotely to that same target from a host Linux, Windows or MAC over USB or Ethernet or Serial. + +Although libiio was primarily developed by Analog Devices Inc., it is an active open source library, which many people have contributed to. It released under the GNU Lesser General Public License, version 2.1 or later, this open-source license allows anyone to use the library, on any vendors processor/FPGA/SoC, which may be controlling any vendors peripheral device (ADC, DAC, etc) either locally or remotely. This includes closed or open-source, commercial or non-commercial applications (subject to the LGPL license freedoms, obligations and restrictions). + +License : [](https://github.com/analogdevicesinc/libiio/blob/master/COPYING.txt) +Latest Release : [](https://github.com/analogdevicesinc/libiio/releases/latest) +Downloads : [](https://github.com/analogdevicesinc/libiio/releases/latest) + +Scans : [](https://scan.coverity.com/projects/analogdevicesinc-libiio) + +As with many open source packages, we use [GitHub](https://github.com/analogdevicesinc/libiio) to do develop and maintain the source, and [Travis CI](https://travis-ci.com/) and [Appveyor](https://www.appveyor.com/) for continuous integration. + - If you want to just use libiio, we suggest using the [latest release](https://github.com/analogdevicesinc/libiio/releases/latest). + - If you think you have found a bug in the release, or need a feature which isn't in the release, try the latest **untested** binaries from the master branch. We provide builds for a few operating systems. If you need something else, we can most likely add that -- just ask. + +| Operating System | GitHub master status | Version | Installer Package | tarball or zip | +|:-----------------------:|:---------------------:|:-------:|:-------------------:|:--------------:| +| Windows | [](https://ci.appveyor.com/project/analogdevicesinc/libiio/branch/master) | Windows 10<br />Windows 8.1<br />Windows 8<br />Windows 7 | [](https://ci.appveyor.com/api/projects/analogdevicesinc/libiio/artifacts/libiio-setup.exe?branch=master) | [](https://ci.appveyor.com/api/projects/analogdevicesinc/libiio/artifacts/libiio.zip?branch=master) | +| OS X | [](https://travis-ci.org/analogdevicesinc/libiio) | macOS Sierra<br />(v 10.12) | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-osx_10.12.pkg) | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-osx_10.12.tar.gz) | +| | | OS X El Capitan<br />(v 10.11) | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-osx_10.11.pkg) | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-osx_10.11.tar.gz) | +| | | OS X Yosemite<br />(v 10.10) | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-osx_10.10.pkg) | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-osx_10.10.tar.gz) | +| Linux | [](https://travis-ci.org/analogdevicesinc/libiio) | Ubuntu Trusty Tahr<br />(v 14.04)<sup>1</sup> | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-trusty.deb) [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-trusty.rpm)<sup>3</sup> | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-trusty.tar.gz) | +| | | Ubuntu Precise Pangolin<br />(v 12.04)<sup>2</sup> | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-precise.deb) [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-precise.rpm)<sup>3</sup> | [](http://swdownloads.analog.com/cse/travis_builds/master_latest_libiio-precise.tar.gz) | + +If you use it, and like it - please let us know. If you use it, and hate it - please let us know that too. The goal of the project is to try to make Linux IIO devices easier to use on a variety of platforms. If we aren't doing that - we will try to make it better. + +Feedback is appreciated (in order of preference): + + * [Github trackers](https://github.com/analogdevicesinc/libiio/issues) for bugs, improvements, or feature requests + * [Analog Devices web forums](https://ez.analog.com/community/linux-device-drivers/linux-software-drivers) for general help on libiio and/or ADI Linux IIO drivers + * [The IIO mailing list](http://vger.kernel.org/vger-lists.html#linux-iio) for questions about other Linux IIO drivers, or kernel-specific IIO questions + +Weblinks: + * About IIO: https://wiki.analog.com/software/linux/docs/iio/iio + * API Documentation: http://analogdevicesinc.github.io/libiio/ + * Libiio : http://wiki.analog.com/resources/tools-software/linux-software/libiio + * Libiio internals : http://wiki.analog.com/resources/tools-software/linux-software/libiio_internals + +1. This is known to work on Debian Jessie(v 8) as well.<br /> +Package dependencies: libc6 (>= 2.19), libaio1 (>= 0.3.109), libavahi-client3 (>= 0.6.31), libavahi-common-data (>= 0.6.31), libavahi-common3 (>= 0.6.31), libusb-1.0-0 (>= 2:1.0.17), libxml2 (>= 2.9.1)<br /> +2. This is known to work on Debian Wheezy(v 7) as well.<br /> +Package dependencies: libc6 (>= 2.15), libaio1 (>= 0.3.109), libavahi-client3 (>= 0.6.30), libavahi-common-data (>= 0.6.30), libavahi-common3 (>= 0.6.30), libusb-1.0-0 (>= 2:1.0.9~rc3), libxml2 (>= 2.8.0~precise1)<br /> +3. The rpm packages are listed under Ubuntu, since we take advantage of the Debian/Ubuntu ability to build rpm packages. These are not actually built on Red Hat/Fedora based systems, but are known to work. + |