Merge pull request #734 from plugwise/better-timing

Set timeout based on discovered version

Author: bouwew

CHANGELOG.md

@@ -2,10 +2,11 @@
 
 ## Versions from 0.40 and up
 
-## Ongoing
+## v0.53.3
 
 - Test-code improvements.
 - Fix errors showing after Core 2023.9.3 release.
+- Set the connection-timeout based on the device discovered, 10s for actual devices, legacy devices require a 30s timeout.
 
 ## v0.53.2
 

custom_components/plugwise/__init__.py

@@ -8,7 +8,7 @@
 import voluptuous as vol  # pw-beta delete_notification
 
 from homeassistant.config_entries import ConfigEntry
-from homeassistant.const import Platform
+from homeassistant.const import CONF_TIMEOUT, Platform
 from homeassistant.core import (
     HomeAssistant,
     ServiceCall,  # pw-beta delete_notification
@@ -24,6 +24,7 @@
     SERVICE_DELETE,  # pw-beta delete_notifications
 )
 from .coordinator import PlugwiseDataUpdateCoordinator
+from .util import get_timeout_for_version
 
 type PlugwiseConfigEntry = ConfigEntry[PlugwiseDataUpdateCoordinator]
 
@@ -44,7 +45,8 @@ async def async_setup_entry(hass: HomeAssistant, entry: PlugwiseConfigEntry) ->
     )  # pw-beta - cooldown, update_interval as extra
     await coordinator.async_config_entry_first_refresh()
 
-    migrate_sensor_entities(hass, coordinator)
+    await async_migrate_sensor_entities(hass, coordinator)
+    await async_migrate_plugwise_entry(hass, coordinator, entry)
 
     entry.runtime_data = coordinator
 
@@ -123,7 +125,7 @@ def async_migrate_entity_entry(entry: er.RegistryEntry) -> dict[str, Any] | None
     # No migration needed
     return None
 
-def migrate_sensor_entities(
+async def async_migrate_sensor_entities(
     hass: HomeAssistant,
     coordinator: PlugwiseDataUpdateCoordinator,
 ) -> None:
@@ -143,3 +145,27 @@ def migrate_sensor_entities(
             new_unique_id = f"{device_id}-outdoor_air_temperature"
             # Upstream remove LOGGER debug
             ent_reg.async_update_entity(entity_id, new_unique_id=new_unique_id)
+
+async def async_migrate_plugwise_entry(
+    hass: HomeAssistant,
+    coordinator: PlugwiseDataUpdateCoordinator,
+    entry: ConfigEntry
+) -> bool:
+    """Migrate to new config entry."""
+    if entry.version > 1:
+        return False
+
+    if entry.version == 1 and entry.minor_version < 2:
+        new_data = {**entry.data}
+        new_data[CONF_TIMEOUT] = get_timeout_for_version(coordinator.api.smile_version)
+        hass.config_entries.async_update_entry(
+            entry, data=new_data, minor_version=2, version=1
+        )
+        LOGGER.debug(
+            "Migration to version %s.%s successful",
+            entry.version,
+            entry.minor_version,
+        )
+        return True
+
+    return False

custom_components/plugwise/config_flow.py

@@ -35,6 +35,7 @@
     CONF_PASSWORD,
     CONF_PORT,
     CONF_SCAN_INTERVAL,
+    CONF_TIMEOUT,
     CONF_USERNAME,
 )
 
@@ -50,6 +51,7 @@
     CONTEXT,
     DEFAULT_PORT,
     DEFAULT_SCAN_INTERVAL,  # pw-beta option
+    DEFAULT_TIMEOUT,
     DEFAULT_USERNAME,
     DOMAIN,
     FLOW_ID,
@@ -70,6 +72,7 @@
 
 # Upstream
 from .coordinator import PlugwiseDataUpdateCoordinator
+from .util import get_timeout_for_version
 
 type PlugwiseConfigEntry = ConfigEntry[PlugwiseDataUpdateCoordinator]
 
@@ -103,7 +106,6 @@ def _base_schema(
                 ),
             }
         )
-
     return vol.Schema({vol.Required(CONF_PASSWORD): str})
 
 
@@ -118,7 +120,7 @@ async def validate_input(hass: HomeAssistant, data: dict[str, Any]) -> Smile:
         password=data[CONF_PASSWORD],
         port=data[CONF_PORT],
         username=data[CONF_USERNAME],
-        timeout=30,
+        timeout=data[CONF_TIMEOUT],
         websession=websession,
     )
     await api.connect()
@@ -129,9 +131,11 @@ class PlugwiseConfigFlow(ConfigFlow, domain=DOMAIN):
     """Handle a config flow for Plugwise Smile."""
 
     VERSION = 1
+    MINOR_VERSION = 2
 
     discovery_info: ZeroconfServiceInfo | None = None
     _username: str = DEFAULT_USERNAME
+    _timeout: int = DEFAULT_TIMEOUT
 
     async def async_step_zeroconf(
         self, discovery_info: ZeroconfServiceInfo
@@ -147,9 +151,10 @@ async def async_step_zeroconf(
                     self.hass,
                     {
                         CONF_HOST: discovery_info.host,
+                        CONF_PASSWORD: config_entry.data[CONF_PASSWORD],
                         CONF_PORT: discovery_info.port,
                         CONF_USERNAME: config_entry.data[CONF_USERNAME],
-                        CONF_PASSWORD: config_entry.data[CONF_PASSWORD],
+                        CONF_TIMEOUT: self._timeout,
                     },
                 )
             except Exception:  # noqa: BLE001
@@ -168,6 +173,8 @@ async def async_step_zeroconf(
         _version = _properties.get(VERSION, "n/a")
         _name = f"{ZEROCONF_MAP.get(_product, _product)} v{_version}"
 
+        self._timeout = get_timeout_for_version(_version)
+
         # This is an Anna, but we already have config entries.
         # Assuming that the user has already configured Adam, aborting discovery.
         if self._async_current_entries() and _product == SMILE_THERMO:
@@ -200,6 +207,7 @@ async def async_step_zeroconf(
                     CONF_HOST: discovery_info.host,
                     CONF_NAME: _name,
                     CONF_PORT: discovery_info.port,
+                    CONF_TIMEOUT: self._timeout,
                     CONF_USERNAME: self._username,
                 },
                 ATTR_CONFIGURATION_URL: (
@@ -227,6 +235,8 @@ async def async_step_user(
             user_input[CONF_HOST] = self.discovery_info.host
             user_input[CONF_PORT] = self.discovery_info.port
             user_input[CONF_USERNAME] = self._username
+
+        user_input[CONF_TIMEOUT] = self._timeout
         try:
             api = await validate_input(self.hass, user_input)
         except ConnectionFailedError:
@@ -253,7 +263,6 @@ async def async_step_user(
             api.smile_hostname or api.gateway_id, raise_on_progress=False
         )
         self._abort_if_unique_id_configured()
-
         return self.async_create_entry(title=api.smile_name, data=user_input)
 
     @staticmethod
@@ -278,7 +287,6 @@ async def async_step_none(
         if user_input is not None:
             # Apparently not possible to abort an options flow at the moment
             return self.async_create_entry(title="", data=self._options)
-
         return self.async_show_form(step_id="none")
 
     async def async_step_init(
@@ -322,5 +330,4 @@ async def async_step_init(
                 ): vol.All(vol.Coerce(float), vol.Range(min=1.5, max=10.0)),
             }
         )  # pw-beta
-
         return self.async_show_form(step_id=INIT, data_schema=vol.Schema(data))

custom_components/plugwise/const.py

@@ -159,7 +159,7 @@
     "stretch": timedelta(seconds=60),
     "thermostat": timedelta(seconds=60),
 }
-DEFAULT_TIMEOUT: Final[int] = 10
+DEFAULT_TIMEOUT: Final[int] = 30
 DEFAULT_USERNAME: Final = "smile"
 
 # --- Const for Plugwise Smile and Stretch

custom_components/plugwise/coordinator.py

@@ -18,6 +18,7 @@
     CONF_PASSWORD,
     CONF_PORT,
     CONF_SCAN_INTERVAL,  # pw-beta options
+    CONF_TIMEOUT,
     CONF_USERNAME,
 )
 from homeassistant.core import HomeAssistant
@@ -30,6 +31,7 @@
 from .const import (
     DEFAULT_PORT,
     DEFAULT_SCAN_INTERVAL,
+    DEFAULT_TIMEOUT,
     DEFAULT_USERNAME,
     DOMAIN,
     GATEWAY_ID,
@@ -73,7 +75,7 @@ def __init__(
             username=self.config_entry.data.get(CONF_USERNAME, DEFAULT_USERNAME),
             password=self.config_entry.data[CONF_PASSWORD],
             port=self.config_entry.data.get(CONF_PORT, DEFAULT_PORT),
-            timeout=30,
+            timeout=self.config_entry.data.get(CONF_TIMEOUT, DEFAULT_TIMEOUT),
             websession=async_get_clientsession(hass, verify_ssl=False),
         )
         self._current_devices: set[str] = set()
@@ -115,21 +117,21 @@ async def _async_update_data(self) -> PlugwiseData:
             raise ConfigEntryError("Device with unsupported firmware") from err
         else:
             LOGGER.debug(f"{self.api.smile_name} data: %s", data)
-            self._async_add_remove_devices(data, self.config_entry)
+            await self.async_add_remove_devices(data, self.config_entry)
 
         return data
 
-    def _async_add_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
+    async def async_add_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
         """Add new Plugwise devices, remove non-existing devices."""
         # Check for new or removed devices
         self.new_devices = set(data.devices) - self._current_devices
         removed_devices = self._current_devices - set(data.devices)
         self._current_devices = set(data.devices)
 
         if removed_devices:
-            self._async_remove_devices(data, entry)
+            await self.async_remove_devices(data, entry)
 
-    def _async_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
+    async def async_remove_devices(self, data: PlugwiseData, entry: ConfigEntry) -> None:
         """Clean registries when removed devices found."""
         device_reg = dr.async_get(self.hass)
         device_list = dr.async_entries_for_config_entry(

custom_components/plugwise/manifest.json

@@ -8,6 +8,6 @@
   "iot_class": "local_polling",
   "loggers": ["plugwise"],
   "requirements": ["plugwise==1.4.0"],
-  "version": "0.53.2",
+  "version": "0.53.3",
   "zeroconf": ["_plugwise._tcp.local."]
 }

custom_components/plugwise/strings.json

@@ -19,8 +19,8 @@
   "config": {
     "step": {
       "user": {
-        "title": "Connect to the Plugwise Adam/Smile/Stretch",
-        "description": "Please enter:",
+        "title": "Set up Plugwise Adam/Smile/Stretch",
+        "description": "Enter your Plugwise device: (setup can take up to 90s)",
         "data": {
           "password": "ID",
           "username": "Username",

custom_components/plugwise/translations/en.json

@@ -19,8 +19,8 @@
   "config": {
     "step": {
       "user": {
-        "title": "Connect to the Plugwise Adam/Smile/Stretch",
-        "description": "Please enter:",
+        "title": "Set up Plugwise Adam/Smile/Stretch",
+        "description": "Enter your Plugwise device: (setup can take up to 90s)",
         "data": {
           "password": "ID",
           "username": "Username",

custom_components/plugwise/translations/nl.json

@@ -19,8 +19,8 @@
   "config": {
     "step": {
       "user": {
-        "title": "Verbinden met de Plugwise Adam/Smile/Stretch",
-        "description": "Aub invoeren:",
+        "title": "Installeer Plugwise Adam/Smile/Stretch",
+        "description": "Van uw Plugwise apparaat voer in: (installeren kan tot 90s duren)",
         "data": {
           "password": "ID",
           "username": "Gebruikersnaam",

custom_components/plugwise/util.py

@@ -8,7 +8,9 @@
 from plugwise.exceptions import PlugwiseException
 
 from homeassistant.exceptions import HomeAssistantError
+from packaging import version
 
+from .const import DEFAULT_TIMEOUT
 from .entity import PlugwiseEntity
 
 # For reference:
@@ -17,6 +19,17 @@
 # _P = ParamSpec("_P")
 
 
+def get_timeout_for_version(version_str: str) -> int:
+    """Determine timeout value based on gateway version.
+
+    A gateway firmware version > 3.2.0 should mean a latest-generation-device, allowing for a timeout of 10s.
+    Legacy devices require a timeout of 30s.
+    """
+    if version.parse(version_str) >= version.parse("3.2.0"):
+        return 10
+    return DEFAULT_TIMEOUT
+
+
 def plugwise_command[_PlugwiseEntityT: PlugwiseEntity, **_P, _R](
     func: Callable[Concatenate[_PlugwiseEntityT, _P], Awaitable[_R]],
 ) -> Callable[Concatenate[_PlugwiseEntityT, _P], Coroutine[Any, Any, _R]]: