Compare commits
	
		
			57 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| d52d622785 | |||
| 9643f66549 | |||
| d26e33a055 | |||
| 0301427497 | |||
| 272556586e | |||
| e82c14ec99 | |||
| 970b94bfa7 | |||
| 33454f68b8 | |||
| 6b2c60d552 | |||
| 46e6a85e84 | |||
| 8c832b44cd | |||
| b4b782c52c | |||
| e857fe91de | |||
| 79c9678492 | |||
| 7c49589944 | |||
| f421cf1ce6 | |||
| ba208ffd98 | |||
| 3e3fc7ad66 | |||
| e8531f3faf | |||
| 2597cbd883 | |||
| 8dc6cd71cd | |||
| 36fad84ee2 | |||
| eb6741145a | |||
| 8fa01343bc | |||
| 36079c3c77 | |||
| 6d40e73881 | |||
| 6c3da96a03 | |||
| 3c81c46c8b | |||
| 0d92d037a5 | |||
| 5e32dd76c0 | |||
| f8dde06510 | |||
| 5ec1a760f6 | |||
| cd5a4c345e | |||
| d707342f8f | |||
| e12edda588 | |||
| 409aa11fcb | |||
| f73ef26e74 | |||
| 0ddbdd0b4e | |||
| 241ee95d5c | |||
| c9d4461f8f | |||
| 318e60e91e | |||
| fde41ac456 | |||
| aeabbe64e2 | |||
| 7c99ffeaf7 | |||
| 2941b57d09 | |||
| f00ee03c0d | |||
| ec7355e341 | |||
| 96233dd7fd | |||
| ef4f7f7398 | |||
| fc8c92d538 | |||
| fe4f6e766e | |||
| 6b346f766f | |||
| f52f84711f | |||
| c4d21be388 | |||
| 5acc81acc3 | |||
| 43d61ab853 | |||
| 79a121263f | 
							
								
								
									
										39
									
								
								.github/workflows/python-check.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										39
									
								
								.github/workflows/python-check.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @ -0,0 +1,39 @@ | ||||
| name: Python check | ||||
|  | ||||
| on: | ||||
|   push: | ||||
|     branches: [ "main" ] | ||||
|   pull_request: | ||||
|     branches: [ "main" ] | ||||
|  | ||||
| jobs: | ||||
|   build: | ||||
|  | ||||
|     runs-on: ubuntu-latest | ||||
|     strategy: | ||||
|       fail-fast: false | ||||
|       matrix: | ||||
|         python-version: ["3.10", "3.11"] | ||||
|  | ||||
|     steps: | ||||
|     - uses: actions/checkout@v3 | ||||
|     - name: Set up Python ${{ matrix.python-version }} | ||||
|       uses: actions/setup-python@v3 | ||||
|       with: | ||||
|         python-version: ${{ matrix.python-version }} | ||||
|     - name: Install dependencies | ||||
|       run: | | ||||
|         python -m pip install --upgrade pip | ||||
|         python -m pip install -r requirements.txt | ||||
|         python -m pip install flake8 pylint black | ||||
|     - name: Lint with flake8 | ||||
|       run: | | ||||
|         # stop the build if there are Python syntax errors or undefined names | ||||
|         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | ||||
|         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics | ||||
|     # - name: Analysing the code with pylint | ||||
|     #   run: | | ||||
|     #     pylint --max-line-length 88 $(git ls-files '*.py') | ||||
|     - name: Check black style | ||||
|       run: | | ||||
|         black . --check | ||||
							
								
								
									
										2
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @ -3,4 +3,4 @@ venv/ | ||||
| __pycache__/ | ||||
| dist/ | ||||
| **/*.egg-info/ | ||||
| test.py | ||||
| test* | ||||
|  | ||||
							
								
								
									
										74
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										74
									
								
								README.md
									
									
									
									
									
								
							| @ -4,8 +4,8 @@ | ||||
| [](https://pypi.org/project/pyhOn) | ||||
| [](https://pypi.org/project/pyhOn) | ||||
| [](https://www.python.org/) | ||||
| [](https://github.com/Andre0512/pyhOn/blob/main/LICENCE) | ||||
| [](https://pypistats.org/packages/pyhOn)   | ||||
| [](https://github.com/Andre0512/pyhOn/blob/main/LICENSE) | ||||
| [](https://pypistats.org/packages/pyhon)   | ||||
| Control your Haier appliances with python! | ||||
| The idea behind this library is, to make the use of all available commands as simple as possible. | ||||
|  | ||||
| @ -19,47 +19,56 @@ To get an idea of what is possible, use the commandline-tool `pyhOn`. This comma | ||||
| ```commandline | ||||
| $ pyhOn --user example@mail.com --password pass123 | ||||
| ========== WM - Waschmaschine ========== | ||||
| commands: | ||||
|   pauseProgram: pauseProgram command | ||||
|   resumeProgram: resumeProgram command | ||||
|   startProgram: startProgram command | ||||
|   stopProgram: stopProgram command | ||||
| data: | ||||
|   actualWeight: 0 | ||||
|   airWashTempLevel: 0 | ||||
|   airWashTime: 0 | ||||
|   antiAllergyStatus: 0 | ||||
| ... | ||||
|   attributes: | ||||
|     parameters: | ||||
|       ... | ||||
|       texture: 1 | ||||
|       totalElectricityUsed: 28.71 | ||||
|       totalWashCycle: 35 | ||||
|       totalWaterUsed: 2494 | ||||
|       transMode: 0 | ||||
|       ... | ||||
| settings: | ||||
|   startProgram: | ||||
|     rinseIterations: | ||||
|       max: 5 | ||||
|       min: 3 | ||||
|       step: 1 | ||||
|     spinSpeed: | ||||
|       - 0 | ||||
|       - 400 | ||||
|       - 600 | ||||
|       - 800 | ||||
|       ... | ||||
| ``` | ||||
|  | ||||
| ## Python-API | ||||
| ### List devices | ||||
| ```python | ||||
| import asyncio | ||||
| from pyhon import HonConnection | ||||
| from pyhon import Hon | ||||
|  | ||||
| async def devices_example(): | ||||
|     async with HonConnection(USER, PASSWORD) as hon: | ||||
|         for device in hon.devices: | ||||
|             print(device.nick_name) | ||||
|     async with Hon(USER, PASSWORD) as hon: | ||||
|         for appliance in hon.appliances: | ||||
|             print(appliance.nick_name) | ||||
|  | ||||
| asyncio.run(devices_example()) | ||||
| ``` | ||||
|  | ||||
| ### Execute a command | ||||
| ```python | ||||
| async with HonConnection(USER, PASSWORD) as hon: | ||||
|     washing_machine = hon.devices[0] | ||||
| async with Hon(USER, PASSWORD) as hon: | ||||
|     washing_machine = hon.appliances[0] | ||||
|     pause_command = washing_machine.commands["pauseProgram"] | ||||
|     await pause_command.send() | ||||
| ``` | ||||
|  | ||||
| ### Set command parameter | ||||
| Use `device.settings` to get all variable parameters.   | ||||
| Use `device.parmeters` to get also fixed parameters.  | ||||
| ```python | ||||
| async with HonConnection(USER, PASSWORD) as hon: | ||||
|     washing_machine = hon.devices[0] | ||||
| async with Hon(USER, PASSWORD) as hon: | ||||
|     washing_machine = hon.appliances[0] | ||||
|     start_command = washing_machine.commands["startProgram"] | ||||
|     for name, setting in start_command.settings: | ||||
|         print("Setting", name) | ||||
| @ -74,10 +83,23 @@ async with HonConnection(USER, PASSWORD) as hon: | ||||
|             setting.value = setting.min + setting.step | ||||
| ``` | ||||
|  | ||||
| ## Tested devices | ||||
| - Haier Washing Machine HW90 | ||||
|  | ||||
| _Unfortunately I don't have any more Haier appliances..._ | ||||
| ## Translation | ||||
| To get the translation of some keys like programs, you can use the translation command to see all of hOn's available translations | ||||
| ```commandline | ||||
| $ pyhOn translate es | ||||
| AC: | ||||
|   APPLIANCE_RENAME: | ||||
|     CONTENT_CHOOSE_NAME: Antes de continuar, debes elegir un nombre... | ||||
|     DEFAULT_NAME: Aire acondicionado | ||||
|     TITLE_CHOOSE_NAME: ¡Elije un nombre para tu aire acondicionado! | ||||
|     TITLE_SAVE_NAME: Para cambiar el nombre de tu aparato: | ||||
| ... | ||||
| ``` | ||||
| This generates a huge output. It is recommended to pipe this into a file | ||||
| ```commandline | ||||
| $ pyhOn translate fr > hon_fr.yaml | ||||
| $ pyhOn translate en --json > hon_en.json | ||||
| ``` | ||||
|  | ||||
| ## Usage example | ||||
| This library is used for the custom [HomeAssistant Integration "Haier hOn"](https://github.com/Andre0512/hOn). | ||||
|  | ||||
| @ -1 +1,4 @@ | ||||
| from .api import HonConnection | ||||
| from .connection.api import HonAPI | ||||
| from .hon import Hon | ||||
|  | ||||
| __all__ = ["Hon", "HonAPI"] | ||||
|  | ||||
| @ -1,17 +1,16 @@ | ||||
| #!/usr/bin/env python | ||||
| import argparse | ||||
| import asyncio | ||||
| import json | ||||
| import logging | ||||
| import sys | ||||
| import time | ||||
| from getpass import getpass | ||||
| from pathlib import Path | ||||
| from pprint import pprint | ||||
|  | ||||
| if __name__ == "__main__": | ||||
|     sys.path.insert(0, str(Path(__file__).parent.parent)) | ||||
|  | ||||
| from pyhon import HonConnection | ||||
| from pyhon import Hon, HonAPI, helper | ||||
|  | ||||
| _LOGGER = logging.getLogger(__name__) | ||||
|  | ||||
| @ -21,43 +20,70 @@ def get_arguments(): | ||||
|     parser = argparse.ArgumentParser(description="pyhOn: Command Line Utility") | ||||
|     parser.add_argument("-u", "--user", help="user for haier hOn account") | ||||
|     parser.add_argument("-p", "--password", help="password for haier hOn account") | ||||
|     subparser = parser.add_subparsers(title="commands", metavar="COMMAND") | ||||
|     keys = subparser.add_parser("keys", help="print as key format") | ||||
|     keys.add_argument("keys", help="print as key format", action="store_true") | ||||
|     keys.add_argument("--all", help="print also full keys", action="store_true") | ||||
|     translate = subparser.add_parser( | ||||
|         "translate", help="print available translation keys" | ||||
|     ) | ||||
|     translate.add_argument( | ||||
|         "translate", help="language (de, en, fr...)", metavar="LANGUAGE" | ||||
|     ) | ||||
|     translate.add_argument("--json", help="print as json", action="store_true") | ||||
|     return vars(parser.parse_args()) | ||||
|  | ||||
|  | ||||
| # yaml.dump() would be done the same, but needs an additional import... | ||||
| def pretty_print(data, key="", intend=0, is_list=False): | ||||
|     if type(data) is list: | ||||
|         if key: | ||||
|             print(f"{'  ' * intend}{'- ' if is_list else ''}{key}:") | ||||
|             intend += 1 | ||||
|         for i, value in enumerate(data): | ||||
|             pretty_print(value, intend=intend, is_list=True) | ||||
|     elif type(data) is dict: | ||||
|         if key: | ||||
|             print(f"{'  ' * intend}{'- ' if is_list else ''}{key}:") | ||||
|             intend += 1 | ||||
|         for i, (key, value) in enumerate(sorted(data.items())): | ||||
|             if is_list and not i: | ||||
|                 pretty_print(value, key=key, intend=intend, is_list=True) | ||||
|             elif is_list: | ||||
|                 pretty_print(value, key=key, intend=intend + 1) | ||||
|             else: | ||||
|                 pretty_print(value, key=key, intend=intend) | ||||
| async def translate(language, json_output=False): | ||||
|     async with HonAPI(anonymous=True) as hon: | ||||
|         keys = await hon.translation_keys(language) | ||||
|     if json_output: | ||||
|         print(json.dumps(keys, indent=4)) | ||||
|     else: | ||||
|         print(f"{'  ' * intend}{'- ' if is_list else ''}{key}{': ' if key else ''}{data}") | ||||
|         clean_keys = ( | ||||
|             json.dumps(keys) | ||||
|             .replace("\\n", "\\\\n") | ||||
|             .replace("\\\\r", "") | ||||
|             .replace("\\r", "") | ||||
|         ) | ||||
|         keys = json.loads(clean_keys) | ||||
|         print(helper.pretty_print(keys)) | ||||
|  | ||||
|  | ||||
| async def main(): | ||||
|     args = get_arguments() | ||||
|     if language := args.get("translate"): | ||||
|         await translate(language, json_output=args.get("json")) | ||||
|         return | ||||
|     if not (user := args["user"]): | ||||
|         user = input("User for hOn account: ") | ||||
|     if not (password := args["password"]): | ||||
|         password = getpass("Password for hOn account: ") | ||||
|     async with HonConnection(user, password) as hon: | ||||
|         for device in hon.devices: | ||||
|             print("=" * 10, device.appliance_type_name, "-", device.nick_name, "=" * 10) | ||||
|             pretty_print({"commands": device.commands}) | ||||
|             pretty_print({"data": device.data}) | ||||
|     async with Hon(user, password) as hon: | ||||
|         for device in hon.appliances: | ||||
|             print("=" * 10, device.appliance_type, "-", device.nick_name, "=" * 10) | ||||
|             if args.get("keys"): | ||||
|                 data = device.data.copy() | ||||
|                 attr = "get" if args.get("all") else "pop" | ||||
|                 print( | ||||
|                     helper.key_print( | ||||
|                         data["attributes"].__getattribute__(attr)("parameters") | ||||
|                     ) | ||||
|                 ) | ||||
|                 print(helper.key_print(data.__getattribute__(attr)("appliance"))) | ||||
|                 print(helper.key_print(data)) | ||||
|                 print( | ||||
|                     helper.pretty_print( | ||||
|                         helper.create_command(device.commands, concat=True) | ||||
|                     ) | ||||
|                 ) | ||||
|             else: | ||||
|                 print(helper.pretty_print({"data": device.data})) | ||||
|                 print( | ||||
|                     helper.pretty_print( | ||||
|                         {"settings": helper.create_command(device.commands)} | ||||
|                     ) | ||||
|                 ) | ||||
|  | ||||
|  | ||||
| def start(): | ||||
| @ -67,5 +93,5 @@ def start(): | ||||
|         print("Aborted.") | ||||
|  | ||||
|  | ||||
| if __name__ == '__main__': | ||||
| if __name__ == "__main__": | ||||
|     start() | ||||
|  | ||||
							
								
								
									
										138
									
								
								pyhon/api.py
									
									
									
									
									
								
							
							
						
						
									
										138
									
								
								pyhon/api.py
									
									
									
									
									
								
							| @ -1,138 +0,0 @@ | ||||
| import asyncio | ||||
| import json | ||||
| import logging | ||||
| import secrets | ||||
| from datetime import datetime | ||||
| from typing import List | ||||
|  | ||||
| import aiohttp as aiohttp | ||||
|  | ||||
| from pyhon import const | ||||
| from pyhon.auth import HonAuth | ||||
| from pyhon.device import HonDevice | ||||
|  | ||||
| _LOGGER = logging.getLogger() | ||||
|  | ||||
|  | ||||
| class HonConnection: | ||||
|     def __init__(self, email, password, session=None) -> None: | ||||
|         super().__init__() | ||||
|         self._email = email | ||||
|         self._password = password | ||||
|         self._request_headers = {"Content-Type": "application/json"} | ||||
|         self._session = session | ||||
|         self._devices = [] | ||||
|         self._mobile_id = secrets.token_hex(8) | ||||
|  | ||||
|     async def __aenter__(self): | ||||
|         self._session = aiohttp.ClientSession() | ||||
|         await self.setup() | ||||
|         return self | ||||
|  | ||||
|     async def __aexit__(self, exc_type, exc_val, exc_tb): | ||||
|         await self._session.close() | ||||
|  | ||||
|     @property | ||||
|     def devices(self) -> List[HonDevice]: | ||||
|         return self._devices | ||||
|  | ||||
|     @property | ||||
|     async def _headers(self): | ||||
|         if "cognito-token" not in self._request_headers or "id-token" not in self._request_headers: | ||||
|             auth = HonAuth() | ||||
|             if await auth.authorize(self._email, self._password, self._mobile_id): | ||||
|                 self._request_headers["cognito-token"] = auth.cognito_token | ||||
|                 self._request_headers["id-token"] = auth.id_token | ||||
|             else: | ||||
|                 raise PermissionError("Can't Login") | ||||
|         return self._request_headers | ||||
|  | ||||
|     async def setup(self): | ||||
|         async with aiohttp.ClientSession() as session: | ||||
|             async with session.get(f"{const.API_URL}/commands/v1/appliance", | ||||
|                                    headers=await self._headers) as resp: | ||||
|                 try: | ||||
|                     appliances = (await resp.json())["payload"]["appliances"] | ||||
|                     for appliance in appliances: | ||||
|                         device = HonDevice(self, appliance) | ||||
|                         await asyncio.gather(*[ | ||||
|                             device.load_attributes(), | ||||
|                             device.load_commands(), | ||||
|                             device.load_statistics()]) | ||||
|                     self._devices.append(device) | ||||
|                 except json.JSONDecodeError: | ||||
|                     _LOGGER.error("No JSON Data after GET: %s", await resp.text()) | ||||
|                     return False | ||||
|         return True | ||||
|  | ||||
|     async def load_commands(self, device: HonDevice): | ||||
|         params = { | ||||
|             "applianceType": device.appliance_type_name, | ||||
|             "code": device.code, | ||||
|             "applianceModelId": device.appliance_model_id, | ||||
|             "firmwareId": "41", | ||||
|             "macAddress": device.mac_address, | ||||
|             "fwVersion": device.fw_version, | ||||
|             "os": const.OS, | ||||
|             "appVersion": const.APP_VERSION, | ||||
|             "series": device.series, | ||||
|         } | ||||
|         url = f"{const.API_URL}/commands/v1/retrieve" | ||||
|         async with self._session.get(url, params=params, headers=await self._headers) as response: | ||||
|             result = (await response.json()).get("payload", {}) | ||||
|             if not result or result.pop("resultCode") != "0": | ||||
|                 return {} | ||||
|             return result | ||||
|  | ||||
|     async def load_attributes(self, device: HonDevice): | ||||
|         params = { | ||||
|             "macAddress": device.mac_address, | ||||
|             "applianceType": device.appliance_type_name, | ||||
|             "category": "CYCLE" | ||||
|         } | ||||
|         url = f"{const.API_URL}/commands/v1/context" | ||||
|         async with self._session.get(url, params=params, headers=await self._headers) as response: | ||||
|             return (await response.json()).get("payload", {}) | ||||
|  | ||||
|     async def load_statistics(self, device: HonDevice): | ||||
|         params = { | ||||
|             "macAddress": device.mac_address, | ||||
|             "applianceType": device.appliance_type_name | ||||
|         } | ||||
|         url = f"{const.API_URL}/commands/v1/statistics" | ||||
|         async with self._session.get(url, params=params, headers=await self._headers) as response: | ||||
|             return (await response.json()).get("payload", {}) | ||||
|  | ||||
|     async def send_command(self, device, command, parameters, ancillary_parameters): | ||||
|         now = datetime.utcnow().isoformat() | ||||
|         data = { | ||||
|             "macAddress": device.mac_address, | ||||
|             "timestamp": f"{now[:-3]}Z", | ||||
|             "commandName": command, | ||||
|             "transactionId": f"{device.mac_address}_{now[:-3]}Z", | ||||
|             "applianceOptions": device.commands_options, | ||||
|             "device": { | ||||
|                 "mobileId": self._mobile_id, | ||||
|                 "mobileOs": const.OS, | ||||
|                 "osVersion": const.OS_VERSION, | ||||
|                 "appVersion": const.APP_VERSION, | ||||
|                 "deviceModel": const.DEVICE_MODEL | ||||
|             }, | ||||
|             "attributes": { | ||||
|                 "channel": "mobileApp", | ||||
|                 "origin": "standardProgram", | ||||
|                 "energyLabel": "0" | ||||
|             }, | ||||
|             "ancillaryParameters": ancillary_parameters, | ||||
|             "parameters": parameters, | ||||
|             "applianceType": device.appliance_type_name | ||||
|         } | ||||
|         url = f"{const.API_URL}/commands/v1/send" | ||||
|         async with self._session.post(url, headers=await self._headers, json=data) as resp: | ||||
|             try: | ||||
|                 json_data = await resp.json() | ||||
|             except json.JSONDecodeError: | ||||
|                 return False | ||||
|             if json_data["payload"]["resultCode"] == "0": | ||||
|                 return True | ||||
|         return False | ||||
							
								
								
									
										196
									
								
								pyhon/appliance.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										196
									
								
								pyhon/appliance.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,196 @@ | ||||
| import importlib | ||||
| from contextlib import suppress | ||||
| from typing import Optional, Dict | ||||
|  | ||||
| from pyhon import helper | ||||
| from pyhon.commands import HonCommand | ||||
| from pyhon.parameter import HonParameterFixed | ||||
|  | ||||
|  | ||||
| class HonAppliance: | ||||
|     def __init__(self, api, info: Dict, zone: int = 0) -> None: | ||||
|         if attributes := info.get("attributes"): | ||||
|             info["attributes"] = {v["parName"]: v["parValue"] for v in attributes} | ||||
|         self._info = info | ||||
|         self._api = api | ||||
|         self._appliance_model = {} | ||||
|  | ||||
|         self._commands = {} | ||||
|         self._statistics = {} | ||||
|         self._attributes = {} | ||||
|         self._zone = zone | ||||
|  | ||||
|         try: | ||||
|             self._extra = importlib.import_module( | ||||
|                 f"pyhon.appliances.{self.appliance_type.lower()}" | ||||
|             ).Appliance() | ||||
|         except ModuleNotFoundError: | ||||
|             self._extra = None | ||||
|  | ||||
|     def __getitem__(self, item): | ||||
|         if self._zone: | ||||
|             item += f"Z{self._zone}" | ||||
|         if "." in item: | ||||
|             result = self.data | ||||
|             for key in item.split("."): | ||||
|                 if all(k in "0123456789" for k in key) and isinstance(result, list): | ||||
|                     result = result[int(key)] | ||||
|                 else: | ||||
|                     result = result[key] | ||||
|             return result | ||||
|         if item in self.data: | ||||
|             return self.data[item] | ||||
|         if item in self.attributes["parameters"]: | ||||
|             return self.attributes["parameters"].get(item) | ||||
|         return self.info[item] | ||||
|  | ||||
|     def get(self, item, default=None): | ||||
|         try: | ||||
|             return self[item] | ||||
|         except (KeyError, IndexError): | ||||
|             return default | ||||
|  | ||||
|     def _check_name_zone(self, name: str, frontend: bool = True) -> str: | ||||
|         middle = " Z" if frontend else "_z" | ||||
|         if (attribute := self._info.get(name, "")) and self._zone: | ||||
|             return f"{attribute}{middle}{self._zone}" | ||||
|         return attribute | ||||
|  | ||||
|     @property | ||||
|     def appliance_model_id(self) -> str: | ||||
|         return self._info.get("applianceModelId") | ||||
|  | ||||
|     @property | ||||
|     def appliance_type(self) -> str: | ||||
|         return self._info.get("applianceTypeName") | ||||
|  | ||||
|     @property | ||||
|     def mac_address(self) -> str: | ||||
|         return self._check_name_zone("macAddress", frontend=False) | ||||
|  | ||||
|     @property | ||||
|     def model_name(self) -> str: | ||||
|         return self._check_name_zone("modelName") | ||||
|  | ||||
|     @property | ||||
|     def nick_name(self) -> str: | ||||
|         return self._check_name_zone("nickName") | ||||
|  | ||||
|     @property | ||||
|     def commands_options(self): | ||||
|         return self._appliance_model.get("options") | ||||
|  | ||||
|     @property | ||||
|     def commands(self): | ||||
|         return self._commands | ||||
|  | ||||
|     @property | ||||
|     def attributes(self): | ||||
|         return self._attributes | ||||
|  | ||||
|     @property | ||||
|     def statistics(self): | ||||
|         return self._statistics | ||||
|  | ||||
|     @property | ||||
|     def info(self): | ||||
|         return self._info | ||||
|  | ||||
|     async def _recover_last_command_states(self, commands): | ||||
|         command_history = await self._api.command_history(self) | ||||
|         for name, command in commands.items(): | ||||
|             last = next( | ||||
|                 ( | ||||
|                     index | ||||
|                     for (index, d) in enumerate(command_history) | ||||
|                     if d.get("command", {}).get("commandName") == name | ||||
|                 ), | ||||
|                 None, | ||||
|             ) | ||||
|             if last is None: | ||||
|                 continue | ||||
|             parameters = command_history[last].get("command", {}).get("parameters", {}) | ||||
|             if command._multi and parameters.get("program"): | ||||
|                 command.set_program(parameters.pop("program").split(".")[-1].lower()) | ||||
|                 command = self.commands[name] | ||||
|             for key, data in command.settings.items(): | ||||
|                 if ( | ||||
|                     not isinstance(data, HonParameterFixed) | ||||
|                     and parameters.get(key) is not None | ||||
|                 ): | ||||
|                     with suppress(ValueError): | ||||
|                         data.value = parameters.get(key) | ||||
|  | ||||
|     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, multi=multi, program=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.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, | ||||
|         } | ||||
|         if self._extra: | ||||
|             return self._extra.data(result) | ||||
|         return result | ||||
|  | ||||
|     @property | ||||
|     def diagnose(self): | ||||
|         data = self.data.copy() | ||||
|         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( | ||||
|             {"commands": helper.create_command(self.commands)}, | ||||
|             whitespace="\u200B \u200B ", | ||||
|         ) | ||||
|         return result.replace(self.mac_address, "12-34-56-78-90-ab") | ||||
							
								
								
									
										0
									
								
								pyhon/appliances/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								pyhon/appliances/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										23
									
								
								pyhon/appliances/ov.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								pyhon/appliances/ov.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,23 @@ | ||||
| from pyhon.parameter import HonParameterEnum | ||||
|  | ||||
|  | ||||
| class Appliance: | ||||
|     _FILTERS = { | ||||
|         "default": "^(?!iot_(?:recipe|guided))\\S+$", | ||||
|         "recipe": "iot_recipe_", | ||||
|         "guided": "iot_guided_", | ||||
|     } | ||||
|  | ||||
|     def __init__(self): | ||||
|         filters = list(self._FILTERS.values()) | ||||
|         data = {"defaultValue": filters[0], "enumValues": filters} | ||||
|         self._program_filter = HonParameterEnum("program_filter", data) | ||||
|  | ||||
|     def data(self, data): | ||||
|         return data | ||||
|  | ||||
|     def settings(self, settings): | ||||
|         settings["program_filter"] = self._program_filter | ||||
|         value = self._FILTERS[self._program_filter.value] | ||||
|         settings["startProgram.program"].filter = value | ||||
|         return settings | ||||
							
								
								
									
										10
									
								
								pyhon/appliances/td.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								pyhon/appliances/td.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,10 @@ | ||||
| class 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" | ||||
|         return data | ||||
|  | ||||
|     def settings(self, settings): | ||||
|         return settings | ||||
							
								
								
									
										10
									
								
								pyhon/appliances/wd.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										10
									
								
								pyhon/appliances/wd.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,10 @@ | ||||
| class 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" | ||||
|         return data | ||||
|  | ||||
|     def settings(self, settings): | ||||
|         return settings | ||||
| @ -1,7 +1,10 @@ | ||||
| class Appliance: | ||||
|     def __init__(self, data): | ||||
|         self._data = data | ||||
|     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" | ||||
|         return data | ||||
|  | ||||
|     def get(self): | ||||
|         self._data["connected"] = self._data["lastConnEvent.category"] == "CONNECTED" | ||||
|         return self._data | ||||
|     def settings(self, settings): | ||||
|         return settings | ||||
|  | ||||
							
								
								
									
										128
									
								
								pyhon/auth.py
									
									
									
									
									
								
							
							
						
						
									
										128
									
								
								pyhon/auth.py
									
									
									
									
									
								
							| @ -1,128 +0,0 @@ | ||||
| import json | ||||
| import logging | ||||
| import re | ||||
| import secrets | ||||
| import urllib | ||||
| from urllib import parse | ||||
|  | ||||
| import aiohttp as aiohttp | ||||
|  | ||||
| from pyhon import const | ||||
|  | ||||
| _LOGGER = logging.getLogger() | ||||
|  | ||||
|  | ||||
| class HonAuth: | ||||
|     def __init__(self) -> None: | ||||
|         self._framework = "" | ||||
|         self._cognito_token = "" | ||||
|         self._id_token = "" | ||||
|  | ||||
|     @property | ||||
|     def cognito_token(self): | ||||
|         return self._cognito_token | ||||
|  | ||||
|     @property | ||||
|     def id_token(self): | ||||
|         return self._id_token | ||||
|  | ||||
|     async def _get_frontdoor_url(self, session, email, password): | ||||
|         data = { | ||||
|             "message": { | ||||
|                 "actions": [ | ||||
|                     { | ||||
|                         "id": "79;a", | ||||
|                         "descriptor": "apex://LightningLoginCustomController/ACTION$login", | ||||
|                         "callingDescriptor": "markup://c:loginForm", | ||||
|                         "params": { | ||||
|                             "username": email, | ||||
|                             "password": password, | ||||
|                             "startUrl": "" | ||||
|                         } | ||||
|                     } | ||||
|                 ] | ||||
|             }, | ||||
|             "aura.context": { | ||||
|                 "mode": "PROD", | ||||
|                 "fwuid": self._framework, | ||||
|                 "app": "siteforce:loginApp2", | ||||
|                 "loaded": {"APPLICATION@markup://siteforce:loginApp2": "YtNc5oyHTOvavSB9Q4rtag"}, | ||||
|                 "dn": [], | ||||
|                 "globals": {}, | ||||
|                 "uad": False}, | ||||
|             "aura.pageURI": f"SmartHome/s/login/?language={const.LANGUAGE}", | ||||
|             "aura.token": None} | ||||
|  | ||||
|         params = {"r": 3, "other.LightningLoginCustom.login": 1} | ||||
|         async with session.post( | ||||
|                 const.AUTH_API + "/s/sfsites/aura", | ||||
|                 headers={"Content-Type": "application/x-www-form-urlencoded"}, | ||||
|                 data="&".join(f"{k}={json.dumps(v)}" for k, v in data.items()), | ||||
|                 params=params | ||||
|         ) as response: | ||||
|             if response.status != 200: | ||||
|                 _LOGGER.error("Unable to connect to the login service: %s\n%s", response.status, await response.text()) | ||||
|                 return "" | ||||
|             try: | ||||
|                 text = await response.text() | ||||
|                 return (await response.json())["events"][0]["attributes"]["values"]["url"] | ||||
|             except json.JSONDecodeError: | ||||
|                 if framework := re.findall('clientOutOfSync.*?Expected: ([\\w-]+?) Actual: (.*?)"', text): | ||||
|                     self._framework, actual = framework[0] | ||||
|                     _LOGGER.debug('Framework update from "%s" to "%s"', self._framework, actual) | ||||
|                     return await self._get_frontdoor_url(session, email, password) | ||||
|                 _LOGGER.error("Unable to retrieve the frontdoor URL. Message: " + text) | ||||
|                 return "" | ||||
|  | ||||
|     async def _prepare_login(self, session, email, password): | ||||
|         if not (frontdoor_url := await self._get_frontdoor_url(session, email, password)): | ||||
|             return False | ||||
|  | ||||
|         async with session.get(frontdoor_url) as resp: | ||||
|             if resp.status != 200: | ||||
|                 _LOGGER.error("Unable to connect to the login service: %s", resp.status) | ||||
|                 return False | ||||
|  | ||||
|         params = {"retURL": "/SmartHome/apex/CustomCommunitiesLanding"} | ||||
|         async with session.get(f"{const.AUTH_API}/apex/ProgressiveLogin", params=params) as resp: | ||||
|             if resp.status != 200: | ||||
|                 _LOGGER.error("Unable to connect to the login service: %s", resp.status) | ||||
|                 return False | ||||
|         return True | ||||
|  | ||||
|     async def _login(self, session): | ||||
|         nonce = secrets.token_hex(16) | ||||
|         nonce = f"{nonce[:8]}-{nonce[8:12]}-{nonce[12:16]}-{nonce[16:20]}-{nonce[20:]}" | ||||
|         params = { | ||||
|             "response_type": "token+id_token", | ||||
|             "client_id": const.CLIENT_ID, | ||||
|             "redirect_uri": urllib.parse.quote(f"{const.APP}://mobilesdk/detect/oauth/done"), | ||||
|             "display": "touch", | ||||
|             "scope": "api openid refresh_token web", | ||||
|             "nonce": nonce | ||||
|         } | ||||
|         params = "&".join([f"{k}={v}" for k, v in params.items()]) | ||||
|         async with session.get(f"{const.AUTH_API}/services/oauth2/authorize?{params}") as resp: | ||||
|             if id_token := re.findall("id_token=(.*?)&", await resp.text()): | ||||
|                 self._id_token = id_token[0] | ||||
|                 return True | ||||
|         return False | ||||
|  | ||||
|     async def authorize(self, email, password, mobile_id): | ||||
|         async with aiohttp.ClientSession() as session: | ||||
|             if not await self._prepare_login(session, email, password): | ||||
|                 return False | ||||
|             if not await self._login(session): | ||||
|                 return False | ||||
|  | ||||
|             post_headers = {"Content-Type": "application/json", "id-token": self._id_token} | ||||
|             data = {"appVersion": const.APP_VERSION, "mobileId": mobile_id, "osVersion": const.OS_VERSION, | ||||
|                     "os": const.OS, "deviceModel": const.DEVICE_MODEL} | ||||
|             async with session.post(f"{const.API_URL}/auth/v1/login", headers=post_headers, json=data) as resp: | ||||
|                 try: | ||||
|                     json_data = await resp.json() | ||||
|                 except json.JSONDecodeError: | ||||
|                     _LOGGER.error("No JSON Data after POST: %s", await resp.text()) | ||||
|                     return False | ||||
|                 self._cognito_token = json_data["cognitoUser"]["Token"] | ||||
|         return True | ||||
| @ -1,16 +1,23 @@ | ||||
| from pyhon.parameter import HonParameterFixed, HonParameterEnum, HonParameterRange, HonParameterProgram | ||||
| from pyhon.parameter import ( | ||||
|     HonParameterFixed, | ||||
|     HonParameterEnum, | ||||
|     HonParameterRange, | ||||
|     HonParameterProgram, | ||||
| ) | ||||
|  | ||||
|  | ||||
| class HonCommand: | ||||
|     def __init__(self, name, attributes, connector, device, multi=None, category=""): | ||||
|     def __init__(self, name, attributes, connector, device, multi=None, program=""): | ||||
|         self._connector = connector | ||||
|         self._device = device | ||||
|         self._name = name | ||||
|         self._multi = multi or {} | ||||
|         self._category = category | ||||
|         self._program = program | ||||
|         self._description = attributes.get("description", "") | ||||
|         self._parameters = self._create_parameters(attributes.get("parameters", {})) | ||||
|         self._ancillary_parameters = self._create_parameters(attributes.get("ancillaryParameters", {})) | ||||
|         self._ancillary_parameters = self._create_parameters( | ||||
|             attributes.get("ancillaryParameters", {}) | ||||
|         ) | ||||
|  | ||||
|     def __repr__(self): | ||||
|         return f"{self._name} command" | ||||
| @ -18,6 +25,8 @@ class HonCommand: | ||||
|     def _create_parameters(self, parameters): | ||||
|         result = {} | ||||
|         for parameter, attributes in parameters.items(): | ||||
|             if parameter == "zoneMap" and self._device.zone: | ||||
|                 attributes["default"] = self._device.zone | ||||
|             match attributes.get("typology"): | ||||
|                 case "range": | ||||
|                     result[parameter] = HonParameterRange(parameter, attributes) | ||||
| @ -31,18 +40,22 @@ class HonCommand: | ||||
|  | ||||
|     @property | ||||
|     def parameters(self): | ||||
|         result = {key: parameter.value for key, parameter in self._parameters.items()} | ||||
|         if self._multi: | ||||
|             result |= {"program": self._category} | ||||
|         return result | ||||
|         return self._parameters | ||||
|  | ||||
|     @property | ||||
|     def ancillary_parameters(self): | ||||
|         return {key: parameter.value for key, parameter in self._ancillary_parameters.items()} | ||||
|         return { | ||||
|             key: parameter.value | ||||
|             for key, parameter in self._ancillary_parameters.items() | ||||
|         } | ||||
|  | ||||
|     async def send(self): | ||||
|         return await self._connector.send_command(self._device, self._name, self.parameters, | ||||
|                                                   self.ancillary_parameters) | ||||
|         parameters = { | ||||
|             name: parameter.value for name, parameter in self._parameters.items() | ||||
|         } | ||||
|         return await self._connector.send_command( | ||||
|             self._device, self._name, parameters, self.ancillary_parameters | ||||
|         ) | ||||
|  | ||||
|     def get_programs(self): | ||||
|         return self._multi | ||||
| @ -64,11 +77,16 @@ class HonCommand: | ||||
|     def setting_keys(self): | ||||
|         if not self._multi: | ||||
|             return self._get_settings_keys() | ||||
|         result = [key for cmd in self._multi.values() for key in self._get_settings_keys(cmd)] | ||||
|         result = [ | ||||
|             key for cmd in self._multi.values() for key in self._get_settings_keys(cmd) | ||||
|         ] | ||||
|         return list(set(result + ["program"])) | ||||
|  | ||||
|     @property | ||||
|     def settings(self): | ||||
|         """Parameters with typology enum and range""" | ||||
|         return {s: self._parameters[s] for s in self.setting_keys} | ||||
|  | ||||
|         return { | ||||
|             s: self._parameters.get(s) | ||||
|             for s in self.setting_keys | ||||
|             if self._parameters.get(s) is not None | ||||
|         } | ||||
|  | ||||
							
								
								
									
										0
									
								
								pyhon/connection/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										0
									
								
								pyhon/connection/__init__.py
									
									
									
									
									
										Normal file
									
								
							
							
								
								
									
										194
									
								
								pyhon/connection/api.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										194
									
								
								pyhon/connection/api.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,194 @@ | ||||
| import json | ||||
| import logging | ||||
| from datetime import datetime | ||||
| from typing import Dict, Optional | ||||
| from typing_extensions import Self | ||||
|  | ||||
| from aiohttp import ClientSession | ||||
|  | ||||
| from pyhon import const, exceptions | ||||
| from pyhon.appliance import HonAppliance | ||||
| from pyhon.connection.auth import HonAuth | ||||
| from pyhon.connection.handler import HonConnectionHandler, HonAnonymousConnectionHandler | ||||
|  | ||||
| _LOGGER = logging.getLogger() | ||||
|  | ||||
|  | ||||
| class HonAPI: | ||||
|     def __init__( | ||||
|         self, | ||||
|         email: str = "", | ||||
|         password: str = "", | ||||
|         anonymous: bool = False, | ||||
|         session: Optional[ClientSession] = None, | ||||
|     ) -> None: | ||||
|         super().__init__() | ||||
|         self._email: str = email | ||||
|         self._password: str = password | ||||
|         self._anonymous: bool = anonymous | ||||
|         self._hon_handler: Optional[HonConnectionHandler] = None | ||||
|         self._hon_anonymous_handler: Optional[HonAnonymousConnectionHandler] = None | ||||
|         self._session: Optional[ClientSession] = session | ||||
|  | ||||
|     async def __aenter__(self) -> Self: | ||||
|         return await self.create() | ||||
|  | ||||
|     async def __aexit__(self, exc_type, exc_val, exc_tb) -> None: | ||||
|         await self.close() | ||||
|  | ||||
|     @property | ||||
|     def auth(self) -> HonAuth: | ||||
|         if self._hon is None or self._hon.auth is None: | ||||
|             raise exceptions.NoAuthenticationException | ||||
|         return self._hon.auth | ||||
|  | ||||
|     @property | ||||
|     def _hon(self): | ||||
|         if self._hon_handler is None: | ||||
|             raise exceptions.NoAuthenticationException | ||||
|         return self._hon_handler | ||||
|  | ||||
|     @property | ||||
|     def _hon_anonymous(self): | ||||
|         if self._hon_anonymous_handler is None: | ||||
|             raise exceptions.NoAuthenticationException | ||||
|         return self._hon_anonymous_handler | ||||
|  | ||||
|     async def create(self) -> Self: | ||||
|         self._hon_anonymous_handler = await HonAnonymousConnectionHandler( | ||||
|             self._session | ||||
|         ).create() | ||||
|         if not self._anonymous: | ||||
|             self._hon_handler = await HonConnectionHandler( | ||||
|                 self._email, self._password, self._session | ||||
|             ).create() | ||||
|         return self | ||||
|  | ||||
|     async def load_appliances(self) -> Dict: | ||||
|         async with self._hon.get(f"{const.API_URL}/commands/v1/appliance") as resp: | ||||
|             return await resp.json() | ||||
|  | ||||
|     async def load_commands(self, appliance: HonAppliance) -> Dict: | ||||
|         params: Dict = { | ||||
|             "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"], | ||||
|         } | ||||
|         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": | ||||
|                 return {} | ||||
|             return result | ||||
|  | ||||
|     async def command_history(self, appliance: HonAppliance) -> Dict: | ||||
|         url: str = ( | ||||
|             f"{const.API_URL}/commands/v1/appliance/{appliance.mac_address}/history" | ||||
|         ) | ||||
|         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"]["history"] | ||||
|  | ||||
|     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} | ||||
|         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, | ||||
|             "applianceType": appliance.appliance_type, | ||||
|             "category": "CYCLE", | ||||
|         } | ||||
|         url: str = f"{const.API_URL}/commands/v1/context" | ||||
|         async with self._hon.get(url, params=params) as response: | ||||
|             return (await response.json()).get("payload", {}) | ||||
|  | ||||
|     async def load_statistics(self, appliance: HonAppliance) -> Dict: | ||||
|         params: Dict = { | ||||
|             "macAddress": appliance.mac_address, | ||||
|             "applianceType": appliance.appliance_type, | ||||
|         } | ||||
|         url: str = f"{const.API_URL}/commands/v1/statistics" | ||||
|         async with self._hon.get(url, params=params) as response: | ||||
|             return (await response.json()).get("payload", {}) | ||||
|  | ||||
|     async def send_command( | ||||
|         self, | ||||
|         appliance: HonAppliance, | ||||
|         command: str, | ||||
|         parameters: Dict, | ||||
|         ancillary_parameters: Dict, | ||||
|     ) -> bool: | ||||
|         now: str = datetime.utcnow().isoformat() | ||||
|         data: Dict = { | ||||
|             "macAddress": appliance.mac_address, | ||||
|             "timestamp": f"{now[:-3]}Z", | ||||
|             "commandName": command, | ||||
|             "transactionId": f"{appliance.mac_address}_{now[:-3]}Z", | ||||
|             "applianceOptions": appliance.commands_options, | ||||
|             "device": self._hon.device.get(mobile=True), | ||||
|             "attributes": { | ||||
|                 "channel": "mobileApp", | ||||
|                 "origin": "standardProgram", | ||||
|                 "energyLabel": "0", | ||||
|             }, | ||||
|             "ancillaryParameters": ancillary_parameters, | ||||
|             "parameters": parameters, | ||||
|             "applianceType": appliance.appliance_type, | ||||
|         } | ||||
|         url: str = f"{const.API_URL}/commands/v1/send" | ||||
|         async with self._hon.post(url, json=data) as response: | ||||
|             json_data: Dict = await response.json() | ||||
|             if json_data.get("payload", {}).get("resultCode") == "0": | ||||
|                 return True | ||||
|             _LOGGER.error(await response.text()) | ||||
|         return False | ||||
|  | ||||
|     async def appliance_configuration(self) -> Dict: | ||||
|         url: str = f"{const.API_URL}/config/v1/appliance-configuration" | ||||
|         async with self._hon_anonymous.get(url) as response: | ||||
|             result: Dict = await response.json() | ||||
|             if result and (data := result.get("payload")): | ||||
|                 return data | ||||
|         return {} | ||||
|  | ||||
|     async def app_config(self, language: str = "en", beta: bool = True) -> Dict: | ||||
|         url: str = f"{const.API_URL}/app-config" | ||||
|         payload_data: Dict = { | ||||
|             "languageCode": language, | ||||
|             "beta": beta, | ||||
|             "appVersion": const.APP_VERSION, | ||||
|             "os": const.OS, | ||||
|         } | ||||
|         payload: str = json.dumps(payload_data, separators=(",", ":")) | ||||
|         async with self._hon_anonymous.post(url, data=payload) as response: | ||||
|             if (result := await response.json()) and (data := result.get("payload")): | ||||
|                 return data | ||||
|         return {} | ||||
|  | ||||
|     async def translation_keys(self, language: str = "en") -> Dict: | ||||
|         config = await self.app_config(language=language) | ||||
|         if url := config.get("language", {}).get("jsonPath"): | ||||
|             async with self._hon_anonymous.get(url) as response: | ||||
|                 if result := await response.json(): | ||||
|                     return result | ||||
|         return {} | ||||
|  | ||||
|     async def close(self) -> None: | ||||
|         if self._hon_handler is not None: | ||||
|             await self._hon_handler.close() | ||||
|         if self._hon_anonymous_handler is not None: | ||||
|             await self._hon_anonymous_handler.close() | ||||
							
								
								
									
										268
									
								
								pyhon/connection/auth.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										268
									
								
								pyhon/connection/auth.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,268 @@ | ||||
| import json | ||||
| import logging | ||||
| import re | ||||
| import secrets | ||||
| import urllib | ||||
| from datetime import datetime, timedelta | ||||
| from pprint import pformat | ||||
| from typing import List, Tuple | ||||
| from urllib import parse | ||||
| from urllib.parse import quote | ||||
|  | ||||
| from yarl import URL | ||||
|  | ||||
| from pyhon import const, exceptions | ||||
|  | ||||
| _LOGGER = logging.getLogger(__name__) | ||||
|  | ||||
|  | ||||
| class HonAuth: | ||||
|     _TOKEN_EXPIRES_AFTER_HOURS = 8 | ||||
|     _TOKEN_EXPIRE_WARNING_HOURS = 7 | ||||
|  | ||||
|     def __init__(self, session, email, password, device) -> None: | ||||
|         self._session = session | ||||
|         self._email = email | ||||
|         self._password = password | ||||
|         self._access_token = "" | ||||
|         self._refresh_token = "" | ||||
|         self._cognito_token = "" | ||||
|         self._id_token = "" | ||||
|         self._device = device | ||||
|         self._called_urls: List[Tuple[int, str]] = [] | ||||
|         self._expires: datetime = datetime.utcnow() | ||||
|  | ||||
|     @property | ||||
|     def cognito_token(self): | ||||
|         return self._cognito_token | ||||
|  | ||||
|     @property | ||||
|     def id_token(self): | ||||
|         return self._id_token | ||||
|  | ||||
|     @property | ||||
|     def access_token(self): | ||||
|         return self._access_token | ||||
|  | ||||
|     @property | ||||
|     def refresh_token(self): | ||||
|         return self._refresh_token | ||||
|  | ||||
|     def _check_token_expiration(self, hours): | ||||
|         return datetime.utcnow() >= self._expires + timedelta(hours=hours) | ||||
|  | ||||
|     @property | ||||
|     def token_is_expired(self) -> bool: | ||||
|         return self._check_token_expiration(self._TOKEN_EXPIRES_AFTER_HOURS) | ||||
|  | ||||
|     @property | ||||
|     def token_expires_soon(self) -> bool: | ||||
|         return self._check_token_expiration(self._TOKEN_EXPIRE_WARNING_HOURS) | ||||
|  | ||||
|     async def _error_logger(self, response, fail=True): | ||||
|         result = "hOn Authentication Error\n" | ||||
|         for i, (status, url) in enumerate(self._called_urls): | ||||
|             result += f" {i + 1: 2d}     {status} - {url}\n" | ||||
|         result += f"ERROR - {response.status} - {response.request_info.url}\n" | ||||
|         result += f"{15 * '='} Response {15 * '='}\n{await response.text()}\n{40 * '='}" | ||||
|         _LOGGER.error(result) | ||||
|         if fail: | ||||
|             raise exceptions.HonAuthenticationError("Can't login") | ||||
|  | ||||
|     async def _load_login(self): | ||||
|         nonce = secrets.token_hex(16) | ||||
|         nonce = f"{nonce[:8]}-{nonce[8:12]}-{nonce[12:16]}-{nonce[16:20]}-{nonce[20:]}" | ||||
|         params = { | ||||
|             "response_type": "token+id_token", | ||||
|             "client_id": const.CLIENT_ID, | ||||
|             "redirect_uri": urllib.parse.quote( | ||||
|                 f"{const.APP}://mobilesdk/detect/oauth/done" | ||||
|             ), | ||||
|             "display": "touch", | ||||
|             "scope": "api openid refresh_token web", | ||||
|             "nonce": nonce, | ||||
|         } | ||||
|         params = "&".join([f"{k}={v}" for k, v in params.items()]) | ||||
|         async with self._session.get( | ||||
|             f"{const.AUTH_API}/services/oauth2/authorize/expid_Login?{params}" | ||||
|         ) as response: | ||||
|             self._called_urls.append((response.status, response.request_info.url)) | ||||
|             text = await response.text() | ||||
|             self._expires = datetime.utcnow() | ||||
|             if not (login_url := re.findall("url = '(.+?)'", text)): | ||||
|                 if "oauth/done#access_token=" in text: | ||||
|                     self._parse_token_data(text) | ||||
|                     raise exceptions.HonNoAuthenticationNeeded() | ||||
|                 await self._error_logger(response) | ||||
|                 return False | ||||
|         async with self._session.get(login_url[0], allow_redirects=False) as redirect1: | ||||
|             self._called_urls.append((redirect1.status, redirect1.request_info.url)) | ||||
|             if not (url := redirect1.headers.get("Location")): | ||||
|                 await self._error_logger(redirect1) | ||||
|                 return False | ||||
|         async with self._session.get(url, allow_redirects=False) as redirect2: | ||||
|             self._called_urls.append((redirect2.status, redirect2.request_info.url)) | ||||
|             if not ( | ||||
|                 url := redirect2.headers.get("Location") | ||||
|                 + "&System=IoT_Mobile_App&RegistrationSubChannel=hOn" | ||||
|             ): | ||||
|                 await self._error_logger(redirect2) | ||||
|                 return False | ||||
|         async with self._session.get( | ||||
|             URL(url, encoded=True), headers={"user-agent": const.USER_AGENT} | ||||
|         ) as login_screen: | ||||
|             self._called_urls.append( | ||||
|                 (login_screen.status, login_screen.request_info.url) | ||||
|             ) | ||||
|             if context := re.findall( | ||||
|                 '"fwuid":"(.*?)","loaded":(\\{.*?})', await login_screen.text() | ||||
|             ): | ||||
|                 fw_uid, loaded_str = context[0] | ||||
|                 loaded = json.loads(loaded_str) | ||||
|                 login_url = login_url[0].replace( | ||||
|                     "/".join(const.AUTH_API.split("/")[:-1]), "" | ||||
|                 ) | ||||
|                 return fw_uid, loaded, login_url | ||||
|             await self._error_logger(login_screen) | ||||
|         return False | ||||
|  | ||||
|     async def _login(self, fw_uid, loaded, login_url): | ||||
|         data = { | ||||
|             "message": { | ||||
|                 "actions": [ | ||||
|                     { | ||||
|                         "id": "79;a", | ||||
|                         "descriptor": "apex://LightningLoginCustomController/ACTION$login", | ||||
|                         "callingDescriptor": "markup://c:loginForm", | ||||
|                         "params": { | ||||
|                             "username": quote(self._email), | ||||
|                             "password": quote(self._password), | ||||
|                             "startUrl": parse.unquote( | ||||
|                                 login_url.split("startURL=")[-1] | ||||
|                             ).split("%3D")[0], | ||||
|                         }, | ||||
|                     } | ||||
|                 ] | ||||
|             }, | ||||
|             "aura.context": { | ||||
|                 "mode": "PROD", | ||||
|                 "fwuid": fw_uid, | ||||
|                 "app": "siteforce:loginApp2", | ||||
|                 "loaded": loaded, | ||||
|                 "dn": [], | ||||
|                 "globals": {}, | ||||
|                 "uad": False, | ||||
|             }, | ||||
|             "aura.pageURI": login_url, | ||||
|             "aura.token": None, | ||||
|         } | ||||
|         params = {"r": 3, "other.LightningLoginCustom.login": 1} | ||||
|         async with self._session.post( | ||||
|             const.AUTH_API + "/s/sfsites/aura", | ||||
|             headers={"Content-Type": "application/x-www-form-urlencoded"}, | ||||
|             data="&".join(f"{k}={json.dumps(v)}" for k, v in data.items()), | ||||
|             params=params, | ||||
|         ) as response: | ||||
|             self._called_urls.append((response.status, response.request_info.url)) | ||||
|             if response.status == 200: | ||||
|                 try: | ||||
|                     data = await response.json() | ||||
|                     return data["events"][0]["attributes"]["values"]["url"] | ||||
|                 except json.JSONDecodeError: | ||||
|                     pass | ||||
|                 except KeyError: | ||||
|                     _LOGGER.error( | ||||
|                         "Can't get login url - %s", pformat(await response.json()) | ||||
|                     ) | ||||
|             await self._error_logger(response) | ||||
|             return "" | ||||
|  | ||||
|     def _parse_token_data(self, text): | ||||
|         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] | ||||
|  | ||||
|     async def _get_token(self, url): | ||||
|         async with self._session.get(url) as response: | ||||
|             self._called_urls.append((response.status, response.request_info.url)) | ||||
|             if response.status != 200: | ||||
|                 await self._error_logger(response) | ||||
|                 return False | ||||
|             url = re.findall("href\\s*=\\s*[\"'](.+?)[\"']", await response.text()) | ||||
|             if not url: | ||||
|                 await self._error_logger(response) | ||||
|                 return False | ||||
|         if "ProgressiveLogin" in url[0]: | ||||
|             async with self._session.get(url[0]) as response: | ||||
|                 self._called_urls.append((response.status, response.request_info.url)) | ||||
|                 if response.status != 200: | ||||
|                     await self._error_logger(response) | ||||
|                     return False | ||||
|                 url = re.findall("href\\s*=\\s*[\"'](.*?)[\"']", await response.text()) | ||||
|         url = "/".join(const.AUTH_API.split("/")[:-1]) + url[0] | ||||
|         async with self._session.get(url) as response: | ||||
|             self._called_urls.append((response.status, response.request_info.url)) | ||||
|             if response.status != 200: | ||||
|                 await self._error_logger(response) | ||||
|                 return False | ||||
|             self._parse_token_data(await response.text()) | ||||
|         return True | ||||
|  | ||||
|     async def _api_auth(self): | ||||
|         post_headers = {"id-token": self._id_token} | ||||
|         data = self._device.get() | ||||
|         async with self._session.post( | ||||
|             f"{const.API_URL}/auth/v1/login", headers=post_headers, json=data | ||||
|         ) as response: | ||||
|             self._called_urls.append((response.status, response.request_info.url)) | ||||
|             try: | ||||
|                 json_data = await response.json() | ||||
|             except json.JSONDecodeError: | ||||
|                 await self._error_logger(response) | ||||
|                 return False | ||||
|             self._cognito_token = json_data["cognitoUser"]["Token"] | ||||
|         return True | ||||
|  | ||||
|     async def authenticate(self): | ||||
|         self.clear() | ||||
|         try: | ||||
|             if not (login_site := await self._load_login()): | ||||
|                 raise exceptions.HonAuthenticationError("Can't open login page") | ||||
|             if not (url := await self._login(*login_site)): | ||||
|                 raise exceptions.HonAuthenticationError("Can't login") | ||||
|             if not await self._get_token(url): | ||||
|                 raise exceptions.HonAuthenticationError("Can't get token") | ||||
|             if not await self._api_auth(): | ||||
|                 raise exceptions.HonAuthenticationError("Can't get api token") | ||||
|         except exceptions.HonNoAuthenticationNeeded: | ||||
|             return | ||||
|  | ||||
|     async def refresh(self): | ||||
|         params = { | ||||
|             "client_id": const.CLIENT_ID, | ||||
|             "refresh_token": self._refresh_token, | ||||
|             "grant_type": "refresh_token", | ||||
|         } | ||||
|         async with self._session.post( | ||||
|             f"{const.AUTH_API}/services/oauth2/token", params=params | ||||
|         ) as response: | ||||
|             self._called_urls.append((response.status, response.request_info.url)) | ||||
|             if response.status >= 400: | ||||
|                 await self._error_logger(response, fail=False) | ||||
|                 return False | ||||
|             data = await response.json() | ||||
|         self._expires = datetime.utcnow() | ||||
|         self._id_token = data["id_token"] | ||||
|         self._access_token = data["access_token"] | ||||
|         return await self._api_auth() | ||||
|  | ||||
|     def clear(self): | ||||
|         self._session.cookie_jar.clear_domain(const.AUTH_API.split("/")[-2]) | ||||
|         self._called_urls = [] | ||||
|         self._cognito_token = "" | ||||
|         self._id_token = "" | ||||
|         self._access_token = "" | ||||
|         self._refresh_token = "" | ||||
							
								
								
									
										43
									
								
								pyhon/connection/device.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										43
									
								
								pyhon/connection/device.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,43 @@ | ||||
| import secrets | ||||
| from typing import Dict | ||||
|  | ||||
| from pyhon import const | ||||
|  | ||||
|  | ||||
| class HonDevice: | ||||
|     def __init__(self) -> None: | ||||
|         self._app_version: str = const.APP_VERSION | ||||
|         self._os_version: int = const.OS_VERSION | ||||
|         self._os: str = const.OS | ||||
|         self._device_model: str = const.DEVICE_MODEL | ||||
|         self._mobile_id: str = secrets.token_hex(8) | ||||
|  | ||||
|     @property | ||||
|     def app_version(self) -> str: | ||||
|         return self._app_version | ||||
|  | ||||
|     @property | ||||
|     def os_version(self) -> int: | ||||
|         return self._os_version | ||||
|  | ||||
|     @property | ||||
|     def os(self) -> str: | ||||
|         return self._os | ||||
|  | ||||
|     @property | ||||
|     def device_model(self) -> str: | ||||
|         return self._device_model | ||||
|  | ||||
|     @property | ||||
|     def mobile_id(self) -> str: | ||||
|         return self._mobile_id | ||||
|  | ||||
|     def get(self, mobile: bool = False) -> Dict: | ||||
|         result = { | ||||
|             "appVersion": self.app_version, | ||||
|             "mobileId": self.mobile_id, | ||||
|             "os": self.os, | ||||
|             "osVersion": self.os_version, | ||||
|             "deviceModel": self.device_model, | ||||
|         } | ||||
|         return (result | {"mobileOs": result.pop("os")}) if mobile else result | ||||
							
								
								
									
										159
									
								
								pyhon/connection/handler.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										159
									
								
								pyhon/connection/handler.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,159 @@ | ||||
| import json | ||||
| from collections.abc import Generator, AsyncIterator, Coroutine | ||||
| from contextlib import asynccontextmanager | ||||
| from typing import Optional, Callable, Dict | ||||
| from typing_extensions import Self | ||||
|  | ||||
| import aiohttp | ||||
|  | ||||
| from pyhon import const, exceptions | ||||
| from pyhon.connection.auth import HonAuth, _LOGGER | ||||
| from pyhon.connection.device import HonDevice | ||||
| from pyhon.exceptions import HonAuthenticationError | ||||
|  | ||||
|  | ||||
| class HonBaseConnectionHandler: | ||||
|     _HEADERS: Dict = { | ||||
|         "user-agent": const.USER_AGENT, | ||||
|         "Content-Type": "application/json", | ||||
|     } | ||||
|  | ||||
|     def __init__(self, session: Optional[aiohttp.ClientSession] = None) -> None: | ||||
|         self._create_session: bool = session is None | ||||
|         self._session: Optional[aiohttp.ClientSession] = session | ||||
|         self._auth: Optional[HonAuth] = None | ||||
|  | ||||
|     async def __aenter__(self) -> Self: | ||||
|         return await self.create() | ||||
|  | ||||
|     async def __aexit__(self, exc_type, exc_val, exc_tb) -> None: | ||||
|         await self.close() | ||||
|  | ||||
|     @property | ||||
|     def auth(self) -> Optional[HonAuth]: | ||||
|         return self._auth | ||||
|  | ||||
|     async def create(self) -> Self: | ||||
|         if self._create_session: | ||||
|             self._session = aiohttp.ClientSession() | ||||
|         return self | ||||
|  | ||||
|     @asynccontextmanager | ||||
|     def _intercept(self, method: Callable, *args, loop: int = 0, **kwargs): | ||||
|         raise NotImplementedError | ||||
|  | ||||
|     @asynccontextmanager | ||||
|     async def get(self, *args, **kwargs) -> AsyncIterator[Callable]: | ||||
|         if self._session is None: | ||||
|             raise exceptions.NoSessionException() | ||||
|         response: Callable | ||||
|         async with self._intercept(self._session.get, *args, **kwargs) as response: | ||||
|             yield response | ||||
|  | ||||
|     @asynccontextmanager | ||||
|     async def post(self, *args, **kwargs) -> AsyncIterator[Callable]: | ||||
|         if self._session is None: | ||||
|             raise exceptions.NoSessionException() | ||||
|         response: Callable | ||||
|         async with self._intercept(self._session.post, *args, **kwargs) as response: | ||||
|             yield response | ||||
|  | ||||
|     async def close(self) -> None: | ||||
|         if self._create_session and self._session is not None: | ||||
|             await self._session.close() | ||||
|  | ||||
|  | ||||
| class HonConnectionHandler(HonBaseConnectionHandler): | ||||
|     def __init__( | ||||
|         self, email: str, password: str, session: Optional[aiohttp.ClientSession] = None | ||||
|     ) -> None: | ||||
|         super().__init__(session=session) | ||||
|         self._device: HonDevice = HonDevice() | ||||
|         self._email: str = email | ||||
|         self._password: str = password | ||||
|         if not self._email: | ||||
|             raise HonAuthenticationError("An email address must be specified") | ||||
|         if not self._password: | ||||
|             raise HonAuthenticationError("A password address must be specified") | ||||
|  | ||||
|     @property | ||||
|     def device(self) -> HonDevice: | ||||
|         return self._device | ||||
|  | ||||
|     async def create(self) -> Self: | ||||
|         await super().create() | ||||
|         self._auth: HonAuth = HonAuth( | ||||
|             self._session, self._email, self._password, self._device | ||||
|         ) | ||||
|         return self | ||||
|  | ||||
|     async def _check_headers(self, headers: Dict) -> Dict: | ||||
|         if not (self._auth.cognito_token and self._auth.id_token): | ||||
|             await self._auth.authenticate() | ||||
|         headers["cognito-token"] = self._auth.cognito_token | ||||
|         headers["id-token"] = self._auth.id_token | ||||
|         return self._HEADERS | headers | ||||
|  | ||||
|     @asynccontextmanager | ||||
|     async def _intercept( | ||||
|         self, method: Callable, *args, loop: int = 0, **kwargs | ||||
|     ) -> AsyncIterator: | ||||
|         kwargs["headers"] = await self._check_headers(kwargs.get("headers", {})) | ||||
|         async with method(*args, **kwargs) as response: | ||||
|             if ( | ||||
|                 self._auth.token_expires_soon or response.status in [401, 403] | ||||
|             ) and loop == 0: | ||||
|                 _LOGGER.info("Try refreshing token...") | ||||
|                 await self._auth.refresh() | ||||
|                 async with self._intercept( | ||||
|                     method, *args, loop=loop + 1, **kwargs | ||||
|                 ) as result: | ||||
|                     yield result | ||||
|             elif ( | ||||
|                 self._auth.token_is_expired or response.status in [401, 403] | ||||
|             ) and loop == 1: | ||||
|                 _LOGGER.warning( | ||||
|                     "%s - Error %s - %s", | ||||
|                     response.request_info.url, | ||||
|                     response.status, | ||||
|                     await response.text(), | ||||
|                 ) | ||||
|                 await self.create() | ||||
|                 async with self._intercept( | ||||
|                     method, *args, loop=loop + 1, **kwargs | ||||
|                 ) as result: | ||||
|                     yield result | ||||
|             elif loop >= 2: | ||||
|                 _LOGGER.error( | ||||
|                     "%s - Error %s - %s", | ||||
|                     response.request_info.url, | ||||
|                     response.status, | ||||
|                     await response.text(), | ||||
|                 ) | ||||
|                 raise HonAuthenticationError("Login failure") | ||||
|             else: | ||||
|                 try: | ||||
|                     await response.json() | ||||
|                     yield response | ||||
|                 except json.JSONDecodeError: | ||||
|                     _LOGGER.warning( | ||||
|                         "%s - JsonDecodeError %s - %s", | ||||
|                         response.request_info.url, | ||||
|                         response.status, | ||||
|                         await response.text(), | ||||
|                     ) | ||||
|                     raise HonAuthenticationError("Decode Error") | ||||
|  | ||||
|  | ||||
| class HonAnonymousConnectionHandler(HonBaseConnectionHandler): | ||||
|     _HEADERS: Dict = HonBaseConnectionHandler._HEADERS | {"x-api-key": const.API_KEY} | ||||
|  | ||||
|     @asynccontextmanager | ||||
|     async def _intercept( | ||||
|         self, method: Callable, *args, loop: int = 0, **kwargs | ||||
|     ) -> AsyncIterator: | ||||
|         kwargs["headers"] = kwargs.pop("headers", {}) | self._HEADERS | ||||
|         async with method(*args, **kwargs) as response: | ||||
|             if response.status == 403: | ||||
|                 _LOGGER.error("Can't authenticate anymore") | ||||
|             yield response | ||||
| @ -1,10 +1,11 @@ | ||||
| AUTH_API = "https://he-accounts.force.com/SmartHome" | ||||
| API_URL = "https://api-iot.he.services" | ||||
| API_KEY = "GRCqFhC6Gk@ikWXm1RmnSmX1cm,MxY-configuration" | ||||
| APP = "hon" | ||||
| # All seen id's (different accounts, different devices) are the same, so I guess this hash is static | ||||
| CLIENT_ID = "3MVG9QDx8IX8nP5T2Ha8ofvlmjLZl5L_gvfbT9.HJvpHGKoAS_dcMN8LYpTSYeVFCraUnV.2Ag1Ki7m4znVO6" | ||||
| APP_VERSION = "1.51.9" | ||||
| APP_VERSION = "1.53.7" | ||||
| OS_VERSION = 31 | ||||
| OS = "android" | ||||
| DEVICE_MODEL = "exynos9820" | ||||
| LANGUAGE = "en" | ||||
| USER_AGENT = "Chrome/110.0.5481.153" | ||||
|  | ||||
							
								
								
									
										188
									
								
								pyhon/device.py
									
									
									
									
									
								
							
							
						
						
									
										188
									
								
								pyhon/device.py
									
									
									
									
									
								
							| @ -1,188 +0,0 @@ | ||||
| import importlib | ||||
| from pprint import pprint | ||||
|  | ||||
| from pyhon.commands import HonCommand | ||||
|  | ||||
|  | ||||
| class HonDevice: | ||||
|     def __init__(self, connector, appliance): | ||||
|         self._appliance = appliance | ||||
|         for values in self._appliance.pop("attributes"): | ||||
|             self._appliance[values["parName"]] = values["parValue"] | ||||
|         self._connector = connector | ||||
|         self._appliance_model = {} | ||||
|  | ||||
|         self._commands = {} | ||||
|         self._statistics = {} | ||||
|         self._attributes = {} | ||||
|  | ||||
|     @property | ||||
|     def appliance_id(self): | ||||
|         return self._appliance.get("applianceId") | ||||
|  | ||||
|     @property | ||||
|     def appliance_model_id(self): | ||||
|         return self._appliance.get("applianceModelId") | ||||
|  | ||||
|     @property | ||||
|     def appliance_status(self): | ||||
|         return self._appliance.get("applianceStatus") | ||||
|  | ||||
|     @property | ||||
|     def appliance_type_id(self): | ||||
|         return self._appliance.get("applianceTypeId") | ||||
|  | ||||
|     @property | ||||
|     def appliance_type_name(self): | ||||
|         return self._appliance.get("applianceTypeName") | ||||
|  | ||||
|     @property | ||||
|     def brand(self): | ||||
|         return self._appliance.get("brand") | ||||
|  | ||||
|     @property | ||||
|     def code(self): | ||||
|         return self._appliance.get("code") | ||||
|  | ||||
|     @property | ||||
|     def connectivity(self): | ||||
|         return self._appliance.get("connectivity") | ||||
|  | ||||
|     @property | ||||
|     def coords(self): | ||||
|         return self._appliance.get("coords") | ||||
|  | ||||
|     @property | ||||
|     def eeprom_id(self): | ||||
|         return self._appliance.get("eepromId") | ||||
|  | ||||
|     @property | ||||
|     def eeprom_name(self): | ||||
|         return self._appliance.get("eepromName") | ||||
|  | ||||
|     @property | ||||
|     def enrollment_date(self): | ||||
|         return self._appliance.get("enrollmentDate") | ||||
|  | ||||
|     @property | ||||
|     def first_enrollment(self): | ||||
|         return self._appliance.get("firstEnrollment") | ||||
|  | ||||
|     @property | ||||
|     def first_enrollment_tbc(self): | ||||
|         return self._appliance.get("firstEnrollmentTBC") | ||||
|  | ||||
|     @property | ||||
|     def fw_version(self): | ||||
|         return self._appliance.get("fwVersion") | ||||
|  | ||||
|     @property | ||||
|     def id(self): | ||||
|         return self._appliance.get("id") | ||||
|  | ||||
|     @property | ||||
|     def last_update(self): | ||||
|         return self._appliance.get("lastUpdate") | ||||
|  | ||||
|     @property | ||||
|     def mac_address(self): | ||||
|         return self._appliance.get("macAddress") | ||||
|  | ||||
|     @property | ||||
|     def model_name(self): | ||||
|         return self._appliance.get("modelName") | ||||
|  | ||||
|     @property | ||||
|     def nick_name(self): | ||||
|         return self._appliance.get("nickName") | ||||
|  | ||||
|     @property | ||||
|     def purchase_date(self): | ||||
|         return self._appliance.get("purchaseDate") | ||||
|  | ||||
|     @property | ||||
|     def serial_number(self): | ||||
|         return self._appliance.get("serialNumber") | ||||
|  | ||||
|     @property | ||||
|     def series(self): | ||||
|         return self._appliance.get("series") | ||||
|  | ||||
|     @property | ||||
|     def water_hard(self): | ||||
|         return self._appliance.get("waterHard") | ||||
|  | ||||
|     @property | ||||
|     def commands_options(self): | ||||
|         return self._appliance_model.get("options") | ||||
|  | ||||
|     @property | ||||
|     def commands(self): | ||||
|         return self._commands | ||||
|  | ||||
|     @property | ||||
|     def attributes(self): | ||||
|         return self._attributes | ||||
|  | ||||
|     @property | ||||
|     def statistics(self): | ||||
|         return self._statistics | ||||
|  | ||||
|     @property | ||||
|     def appliance(self): | ||||
|         return self._appliance | ||||
|  | ||||
|     async def load_commands(self): | ||||
|         raw = await self._connector.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._connector, self) | ||||
|             elif "parameters" in attr[list(attr)[0]]: | ||||
|                 multi = {} | ||||
|                 for category, attr2 in attr.items(): | ||||
|                     cmd = HonCommand(command, attr2, self._connector, self, multi=multi, category=category) | ||||
|                     multi[category] = cmd | ||||
|                     commands[command] = cmd | ||||
|         self._commands = 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 | ||||
|         return result | ||||
|  | ||||
|     @property | ||||
|     def parameters(self): | ||||
|         result = {} | ||||
|         for name, command in self._commands.items(): | ||||
|             for key, parameter in command.parameters.items(): | ||||
|                 result[f"{name}.{key}"] = parameter | ||||
|         return result | ||||
|  | ||||
|     async def load_attributes(self): | ||||
|         data = await self._connector.load_attributes(self) | ||||
|         for name, values in data.get("shadow").get("parameters").items(): | ||||
|             self._attributes[name] = values["parNewVal"] | ||||
|         for name, value in data.get("lastConnEvent").items(): | ||||
|             self._attributes[f"lastConnEvent.{name}"] = value | ||||
|  | ||||
|     async def load_statistics(self): | ||||
|         self._statistics = await self._connector.load_statistics(self) | ||||
|  | ||||
|     async def update(self): | ||||
|         await self.load_attributes() | ||||
|  | ||||
|     @property | ||||
|     def data(self): | ||||
|         result = self.attributes | self.parameters | self.appliance | self._statistics | ||||
|         try: | ||||
|             extra = importlib.import_module(f'appliances.{self.appliance_type_name.lower()}') | ||||
|             return result | extra.Appliance(result).get() | ||||
|         except ModuleNotFoundError: | ||||
|             return result | ||||
							
								
								
									
										14
									
								
								pyhon/exceptions.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										14
									
								
								pyhon/exceptions.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,14 @@ | ||||
| class HonAuthenticationError(Exception): | ||||
|     pass | ||||
|  | ||||
|  | ||||
| class HonNoAuthenticationNeeded(Exception): | ||||
|     pass | ||||
|  | ||||
|  | ||||
| class NoSessionException(Exception): | ||||
|     pass | ||||
|  | ||||
|  | ||||
| class NoAuthenticationException(Exception): | ||||
|     pass | ||||
							
								
								
									
										63
									
								
								pyhon/helper.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										63
									
								
								pyhon/helper.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,63 @@ | ||||
| def key_print(data, key="", start=True): | ||||
|     result = "" | ||||
|     if isinstance(data, list): | ||||
|         for i, value in enumerate(data): | ||||
|             result += key_print(value, key=f"{key}.{i}", start=False) | ||||
|     elif isinstance(data, dict): | ||||
|         for k, value in sorted(data.items()): | ||||
|             result += key_print(value, key=k if start else f"{key}.{k}", start=False) | ||||
|     else: | ||||
|         result += f"{key}: {data}\n" | ||||
|     return result | ||||
|  | ||||
|  | ||||
| # yaml.dump() would be done the same, but needs an additional dependency... | ||||
| def pretty_print(data, key="", intend=0, is_list=False, whitespace="  "): | ||||
|     result = "" | ||||
|     if isinstance(data, list): | ||||
|         if key: | ||||
|             result += f"{whitespace * intend}{'- ' if is_list else ''}{key}:\n" | ||||
|             intend += 1 | ||||
|         for i, value in enumerate(data): | ||||
|             result += pretty_print( | ||||
|                 value, intend=intend, is_list=True, whitespace=whitespace | ||||
|             ) | ||||
|     elif isinstance(data, dict): | ||||
|         if key: | ||||
|             result += f"{whitespace * intend}{'- ' if is_list else ''}{key}:\n" | ||||
|             intend += 1 | ||||
|         for i, (key, value) in enumerate(sorted(data.items())): | ||||
|             if is_list and not i: | ||||
|                 result += pretty_print( | ||||
|                     value, key=key, intend=intend, is_list=True, whitespace=whitespace | ||||
|                 ) | ||||
|             elif is_list: | ||||
|                 result += pretty_print( | ||||
|                     value, key=key, intend=intend + 1, whitespace=whitespace | ||||
|                 ) | ||||
|             else: | ||||
|                 result += pretty_print( | ||||
|                     value, key=key, intend=intend, whitespace=whitespace | ||||
|                 ) | ||||
|     else: | ||||
|         result += f"{whitespace * intend}{'- ' if is_list else ''}{key}{': ' if key else ''}{data}\n" | ||||
|     return result | ||||
|  | ||||
|  | ||||
| def create_command(commands, concat=False): | ||||
|     result = {} | ||||
|     for name, command in commands.items(): | ||||
|         if not concat: | ||||
|             result[name] = {} | ||||
|         for parameter, data in command.parameters.items(): | ||||
|             if data.typology == "enum": | ||||
|                 value = data.values | ||||
|             elif data.typology == "range": | ||||
|                 value = {"min": data.min, "max": data.max, "step": data.step} | ||||
|             else: | ||||
|                 continue | ||||
|             if not concat: | ||||
|                 result[name][parameter] = value | ||||
|             else: | ||||
|                 result[f"{name}.{parameter}"] = value | ||||
|     return result | ||||
							
								
								
									
										62
									
								
								pyhon/hon.py
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										62
									
								
								pyhon/hon.py
									
									
									
									
									
										Normal file
									
								
							| @ -0,0 +1,62 @@ | ||||
| import asyncio | ||||
| from typing import List, Optional, Dict | ||||
| from typing_extensions import Self | ||||
|  | ||||
| from aiohttp import ClientSession | ||||
|  | ||||
| from pyhon import HonAPI, exceptions | ||||
| from pyhon.appliance import HonAppliance | ||||
|  | ||||
|  | ||||
| class Hon: | ||||
|     def __init__(self, email: str, password: str, session: ClientSession | None = None): | ||||
|         self._email: str = email | ||||
|         self._password: str = password | ||||
|         self._session: ClientSession | None = session | ||||
|         self._appliances: List[HonAppliance] = [] | ||||
|         self._api: Optional[HonAPI] = None | ||||
|  | ||||
|     async def __aenter__(self): | ||||
|         return await self.create() | ||||
|  | ||||
|     async def __aexit__(self, exc_type, exc_val, exc_tb): | ||||
|         await self.close() | ||||
|  | ||||
|     @property | ||||
|     def api(self) -> HonAPI: | ||||
|         if self._api is None: | ||||
|             raise exceptions.NoAuthenticationException | ||||
|         return self._api | ||||
|  | ||||
|     async def create(self) -> Self: | ||||
|         self._api = await HonAPI( | ||||
|             self._email, self._password, session=self._session | ||||
|         ).create() | ||||
|         await self.setup() | ||||
|         return self | ||||
|  | ||||
|     @property | ||||
|     def appliances(self) -> List[HonAppliance]: | ||||
|         return self._appliances | ||||
|  | ||||
|     async def _create_appliance(self, appliance: Dict, zone=0) -> None: | ||||
|         appliance = HonAppliance(self._api, appliance, zone=zone) | ||||
|         if appliance.mac_address is None: | ||||
|             return | ||||
|         await asyncio.gather( | ||||
|             *[ | ||||
|                 appliance.load_attributes(), | ||||
|                 appliance.load_commands(), | ||||
|                 appliance.load_statistics(), | ||||
|             ] | ||||
|         ) | ||||
|         self._appliances.append(appliance) | ||||
|  | ||||
|     async def setup(self): | ||||
|         for appliance in (await self._api.load_appliances())["payload"]["appliances"]: | ||||
|             for zone in range(int(appliance.get("zone", "0"))): | ||||
|                 await self._create_appliance(appliance, zone=zone + 1) | ||||
|             await self._create_appliance(appliance) | ||||
|  | ||||
|     async def close(self): | ||||
|         await self._api.close() | ||||
| @ -1,3 +1,13 @@ | ||||
| import re | ||||
|  | ||||
|  | ||||
| def str_to_float(string): | ||||
|     try: | ||||
|         return int(string) | ||||
|     except ValueError: | ||||
|         return float(str(string).replace(",", ".")) | ||||
|  | ||||
|  | ||||
| class HonParameter: | ||||
|     def __init__(self, key, attributes): | ||||
|         self._key = key | ||||
| @ -30,7 +40,7 @@ class HonParameter: | ||||
| class HonParameterFixed(HonParameter): | ||||
|     def __init__(self, key, attributes): | ||||
|         super().__init__(key, attributes) | ||||
|         self._value = attributes["fixedValue"] | ||||
|         self._value = attributes.get("fixedValue", None) | ||||
|  | ||||
|     def __repr__(self): | ||||
|         return f"{self.__class__} (<{self.key}> fixed)" | ||||
| @ -48,10 +58,10 @@ class HonParameterFixed(HonParameter): | ||||
| class HonParameterRange(HonParameter): | ||||
|     def __init__(self, key, attributes): | ||||
|         super().__init__(key, attributes) | ||||
|         self._min = int(attributes["minimumValue"]) | ||||
|         self._max = int(attributes["maximumValue"]) | ||||
|         self._step = int(attributes["incrementValue"]) | ||||
|         self._default = int(attributes.get("defaultValue", self._min)) | ||||
|         self._min = str_to_float(attributes["minimumValue"]) | ||||
|         self._max = str_to_float(attributes["maximumValue"]) | ||||
|         self._step = str_to_float(attributes["incrementValue"]) | ||||
|         self._default = str_to_float(attributes.get("defaultValue", self._min)) | ||||
|         self._value = self._default | ||||
|  | ||||
|     def __repr__(self): | ||||
| @ -75,10 +85,13 @@ class HonParameterRange(HonParameter): | ||||
|  | ||||
|     @value.setter | ||||
|     def value(self, value): | ||||
|         value = str_to_float(value) | ||||
|         if self._min <= value <= self._max and not value % self._step: | ||||
|             self._value = value | ||||
|         else: | ||||
|             raise ValueError(f"Allowed: min {self._min} max {self._max} step {self._step}") | ||||
|             raise ValueError( | ||||
|                 f"Allowed: min {self._min} max {self._max} step {self._step}" | ||||
|             ) | ||||
|  | ||||
|  | ||||
| class HonParameterEnum(HonParameter): | ||||
| @ -111,8 +124,10 @@ class HonParameterProgram(HonParameterEnum): | ||||
|     def __init__(self, key, command): | ||||
|         super().__init__(key, {}) | ||||
|         self._command = command | ||||
|         self._value = command._category | ||||
|         self._value = command._program | ||||
|         self._values = command._multi | ||||
|         self._typology = "enum" | ||||
|         self._filter = "" | ||||
|  | ||||
|     @property | ||||
|     def value(self): | ||||
| @ -124,3 +139,19 @@ class HonParameterProgram(HonParameterEnum): | ||||
|             self._command.set_program(value) | ||||
|         else: | ||||
|             raise ValueError(f"Allowed values {self._values}") | ||||
|  | ||||
|     @property | ||||
|     def filter(self): | ||||
|         return self._filter | ||||
|  | ||||
|     @filter.setter | ||||
|     def filter(self, filter): | ||||
|         self._filter = filter | ||||
|  | ||||
|     @property | ||||
|     def values(self): | ||||
|         values = [] | ||||
|         for value in self._values: | ||||
|             if not self._filter or re.findall(self._filter, str(value)): | ||||
|                 values.append(str(value)) | ||||
|         return sorted(values) | ||||
|  | ||||
							
								
								
									
										12
									
								
								setup.py
									
									
									
									
									
								
							
							
						
						
									
										12
									
								
								setup.py
									
									
									
									
									
								
							| @ -7,11 +7,11 @@ with open("README.md", "r") as f: | ||||
|  | ||||
| setup( | ||||
|     name="pyhOn", | ||||
|     version="0.2.4", | ||||
|     version="0.8.0b2", | ||||
|     author="Andre Basche", | ||||
|     description="Control hOn devices with python", | ||||
|     long_description=long_description, | ||||
|     long_description_content_type='text/markdown', | ||||
|     long_description_content_type="text/markdown", | ||||
|     project_urls={ | ||||
|         "GitHub": "https://github.com/Andre0512/pyhOn", | ||||
|         "PyPI": "https://pypi.org/project/pyhOn", | ||||
| @ -23,7 +23,7 @@ setup( | ||||
|     python_requires=">=3.10", | ||||
|     install_requires=["aiohttp"], | ||||
|     classifiers=[ | ||||
|         "Development Status :: 3 - Alpha", | ||||
|         "Development Status :: 4 - Beta", | ||||
|         "Environment :: Console", | ||||
|         "License :: OSI Approved :: MIT License", | ||||
|         "Natural Language :: English", | ||||
| @ -33,8 +33,8 @@ setup( | ||||
|         "Topic :: Software Development :: Libraries :: Python Modules", | ||||
|     ], | ||||
|     entry_points={ | ||||
|         'console_scripts': [ | ||||
|             'pyhOn = pyhon.__main__:start', | ||||
|         "console_scripts": [ | ||||
|             "pyhOn = pyhon.__main__:start", | ||||
|         ] | ||||
|     } | ||||
|     }, | ||||
| ) | ||||
|  | ||||
		Reference in New Issue
	
	Block a user
	