Merge pull request #397 from sfam/dev

Add MQTT alarm

homeassistant/components/alarm_control_panel/__init__.py

@@ -29,9 +29,11 @@ SERVICE_TO_METHOD = {
 }
 
 ATTR_CODE = 'code'
+ATTR_CODE_FORMAT = 'code_format'
 
 ATTR_TO_PROPERTY = [
     ATTR_CODE,
+    ATTR_CODE_FORMAT
 ]
 
 
@@ -93,16 +95,31 @@ def alarm_arm_away(hass, code, entity_id=None):
     hass.services.call(DOMAIN, SERVICE_ALARM_ARM_AWAY, data)
 
 
+# pylint: disable=no-self-use
 class AlarmControlPanel(Entity):
     """ ABC for alarm control devices. """
-    def alarm_disarm(self, code):
+
+    @property
+    def code_format(self):
+        """ regex for code format or None if no code is required """
+        return None
+
+    def alarm_disarm(self, code=None):
         """ Send disarm command. """
         raise NotImplementedError()
 
-    def alarm_arm_home(self, code):
+    def alarm_arm_home(self, code=None):
         """ Send arm home command. """
         raise NotImplementedError()
 
-    def alarm_arm_away(self, code):
+    def alarm_arm_away(self, code=None):
         """ Send arm away command. """
         raise NotImplementedError()
+
+    @property
+    def state_attributes(self):
+        """ Return the state attributes. """
+        state_attr = {
+            ATTR_CODE_FORMAT: self.code_format,
+            }
+        return state_attr

homeassistant/components/alarm_control_panel/mqtt.py

@@ -0,0 +1,168 @@
+"""
+homeassistant.components.alarm_control_panel.mqtt
+
+This platform enables the possibility to control a MQTT alarm.
+In this platform, 'state_topic' and 'command_topic' are required.
+The alarm will only change state after receiving the 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'.
+
+Configuration:
+
+alarm_control_panel:
+  platform: mqtt
+  name: "MQTT Alarm"
+  state_topic: "home/alarm"
+  command_topic: "home/alarm/set"
+  qos: 0
+  payload_disarm: "DISARM"
+  payload_arm_home: "ARM_HOME"
+  payload_arm_away: "ARM_AWAY"
+  code: "mySecretCode"
+
+Variables:
+
+name
+*Optional
+The name of the alarm. Default is 'MQTT Alarm'.
+
+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.
+
+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 alarm. Default is "DISARM".
+
+payload_arm_home
+*Optional
+The payload to set armed-home mode. Default is "ARM_HOME".
+
+payload_arm_away
+*Optional
+The payload to set armed-away mode. Default is "ARM_AWAY".
+
+code
+*Optional
+If defined, specifies a code to enable or disable the alarm in the frontend.
+
+"""
+
+import logging
+import homeassistant.components.mqtt as mqtt
+import homeassistant.components.alarm_control_panel as alarm
+
+from homeassistant.const import (STATE_UNKNOWN)
+
+_LOGGER = logging.getLogger(__name__)
+
+DEFAULT_NAME = "MQTT Alarm"
+DEFAULT_QOS = 0
+DEFAULT_PAYLOAD_DISARM = "DISARM"
+DEFAULT_PAYLOAD_ARM_HOME = "ARM_HOME"
+DEFAULT_PAYLOAD_ARM_AWAY = "ARM_AWAY"
+
+DEPENDENCIES = ['mqtt']
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """ Sets up the MQTT platform. """
+
+    if config.get('state_topic') is None:
+        _LOGGER.error("Missing required variable: state_topic")
+        return False
+
+    if config.get('command_topic') is None:
+        _LOGGER.error("Missing required variable: command_topic")
+        return False
+
+    add_devices([MqttAlarm(
+        hass,
+        config.get('name', DEFAULT_NAME),
+        config.get('state_topic'),
+        config.get('command_topic'),
+        config.get('qos', DEFAULT_QOS),
+        config.get('payload_disarm', DEFAULT_PAYLOAD_DISARM),
+        config.get('payload_arm_home', DEFAULT_PAYLOAD_ARM_HOME),
+        config.get('payload_arm_away', DEFAULT_PAYLOAD_ARM_AWAY),
+        config.get('code'))])
+
+
+# pylint: disable=too-many-arguments, too-many-instance-attributes
+class MqttAlarm(alarm.AlarmControlPanel):
+    """ represents a MQTT alarm status within home assistant. """
+
+    def __init__(self, hass, name, state_topic, command_topic, qos,
+                 payload_disarm, payload_arm_home, payload_arm_away, code):
+        self._state = STATE_UNKNOWN
+        self._hass = hass
+        self._name = name
+        self._state_topic = state_topic
+        self._command_topic = command_topic
+        self._qos = qos
+        self._payload_disarm = payload_disarm
+        self._payload_arm_home = payload_arm_home
+        self._payload_arm_away = payload_arm_away
+        self._code = code
+
+        def message_received(topic, payload, qos):
+            """ A new MQTT message has been received. """
+            self._state = payload
+            self.update_ha_state()
+
+        mqtt.subscribe(hass, self._state_topic, message_received, self._qos)
+
+    @property
+    def should_poll(self):
+        """ No polling needed """
+        return False
+
+    @property
+    def name(self):
+        """ Returns the name of the device. """
+        return self._name
+
+    @property
+    def state(self):
+        """ Returns the state of the device. """
+        return self._state
+
+    @property
+    def code_format(self):
+        """ One or more characters if code is defined """
+        return None if self._code is None else '.+'
+
+    def alarm_disarm(self, code=None):
+        """ Send disarm command. """
+        if code == str(self._code) or self.code_format is None:
+            mqtt.publish(self.hass, self._command_topic,
+                         self._payload_disarm, self._qos)
+        else:
+            _LOGGER.warning("Wrong code entered while disarming!")
+
+    def alarm_arm_home(self, code=None):
+        """ Send arm home command. """
+        if code == str(self._code) or self.code_format is None:
+            mqtt.publish(self.hass, self._command_topic,
+                         self._payload_arm_home, self._qos)
+        else:
+            _LOGGER.warning("Wrong code entered while arming home!")
+
+    def alarm_arm_away(self, code=None):
+        """ Send arm away command. """
+        if code == str(self._code) or self.code_format is None:
+            mqtt.publish(self.hass, self._command_topic,
+                         self._payload_arm_away, self._qos)
+        else:
+            _LOGGER.warning("Wrong code entered while arming away!")

homeassistant/components/alarm_control_panel/verisure.py

@@ -51,6 +51,11 @@ class VerisureAlarm(alarm.AlarmControlPanel):
         """ Returns the state of the device. """
         return self._state
 
+    @property
+    def code_format(self):
+        """ Four digit code required"""
+        return '^\\d{4}$'
+
     def update(self):
         ''' update alarm status '''
         verisure.update()
@@ -66,21 +71,21 @@ class VerisureAlarm(alarm.AlarmControlPanel):
                 'Unknown alarm state %s',
                 verisure.STATUS[self._device][self._id].status)
 
-    def alarm_disarm(self, code):
+    def alarm_disarm(self, code=None):
         """ Send disarm command. """
         verisure.MY_PAGES.set_alarm_status(
             code,
             verisure.MY_PAGES.ALARM_DISARMED)
         _LOGGER.warning('disarming')
 
-    def alarm_arm_home(self, code):
+    def alarm_arm_home(self, code=None):
         """ Send arm home command. """
         verisure.MY_PAGES.set_alarm_status(
             code,
             verisure.MY_PAGES.ALARM_ARMED_HOME)
         _LOGGER.warning('arming home')
 
-    def alarm_arm_away(self, code):
+    def alarm_arm_away(self, code=None):
         """ Send arm away command. """
         verisure.MY_PAGES.set_alarm_status(
             code,