MQTT Alarm Control Panel
The mqtt
alarm panel platform enables the possibility to control MQTT capable alarm panels. The Alarm icon will change state after receiving a new state from state_topic
. If these messages are published with RETAIN flag, the MQTT alarm panel will receive an instant state update after subscription and will start with the correct state. Otherwise, the initial state will be unknown
.
The integration will accept the following states from your Alarm Panel (in lower case):
disarmed
armed_home
armed_away
armed_night
pending
triggered
The integration can control your Alarm Panel by publishing to the command_topic
when a user interacts with the Home Assistant frontend.
Configuration
To enable this platform, add the following lines to your configuration.yaml
:
# Example configuration.yaml entry
alarm_control_panel:
- platform: mqtt
state_topic: "home/alarm"
command_topic: "home/alarm/set"
Configuration Variables
- name
-
(string)(Optional)
The name of the alarm.
Default value:
MQTT Alarm
- unique_id
(string)(Optional)
An ID that uniquely identifies this alarm panel. If two alarm panels have the same unique ID, Home Assistant will raise an exception.
- state_topic
(string)(Required)
The MQTT topic subscribed to receive state updates.
- command_topic
(string)(Required)
The MQTT topic to publish commands to change the alarm state.
- command_template
-
(string)(Optional)
The template used for the command payload. Available variables:
action
andcode
.Default value:
action
- value_template
(template)(Optional)
Defines a template to extract the value.
- qos
-
(integer)(Optional)
The maximum QoS level of the state topic.
Default value:
0
- payload_disarm
-
(string)(Optional)
The payload to disarm your Alarm Panel.
Default value:
DISARM
- payload_arm_home
-
(string)(Optional)
The payload to set armed-home mode on your Alarm Panel.
Default value:
ARM_HOME
- payload_arm_away
-
(string)(Optional)
The payload to set armed-away mode on your Alarm Panel.
Default value:
ARM_AWAY
- payload_arm_night
-
(string)(Optional)
The payload to set armed-night mode on your Alarm Panel.
Default value:
ARM_NIGHT
- code
(string)(Optional)
If defined, specifies a code to enable or disable the alarm in the frontend.
- code_arm_required
-
(boolean)(Optional)
If true the code is required to arm the alarm. If false the code is not validated.
Default value:
true
- code_disarm_required
-
(boolean)(Optional)
If true the code is required to disarm the alarm. If false the code is not validated.
Default value:
true
- availability_topic
(string)(Optional)
The MQTT topic subscribed to receive availability (online/offline) updates.
- payload_available
-
(string)(Optional)
The payload that represents the available state.
Default value:
online
- payload_not_available
-
(string)(Optional)
The payload that represents the unavailable state.
Default value:
offline
- json_attributes_topic
(string)(Optional)
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
- json_attributes_template
(template)(Optional)
Defines a template to extract the JSON dictionary from messages received on the
json_attributes_topic
. Usage example can be found in MQTT sensor documentation.- device
(map)(Optional)
Information about the device this alarm panel is a part of to tie it into the device registry. Only works through MQTT discovery and when
unique_id
is set.- identifiers
(list | string)(Optional)
A list of IDs that uniquely identify the device. For example a serial number.
- connections
(list)(Optional)
A list of connections of the device to the outside world as a list of tuples
[connection_type, connection_identifier]
. For example the MAC address of a network interface:"connections": [["mac", "02:5b:26:a8:dc:12"]]
.- manufacturer
(string)(Optional)
The manufacturer of the device.
- model
(string)(Optional)
The model of the device.
- name
(string)(Optional)
The name of the device.
- sw_version
(string)(Optional)
The firmware version of the device.