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-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add AlarmDecoder Arming Key Sequences documentation (#13725)

Browse Source
This commit is contained in:
AJ Schmidt 2020-06-19 14:39:49 -04:00 committed by GitHub
parent 408ebf2052
commit 1530e60036
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 51 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
source/_integrations/alarmdecoder.markdown
View File

@ -78,17 +78,17 @@ device:
default: 115200
type: string
panel_display:
description: Create a sensor called sensor.alarm_display to match the Alarm Keypad display.
description: Create a sensor called `sensor.alarm_display` to match the Alarm Keypad display.
required: false
default: false
type: boolean
autobypass:
description: "If this is set to `true`, then when arming (home or away), it will automatically bypass all open zones (sending '6#'). This will require your code to be entered even if `code_arm_required` is set to `false`."
description: "**Honeywell only.** Set to `true`, to automatically bypass all open zones (sending `6#`) when arming. This will require a code to be entered even if `code_arm_required` is set to `false`."
required: false
default: false
type: boolean
code_arm_required:
description: "If this is set to `false`, you will not need to enter your code to arm the system."
description: "Set to `false` to enable arming without having to enter a code."
required: false
default: true
type: boolean
@ -146,7 +146,7 @@ The Alarm Decoder integration gives you access to several services for you to co
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
- `alarm_arm_night`: Arms the alarm in instant mode; all faults will trigger the alarm. Additionally, the entry delay is turned off on the doors.
- `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered.
- `alarm_disarm`: Disarms the alarm from any state.
- `alarmdecoder.alarm_keypress`: Sends a string of characters to the alarm, as if you had touched those keys on a keypad.
- `alarmdecoder.alarm_toggle_chime`: Toggles the alarm's chime state.
@ -185,3 +185,50 @@ Using a combination of the available services and attributes, you can create swi
{% endif %}
```
{% endraw %}
## Arming Key Sequences
The tables below show the key press sequences used for arming for the different panel brands and configuration setting combinations. They are taken from the [adext](https://pypi.org/project/adext/) PyPI package.
### Honeywell
#### code_arm_required = true (default)
| Mode | Key Sequence |
| ------------------------------------------------------- | --------------------------- |
| `alarm_arm_home` | `code` + `3` |
| `alarm_arm_away` | `code` + `2` |
| `alarm_arm_night` | `code` + `7` |
#### code_arm_required = false
| Mode | Key Sequence |
| ------------------------------------------------------- | --------------------------- |
| `alarm_arm_home` | `#3` |
| `alarm_arm_away` | `#2` |
| `alarm_arm_night` | `#7` |
### DSC
#### code_arm_required = true (default)
| Mode | Key Sequence |
| ------------------------------------------------------- | --------------------------- |
| `alarm_arm_home` | `code` |
| `alarm_arm_away` | `code` |
| `alarm_arm_night` | `code` |
#### code_arm_required = false
<div class='note'>
The `chr(4)` and `chr(5)` sequences below are equivalent to pressing the <em>Stay</em> and <em>Away</em> keypad keys respectively (as outlined in the <a href='http://www.alarmdecoder.com/wiki/index.php/Protocol#Special_Keys'>AlarmDecoder documentation</a>).
</div>
| Mode | Key Sequence |
| ------------------------------------------------------- | ------------------------------- |
| `alarm_arm_home` | `chr(4)` + `chr(4)` + `chr(4)` |
| `alarm_arm_away` | `chr(5)` + `chr(5)` + `chr(5)` |
| `alarm_arm_night` | `chr(4)` + `chr(4)` + `chr(4)` |