MQTT
Alarm
Wandering

Wandering

🚫
NOTE: This part of the API does not exist yet.

Detects when a device recognizes a person that is usually present in a room observed by a different device.

Turning this on is useful for devices near exits or entrances. Devices deployed in rooms learn which person is usually present in the room. When a device with wandering detection enabled recognizes a person that is usually present in a different room, it fires a wandering event.

Set Settings

Topic

Publish to: api_client/<client_name>/<location_id>/<device_id>/wandering/settings/set

Payload 

{
  "active": true
}
  • active: whether wandering detection is active or not

Get Settings

Topics

Subscribe to api_client/<client_name>/<location_id>/<device_id>/wandering/settings Publish to `api_client/<client_name>/<location_id>/<device_id>/wandering/settings/get

Payload

Publish an empty payload.

Response

Not retained
QoS: 1

{
  "active": true
}
  • active: whether wandering detection is active or not

Wandering

Topic

Subscribe to: api_client/<client_name>/<location_id>/<device_id>/wandering

Payload

Retained
QoS: 2

{
  "id": "f3e2c1d4-5b6a-7c8d-9e0f-1a2b3c4d5e6f",
  "homeDeviceId": "abcd1234efgh5678ijkl9012mnop3456qrst7890uvwx5678yzab9012cdef3456",
  "detectedAt": "2026-01-15T11:30:56.336650702Z"
}
  • id: Unique identifier (UUID) of the detection event. This can be used to obtain event footage.
  • homeDeviceId: the device ID of the device that usually observes the recognized person
  • detectedAt: Time of detection