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
The component will accept the following states from your Alarm Panel (in lower case):
The component can control your Alarm Panel by publishing to the
command_topic when a user interacts with the Home Assistant frontend.
To enable this platform, add the following lines to your
# Example configuration.yaml entry alarm_control_panel: - platform: mqtt state_topic: "home/alarm" command_topic: "home/alarm/set"
(string)(Optional)The name of the alarm.
Default value: MQTT Alarm
(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.
(string)(Required)The MQTT topic subscribed to receive state updates.
(string)(Required)The MQTT topic to publish commands to change the alarm state.
(integer)(Optional)The maximum QoS level of the state topic.
Default value: 0
(string)(Optional)The payload to disarm your Alarm Panel.
Default value: DISARM
(string)(Optional)The payload to set armed-home mode on your Alarm Panel.
Default value: ARM_HOME
(string)(Optional)The payload to set armed-away mode on your Alarm Panel.
Default value: ARM_AWAY
(string)(Optional)If defined, specifies a code to enable or disable the alarm in the frontend.
(string)(Optional)The MQTT topic subscribed to receive availability (online/offline) updates.
(string)(Optional)The payload that represents the available state.
Default value: online
(string)(Optional)The payload that represents the unavailable state.
Default value: offline
(list | string)(Optional)A list of IDs that uniquely identify the device. For example a serial number.
(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"]].
(string)(Optional)The manufacturer of the device.
(string)(Optional)The model of the device.
(string)(Optional)The name of the device.
(string)(Optional)The firmware version of the device.