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-22 00:36:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MQTT alarm_control_panel config to integration key (#22812)

Browse Source
This commit is contained in:
Jan Bouwhuis 2022-05-23 14:22:42 +02:00 committed by GitHub
parent 6f72a91d0b
commit 9abd798311
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
source/_integrations/alarm_control_panel.mqtt.markdown
View File

@ -31,12 +31,32 @@ To enable this platform, add the following lines to your `configuration.yaml`:
```yaml
# Example configuration.yaml entry
mqtt:
alarm_control_panel:
- state_topic: "home/alarm"
command_topic: "home/alarm/set"
```
<a id='new_format'></a>
{% details "Previous configuration format" %}
The configuration format of manual configured MQTT items has changed.
The old format that places configurations under the `alarm_control_panel` platform key
should no longer be used and is deprecated.
The above example shows the new and modern way,
this is the previous/old example:
```yaml
alarm_control_panel:
- platform: mqtt
state_topic: "home/alarm"
command_topic: "home/alarm/set"
```
{% enddetails %}
{% configuration %}
availability:
description: A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
@ -260,13 +280,13 @@ The example below shows a full configuration with local code validation.
```yaml
# Example using text based code with local validation configuration.yaml
alarm_control_panel:
- platform: mqtt
name: "Alarm Panel With Numeric Keypad"
state_topic: "alarmdecoder/panel"
value_template: "{{value_json.state}}"
command_topic: "alarmdecoder/panel/set"
code: mys3cretc0de
mqtt:
alarm_control_panel:
- name: "Alarm Panel With Numeric Keypad"
state_topic: "alarmdecoder/panel"
value_template: "{{value_json.state}}"
command_topic: "alarmdecoder/panel/set"
code: mys3cretc0de
```
{% endraw %}
@ -279,26 +299,26 @@ The example below shows a full configuration with remote code validation and `co
```yaml
# Example using text code with remote validation configuration.yaml
alarm_control_panel:
- platform: mqtt
name: "Alarm Panel With Text Code Dialog"
state_topic: "alarmdecoder/panel"
value_template: "{{ value_json.state }}"
command_topic: "alarmdecoder/panel/set"
code: REMOTE_CODE_TEXT
command_template: "{ action: '{{ action }}', code: '{{ code }}'}"
mqtt:
alarm_control_panel:
- name: "Alarm Panel With Text Code Dialog"
state_topic: "alarmdecoder/panel"
value_template: "{{ value_json.state }}"
command_topic: "alarmdecoder/panel/set"
code: REMOTE_CODE_TEXT
command_template: "{ action: '{{ action }}', code: '{{ code }}'}"
```
```yaml
# Example using numeric code with remote validation configuration.yaml
alarm_control_panel:
- platform: mqtt
name: "Alarm Panel With Numeric Keypad"
state_topic: "alarmdecoder/panel"
value_template: "{{ value_json.state }}"
command_topic: "alarmdecoder/panel/set"
code: REMOTE_CODE
command_template: "{ action: '{{ action }}', code: '{{ code }}'}"
mqtt:
alarm_control_panel:
- name: "Alarm Panel With Numeric Keypad"
state_topic: "alarmdecoder/panel"
value_template: "{{ value_json.state }}"
command_topic: "alarmdecoder/panel/set"
code: REMOTE_CODE
command_template: "{ action: '{{ action }}', code: '{{ code }}'}"
```
{% endraw %}