Bump version

pyhon/appliance.py

@@ -1,10 +1,13 @@
 import importlib
+import json
 import logging
 from contextlib import suppress
+from datetime import datetime, timedelta
+from pathlib import Path
 from typing import Optional, Dict, Any
 from typing import TYPE_CHECKING
 
-from pyhon import helper, exceptions
+from pyhon import helper
 from pyhon.commands import HonCommand
 from pyhon.parameter.base import HonParameter
 from pyhon.parameter.fixed import HonParameterFixed
@@ -16,6 +19,8 @@ _LOGGER = logging.getLogger(__name__)
 
 
 class HonAppliance:
+    _MINIMAL_UPDATE_INTERVAL = 5  # seconds
+
     def __init__(
         self, api: Optional["HonAPI"], info: Dict[str, Any], zone: int = 0
     ) -> None:
@@ -30,6 +35,8 @@ class HonAppliance:
         self._attributes: Dict = {}
         self._zone: int = zone
         self._additional_data: Dict[str, Any] = {}
+        self._last_update = None
+        self._default_setting = HonParameter("", {}, "")
 
         try:
             self._extra = importlib.import_module(
@@ -92,8 +99,15 @@ class HonAppliance:
         return self._check_name_zone("nickName")
 
     @property
-    def commands_options(self):
+    def code(self) -> str:
-        return self._appliance_model.get("options")
+        if code := self.info.get("code"):
+            return code
+        serial_number = self.info.get("serialNumber", "")
+        return serial_number[:8] if len(serial_number) < 18 else serial_number[:11]
+
+    @property
+    def options(self):
+        return self._appliance_model.get("options", {})
 
     @property
     def commands(self):
@@ -120,9 +134,7 @@ class HonAppliance:
         return self._zone
 
     @property
-    def api(self) -> "HonAPI":
+    def api(self) -> Optional["HonAPI"]:
-        if self._api is None:
-            raise exceptions.NoAuthenticationException
         return self._api
 
     async def _recover_last_command_states(self):
@@ -139,8 +151,13 @@ class HonAppliance:
             if last is None:
                 continue
             parameters = command_history[last].get("command", {}).get("parameters", {})
-            if command.categories and parameters.get("category"):
+            if command.categories and (
-                command.category = parameters.pop("category").split(".")[-1].lower()
+                parameters.get("program") or parameters.get("category")
+            ):
+                if parameters.get("program"):
+                    command.category = parameters.pop("program").split(".")[-1].lower()
+                else:
+                    command.category = parameters.pop("category")
                 command = self.commands[name]
             for key, data in command.settings.items():
                 if (
@@ -159,6 +176,8 @@ class HonAppliance:
                     category = category.split(".")[-1].lower()
                 categories[category] = result[0]
         if categories:
+            if "setParameters" in categories:
+                return [categories["setParameters"]]
             return [list(categories.values())[0]]
         return []
 
@@ -192,7 +211,7 @@ class HonAppliance:
     async def load_commands(self):
         raw = await self.api.load_commands(self)
         self._appliance_model = raw.pop("applianceModel")
-        raw.pop("dictionaryId")
+        raw.pop("dictionaryId", None)
         self._commands = self._get_commands(raw)
         await self._recover_last_command_states()
 
@@ -203,9 +222,15 @@ class HonAppliance:
 
     async def load_statistics(self):
         self._statistics = await self.api.load_statistics(self)
+        self._statistics |= await self.api.load_maintenance(self)
 
     async def update(self):
-        await self.load_attributes()
+        now = datetime.now()
+        if not self._last_update or self._last_update < now - timedelta(
+            seconds=self._MINIMAL_UPDATE_INTERVAL
+        ):
+            self._last_update = now
+            await self.load_attributes()
 
     @property
     def command_parameters(self):
@@ -216,12 +241,20 @@ class HonAppliance:
         result = {}
         for name, command in self._commands.items():
             for key in command.setting_keys:
-                setting = command.settings.get(key, HonParameter(key, {}, name))
+                setting = command.settings.get(key, self._default_setting)
                 result[f"{name}.{key}"] = setting
         if self._extra:
             return self._extra.settings(result)
         return result
 
+    @property
+    def available_settings(self):
+        result = []
+        for name, command in self._commands.items():
+            for key in command.setting_keys:
+                result.append(f"{name}.{key}")
+        return result
+
     @property
     def data(self):
         result = {
@@ -235,21 +268,60 @@ class HonAppliance:
             return self._extra.data(result)
         return result
 
-    def diagnose(self, whitespace="\u200B \u200B "):
+    def diagnose(self, whitespace="  ", command_only=False):
         data = {
             "attributes": self.attributes.copy(),
             "appliance": self.info,
+            "statistics": self.statistics,
             "additional_data": self._additional_data,
         }
+        if command_only:
+            data.pop("attributes")
+            data.pop("appliance")
+            data.pop("statistics")
         data |= {n: c.parameter_groups for n, c in self._commands.items()}
         extra = {n: c.data for n, c in self._commands.items() if c.data}
         if extra:
             data |= {"extra_command_data": extra}
-        for sensible in ["PK", "SK", "serialNumber", "code", "coords"]:
+        for sensible in ["PK", "SK", "serialNumber", "coords", "device"]:
-            data["appliance"].pop(sensible, None)
+            data.get("appliance", {}).pop(sensible, None)
         result = helper.pretty_print({"data": data}, whitespace=whitespace)
         result += helper.pretty_print(
-            {"commands": helper.create_command(self.commands)},
+            {
+                "commands": helper.create_command(self.commands),
+                "rules": helper.create_rules(self.commands),
+            },
             whitespace=whitespace,
         )
         return result.replace(self.mac_address, "xx-xx-xx-xx-xx-xx")
+
+
+class HonApplianceTest(HonAppliance):
+    def __init__(self, name):
+        super().__init__(None, {})
+        self._name = name
+        self.load_commands()
+        self._info = self._appliance_model
+
+    def load_commands(self):
+        device = Path(__file__).parent / "test_data" / f"{self._name}.json"
+        with open(str(device)) as f:
+            raw = json.loads(f.read())
+        self._appliance_model = raw.pop("applianceModel")
+        raw.pop("dictionaryId", None)
+        self._commands = self._get_commands(raw)
+
+    async def update(self):
+        return
+
+    @property
+    def nick_name(self) -> str:
+        return self._name
+
+    @property
+    def unique_id(self) -> str:
+        return self._name
+
+    @property
+    def mac_address(self) -> str:
+        return "xx-xx-xx-xx-xx-xx"

pyhon/commands.py

@@ -1,15 +1,20 @@
+import logging
 from typing import Optional, Dict, Any, List, TYPE_CHECKING, Union
 
+from pyhon import exceptions
 from pyhon.parameter.base import HonParameter
 from pyhon.parameter.enum import HonParameterEnum
 from pyhon.parameter.fixed import HonParameterFixed
 from pyhon.parameter.program import HonParameterProgram
 from pyhon.parameter.range import HonParameterRange
+from pyhon.rules import HonRuleSet
 
 if TYPE_CHECKING:
     from pyhon import HonAPI
     from pyhon.appliance import HonAppliance
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class HonCommand:
     def __init__(
@@ -20,7 +25,7 @@ class HonCommand:
         categories: Optional[Dict[str, "HonCommand"]] = None,
         category_name: str = "",
     ):
-        self._api: HonAPI = appliance.api
+        self._api: Optional[HonAPI] = appliance.api
         self._appliance: "HonAppliance" = appliance
         self._name: str = name
         self._categories: Optional[Dict[str, "HonCommand"]] = categories
@@ -29,6 +34,8 @@ class HonCommand:
         self._protocol_type: str = attributes.pop("protocolType", "")
         self._parameters: Dict[str, HonParameter] = {}
         self._data: Dict[str, Any] = {}
+        self._available_settings: Dict[str, HonParameter] = {}
+        self._rules: List[HonRuleSet] = []
         self._load_parameters(attributes)
 
     def __repr__(self) -> str:
@@ -38,6 +45,16 @@ class HonCommand:
     def name(self):
         return self._name
 
+    @property
+    def api(self) -> "HonAPI":
+        if self._api is None:
+            raise exceptions.NoAuthenticationException
+        return self._api
+
+    @property
+    def appliance(self) -> "HonAppliance":
+        return self._appliance
+
     @property
     def data(self):
         return self._data
@@ -46,6 +63,10 @@ class HonCommand:
     def parameters(self) -> Dict[str, HonParameter]:
         return self._parameters
 
+    @property
+    def settings(self) -> Dict[str, HonParameter]:
+        return self._parameters
+
     @property
     def parameter_groups(self) -> Dict[str, Dict[str, Union[str, float]]]:
         result: Dict[str, Dict[str, Union[str, float]]] = {}
@@ -61,10 +82,17 @@ class HonCommand:
         for key, items in attributes.items():
             for name, data in items.items():
                 self._create_parameters(data, name, key)
+        for rule in self._rules:
+            rule.patch()
 
     def _create_parameters(self, data: Dict, name: str, parameter: str) -> None:
         if name == "zoneMap" and self._appliance.zone:
             data["default"] = self._appliance.zone
+        if data.get("category") == "rule":
+            if "fixedValue" not in data:
+                _LOGGER.error("Rule not supported: %s", data)
+            else:
+                self._rules.append(HonRuleSet(self, data["fixedValue"]))
         match data.get("typology"):
             case "range":
                 self._parameters[name] = HonParameterRange(name, data, parameter)
@@ -76,15 +104,13 @@ class HonCommand:
                 self._data[name] = data
                 return
         if self._category_name:
-            if not self._categories:
+            name = "program" if "PROGRAM" in self._category_name else "category"
-                self._parameters["program"] = HonParameterProgram(
+            self._parameters[name] = HonParameterProgram(name, self, "custom")
-                    "program", self, "custom"
-                )
 
     async def send(self) -> bool:
-        params = self.parameter_groups["parameters"]
+        params = self.parameter_groups.get("parameters", {})
-        ancillary_params = self.parameter_groups["ancillary_parameters"]
+        ancillary_params = self.parameter_groups.get("ancillaryParameters", {})
-        return await self._api.send_command(
+        return await self.api.send_command(
             self._appliance, self._name, params, ancillary_params
         )
 
@@ -100,7 +126,8 @@ class HonCommand:
 
     @category.setter
     def category(self, category: str) -> None:
-        self._appliance.commands[self._name] = self.categories[category]
+        if category in self.categories:
+            self._appliance.commands[self._name] = self.categories[category]
 
     @property
     def setting_keys(self) -> List[str]:
@@ -119,11 +146,12 @@ class HonCommand:
         return first
 
     @property
-    def settings(self) -> Dict[str, HonParameter]:
+    def available_settings(self) -> Dict[str, HonParameter]:
         result: Dict[str, HonParameter] = {}
         for command in self.categories.values():
             for name, parameter in command.parameters.items():
                 if name in result:
                     result[name] = self._more_options(result[name], parameter)
-                result[name] = parameter
+                else:
+                    result[name] = parameter
         return result

pyhon/connection/api.py

@@ -72,21 +72,23 @@ class HonAPI:
     async def load_commands(self, appliance: HonAppliance) -> Dict:
         params: Dict = {
             "applianceType": appliance.appliance_type,
-            "code": appliance.info["code"],
             "applianceModelId": appliance.appliance_model_id,
             "macAddress": appliance.mac_address,
             "os": const.OS,
             "appVersion": const.APP_VERSION,
-            "series": appliance.info["series"],
+            "code": appliance.code,
         }
         if firmware_id := appliance.info.get("eepromId"):
             params["firmwareId"] = firmware_id
         if firmware_version := appliance.info.get("fwVersion"):
             params["fwVersion"] = firmware_version
+        if series := appliance.info.get("series"):
+            params["series"] = series
         url: str = f"{const.API_URL}/commands/v1/retrieve"
         async with self._hon.get(url, params=params) as response:
             result: Dict = (await response.json()).get("payload", {})
             if not result or result.pop("resultCode") != "0":
+                _LOGGER.error(await response.json())
                 return {}
             return result
 
@@ -100,6 +102,16 @@ class HonAPI:
                 return {}
             return result["payload"]["history"]
 
+    async def command_favourites(self, appliance: HonAppliance) -> Dict:
+        url: str = (
+            f"{const.API_URL}/commands/v1/appliance/{appliance.mac_address}/favourite"
+        )
+        async with self._hon.get(url) as response:
+            result: Dict = await response.json()
+            if not result or not result.get("payload"):
+                return {}
+            return result["payload"]["favourites"]
+
     async def last_activity(self, appliance: HonAppliance) -> Dict:
         url: str = f"{const.API_URL}/commands/v1/retrieve-last-activity"
         params: Dict = {"macAddress": appliance.mac_address}
@@ -140,6 +152,12 @@ class HonAPI:
         async with self._hon.get(url, params=params) as response:
             return (await response.json()).get("payload", {})
 
+    async def load_maintenance(self, appliance: HonAppliance):
+        url = f"{const.API_URL}/commands/v1/maintenance-cycle"
+        params = {"macAddress": appliance.mac_address}
+        async with self._hon.get(url, params=params) as response:
+            return (await response.json()).get("payload", {})
+
     async def send_command(
         self,
         appliance: HonAppliance,
@@ -153,7 +171,7 @@ class HonAPI:
             "timestamp": f"{now[:-3]}Z",
             "commandName": command,
             "transactionId": f"{appliance.mac_address}_{now[:-3]}Z",
-            "applianceOptions": appliance.commands_options,
+            "applianceOptions": appliance.options,
             "device": self._hon.device.get(mobile=True),
             "attributes": {
                 "channel": "mobileApp",

pyhon/helper.py

@@ -1,6 +1,3 @@
-from pyhon.parameter.base import HonParameter
-
-
 def key_print(data, key="", start=True):
     result = ""
     if isinstance(data, list):
@@ -47,21 +44,10 @@ def pretty_print(data, key="", intend=0, is_list=False, whitespace="  "):
     return result
 
 
-def get_parameter(command, parameter):
-    if programs := command.categories:
-        for program in programs.values():
-            if data := program.settings.get(parameter):
-                return data
-    return command.settings.get(parameter)
-
-
 def create_command(commands, concat=False):
     result = {}
     for name, command in commands.items():
-        if not concat:
+        for parameter, data in command.available_settings.items():
-            result[name] = {}
-        for parameter in command.setting_keys:
-            data = get_parameter(command, parameter)
             if data.typology == "enum":
                 value = data.values
             elif data.typology == "range":
@@ -69,7 +55,21 @@ def create_command(commands, concat=False):
             else:
                 continue
             if not concat:
-                result[name][parameter] = value
+                result.setdefault(name, {})[parameter] = value
+            else:
+                result[f"{name}.{parameter}"] = value
+    return result
+
+
+def create_rules(commands, concat=False):
+    result = {}
+    for name, command in commands.items():
+        for parameter, data in command.available_settings.items():
+            value = data.triggers
+            if not value:
+                continue
+            if not concat:
+                result.setdefault(name, {})[parameter] = value
             else:
                 result[f"{name}.{parameter}"] = value
     return result

pyhon/hon.py

@@ -1,4 +1,5 @@
 import asyncio
+import logging
 from types import TracebackType
 from typing import List, Optional, Dict, Any, Type
 
@@ -8,11 +9,18 @@ from typing_extensions import Self
 from pyhon import HonAPI, exceptions
 from pyhon.appliance import HonAppliance
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class Hon:
-    def __init__(self, email: str, password: str, session: ClientSession | None = None):
+    def __init__(
-        self._email: str = email
+        self,
-        self._password: str = password
+        email: Optional[str] = "",
+        password: Optional[str] = "",
+        session: Optional[ClientSession] = None,
+    ):
+        self._email: Optional[str] = email
+        self._password: Optional[str] = password
         self._session: ClientSession | None = session
         self._appliances: List[HonAppliance] = []
         self._api: Optional[HonAPI] = None
@@ -34,9 +42,21 @@ class Hon:
             raise exceptions.NoAuthenticationException
         return self._api
 
+    @property
+    def email(self) -> str:
+        if not self._email:
+            raise ValueError("Missing email")
+        return self._email
+
+    @property
+    def password(self) -> str:
+        if not self._password:
+            raise ValueError("Missing password")
+        return self._password
+
     async def create(self) -> Self:
         self._api = await HonAPI(
-            self._email, self._password, session=self._session
+            self.email, self.password, session=self._session
         ).create()
         await self.setup()
         return self
@@ -45,17 +65,25 @@ class Hon:
     def appliances(self) -> List[HonAppliance]:
         return self._appliances
 
+    @appliances.setter
+    def appliances(self, appliances) -> None:
+        self._appliances = appliances
+
     async def _create_appliance(self, appliance_data: Dict[str, Any], zone=0) -> None:
         appliance = HonAppliance(self._api, appliance_data, zone=zone)
         if appliance.mac_address == "":
             return
-        await asyncio.gather(
+        try:
-            *[
+            await asyncio.gather(
-                appliance.load_attributes(),
+                *[
-                appliance.load_commands(),
+                    appliance.load_attributes(),
-                appliance.load_statistics(),
+                    appliance.load_commands(),
-            ]
+                    appliance.load_statistics(),
-        )
+                ]
+            )
+        except (KeyError, ValueError, IndexError) as error:
+            _LOGGER.exception(error)
+            _LOGGER.error("Device data - %s", appliance_data)
         self._appliances.append(appliance)
 
     async def setup(self) -> None:

pyhon/parameter/base.py

@@ -1,4 +1,7 @@
-from typing import Dict, Any, List
+from typing import Dict, Any, List, Tuple, Callable, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from pyhon.rules import HonRule
 
 
 class HonParameter:
@@ -9,6 +12,7 @@ class HonParameter:
         self._mandatory: int = attributes.get("mandatory", 0)
         self._value: str | float = ""
         self._group: str = group
+        self._triggers: Dict[str, List[Tuple[Callable, "HonRule"]]] = {}
 
     @property
     def key(self) -> str:
@@ -37,3 +41,21 @@ class HonParameter:
     @property
     def group(self) -> str:
         return self._group
+
+    def add_trigger(self, value, func, data):
+        if self._value == value:
+            func(data)
+        self._triggers.setdefault(value, []).append((func, data))
+
+    def check_trigger(self, value) -> None:
+        if str(value) in self._triggers:
+            for trigger in self._triggers[str(value)]:
+                func, args = trigger
+                func(args)
+
+    @property
+    def triggers(self):
+        result = {}
+        for value, rules in self._triggers.items():
+            result[value] = {rule.param_key: rule.param_value for _, rule in rules}
+        return result

pyhon/parameter/enum.py

@@ -9,6 +9,8 @@ class HonParameterEnum(HonParameter):
         self._default = attributes.get("defaultValue")
         self._value = self._default or "0"
         self._values: List[str] = attributes.get("enumValues", [])
+        if self._default and str(self._default.strip("[]")) not in self.values:
+            self._values.append(self._default)
 
     def __repr__(self) -> str:
         return f"{self.__class__} (<{self.key}> {self.values})"
@@ -17,6 +19,10 @@ class HonParameterEnum(HonParameter):
     def values(self) -> List[str]:
         return [str(value) for value in self._values]
 
+    @values.setter
+    def values(self, values) -> None:
+        self._values = values
+
     @property
     def value(self) -> str | float:
         return self._value if self._value is not None else self.values[0]
@@ -25,5 +31,6 @@ class HonParameterEnum(HonParameter):
     def value(self, value: str) -> None:
         if value in self.values:
             self._value = value
+            self.check_trigger(value)
         else:
-            raise ValueError(f"Allowed values {self._value}")
+            raise ValueError(f"Allowed values {self._values}")

pyhon/parameter/fixed.py

@@ -19,3 +19,4 @@ class HonParameterFixed(HonParameter):
     def value(self, value: str | float) -> None:
         # Fixed values seems being not so fixed as thought
         self._value = value
+        self.check_trigger(value)

pyhon/parameter/program.py

@@ -12,7 +12,10 @@ class HonParameterProgram(HonParameterEnum):
     def __init__(self, key: str, command: "HonCommand", group: str) -> None:
         super().__init__(key, {}, group)
         self._command = command
-        self._value: str = command.category
+        if "PROGRAM" in command.category:
+            self._value = command.category.split(".")[-1].lower()
+        else:
+            self._value = command.category
         self._programs: Dict[str, "HonCommand"] = command.categories
         self._typology: str = "enum"
 
@@ -32,8 +35,12 @@ class HonParameterProgram(HonParameterEnum):
         values = [v for v in self._programs if all(f not in v for f in self._FILTER)]
         return sorted(values)
 
+    @values.setter
+    def values(self, values) -> None:
+        return
+
     @property
-    def ids(self):
+    def ids(self) -> Dict[int, str]:
         values = {
             int(p.parameters["prCode"].value): n
             for i, (n, p) in enumerate(self._programs.items())

pyhon/parameter/range.py

@@ -32,6 +32,8 @@ class HonParameterRange(HonParameter):
 
     @property
     def step(self) -> float:
+        if not self._step:
+            return 1
         return self._step
 
     @property
@@ -41,8 +43,9 @@ class HonParameterRange(HonParameter):
     @value.setter
     def value(self, value: float) -> None:
         value = str_to_float(value)
-        if self._min <= value <= self._max and not value % self._step:
+        if self._min <= value <= self._max and not (value - self._min) % self._step:
             self._value = value
+            self.check_trigger(value)
         else:
             raise ValueError(
                 f"Allowed: min {self._min} max {self._max} step {self._step}"

pyhon/rules.py

@@ -0,0 +1,62 @@
+from dataclasses import dataclass
+from typing import List, Dict, TYPE_CHECKING
+
+from pyhon.parameter.enum import HonParameterEnum
+from pyhon.parameter.range import HonParameterRange
+
+if TYPE_CHECKING:
+    from pyhon.commands import HonCommand
+
+
+@dataclass
+class HonRule:
+    trigger_key: str
+    trigger_value: str
+    param_key: str
+    param_value: str
+
+
+class HonRuleSet:
+    def __init__(self, command: "HonCommand", rule):
+        self._command: "HonCommand" = command
+        self._rules: Dict[str, List[HonRule]] = {}
+        self._parse_rule(rule)
+
+    def _parse_rule(self, rule):
+        for entity_key, params in rule.items():
+            entity_key = self._command.appliance.options.get(entity_key, entity_key)
+            for trigger_key, values in params.items():
+                trigger_key = trigger_key.replace("@", "")
+                trigger_key = self._command.appliance.options.get(
+                    trigger_key, trigger_key
+                )
+                for trigger_value, entity_value in values.items():
+                    if entity_value.get("fixedValue") == f"@{entity_key}":
+                        continue
+                    self._rules.setdefault(trigger_key, []).append(
+                        HonRule(
+                            trigger_key,
+                            trigger_value,
+                            entity_key,
+                            entity_value.get("fixedValue"),
+                        )
+                    )
+
+    def patch(self):
+        for name, parameter in self._command.parameters.items():
+            if name not in self._rules:
+                continue
+            for data in self._rules.get(name):
+
+                def apply(rule):
+                    if param := self._command.parameters.get(rule.param_key):
+                        if isinstance(param, HonParameterEnum) and set(
+                            param.values
+                        ) != {str(rule.param_value)}:
+                            param.values = [str(rule.param_value)]
+                        elif isinstance(param, HonParameterRange):
+                            param.value = float(rule.param_value)
+                            return
+                        param.value = str(rule.param_value)
+
+                parameter.add_trigger(data.trigger_value, apply, data)

setup.py

@@ -7,7 +7,7 @@ with open("README.md", "r") as f:
 
 setup(
     name="pyhOn",
-    version="0.10.0",
+    version="0.11.0",
     author="Andre Basche",
     description="Control hOn devices with python",
     long_description=long_description,