More general parsing

Oven overwrite

pyhon/appliance.py

@@ -1,15 +1,19 @@
 import importlib
+import logging
 from contextlib import suppress
 from typing import Optional, Dict, Any
 from typing import TYPE_CHECKING
 
 from pyhon import helper
 from pyhon.commands import HonCommand
+from pyhon.parameter.base import HonParameter
 from pyhon.parameter.fixed import HonParameterFixed
 
 if TYPE_CHECKING:
     from pyhon import HonAPI
 
+_LOGGER = logging.getLogger(__name__)
+
 
 class HonAppliance:
     def __init__(
@@ -25,11 +29,12 @@ class HonAppliance:
         self._statistics: Dict = {}
         self._attributes: Dict = {}
         self._zone: int = zone
+        self._additional_data = {}
 
         try:
             self._extra = importlib.import_module(
                 f"pyhon.appliances.{self.appliance_type.lower()}"
-            ).Appliance()
+            ).Appliance(self)
         except ModuleNotFoundError:
             self._extra = None
 
@@ -106,13 +111,17 @@ class HonAppliance:
     def info(self):
         return self._info
 
+    @property
+    def additional_data(self):
+        return self._additional_data
+
     @property
     def zone(self) -> int:
         return self._zone
 
-    async def _recover_last_command_states(self, commands):
+    async def _recover_last_command_states(self):
         command_history = await self._api.command_history(self)
-        for name, command in commands.items():
+        for name, command in self._commands.items():
             last = next(
                 (
                     index
@@ -124,8 +133,8 @@ class HonAppliance:
             if last is None:
                 continue
             parameters = command_history[last].get("command", {}).get("parameters", {})
-            if command.programs and parameters.get("program"):
-                command.program = parameters.pop("program").split(".")[-1].lower()
+            if command.categories and parameters.get("category"):
+                command.category = parameters.pop("category").split(".")[-1].lower()
                 command = self.commands[name]
             for key, data in command.settings.items():
                 if (
@@ -135,51 +144,50 @@ class HonAppliance:
                     with suppress(ValueError):
                         data.value = parameters.get(key)
 
+    def _get_categories(self, command, data):
+        categories = {}
+        for category, value in data.items():
+            result = self._get_command(value, command, category, categories)
+            if result:
+                if "PROGRAM" in category:
+                    category = category.split(".")[-1].lower()
+                categories[category] = result[0]
+        if categories:
+            return [list(categories.values())[0]]
+        return []
+
+    def _get_commands(self, data):
+        commands = []
+        for command, value in data.items():
+            commands += self._get_command(value, command, "")
+        return {c.name: c for c in commands}
+
+    def _get_command(self, data, command="", category="", categories=None):
+        commands = []
+        if isinstance(data, dict):
+            if data.get("description") and data.get("protocolType", None):
+                commands += [
+                    HonCommand(
+                        command,
+                        data,
+                        self._api,
+                        self,
+                        category_name=category,
+                        categories=categories,
+                    )
+                ]
+            else:
+                commands += self._get_categories(command, data)
+        else:
+            self._additional_data[command] = data
+        return commands
+
     async def load_commands(self):
         raw = await self._api.load_commands(self)
         self._appliance_model = raw.pop("applianceModel")
-        for item in ["settings", "options", "dictionaryId"]:
-            raw.pop(item)
-        commands = {}
-        for command, attr in raw.items():
-            if "parameters" in attr:
-                commands[command] = HonCommand(command, attr, self._api, self)
-            elif "parameters" in attr[list(attr)[0]]:
-                multi = {}
-                for program, attr2 in attr.items():
-                    program = program.split(".")[-1].lower()
-                    cmd = HonCommand(
-                        command,
-                        attr2,
-                        self._api,
-                        self,
-                        programs=multi,
-                        program_name=program,
-                    )
-                    multi[program] = cmd
-                    commands[command] = cmd
-        self._commands = commands
-        await self._recover_last_command_states(commands)
-
-    @property
-    def settings(self):
-        result = {}
-        for name, command in self._commands.items():
-            for key, setting in command.settings.items():
-                result[f"{name}.{key}"] = setting
-        if self._extra:
-            return self._extra.settings(result)
-        return result
-
-    @property
-    def parameters(self):
-        result = {}
-        for name, command in self._commands.items():
-            for key, parameter in (
-                command.parameters | command.ancillary_parameters
-            ).items():
-                result.setdefault(name, {})[key] = parameter.value
-        return result
+        raw.pop("dictionaryId")
+        self._commands = self._get_commands(raw)
+        await self._recover_last_command_states()
 
     async def load_attributes(self):
         self._attributes = await self._api.load_attributes(self)
@@ -192,12 +200,32 @@ class HonAppliance:
     async def update(self):
         await self.load_attributes()
 
+    @property
+    def parameters(self):
+        result = {}
+        for name, command in self._commands.items():
+            for key, parameter in command.parameters.items():
+                result.setdefault(name, {})[key] = parameter.value
+        return result
+
+    @property
+    def settings(self):
+        result = {}
+        for name, command in self._commands.items():
+            for key in command.setting_keys:
+                setting = command.settings.get(key, HonParameter(key, {}, name))
+                result[f"{name}.{key}"] = setting
+        if self._extra:
+            return self._extra.settings(result)
+        return result
+
     @property
     def data(self):
         result = {
             "attributes": self.attributes,
             "appliance": self.info,
             "statistics": self.statistics,
+            "additional_data": self._additional_data,
             **self.parameters,
         }
         if self._extra:
@@ -214,4 +242,4 @@ class HonAppliance:
             {"commands": helper.create_command(self.commands)},
             whitespace="\u200B \u200B ",
         )
-        return result.replace(self.mac_address, "12-34-56-78-90-ab")
+        return result.replace(self.mac_address, "xx-xx-xx-xx-xx-xx")

pyhon/appliances/dw.py

@@ -1,4 +1,7 @@
 class Appliance:
+    def __init__(self, appliance):
+        self.parent = appliance
+
     def data(self, data):
         if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED":
             data["attributes"]["parameters"]["machMode"] = "0"

pyhon/appliances/ov.py

@@ -0,0 +1,17 @@
+class Appliance:
+    def __init__(self, appliance):
+        self.parent = appliance
+
+    def data(self, data):
+        if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED":
+            data["attributes"]["parameters"]["temp"] = "0"
+            data["attributes"]["parameters"]["onOffStatus"] = "0"
+            data["attributes"]["parameters"]["remoteCtrValid"] = "0"
+            data["attributes"]["parameters"]["remainingTimeMM"] = "0"
+
+        data["active"] = data["attributes"]["parameters"]["onOffStatus"] == "1"
+
+        return data
+
+    def settings(self, settings):
+        return settings

pyhon/appliances/td.py

@@ -1,10 +1,22 @@
+from pyhon.parameter.fixed import HonParameterFixed
+
+
 class Appliance:
+    def __init__(self, appliance):
+        self.parent = appliance
+
     def data(self, data):
         if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED":
             data["attributes"]["parameters"]["machMode"] = "0"
         data["active"] = bool(data.get("attributes", {}).get("activity"))
         data["pause"] = data["attributes"]["parameters"]["machMode"] == "3"
+        if program := int(data["attributes"]["parameters"]["prCode"]):
+            ids = self.parent.settings["startProgram.program"].ids
+            data["programName"] = ids.get(program, "")
         return data
 
     def settings(self, settings):
+        dry_level = settings.get("startProgram.dryLevel")
+        if isinstance(dry_level, HonParameterFixed) and dry_level.value == "11":
+            settings.pop("startProgram.dryLevel", None)
         return settings

pyhon/appliances/wd.py

@@ -1,4 +1,7 @@
 class Appliance:
+    def __init__(self, appliance):
+        self.parent = appliance
+
     def data(self, data):
         if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED":
             data["attributes"]["parameters"]["machMode"] = "0"

pyhon/appliances/wm.py

@@ -1,4 +1,7 @@
 class Appliance:
+    def __init__(self, appliance):
+        self.parent = appliance
+
     def data(self, data):
         if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED":
             data["attributes"]["parameters"]["machMode"] = "0"

pyhon/commands.py

@@ -18,100 +18,95 @@ class HonCommand:
         attributes: Dict[str, Any],
         api: "HonAPI",
         appliance: "HonAppliance",
-        programs: Optional[Dict[str, "HonCommand"]] = None,
-        program_name: str = "",
+        categories: Optional[Dict[str, "HonCommand"]] = None,
+        category_name: str = "",
     ):
         self._api: HonAPI = api
         self._appliance: "HonAppliance" = appliance
         self._name: str = name
-        self._programs: Optional[Dict[str, "HonCommand"]] = programs or {}
-        self._program_name: str = program_name
-        self._description: str = attributes.get("description", "")
-        self._parameters: Dict[str, HonParameter] = self._create_parameters(
-            attributes.get("parameters", {})
-        )
-        self._ancillary_parameters: Dict[str, HonParameter] = self._create_parameters(
-            attributes.get("ancillaryParameters", {})
-        )
+        self._categories: Optional[Dict[str, "HonCommand"]] = categories
+        self._category_name: str = category_name
+        self._description: str = attributes.pop("description", "")
+        self._protocol_type: str = attributes.pop("protocolType", "")
+        self._parameters: Dict[str, HonParameter] = {}
+        self._data = {}
+        self._load_parameters(attributes)
 
     def __repr__(self) -> str:
         return f"{self._name} command"
 
-    def _create_parameters(self, parameters: Dict) -> Dict[str, HonParameter]:
-        result: Dict[str, HonParameter] = {}
-        for parameter, attributes in parameters.items():
-            if parameter == "zoneMap" and self._appliance.zone:
-                attributes["default"] = self._appliance.zone
-            match attributes.get("typology"):
-                case "range":
-                    result[parameter] = HonParameterRange(parameter, attributes)
-                case "enum":
-                    result[parameter] = HonParameterEnum(parameter, attributes)
-                case "fixed":
-                    result[parameter] = HonParameterFixed(parameter, attributes)
-        if self._programs:
-            result["program"] = HonParameterProgram("program", self)
-        return result
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def data(self):
+        return self._data
 
     @property
     def parameters(self) -> Dict[str, HonParameter]:
         return self._parameters
 
-    @property
-    def ancillary_parameters(self) -> Dict[str, HonParameter]:
-        return self._ancillary_parameters
+    def _load_parameters(self, attributes):
+        for key, items in attributes.items():
+            for name, data in items.items():
+                self._create_parameters(data, name, key)
+
+    def _create_parameters(self, data: Dict, name: str, parameter: str) -> None:
+        if name == "zoneMap" and self._appliance.zone:
+            data["default"] = self._appliance.zone
+        match data.get("typology"):
+            case "range":
+                self._parameters[name] = HonParameterRange(name, data, parameter)
+            case "enum":
+                self._parameters[name] = HonParameterEnum(name, data, parameter)
+            case "fixed":
+                self._parameters[name] = HonParameterFixed(name, data, parameter)
+            case _:
+                self._data[name] = data
+                return
+        if self._category_name:
+            if not self._categories:
+                self._parameters["program"] = HonParameterProgram("program", self, name)
+
+    def _parameters_by_group(self, group):
+        return {
+            name: v.value for name, v in self._parameters.items() if v.group == group
+        }
 
     async def send(self) -> bool:
-        params = {k: v.value for k, v in self._parameters.items()}
-        ancillary_params = {k: v.value for k, v in self._ancillary_parameters.items()}
+        params = self._parameters_by_group("parameters")
+        ancillary_params = self._parameters_by_group("ancillary_parameters")
         return await self._api.send_command(
             self._appliance, self._name, params, ancillary_params
         )
 
     @property
-    def programs(self) -> Dict[str, "HonCommand"]:
-        if self._programs is None:
-            return {}
-        return self._programs
+    def categories(self) -> Dict[str, "HonCommand"]:
+        if self._categories is None:
+            return {"_": self}
+        return self._categories
 
     @property
-    def program(self) -> str:
-        return self._program_name
+    def category(self) -> str:
+        return self._category_name
 
-    @program.setter
-    def program(self, program: str) -> None:
-        self._appliance.commands[self._name] = self.programs[program]
-
-    def _get_settings_keys(self, command: Optional["HonCommand"] = None) -> List[str]:
-        if command is None:
-            command = self
-        keys = []
-        for key, parameter in (
-            command._parameters | command._ancillary_parameters
-        ).items():
-            if isinstance(parameter, HonParameterFixed):
-                continue
-            if key not in keys:
-                keys.append(key)
-        return keys
+    @category.setter
+    def category(self, category: str) -> None:
+        self._appliance.commands[self._name] = self.categories[category]
 
     @property
     def setting_keys(self) -> List[str]:
-        if not self._programs:
-            return self._get_settings_keys()
-        result = [
-            key
-            for cmd in self._programs.values()
-            for key in self._get_settings_keys(cmd)
-        ]
-        return list(set(result + ["program"]))
+        return list(
+            {param for cmd in self.categories.values() for param in cmd.parameters}
+        )
 
     @property
     def settings(self) -> Dict[str, HonParameter]:
-        """Parameters with typology enum and range"""
-        return {
-            s: param
-            for s in self.setting_keys
-            if (param := self._parameters.get(s)) is not None
-            or (param := self._ancillary_parameters.get(s)) is not None
-        }
+        result = {}
+        for command in self.categories.values():
+            for name, parameter in command.parameters.items():
+                if name in result:
+                    continue
+                result[name] = parameter
+        return result

pyhon/connection/api.py

@@ -12,7 +12,7 @@ from pyhon.connection.auth import HonAuth
 from pyhon.connection.handler.anonym import HonAnonymousConnectionHandler
 from pyhon.connection.handler.hon import HonConnectionHandler
 
-_LOGGER = logging.getLogger()
+_LOGGER = logging.getLogger(__name__)
 
 
 class HonAPI:
@@ -74,13 +74,15 @@ class HonAPI:
             "applianceType": appliance.appliance_type,
             "code": appliance.info["code"],
             "applianceModelId": appliance.appliance_model_id,
-            "firmwareId": appliance.info["eepromId"],
             "macAddress": appliance.mac_address,
-            "fwVersion": appliance.info["fwVersion"],
             "os": const.OS,
             "appVersion": const.APP_VERSION,
             "series": appliance.info["series"],
         }
+        if firmware_id := appliance.info.get("eepromId"):
+            params["firmwareId"] = firmware_id
+        if firmware_version := appliance.info.get("fwVersion"):
+            params["fwVersion"] = firmware_version
         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", {})
@@ -107,6 +109,18 @@ class HonAPI:
                 return activity
         return {}
 
+    async def appliance_model(self, appliance: HonAppliance) -> Dict:
+        url: str = f"{const.API_URL}/commands/v1/appliance-model"
+        params: Dict = {
+            "code": appliance.info["code"],
+            "macAddress": appliance.mac_address,
+        }
+        async with self._hon.get(url, params=params) as response:
+            result: Dict = await response.json()
+            if result and (activity := result.get("attributes")):
+                return activity
+        return {}
+
     async def load_attributes(self, appliance: HonAppliance) -> Dict:
         params: Dict = {
             "macAddress": appliance.mac_address,
@@ -159,7 +173,7 @@ class HonAPI:
         return False
 
     async def appliance_configuration(self) -> Dict:
-        url: str = f"{const.API_URL}/config/v1/appliance-configuration"
+        url: str = f"{const.API_URL}/config/v1/program-list-rules"
         async with self._hon_anonymous.get(url) as response:
             result: Dict = await response.json()
             if result and (data := result.get("payload")):

pyhon/connection/auth.py

@@ -182,13 +182,14 @@ class HonAuth:
             await self._error_logger(response)
             return ""
 
-    def _parse_token_data(self, text: str) -> None:
+    def _parse_token_data(self, text: str) -> bool:
         if access_token := re.findall("access_token=(.*?)&", text):
             self._access_token = access_token[0]
         if refresh_token := re.findall("refresh_token=(.*?)&", text):
             self._refresh_token = refresh_token[0]
         if id_token := re.findall("id_token=(.*?)&", text):
             self._id_token = id_token[0]
+        return True if access_token and refresh_token and id_token else False
 
     async def _get_token(self, url: str) -> bool:
         async with self._request.get(url) as response:
@@ -214,7 +215,9 @@ class HonAuth:
             if response.status != 200:
                 await self._error_logger(response)
                 return False
-            self._parse_token_data(await response.text())
+            if not self._parse_token_data(await response.text()):
+                await self._error_logger(response)
+                return False
         return True
 
     async def _api_auth(self) -> bool:
@@ -228,7 +231,10 @@ class HonAuth:
             except json.JSONDecodeError:
                 await self._error_logger(response)
                 return False
-            self._cognito_token = json_data["cognitoUser"]["Token"]
+            self._cognito_token = json_data.get("cognitoUser", {}).get("Token", "")
+            if not self._cognito_token:
+                _LOGGER.error(json_data)
+                raise exceptions.HonAuthenticationError()
         return True
 
     async def authenticate(self) -> None:

pyhon/helper.py

@@ -1,3 +1,6 @@
+from pyhon.parameter.base import HonParameter
+
+
 def key_print(data, key="", start=True):
     result = ""
     if isinstance(data, list):
@@ -44,12 +47,21 @@ 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:
             result[name] = {}
-        for parameter, data in command.settings.items():
+        for parameter in command.setting_keys:
+            data = get_parameter(command, parameter)
             if data.typology == "enum":
                 value = data.values
             elif data.typology == "range":

pyhon/hon.py

@@ -47,7 +47,7 @@ class Hon:
 
     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 is None:
+        if appliance.mac_address == "":
             return
         await asyncio.gather(
             *[

pyhon/parameter/base.py

@@ -1,13 +1,14 @@
-from typing import Dict, Any
+from typing import Dict, Any, List
 
 
 class HonParameter:
-    def __init__(self, key: str, attributes: Dict[str, Any]) -> None:
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
         self._key = key
         self._category: str = attributes.get("category", "")
         self._typology: str = attributes.get("typology", "")
         self._mandatory: int = attributes.get("mandatory", 0)
         self._value: str | float = ""
+        self._group: str = group
 
     @property
     def key(self) -> str:
@@ -17,6 +18,10 @@ class HonParameter:
     def value(self) -> str | float:
         return self._value if self._value is not None else "0"
 
+    @property
+    def values(self) -> List[str]:
+        return [str(self.value)]
+
     @property
     def category(self) -> str:
         return self._category
@@ -28,3 +33,7 @@ class HonParameter:
     @property
     def mandatory(self) -> int:
         return self._mandatory
+
+    @property
+    def group(self) -> str:
+        return self._group

pyhon/parameter/enum.py

@@ -4,8 +4,8 @@ from pyhon.parameter.base import HonParameter
 
 
 class HonParameterEnum(HonParameter):
-    def __init__(self, key: str, attributes: Dict[str, Any]) -> None:
-        super().__init__(key, attributes)
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
+        super().__init__(key, attributes, group)
         self._default = attributes.get("defaultValue")
         self._value = self._default or "0"
         self._values: List[str] = attributes.get("enumValues", [])

pyhon/parameter/fixed.py

@@ -4,8 +4,8 @@ from pyhon.parameter.base import HonParameter
 
 
 class HonParameterFixed(HonParameter):
-    def __init__(self, key: str, attributes: Dict[str, Any]) -> None:
-        super().__init__(key, attributes)
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
+        super().__init__(key, attributes, group)
         self._value = attributes.get("fixedValue", None)
 
     def __repr__(self) -> str:

pyhon/parameter/program.py

@@ -1,4 +1,4 @@
-from typing import List, TYPE_CHECKING
+from typing import List, TYPE_CHECKING, Dict
 
 from pyhon.parameter.enum import HonParameterEnum
 
@@ -9,11 +9,11 @@ if TYPE_CHECKING:
 class HonParameterProgram(HonParameterEnum):
     _FILTER = ["iot_recipe", "iot_guided"]
 
-    def __init__(self, key: str, command: "HonCommand") -> None:
-        super().__init__(key, {})
+    def __init__(self, key: str, command: "HonCommand", group: str) -> None:
+        super().__init__(key, {}, group)
         self._command = command
-        self._value: str = command.program
-        self._values: List[str] = list(command.programs)
+        self._value: str = command.category
+        self._programs: Dict[str, "HonCommand"] = command.categories
         self._typology: str = "enum"
 
     @property
@@ -25,9 +25,18 @@ class HonParameterProgram(HonParameterEnum):
         if value in self.values:
             self._command.program = value
         else:
-            raise ValueError(f"Allowed values {self._values}")
+            raise ValueError(f"Allowed values {self.values}")
 
     @property
     def values(self) -> List[str]:
-        values = [v for v in self._values if all(f not in v for f in self._FILTER)]
+        values = [v for v in self._programs if all(f not in v for f in self._FILTER)]
         return sorted(values)
+
+    @property
+    def ids(self):
+        values = {
+            int(p.parameters["prCode"].value): n
+            for i, (n, p) in enumerate(self._programs.items())
+            if "iot_" not in n and p.parameters.get("prCode")
+        }
+        return dict(sorted(values.items()))

pyhon/parameter/range.py

@@ -1,4 +1,4 @@
-from typing import Dict, Any
+from typing import Dict, Any, List
 
 from pyhon.parameter.base import HonParameter
 
@@ -11,8 +11,8 @@ def str_to_float(string: str | float) -> float:
 
 
 class HonParameterRange(HonParameter):
-    def __init__(self, key: str, attributes: Dict[str, Any]) -> None:
-        super().__init__(key, attributes)
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
+        super().__init__(key, attributes, group)
         self._min: float = str_to_float(attributes["minimumValue"])
         self._max: float = str_to_float(attributes["maximumValue"])
         self._step: float = str_to_float(attributes["incrementValue"])
@@ -47,3 +47,7 @@ class HonParameterRange(HonParameter):
             raise ValueError(
                 f"Allowed: min {self._min} max {self._max} step {self._step}"
             )
+
+    @property
+    def values(self) -> List[str]:
+        return [str(i) for i in range(int(self.min), int(self.max) + 1, int(self.step))]

setup.py

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