Home Assistant

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 component will accept the following states from your Alarm Panel (in lower case):

  • ‘disarmed’
  • ‘armed_home’
  • ‘armed_away’
  • ‘pending’
  • ‘triggered’

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 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

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.

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

code

(string)(Optional)If defined, specifies a code to enable or disable the alarm in the frontend.

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