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

Alarm Channel

Channel Category: alarm

Provides arm/disarm control, siren activation, and alarm status for security systems.


Required Properties

PropertyData TypeRange/ValuesUnitPermissions
stateEnumdisarmed, armed_home, armed_away, armed_night-RW (Read-Write)

Property Details

state

Current arming state of the alarm system

Optional Properties

PropertyData TypeRange/ValuesUnitPermissions
alarm_stateEnumidle, pending, triggered, silenced-RO (Read-Only)
triggeredBool--RO (Read-Only)
sirenBool--RW (Read-Write)
activeBool--RO (Read-Only)
faultUchar0–255-RO (Read-Only)
fault_descriptionString--RO (Read-Only)
tamperedBool--RO (Read-Only)
last_eventString--RO (Read-Only)

Property Details

alarm_state

Current alarm lifecycle state. Prefer this over triggered when available, as it can represent pending and silenced states.

triggered

Indicates whether the alarm is currently triggered

siren

Controls the audible siren output

active

Reports whether the alarm subsystem is operational

fault

Fault code or diagnostic indicator

fault_description

Human-readable fault description, if provided by the integration.

tampered

Indicates if the device has been tampered with

last_event

The last known security-relevant event for this alarm device. Can be provided by the integration or derived by the backend from state changes.

Last updated on