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
armed_custom_bypass
pending
triggered
arming
disarming
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
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic
.
The payload that represents the available state.
The payload that represents the unavailable state.
When availability
is configured, this controls the conditions needed to set the entity to available
. Valid entries are all
, any
, and latest
. If set to all
, payload_available
must be received on all configured availability topics before the entity is marked as online. If set to any
, payload_available
must be received on at least one configured availability topic before the entity is marked as online. If set to latest
, the last payload_available
or payload_not_available
received on any configured availability topic controls the availability.
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability
.
If true the code is required to arm the alarm. If false the code is not validated.
If true the code is required to disarm the alarm. If false the code is not validated.
The template used for the command payload. Available variables: action
and code
.
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.
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"]]
.
A list of IDs that uniquely identify the device. For example a serial number.
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.
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.
The payload to set armed-away mode on your Alarm Panel.
The payload to set armed-home mode on your Alarm Panel.
The payload to set armed-night mode on your Alarm Panel.
The payload to set armed-custom-bypass mode on your Alarm Panel.
The payload that represents the available state.
The payload that represents the unavailable state.
If the published message should have the retain flag on or not.
An ID that uniquely identifies this alarm panel. If two alarm panels have the same unique ID, Home Assistant will raise an exception.
Suggest an edit to this page, or provide/view feedback for this page.