Added time control switches

Author: vmakeev

custom_components/huawei_mesh_router/classes.py

@@ -35,6 +35,7 @@ class EmulatedSwitch(StrEnum):
     DEVICE_ACCESS = "wlan_device_access_switch"
     URL_FILTER = "url_filter_switch"
     PORT_MAPPING = "port_mapping"
+    TIME_CONTROL = "time_control"
 
 
 # ---------------------------

custom_components/huawei_mesh_router/client/classes.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from datetime import datetime, time
 from dataclasses import dataclass
 from enum import Enum, IntEnum, StrEnum
 from typing import Any, Dict, Final, Iterable, TypeAlias
@@ -20,21 +21,22 @@
 #   Feature
 # ---------------------------
 class Feature(StrEnum):
-    NFC: Final = "feature_nfc"
+    NFC = "feature_nfc"
     URL_FILTER = "feature_url_filter"
     WIFI_80211R = "feature_wifi_80211r"
     WIFI_TWT = "feature_wifi_twt"
     WLAN_FILTER = "feature_wlan_filter"
     DEVICE_TOPOLOGY = "feature_device_topology"
     GUEST_NETWORK = "feature_guest_network"
     PORT_MAPPING = "feature_port_mapping"
+    TIME_CONTROL = "feature_time_control"
 
 
 # ---------------------------
 #   Switch
 # ---------------------------
 class Switch(StrEnum):
-    NFC: Final = "nfc_switch"
+    NFC = "nfc_switch"
     WIFI_80211R = "wifi_80211r_switch"
     WIFI_TWT = "wifi_twt_switch"
     WLAN_FILTER = "wlan_filter_switch"
@@ -129,6 +131,19 @@ class HuaweiUrlFilterInfo:
     devices: list[HuaweiFilterItem]
 
 
+# ---------------------------
+#   DayOfWeek
+# ---------------------------
+class DayOfWeek(StrEnum):
+    MONDAY = "Monday"
+    TUESDAY = "Tuesday"
+    WEDNESDAY = "Wednesday"
+    THURSDAY = "Thursday"
+    FRIDAY = "Friday"
+    SATURDAY = "Saturday"
+    SUNDAY = "Sunday"
+
+
 # ---------------------------
 #   HuaweiPortMappingItem
 # ---------------------------
@@ -387,3 +402,94 @@ def connected_devices(self) -> Iterable[HuaweiDeviceNode]:
     def add_device(self, device: HuaweiDeviceNode) -> None:
         """Add connected node to the device."""
         self._connected_devices.append(device)
+
+
+# ---------------------------
+#   HuaweiTimeAccessItem
+# ---------------------------
+class HuaweiTimeControlItemDay:
+    def __init__(
+        self, day_of_week: DayOfWeek, is_enabled: bool, start: time, end: time
+    ):
+        """Initialize."""
+        self._day_of_week = day_of_week
+        self._is_enabled = is_enabled
+        self._start = start
+        self._end = end
+
+    @property
+    def day_of_week(self) -> DayOfWeek:
+        """Return the day of week."""
+        return self._day_of_week
+
+    @property
+    def is_enabled(self) -> bool:
+        """Return the state of the day."""
+        return self._is_enabled
+
+    @property
+    def start(self) -> time:
+        """Return the start time at this day."""
+        return self._start
+
+    @property
+    def end(self) -> time:
+        """Return the end time at this day."""
+        return self._end
+
+
+# ---------------------------
+#   HuaweiTimeAccessItem
+# ---------------------------
+class HuaweiTimeControlItem:
+    def __init__(self, data: Dict):
+        """Initialize."""
+        self._data = data
+        self._days: dict[DayOfWeek, HuaweiTimeControlItemDay] = {}
+
+        for day_of_week in DayOfWeek:
+
+            enabled_value = self._data.get(f"{day_of_week.value}enable")
+            is_enabled: bool = isinstance(enabled_value, bool) and enabled_value
+
+            start_value = self._data.get(f"{day_of_week.value}From", "00:00")
+            start: time = datetime.strptime(start_value, "%H:%M").time()
+
+            end_value = self._data.get(f"{day_of_week.value}To", "00:00")
+            end: time = datetime.strptime(end_value, "%H:%M").time()
+
+            day: HuaweiTimeControlItemDay = HuaweiTimeControlItemDay(
+                day_of_week, is_enabled, start, end
+            )
+
+            self._days[day_of_week] = day
+
+    @property
+    def id(self) -> str:
+        """Return the state of the item."""
+        return self._data.get("ID")
+
+    @property
+    def name(self) -> str:
+        """Return the name of the item."""
+        parts = [part for part in self.id.split(".") if part]
+        last_non_empty = parts[-1] if parts else "?"
+        return f"Time limit rule {last_non_empty}"
+
+    @property
+    def enabled(self) -> bool:
+        """Return the state of the item."""
+        value = self._data.get("Enable")
+        return isinstance(value, bool) and value
+
+    @property
+    def days(self) -> dict[DayOfWeek, HuaweiTimeControlItemDay]:
+        """Return the schedule for each day."""
+        return self._days
+
+    def update(self, source: HuaweiTimeControlItem) -> None:
+        self._data = source._data
+        self._days = source._days
+
+    def set_enabled(self, enabled: bool) -> None:
+        self._data["Enable"] = enabled

custom_components/huawei_mesh_router/client/const.py

@@ -7,15 +7,16 @@
 
 URL_DEVICE_INFO: Final = "api/system/deviceinfo"
 URL_DEVICE_TOPOLOGY: Final = "api/device/topology"
+URL_GUEST_NETWORK: Final = "api/ntwk/guest_network?type=notshowpassall"
 URL_HOST_INFO: Final = "api/system/HostInfo"
+URL_PORT_MAPPING: Final = "api/ntwk/portmapping"
+URL_REBOOT: Final = "api/service/reboot.cgi"
+URL_REPEATER_INFO: Final = "api/ntwk/repeaterinfo"
 URL_SWITCH_NFC: Final = "api/bsp/nfc_switch"
 URL_SWITCH_WIFI_80211R: Final = "api/ntwk/WlanGuideBasic?type=notshowpassall"
 URL_SWITCH_WIFI_TWT: Final = "api/ntwk/WlanGuideBasic?type=notshowpassall"
-URL_REBOOT: Final = "api/service/reboot.cgi"
-URL_REPEATER_INFO: Final = "api/ntwk/repeaterinfo"
-URL_WANDETECT: Final = "api/ntwk/wandetect"
-URL_WLAN_FILTER: Final = "api/ntwk/wlanfilterenhance"
+URL_TIME_CONTROL: Final = "api/ntwk/timecontrol"
 URL_URL_FILTER: Final = "api/ntwk/urlfilter"
-URL_GUEST_NETWORK: Final = "api/ntwk/guest_network?type=notshowpassall"
 URL_WAN_INFO: Final = "api/ntwk/wan?type=active"
-URL_PORT_MAPPING: Final = "api/ntwk/portmapping"
+URL_WANDETECT: Final = "api/ntwk/wandetect"
+URL_WLAN_FILTER: Final = "api/ntwk/wlanfilterenhance"

custom_components/huawei_mesh_router/client/huaweiapi.py

@@ -22,6 +22,7 @@
     HuaweiPortMappingItem,
     HuaweiRouterInfo,
     HuaweiRsaPublicKey,
+    HuaweiTimeControlItem,
     HuaweiUrlFilterInfo,
     Switch,
 )
@@ -36,6 +37,7 @@
     URL_SWITCH_NFC,
     URL_SWITCH_WIFI_80211R,
     URL_SWITCH_WIFI_TWT,
+    URL_TIME_CONTROL,
     URL_URL_FILTER,
     URL_WANDETECT,
     URL_WLAN_FILTER,
@@ -719,7 +721,7 @@ async def set_port_mapping_state(self, port_mapping_id: str, enabled: bool) -> N
         )
 
         if not target:
-            raise InvalidActionError(f"Unknown filter: {port_mapping_id}")
+            raise InvalidActionError(f"Unknown port mapping: {port_mapping_id}")
 
         target["Enable"] = enabled
 
@@ -754,3 +756,30 @@ async def _set_guest_network_enabled(self, enabled: bool) -> None:
             secure=primary_item.sec_opt != WIFI_SECURITY_OPEN,
             password=primary_item.key,
         )
+
+    async def get_time_control_items(self) -> Iterable[HuaweiTimeControlItem]:
+        data = await self._core_api.get(URL_TIME_CONTROL)
+        return [HuaweiTimeControlItem(item) for item in data]
+
+    async def set_time_control_item_state(
+        self, time_control_item_id: str, enabled: bool
+    ) -> None:
+        time_control_items = await self._core_api.get(URL_TIME_CONTROL)
+        target = next(
+            (
+                item
+                for item in time_control_items
+                if item.get("ID") == time_control_item_id
+            )
+        )
+
+        if not target:
+            raise InvalidActionError(
+                f"Unknown time control item: {time_control_item_id}"
+            )
+
+        target["Enable"] = enabled
+
+        await self._core_api.post(
+            URL_TIME_CONTROL, target, extra_data={"action": "update"}
+        )

custom_components/huawei_mesh_router/client/utils.py

@@ -9,6 +9,7 @@
     URL_SWITCH_NFC,
     URL_SWITCH_WIFI_80211R,
     URL_SWITCH_WIFI_TWT,
+    URL_TIME_CONTROL,
     URL_URL_FILTER,
     URL_WLAN_FILTER,
 )
@@ -110,6 +111,12 @@ async def _is_port_mapping_available(self) -> bool:
         data = await self._core_api.get(URL_PORT_MAPPING)
         return data is not None
 
+    @log_feature(Feature.TIME_CONTROL)
+    @unauthorized_as_false
+    async def _is_time_control_available(self) -> bool:
+        data = await self._core_api.get(URL_TIME_CONTROL)
+        return data is not None
+
     async def update(self) -> None:
         """Update the available features list."""
         if await self._is_nfc_available():
@@ -136,6 +143,9 @@ async def update(self) -> None:
         if await self._is_port_mapping_available():
             self._available_features.add(Feature.PORT_MAPPING)
 
+        if await self._is_time_control_available():
+            self._available_features.add(Feature.TIME_CONTROL)
+
     def is_available(self, feature: Feature) -> bool:
         """Return true if feature is available."""
         return feature in self._available_features

custom_components/huawei_mesh_router/config_flow.py

@@ -32,6 +32,7 @@
     DEFAULT_ROUTER_CLIENTS_SENSORS,
     DEFAULT_SCAN_INTERVAL,
     DEFAULT_SSL,
+    DEFAULT_TIME_CONTROL_SWITCHES,
     DEFAULT_URL_FILTER_SWITCHES,
     DEFAULT_USER,
     DEFAULT_VERIFY_SSL,
@@ -43,6 +44,7 @@
     OPT_EVENT_ENTITIES,
     OPT_PORT_MAPPING_SWITCHES,
     OPT_ROUTER_CLIENTS_SENSORS,
+    OPT_TIME_CONTROL_SWITCHES,
     OPT_URL_FILTER_SWITCHES,
     OPT_WIFI_ACCESS_SWITCHES,
 )
@@ -251,6 +253,12 @@ async def async_step_features_select(self, user_input=None) -> FlowResult:
                             OPT_PORT_MAPPING_SWITCHES, DEFAULT_PORT_MAPPING_SWITCHES
                         ),
                     ): bool,
+                    vol.Required(
+                        OPT_TIME_CONTROL_SWITCHES,
+                        default=self.options.get(
+                            OPT_TIME_CONTROL_SWITCHES, DEFAULT_TIME_CONTROL_SWITCHES
+                        ),
+                    ): bool,
                 },
             ),
         )

custom_components/huawei_mesh_router/const.py

@@ -20,6 +20,7 @@
 OPT_DEVICE_TRACKER = "device_tracker"
 OPT_DEVICE_TRACKER_ZONES = "device_tracker_zones"
 OPT_EVENT_ENTITIES = "event_entities"
+OPT_TIME_CONTROL_SWITCHES = "time_control_switches"
 
 DEFAULT_HOST: Final = "192.168.3.1"
 DEFAULT_USER: Final = "admin"
@@ -37,6 +38,7 @@
 DEFAULT_URL_FILTER_SWITCHES: Final = False
 DEFAULT_PORT_MAPPING_SWITCHES: Final = False
 DEFAULT_EVENT_ENTITIES: Final = False
+DEFAULT_TIME_CONTROL_SWITCHES: Final = False
 
 ATTR_MANUFACTURER: Final = "Huawei"
 PLATFORMS: Final = [

custom_components/huawei_mesh_router/manifest.json

@@ -13,5 +13,5 @@
   "iot_class": "local_polling",
   "issue_tracker": "https://github.com/vmakeev/huawei_mesh_router/issues",
   "requirements": ["pycryptodome>=3.12.0"],
-  "version": "0.9.2.1"
+  "version": "0.9.3"
 }

custom_components/huawei_mesh_router/options.py

@@ -11,6 +11,7 @@
     DEFAULT_ROUTER_CLIENTS_SENSORS,
     DEFAULT_EVENT_ENTITIES,
     DEFAULT_SCAN_INTERVAL,
+    DEFAULT_TIME_CONTROL_SWITCHES,
     DEFAULT_URL_FILTER_SWITCHES,
     DEFAULT_WIFI_ACCESS_SWITCHES,
     OPT_DEVICE_TRACKER,
@@ -19,6 +20,7 @@
     OPT_EVENT_ENTITIES,
     OPT_PORT_MAPPING_SWITCHES,
     OPT_ROUTER_CLIENTS_SENSORS,
+    OPT_TIME_CONTROL_SWITCHES,
     OPT_URL_FILTER_SWITCHES,
     OPT_WIFI_ACCESS_SWITCHES,
 )
@@ -103,3 +105,12 @@ def event_entities(self) -> bool:
             OPT_EVENT_ENTITIES,
             DEFAULT_EVENT_ENTITIES,
         )
+
+    @property
+    def time_control_switches(self) -> bool:
+        """Return option 'time control switches' value"""
+        return get_option(
+            self._config_entry,
+            OPT_TIME_CONTROL_SWITCHES,
+            DEFAULT_TIME_CONTROL_SWITCHES,
+        )