Add backhaul diagnostic sensors and polling control (#501)

* Add backhaul diagnostic sensors and polling control

* Update README.md

* Update en.json

* Update strings.json

* Update strings.json

Invalid string

* Update strings.json

* Update README.md

* Update __init__.py

* Update api.py

* Update binary_sensor.py

* Update sensor.py

* Fix pre-commit issues

Author: dkwolf1

README.md

@@ -1,3 +1,54 @@
+# TP-Link Deco (Community Fix)
+
+⚠️ This fork restores and extends compatibility with newer Home Assistant versions.
+
+The original repository is in maintenance mode and is no longer actively tested.
+This fork resolves compatibility issues and adds additional functionality.
+
+---
+
+## Added / Fixed in this fork
+
+- ✅ Fix for Home Assistant 2026.4 compatibility
+- ✅ Diagnostic entities (including backhaul speed and max speed)
+- ✅ Polling control:
+
+  - pause/resume services
+
+- switch entity to control polling from the UI
+- ✅ Improved stability when accessing the Deco web interface
+
+👉 Use this fork if the original integration no longer works or if you need extended diagnostics and control.
+
+---
+
+## Services / Switch
+
+Available services in Home Assistant:
+
+- `tplink_deco.pause_polling`
+- `tplink_deco.resume_polling`
+
+Available entity:
+
+- `switch.deco_polling`
+
+---
+
+## Polling Control
+
+Pause or resume polling to the Deco API.
+
+### Benefits
+
+- Reduces load on the Deco API by limiting continuous polling
+- Decreases network traffic and processing overhead
+- Improves debugging by allowing polling to be temporarily disabled
+- Helps prevent issues with limited concurrent sessions in the Deco web interface
+- Provides more control over integration behavior for advanced users
+
+This is especially useful when accessing the Deco web interface, as the API allows only a limited number of concurrent sessions.
+
 # TP-Link Deco
 
 [![GitHub Release][releases-shield]][releases]

custom_components/tplink_deco/__init__.py

@@ -49,7 +49,9 @@
 from .const import DEVICE_TYPE_DECO
 from .const import DOMAIN
 from .const import PLATFORMS
+from .const import SERVICE_PAUSE_POLLING
 from .const import SERVICE_REBOOT_DECO
+from .const import SERVICE_RESUME_POLLING
 from .coordinator import TpLinkDeco
 from .coordinator import TpLinkDecoClient
 from .coordinator import TpLinkDecoData
@@ -161,6 +163,31 @@ async def async_create_config_data(hass: HomeAssistant, config_entry: ConfigEntr
     )
 
 
+async def async_pause_polling(hass: HomeAssistant, config_entry: ConfigEntry) -> None:
+    """Pause Deco polling."""
+    coordinator_decos = hass.data[DOMAIN][config_entry.entry_id][COORDINATOR_DECOS_KEY]
+
+    if coordinator_decos.paused:
+        _LOGGER.info("TP-Link Deco polling is already paused")
+        return
+
+    coordinator_decos.paused = True
+    _LOGGER.info("TP-Link Deco polling paused")
+
+
+async def async_resume_polling(hass: HomeAssistant, config_entry: ConfigEntry) -> None:
+    """Resume Deco polling."""
+    coordinator_decos = hass.data[DOMAIN][config_entry.entry_id][COORDINATOR_DECOS_KEY]
+
+    if not coordinator_decos.paused:
+        _LOGGER.info("TP-Link Deco polling is already running")
+        return
+
+    coordinator_decos.paused = False
+    _LOGGER.info("TP-Link Deco polling resumed")
+    await coordinator_decos.async_request_refresh()
+
+
 async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry):
     """Set up this integration using UI."""
     _LOGGER.debug("async_setup_entry: Config entry %s", config_entry.entry_id)
@@ -204,6 +231,26 @@ async def async_reboot_deco(service: ServiceCall) -> None:
         ),
     )
 
+    async def handle_pause_polling(service: ServiceCall) -> None:
+        """Handle pause polling service."""
+        await async_pause_polling(hass, config_entry)
+
+    async def handle_resume_polling(service: ServiceCall) -> None:
+        """Handle resume polling service."""
+        await async_resume_polling(hass, config_entry)
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_PAUSE_POLLING,
+        handle_pause_polling,
+    )
+
+    hass.services.async_register(
+        DOMAIN,
+        SERVICE_RESUME_POLLING,
+        handle_resume_polling,
+    )
+
     config_entry.async_on_unload(config_entry.add_update_listener(update_listener))
 
     return True
@@ -230,7 +277,8 @@ async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) ->
     )
     if unloaded:
         hass.data[DOMAIN].pop(config_entry.entry_id)
-
+        hass.services.async_remove(DOMAIN, SERVICE_PAUSE_POLLING)
+        hass.services.async_remove(DOMAIN, SERVICE_RESUME_POLLING)
     return unloaded
 
 

custom_components/tplink_deco/api.py

@@ -398,10 +398,11 @@ async def _async_post(
         data: Any,
     ) -> dict:
         headers = {CONTENT_TYPE: "application/json"}
+        # Gebruik een dictionary voor cookies in plaats van een string in headers
         request_cookies = {}
         if self._cookie is not None:
             try:
-                # Split 'sysauth=abc' into {'sysauth': 'abc'}
+                # Split 'sysauth=abc' naar {'sysauth': 'abc'}
                 cookie_parts = self._cookie.split("=", 1)
                 if len(cookie_parts) == 2:
                     request_cookies[cookie_parts[0]] = cookie_parts[1]
@@ -414,7 +415,7 @@ async def _async_post(
                     params=params,
                     data=data,
                     headers=headers,
-                    cookies=request_cookies,
+                    cookies=request_cookies,  # Gebruik de cookies parameter
                     ssl=self._ssl_context,
                 )
                 response.raise_for_status()
@@ -427,7 +428,7 @@ async def _async_post(
                         _LOGGER.debug("Found new cookie: %s", self._cookie)
                         break
 
-                # Sometimes server responses with incorrect content type, so disable the check
+                # Soms antwoordt de server met de verkeerde content-type
                 response_json = await response.json(content_type=None)
                 if "error_code" in response_json:
                     error_code = response_json.get("error_code")

custom_components/tplink_deco/binary_sensor.py

@@ -33,7 +33,7 @@ def add_binary_sensors_for_deco(deco: TpLinkDeco) -> None:
                 ),
                 TplinkDecoOnlineBinarySensor(
                     coordinator_decos,
-                    deco.mac,    
+                    deco.mac,
                 ),
             ]
         )
@@ -84,14 +84,13 @@ def is_on(self) -> bool:
 
         if isinstance(value, str):
             return value.lower() in ("online", "true", "1", "yes")
-        
+
         return bool(value)
-    
+
     @property
     def available(self) -> bool:
         return self._deco is not None and self._deco.internet_online is not None
 
-
     @property
     def device_info(self):
         """Return device info."""
@@ -100,6 +99,7 @@ def device_info(self):
             self.coordinator.data.master_deco,
         )
 
+
 class TplinkDecoOnlineBinarySensor(CoordinatorEntity, BinarySensorEntity):
     """TP-Link Deco online (mesh/backhaul) status."""
 
@@ -129,4 +129,4 @@ def device_info(self):
         return create_device_info(
             self._deco,
             self.coordinator.data.master_deco,
-        )
+        )

custom_components/tplink_deco/const.py

@@ -1,11 +1,8 @@
 """Constants for TP-Link Deco."""
 
-from homeassistant.components.binary_sensor import DOMAIN as BINARY_SENSOR_DOMAIN
-from homeassistant.components.device_tracker import DOMAIN as DEVICE_TRACKER_DOMAIN
 from homeassistant.components.device_tracker.const import (
     DEFAULT_CONSIDER_HOME as DEFAULT_CONSIDER_HOME_SPAN,
 )
-from homeassistant.components.sensor import DOMAIN as SENSOR_DOMAIN
 
 # Base component constants
 DOMAIN = "tplink_deco"
@@ -53,6 +50,7 @@
 
 # Services
 SERVICE_REBOOT_DECO = "reboot_deco"
-
+SERVICE_PAUSE_POLLING = "pause_polling"
+SERVICE_RESUME_POLLING = "resume_polling"
 # Platforms
-PLATFORMS = [DEVICE_TRACKER_DOMAIN, SENSOR_DOMAIN, BINARY_SENSOR_DOMAIN]
+PLATFORMS = ["device_tracker", "sensor", "binary_sensor", "switch"]

custom_components/tplink_deco/coordinator.py

@@ -72,6 +72,8 @@ def __init__(self, mac: str) -> None:
         self.bssid_band5 = None
         self.signal_band2_4 = None
         self.signal_band5 = None
+        self.backhaul_speed = None
+        self.backhaul_max_speed = None
 
     def update(
         self,
@@ -92,14 +94,16 @@ def update(
         elif isinstance(inet, str):
             self.internet_online = inet.lower() in ("online", "connected", "up")
         else:
-            self.internet_online = bool(inet)    
+            self.internet_online = bool(inet)
         self.master = data.get("role") == "master"
         self.connection_type = data.get("connection_type")
         self.bssid_band2_4 = data.get("bssid_2g")
         self.bssid_band5 = data.get("bssid_5g")
         signal_level = data.get("signal_level", {})
         self.signal_band2_4 = signal_level.get("band2_4")
         self.signal_band5 = signal_level.get("band5")
+        self.backhaul_speed = data.get("backhual_speed")
+        self.backhaul_max_speed = data.get("backhual_max_speed")
 
 
 class TpLinkDecoClient:
@@ -171,8 +175,14 @@ def __init__(
         # Must happen after super().__init__
         self.data = TpLinkDecoData() if data is None else data
 
+        self.paused = False
+
     async def _async_update_data(self):
         """Update data via api."""
+        if self.paused:
+            _LOGGER.debug("Deco polling is paused")
+            return self.data
+
         new_decos = await async_call_and_propagate_config_error(
             self.api.async_list_devices
         )
@@ -244,6 +254,10 @@ def __init__(
 
     async def _async_update_data(self):
         """Update data via api."""
+        if self._deco_update_coordinator.paused:
+            _LOGGER.debug("Deo client polling is paused")
+            return self.data
+
         if len(self._deco_update_coordinator.data.decos) == 0:
             return
 

custom_components/tplink_deco/sensor.py

@@ -2,6 +2,7 @@
 
 from dataclasses import dataclass
 import logging
+from typing import Any
 from typing import Callable
 
 from homeassistant.components.sensor import SensorEntity
@@ -33,7 +34,7 @@
 class TplinkDecoDiagnosticSensorDescription(SensorEntityDescription):
     """Description of a TP-Link Deco diagnostic sensor."""
 
-    value_fn: Callable[[TpLinkDeco], str | None]
+    value_fn: Callable[[TpLinkDeco], Any]
 
 
 DIAGNOSTIC_SENSOR_DESCRIPTIONS: tuple[TplinkDecoDiagnosticSensorDescription, ...] = (
@@ -69,6 +70,22 @@ class TplinkDecoDiagnosticSensorDescription(SensorEntityDescription):
             else deco.connection_type
         ),
     ),
+    TplinkDecoDiagnosticSensorDescription(
+        key="backhaul_speed",
+        name="Backhaul speed",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+        native_unit_of_measurement=UnitOfDataRate.MEGABITS_PER_SECOND,
+        value_fn=lambda deco: deco.backhaul_speed,
+    ),
+    TplinkDecoDiagnosticSensorDescription(
+        key="backhaul_max_speed",
+        name="Backhaul max speed",
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+        native_unit_of_measurement=UnitOfDataRate.MEGABITS_PER_SECOND,
+        value_fn=lambda deco: deco.backhaul_max_speed,
+    ),
 )
 
 
@@ -179,7 +196,7 @@ def __init__(
         self._attr_state_class = SensorStateClass.MEASUREMENT
         self._attr_unique_id = unique_id
         super().__init__(coordinator_clients)
-        self._update_state()  # Must happen after init
+        self._update_state()
 
     @property
     def device_info(self) -> DeviceInfo:
@@ -224,7 +241,7 @@ def __init__(
         self._deco_mac = deco_mac
         self._attr_unique_id = f"{deco_mac}_client_count"
         super().__init__(coordinator_clients)
-        self._update_state()  # Must happen after init
+        self._update_state()
 
     @property
     def _deco(self) -> TpLinkDeco:
@@ -280,6 +297,8 @@ def device_info(self) -> DeviceInfo:
         return create_device_info(self._deco, self.coordinator.data.master_deco)
 
     @property
-    def native_value(self) -> str | None:
+    def native_value(self):
         value = self.entity_description.value_fn(self._deco)
-        return value if value else None
+        if value is None or value == "" or value == []:
+            return None
+        return value

custom_components/tplink_deco/strings.json

@@ -2,7 +2,7 @@
   "config": {
     "step": {
       "user": {
-        "description": "Use the credentials for the admin web portal. Please follow the instructions at https://github.com/amosyuen/ha-tplink-deco#configuration-important-please-read",
+        "description": "Use the credentials for the admin web portal. See documentation for more information",
         "data": {
           "host": "[%key:common::config_flow::data::host%]",
           "username": "[%key:common::config_flow::data::username%]",
@@ -19,7 +19,7 @@
         }
       },
       "reauth_confirm": {
-        "description": "Problem with login credentials. Maybe caused by logging in on a separate device. See https://github.com/amosyuen/ha-tplink-deco#login-credentials",
+        "description": "Problem with login credentials. Maybe caused by logging in on a separate device. See documentation for more information",
         "data": {
           "username": "[%key:common::config_flow::data::username%]",
           "password": "[%key:common::config_flow::data::password%]"
@@ -36,7 +36,7 @@
   "options": {
     "step": {
       "init": {
-        "description": "Use the credentials for the admin web portal. Please follow the instructions at https://github.com/amosyuen/ha-tplink-deco#configuration-important-please-read",
+        "description": "Use the credentials for the admin web portal. See documentation for more information",
         "data": {
           "host": "[%key:common::config_flow::data::host%]",
           "username": "[%key:common::config_flow::data::username%]",