From ffe53acbaa5cb3373c4e8b89a81543d561ebb732 Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Fri, 15 Sep 2023 12:05:42 +0200 Subject: [PATCH] Align documented alarm_control_panel attributes with implementation (#1910) --- docs/core/entity/alarm-control-panel.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/core/entity/alarm-control-panel.md b/docs/core/entity/alarm-control-panel.md index 188ea18a..dcb6a106 100644 --- a/docs/core/entity/alarm-control-panel.md +++ b/docs/core/entity/alarm-control-panel.md @@ -13,14 +13,16 @@ Properties should always only return information from memory and not do I/O (lik | Name | Type | Default | Description | ---- | ---- | ------- | ----------- -| state | string | **Required** | One of the states listed in the **states** section. -| code_format | string | `None` | One of the states listed in the **code formats** section. -| changed_by | string | `None` | Last change triggered by. +| state | str | None | **Required** | One of the states listed in the **states**. +| code_arm_required | bool | `True` | Whether the code is required for arm actions. +| code_format | CodeFormat | None | `None` | One of the states listed in the **code formats** section. +| changed_by | str | None | `None` | Last change triggered by. ### States | Value | Description | ----- | ----------- +| `None` | Unknown state. | `disarmed` | The alarm is disarmed (`off`). | `armed_home` | The alarm is armed in home mode. | `armed_away` | The alarm is armed in away mode.