0.37.0 (#954)

* Switch to the new format for backend `ARConfig` (#949)

* Use robust boottime feature of backend (#950)

* Add ruff/isort config (#952)

* Add DDNS support (#951)

* Fix formatting and imports (#953)

* Bump `asusrouter` to `1.18.0`

* Bump version to `0.37.0`

Author: Vaskivskyi

custom_components/asusrouter/__init__.py

@@ -42,7 +42,9 @@ async def async_close_connection(event):
         STOP_LISTENER: stop_listener,
     }
 
-    await hass.config_entries.async_forward_entry_setups(config_entry, PLATFORMS)
+    await hass.config_entries.async_forward_entry_setups(
+        config_entry, PLATFORMS
+    )
 
     return True
 
@@ -55,7 +57,9 @@ async def async_unload_entry(
 
     _LOGGER.debug("Unloading entry")
 
-    unload = await hass.config_entries.async_unload_platforms(config_entry, PLATFORMS)
+    unload = await hass.config_entries.async_unload_platforms(
+        config_entry, PLATFORMS
+    )
 
     if unload:
         # Close connection
@@ -90,10 +94,14 @@ async def async_migrate_entry(hass, config_entry: ConfigEntry):
 
     if config_entry.version == 4:
         new_options = {**config_entry.options}
-        new_options["interval_network"] = new_options.pop("interval_network_stat", 30)
+        new_options["interval_network"] = new_options.pop(
+            "interval_network_stat", 30
+        )
 
         config_entry.version = 5
-        hass.config_entries.async_update_entry(config_entry, options=new_options)
+        hass.config_entries.async_update_entry(
+            config_entry, options=new_options
+        )
 
     _LOGGER.debug("Migration to version %s successful", config_entry.version)
 

custom_components/asusrouter/aimesh.py

@@ -34,7 +34,9 @@ def __init__(
     def update(
         self,
         node_info: Optional[AiMeshDevice] = None,
-        event_call: Optional[Callable[[str, Optional[dict[str, Any]]], None]] = None,
+        event_call: Optional[
+            Callable[[str, Optional[dict[str, Any]]], None]
+        ] = None,
     ) -> None:
         """Update AiMesh device."""
 
@@ -50,7 +52,9 @@ def update(
                     "type"
                 ] = node_info.type
                 # IP
-                self._extra_state_attributes["ip"] = self.identity["ip"] = node_info.ip
+                self._extra_state_attributes["ip"] = self.identity["ip"] = (
+                    node_info.ip
+                )
                 # Alias
                 self._extra_state_attributes["alias"] = self.identity[
                     "alias"
@@ -60,7 +64,9 @@ def update(
                     "model"
                 ] = node_info.model
                 # Product ID
-                self._extra_state_attributes["product_id"] = node_info.product_id
+                self._extra_state_attributes["product_id"] = (
+                    node_info.product_id
+                )
                 # Node level
                 self._extra_state_attributes["level"] = node_info.level
                 # Node parent
@@ -75,7 +81,9 @@ def update(
                 # Access point
                 # self._extra_state_attributes[ACCESS_POINT] = node_info.ap
                 # Notify reconnect
-                if self.identity["connected"] is False and callable(event_call):
+                if self.identity["connected"] is False and callable(
+                    event_call
+                ):
                     event_call(
                         "node_reconnected",
                         self.identity,

custom_components/asusrouter/binary_sensor.py

@@ -41,11 +41,18 @@ async def async_setup_entry(
     binary_sensors = STATIC_BINARY_SENSORS.copy()
 
     hide = []
-    if config_entry.options.get(CONF_HIDE_PASSWORDS, CONF_DEFAULT_HIDE_PASSWORDS):
+    if config_entry.options.get(
+        CONF_HIDE_PASSWORDS, CONF_DEFAULT_HIDE_PASSWORDS
+    ):
         hide.append(PASSWORD)
 
     await async_setup_ar_entry(
-        hass, config_entry, async_add_entities, binary_sensors, ARBinarySensor, hide
+        hass,
+        config_entry,
+        async_add_entities,
+        binary_sensors,
+        ARBinarySensor,
+        hide,
     )
 
     router = hass.data[DOMAIN][config_entry.entry_id][ASUSROUTER]
@@ -112,7 +119,9 @@ def __init__(
 
         self._router = router
         self._node = node
-        self._attr_unique_id = to_unique_id(f"{router.mac}_{AIMESH}_{node.mac}")
+        self._attr_unique_id = to_unique_id(
+            f"{router.mac}_{AIMESH}_{node.mac}"
+        )
         self._attr_name = f"AiMesh {node.native.model} ({node.native.mac})"
 
     @property

custom_components/asusrouter/bridge.py

@@ -8,7 +8,7 @@
 
 import aiohttp
 from asusrouter import AsusRouter
-from asusrouter.config import ARConfig
+from asusrouter.config import ARConfig, ARConfigKey
 from asusrouter.error import AsusRouterError
 from asusrouter.modules.aimesh import AiMeshDevice
 from asusrouter.modules.client import AsusClient
@@ -44,6 +44,7 @@
     CONF_DEFAULT_PORT,
     CONF_MODE,
     CPU,
+    DDNS,
     DEFAULT_SENSORS,
     DSL,
     FIRMWARE,
@@ -106,9 +107,15 @@ def __init__(
         # Initialize API
         self._api = self._get_api(self._configs, session)
 
-        # Switch API to optimistic
+        # Switch API to optimistic mode
         # Optimistic temperature to avoid scaling issues from some devices
-        ARConfig.set("optimistic_temperature", True)
+        ARConfig.set(ARConfigKey.OPTIMISTIC_TEMPERATURE, True)
+        # Switch API to robust mode
+        # Robust boottime will avoid 1 second jitter due to the raw data
+        # uncertainty. This can provide up to 1 second overestimation
+        # of the boottime, but will avoid saving extra data when the
+        # integration restarts and loses the previous boottime data.
+        ARConfig.set(ARConfigKey.ROBUST_BOOTTIME, True)
 
         self._host = self._configs[CONF_HOST]
         self._identity: Optional[AsusDevice] = None
@@ -219,6 +226,10 @@ async def async_get_available_sensors(self) -> dict[str, dict[str, Any]]:
                 SENSORS: await self._get_sensors_modern(AsusData.CPU),
                 METHOD: self._get_data_cpu,
             },
+            DDNS: {
+                SENSORS: await self._get_sensors_modern(AsusData.DDNS),
+                METHOD: self._get_data_ddns,
+            },
             DSL: {
                 SENSORS: await self._get_sensors_modern(AsusData.DSL),
                 METHOD: self._get_data_dsl,
@@ -360,6 +371,11 @@ async def _get_data_cpu(self) -> dict[str, Any]:
 
         return await self._get_data(AsusData.CPU)
 
+    async def _get_data_ddns(self) -> dict[str, Any]:
+        """Get DDNS data from the device."""
+
+        return await self._get_data_modern(AsusData.DDNS)
+
     async def _get_data_dsl(self) -> dict[str, Any]:
         """Get DSL data from the device."""
 

custom_components/asusrouter/button.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 import logging
-from typing import Any, Optional
+from typing import Any
 
 from asusrouter.modules.state import AsusState
 from homeassistant.components.button import ButtonEntity

custom_components/asusrouter/client.py

@@ -5,9 +5,6 @@
 from datetime import datetime, timezone
 from typing import Any, Callable, Optional
 
-from homeassistant.core import callback
-from homeassistant.helpers.device_registry import format_mac
-
 from asusrouter.modules.client import (
     AsusClient,
     AsusClientConnection,
@@ -16,6 +13,8 @@
 )
 from asusrouter.modules.connection import ConnectionState, ConnectionType
 from asusrouter.modules.homeassistant import convert_to_ha_state_bool
+from homeassistant.core import callback
+from homeassistant.helpers.device_registry import format_mac
 
 from .helpers import clean_dict
 

custom_components/asusrouter/compilers.py

@@ -37,11 +37,17 @@ def list_sensors_network(
                     icon=data["icon"] or None,
                     state_class=data["state_class"] or None,
                     device_class=data["device_class"] or None,
-                    native_unit_of_measurement=data["native_unit_of_measurement"]
+                    native_unit_of_measurement=data[
+                        "native_unit_of_measurement"
+                    ]
                     or None,
-                    suggested_unit_of_measurement=data["suggested_unit_of_measurement"]
+                    suggested_unit_of_measurement=data[
+                        "suggested_unit_of_measurement"
+                    ]
                     or None,
-                    suggested_display_precision=data["suggested_display_precision"]
+                    suggested_display_precision=data[
+                        "suggested_display_precision"
+                    ]
                     or None,
                     entity_registry_enabled_default=data[
                         "entity_registry_enabled_default"

custom_components/asusrouter/config_flow.py

@@ -6,7 +6,14 @@
 import socket
 from typing import Any
 
-import voluptuous as vol
+from asusrouter import AsusData
+from asusrouter.error import (
+    AsusRouterAccessError,
+    AsusRouterConnectionError,
+    AsusRouterTimeoutError,
+)
+from asusrouter.modules.endpoint.error import AccessError
+from asusrouter.modules.homeassistant import convert_to_ha_sensors_group
 from homeassistant.config_entries import ConfigEntry, ConfigFlow, OptionsFlow
 from homeassistant.const import (
     CONF_HOST,
@@ -20,15 +27,7 @@
 from homeassistant.data_entry_flow import FlowResult
 from homeassistant.helpers import config_validation as cv
 from homeassistant.helpers.device_registry import format_mac
-
-from asusrouter import AsusData
-from asusrouter.error import (
-    AsusRouterAccessError,
-    AsusRouterConnectionError,
-    AsusRouterTimeoutError,
-)
-from asusrouter.modules.endpoint.error import AccessError
-from asusrouter.modules.homeassistant import convert_to_ha_sensors_group
+import voluptuous as vol
 
 from .bridge import ARBridge
 from .const import (

custom_components/asusrouter/const.py

@@ -98,6 +98,7 @@
 COORDINATOR = "coordinator"
 CORE = "core"
 CPU = "cpu"
+DDNS = "ddns"
 DEVICES = "devices"
 DNS = "dns"
 DSL = "dsl"
@@ -273,6 +274,7 @@
 MODE_ROUTER = MODE_ACCESS_POINT.copy()
 MODE_ROUTER.extend(
     [
+        DDNS,
         DSL,
         GWLAN,
         "ovpn_client",
@@ -838,6 +840,7 @@
 # ICONS -->
 
 ICON_CPU = "mdi:cpu-32-bit"
+ICON_DDNS = "mdi:dns-outline"
 ICON_DEVICES = "mdi:devices"
 ICON_DUALWAN = "mdi:call-split"
 ICON_ETHERNET_ON = "mdi:ethernet-cable"
@@ -867,6 +870,27 @@
 
 # SENSORS -->
 STATIC_BINARY_SENSORS: list[AREntityDescription] = [
+    # DDNS
+    ARBinarySensorDescription(
+        key="state",
+        key_group="ddns",
+        name="DDNS",
+        icon=ICON_DDNS,
+        entity_category=EntityCategory.DIAGNOSTIC,
+        entity_registry_enabled_default=False,
+        extra_state_attributes={
+            "enabled": "enabled",
+            "hostname": "hostname",
+            "ip_address": "ip_address",
+            "old_name": "old_name",
+            "replace_status": "replace_status",
+            "return_code": "return_code",
+            "server": "server",
+            "status": "status",
+            "status_hint": "status_hint",
+            "updated": "updated",
+        },
+    ),
     # Dual WAN
     ARBinarySensorDescription(
         key="dualwan_state",

custom_components/asusrouter/dataclass.py

@@ -7,7 +7,9 @@
 from typing import Any, Optional
 
 from asusrouter.modules.state import AsusState, AsusStateNone
-from homeassistant.components.binary_sensor import BinarySensorEntityDescription
+from homeassistant.components.binary_sensor import (
+    BinarySensorEntityDescription,
+)
 from homeassistant.components.button import ButtonEntityDescription
 from homeassistant.components.light import LightEntityDescription
 from homeassistant.components.sensor import SensorEntityDescription
@@ -43,7 +45,9 @@ class ARSensorDescription(AREntityDescription, SensorEntityDescription):
 
 
 @dataclass
-class ARBinarySensorDescription(ARBinaryDescription, BinarySensorEntityDescription):
+class ARBinarySensorDescription(
+    ARBinaryDescription, BinarySensorEntityDescription
+):
     """Describe AsusRouter sensor."""