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

Occupancy Sensor Channel

Channel Category: occupancy

Detects the presence of people in a space for automation or energy efficiency purposes.


Required Properties

PropertyData TypeRangeUnitPermissions
detectedBooltrue/false-RO (Read-Only)

Property Details

detected

Indicates whether the sensor detects a occupancy event:

  • true: Occupancy is detected.
  • false: Occupancy is not detected.

Optional Properties

PropertyData TypeRangeUnitPermissions
distanceFloat0.0–100.0mRO (Read-Only)
activeBooltrue/false-RO (Read-Only)
faultUchar0–255-RO (Read-Only)
tamperedBooltrue/false-RO (Read-Only)

Property Details

distance

Represents the distance from the sensor to the detected object:

  • Measured in meters (m).

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