Ozone Hardware

Contents:

  • Architecture Overview
    • Entry Point
    • Configuration
    • Sensing Loop
    • Communication Threads
  • Core Modules
    • Sensor (Orchestrator)
    • Manager (Gateway Client)
      • Manager
        • Manager.server
        • Manager.config_api
        • Manager.data_api
        • Manager.realtime_data_api
        • Manager.automation_alert_api
        • Manager.init_api
        • Manager.ppb_analytics
        • Manager.access_token
        • Manager.__init__()
        • Manager.getConfig()
        • Manager.getPPBanalytics()
        • Manager.updateConfig()
        • Manager.sendData()
        • Manager.sendRealtimeData()
        • Manager.sendAutomationAlertsEmailSms()
        • Manager.sendInit()
    • Network (Connectivity Monitor)
      • Network
        • Network.success_delay
        • Network.HOSTPOT_TIMER
        • Network.server
        • Network.status_api
        • Network.__init__()
        • Network.add_server()
        • Network.is_internet()
        • Network.run()
        • Network.putStatus()
        • Network.identifyConnection()
        • Network.getStatus()
    • Configuration
      • Config
        • Config.__init__()
        • Config.config
    • SensorBase (Abstract Base)
      • GenericSensor
        • GenericSensor.partNumber
        • GenericSensor.parameter
        • GenericSensor.__init__()
        • GenericSensor.baseConfig
        • GenericSensor.initialize()
        • GenericSensor.initializeSensor()
        • GenericSensor.getSensorReading()
        • GenericSensor.putSensorValue()
        • GenericSensor.putInitvalues()
    • Indices (Environmental Calculations)
      • Indices
        • Indices.__init__()
        • Indices.updateIndices()
        • Indices.calculate_wbgt_indoor()
        • Indices.calculate_wbgt_outdoor()
        • Indices.calculate_tnwb()
        • Indices.calculate_air_density()
        • Indices.calculate_internal_dew_point()
        • Indices.calculate_external_dew_point()
        • Indices.calculate_vapour_pressure()
        • Indices.calculate_evapotranspiration()
        • Indices.calculate_cloud_base_height()
    • Quality Control
    • Utilities
      • Logger
        • OizomLogger
        • apply_logger_config()
      • Reboot Manager
        • RebootManager
  • Sensor Wrappers (OzWrapper)
    • Environmental
      • OzTemp – Temperature & Humidity
        • OzTemp
      • OzDust – Particulate Matter
      • OzCO2 – Carbon Dioxide
        • OzCO2
      • OzCH4 – Methane
        • OzCH4
      • OzCO – Carbon Monoxide
        • OzCO
    • Meteorological
      • OzWind – Wind Speed & Direction
        • OzWind
      • OzRain – Rainfall
        • OzRain
      • OzFlood – Flood Level
        • OzFlood
      • OzSoil – Soil Moisture
        • OzSoil
      • OzSurface – Surface Temperature
        • OzSurface
    • Light & Noise
      • OzUVLight – UV Light
        • OzUVLight
      • OzVisible – Visible Light
        • OzVisible
      • OzNoise – Noise Level
        • OzNoise
      • OzLightning – Lightning Detection
        • OzLightning
    • System & Infrastructure
      • OzSystem – System Monitoring
        • OzSystem
      • OzBattery – Battery Management
        • OzBattery
      • OzError – Error Tracking
        • OzError
      • OzGPS – GPS Location
        • OzGPSParam
        • OzGPS
      • OzRGB – LED Indicator
        • hex_to_rgb()
        • get_color_from_value()
        • Magic
        • main()
    • Communication
      • OzSocket – WebSocket
        • OzSocket
      • OzModbus – Modbus
        • OzModbus
      • OzLora – LoRa Radio
        • OzLora
      • OzDisplay – E-Paper Display
        • OzDisplay
      • OzHMI – 7-Segment Display
        • OzHMI
    • Calibration & Special
      • OzOGS – Odor Gas Sensor
        • context_logger
        • OzOGSParam
        • OzOGS
      • OzOSP – Outdoor Sensor Package
        • OzOSP
      • OzAlert – Automation Alerts
        • OzAlert
  • Hardware Drivers
    • I2C Environmental Sensors
      • BME280 – Temperature, Humidity, Pressure
        • BME280
      • ATH20 – Temperature & Humidity
        • ATH20
      • SHT31 – Temperature & Humidity
        • SHT31
      • SHT41 – Temperature & Humidity
        • SHT41_driver
        • SHT41
      • LPS25HB – Barometric Pressure
        • LPS25HB
      • SCD40 – CO2 Sensor
        • SCD40
      • ELTCO2 – CO2 Sensor
        • ELTCO2
    • I2C Light & UV Sensors
      • LTR390 – UV & Ambient Light
        • LTR390
      • Si1133 – UV Index Sensor
        • SI1133_Coeff_TypeDef
        • SI1133_LuxCoeff_TypeDef
        • SI1133_Samples_TypeDef
        • Si1133
    • Particulate Matter Sensors
      • CubicPM3006
      • CubicPM6303
        • CubicPM6303
    • UART / Serial Sensors
      • Noise – Noise Level Sensor
        • Noise
      • Wind – Wind Speed & Direction
        • Wind
      • Rain – Rainfall Sensor
        • Rain
    • Modbus / Industrial Sensors
      • BAM – Beta Attenuation Monitor
        • BAM
      • PyModbus – Generic Modbus Driver
        • PyModbus
    • Infrastructure Drivers
      • MAX17261 – Battery Fuel Gauge
        • MAX17261
      • MCP230XX – GPIO Expander
        • MCP230XX
      • GPIO Utilities
        • setup()
        • set()
        • read()
        • input()
        • output()
        • mode()
        • cleanup()
        • setwarnings()
        • setmode()
        • select_I2C()
      • DeviceDetector – I2C Device Scanner
        • DeviceDetector
Ozone Hardware
  • Overview: module code

All modules for which code is available

  • Configuration.config
  • Indices.Indices
  • Manager.Manager
  • Network.Network
  • OzWrapper.OzAlert.OzAlert
  • OzWrapper.OzBattery.OzBattery
  • OzWrapper.OzCH4.OzCH4
  • OzWrapper.OzCO.OzCO
  • OzWrapper.OzCO2.OzCO2
  • OzWrapper.OzDisplay.OzDisplay
  • OzWrapper.OzError.OzError
  • OzWrapper.OzFlood.OzFlood
  • OzWrapper.OzGPS.OzGPS
  • OzWrapper.OzHMI.OzHMI
  • OzWrapper.OzLightning.OzLightning
  • OzWrapper.OzLora.OzLora
  • OzWrapper.OzModbus.OzModbus
  • OzWrapper.OzNoise.OzNoise
  • OzWrapper.OzOGS.OzOGS
  • OzWrapper.OzOSP.OzOSP
  • OzWrapper.OzRGB.OzRGB
  • OzWrapper.OzRain.OzRain
  • OzWrapper.OzSocket.OzSocket
  • OzWrapper.OzSoil.OzSoil
  • OzWrapper.OzSurface.OzSurface
  • OzWrapper.OzSystem.OzSystem
  • OzWrapper.OzTemp.OzTemp
  • OzWrapper.OzUVLight.OzUVLight
  • OzWrapper.OzVisible.OzVisible
  • OzWrapper.OzWind.OzWind
  • SensorBase.SensorBase
  • drivers.ATH20.ATH20
  • drivers.BAM.BAM
  • drivers.BME280.BME280
  • drivers.CubicPM6303.CubicPM6303
  • drivers.DeviceDetector.DeviceDetector
  • drivers.ELTCO2.ELTCO2
  • drivers.LPS25HB.LPS25HB
  • drivers.LTR390.LTR390
  • drivers.MAX17261.MAX17261
  • drivers.MCP230XX.MCP230XX
  • drivers.Noise.Noise
  • drivers.PyModbus.PyModbus
  • drivers.Rain.Rain
  • drivers.SCD40.SCD40
  • drivers.SHT31.SHT31
  • drivers.SHT41.SHT41
  • drivers.Si1133.Si1133
  • drivers.Wind.Wind
  • drivers.gpio.gpio
  • utils.oizom_logger
  • utils.reboot_RPi

© Copyright 2024, Oizom Instruments Pvt. Ltd..

Built with Sphinx using a theme provided by Read the Docs.