-
Notifications
You must be signed in to change notification settings - Fork 318
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
python: added README.md file for Python bindings.
Added a README.md file which contains information to be displayed on the main Pypi libiio page. Signed-off-by: Cristi Iacob <[email protected]>
- Loading branch information
1 parent
cc55f51
commit ad526d9
Showing
1 changed file
with
48 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # libiio: Python Bindings | ||
|
|
||
| This package contains the python bindings for libiio, a 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. | ||
|
|
||
| [](https://travis-ci.org/analogdevicesinc/libiio) | ||
| [](https://badge.fury.io/py/libiio) [](https://www.codacy.com/app/rgetz/libiio?utm_source=github.com&utm_medium=referral&utm_content=analogdevicesinc/libiio&utm_campaign=Badge_Grade) | ||
|  | ||
|
|
||
| [[Docs](https://analogdevicesinc.github.io/libiio/v0.19/python/index.html)] | ||
| [[Support](http://ez.analog.com)] | ||
| [[Wiki](https://wiki.analog.com/resources/tools-software/linux-software/libiio)] | ||
|
|
||
| ## Requirements | ||
| To use these bindings naturally you need the core library they depend upon, libiio. This is not packaged with the pypi release but there are a number of options: | ||
| - 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 and check out the [documentation](https://codedocs.xyz/analogdevicesinc/libiio/) based on the master branch. We provide builds for a few operating systems. If you need something else, we can most likely add that -- just ask. | ||
|
|
||
| ### Installing the bindings | ||
| To install these bindings there are a few methods. If you already have the library itself and just need the bindings, pip is the most convenient method: | ||
| ```shell | ||
| (sudo) pip install libiio | ||
| ``` | ||
| If you do not want to use pip, then installation is dependent on your operating system. | ||
| #### Linux / macOS | ||
| For Linux and macOS the python bindings need to be installed through source if not using pip. For v0.20 and beyond this requires the `-DPYTHON_BINDINGS=ON` flag during the cmake configuration. Further documentation is located [here](https://github.com/analogdevicesinc/libiio/blob/master/README_BUILD.md). | ||
|
|
||
| #### Windows | ||
| Only pip installation is supported. | ||
|
|
||
| ### Support | ||
| If you have a question about libiio or the python bindings and an Analog Devices IIO kernel driver please ask on : [](https://ez.analog.com/linux-device-drivers/linux-software-drivers). If you have a question about a non-ADI devices, please ask it on [github](https://github.com/analogdevicesinc/libiio/issues). | ||
|
|
||
| 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 | ||
|
|
||
| ## Useful resources | ||
| * [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) | ||
|
|