jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-08 01:46:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve title, make minor corrections (#13091)

Browse Source 
The title on this page was rather unclear. Also made some cosmetic improvements.
This commit is contained in:
Jay 2020-04-22 08:32:08 -05:00 committed by GitHub
parent e7c035018d
commit 1a89687101
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
source/_integrations/manual.markdown
View File

@ -1,5 +1,5 @@
--- ---
title: Manual title: Manual Alarm Control Panel
description: Instructions on how to integrate manual alarms into Home Assistant. description: Instructions on how to integrate manual alarms into Home Assistant.
ha_category: ha_category:
- Alarm - Alarm
@ -8,7 +8,7 @@ ha_quality_scale: internal
ha_domain: manual ha_domain: manual
--- ---
The `manual` alarm control panel platform enables you to set manual alarms in Home Assistant. The `manual` alarm control panel platform enables you to create an alarm system in Home Assistant.
## Configuration ## Configuration
@ -85,37 +85,37 @@ armed_custom_bypass/armed_home/armed_away/armed_night/disarmed/triggered:
## State machine ## State machine
The state machine of the manual alarm integration is complex but powerful. The The state machine of the manual alarm integration is complex but powerful. The
transitions are timed according to three values, **delay_time**, **pending_time** transitions are timed according to three values, **delay_time**, **pending_time**
and **trigger_time**. The values in turn can come from the default configuration and **trigger_time**. The values in turn can come from the default configuration
variable or from a state-specific override. variable or from a state-specific override.
When the alarm is armed, its state first goes to **pending** for a number When the alarm is armed, its state first goes to **pending** for a number
of seconds equal to the destination state's **pending_time**, and then of seconds equal to the destination state's **pending_time**, and then
transitions to one of the "armed" states. Note that **code_template** transitions to one of the "armed" states. Note that **code_template**
never receives "pending" in the **to_state** variable; instead, never receives "pending" in the **to_state** variable; instead,
**to_state** contains the state which the user has requested. However, **to_state** contains the state which the user has requested. However,
**from_state** *can* contain "pending". **from_state** *can* contain "pending".
When the alarm is triggered, its state goes to **pending** for a number of When the alarm is triggered, its state goes to **pending** for a number of
seconds equal to the previous state's **delay_time** plus the triggered seconds equal to the previous state's **delay_time** plus the triggered
state's **pending_time**. Then the alarm transitions to the "triggered" state's **pending_time**. Then the alarm transitions to the "triggered"
states. The code is never checked when triggering the alarm, so the states. The code is never checked when triggering the alarm, so the
**to_state** variable of **code_template** cannot ever contain "triggered" **to_state** variable of **code_template** cannot ever contain "triggered"
either; again, **from_state** *can* contain "triggered". either; again, **from_state** *can* contain "triggered".
The alarm remains in the "triggered" state for a number of seconds equal to the The alarm remains in the "triggered" state for a number of seconds equal to the
previous state's **trigger_time**. Then, depending on **disarm_after_trigger**, previous state's **trigger_time**. Then, depending on **disarm_after_trigger**,
it goes back to either the previous state or **disarmed**. If the previous it goes back to either the previous state or **disarmed**. If the previous
state's **trigger_time** is zero, the transition to "triggered" is entirely state's **trigger_time** is zero, the transition to "triggered" is entirely
blocked and the alarm remains in the armed state. blocked and the alarm remains in the armed state.
Each of the settings is useful in different scenarios. **pending_time** gives Each of the settings is useful in different scenarios. **pending_time** gives
you some time to leave the building (for "armed" states) or to disarm the alarm you some time to leave the building (for "armed" states) or to disarm the alarm
(for the "triggered" state). (for the "triggered" state).
**delay_time** can also be used to allow some time to disarm the alarm, but with **delay_time** can also be used to allow some time to disarm the alarm, but with
more flexibility. For example, you could specify a delay time for the more flexibility. For example, you could specify a delay time for the
"armed away" state, in order to avoid triggering the alarm while the "armed away" state, in order to avoid triggering the alarm while the
garage door opens, but not for the "armed home" state. garage door opens, but not for the "armed home" state.
@ -126,9 +126,9 @@ be used for example to sound the siren for a shorter time during the night.
In the configuration example below: In the configuration example below:
- the disarmed state never triggers the alarm; - The `disarmed` state never triggers the alarm.
- the armed_home state will leave no time to leave the building or disarm the alarm; - The `armed_home` state will leave no time to leave the building or disarm the alarm.
- while other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back. - The other states will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry