Noise

Noise

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

Noise detection uses the device’s noise level sensor (measured in dB).
Alarms are triggered when the noise level exceeds the threshold for the configured duration.

Set Settings

Topic

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

Payload

{
  "threshold": 100,
  "duration": 10
}
  • threshold: threshold in dB, values can range from 0 to 194. Set it to 0 to turn off the detection.
  • duration: duration in seconds, values can range from 1 to 3600

Get Settings

Topics

Subscribe to: api_client/<client_name>/<location_id>/<device_id>/noise/settings Publish to: api_client/<client_name>/<location_id>/<device_id>/noise/settings/get

Payload

Publish with an empty payload.

Response

Not Retained
QoS: 1

Returns the current noise detection settings in the same format as the Set Settings payload.

Noise

Topic

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

Payload

Not Retained
QoS: 2

{
  "id": "f3e2c1d4-5b6a-7c8d-9e0f-1a2b3c4d5e6f",
  "detectedAt": "2026-01-15T11:30:56.336650702Z"
}
  • id: Unique identifier (UUID) of the detection event. This can be used to obtain an event recording.
  • detectedAt: Time of detection. Note that the message may be sent several seconds after the detection.