Add Elk-M1 sensor platform

homeassistant/components/elkm1/__init__.py

@@ -35,7 +35,8 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-SUPPORTED_DOMAINS = ['alarm_control_panel', 'light', 'scene', 'switch']
+SUPPORTED_DOMAINS = ['alarm_control_panel', 'light', 'scene', 'sensor',
+                     'switch']
 
 
 def _host_validator(config):

homeassistant/components/sensor/elkm1.py

@@ -0,0 +1,315 @@
+"""
+Support for control of ElkM1 sensors.
+
+On the ElkM1 there are 6 types of sensors:
+- Counters that are integers that can be read
+- Keypads that have temperature (not all models, but no way to know)
+- Panel that monitors the state of the connection, versions, etc.
+- Settings that are used to trigger Elk-M1 automations
+- Thermostats that have temperature
+- Zones that are multi-state, voltage, or temperature.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.elkm1/
+"""
+
+import voluptuous as vol
+
+from homeassistant.components.elkm1 import (
+    DOMAIN as ELK_DOMAIN, create_elk_entities, ElkEntity)
+from homeassistant.components.sensor import DOMAIN
+from homeassistant.const import ATTR_ENTITY_ID
+import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.dispatcher import (
+    async_dispatcher_connect, async_dispatcher_send)
+
+DEPENDENCIES = [ELK_DOMAIN]
+
+SPEAK_SERVICE_SCHEMA = vol.Schema({
+    vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
+    vol.Required('number'): vol.Range(min=0, max=999),
+})
+
+SIGNAL_SPEAK_WORD = 'elkm1_speak_word'
+SIGNAL_SPEAK_PHRASE = 'elkm1_speak_phrase'
+
+
+async def async_setup_platform(hass, config, async_add_entities,
+                               discovery_info=None):
+    """Create the Elk-M1 sensor platform."""
+    if discovery_info is None:
+        return
+
+    elk = hass.data[ELK_DOMAIN]['elk']
+    entities = create_elk_entities(
+        hass, elk.counters, 'counter', ElkCounter, [])
+    entities = create_elk_entities(
+        hass, elk.keypads, 'keypad', ElkKeypad, entities)
+    entities = create_elk_entities(
+        hass, [elk.panel], 'panel', ElkPanel, entities)
+    entities = create_elk_entities(
+        hass, elk.settings, 'setting', ElkSetting, entities)
+    entities = create_elk_entities(
+        hass, elk.thermostats, 'thermostat', ElkThermostat, entities)
+    entities = create_elk_entities(
+        hass, elk.zones, 'zone', ElkZone, entities)
+    async_add_entities(entities, True)
+
+    def _dispatch(signal, entity_ids, *args):
+        for entity_id in entity_ids:
+            async_dispatcher_send(
+                hass, '{}_{}'.format(signal, entity_id), *args)
+
+    def _speak_word_service(service):
+        entity_ids = service.data.get(ATTR_ENTITY_ID, [])
+        args = (service.data.get('number'))
+        _dispatch(SIGNAL_SPEAK_WORD, entity_ids, *args)
+
+    def _speak_phrase_service(service):
+        entity_ids = service.data.get(ATTR_ENTITY_ID, [])
+        args = (service.data.get('number'))
+        _dispatch(SIGNAL_SPEAK_PHRASE, entity_ids, *args)
+
+    hass.services.async_register(DOMAIN, 'elkm1_sensor_speak_word',
+                                 _speak_word_service, SPEAK_SERVICE_SCHEMA)
+    hass.services.async_register(DOMAIN, 'elkm1_sensor_speak_phrase',
+                                 _speak_phrase_service, SPEAK_SERVICE_SCHEMA)
+
+
+def temperature_to_state(temperature, undefined_temperature):
+    """Convert temperature to a state."""
+    return temperature if temperature > undefined_temperature else None
+
+
+class ElkSensor(ElkEntity):
+    """Base representation of Elk-M1 sensor."""
+
+    def __init__(self, element, elk, elk_data):
+        """Initialize the base of all Elk sensors."""
+        super().__init__(element, elk, elk_data)
+        self._state = None
+
+    @property
+    def state(self):
+        """Return the state of the sensor."""
+        return self._state
+
+
+class ElkCounter(ElkSensor):
+    """Representation of an Elk-M1 Counter."""
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend."""
+        return 'mdi:numeric'
+
+    def _element_changed(self, element, changeset):
+        self._state = self._element.value
+
+
+class ElkKeypad(ElkSensor):
+    """Representation of an Elk-M1 Keypad."""
+
+    @property
+    def temperature_unit(self):
+        """Return the temperature unit."""
+        return self._temperature_unit
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit of measurement."""
+        return self._temperature_unit
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend."""
+        return 'mdi:thermometer-lines'
+
+    @property
+    def device_state_attributes(self):
+        """Attributes of the sensor."""
+        from elkm1_lib.util import username
+
+        attrs = self.initial_attrs()
+        attrs['area'] = self._element.area + 1
+        attrs['temperature'] = self._element.temperature
+        attrs['last_user_time'] = self._element.last_user_time.isoformat()
+        attrs['last_user'] = self._element.last_user + 1
+        attrs['code'] = self._element.code
+        attrs['last_user_name'] = username(self._elk, self._element.last_user)
+        return attrs
+
+    def _element_changed(self, element, changeset):
+        self._state = temperature_to_state(self._element.temperature, -40)
+
+    async def async_added_to_hass(self):
+        """Register callback for ElkM1 changes and update entity state."""
+        await super().async_added_to_hass()
+        self.hass.data[ELK_DOMAIN]['keypads'][
+            self._element.index] = self.entity_id
+
+
+class ElkPanel(ElkSensor):
+    """Representation of an Elk-M1 Panel."""
+
+    async def async_added_to_hass(self):
+        """Register callback for ElkM1 changes."""
+        await super().async_added_to_hass()
+        async_dispatcher_connect(
+            self.hass, '{}_{}'.format(SIGNAL_SPEAK_WORD, self.entity_id),
+            self._speak_word)
+        async_dispatcher_connect(
+            self.hass, '{}_{}'.format(SIGNAL_SPEAK_PHRASE, self.entity_id),
+            self._speak_phrase)
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend."""
+        return "mdi:home"
+
+    @property
+    def device_state_attributes(self):
+        """Attributes of the sensor."""
+        attrs = self.initial_attrs()
+        attrs['elkm1_version'] = self._element.elkm1_version
+        attrs['system_trouble_status'] = self._element.system_trouble_status
+        attrs['xep_version'] = self._element.xep_version
+        return attrs
+
+    def _element_changed(self, element, changeset):
+        if self._elk.is_connected():
+            self._state = 'Paused' if self._element.remote_programming_status \
+                else 'Connected'
+        else:
+            self._state = 'Disconnected'
+
+    async def _speak_word(self, number):
+        """Speak a word on the panel."""
+        self._element.speak_word(number)
+
+    async def _speak_phrase(self, number):
+        """Speak a phrase on the panel."""
+        self._element.speak_phrase(number)
+
+
+class ElkSetting(ElkSensor):
+    """Representation of an Elk-M1 Setting."""
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend."""
+        return 'mdi:numeric'
+
+    def _element_changed(self, element, changeset):
+        self._state = self._element.value
+
+    @property
+    def device_state_attributes(self):
+        """Attributes of the sensor."""
+        from elkm1_lib.const import SettingFormat
+        attrs = self.initial_attrs()
+        attrs['value_format'] = SettingFormat(
+            self._element.value_format).name.lower()
+        return attrs
+
+
+class ElkThermostat(ElkSensor):
+    """Representation of an Elk-M1 Thermostat."""
+
+    @property
+    def temperature_unit(self):
+        """Return the temperature unit."""
+        return self._temperature_unit
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit of measurement."""
+        return self._temperature_unit
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend."""
+        return 'mdi:thermometer-lines'
+
+    def _element_changed(self, element, changeset):
+        self._state = temperature_to_state(self._element.current_temp, 0)
+
+
+class ElkZone(ElkSensor):
+    """Representation of an Elk-M1 Zone."""
+
+    @property
+    def icon(self):
+        """Icon to use in the frontend."""
+        from elkm1_lib.const import ZoneType
+        zone_icons = {
+            ZoneType.FIRE_ALARM.value: 'fire',
+            ZoneType.FIRE_VERIFIED.value: 'fire',
+            ZoneType.FIRE_SUPERVISORY.value: 'fire',
+            ZoneType.KEYFOB.value: 'key',
+            ZoneType.NON_ALARM.value: 'alarm-off',
+            ZoneType.MEDICAL_ALARM.value: 'medical-bag',
+            ZoneType.POLICE_ALARM.value: 'alarm-light',
+            ZoneType.POLICE_NO_INDICATION.value: 'alarm-light',
+            ZoneType.KEY_MOMENTARY_ARM_DISARM.value: 'power',
+            ZoneType.KEY_MOMENTARY_ARM_AWAY.value: 'power',
+            ZoneType.KEY_MOMENTARY_ARM_STAY.value: 'power',
+            ZoneType.KEY_MOMENTARY_DISARM.value: 'power',
+            ZoneType.KEY_ON_OFF.value: 'toggle-switch',
+            ZoneType.MUTE_AUDIBLES.value: 'volume-mute',
+            ZoneType.POWER_SUPERVISORY.value: 'power-plug',
+            ZoneType.TEMPERATURE.value: 'thermometer-lines',
+            ZoneType.ANALOG_ZONE.value: 'speedometer',
+            ZoneType.PHONE_KEY.value: 'phone-classic',
+            ZoneType.INTERCOM_KEY.value: 'deskphone'
+        }
+        return 'mdi:{}'.format(
+            zone_icons.get(self._element.definition, 'alarm-bell'))
+
+    @property
+    def device_state_attributes(self):
+        """Attributes of the sensor."""
+        from elkm1_lib.const import (
+            ZoneLogicalStatus, ZonePhysicalStatus, ZoneType)
+
+        attrs = self.initial_attrs()
+        attrs['physical_status'] = ZonePhysicalStatus(
+            self._element.physical_status).name.lower()
+        attrs['logical_status'] = ZoneLogicalStatus(
+            self._element.logical_status).name.lower()
+        attrs['definition'] = ZoneType(
+            self._element.definition).name.lower()
+        attrs['area'] = self._element.area + 1
+        attrs['bypassed'] = self._element.bypassed
+        attrs['triggered_alarm'] = self._element.triggered_alarm
+        return attrs
+
+    @property
+    def temperature_unit(self):
+        """Return the temperature unit."""
+        from elkm1_lib.const import ZoneType
+        if self._element.definition == ZoneType.TEMPERATURE.value:
+            return self._temperature_unit
+        return None
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit of measurement."""
+        from elkm1_lib.const import ZoneType
+        if self._element.definition == ZoneType.TEMPERATURE.value:
+            return self._temperature_unit
+        if self._element.definition == ZoneType.ANALOG_ZONE.value:
+            return 'V'
+        return None
+
+    def _element_changed(self, element, changeset):
+        from elkm1_lib.const import ZoneLogicalStatus, ZoneType
+        from elkm1_lib.util import pretty_const
+
+        if self._element.definition == ZoneType.TEMPERATURE.value:
+            self._state = temperature_to_state(self._element.temperature, -60)
+        elif self._element.definition == ZoneType.ANALOG_ZONE.value:
+            self._state = self._element.voltage
+        else:
+            self._state = pretty_const(ZoneLogicalStatus(
+                self._element.logical_status).name)

homeassistant/components/sensor/services.yaml

@@ -0,0 +1,21 @@
+# Describes the format for available ElkM1 alarm control panel services
+
+elkm1_sensor_speak_word:
+  description: Speak a word. See list of words in ElkM1 ASCII Protocol documentation.
+  fields:
+    entity_id:
+      description: Name of panel to speak word on.
+      example: 'sensor.elkm1_panel_001'
+    number:
+      description: Word number to speak.
+      example: 458
+
+elkm1_sensor_speak_phrase:
+  description: Speak a phrase. See list of phrases in ElkM1 ASCII Protocol documentation.
+  fields:
+    entity_id:
+      description: Name of panel to speak phrase on.
+      example: 'sensor.elkm1_panel_001'
+    number:
+      description: Phrase number to speak.
+      example: 42