⚠️ Device Room State

The state of a room is derived from event and sensor data. It is sent on change only.

Topics

Subscribe to: api_client/<client_name>/<location_id>/<device_id>/room/state

Response

Not retained
QoS: 1

{
  "timestamp": "2024-06-01T12:00:00Z",
  "privacyMode": false,
  "humanPresent": true,
  "sitting": false,
  "zones": [
    {
      "id": "5403bc21-834f-443e-bdfb-2993ab4044a7",
      "kind": "bed",
      "description": "Bed next to window.",
      "occupied": false
    }
  ]
}

• timestamp: Timestamp of when the state was generated
• privacyMode: Whether the privacy mode is active on the device
• humanPresent: Whether a human is present in the room, see Detection Logic for more info
• sitting: Whether a human in the room is sitting
• zones: A list of zones in the room, which are defined areas such as beds, doors, and seats
  • id: Unique identifier of the zone (UUID)
  • kind: Kind of the zone; expected values are bed, doorExit, doorBathroom, seat
  • description: Description of the zone, e.g., “Bed next to window.”
  • occupied: Whether the zone is currently occupied by a human, see Detection Logic for more info