Home
====

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

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

   self
   ./how_to_use.rst
   ./api_description.rst


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

libDM_mmc5983ma is a library for the MMC5983MA magnetometer sensor. It allows the reading of the magnetic field on the 3 axis of the sensor and the configuration of the measures.

.. note::

    This library is part of a project made for esp32s3. It includes some dependencies and can not be used easily without the other parts of the project. A standalone version without dependencies is available as 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>`_, and will be easier to use on all microcontrollers.