Skip to content

Commit b40d325

Browse files
mririgoyenMartinHjelmare
authored andcommitted
Update the Alarm Decoder docs to outline the services and attributes (home-assistant#4277)
* Update the Alarm Decoder alarm panel doc to outline the services and attributes available * Update docs to meet standards
1 parent fd2dd4d commit b40d325

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

source/_components/alarm_control_panel.alarmdecoder.markdown

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,58 @@ The `alarmdecoder` alarm control panel platform allows you to control your [Alar
1818

1919
The requirement is that you have setup your [AlarmDecoder hub](/components/alarmdecoder/).
2020

21+
### {% linkable_title Services %}
22+
23+
The Alarm Decoder component gives you access to several services for you to control your alarm with.
24+
25+
- `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm.
26+
- `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm.
27+
- `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.
28+
- `alarm_disarm`: Disarms the alarm from any state. Also clears a `check_zone` flag after an alarm was triggered.
29+
- `alarmdecoder_alarm_toggle_chime`: Toggles the alarm's chime state.
30+
31+
**Note**: `alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder component.
32+
33+
### {% linkable_title Attributes %}
34+
35+
There are several attributes available on the alarm panel to give you more information about your alarm.
36+
37+
- `ac_power`: Set to `true` if your system has AC power supplying it.
38+
- `backlight_on`: Set to `true` if your keypad's backlight is on.
39+
- `battery_low`: Set to `true` if your system's back-up battery is low.
40+
- `check_zone`: Set to `true` if your system was recently triggered. When `check_zone` is `true`, it must be cleared by entering your code + 1 before attempting to rearm your alarm.
41+
- `chime`: Set to `true` if your system's chime is activated. When activated, your system will beep anytime a door or window is faulted while the alarm is disarmed.
42+
- `entry_delay_off`: Set to `true` if your system is in "Instant" mode, meaning the alarm will sound on any faults.
43+
- `programming_mode`: Set to `true` if your system is in programming mode.
44+
- `ready`: Set to `true` if your system is ready to be armed. Any faults, including motions sensors, will make this value `false`.
45+
- `zone_bypassed`: Set to `true` if your system is currently bypassing a zone.
46+
47+
### {% linkable_title Examples %}
48+
49+
Using a combination of the available services and attributes, you can create switch templates.
50+
51+
#### {% linkable_title Chime Status and Control %}
52+
53+
{% raw %}
54+
```yaml
55+
- platform: template
56+
switches:
57+
alarm_chime:
58+
friendly_name: Chime
59+
value_template: "{{ is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) }}"
60+
turn_on:
61+
service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
62+
data:
63+
code: !secret alarm_code
64+
turn_off:
65+
service: alarm_control_panel.alarmdecoder_alarm_toggle_chime
66+
data:
67+
code: !secret alarm_code
68+
icon_template: >-
69+
{% if is_state_attr('alarm_control_panel.alarm_panel', 'chime', true) %}
70+
mdi:bell-ring
71+
{% else %}
72+
mdi:bell-off
73+
{% endif %}
74+
```
75+
{% endraw %}

0 commit comments

Comments
 (0)