Implement templates for covers

homeassistant/components/cover/template.py

@@ -0,0 +1,353 @@
+"""
+Support for covers which integrate with other components.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/cover.template/
+"""
+import asyncio
+import logging
+
+import voluptuous as vol
+
+from homeassistant.core import callback
+from homeassistant.components.cover import (
+    ENTITY_ID_FORMAT, CoverDevice, PLATFORM_SCHEMA,
+    SUPPORT_OPEN_TILT, SUPPORT_CLOSE_TILT, SUPPORT_STOP_TILT,
+    SUPPORT_SET_TILT_POSITION, SUPPORT_OPEN, SUPPORT_CLOSE, SUPPORT_STOP,
+    SUPPORT_SET_POSITION, ATTR_POSITION, ATTR_TILT_POSITION)
+from homeassistant.const import (
+    CONF_FRIENDLY_NAME, CONF_ENTITY_ID,
+    EVENT_HOMEASSISTANT_START, MATCH_ALL,
+    CONF_VALUE_TEMPLATE, CONF_ICON_TEMPLATE,
+    STATE_OPEN, STATE_CLOSED)
+from homeassistant.exceptions import TemplateError
+import homeassistant.helpers.config_validation as cv
+from homeassistant.helpers.entity import async_generate_entity_id
+from homeassistant.helpers.event import async_track_state_change
+from homeassistant.helpers.restore_state import async_get_last_state
+from homeassistant.helpers.script import Script
+
+_LOGGER = logging.getLogger(__name__)
+_VALID_STATES = [STATE_OPEN, STATE_CLOSED, 'true', 'false']
+
+CONF_COVERS = 'covers'
+
+CONF_POSITION_TEMPLATE = 'position_template'
+CONF_TILT_TEMPLATE = 'tilt_template'
+OPEN_ACTION = 'open_cover'
+CLOSE_ACTION = 'close_cover'
+STOP_ACTION = 'stop_cover'
+POSITION_ACTION = 'set_cover_position'
+TILT_ACTION = 'set_cover_tilt_position'
+
+TILT_FEATURES = (SUPPORT_OPEN_TILT | SUPPORT_CLOSE_TILT | SUPPORT_STOP_TILT |
+                 SUPPORT_SET_TILT_POSITION)
+
+COVER_SCHEMA = vol.Schema({
+    vol.Optional(CONF_VALUE_TEMPLATE): cv.template,
+    vol.Required(OPEN_ACTION): cv.SCRIPT_SCHEMA,
+    vol.Required(CLOSE_ACTION): cv.SCRIPT_SCHEMA,
+    vol.Required(STOP_ACTION): cv.SCRIPT_SCHEMA,
+    vol.Optional(CONF_POSITION_TEMPLATE): cv.template,
+    vol.Optional(CONF_TILT_TEMPLATE): cv.template,
+    vol.Optional(CONF_ICON_TEMPLATE): cv.template,
+    vol.Optional(POSITION_ACTION): cv.SCRIPT_SCHEMA,
+    vol.Optional(TILT_ACTION): cv.SCRIPT_SCHEMA,
+    vol.Optional(CONF_FRIENDLY_NAME, default=None): cv.string,
+    vol.Optional(CONF_ENTITY_ID): cv.entity_ids
+})
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_COVERS): vol.Schema({cv.slug: COVER_SCHEMA}),
+})
+
+
+@asyncio.coroutine
+def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
+    """Set up the Template cover."""
+    covers = []
+
+    for device, device_config in config[CONF_COVERS].items():
+        friendly_name = device_config.get(CONF_FRIENDLY_NAME, device)
+        state_template = device_config.get(CONF_VALUE_TEMPLATE)
+        position_template = device_config.get(CONF_POSITION_TEMPLATE)
+        tilt_template = device_config.get(CONF_TILT_TEMPLATE)
+        icon_template = device_config.get(CONF_ICON_TEMPLATE)
+        open_action = device_config[OPEN_ACTION]
+        close_action = device_config[CLOSE_ACTION]
+        stop_action = device_config[STOP_ACTION]
+        position_action = device_config.get(POSITION_ACTION)
+        tilt_action = device_config.get(TILT_ACTION)
+
+        if ((position_template is None and state_template is None) or
+                (position_template is not None and
+                 state_template is not None)):
+            _LOGGER.error('Must specify only one of: %s',
+                          ', '.join([CONF_VALUE_TEMPLATE,
+                                     CONF_VALUE_TEMPLATE]))
+            continue
+
+        template_entity_ids = set()
+        if state_template is not None:
+            temp_ids = state_template.extract_entities()
+            if str(temp_ids) != MATCH_ALL:
+                template_entity_ids |= set(temp_ids)
+
+        if position_template is not None:
+            temp_ids = position_template.extract_entities()
+            if str(temp_ids) != MATCH_ALL:
+                template_entity_ids |= set(temp_ids)
+
+        if tilt_template is not None:
+            temp_ids = tilt_template.extract_entities()
+            if str(temp_ids) != MATCH_ALL:
+                template_entity_ids |= set(temp_ids)
+
+        if icon_template is not None:
+            temp_ids = icon_template.extract_entities()
+            if str(temp_ids) != MATCH_ALL:
+                template_entity_ids |= set(temp_ids)
+
+        if not template_entity_ids:
+            template_entity_ids = MATCH_ALL
+
+        entity_ids = device_config.get(CONF_ENTITY_ID, template_entity_ids)
+
+        covers.append(
+            CoverTemplate(
+                hass,
+                device, friendly_name, state_template,
+                position_template, tilt_template, icon_template,
+                open_action, close_action, stop_action,
+                position_action, tilt_action, entity_ids
+            )
+        )
+    if not covers:
+        _LOGGER.error("No covers added")
+        return False
+
+    async_add_devices(covers, True)
+    return True
+
+
+class CoverTemplate(CoverDevice):
+    """Representation of a Template cover."""
+
+    def __init__(self, hass, device_id, friendly_name, state_template,
+                 position_template, tilt_template, icon_template,
+                 open_action, close_action, stop_action,
+                 position_action, tilt_action, entity_ids):
+        """Initialize the Template cover."""
+        self.hass = hass
+        self.entity_id = async_generate_entity_id(
+            ENTITY_ID_FORMAT, device_id, hass=hass)
+        self._name = friendly_name
+        self._template = state_template
+        self._position_template = position_template
+        self._tilt_template = tilt_template
+        self._icon_template = icon_template
+        self._open_script = Script(hass, open_action)
+        self._close_script = Script(hass, close_action)
+        self._stop_script = Script(hass, stop_action)
+        self._position_script = None
+        if position_action is not None:
+            self._position_script = Script(hass, position_action)
+        self._tilt_script = None
+        if tilt_action is not None:
+            self._tilt_script = Script(hass, tilt_action)
+        self._icon = None
+        self._position = None
+        self._tilt_value = None
+        self._entities = entity_ids
+
+        if self._template is not None:
+            self._template.hass = self.hass
+        if self._position_template is not None:
+            self._position_template.hass = self.hass
+        if self._tilt_template is not None:
+            self._tilt_template.hass = self.hass
+        if self._icon_template is not None:
+            self._icon_template.hass = self.hass
+
+    @asyncio.coroutine
+    def async_added_to_hass(self):
+        """Register callbacks."""
+        state = yield from async_get_last_state(self.hass, self.entity_id)
+        if state:
+            self._position = 100 if state.state else 0
+
+        @callback
+        def template_cover_state_listener(entity, old_state, new_state):
+            """Handle target device state changes."""
+            self.hass.async_add_job(self.async_update_ha_state(True))
+
+        @callback
+        def template_cover_startup(event):
+            """Update template on startup."""
+            async_track_state_change(
+                self.hass, self._entities, template_cover_state_listener)
+
+            self.hass.async_add_job(self.async_update_ha_state(True))
+
+        self.hass.bus.async_listen_once(
+            EVENT_HOMEASSISTANT_START, template_cover_startup)
+
+    @property
+    def name(self):
+        """Return the name of the cover."""
+        return self._name
+
+    @property
+    def is_closed(self):
+        """Return if the cover is closed."""
+        return self._position == 0
+
+    @property
+    def current_cover_position(self):
+        """Return current position of cover.
+
+        None is unknown, 0 is closed, 100 is fully open.
+        """
+        return self._position
+
+    @property
+    def current_cover_tilt_position(self):
+        """Return current position of cover tilt.
+
+        None is unknown, 0 is closed, 100 is fully open.
+        """
+        return self._tilt_value
+
+    @property
+    def icon(self):
+        """Return the icon to use in the frontend, if any."""
+        return self._icon
+
+    @property
+    def supported_features(self):
+        """Flag supported features."""
+        supported_features = SUPPORT_OPEN | SUPPORT_CLOSE | SUPPORT_STOP
+
+        if self.current_cover_position is not None:
+            supported_features |= SUPPORT_SET_POSITION
+
+        if self.current_cover_tilt_position is not None:
+            supported_features |= TILT_FEATURES
+
+        return supported_features
+
+    @property
+    def should_poll(self):
+        """Return the polling state."""
+        return False
+
+    @asyncio.coroutine
+    def async_open_cover(self, **kwargs):
+        """Move the cover up."""
+        self.hass.async_add_job(self._open_script.async_run())
+
+    @asyncio.coroutine
+    def async_close_cover(self, **kwargs):
+        """Move the cover down."""
+        self.hass.async_add_job(self._close_script.async_run())
+
+    @asyncio.coroutine
+    def async_stop_cover(self, **kwargs):
+        """Fire the stop action."""
+        self.hass.async_add_job(self._stop_script.async_run())
+
+    @asyncio.coroutine
+    def async_set_cover_position(self, **kwargs):
+        """Set cover position."""
+        if ATTR_POSITION not in kwargs:
+            return
+        self._position = kwargs[ATTR_POSITION]
+        self.hass.async_add_job(self._position_script.async_run(
+            {"position": self._position}))
+
+    @asyncio.coroutine
+    def async_open_cover_tilt(self, **kwargs):
+        """Tilt the cover open."""
+        self._tilt_value = 100
+        self.hass.async_add_job(self._tilt_script.async_run(
+            {"tilt": self._tilt_value}))
+
+    @asyncio.coroutine
+    def async_close_cover_tilt(self, **kwargs):
+        """Tilt the cover closed."""
+        self._tilt_value = 0
+        self.hass.async_add_job(self._tilt_script.async_run(
+            {"tilt": self._tilt_value}))
+
+    @asyncio.coroutine
+    def async_set_cover_tilt_position(self, **kwargs):
+        """Move the cover tilt to a specific position."""
+        if ATTR_TILT_POSITION not in kwargs:
+            return
+        self._tilt_value = kwargs[ATTR_TILT_POSITION]
+        self.hass.async_add_job(self._tilt_script.async_run(
+            {"tilt": self._tilt_value}))
+
+    @asyncio.coroutine
+    def async_update(self):
+        """Update the state from the template."""
+        if self._template is not None:
+            try:
+                state = self._template.async_render().lower()
+                if state in _VALID_STATES:
+                    if state in ('true', STATE_OPEN):
+                        self._position = 100
+                    else:
+                        self._position = 0
+                else:
+                    _LOGGER.error(
+                        'Received invalid cover is_on state: %s. Expected: %s',
+                        state, ', '.join(_VALID_STATES))
+                    self._position = None
+            except TemplateError as ex:
+                _LOGGER.error(ex)
+                self._position = None
+        if self._position_template is not None:
+            try:
+                state = float(self._position_template.async_render())
+                if state < 0 or state > 100:
+                    self._position = None
+                    _LOGGER.error("Cover position value must be"
+                                  " between 0 and 100."
+                                  " Value was: %.2f", state)
+                else:
+                    self._position = state
+            except TemplateError as ex:
+                _LOGGER.error(ex)
+                self._position = None
+            except ValueError as ex:
+                _LOGGER.error(ex)
+                self._position = None
+        if self._tilt_template is not None:
+            try:
+                state = float(self._tilt_template.async_render())
+                if state < 0 or state > 100:
+                    self._tilt_value = None
+                    _LOGGER.error("Tilt value must be between 0 and 100."
+                                  " Value was: %.2f", state)
+                else:
+                    self._tilt_value = state
+            except TemplateError as ex:
+                _LOGGER.error(ex)
+                self._tilt_value = None
+            except ValueError as ex:
+                _LOGGER.error(ex)
+                self._tilt_value = None
+        if self._icon_template is not None:
+            try:
+                self._icon = self._icon_template.async_render()
+            except TemplateError as ex:
+                if ex.args and ex.args[0].startswith(
+                        "UndefinedError: 'None' has no attribute"):
+                    # Common during HA startup - so just a warning
+                    _LOGGER.warning('Could not render icon template %s,'
+                                    ' the state is unknown.', self._name)
+                    return
+                self._icon = super().icon
+                _LOGGER.error('Could not render icon template %s: %s',
+                              self._name, ex)