Ozone Hardware Documentation
============================

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

   overview
   api/core
   api/wrappers
   api/drivers


Overview
--------

Ozone Hardware is the Python-based IoT edge software for Oizom environmental
monitoring devices. It runs on Raspberry Pi (ARM), containerized with Docker,
and communicates with a Gateway container over HTTP/WebSocket.

**Architecture layers (top to bottom):**

1. **Sensor** -- Orchestrator. Initializes all sensor wrappers, runs the
   sensing loop (read → average → publish).
2. **OzWrapper** -- One wrapper per sensor category (OzTemp, OzDust, OzCO2,
   etc.). Each abstracts over multiple hardware drivers.
3. **drivers** -- Low-level hardware drivers for individual sensor ICs.
4. **Manager** -- HTTP client to the Gateway container.
5. **Network** -- Connectivity monitor.
6. **Configuration** -- Static config loader.


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

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