Fix missing program

pyhon/__main__.py

@@ -78,12 +78,7 @@ async def main():
                     )
                 )
             else:
-                print(helper.pretty_print({"data": device.data}))
+                print(device.diagnose("  "))
-                print(
-                    helper.pretty_print(
-                        {"settings": helper.create_command(device.commands)}
-                    )
-                )
 
 
 def start():

pyhon/appliance.py

@@ -1,22 +1,23 @@
 import importlib
 import logging
 from contextlib import suppress
+from datetime import datetime, timedelta
 from typing import Optional, Dict, Any
 from typing import TYPE_CHECKING
 
-from pyhon import helper
+from pyhon import helper, exceptions
 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:
+    _MINIMAL_UPDATE_INTERVAL = 5  # seconds
+
     def __init__(
         self, api: Optional["HonAPI"], info: Dict[str, Any], zone: int = 0
     ) -> None:
@@ -30,6 +31,8 @@ class HonAppliance:
         self._statistics: Dict = {}
         self._attributes: Dict = {}
         self._zone: int = zone
+        self._additional_data: Dict[str, Any] = {}
+        self._last_update = None
 
         try:
             self._extra = importlib.import_module(
@@ -111,13 +114,23 @@ 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):
+    @property
-        command_history = await self._api.command_history(self)
+    def api(self) -> "HonAPI":
-        for name, command in commands.items():
+        if self._api is None:
+            raise exceptions.NoAuthenticationException
+        return self._api
+
+    async def _recover_last_command_states(self):
+        command_history = await self.api.command_history(self)
+        for name, command in self._commands.items():
             last = next(
                 (
                     index
@@ -129,8 +142,11 @@ class HonAppliance:
             if last is None:
                 continue
             parameters = command_history[last].get("command", {}).get("parameters", {})
-            if command.programs and parameters.get("program"):
+            if command.categories:
-                command.program = parameters.pop("program").split(".")[-1].lower()
+                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 (
@@ -140,84 +156,119 @@ class HonAppliance:
                     with suppress(ValueError):
                         data.value = parameters.get(key)
 
-    async def load_commands(self):
+    def _get_categories(self, command, data):
-        raw = await self._api.load_commands(self)
+        categories = {}
-        self._appliance_model = raw.pop("applianceModel")
+        for category, value in data.items():
-        for item in ["settings", "options", "dictionaryId"]:
+            result = self._get_command(value, command, category, categories)
-            raw.pop(item)
+            if result:
-        commands = {}
+                if "PROGRAM" in category:
-        for command, attr in raw.items():
+                    category = category.split(".")[-1].lower()
-            if "parameters" in attr:
+                categories[category] = result[0]
-                commands[command] = HonCommand(command, attr, self._api, self)
+        if categories:
-            elif "parameters" in attr[list(attr)[0]]:
+            return [list(categories.values())[0]]
-                multi = {}
+        return []
-                for program, attr2 in attr.items():
+
-                    program = program.split(".")[-1].lower()
+    def _get_commands(self, data):
-                    cmd = HonCommand(
+        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,
-                        attr2,
+                        data,
-                        self._api,
                         self,
-                        programs=multi,
+                        category_name=category,
-                        program_name=program,
+                        categories=categories,
                     )
-                    multi[program] = cmd
+                ]
-                    commands[command] = cmd
+            else:
-        self._commands = commands
+                commands += self._get_categories(command, data)
-        await self._recover_last_command_states(commands)
+        elif category:
+            self._additional_data.setdefault(command, {})[category] = 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")
+        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)
+        for name, values in self._attributes.pop("shadow").get("parameters").items():
+            self._attributes.setdefault("parameters", {})[name] = values["parNewVal"]
+
+    async def load_statistics(self):
+        self._statistics = await self.api.load_statistics(self)
+
+    async def update(self):
+        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):
+        return {n: c.parameter_value for n, c in self._commands.items()}
 
     @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, {}))
+                setting = command.settings.get(key)
                 result[f"{name}.{key}"] = setting
         if self._extra:
             return self._extra.settings(result)
         return result
 
     @property
-    def parameters(self):
+    def available_settings(self):
-        result = {}
+        result = []
         for name, command in self._commands.items():
-            for key, parameter in (
+            for key in command.setting_keys:
-                command.parameters | command.ancillary_parameters
+                result.append(f"{name}.{key}")
-            ).items():
-                result.setdefault(name, {})[key] = parameter.value
         return result
 
-    async def load_attributes(self):
-        self._attributes = await self._api.load_attributes(self)
-        for name, values in self._attributes.pop("shadow").get("parameters").items():
-            self._attributes.setdefault("parameters", {})[name] = values["parNewVal"]
-
-    async def load_statistics(self):
-        self._statistics = await self._api.load_statistics(self)
-
-    async def update(self):
-        await self.load_attributes()
-
     @property
     def data(self):
         result = {
             "attributes": self.attributes,
             "appliance": self.info,
             "statistics": self.statistics,
-            **self.parameters,
+            "additional_data": self._additional_data,
+            **self.command_parameters,
         }
         if self._extra:
             return self._extra.data(result)
         return result
 
-    @property
+    def diagnose(self, whitespace="\u200B \u200B "):
-    def diagnose(self):
+        data = {
-        data = self.data.copy()
+            "attributes": self.attributes.copy(),
+            "appliance": self.info,
+            "additional_data": self._additional_data,
+        }
+        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"]:
             data["appliance"].pop(sensible, None)
-        result = helper.pretty_print({"data": self.data}, whitespace="\u200B \u200B ")
+        result = helper.pretty_print({"data": data}, whitespace=whitespace)
         result += helper.pretty_print(
             {"commands": helper.create_command(self.commands)},
-            whitespace="\u200B \u200B ",
+            whitespace=whitespace,
         )
         return result.replace(self.mac_address, "xx-xx-xx-xx-xx-xx")

pyhon/commands.py

@@ -1,4 +1,4 @@
-from typing import Optional, Dict, Any, List, TYPE_CHECKING
+from typing import Optional, Dict, Any, List, TYPE_CHECKING, Union
 
 from pyhon.parameter.base import HonParameter
 from pyhon.parameter.enum import HonParameterEnum
@@ -16,99 +16,117 @@ class HonCommand:
         self,
         name: str,
         attributes: Dict[str, Any],
-        api: "HonAPI",
         appliance: "HonAppliance",
-        programs: Optional[Dict[str, "HonCommand"]] = None,
+        categories: Optional[Dict[str, "HonCommand"]] = None,
-        program_name: str = "",
+        category_name: str = "",
     ):
-        self._api: HonAPI = api
+        self._api: HonAPI = appliance.api
         self._appliance: "HonAppliance" = appliance
         self._name: str = name
-        self._programs: Optional[Dict[str, "HonCommand"]] = programs
+        self._categories: Optional[Dict[str, "HonCommand"]] = categories
-        self._program_name: str = program_name
+        self._category_name: str = category_name
-        self._description: str = attributes.get("description", "")
+        self._description: str = attributes.pop("description", "")
-        self._parameters: Dict[str, HonParameter] = self._create_parameters(
+        self._protocol_type: str = attributes.pop("protocolType", "")
-            attributes.get("parameters", {})
+        self._parameters: Dict[str, HonParameter] = {}
-        )
+        self._data: Dict[str, Any] = {}
-        self._ancillary_parameters: Dict[str, HonParameter] = self._create_parameters(
+        self._available_settings: Dict[str, HonParameter] = {}
-            attributes.get("ancillaryParameters", {})
+        self._load_parameters(attributes)
-        )
 
     def __repr__(self) -> str:
         return f"{self._name} command"
 
-    def _create_parameters(self, parameters: Dict) -> Dict[str, HonParameter]:
+    @property
-        result: Dict[str, HonParameter] = {}
+    def name(self):
-        for parameter, attributes in parameters.items():
+        return self._name
-            if parameter == "zoneMap" and self._appliance.zone:
+
-                attributes["default"] = self._appliance.zone
+    @property
-            match attributes.get("typology"):
+    def data(self):
-                case "range":
+        return self._data
-                    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 parameters(self) -> Dict[str, HonParameter]:
         return self._parameters
 
     @property
-    def ancillary_parameters(self) -> Dict[str, HonParameter]:
+    def settings(self) -> Dict[str, HonParameter]:
-        return self._ancillary_parameters
+        return self._parameters
+
+    @property
+    def parameter_groups(self) -> Dict[str, Dict[str, Union[str, float]]]:
+        result: Dict[str, Dict[str, Union[str, float]]] = {}
+        for name, parameter in self._parameters.items():
+            result.setdefault(parameter.group, {})[name] = parameter.value
+        return result
+
+    @property
+    def parameter_value(self) -> Dict[str, Union[str, float]]:
+        return {n: p.value for n, p in self._parameters.items()}
+
+    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:
+            name = "program" if "PROGRAM" in self._category_name else "category"
+            self._parameters[name] = HonParameterProgram(name, self, "custom")
 
     async def send(self) -> bool:
-        params = {k: v.value for k, v in self._parameters.items()}
+        params = self.parameter_groups["parameters"]
-        ancillary_params = {k: v.value for k, v in self._ancillary_parameters.items()}
+        ancillary_params = self.parameter_groups["ancillary_parameters"]
         return await self._api.send_command(
             self._appliance, self._name, params, ancillary_params
         )
 
     @property
-    def programs(self) -> Dict[str, "HonCommand"]:
+    def categories(self) -> Dict[str, "HonCommand"]:
-        if self._programs is None:
+        if self._categories is None:
-            return {}
+            return {"_": self}
-        return self._programs
+        return self._categories
 
     @property
-    def program(self) -> str:
+    def category(self) -> str:
-        return self._program_name
+        return self._category_name
 
-    @program.setter
+    @category.setter
-    def program(self, program: str) -> None:
+    def category(self, category: str) -> None:
-        self._appliance.commands[self._name] = self.programs[program]
+        self._appliance.commands[self._name] = self.categories[category]
-
-    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 key not in keys:
-                keys.append(key)
-        return keys
 
     @property
     def setting_keys(self) -> List[str]:
-        if not self._programs:
+        return list(
-            return self._get_settings_keys()
+            {param for cmd in self.categories.values() for param in cmd.parameters}
-        result = [
+        )
-            key
+
-            for cmd in self._programs.values()
+    @staticmethod
-            for key in self._get_settings_keys(cmd)
+    def _more_options(first: HonParameter, second: HonParameter):
-        ]
+        if isinstance(first, HonParameterFixed) and not isinstance(
-        return list(set(result + ["program"]))
+            second, HonParameterFixed
+        ):
+            return second
+        if len(second.values) > len(first.values):
+            return second
+        return first
 
     @property
-    def settings(self) -> Dict[str, HonParameter]:
+    def available_settings(self) -> Dict[str, HonParameter]:
-        return {
+        result: Dict[str, HonParameter] = {}
-            s: param
+        for command in self.categories.values():
-            for s in self.setting_keys
+            for name, parameter in command.parameters.items():
-            if (param := self._parameters.get(s)) is not None
+                if name in result:
-            or (param := self._ancillary_parameters.get(s)) is not None
+                    result[name] = self._more_options(result[name], parameter)
-        }
+                result[name] = parameter
+        return result

pyhon/connection/api.py

@@ -109,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,
@@ -161,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/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,12 @@ def pretty_print(data, key="", intend=0, is_list=False, whitespace="  "):
     return result
 
 
-def get_parameter(command, parameter):
-    if programs := command.programs:
-        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 in command.setting_keys:
+        for parameter, data in command.available_settings.items():
-            data = get_parameter(command, parameter)
             if data.typology == "enum":
                 value = data.values
             elif data.typology == "range":

pyhon/parameter/base.py

@@ -2,12 +2,13 @@ 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:
@@ -19,7 +20,7 @@ class HonParameter:
 
     @property
     def values(self) -> List[str]:
-        return list(str(self.value))
+        return [str(self.value)]
 
     @property
     def category(self) -> str:
@@ -32,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:
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
-        super().__init__(key, attributes)
+        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:
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
-        super().__init__(key, attributes)
+        super().__init__(key, attributes, group)
         self._value = attributes.get("fixedValue", None)
 
     def __repr__(self) -> str:

pyhon/parameter/program.py

@@ -9,11 +9,14 @@ if TYPE_CHECKING:
 class HonParameterProgram(HonParameterEnum):
     _FILTER = ["iot_recipe", "iot_guided"]
 
-    def __init__(self, key: str, command: "HonCommand") -> None:
+    def __init__(self, key: str, command: "HonCommand", group: str) -> None:
-        super().__init__(key, {})
+        super().__init__(key, {}, group)
         self._command = command
-        self._value: str = command.program
+        if "PROGRAM" in command.category:
-        self._programs: Dict[str, "HonCommand"] = command.programs
+            self._value: str = command.category.split(".")[-1].lower()
+        else:
+            self._value: str = command.category
+        self._programs: Dict[str, "HonCommand"] = command.categories
         self._typology: str = "enum"
 
     @property
@@ -23,7 +26,7 @@ class HonParameterProgram(HonParameterEnum):
     @value.setter
     def value(self, value: str) -> None:
         if value in self.values:
-            self._command.program = value
+            self._command.category = value
         else:
             raise ValueError(f"Allowed values {self.values}")
 

pyhon/parameter/range.py

@@ -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:
+    def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
-        super().__init__(key, attributes)
+        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"])

setup.py

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