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-06-17 15:46:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document alarm control panel vacation mode (#758)

Browse Source
This commit is contained in:
posixx 2021-07-01 17:27:35 +02:00 committed by GitHub
parent 23cb2bba8f
commit 2f06bbd68f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -25,6 +25,7 @@ Properties should always only return information from memory and not do I/O (lik
| `armed_home` | The alarm is armed in home mode.
| `armed_away` | The alarm is armed in away mode.
| `armed_night` | The alarm is armed in night mode.
| `armed_vacation` | The alarm is armed in vacation mode.
| `armed_custom_bypass` | The alarm is armed in bypass mode.
| `pending` | The alarm is pending (towards `triggered`).
| `arming` | The alarm is arming.
@ -67,7 +68,7 @@ class MyAlarm(AlarmControlPanelEntity):
def alarm_arm_home(self, code=None) -> None:
"""Send arm home command."""
def async_alarm_arm_home(self, code=None) -> None:
async def async_alarm_arm_home(self, code=None) -> None:
"""Send arm home command."""
```
@ -82,7 +83,7 @@ class MyAlarm(AlarmControlPanelEntity):
def alarm_arm_away(self, code=None) -> None:
"""Send arm away command."""
def async_alarm_arm_away(self, code=None) -> None:
async def async_alarm_arm_away(self, code=None) -> None:
"""Send arm away command."""
```
@ -97,10 +98,25 @@ class MyAlarm(AlarmControlPanelEntity):
def alarm_arm_night(self, code=None) -> None:
"""Send arm night command."""
def async_alarm_arm_night(self, code=None) -> None:
async def async_alarm_arm_night(self, code=None) -> None:
"""Send arm night command."""
```
### Alarm Arm Vacation
Send arm vacation command.
```python
class MyAlarm(AlarmControlPanelEntity):
# Implement one of these methods.
def alarm_arm_vacation(self, code=None) -> None:
"""Send arm vacation command."""
async def async_alarm_arm_vacation(self, code=None) -> None:
"""Send arm vacation command."""
```
### Alarm Trigger
Send alarm trigger command.
@ -112,7 +128,7 @@ class MyAlarm(AlarmControlPanelEntity):
def alarm_trigger(self, code=None) -> None:
"""Send alarm trigger command."""
def async_alarm_trigger(self, code=None) -> None:
async def async_alarm_trigger(self, code=None) -> None:
"""Send alarm trigger command."""
```
@ -127,6 +143,6 @@ class MyAlarm(AlarmControlPanelEntity):
def alarm_arm_custom_bypass(self, code=None) -> None:
"""Send arm custom bypass command."""
def async_alarm_arm_custom_bypass(self, code=None) -> None:
async def async_alarm_arm_custom_bypass(self, code=None) -> None:
"""Send arm custom bypass command."""
```