jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-02 17:18:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_components/alarm_control_panel.mqtt.markdown
Peter Kyrkos 7f0c538e7a Update alarm_control_panel.mqtt.markdown
2016-01-22 20:11:34 +11:00

2.0 KiB
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category
layout title description date sidebar comments sharing footer logo ha_category
component MQTT Alarm Control Panel Instructions how to integrate MQTT capable Alarm Panels into Home Assistant. 2015-09-14 19:10 true false true true mqtt.png Alarm

This platform enables the possibility to control an MQTT alarm panel. 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 will receive an instant state update after subscription and will start with correct state. Otherwise, the initial state will be unknown.

The component will accept the following states from your Alarm Panel (in lower case) :-

  • 'armed'
  • 'armed_home'
  • 'armed_away'
  • 'pending'
  • 'triggered'

The component is able to control your Alarm Panel by publishing to the command_topic: when a user interacts with the screen icon on the frontend.

# Example configuration.yaml entry
alarm_control_panel:
  platform: mqtt
  state_topic: "home/alarm"
  command_topic: "home/alarm/set"
  name: "MQTT Alarm"
  qos: 0
  payload_disarm: "DISARM"
  payload_arm_home: "ARM_HOME"
  payload_arm_away: "ARM_AWAY"
  code: "mySecretCode"

Configuration variables:

  • state_topic (Required): The MQTT topic subscribed to receive state updates.

  • command_topic (Required): The MQTT topic to publish commands to change the alarm state.

  • name (Optional): The name of the alarm. Default is 'MQTT Alarm'.

  • qos (Optional): The maximum QoS level of the state topic. Default is 0. This QoS will also be used to publishing messages.

  • payload_disarm (Optional): The payload do disarm your Alarm Panel. Default is "DISARM".

  • payload_arm_home (Optional): The payload to set armed-home mode on your Alarm Panel. Default is "ARM_HOME".

  • payload_arm_away (Optional): The payload to set armed-away mode on your Alarm Panel. Default is "ARM_AWAY".

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