Skip to content

API Reference

Auto-generated from source code docstrings using mkdocstrings.


Public API

What you need to configure and understand gas2mqtt:

  • SettingsGas2MqttSettings and its fields (env vars, defaults, validation)
  • PortsMagnetometerPort protocol and MagneticReading dataclass
  • Domain — Schmitt trigger and consumption tracker

Internals

Implementation details for contributors and deep-dive readers:

  • Devices — cosalette device handlers (gas counter, temperature, magnetometer)
  • Adapters — Hardware adapter implementations (QMC5883L, fake)
  • Application — App factory, lifespan, and wiring