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

Alarm Device

Device Category: alarm

The Alarm device represents a security system that provides arm/disarm control, siren activation, and alarm status monitoring for home or building security.


Required Channels

These channels are mandatory for the functionality of the alarm:

ChannelDescriptionMultipleDetails
alarmProvides arm/disarm control, siren activation, alarm status, and health indicators.NoSee details
device_informationProvides metadata about the device, including manufacturer details, model information, and operational statuses.NoSee details

Optional Channels

These channels are optional and provide additional features:

ChannelDescriptionMultipleDetails
batteryReports the status of a device’s battery, including level, charging state, and operational health.NoSee details

Use Case Scenarios

  1. Security Control:

    • Arm and disarm the alarm system using the state property. Configure different modes like armed_home, armed_away, and armed_night.
  2. Alert Management:

    • Monitor alarm state and control the siren for audible alerts. Use alarm_state to distinguish idle, pending, triggered, and silenced states when available.
  3. Status Monitoring:

    • Track alarm system health, fault conditions, and tampering detection.

Developer Notes

  1. The alarm channel is required for core security functionality.
  2. Battery channel is important for wireless alarm systems.
  3. Tampered property helps detect physical interference with the device.
  4. alarm_state is recommended for richer UI and integrations; triggered remains for backward compatibility.
  5. last_event can be provided by integrations or derived by the backend from state changes.
Last updated on