Home
====

.. image:: images/inheritance.jpeg
   :width: 400
   :height: 400

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   self
   ./api_description.rst


Description
============

libDM_abstract_sensors is a library that provides an abstraction layer for the sensors and protocol used in the project. It defines generic method and template that are reused for the projects sensors.

.. note::

    This library is part of the projects `SENSORS_ONLY <https://doc.sysrox.com/lib/appdm_ins_sensors_only/index.html>`_ and `INS_MINIMAL <https://doc.sysrox.com/lib/appdm_ins_minimal/index.html>`_. It includes no dependency and is easier to port.

Usage
=====

This library can be modified if you need:

- To implement sensors readings with a different hardware protocol
- To implement sensors readings with a different framework as it contains the the methods relative to hardware and framework abstraction
- To implement generic methods applicable to multiple sensors, hardware bus... Such as calibration, filtering, general data processing...