From 534270da159cd18405ef0a2c9808ed8de14ba2af Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Sat, 25 Apr 2020 08:57:59 +0200 Subject: [PATCH 1/3] Rename AlarmControlPanel to AlarmControlPanelEntity --- docs/entity_alarm_control_panel.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/entity_alarm_control_panel.md b/docs/entity_alarm_control_panel.md index 14f75410929..59c1972056d 100644 --- a/docs/entity_alarm_control_panel.md +++ b/docs/entity_alarm_control_panel.md @@ -50,7 +50,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 +64,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 +78,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 +92,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 +106,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 +120,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: From d6450956b88b477d09b7304bccae5552dfcf504a Mon Sep 17 00:00:00 2001 From: Erik Montnemery Date: Sat, 25 Apr 2020 09:35:03 +0200 Subject: [PATCH 2/3] Add link to base class --- docs/entity_alarm_control_panel.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/entity_alarm_control_panel.md b/docs/entity_alarm_control_panel.md index 59c1972056d..f9f49687fe5 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 entity platforms 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 From 6df76f89c0bebdc36ac2ca5669530c07b0b7e2f6 Mon Sep 17 00:00:00 2001 From: Martin Hjelmare Date: Sat, 25 Apr 2020 18:05:05 +0200 Subject: [PATCH 3/3] Wording --- docs/entity_alarm_control_panel.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/entity_alarm_control_panel.md b/docs/entity_alarm_control_panel.md index f9f49687fe5..d322794395b 100644 --- a/docs/entity_alarm_control_panel.md +++ b/docs/entity_alarm_control_panel.md @@ -7,7 +7,7 @@ sidebar_label: Alarm Control Panel This entry is incomplete. Contribution welcome. ::: -An alarm control panel entity controls an alarm. Derive entity platforms from [`homeassistant.components.alarm_control_panel.AlarmControlPanelEntity`](https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/alarm_control_panel/__init__.py). +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