Overview
The aim of this project is to provide a generic API for ADC devices (drivers). The advantage of sharing the same API among different applications is that we can concentrate to provide a single stable and robust entry point for a variety of boards and driver types, and on the application side it allows to write generic tools that may work with any ADC.
The library has the knowledge about how to handle different devices and it hides this complexity to the application by providing a single access point. Thanks to the internal routing system, all the operation from the application are properly propagated to the correct set of functions for a specific device.
Supported Hardware
Here the list of supported ADC devices:
Documentation
The library uses Sphinx to
generate documentation from
reStructuredText files under
doc/
.
To build the documentation, it is highly recommended to setup a Python
virtual environment where the
necessary packages (docuilts, sphinx, etc.) can be installed via
pip and kept at a specific version. The
following steps illustrate how to do this on a Debian/Ubuntu Linux box,
with the virtual environment placed inside the doc/
folder of the
project:
$> sudo apt install virtualenv
$> cd doc
$> virtualenv build_env
$> . build_env/bin/activate
$> pip install -r requirements.txt
$> deactivate
Once the environment is installed, you can (re)build the documentation by doing:
$> cd doc
$> . build_env/bin/activate
$> make html
$> deactivate
The generated documentation can be accessed by opening
doc/_build/html/index.html
in your browser.
Alternatively, if you have LaTeX
installed, you can produce a PDF by doing a make latexpdf
instead. The
generated documentation can be accessed by opening
doc/_build/latex/adclib.pdf
.