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

Add elkm1 bypass and trigger services (#15170)

Browse Source 
Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Glenn Waters 2020-10-20 20:20:10 -04:00 committed by GitHub
parent 06f9f368ad
commit ed206a8af6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 33 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
source/_integrations/elkm1.markdown
View File

@ -409,7 +409,11 @@ and Switch the ElkM1 integration offers these additional services:
- `elkm1.alarm_arm_home_instant` - `elkm1.alarm_arm_home_instant`
- `elkm1.alarm_arm_night_instant` - `elkm1.alarm_arm_night_instant`
- `elkm1.alarm_arm_vacation` - `elkm1.alarm_arm_vacation`
- `elkm1.alarm_bypass`
- `elkm1.alarm_clear_bypass`
- `elkm1.alarm_display_message` - `elkm1.alarm_display_message`
- `elkm1.sensor_zone_bypass`
- `elkm1.sensor_zone_trigger`
- `elkm1.speak_phrase` - `elkm1.speak_phrase`
- `elkm1.speak_word` - `elkm1.speak_word`
@ -423,6 +427,16 @@ respectively.
| `entity_id` | yes | ElkM1 area which to arm. | `entity_id` | yes | ElkM1 area which to arm.
| `code` | no | Alarm code to arm the system (4 or 6 digits). | `code` | no | Alarm code to arm the system (4 or 6 digits).
### Services `elkm1.alarm_bypass` and `elkm1.alarm_clear_bypass`
For all zones associated with the specified alarm panel these services respectively
bypass or clear the bypass the zones.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 area which to bypass or clear bypass.
| `code` | no | Alarm code to bypass the alarm panel (4 or 6 digits).
### Service `elkm1.alarm_display_message` ### Service `elkm1.alarm_display_message`
Display text on an area's keypads. Display text on an area's keypads.
@ -436,6 +450,25 @@ Display text on an area's keypads.
| `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank. | `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank.
| `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank. | `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank.
### Service `elkm1.sensor_zone_bypass`
Bypass a zone. Note that the only mechanism ElkM1 offers to clear the bypass
is to clear all the bypassed zones in a given alarm panel (area).
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 zone which to bypass.
| `code` | no | Alarm code to bypass the zone (4 or 6 digits).
### Service `elkm1.sensor_zone_trigger`
Cause a zone on the panel to trigger. This command creates a virtual momentary
open condition on the zone as if the EOL hardwired loop had been physically opened.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | ElkM1 zone which to trigger.
### Service `elkm1.speak_phrase` ### Service `elkm1.speak_phrase`
Speak a phrase. The list of phrases is defined in the ElkM1 ASCII Protocol documentation. Speak a phrase. The list of phrases is defined in the ElkM1 ASCII Protocol documentation.