Connected devices stats added (#4)

* Connected devices stats added
* Recursive search for connected devices

Author: vmakeev

README.md

@@ -1,76 +1,17 @@
-# Управление роутерами Huawei WiFi Mesh 3 из Home Assistant
-
-Компонент для Home Assistant, позволяющий управлять роутерами [Huawei WiFi Mesh 3](https://consumer.huawei.com/ru/routers/wifi-mesh3/) через локальную сеть.
-
-**0.7.1**
-
-- включение/отключение NFC
-- включение/отключение TWT (снижение энергопотребления устройств Wi-Fi 6 в спящем режиме)
-- управление функцией быстрого роуминга (802.11r)
-- отслеживание подключенных устройств
-- определение конкретного роутера, к которому подключено устройство
-- определение параметров подключения устройств (частота, сила сигнала, гостевые и mesh устройства)
-- информация об аппаратной версии роутера
-- информация о версии прошивки роутера
-
-## Установка
-
-Необходимо скопировать папку `huawei_mesh_router` из [последнего релиза](https://github.com/vmakeev/huawei_mesh_router/releases/latest) в папку `custom_components`, расположенную в папке с конфигурацией Home Assistant, после чего перезапустить Home Assistant.
-
-## Настройка
-
-Конфигурация > [Устройства и службы](https://my.home-assistant.io/redirect/integrations/) > Добавить интеграцию > [Huawei Mesh Router](https://my.home-assistant.io/redirect/config_flow_start/?domain=huawei_mesh_router)
-
-По умолчанию роутеры Huawei WiFi Mesh 3 используют имя пользователя `admin`, хотя оно и не отображается в web-интерфейсе и в мобильном приложении
-
-## Отслеживание устройств
-
-Каждое отслеживаемое устройство предоставляет следующие атрибуты:
-
-| Атрибут | Описание | Только когда подключено |
-|---------|----------|-------------------------|
-|source_type| всегда `router`| Нет |
-|ip| IP-адрес устройства | Да |
-|mac|MAC-адрес устройства| Нет |
-|host_name| Имя устройства по данным самого устройства| Нет |
-|connected_via| Имя роутера, через который выполнено подключение. Для основного роутера - `Huawei Mesh 3` | Да |
-|interface_type| Тип интерфейса подключения (например `5GHz`, `LAN` и т.д.)| Да |
-|rssi| Сила сигнала для беспроводных подключений| Да |
-|is_guest| Является ли устройство подключенным к гостевой сети | Да |
-|is_hilink| Подключено ли устройство через HiLink (обычно это другие роутеры)| Да |
-|friendly_name| Имя устройства, предоставленное роутером | Нет |
-
-Имена устройств для отслеживания, включая роутеры, могут быть изменены в [интерфейсе управления вашей mesh-системой](http://192.168.3.1/html/index.html#/devicecontrol), после чего компонент обновит их и в Home Assistant
-
-
-Пример markdown карточки, отображающей часть информации об отслеживаемом устройстве:
-
-```
-Мой телефон: Rssi
-{{- " **" + state_attr('device_tracker.my_phone', 'rssi') | string }}** *via*
-{{- " **" + state_attr('device_tracker.my_phone', 'connected_via') | string }}**
-{{- " **(" + state_attr('device_tracker.my_phone', 'interface_type') | string }})**
-```
-
-Результат:
-Мой телефон: Rssi **30** *via* **Kitchen router** (**5GHz**)
-
------
-
 # Control Huawei WiFi Mesh 3 routers from Home Assistant
 
-Home Assistant custom component for control [Huawei WiFi Mesh 3](https://consumer.huawei.com/ru/routers/wifi-mesh3/) routers over LAN.
+Home Assistant custom component for control [Huawei WiFi Mesh 3](https://consumer.huawei.com/en/routers/wifi-mesh3/) routers over LAN.
 
-**0.7.1**
+**0.7.2**
 
+- sensors for the number of connected devices (total and for each individual router)
 - enable/disable NFC
 - enable/disable TWT (reduce power consumption of Wi-Fi 6 devices in sleep mode)
 - control of the fast roaming function (802.11r)
 - connected devices tracking
 - obtaining of the specific router to which the device is connected
-- obtaining of device connection parameters (frequency, signal strength, guest and mesh devices)
-- hardware version of the router
-- firmware version of the router
+- obtaining of device connection parameters (frequency, signal strength, guest and hilink devices)
+- hardware and firmware version of the router
 
 ## Installation
 
@@ -86,18 +27,18 @@ By default, Huawei WiFi Mesh 3 routers use the username `admin`, although it is
 
 Each tracked device exposes the following attributes:
 
-|    Attribute   |    Description    | Only when connected |
-|----------------|-------------------|---------------------|
-| source_type    | always `router`   | No |
-| ip             | Device IP address | Yes |
-| mac            | MAC address of the device | No |
-| hostname       | Device name according to the device itself | No |
-| connected_via  | The name of the router through which the connection was made. For the primary router - `Huawei Mesh 3` | Yes |
-| interface_type | Connection interface type (eg `5GHz`, `LAN`, etc.) | Yes |
-| rssi           | Signal strength for wireless connections | Yes |
-| is_guest       | Is the device connected to the guest network | Yes |
-| is_hilink      | Is the device connected via HiLink (usually other routers) | Yes |
-| friendly_name  | Device name provided by the router | No |
+|    Attribute     |                  Description                 | Only when connected |
+|------------------|----------------------------------------------|---------------------|
+| `source_type`    | Always `router`                              | No                  |
+| `ip`             | Device IP address                            | Yes                 |
+| `mac`            | MAC address of the device                    | No                  |
+| `hostname`       | Device name according to the device itself   | No                  |
+| `connected_via`  | The name of the router through which the connection was made. For the primary router - `Huawei Mesh 3` (or your configuration name) | Yes |
+| `interface_type` | Connection interface type (`5GHz`, `2.4GHz`, `LAN`) | Yes          |
+| `rssi`           | Signal strength for wireless connections     | Yes                 |
+| `is_guest`       | Is the device connected to the guest network | Yes                 |
+| `is_hilink`      | Is the device connected via HiLink (usually other routers) | Yes   |
+| `friendly_name`  | Device name provided by the router           | No                  |
 
 Tracked device names, including routers, can be changed in [your mesh control interface](http://192.168.3.1/html/index.html#/devicecontrol), after which the component will update them in Home Assistant
 
@@ -112,3 +53,29 @@ My phone: Rssi
 
 Result:
 My phone: Rssi **30** *via* **Kitchen router** (**5GHz**)
+
+## Sensors
+
+### Number of connected devices
+
+The component provides the ability to obtain the number of connected devices both to the entire mesh network and to specific routers using sensors.
+
+There are two sensors that are always present:
+* `sensor.<integration_name>_clients_total` - total number of devices connected to the mesh network
+* `sensor.<integration_name>_clients_primary_router` - number of devices connected to the primary router
+
+Also, one sensor is created for each additional router in the mesh network:
+* `sensor.<integration_name>_clients_<router_name>`
+
+_Note: when additional routers are disconnected from the network, their personal sensors are automatically deleted._
+
+Each sensor exposes the following attributes:
+
+|     Attribute      |                  Description                     |
+|--------------------|--------------------------------------------------|
+| `guest_clients`    | Number of devices connected to the guest network |
+| `hilink_clients`   | Number of devices connected via HiLink           |
+| `wireless_clients` | Number of devices connected wirelessly           |
+| `lan_clients`      | Number of devices connected by cable             |
+| `wifi_2_4_clients` | Number of devices connected to Wi-Fi 2.4 GHz     |
+| `wifi_5_clients`   | Number of devices connected to Wi-Fi 5 GHz       |

custom_components/huawei_mesh_router/__init__.py

@@ -29,7 +29,7 @@ async def async_setup(hass, _config):
 # ---------------------------
 #   async_setup_entry
 # ---------------------------
-async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry):
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
     """Set up Huawei Router as config entry."""
     coordinator = HuaweiControllerDataUpdateCoordinator(hass, config_entry)
     await coordinator.async_config_entry_first_refresh()

custom_components/huawei_mesh_router/config_flow.py

@@ -1,4 +1,4 @@
-"""Config flow to configure Mikrotik Router."""
+"""Config flow to configure Huawei Mesh Router."""
 
 import logging
 

custom_components/huawei_mesh_router/connected_device.py

@@ -1,4 +1,16 @@
 from typing import Dict
+from homeassistant.backports.enum import StrEnum
+
+from .const import VENDOR_CLASS_ID_ROUTER
+
+
+# ---------------------------
+#   HuaweiInterfaceType
+# ---------------------------
+class HuaweiInterfaceType(StrEnum):
+    INTERFACE_5GHZ = "5GHz"
+    INTERFACE_2_4GHZ = "2.4GHz"
+    INTERFACE_LAN = "LAN"
 
 
 # ---------------------------
@@ -11,7 +23,7 @@ def __init__(self,
                  host_name: str,
                  mac: str,
                  is_active: bool,
-                 **kwargs: Dict):
+                 **kwargs: Dict) -> None:
         self._name: str = name
         self._host_name: str = host_name
         self._mac: str = mac
@@ -28,6 +40,12 @@ def update_device_data(self,
         self._is_active: bool = is_active
         self._data: Dict = kwargs or {}
 
+    def __str__(self) -> str:
+        return f"Device {self._name} ({self._host_name}), {'' if self._is_active else 'not '}active, data: {self._data}"
+
+    def __repr__(self) -> str:
+        return self.__str__()
+
     @property
     def name(self) -> str:
         """Return the name of the device."""
@@ -48,15 +66,35 @@ def mac(self) -> str:
         """Return the mac address of the device."""
         return self._mac
 
+    @property
+    def connected_via_id(self) -> str | None:
+        """Return the id of parent device."""
+        return self._data.get("connected_via_id")
+
+    @property
+    def interface_type(self) -> HuaweiInterfaceType | None:
+        """Return the connection interface type."""
+        return self._data.get("interface_type")
+
     @property
     def is_active(self) -> bool:
         """Return true when device is connected to mesh."""
         return self._is_active
 
     @property
-    def is_hilink(self) -> bool | None:
-        """Return true when device is hilink mesh router."""
-        return self._data.get("is_hilink")
+    def is_guest(self) -> bool:
+        """Return true when device is guest."""
+        return self._data.get("is_guest", False)
+
+    @property
+    def is_hilink(self) -> bool:
+        """Return true when device is hilink."""
+        return self._data.get("is_hilink", False)
+
+    @property
+    def is_router(self) -> bool:
+        """Return true when device is hilink router."""
+        return self.is_hilink and self._data.get("vendor_class_id") == VENDOR_CLASS_ID_ROUTER
 
     @property
     def all_attrs(self) -> Dict:

custom_components/huawei_mesh_router/const.py

@@ -12,8 +12,12 @@
 DEFAULT_SCAN_INTERVAL = 30
 
 ATTR_MANUFACTURER = "Huawei"
-PLATFORMS = [Platform.SWITCH, Platform.DEVICE_TRACKER]
+PLATFORMS = [Platform.SWITCH, Platform.DEVICE_TRACKER, Platform.SENSOR]
 
 SWITCHES_NFC = "nfc_switch"
 SWITCHES_WIFI_80211R = "wifi_80211r_switch"
 SWITCHES_WIFI_TWT = "wifi_twt_switch"
+
+VENDOR_CLASS_ID_ROUTER = "router"
+
+CONNECTED_VIA_ID_PRIMARY = "primary"

custom_components/huawei_mesh_router/device_tracker.py

@@ -1,6 +1,7 @@
 """Support for Huawei routers as device tracker."""
 import logging
 
+from typing import Any
 from homeassistant.components.device_tracker.config_entry import ScannerEntity
 from homeassistant.components.device_tracker.const import (
     SOURCE_TYPE_ROUTER,
@@ -14,7 +15,7 @@
 from .const import DOMAIN
 from .update_coordinator import HuaweiControllerDataUpdateCoordinator
 
-FILTER_ATTRS = ("ip_address",)
+FILTER_ATTRS = ("ip_address", "connected_via_id", "vendor_class_id")
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -45,7 +46,7 @@ def coordinator_updated():
 # ---------------------------
 @callback
 def update_items(coordinator: HuaweiControllerDataUpdateCoordinator,
-                 async_add_entities, tracked):
+                 async_add_entities, tracked) -> None:
     """Update tracked device state from the hub."""
     new_tracked = []
     for mac, device in coordinator.connected_devices.items():
@@ -63,18 +64,18 @@ def update_items(coordinator: HuaweiControllerDataUpdateCoordinator,
 class HuaweiTracker(CoordinatorEntity, ScannerEntity):
     """Representation of network device."""
 
-    def __init__(self, device: ConnectedDevice, coordinator: HuaweiControllerDataUpdateCoordinator):
+    def __init__(self, device: ConnectedDevice, coordinator: HuaweiControllerDataUpdateCoordinator) -> None:
         """Initialize the tracked device."""
         self.device: ConnectedDevice = device
         super().__init__(coordinator)
 
     @property
-    def is_connected(self):
+    def is_connected(self) -> bool:
         """Return true if the client is connected to the network."""
         return self.device.is_active
 
     @property
-    def source_type(self):
+    def source_type(self) -> str:
         """Return the source type of the client."""
         return SOURCE_TYPE_ROUTER
 
@@ -104,7 +105,7 @@ def unique_id(self) -> str:
         return f'{self.coordinator.unique_id}_{self.device.mac}'
 
     @property
-    def extra_state_attributes(self):
+    def extra_state_attributes(self) -> dict[str, Any]:
         """Return the device state attributes."""
         return {k: v for k, v in self.device.all_attrs.items() if k not in FILTER_ATTRS}