diff --git a/docs/entity_alarm_control_panel.md b/docs/entity_alarm_control_panel.md index 14f75410..d3227943 100644 --- a/docs/entity_alarm_control_panel.md +++ b/docs/entity_alarm_control_panel.md @@ -7,6 +7,8 @@ sidebar_label: Alarm Control Panel This entry is incomplete. Contribution welcome. ::: +An alarm control panel entity controls an alarm. Derive a platform entity from [`homeassistant.components.alarm_control_panel.AlarmControlPanelEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/alarm_control_panel/__init__.py). + ## Properties :::tip @@ -50,7 +52,7 @@ Properties should always only return information from memory and not do I/O (lik Send disarm command. ```python -class MyAlarm(AlarmControlPanel): +class MyAlarm(AlarmControlPanelEntity): # Implement one of these methods. def alarm_disarm(self, code=None) -> None: @@ -64,7 +66,7 @@ class MyAlarm(AlarmControlPanel): Send arm home command. ```python -class MyAlarm(AlarmControlPanel): +class MyAlarm(AlarmControlPanelEntity): # Implement one of these methods. def alarm_arm_home(self, code=None) -> None: @@ -78,7 +80,7 @@ class MyAlarm(AlarmControlPanel): Send arm away command. ```python -class MyAlarm(AlarmControlPanel): +class MyAlarm(AlarmControlPanelEntity): # Implement one of these methods. def alarm_arm_away(self, code=None) -> None: @@ -92,7 +94,7 @@ class MyAlarm(AlarmControlPanel): Send arm night command. ```python -class MyAlarm(AlarmControlPanel): +class MyAlarm(AlarmControlPanelEntity): # Implement one of these methods. def alarm_arm_night(self, code=None) -> None: @@ -106,7 +108,7 @@ class MyAlarm(AlarmControlPanel): Send alarm trigger command. ```python -class MyAlarm(AlarmControlPanel): +class MyAlarm(AlarmControlPanelEntity): # Implement one of these methods. def alarm_trigger(self, code=None) -> None: @@ -120,7 +122,7 @@ class MyAlarm(AlarmControlPanel): Send arm custom bypass command. ```python -class MyAlarm(AlarmControlPanel): +class MyAlarm(AlarmControlPanelEntity): # Implement one of these methods. def alarm_arm_custom_bypass(self, code=None) -> None: