jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-08 09:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add new alarm state property and enum (#2361)

Browse Source 
* Add new alarm state property and enum

* Mod date

* Change name of enum

* Fix

* Fixes

* Mod
This commit is contained in:
G Johansson 2024-10-22 21:43:51 +02:00 committed by GitHub
parent 7a110960bd
commit ab02bc1e01
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 46 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
blog/2024-10-22-new-alarm-state-property.md Normal file
View File

@ -0,0 +1,33 @@
---
author: G Johansson
authorURL: https://github.com/gjohansson-ST
authorImageURL: https://avatars.githubusercontent.com/u/62932417?v=4
authorTwitter: GJohansson
title: "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
```python
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](/docs/core/entity/alarm-control-panel#states).

25
docs/core/entity/alarm-control-panel.md
View File

@ -13,26 +13,27 @@ Properties should always only return information from memory and not do I/O (lik
| Name | Type | Default | Description | Name | Type | Default | Description
| ---- | ---- | ------- | ----------- | ---- | ---- | ------- | -----------
| state | <code>str &#124; None</code> | **Required** | One of the states listed in the **states**. | alarm_state | <code>AlarmControlPanelState &#124; None</code> | **Required** | One of the alarm values listed in the **states**.
| code_arm_required | bool | `True` | Whether the code is required for arm actions. | code_arm_required | bool | `True` | Whether the code is required for arm actions.
| code_format | <code>CodeFormat &#124; None</code> | `None` | One of the states listed in the **code formats** section. | code_format | <code>CodeFormat &#124; None</code> | `None` | One of the states listed in the **code formats** section.
| changed_by | <code>str &#124; None</code> | `None` | Last change triggered by. | changed_by | <code>str &#124; None</code> | `None` | Last change triggered by.
### States ### States
Setting the state should return an enum from `AlarmControlPanelState` in the `alarm_state` property.
| Value | Description | Value | Description
| ----- | ----------- | ----- | -----------
| `None` | Unknown state. | `DISARMED` | The alarm is disarmed (`off`).
| `disarmed` | The alarm is disarmed (`off`). | `ARMED_HOME` | The alarm is armed in home mode.
| `armed_home` | The alarm is armed in home mode. | `ARMED_AWAY` | The alarm is armed in away mode.
| `armed_away` | The alarm is armed in away mode. | `ARMED_NIGHT` | The alarm is armed in night mode.
| `armed_night` | The alarm is armed in night mode. | `ARMED_VACATION` | The alarm is armed in vacation mode.
| `armed_vacation` | The alarm is armed in vacation mode. | `ARMED_CUSTOM_BYPASS` | The alarm is armed in bypass mode.
| `armed_custom_bypass` | The alarm is armed in bypass mode. | `PENDING` | The alarm is pending (towards `triggered`).
| `pending` | The alarm is pending (towards `triggered`). | `ARMING` | The alarm is arming.
| `arming` | The alarm is arming. | `DISARMING` | The alarm is disarming.
| `disarming` | The alarm is disarming. | `TRIGGERED` | The alarm is triggered.
| `triggered` | The alarm is triggered.
## Supported features ## Supported features