From e2bb3b559207a96484bba0a269b0755bb7873fad Mon Sep 17 00:00:00 2001 From: Richard Mann Date: Thu, 9 Apr 2026 11:03:33 +1000 Subject: [PATCH] feat: refactor to a hub model --- .../hunterdouglas_powerview_ble/__init__.py | 208 ++++++-- .../binary_sensor.py | 23 +- .../hunterdouglas_powerview_ble/button.py | 22 +- .../config_flow.py | 485 ++++-------------- .../hunterdouglas_powerview_ble/const.py | 4 + .../coordinator.py | 5 +- .../hunterdouglas_powerview_ble/cover.py | 21 +- .../hunterdouglas_powerview_ble/manifest.json | 2 +- .../hunterdouglas_powerview_ble/number.py | 15 +- .../hunterdouglas_powerview_ble/sensor.py | 23 +- .../hunterdouglas_powerview_ble/strings.json | 54 +- .../translations/en.json | 51 +- 12 files changed, 357 insertions(+), 556 deletions(-) diff --git a/custom_components/hunterdouglas_powerview_ble/__init__.py b/custom_components/hunterdouglas_powerview_ble/__init__.py index c3a6d2f..f0da803 100644 --- a/custom_components/hunterdouglas_powerview_ble/__init__.py +++ b/custom_components/hunterdouglas_powerview_ble/__init__.py @@ -4,16 +4,33 @@ @license: Apache-2.0 license """ +import base64 +from collections.abc import Callable + +import aiohttp from bleak.backends.device import BLEDevice from bleak.exc import BleakError -from homeassistant.components.bluetooth import async_ble_device_from_address +from homeassistant.components import bluetooth +from homeassistant.components.bluetooth import ( + BluetoothCallbackMatcher, + BluetoothScanningMode, + BluetoothServiceInfoBleak, + async_ble_device_from_address, + async_discovered_service_info, +) from homeassistant.config_entries import ConfigEntry from homeassistant.const import Platform -from homeassistant.core import HomeAssistant -from homeassistant.exceptions import ConfigEntryError, ConfigEntryNotReady +from homeassistant.core import HomeAssistant, callback +from homeassistant.helpers.aiohttp_client import async_get_clientsession +from homeassistant.helpers.dispatcher import ( + async_dispatcher_connect, + async_dispatcher_send, +) +from homeassistant.helpers.entity_platform import AddEntitiesCallback -from .const import LOGGER +from .api import UUID_COV_SERVICE as UUID +from .const import CONF_HUB_URL, LOGGER, MFCT_ID, SIGNAL_NEW_SHADE from .coordinator import PVCoordinator PLATFORMS: list[Platform] = [ @@ -24,34 +41,157 @@ PLATFORMS: list[Platform] = [ Platform.SENSOR, ] -type ConfigEntryType = ConfigEntry[PVCoordinator] +type HubRuntimeData = dict[str, PVCoordinator] +type ConfigEntryType = ConfigEntry[HubRuntimeData] + +type AddEntitiesFn = Callable[[PVCoordinator, AddEntitiesCallback], None] + + +def async_setup_shade_platform( + hass: HomeAssistant, + config_entry: ConfigEntryType, + async_add_entities: AddEntitiesCallback, + add_fn: AddEntitiesFn, +) -> None: + """Set up a platform for all current and future shades.""" + for coordinator in config_entry.runtime_data.values(): + add_fn(coordinator, async_add_entities) + + @callback + def _async_new_shade(coordinator: PVCoordinator) -> None: + add_fn(coordinator, async_add_entities) + + config_entry.async_on_unload( + async_dispatcher_connect( + hass, + SIGNAL_NEW_SHADE.format(entry_id=config_entry.entry_id), + _async_new_shade, + ) + ) + + +async def _fetch_shade_names( + hass: HomeAssistant, hub_url: str +) -> dict[str, str]: + """Fetch BLE name -> friendly name mapping from the hub. + + Returns empty dict on failure. + """ + session = async_get_clientsession(hass) + timeout = aiohttp.ClientTimeout(total=10) + try: + async with session.get(f"{hub_url}/home/shades", timeout=timeout) as resp: + resp.raise_for_status() + shades = await resp.json(content_type=None) + except (TimeoutError, aiohttp.ClientError, ValueError): + return {} + + names: dict[str, str] = {} + for shade in shades or []: + ble_name = shade.get("bleName", "") + if not ble_name: + continue + name_b64 = shade.get("name", "") + try: + name = base64.b64decode(name_b64).decode("utf-8") if name_b64 else ble_name + except Exception: # noqa: BLE001 + name = ble_name + names[ble_name] = name + return names + + +async def _async_setup_shade( + hass: HomeAssistant, + entry: ConfigEntryType, + service_info: BluetoothServiceInfoBleak, + shade_names: dict[str, str], +) -> None: + """Create a coordinator for a newly discovered shade.""" + address = service_info.address + + if address in entry.runtime_data: + return + + ble_device: BLEDevice | None = async_ble_device_from_address( + hass=hass, address=address, connectable=True + ) + if not ble_device: + LOGGER.debug("BLE device %s not connectable, skipping", address) + return + + friendly_name = shade_names.get(service_info.name, service_info.name) + + coordinator = PVCoordinator( + hass, ble_device, entry.data.copy(), friendly_name + ) + + entry.runtime_data[address] = coordinator + entry.async_on_unload(coordinator.async_start()) + + async_dispatcher_send( + hass, + SIGNAL_NEW_SHADE.format(entry_id=entry.entry_id), + coordinator, + ) + + # Query device info in background — don't block entry setup + try: + await coordinator.query_dev_info() + except BleakError: + LOGGER.warning( + "Could not query device info for %s (%s)", + friendly_name, + address, + ) async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntryType) -> bool: - """Set up BT Battery Management System from a config entry.""" + """Set up PowerView Home from a config entry.""" LOGGER.debug("Setup of %s", repr(entry)) - if entry.unique_id is None: - raise ConfigEntryError("Missing unique ID for device.") + entry.runtime_data = {} - ble_device: BLEDevice | None = async_ble_device_from_address( - hass=hass, address=entry.unique_id, connectable=True + # Resolve shade friendly names from hub if available + hub_url = entry.data.get(CONF_HUB_URL, "") + shade_names: dict[str, str] = {} + if hub_url: + shade_names = await _fetch_shade_names(hass, hub_url) + + # Forward platforms first so dispatched entities have their setup ready + await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS) + + # Kick off shade setup for already-discovered BLE devices (non-blocking) + for service_info in async_discovered_service_info(hass, connectable=True): + if ( + MFCT_ID in service_info.manufacturer_data + and UUID in service_info.service_uuids + ): + hass.async_create_task( + _async_setup_shade(hass, entry, service_info, shade_names) + ) + + # Register for future BLE discoveries + def _async_discovered_device( + service_info: BluetoothServiceInfoBleak, + change: bluetooth.BluetoothChange, + ) -> None: + if service_info.address not in entry.runtime_data: + hass.async_create_task( + _async_setup_shade(hass, entry, service_info, shade_names) + ) + + entry.async_on_unload( + bluetooth.async_register_callback( + hass, + _async_discovered_device, + BluetoothCallbackMatcher( + service_uuid=UUID, + manufacturer_id=MFCT_ID, + ), + BluetoothScanningMode.ACTIVE, + ) ) - if not ble_device: - raise ConfigEntryNotReady( - f"Could not find PowerView device ({entry.unique_id}) via Bluetooth" - ) - - coordinator = PVCoordinator(hass, ble_device, entry.data.copy(), entry.title) - try: - await coordinator.query_dev_info() - except BleakError as err: - raise ConfigEntryNotReady("Unable to query device info.") from err - - entry.runtime_data = coordinator - await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS) - entry.async_on_unload(coordinator.async_start()) return True @@ -59,20 +199,10 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntryType) -> boo """Unload a config entry.""" unload_ok = await hass.config_entries.async_unload_platforms(entry, PLATFORMS) + if unload_ok: + for coordinator in entry.runtime_data.values(): + coordinator._async_stop() # noqa: SLF001 + entry.runtime_data.clear() + LOGGER.debug("Unloaded config entry: %s, ok? %s!", entry.unique_id, str(unload_ok)) return unload_ok - - -async def async_migrate_entry( - _hass: HomeAssistant, config_entry: ConfigEntryType -) -> bool: - """Migrate old entry.""" - - if config_entry.version > 1: - # This means the user has downgraded from a future version - LOGGER.debug("Cannot downgrade from version %s", config_entry.version) - return False - - LOGGER.debug("Migrating from version %s", config_entry.version) - - return False diff --git a/custom_components/hunterdouglas_powerview_ble/binary_sensor.py b/custom_components/hunterdouglas_powerview_ble/binary_sensor.py index 7749300..e487b67 100644 --- a/custom_components/hunterdouglas_powerview_ble/binary_sensor.py +++ b/custom_components/hunterdouglas_powerview_ble/binary_sensor.py @@ -13,7 +13,7 @@ from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import format_mac from homeassistant.helpers.entity_platform import AddEntitiesCallback -from . import ConfigEntryType +from . import ConfigEntryType, async_setup_shade_platform from .const import DOMAIN from .coordinator import PVCoordinator @@ -26,18 +26,25 @@ BINARY_SENSOR_TYPES: list[BinarySensorEntityDescription] = [ ] +def _add_entities( + coordinator: PVCoordinator, async_add_entities: AddEntitiesCallback +) -> None: + """Create binary sensor entities for a single shade coordinator.""" + async_add_entities( + [ + PVBinarySensor(coordinator, descr, format_mac(coordinator.address)) + for descr in BINARY_SENSOR_TYPES + ] + ) + + async def async_setup_entry( - _hass: HomeAssistant, + hass: HomeAssistant, config_entry: ConfigEntryType, async_add_entities: AddEntitiesCallback, ) -> None: """Add sensors for passed config_entry in Home Assistant.""" - - coord: PVCoordinator = config_entry.runtime_data - for descr in BINARY_SENSOR_TYPES: - async_add_entities( - [PVBinarySensor(coord, descr, format_mac(config_entry.unique_id))] - ) + async_setup_shade_platform(hass, config_entry, async_add_entities, _add_entities) class PVBinarySensor( diff --git a/custom_components/hunterdouglas_powerview_ble/button.py b/custom_components/hunterdouglas_powerview_ble/button.py index bf7649b..6826126 100644 --- a/custom_components/hunterdouglas_powerview_ble/button.py +++ b/custom_components/hunterdouglas_powerview_ble/button.py @@ -10,12 +10,12 @@ from homeassistant.components.button import ( ButtonEntity, ButtonEntityDescription, ) -from homeassistant.config_entries import ConfigEntry from homeassistant.const import EntityCategory from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import DeviceInfo, format_mac from homeassistant.helpers.entity_platform import AddEntitiesCallback +from . import ConfigEntryType, async_setup_shade_platform from .const import DOMAIN, LOGGER from .coordinator import PVCoordinator @@ -28,16 +28,22 @@ BUTTONS_SHADE: Final = [ ] +def _add_entities( + coordinator: PVCoordinator, async_add_entities: AddEntitiesCallback +) -> None: + """Create button entities for a single shade coordinator.""" + async_add_entities( + [PowerViewButton(coordinator, descr) for descr in BUTTONS_SHADE] + ) + + async def async_setup_entry( - _hass: HomeAssistant, - config_entry: ConfigEntry, + hass: HomeAssistant, + config_entry: ConfigEntryType, async_add_entities: AddEntitiesCallback, ) -> None: - """Set up the demo cover platform.""" - - coordinator: PVCoordinator = config_entry.runtime_data - for descr in BUTTONS_SHADE: - async_add_entities([PowerViewButton(coordinator, descr)]) + """Set up the button platform.""" + async_setup_shade_platform(hass, config_entry, async_add_entities, _add_entities) class PowerViewButton(PassiveBluetoothCoordinatorEntity[PVCoordinator], ButtonEntity): # type: ignore[reportIncompatibleVariableOverride] diff --git a/custom_components/hunterdouglas_powerview_ble/config_flow.py b/custom_components/hunterdouglas_powerview_ble/config_flow.py index 6c88d50..a0116c9 100644 --- a/custom_components/hunterdouglas_powerview_ble/config_flow.py +++ b/custom_components/hunterdouglas_powerview_ble/config_flow.py @@ -1,9 +1,6 @@ -"""Config flow for BLE Battery Management System integration.""" +"""Config flow for Hunter Douglas PowerView BLE integration.""" -import asyncio -import base64 -import contextlib -from dataclasses import dataclass +import hashlib import struct from typing import Any @@ -11,12 +8,8 @@ import aiohttp import voluptuous as vol from homeassistant import config_entries -from homeassistant.components.bluetooth import ( - BluetoothServiceInfoBleak, - async_discovered_service_info, -) +from homeassistant.components.bluetooth import BluetoothServiceInfoBleak from homeassistant.config_entries import ConfigFlowResult -from homeassistant.const import CONF_ADDRESS from homeassistant.core import HomeAssistant from homeassistant.helpers.aiohttp_client import async_get_clientsession from homeassistant.helpers.selector import ( @@ -28,32 +21,78 @@ from homeassistant.helpers.selector import ( TextSelectorType, ) -from .api import UUID_COV_SERVICE as UUID -from .const import CONF_HOME_KEY, DOMAIN, LOGGER, MFCT_ID +from .const import CONF_HOME_KEY, CONF_HUB_URL, DOMAIN, LOGGER -def _needs_encryption(manufacturer_data_hex: str) -> bool: - """Return True if the BLE advertisement indicates encryption (home_id != 0).""" - data = bytearray.fromhex(manufacturer_data_hex) - if len(data) < 2: - return False - home_id = int.from_bytes(data[0:2], byteorder="little") - return home_id != 0 +def _hub_unique_id(home_key: str) -> str: + """Derive a stable unique ID for a hub entry from the home key.""" + if home_key: + digest = hashlib.sha256(home_key.encode()).hexdigest()[:16] + return f"pvhome_{digest}" + return "pvhome_unencrypted" -@dataclass -class HubShadeInfo: - """Shade metadata from the PowerView hub.""" +def _parse_key_response(ble_name: str, result: dict) -> bytes | None: # noqa: PLR0911 + """Parse a shade exec response and return the 16-byte key, or None.""" + if result.get("err"): + err_msg = (result.get("responses") or [{}])[0].get("errMsg", "unknown") + LOGGER.warning( + "Shade %s: hub BLE command failed (err=%s: %s)", + ble_name, + result["err"], + err_msg, + ) + return None - name: str # Human-readable name (decoded from base64) - ble_name: str # BLE advertisement name, e.g. "DUE:94ED" + responses = result.get("responses", []) + if len(responses) != 1 or "hex" not in responses[0]: + LOGGER.warning( + "Shade %s returned unexpected response structure: %s", + ble_name, + result, + ) + return None + + response_bytes = bytes.fromhex(responses[0]["hex"]) + if len(response_bytes) < 5: + LOGGER.warning( + "Shade %s response too short (%d bytes)", ble_name, len(response_bytes) + ) + return None + _s, _c, _q, length = struct.unpack(" list[HubShadeInfo]: - """Fetch shade list with human-readable names from a PowerView G3 hub. +) -> bytes: + """Fetch 16-byte homekey from a PowerView G3 hub. + Tries each shade on the hub until one returns a valid key. + The key is network-wide so any reachable shade returns the same value. + + Raises ValueError on protocol/key errors. Raises aiohttp.ClientError on network errors. Raises asyncio.TimeoutError on timeout. """ @@ -65,76 +104,33 @@ async def _fetch_shades_from_hub( shades = await resp.json(content_type=None) if not shades: - return [] - - hub_shades: list[HubShadeInfo] = [] - for shade in shades: - ble_name = shade.get("bleName", "") - if not ble_name: - continue - name_b64 = shade.get("name", "") - try: - name = base64.b64decode(name_b64).decode("utf-8") if name_b64 else ble_name - except Exception: # noqa: BLE001 - name = ble_name - hub_shades.append(HubShadeInfo(name=name, ble_name=ble_name)) - return hub_shades - - -async def _fetch_key_and_shades_from_hub( - hass: HomeAssistant, hub_url: str -) -> tuple[bytes, list[HubShadeInfo]]: - """Fetch 16-byte homekey and shade list from a PowerView G3 hub. - - Returns (key, shade_list). The key is network-wide so any reachable shade - returns the same value. The shade list contains human-readable names that - can be used to label BLE-discovered devices. - - Raises ValueError on protocol/key errors. - Raises aiohttp.ClientError on network errors. - Raises asyncio.TimeoutError on timeout. - """ - hub_shades = await _fetch_shades_from_hub(hass, hub_url) - if not hub_shades: raise ValueError("No shades found on the hub") - session = async_get_clientsession(hass) - timeout = aiohttp.ClientTimeout(total=10) + ble_names = [s.get("bleName", "") for s in shades if s.get("bleName")] + if not ble_names: + raise ValueError("No BLE-capable shades found on the hub") # GetShadeKey BLE request: sid=251, cid=18, seqId=1, data_len=0 request_frame = struct.pack(" None: """Initialize the config flow.""" - - self._discovered_device: ConfigFlow.DiscoveredDevice | None = None - self._discovered_devices: dict[str, ConfigFlow.DiscoveredDevice] = {} - self._manufacturer_data_hex: str = "" - self._device_name: str = "" self._home_key: str = "" self._hub_url: str = "" - self._hub_shades: list[HubShadeInfo] = [] def _create_entry(self) -> ConfigFlowResult: - """Create the config entry with collected data.""" - data: dict[str, str] = { - "manufacturer_data": self._manufacturer_data_hex, - CONF_HOME_KEY: self._home_key, - } + """Create the hub config entry.""" + data: dict[str, str] = {CONF_HOME_KEY: self._home_key} if self._hub_url: - data["hub_url"] = self._hub_url - return self.async_create_entry( - title=self._device_name, - data=data, - ) + data[CONF_HUB_URL] = self._hub_url + return self.async_create_entry(title="PowerView Home", data=data) def _validate_manual_key( self, user_input: dict[str, Any], errors: dict[str, str] ) -> bool: - """Validate a manually entered hex key and store it. + """Validate a manually entered hex key. Returns True on success, False on validation error. """ @@ -233,7 +210,6 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN): """Parse and validate homekey user_input, populating self state. Returns True on success, False on validation error (errors dict is populated). - On skip, self._home_key is set to "". """ method = user_input.get("key_method", "skip") @@ -247,7 +223,7 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN): if method != "hub": return False - hub_url = user_input.get("hub_url", "").rstrip("/") + hub_url = user_input.get(CONF_HUB_URL, "").rstrip("/") _HUB_ERROR_MAP: dict[type[Exception], str] = { aiohttp.ClientResponseError: "hub_http_error", aiohttp.ClientConnectionError: "hub_connection_error", @@ -255,14 +231,14 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN): ValueError: "hub_protocol_error", } try: - key, hub_shades = await _fetch_key_and_shades_from_hub(self.hass, hub_url) + key = await _fetch_key_from_hub(self.hass, hub_url) except tuple(_HUB_ERROR_MAP) as ex: - errors["hub_url"] = _HUB_ERROR_MAP[type(ex)] + LOGGER.warning("Hub key fetch failed: %s", ex) + errors[CONF_HUB_URL] = _HUB_ERROR_MAP[type(ex)] return False self._home_key = key.hex() self._hub_url = hub_url - self._hub_shades = hub_shades return True async def async_step_bluetooth( @@ -271,296 +247,45 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN): """Handle a flow initialized by Bluetooth discovery.""" LOGGER.debug("Bluetooth device detected: %s", discovery_info) + # Tag the flow with this address so HA deduplicates future + # discovery flows for the same device await self.async_set_unique_id(discovery_info.address) - self._abort_if_unique_id_configured() - self._discovered_device = ConfigFlow.DiscoveredDevice( - discovery_info.name, discovery_info - ) - self.context["title_placeholders"] = {"name": self._discovered_device.name} - return await self.async_step_bluetooth_confirm() - - async def async_step_bluetooth_confirm( - self, user_input: dict[str, Any] | None = None - ) -> ConfigFlowResult: - """Confirm bluetooth device discovery.""" - assert self._discovered_device is not None - LOGGER.debug("confirm step for %s", self._discovered_device.name) - - if user_input is not None: - self._manufacturer_data_hex = ( - self._discovered_device.discovery_info.manufacturer_data[MFCT_ID].hex() - ) - self._device_name = self._discovered_device.name - - # Unencrypted shades can skip the homekey step entirely - if not _needs_encryption(self._manufacturer_data_hex): - await self._resolve_friendly_name() - return self._create_entry() - - return await self.async_step_homekey_bluetooth() - - self._set_confirm_only() - - return self.async_show_form( - step_id="bluetooth_confirm", - description_placeholders={"name": self._discovered_device.name}, - ) - - async def async_step_homekey_bluetooth( - self, user_input: dict[str, Any] | None = None - ) -> ConfigFlowResult: - """Configure homekey for a shade discovered via Bluetooth.""" - # Reuse an existing key if another shade was already configured - existing = self._existing_home_key() - if existing and user_input is None: - self._home_key = existing - await self._resolve_friendly_name() - return self._create_entry() - - errors: dict[str, str] = {} - - if user_input is not None and await self._validate_homekey_input( - user_input, errors - ): - # Use hub name for the entry title if available - friendly = self._hub_name_for(self._device_name) - if friendly: - self._device_name = friendly - return self._create_entry() - - return self.async_show_form( - step_id="homekey_bluetooth", - data_schema=_HOMEKEY_SCHEMA, - errors=errors, - description_placeholders={ - "name": self._device_name, - "hub_url_example": "http://powerview-g3.local", - }, - ) - - def _existing_entry_value(self, key: str) -> str: - """Return the first non-empty value for *key* across configured entries.""" + # If a hub entry already exists, shades are auto-discovered for entry in self._async_current_entries(): - if value := entry.data.get(key, ""): - return value - return "" + if entry.version >= 2: + return self.async_abort(reason="already_configured") - def _existing_home_key(self) -> str: - """Return the home_key from any already-configured entry, or ''.""" - return self._existing_entry_value(CONF_HOME_KEY) - - async def _resolve_friendly_name(self) -> None: - """Try to resolve BLE device name to hub friendly name.""" - hub_url = self._hub_url or self._existing_entry_value("hub_url") - if not hub_url: - return - try: - shades = await _fetch_shades_from_hub(self.hass, hub_url) - for hs in shades: - if hs.ble_name == self._device_name: - self._device_name = hs.name - break - if not self._hub_url: - self._hub_url = hub_url - except (TimeoutError, aiohttp.ClientError, ValueError): - pass - - def _hub_name_for(self, ble_name: str) -> str | None: - """Return the human-readable hub name for a BLE name, or None.""" - for hs in self._hub_shades: - if hs.ble_name == ble_name: - return hs.name - return None + # No hub entry yet — redirect to user setup + return await self.async_step_user() async def async_step_user( self, user_input: dict[str, Any] | None = None ) -> ConfigFlowResult: - """Handle the user step — reuse existing key or offer a menu.""" + """Handle the user step — create a hub entry.""" LOGGER.debug("user step") - existing = self._existing_home_key() - if existing: - self._home_key = existing - self._hub_url = self._hub_url or self._existing_entry_value("hub_url") - if self._hub_url and not self._hub_shades: - with contextlib.suppress( - TimeoutError, aiohttp.ClientError, ValueError - ): - self._hub_shades = await _fetch_shades_from_hub( - self.hass, self._hub_url - ) - return self.async_show_menu( - step_id="user", - menu_options=["select_device", "manual"], - ) - return await self.async_step_homekey() - def _build_selected_entries( - self, user_input: dict[str, Any] - ) -> list[dict[str, Any]]: - """Build config entry data for each selected shade address.""" - addresses: list[str] = user_input[CONF_ADDRESS] - if isinstance(addresses, str): - addresses = [addresses] + # Only one hub entry allowed (per key, but for simplicity one total) + for entry in self._async_current_entries(): + if entry.version >= 2: + return self.async_abort(reason="single_instance_allowed") - entries: list[dict[str, Any]] = [] - for address in addresses: - device = self._discovered_devices[address] - ble_name = device.name - name = self._hub_name_for(ble_name) or ble_name - mfct_hex = device.discovery_info.manufacturer_data[MFCT_ID].hex() - entry_data: dict[str, str] = { - "manufacturer_data": mfct_hex, - CONF_HOME_KEY: self._home_key, - } - if self._hub_url: - entry_data["hub_url"] = self._hub_url - entries.append( - { - "address": address, - "name": name, - "data": entry_data, - } - ) - return entries - - async def async_step_select_device( - self, user_input: dict[str, Any] | None = None - ) -> ConfigFlowResult: - """Select one or more BLE-discovered shades, or fall through to manual.""" - LOGGER.debug("select_device step") - - if user_input is not None: - entries = self._build_selected_entries(user_input) - - # Kick off auto-add flows for all but the last shade - await asyncio.gather( - *( - self.hass.config_entries.flow.async_init( - DOMAIN, - context={"source": "auto_add"}, - data=info, - ) - for info in entries[:-1] - ) - ) - - # Create the final entry normally (ends this flow) - last = entries[-1] - await self.async_set_unique_id(last["address"], raise_on_progress=False) - self._abort_if_unique_id_configured() - self._device_name = last["name"] - self._manufacturer_data_hex = last["data"]["manufacturer_data"] - self.context["title_placeholders"] = {"name": self._device_name} - return self._create_entry() - - current_addresses = self._async_current_ids() - for discovery_info in async_discovered_service_info(self.hass, False): - address = discovery_info.address - if address in current_addresses or address in self._discovered_devices: - continue - - if MFCT_ID not in discovery_info.manufacturer_data: - continue - - if UUID not in discovery_info.service_uuids: - continue - - self._discovered_devices[address] = ConfigFlow.DiscoveredDevice( - discovery_info.name, discovery_info - ) - - if not self._discovered_devices: - return await self.async_step_manual() - - titles: list[SelectOptionDict] = [] - for address, discovery in self._discovered_devices.items(): - hub_name = self._hub_name_for(discovery.name) - label = f"{hub_name} ({discovery.name})" if hub_name else discovery.name - titles.append({"value": address, "label": label}) - - return self.async_show_form( - step_id="select_device", - data_schema=vol.Schema( - { - vol.Required(CONF_ADDRESS): SelectSelector( - SelectSelectorConfig(options=titles, multiple=True) - ) - } - ), - ) - - async def async_step_auto_add( - self, discovery_info: dict[str, Any] - ) -> ConfigFlowResult: - """Handle a shade queued from multi-select for individual setup.""" - await self.async_set_unique_id(discovery_info["address"]) - self._abort_if_unique_id_configured() - - self._device_name = discovery_info["name"] - self._manufacturer_data_hex = discovery_info["data"]["manufacturer_data"] - self._home_key = discovery_info["data"].get(CONF_HOME_KEY, "") - self._hub_url = discovery_info["data"].get("hub_url", "") - - self.context["title_placeholders"] = {"name": self._device_name} - return await self.async_step_auto_add_confirm() - - async def async_step_auto_add_confirm( - self, user_input: dict[str, Any] | None = None - ) -> ConfigFlowResult: - """Confirm adding a shade discovered via multi-select.""" - if user_input is not None: - return self._create_entry() - - self._set_confirm_only() - return self.async_show_form( - step_id="auto_add_confirm", - description_placeholders={"name": self._device_name}, - ) - - async def async_step_manual( - self, user_input: dict[str, Any] | None = None - ) -> ConfigFlowResult: - """Handle manual entry of a BLE device address and name.""" - if user_input is not None: - address = user_input[CONF_ADDRESS].upper().strip() - self._device_name = user_input["ble_name"].strip() - await self.async_set_unique_id(address, raise_on_progress=False) - self._abort_if_unique_id_configured() - self.context["title_placeholders"] = {"name": self._device_name} - self._manufacturer_data_hex = "" - return self._create_entry() - - return self.async_show_form( - step_id="manual", - data_schema=vol.Schema( - { - vol.Required(CONF_ADDRESS): TextSelector( - TextSelectorConfig(type=TextSelectorType.TEXT) - ), - vol.Required("ble_name"): TextSelector( - TextSelectorConfig(type=TextSelectorType.TEXT) - ), - } - ), - ) - - async def async_step_homekey( - self, user_input: dict[str, Any] | None = None - ) -> ConfigFlowResult: - """Configure homekey — collected before device selection.""" errors: dict[str, str] = {} if user_input is not None and await self._validate_homekey_input( user_input, errors ): - return await self.async_step_select_device() + unique_id = _hub_unique_id(self._home_key) + await self.async_set_unique_id(unique_id, raise_on_progress=False) + self._abort_if_unique_id_configured() + return self._create_entry() return self.async_show_form( - step_id="homekey", + step_id="user", data_schema=_HOMEKEY_SCHEMA, errors=errors, description_placeholders={ "hub_url_example": "http://powerview-g3.local", }, ) + diff --git a/custom_components/hunterdouglas_powerview_ble/const.py b/custom_components/hunterdouglas_powerview_ble/const.py index 0e02520..f8b0c1b 100644 --- a/custom_components/hunterdouglas_powerview_ble/const.py +++ b/custom_components/hunterdouglas_powerview_ble/const.py @@ -9,6 +9,10 @@ MFCT_ID: Final[int] = 2073 TIMEOUT: Final[int] = 5 CONF_HOME_KEY: Final[str] = "home_key" +CONF_HUB_URL: Final[str] = "hub_url" + +# dispatcher signal for newly discovered shades (format with entry_id) +SIGNAL_NEW_SHADE: Final[str] = f"{DOMAIN}_new_shade_{{entry_id}}" # attributes (do not change) ATTR_RSSI: Final[str] = "rssi" diff --git a/custom_components/hunterdouglas_powerview_ble/coordinator.py b/custom_components/hunterdouglas_powerview_ble/coordinator.py index 10aabb8..0fb07d5 100644 --- a/custom_components/hunterdouglas_powerview_ble/coordinator.py +++ b/custom_components/hunterdouglas_powerview_ble/coordinator.py @@ -54,10 +54,11 @@ class PVCoordinator(PassiveBluetoothDataUpdateCoordinator): @property def type_id(self) -> int | None: - """Return the shade type ID from manufacturer data.""" + """Return the shade type ID from manufacturer data or live BLE data.""" if self._manuf_dat: return int(bytes.fromhex(self._manuf_dat)[2]) - return None + live = self.data.get("type_id") + return int(live) if live is not None else None @property def shade_capabilities(self) -> ShadeCapability: diff --git a/custom_components/hunterdouglas_powerview_ble/cover.py b/custom_components/hunterdouglas_powerview_ble/cover.py index 3d463d7..6cd8591 100644 --- a/custom_components/hunterdouglas_powerview_ble/cover.py +++ b/custom_components/hunterdouglas_powerview_ble/cover.py @@ -16,24 +16,20 @@ from homeassistant.components.cover import ( CoverEntity, CoverEntityFeature, ) -from homeassistant.config_entries import ConfigEntry from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import format_mac from homeassistant.helpers.entity_platform import AddEntitiesCallback +from . import ConfigEntryType, async_setup_shade_platform from .api import CLOSED_POSITION, OPEN_POSITION from .const import DOMAIN, LOGGER from .coordinator import PVCoordinator -async def async_setup_entry( - _hass: HomeAssistant, - config_entry: ConfigEntry, - async_add_entities: AddEntitiesCallback, +def _add_entities( + coordinator: PVCoordinator, async_add_entities: AddEntitiesCallback ) -> None: - """Set up the cover platform.""" - - coordinator: PVCoordinator = config_entry.runtime_data + """Create cover entities for a single shade coordinator.""" caps = coordinator.shade_capabilities if caps.tilt_only: @@ -46,6 +42,15 @@ async def async_setup_entry( async_add_entities(entities) +async def async_setup_entry( + hass: HomeAssistant, + config_entry: ConfigEntryType, + async_add_entities: AddEntitiesCallback, +) -> None: + """Set up the cover platform.""" + async_setup_shade_platform(hass, config_entry, async_add_entities, _add_entities) + + class PowerViewCover(PassiveBluetoothCoordinatorEntity[PVCoordinator], CoverEntity): # type: ignore[reportIncompatibleVariableOverride] """Representation of a PowerView shade with Up/Down functionality only.""" diff --git a/custom_components/hunterdouglas_powerview_ble/manifest.json b/custom_components/hunterdouglas_powerview_ble/manifest.json index 47a475c..9680d6b 100644 --- a/custom_components/hunterdouglas_powerview_ble/manifest.json +++ b/custom_components/hunterdouglas_powerview_ble/manifest.json @@ -11,7 +11,7 @@ "config_flow": true, "dependencies": ["bluetooth_adapters"], "documentation": "https://github.com/patman15/hdpv_ble", - "integration_type": "device", + "integration_type": "hub", "iot_class": "local_polling", "issue_tracker": "https://github.com/patman15/hdpv_ble/issues", "loggers": ["hunterdouglas_powerview_ble"], diff --git a/custom_components/hunterdouglas_powerview_ble/number.py b/custom_components/hunterdouglas_powerview_ble/number.py index 1d76d95..b92310c 100644 --- a/custom_components/hunterdouglas_powerview_ble/number.py +++ b/custom_components/hunterdouglas_powerview_ble/number.py @@ -9,20 +9,25 @@ from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import format_mac from homeassistant.helpers.entity_platform import AddEntitiesCallback -from . import ConfigEntryType +from . import ConfigEntryType, async_setup_shade_platform from .const import DOMAIN, LOGGER from .coordinator import PVCoordinator +def _add_entities( + coordinator: PVCoordinator, async_add_entities: AddEntitiesCallback +) -> None: + """Create velocity number entity for a single shade coordinator.""" + async_add_entities([PowerViewVelocity(coordinator)]) + + async def async_setup_entry( - _hass: HomeAssistant, + hass: HomeAssistant, config_entry: ConfigEntryType, async_add_entities: AddEntitiesCallback, ) -> None: """Set up the velocity number entity.""" - - coordinator: PVCoordinator = config_entry.runtime_data - async_add_entities([PowerViewVelocity(coordinator)]) + async_setup_shade_platform(hass, config_entry, async_add_entities, _add_entities) class PowerViewVelocity( diff --git a/custom_components/hunterdouglas_powerview_ble/sensor.py b/custom_components/hunterdouglas_powerview_ble/sensor.py index d19333d..124fc56 100644 --- a/custom_components/hunterdouglas_powerview_ble/sensor.py +++ b/custom_components/hunterdouglas_powerview_ble/sensor.py @@ -15,7 +15,7 @@ from homeassistant.core import HomeAssistant from homeassistant.helpers.device_registry import format_mac from homeassistant.helpers.entity_platform import AddEntitiesCallback -from . import ConfigEntryType +from . import ConfigEntryType, async_setup_shade_platform from .const import ATTR_RSSI, DOMAIN from .coordinator import PVCoordinator @@ -39,18 +39,25 @@ SENSOR_TYPES: list[SensorEntityDescription] = [ ] +def _add_entities( + coordinator: PVCoordinator, async_add_entities: AddEntitiesCallback +) -> None: + """Create sensor entities for a single shade coordinator.""" + async_add_entities( + [ + PVSensor(coordinator, descr, format_mac(coordinator.address)) + for descr in SENSOR_TYPES + ] + ) + + async def async_setup_entry( - _hass: HomeAssistant, + hass: HomeAssistant, config_entry: ConfigEntryType, async_add_entities: AddEntitiesCallback, ) -> None: """Add sensors for passed config_entry in Home Assistant.""" - - pv_dev: PVCoordinator = config_entry.runtime_data - for descr in SENSOR_TYPES: - async_add_entities( - [PVSensor(pv_dev, descr, format_mac(config_entry.unique_id))] - ) + async_setup_shade_platform(hass, config_entry, async_add_entities, _add_entities) class PVSensor(PassiveBluetoothCoordinatorEntity[PVCoordinator], SensorEntity): # type: ignore[reportIncompatibleMethodOverride] diff --git a/custom_components/hunterdouglas_powerview_ble/strings.json b/custom_components/hunterdouglas_powerview_ble/strings.json index 5e3e3e7..0fccf5e 100644 --- a/custom_components/hunterdouglas_powerview_ble/strings.json +++ b/custom_components/hunterdouglas_powerview_ble/strings.json @@ -1,24 +1,10 @@ { "config": { - "flow_title": "Setup {name}", + "flow_title": "PowerView Home Setup", "step": { "user": { - "title": "Add PowerView Shade", - "menu_options": { - "select_device": "Select from discovered shades", - "manual": "Enter device details manually" - }, - "menu_option_descriptions": { - "select_device": "Choose from shades detected via Bluetooth nearby.", - "manual": "Enter a Bluetooth MAC address and device name directly, for example if a shade is out of range of discovery." - } - }, - "bluetooth_confirm": { - "description": "[%key:component::bluetooth::config::step::bluetooth_confirm::description%]" - }, - "homekey": { - "title": "Configure HomeKey", - "description": "All shades on a PowerView network share the same encryption key. The recommended method is to fetch it from your G3 hub. You can also enter the key manually, or skip if your shades are unencrypted.", + "title": "Set up PowerView Home", + "description": "Configure your PowerView encryption key. All shades on your network will be discovered automatically via Bluetooth.", "data": { "key_method": "Key source", "hub_url": "PowerView hub URL", @@ -28,37 +14,6 @@ "hub_url": "Base URL of your PowerView G3 hub, e.g. {hub_url_example}", "home_key": "32-character hex string (e.g. 0102030405060708090a0b0c0d0e0f10) or \\x escaped format (e.g. \\x01\\x02...)" } - }, - "homekey_bluetooth": { - "title": "Configure HomeKey for {name}", - "description": "This shade uses encryption. The recommended method is to fetch the key from your G3 hub. You can also enter it manually, or skip (controls will be disabled until a key is configured).", - "data": { - "key_method": "Key source", - "hub_url": "PowerView hub URL", - "home_key": "HomeKey (32 hex characters or \\xNN format)" - }, - "data_description": { - "hub_url": "Base URL of your PowerView G3 hub, e.g. {hub_url_example}", - "home_key": "32-character hex string (e.g. 0102030405060708090a0b0c0d0e0f10) or \\x escaped format (e.g. \\x01\\x02...)" - } - }, - "auto_add_confirm": { - "description": "Do you want to set up {name}?" - }, - "select_device": { - "title": "Select Shades", - "description": "Select the PowerView shades to add via Bluetooth.", - "data": { - "address": "Shades" - } - }, - "manual": { - "title": "Enter Device Details", - "description": "Enter the device details manually.", - "data": { - "address": "Bluetooth MAC address (e.g. AA:BB:CC:DD:EE:FF)", - "ble_name": "BLE device name (e.g. DUE:94ED)" - } } }, "error": { @@ -71,8 +26,7 @@ }, "abort": { "already_configured": "[%key:common::config_flow::abort::already_configured_device%]", - "no_devices_found": "[%key:common::config_flow::abort::no_devices_found%]", - "not_supported": "Device not supported" + "single_instance_allowed": "[%key:common::config_flow::abort::single_instance_allowed%]" } } } diff --git a/custom_components/hunterdouglas_powerview_ble/translations/en.json b/custom_components/hunterdouglas_powerview_ble/translations/en.json index 7830431..4551c16 100644 --- a/custom_components/hunterdouglas_powerview_ble/translations/en.json +++ b/custom_components/hunterdouglas_powerview_ble/translations/en.json @@ -1,24 +1,10 @@ { "config": { - "flow_title": "Setup {name}", + "flow_title": "PowerView Home Setup", "step": { "user": { - "title": "Add PowerView Shade", - "menu_options": { - "select_device": "Select from discovered shades", - "manual": "Enter device details manually" - }, - "menu_option_descriptions": { - "select_device": "Choose from shades detected via Bluetooth nearby.", - "manual": "Enter a Bluetooth MAC address and device name directly, for example if a shade is out of range of discovery." - } - }, - "bluetooth_confirm": { - "description": "Do you want to set up {name}?" - }, - "homekey": { - "title": "Configure HomeKey", - "description": "All shades on a PowerView network share the same encryption key. The recommended method is to fetch it from your G3 hub. You can also enter the key manually, or skip if your shades are unencrypted.", + "title": "Set up PowerView Home", + "description": "Configure your PowerView encryption key. All shades on your network will be discovered automatically via Bluetooth.", "data": { "key_method": "Key source", "hub_url": "PowerView hub URL", @@ -28,34 +14,6 @@ "hub_url": "Base URL of your PowerView G3 hub, e.g. {hub_url_example}", "home_key": "32-character hex string (e.g. 0102030405060708090a0b0c0d0e0f10) or \\x escaped format (e.g. \\x01\\x02...)" } - }, - "homekey_bluetooth": { - "title": "Configure HomeKey for {name}", - "description": "This shade uses encryption. The recommended method is to fetch the key from your G3 hub. You can also enter it manually, or skip (controls will be disabled until a key is configured).", - "data": { - "key_method": "Key source", - "hub_url": "PowerView hub URL", - "home_key": "HomeKey (32 hex characters or \\xNN format)" - }, - "data_description": { - "hub_url": "Base URL of your PowerView G3 hub, e.g. {hub_url_example}", - "home_key": "32-character hex string (e.g. 0102030405060708090a0b0c0d0e0f10) or \\x escaped format (e.g. \\x01\\x02...)" - } - }, - "select_device": { - "title": "Select Shades", - "description": "Select the PowerView shades to add via Bluetooth.", - "data": { - "address": "Shades" - } - }, - "manual": { - "title": "Enter Device Details", - "description": "Enter the device details manually.", - "data": { - "address": "Bluetooth MAC address (e.g. AA:BB:CC:DD:EE:FF)", - "ble_name": "BLE device name (e.g. DUE:94ED)" - } } }, "error": { @@ -68,8 +26,7 @@ }, "abort": { "already_configured": "Device is already configured", - "no_devices_found": "No devices found on the network", - "not_supported": "Device not supported" + "single_instance_allowed": "Already configured. Only a single configuration possible." } } }