Compare commits

...

5 Commits

Author SHA1 Message Date
ea8f481b01 More general parsing 2023-05-06 16:08:36 +02:00
7dcb34559b Raise error if missing token 2023-04-24 21:50:25 +02:00
5db13a90e7 Fix some stuff for hoover appliances 2023-04-24 04:33:00 +02:00
9ee5dbc956 Get program name by prcode 2023-04-23 21:42:44 +02:00
d4c6ccdce3 Use parameter optional 2023-04-23 20:15:07 +02:00
18 changed files with 223 additions and 138 deletions

0
pyhon/__main__.py Normal file → Executable file
View File

View File

@ -1,15 +1,19 @@
import importlib import importlib
import logging
from contextlib import suppress from contextlib import suppress
from typing import Optional, Dict, Any from typing import Optional, Dict, Any
from typing import TYPE_CHECKING from typing import TYPE_CHECKING
from pyhon import helper from pyhon import helper
from pyhon.commands import HonCommand from pyhon.commands import HonCommand
from pyhon.parameter.base import HonParameter
from pyhon.parameter.fixed import HonParameterFixed from pyhon.parameter.fixed import HonParameterFixed
if TYPE_CHECKING: if TYPE_CHECKING:
from pyhon import HonAPI from pyhon import HonAPI
_LOGGER = logging.getLogger(__name__)
class HonAppliance: class HonAppliance:
def __init__( def __init__(
@ -25,11 +29,12 @@ class HonAppliance:
self._statistics: Dict = {} self._statistics: Dict = {}
self._attributes: Dict = {} self._attributes: Dict = {}
self._zone: int = zone self._zone: int = zone
self._additional_data = {}
try: try:
self._extra = importlib.import_module( self._extra = importlib.import_module(
f"pyhon.appliances.{self.appliance_type.lower()}" f"pyhon.appliances.{self.appliance_type.lower()}"
).Appliance() ).Appliance(self)
except ModuleNotFoundError: except ModuleNotFoundError:
self._extra = None self._extra = None
@ -106,13 +111,17 @@ class HonAppliance:
def info(self): def info(self):
return self._info return self._info
@property
def additional_data(self):
return self._additional_data
@property @property
def zone(self) -> int: def zone(self) -> int:
return self._zone 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) command_history = await self._api.command_history(self)
for name, command in commands.items(): for name, command in self._commands.items():
last = next( last = next(
( (
index index
@ -124,8 +133,8 @@ class HonAppliance:
if last is None: if last is None:
continue continue
parameters = command_history[last].get("command", {}).get("parameters", {}) parameters = command_history[last].get("command", {}).get("parameters", {})
if command.programs and parameters.get("program"): if command.categories and parameters.get("category"):
command.program = parameters.pop("program").split(".")[-1].lower() command.category = parameters.pop("category").split(".")[-1].lower()
command = self.commands[name] command = self.commands[name]
for key, data in command.settings.items(): for key, data in command.settings.items():
if ( if (
@ -135,51 +144,50 @@ class HonAppliance:
with suppress(ValueError): with suppress(ValueError):
data.value = parameters.get(key) 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): async def load_commands(self):
raw = await self._api.load_commands(self) raw = await self._api.load_commands(self)
self._appliance_model = raw.pop("applianceModel") self._appliance_model = raw.pop("applianceModel")
for item in ["settings", "options", "dictionaryId"]: raw.pop("dictionaryId")
raw.pop(item) self._commands = self._get_commands(raw)
commands = {} await self._recover_last_command_states()
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
async def load_attributes(self): async def load_attributes(self):
self._attributes = await self._api.load_attributes(self) self._attributes = await self._api.load_attributes(self)
@ -192,12 +200,32 @@ class HonAppliance:
async def update(self): async def update(self):
await self.load_attributes() 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 @property
def data(self): def data(self):
result = { result = {
"attributes": self.attributes, "attributes": self.attributes,
"appliance": self.info, "appliance": self.info,
"statistics": self.statistics, "statistics": self.statistics,
"additional_data": self._additional_data,
**self.parameters, **self.parameters,
} }
if self._extra: if self._extra:
@ -214,4 +242,4 @@ class HonAppliance:
{"commands": helper.create_command(self.commands)}, {"commands": helper.create_command(self.commands)},
whitespace="\u200B \u200B ", 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")

View File

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

View File

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

View File

@ -2,15 +2,21 @@ from pyhon.parameter.fixed import HonParameterFixed
class Appliance: class Appliance:
def __init__(self, appliance):
self.parent = appliance
def data(self, data): def data(self, data):
if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED": if data["attributes"]["lastConnEvent"]["category"] == "DISCONNECTED":
data["attributes"]["parameters"]["machMode"] = "0" data["attributes"]["parameters"]["machMode"] = "0"
data["active"] = bool(data.get("attributes", {}).get("activity")) data["active"] = bool(data.get("attributes", {}).get("activity"))
data["pause"] = data["attributes"]["parameters"]["machMode"] == "3" 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 return data
def settings(self, settings): def settings(self, settings):
dry_level = settings["startProgram.dryLevel"] dry_level = settings.get("startProgram.dryLevel")
if isinstance(dry_level, HonParameterFixed) and dry_level.value == "11": if isinstance(dry_level, HonParameterFixed) and dry_level.value == "11":
settings.pop("startProgram.dryLevel", None) settings.pop("startProgram.dryLevel", None)
return settings return settings

View File

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

View File

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

View File

@ -18,97 +18,95 @@ class HonCommand:
attributes: Dict[str, Any], attributes: Dict[str, Any],
api: "HonAPI", api: "HonAPI",
appliance: "HonAppliance", 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 = api
self._appliance: "HonAppliance" = appliance self._appliance: "HonAppliance" = appliance
self._name: str = name self._name: str = name
self._programs: Optional[Dict[str, "HonCommand"]] = programs or {} 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 = {}
self._ancillary_parameters: Dict[str, HonParameter] = self._create_parameters( self._load_parameters(attributes)
attributes.get("ancillaryParameters", {})
)
def __repr__(self) -> str: def __repr__(self) -> str:
return f"{self._name} command" 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 @property
def parameters(self) -> Dict[str, HonParameter]: def parameters(self) -> Dict[str, HonParameter]:
return self._parameters return self._parameters
@property def _load_parameters(self, attributes):
def ancillary_parameters(self) -> Dict[str, HonParameter]: for key, items in attributes.items():
return self._ancillary_parameters 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: async def send(self) -> bool:
params = {k: v.value for k, v in self._parameters.items()} params = self._parameters_by_group("parameters")
ancillary_params = {k: v.value for k, v in self._ancillary_parameters.items()} ancillary_params = self._parameters_by_group("ancillary_parameters")
return await self._api.send_command( return await self._api.send_command(
self._appliance, self._name, params, ancillary_params self._appliance, self._name, params, ancillary_params
) )
@property @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 @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 @property
def setting_keys(self) -> List[str]: 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()
for key in self._get_settings_keys(cmd)
]
return list(set(result + ["program"]))
@property @property
def settings(self) -> Dict[str, HonParameter]: def settings(self) -> Dict[str, HonParameter]:
return { result = {}
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 continue
} result[name] = parameter
return result

View File

@ -12,7 +12,7 @@ from pyhon.connection.auth import HonAuth
from pyhon.connection.handler.anonym import HonAnonymousConnectionHandler from pyhon.connection.handler.anonym import HonAnonymousConnectionHandler
from pyhon.connection.handler.hon import HonConnectionHandler from pyhon.connection.handler.hon import HonConnectionHandler
_LOGGER = logging.getLogger() _LOGGER = logging.getLogger(__name__)
class HonAPI: class HonAPI:
@ -109,6 +109,18 @@ class HonAPI:
return activity return activity
return {} 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: async def load_attributes(self, appliance: HonAppliance) -> Dict:
params: Dict = { params: Dict = {
"macAddress": appliance.mac_address, "macAddress": appliance.mac_address,
@ -161,7 +173,7 @@ class HonAPI:
return False return False
async def appliance_configuration(self) -> Dict: 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: async with self._hon_anonymous.get(url) as response:
result: Dict = await response.json() result: Dict = await response.json()
if result and (data := result.get("payload")): if result and (data := result.get("payload")):

View File

@ -182,13 +182,14 @@ class HonAuth:
await self._error_logger(response) await self._error_logger(response)
return "" 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): if access_token := re.findall("access_token=(.*?)&", text):
self._access_token = access_token[0] self._access_token = access_token[0]
if refresh_token := re.findall("refresh_token=(.*?)&", text): if refresh_token := re.findall("refresh_token=(.*?)&", text):
self._refresh_token = refresh_token[0] self._refresh_token = refresh_token[0]
if id_token := re.findall("id_token=(.*?)&", text): if id_token := re.findall("id_token=(.*?)&", text):
self._id_token = id_token[0] 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 def _get_token(self, url: str) -> bool:
async with self._request.get(url) as response: async with self._request.get(url) as response:
@ -214,7 +215,9 @@ class HonAuth:
if response.status != 200: if response.status != 200:
await self._error_logger(response) await self._error_logger(response)
return False 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 return True
async def _api_auth(self) -> bool: async def _api_auth(self) -> bool:

View File

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

View File

@ -47,7 +47,7 @@ class Hon:
async def _create_appliance(self, appliance_data: Dict[str, Any], zone=0) -> None: async def _create_appliance(self, appliance_data: Dict[str, Any], zone=0) -> None:
appliance = HonAppliance(self._api, appliance_data, zone=zone) appliance = HonAppliance(self._api, appliance_data, zone=zone)
if appliance.mac_address is None: if appliance.mac_address == "":
return return
await asyncio.gather( await asyncio.gather(
*[ *[

View File

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

View File

@ -4,8 +4,8 @@ from pyhon.parameter.base import HonParameter
class HonParameterEnum(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._default = attributes.get("defaultValue")
self._value = self._default or "0" self._value = self._default or "0"
self._values: List[str] = attributes.get("enumValues", []) self._values: List[str] = attributes.get("enumValues", [])

View File

@ -1,11 +1,11 @@
from typing import Dict, Any, List from typing import Dict, Any
from pyhon.parameter.base import HonParameter from pyhon.parameter.base import HonParameter
class HonParameterFixed(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) self._value = attributes.get("fixedValue", None)
def __repr__(self) -> str: def __repr__(self) -> str:
@ -19,7 +19,3 @@ class HonParameterFixed(HonParameter):
def value(self, value: str | float) -> None: def value(self, value: str | float) -> None:
# Fixed values seems being not so fixed as thought # Fixed values seems being not so fixed as thought
self._value = value self._value = value
@property
def values(self) -> List[str]:
return list(str(self.value))

View File

@ -9,11 +9,11 @@ if TYPE_CHECKING:
class HonParameterProgram(HonParameterEnum): class HonParameterProgram(HonParameterEnum):
_FILTER = ["iot_recipe", "iot_guided"] _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._command = command
self._value: str = command.program self._value: str = command.category
self._programs: Dict[str, "HonCommand"] = command.programs self._programs: Dict[str, "HonCommand"] = command.categories
self._typology: str = "enum" self._typology: str = "enum"
@property @property
@ -31,3 +31,12 @@ class HonParameterProgram(HonParameterEnum):
def values(self) -> List[str]: def values(self) -> List[str]:
values = [v for v in self._programs 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) 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()))

View File

@ -11,8 +11,8 @@ def str_to_float(string: str | float) -> float:
class HonParameterRange(HonParameter): 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._min: float = str_to_float(attributes["minimumValue"])
self._max: float = str_to_float(attributes["maximumValue"]) self._max: float = str_to_float(attributes["maximumValue"])
self._step: float = str_to_float(attributes["incrementValue"]) self._step: float = str_to_float(attributes["incrementValue"])

View File

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