Alarm Channel
Channel Category: alarm
Provides arm/disarm control, siren activation, and alarm status for security systems.
Required Properties
| Property | Data Type | Range/Values | Unit | Permissions |
|---|---|---|---|---|
state | Enum | disarmed, armed_home, armed_away, armed_night | - | RW (Read-Write) |
Property Details
state
Current arming state of the alarm system
Optional Properties
| Property | Data Type | Range/Values | Unit | Permissions |
|---|---|---|---|---|
alarm_state | Enum | idle, pending, triggered, silenced | - | RO (Read-Only) |
triggered | Bool | - | - | RO (Read-Only) |
siren | Bool | - | - | RW (Read-Write) |
active | Bool | - | - | RO (Read-Only) |
fault | Uchar | 0–255 | - | RO (Read-Only) |
fault_description | String | - | - | RO (Read-Only) |
tampered | Bool | - | - | RO (Read-Only) |
last_event | String | - | - | 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