1.3 KiB
1.3 KiB
| author | authorURL | authorImageURL | authorTwitter | title |
|---|---|---|---|---|
| G Johansson | https://github.com/gjohansson-ST | https://avatars.githubusercontent.com/u/62932417?v=4 | GJohansson | New alarm control panel state property and state enum |
As of Home Assistant Core 2024.11, we have introduced the alarm_state property in the AlarmControlPanelEntity. This newly added property should be used instead of directly setting the state property.
The new alarm_state property should return its state using the new AlarmControlPanelState enum instead of as previously, setting the state using the STATE_ALARM_* constants.
There is a one-year deprecation period, and the constants will stop working from 2025.11 to ensure all custom integration authors have time to adjust.
Example
from homeassistant.components.alarm_control_panel import AlarmControlPanelEntity, AlarmControlPanelState
class MyAlarm(AlarmControlPanelEntity):
"""My alarm."""
@property
def alarm_state(self) -> AlarmControlPanelState | None:
"""Return the state of the alarm."""
if self.device.is_on():
return AlarmControlPanelState.ARMED_AWAY
return AlarmControlPanelState.DISARMED
More details can be found in the alarm control panel documentation.