Skip to Content
🚀 We just launched! Please star us on Github!

Gas Sensor Channel

Channel Category: gas

Detects the presence of gas in the environment. The exact type of gas depends on the device (e.g., combustible gas, carbon monoxide, LPG, natural gas, etc.).


Required Properties

PropertyData TypeRangeUnitPermissions
detectedBooltrue/false-RO (Read-Only)
statusStringnormal/warning/alarm"-RO (Read-Only)

Property Details

detected

Indicates whether the sensor detects a gas event:

  • true: Gas is detected (potential hazard).
  • false: No gas detected (normal condition).

status

Represents the severity level of the detected gas concentration:

  • Possible values:
    • normal – No risk detected
    • warning – Elevated gas levels
    • alarm – Dangerous concentration detected

Optional Properties

PropertyData TypeRangeUnitPermissions
densityUint0–65535ppmRO (Read-Only)
activeBooltrue/false-RO (Read-Only)
faultUchar0–255-RO (Read-Only)
tamperedBooltrue/false-RO (Read-Only)

Property Details

density

Gas concentration in parts per million:

  • 0 = no measurable concentration
  • 65535 = maximum measurable concentration

This property is optional because not all gas sensors expose an analog concentration measurement.

active

Indicates the channel’s current working status:

  • true: The sensor is active and functioning correctly.
  • false: The sensor is inactive or non-functional.

fault

Represents the fault state of the sensor:

  • 0: No fault detected.
  • Non-zero: A fault has been detected, potentially affecting functionality.

tampered

Indicates whether the channel has been tampered with:

  • true: The channel has been tampered with.
  • false: The channel is in a normal, non-tampered state.
Last updated on