mqtt platform extends the manual alarm by adding support for MQTT control of the alarm by a remote device. It can be used to create external keypads which simply change the state of the manual alarm in Home Assistant.
It’s essentially the opposite of the MQTT Alarm Panel which allows Home Assistant to observe an existing, fully-featured alarm where all of the alarm logic is embedded in that physical device.
The integration will accept the following commands from your Alarm Panel via the
When the state of the manual alarm changes, Home Assistant will publish one of the following states to the
To use your panel in your installation, add the following to your
# Example configuration.yaml entry alarm_control_panel: - platform: manual_mqtt state_topic: home/alarm command_topic: home/alarm/set
The following configuration variables from the base manual alarm platform are available:
If defined, specifies a code to enable or disable the alarm in the frontend. This code is not required for MQTT interactions. Only one of code and code_template can be specified.
If defined, returns a code to enable or disable the alarm in the frontend; an empty string disables checking the code. Inside the template, the variables from_state and to_state identify the current and desired state. Only one of code and code_template can be specified.
If true, the code is required to arm the alarm. If false, the code is not validated.
The time in seconds of delay added to the triggered state’s pending_time before triggering the alarm.
The time in seconds of the pending time before effecting a state change.
The time in seconds of the trigger time in which the alarm is firing.
If true, the alarm will automatically disarm after it has been triggered instead of returning to the previous state.
State specific settings
State specific setting for pending_time (all states except disarmed).
See the documentation for the manual alarm platform for a description.
Additionally, the following MQTT configuration variables are also available.
The MQTT topic Home Assistant will subscribe to, to receive commands from a remote device to change the alarm state.
The maximum QoS level for subscribing and publishing to MQTT messages.
The payload to set armed-home mode on this Alarm Panel.
The payload to set armed-away mode on this Alarm Panel.
In the configuration example below:
- The disarmed state never triggers the alarm
- The armed_home state will leave no time to leave the building or disarm the alarm
- While other states state will give 30 seconds to leave the building before triggering the alarm, and 20 seconds to disarm the alarm when coming back
- Setting pending_time to 0 for triggered state allows the alarm to trigger after previous state’s delay time only. If not set, the alarm will be pending for previous state’s delay_time plus the default pending_time before triggering.
# Example configuration.yaml entry alarm_control_panel: - platform: manual_mqtt state_topic: home/alarm command_topic: home/alarm/set pending_time: 30 delay_time: 20 trigger_time: 4 disarmed: trigger_time: 0 armed_home: pending_time: 0 delay_time: 0 triggered: pending_time: 0
Refer to the Manual Alarm Control page for more real-life examples on how to use this panel.
The state of this alarm can be controlled using MQTT. Ensure you’ve configured that before adding this component.
To change the state of the alarm, publish one of the following messages to the
To receive state updates from HA, subscribe to the
state_topic. Home Assistant will publish a new message whenever the state changes: