README.md
1# libad9361-iio
2
3This is a simple library used for userspace,
4 - which manages multi-chip sync (on platforms (FMCOMMS5) where multiple AD9361 devices are use)
5 - can create AD9361 specific FIR filters on the fly,
6
7**Docs**
8
9Doxygen-based documentation is available at: http://analogdevicesinc.github.io/libad9361-iio/
10
11
12License : [![License](https://img.shields.io/badge/license-LGPL2-blue.svg)](https://github.com/analogdevicesinc/libad9361-iio/blob/master/COPYING.txt)
13Latest Release : [![GitHub release](https://img.shields.io/github/release/analogdevicesinc/libad9361-iio.svg)](https://github.com/analogdevicesinc/libad9361-iio/releases/latest)
14Downloads : [![Github All Releases](https://img.shields.io/github/downloads/analogdevicesinc/libad9361-iio/total.svg)](https://github.com/analogdevicesinc/libad9361-iio/releases/latest)
15
16As with many open source packages, we use [GitHub](https://github.com/analogdevicesinc/libad9361-iio) to do develop and maintain the source, and [Travis CI](https://travis-ci.com/) and [Appveyor](https://www.appveyor.com/) for continuous integration.
17 - If you want to just use libad9361-iio, we suggest using the [latest release](https://github.com/analogdevicesinc/libad9361-iio/releases/latest).
18 - 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.
19
20| Operating System | GitHub master status | Version | Installer Package | tarball or zip |
21|:-----------------------:|:---------------------:|:-------:|:-------------------:|:--------------:|
22| Windows | [![Windows Status](https://ci.appveyor.com/api/projects/status/github/analogdevicesinc/libad9361-iio?svg=true)](https://ci.appveyor.com/project/analogdevicesinc/libad9361-iio/branch/master) | Windows 10<br />Windows 8.1<br />Windows 8<br />Windows 7 | [![Latest Windows installer](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/win_box.png)](https://ci.appveyor.com/api/projects/analogdevicesinc/libad9361-iio/artifacts/libad9361-setup.exe?branch=master) | Win32 : [![Latest 32-bit Windows zip](https://raw.githubusercontent.com/wiki/analogdevicesinc/libad9361-iio/img/win_box.png)](https://ci.appveyor.com/api/projects/analogdevicesinc/libad9361-iio/artifacts/libad9361-win32.zip?branch=master)<br />Win64: [![Latest 64-bit Windows zip](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/win_box.png)](https://ci.appveyor.com/api/projects/analogdevicesinc/libad9361-iio/artifacts/libad9361-win64.zip?branch=master) |
23| OS X | [![OSX Status](https://api.travis-ci.org/analogdevicesinc/libad9361-iio.svg?branch=master&label=osx&passingTex=foo)](https://travis-ci.org/analogdevicesinc/libad9361-iio) | macOS Sierra<br />(v 10.12) | [![OS-X package 10.12](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/osx_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-osx_10.12.pkg) | [![OS-X tarball 10.12](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/osx_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-osx_10.12.tar.gz) |
24| | | OS X El Capitan<br />(v 10.11) | [![OS-X package 10.11](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/osx_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-osx_10.11.pkg) | [![OS-X tarball 10.11](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/osx_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-osx_10.11.tar.gz) |
25| | | OS X Yosemite<br />(v 10.10) | [![OS-X package 10.10](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/osx_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-osx_10.10.pkg) | [![OS-X tarball 10.10](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/osx_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-osx_10.10.tar.gz) |
26| Linux | [![Linux Status](https://api.travis-ci.org/analogdevicesinc/libad9361-iio.svg?branch=master&label=linux)](https://travis-ci.org/analogdevicesinc/libiio) | Ubuntu Xenial Xerus<br />(v 16.04) | [![Debian](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/deb.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-xenial.deb) [![RPM File](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/rpm.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-xenial.rpm) | [![tar.gz file](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/linux_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-xenial.tar.gz) |
27| | | Ubuntu Trusty Tahr<br />(v 14.04)<sup>1</sup> | [![Debian](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/deb.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-trusty.deb) [![RPM File](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/rpm.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-trusty.rpm)<sup>3</sup> | [![tar.gz file](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/linux_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-trusty.tar.gz) |
28| | | Ubuntu Precise Pangolin<br />(v 12.04)<sup>2</sup> | [![Debian](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/deb.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-precise.deb) [![RPM File](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/rpm.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-precise.rpm)<sup>3</sup> | [![tar.gz](https://raw.githubusercontent.com/wiki/analogdevicesinc/libiio/img/linux_box.png)](http://swdownloads.analog.com/cse/travis_builds/master_latest_libad9361-iio-precise.tar.gz) |
29
30If 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.
31
32
33## Building & Installing
34
35should be a quick matter of `cmake`, then `make`, then `make install`:
36
37```
38rgetz@pinky:~/libad9361-iio$ cmake ./CMakeLists.txt
39-- The C compiler identification is GNU 4.7.2
40-- Check for working C compiler: /usr/bin/gcc
41-- Check for working C compiler: /usr/bin/gcc -- works
42-- Detecting C compiler ABI info
43-- Detecting C compiler ABI info - done
44-- Configuring done
45-- Generating done
46-- Build files have been written to: /home/rgetz/libad9361-iio
47rgetz@pinky:~/libad9361-iio$ make
48Scanning dependencies of target ad9361
49[100%] Building C object CMakeFiles/ad9361.dir/ad9361_multichip_sync.c.o
50Linking C shared library libad9361.so
51Copying OS X content Headers/ad9361.h
52[100%] Built target ad9361
53rgetz@pinky:~/libad9361-iio$ sudo make install
54[sudo] password for rgetz:
55[100%] Built target ad9361
56Install the project...
57-- Install configuration: ""
58-- Installing: /usr/local/lib/pkgconfig/libad9361.pc
59-- Installing: /usr/local/lib/libad9361.so.0.1
60-- Installing: /usr/local/lib/libad9361.so.0
61-- Installing: /usr/local/lib/libad9361.so
62-- Installing: /usr/local/include/ad9361.h
63```
64