Skip to content

Rename AlarmControlPanel to AlarmControlPanelEntity #474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MartinHjelmare merged 3 commits into from
Apr 25, 2020
Merged

Rename AlarmControlPanel to AlarmControlPanelEntity #474

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
534270d
Rename AlarmControlPanel to AlarmControlPanelEntity
emontnemery Apr 25, 2020
d645095
Add link to base class
emontnemery Apr 25, 2020
6df76f8
Wording
MartinHjelmare Apr 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/entity_alarm_control_panel.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand All @@ -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:
Expand Down