[light.tradfri] async support with resource observation. (#7815)

* [light.tradfri] Initial support for observe * Update for pytradfri 2.0 * Fix imports * Fix missing call * Don't yield from add devices * Fix imports * Minor fixes to async code. * Imports, formatting * Docker updates, some minor async code changes. * Lint * Lint * Update pytradfri * Minor updates for release version * Build fixes * Retry observation if failed * Revert * Additional logging, fix returns * Fix rename * Bump version * Bump version * Support transitions * Lint * Fix transitions * Update Dockerfile * Set temp first * Observation error handling * Lint * Lint * Lint * Merge upstream changes * Fix bugs * Fix bugs * Fix bugs * Lint * Add sensor * Add sensor * Move sensor attrs * Filter devices better * Lint * Address comments * Pin aiocoap * Fix bug if no devices * Requirements
2017-10-05 17:05:38 +01:00 · 2017-10-05 17:05:38 +01:00 · 8db4641455
commit 8db4641455
parent 89042439b8
9 changed files with 336 additions and 91 deletions
--- a/homeassistant/components/sensor/tradfri.py
+++ b/homeassistant/components/sensor/tradfri.py
@ -0,0 +1,116 @@
+"""
+Support for the IKEA Tradfri platform.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.tradfri/
+"""
+import asyncio
+import logging
+
+from datetime import timedelta
+
+from homeassistant.core import callback
+from homeassistant.components.tradfri import KEY_GATEWAY, KEY_API
+from homeassistant.helpers.entity import Entity
+
+_LOGGER = logging.getLogger(__name__)
+
+DEPENDENCIES = ['tradfri']
+
+SCAN_INTERVAL = timedelta(minutes=5)
+
+
+@asyncio.coroutine
+def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
+    """Set up the IKEA Tradfri device platform."""
+    if discovery_info is None:
+        return
+
+    gateway_id = discovery_info['gateway']
+    api = hass.data[KEY_API][gateway_id]
+    gateway = hass.data[KEY_GATEWAY][gateway_id]
+
+    devices_command = gateway.get_devices()
+    devices_commands = yield from api(devices_command)
+    all_devices = yield from api(*devices_commands)
+    devices = [dev for dev in all_devices if not dev.has_light_control]
+    async_add_devices(TradfriDevice(device, api) for device in devices)
+
+
+class TradfriDevice(Entity):
+    """The platform class required by Home Assistant."""
+
+    def __init__(self, device, api):
+        """Initialize the device."""
+        self._api = api
+        self._device = None
+        self._name = None
+
+        self._refresh(device)
+
+    @asyncio.coroutine
+    def async_added_to_hass(self):
+        """Start thread when added to hass."""
+        self._async_start_observe()
+
+    @property
+    def should_poll(self):
+        """No polling needed for tradfri."""
+        return False
+
+    @property
+    def name(self):
+        """Return the display name of this device."""
+        return self._name
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit_of_measurement of the device."""
+        return '%'
+
+    @property
+    def device_state_attributes(self):
+        """Return the devices' state attributes."""
+        info = self._device.device_info
+        attrs = {
+            'manufacturer': info.manufacturer,
+            'model_number': info.model_number,
+            'serial': info.serial,
+            'firmware_version': info.firmware_version,
+            'power_source': info.power_source_str,
+            'battery_level': info.battery_level
+        }
+        return attrs
+
+    @property
+    def state(self):
+        """Return the current state of the device."""
+        return self._device.device_info.battery_level
+
+    @callback
+    def _async_start_observe(self, exc=None):
+        """Start observation of light."""
+        from pytradfri.error import PyTradFriError
+        if exc:
+            _LOGGER.warning("Observation failed for %s", self._name,
+                            exc_info=exc)
+
+        try:
+            cmd = self._device.observe(callback=self._observe_update,
+                                       err_callback=self._async_start_observe,
+                                       duration=0)
+            self.hass.async_add_job(self._api(cmd))
+        except PyTradFriError as err:
+            _LOGGER.warning("Observation failed, trying again", exc_info=err)
+            self._async_start_observe()
+
+    def _refresh(self, device):
+        """Refresh the device data."""
+        self._device = device
+        self._name = device.name
+
+    def _observe_update(self, tradfri_device):
+        """Receive new state data for this device."""
+        self._refresh(tradfri_device)
+
+        self.hass.async_add_job(self.async_update_ha_state())