Findy Lab
=========

Developer documentation for the Findy device firmware family: the
building blocks shared by the findyIoT module and Logger Pro - the EG915
modem driver, the findyIoT (HiGPS) protocol, the parameter database, the
over-the-air update and, on Logger Pro, the sensor front-end and the
relay outputs.

The firmware on a device is split in two:

* ``firmware_core.mpy`` - the framework (the modules documented under
  *API Reference*). You normally never edit it.
* ``last.py`` - the customizable part: the parameter registry
  (``databaseParams``), the report parameter list (``datalist``) and the
  ``start()`` / ``measure()`` hooks. This is where your application
  logic lives.

.. toctree::
   :maxdepth: 2
   :caption: Guides

   guides/getting-started
   guides/ota-update

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/core
   api/modem
   api/findyiot
   api/database
   api/ota
   api/sensor
   api/relay

.. toctree::
   :maxdepth: 1
   :caption: Hardware

   hardware/findyiot
   hardware/logger-pro

.. toctree::
   :maxdepth: 1
   :caption: Data types

   datatypes/system-ids

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`