Zigbee fan (#12289)

* wip: initial control

* fix initial state

* cosmetic cleanup

* doc typo

* lint

* fixes

* fix unknown bug

* Lint

homeassistant/components/fan/zha.py

@@ -0,0 +1,114 @@
+"""
+Fans on Zigbee Home Automation networks.
+
+For more details on this platform, please refer to the documentation
+at https://home-assistant.io/components/fan.zha/
+"""
+import asyncio
+import logging
+from homeassistant.components import zha
+from homeassistant.components.fan import (
+    DOMAIN, FanEntity, SPEED_OFF, SPEED_LOW, SPEED_MEDIUM, SPEED_HIGH,
+    SUPPORT_SET_SPEED)
+from homeassistant.const import STATE_UNKNOWN
+
+DEPENDENCIES = ['zha']
+
+_LOGGER = logging.getLogger(__name__)
+
+# Additional speeds in zigbee's ZCL
+# Spec is unclear as to what this value means. On King Of Fans HBUniversal
+# receiver, this means Very High.
+SPEED_ON = 'on'
+# The fan speed is self-regulated
+SPEED_AUTO = 'auto'
+# When the heated/cooled space is occupied, the fan is always on
+SPEED_SMART = 'smart'
+
+SPEED_LIST = [
+    SPEED_OFF,
+    SPEED_LOW,
+    SPEED_MEDIUM,
+    SPEED_HIGH,
+    SPEED_ON,
+    SPEED_AUTO,
+    SPEED_SMART
+]
+
+VALUE_TO_SPEED = {i: speed for i, speed in enumerate(SPEED_LIST)}
+SPEED_TO_VALUE = {speed: i for i, speed in enumerate(SPEED_LIST)}
+
+
+@asyncio.coroutine
+def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
+    """Set up the Zigbee Home Automation fans."""
+    discovery_info = zha.get_discovery_info(hass, discovery_info)
+    if discovery_info is None:
+        return
+
+    async_add_devices([ZhaFan(**discovery_info)], update_before_add=True)
+
+
+class ZhaFan(zha.Entity, FanEntity):
+    """Representation of a ZHA fan."""
+
+    _domain = DOMAIN
+
+    @property
+    def supported_features(self) -> int:
+        """Flag supported features."""
+        return SUPPORT_SET_SPEED
+
+    @property
+    def speed_list(self) -> list:
+        """Get the list of available speeds."""
+        return SPEED_LIST
+
+    @property
+    def speed(self) -> str:
+        """Return the current speed."""
+        return self._state
+
+    @property
+    def is_on(self) -> bool:
+        """Return true if entity is on."""
+        if self._state == STATE_UNKNOWN:
+            return False
+        return self._state != SPEED_OFF
+
+    @asyncio.coroutine
+    def async_turn_on(self, speed: str = None, **kwargs) -> None:
+        """Turn the entity on."""
+        if speed is None:
+            speed = SPEED_MEDIUM
+
+        yield from self.async_set_speed(speed)
+
+    @asyncio.coroutine
+    def async_turn_off(self, **kwargs) -> None:
+        """Turn the entity off."""
+        yield from self.async_set_speed(SPEED_OFF)
+
+    @asyncio.coroutine
+    def async_set_speed(self: FanEntity, speed: str) -> None:
+        """Set the speed of the fan."""
+        yield from self._endpoint.fan.write_attributes({
+            'fan_mode': SPEED_TO_VALUE[speed]})
+
+        self._state = speed
+        self.async_schedule_update_ha_state()
+
+    @asyncio.coroutine
+    def async_update(self):
+        """Retrieve latest state."""
+        result = yield from zha.safe_read(self._endpoint.fan, ['fan_mode'])
+        new_value = result.get('fan_mode', None)
+        self._state = VALUE_TO_SPEED.get(new_value, STATE_UNKNOWN)
+
+    @property
+    def should_poll(self) -> bool:
+        """Return True if entity has to be polled for state.
+
+        False if entity pushes its state to HA.
+        """
+        return False

homeassistant/components/zha/const.py

@@ -36,6 +36,7 @@ def populate_data():
         zcl.clusters.measurement.RelativeHumidity: 'sensor',
         zcl.clusters.measurement.TemperatureMeasurement: 'sensor',
         zcl.clusters.security.IasZone: 'binary_sensor',
+        zcl.clusters.hvac.Fan: 'fan',
     })
 
     # A map of hass components to all Zigbee clusters it could use