Add support for topdown shades to hunterdouglas_powerview

.coveragerc

@@ -506,10 +506,13 @@ omit =
     homeassistant/components/huawei_lte/switch.py
     homeassistant/components/hue/light.py
     homeassistant/components/hunterdouglas_powerview/__init__.py
-    homeassistant/components/hunterdouglas_powerview/scene.py
-    homeassistant/components/hunterdouglas_powerview/sensor.py
+    homeassistant/components/hunterdouglas_powerview/coordinator.py
     homeassistant/components/hunterdouglas_powerview/cover.py
     homeassistant/components/hunterdouglas_powerview/entity.py
+    homeassistant/components/hunterdouglas_powerview/scene.py
+    homeassistant/components/hunterdouglas_powerview/sensor.py
+    homeassistant/components/hunterdouglas_powerview/shade_data.py
+    homeassistant/components/hunterdouglas_powerview/util.py
     homeassistant/components/hvv_departures/binary_sensor.py
     homeassistant/components/hvv_departures/sensor.py
     homeassistant/components/hvv_departures/__init__.py

CODEOWNERS

@@ -467,8 +467,8 @@ build.json @home-assistant/supervisor
 /tests/components/huisbaasje/ @dennisschroer
 /homeassistant/components/humidifier/ @home-assistant/core @Shulyaka
 /tests/components/humidifier/ @home-assistant/core @Shulyaka
-/homeassistant/components/hunterdouglas_powerview/ @bdraco @trullock
-/tests/components/hunterdouglas_powerview/ @bdraco @trullock
+/homeassistant/components/hunterdouglas_powerview/ @bdraco @kingy444 @trullock
+/tests/components/hunterdouglas_powerview/ @bdraco @kingy444 @trullock
 /homeassistant/components/hvv_departures/ @vigonotion
 /tests/components/hvv_departures/ @vigonotion
 /homeassistant/components/hydrawise/ @ptcryan

homeassistant/components/hunterdouglas_powerview/__init__.py

@@ -1,10 +1,8 @@
 """The Hunter Douglas PowerView integration."""
-from datetime import timedelta
 import logging
 
 from aiopvapi.helpers.aiorequest import AioRequest
 from aiopvapi.helpers.api_base import ApiEntryPoint
-from aiopvapi.helpers.constants import ATTR_ID
 from aiopvapi.helpers.tools import base64_to_unicode
 from aiopvapi.rooms import Rooms
 from aiopvapi.scenes import Scenes
@@ -14,11 +12,10 @@
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_HOST, Platform
-from homeassistant.core import HomeAssistant, callback
+from homeassistant.core import HomeAssistant
 from homeassistant.exceptions import ConfigEntryNotReady
 from homeassistant.helpers.aiohttp_client import async_get_clientsession
 import homeassistant.helpers.config_validation as cv
-from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
 
 from .const import (
     API_PATH_FWVERSION,
@@ -50,6 +47,9 @@
     SHADE_DATA,
     USER_DATA,
 )
+from .coordinator import PowerviewShadeUpdateCoordinator
+from .shade_data import PowerviewShadeData
+from .util import async_map_data_by_id
 
 PARALLEL_UPDATES = 1
 
@@ -64,7 +64,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 
     config = entry.data
 
-    hub_address = config.get(CONF_HOST)
+    hub_address = config[CONF_HOST]
     websession = async_get_clientsession(hass)
 
     pv_request = AioRequest(hub_address, loop=hass.loop, websession=websession)
@@ -75,17 +75,17 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
 
         async with async_timeout.timeout(10):
             rooms = Rooms(pv_request)
-            room_data = _async_map_data_by_id((await rooms.get_resources())[ROOM_DATA])
+            room_data = async_map_data_by_id((await rooms.get_resources())[ROOM_DATA])
 
         async with async_timeout.timeout(10):
             scenes = Scenes(pv_request)
-            scene_data = _async_map_data_by_id(
+            scene_data = async_map_data_by_id(
                 (await scenes.get_resources())[SCENE_DATA]
             )
 
         async with async_timeout.timeout(10):
             shades = Shades(pv_request)
-            shade_data = _async_map_data_by_id(
+            shade_data = async_map_data_by_id(
                 (await shades.get_resources())[SHADE_DATA]
             )
     except HUB_EXCEPTIONS as err:
@@ -95,24 +95,9 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     if not device_info:
         raise ConfigEntryNotReady(f"Unable to initialize PowerView hub: {hub_address}")
 
-    async def async_update_data():
-        """Fetch data from shade endpoint."""
-        async with async_timeout.timeout(10):
-            shade_entries = await shades.get_resources()
-        if not shade_entries:
-            raise UpdateFailed("Failed to fetch new shade data.")
-        return _async_map_data_by_id(shade_entries[SHADE_DATA])
-
-    coordinator = DataUpdateCoordinator(
-        hass,
-        _LOGGER,
-        name="powerview hub",
-        update_method=async_update_data,
-        update_interval=timedelta(seconds=60),
-    )
-
-    hass.data.setdefault(DOMAIN, {})
-    hass.data[DOMAIN][entry.entry_id] = {
+    coordinator = PowerviewShadeUpdateCoordinator(hass, shades, hub_address)
+    coordinator.async_set_updated_data(PowerviewShadeData())
+    hass.data.setdefault(DOMAIN, {})[entry.entry_id] = {
         PV_API: pv_request,
         PV_ROOM_DATA: room_data,
         PV_SCENE_DATA: scene_data,
@@ -155,12 +140,6 @@ async def async_get_device_info(pv_request):
     }
 
 
-@callback
-def _async_map_data_by_id(data):
-    """Return a dict with the key being the id for a list of entries."""
-    return {entry[ATTR_ID]: entry for entry in data}
-
-
 async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Unload a config entry."""
     unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)

homeassistant/components/hunterdouglas_powerview/const.py

@@ -7,7 +7,6 @@
 
 DOMAIN = "hunterdouglas_powerview"
 
-
 MANUFACTURER = "Hunter Douglas"
 
 HUB_ADDRESS = "address"
@@ -48,7 +47,6 @@
 ROOM_NAME_UNICODE = "name_unicode"
 ROOM_ID = "id"
 
-SHADE_RESPONSE = "shade"
 SHADE_BATTERY_LEVEL = "batteryStrength"
 SHADE_BATTERY_LEVEL_MAX = 200
 
@@ -81,5 +79,10 @@
     FIRMWARE_NAME: LEGACY_DEVICE_MODEL,
 }
 
-
 API_PATH_FWVERSION = "api/fwversion"
+
+POS_KIND_NONE = 0
+POS_KIND_PRIMARY = 1
+POS_KIND_SECONDARY = 2
+POS_KIND_VANE = 3
+POS_KIND_ERROR = 4

homeassistant/components/hunterdouglas_powerview/coordinator.py

@@ -0,0 +1,44 @@
+"""Coordinate data for powerview devices."""
+from __future__ import annotations
+
+from datetime import timedelta
+import logging
+
+from aiopvapi.shades import Shades
+import async_timeout
+
+from homeassistant.core import HomeAssistant
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+
+from .const import SHADE_DATA
+from .shade_data import PowerviewShadeData
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class PowerviewShadeUpdateCoordinator(DataUpdateCoordinator[PowerviewShadeData]):
+    """DataUpdateCoordinator to gather data from a powerview hub."""
+
+    def __init__(
+        self,
+        hass: HomeAssistant,
+        shades: Shades,
+        hub_address: str,
+    ) -> None:
+        """Initialize DataUpdateCoordinator to gather data for specific SmartPlug."""
+        self.shades = shades
+        super().__init__(
+            hass,
+            _LOGGER,
+            name=f"powerview hub {hub_address}",
+            update_interval=timedelta(seconds=60),
+        )
+
+    async def _async_update_data(self) -> PowerviewShadeData:
+        """Fetch data from shade endpoint."""
+        async with async_timeout.timeout(10):
+            shade_entries = await self.shades.get_resources()
+        if not shade_entries:
+            raise UpdateFailed("Failed to fetch new shade data")
+        self.data.store_group_data(shade_entries[SHADE_DATA])
+        return self.data