Compare commits
190 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
327d4a1814 | ||
|
4dc60c29ee | ||
|
7bc9e718a0 | ||
|
d4e5793186 | ||
|
e9f2bb9f4f | ||
|
ea81e2891f | ||
|
c71f8f17f5 | ||
|
27d974abba | ||
|
ab18e45f97 | ||
|
e44b9b6773 | ||
|
5c650d722b | ||
|
6ae40481e3 | ||
|
ff8ae160bb | ||
|
658e80a8f4 | ||
|
ffba85bf0d | ||
|
10c8d961c4 | ||
|
61dd470588 | ||
|
1ed81c2a77 | ||
|
e4dc3cb1d0 | ||
|
2523069ce9 | ||
|
eeb458cb1b | ||
|
2764700bc7 | ||
|
e6c796e822 | ||
|
454f2d8916 | ||
|
59ca8b6caf | ||
|
44c55c681d | ||
|
cfee10df5f | ||
|
e0774677eb | ||
|
fc60d15e60 | ||
|
8ef8c0405d | ||
|
5575b240e1 | ||
|
22367242a2 | ||
|
4f7d4860db | ||
|
5a778373b6 | ||
|
e1c8bc5835 | ||
|
442e7a07dd | ||
|
b0e3b15ff0 | ||
|
2788a3ac91 | ||
|
bc7e8994c9 | ||
|
8ca40d7ad0 | ||
|
9a6a07fd46 | ||
|
f1818bbc5d | ||
|
3d5c8405ea | ||
|
e234ef3bbb | ||
|
e00e147ecd | ||
|
26bc35c8a6 | ||
|
17d73cdeb8 | ||
|
a10ab4423e | ||
|
0553e6c17d | ||
|
44f40c531e | ||
|
4e88bc7a9f | ||
|
b5d8a90d79 | ||
|
52837f16e3 | ||
|
2a6b040193 | ||
|
9eb99f283b | ||
|
ad0d065b03 | ||
|
924e2c240d | ||
|
76bd189e7b | ||
|
ef67188b93 | ||
|
66cb7bcc24 | ||
|
c25e898b42 | ||
|
55966dd52f | ||
|
8c65a37f29 | ||
|
1ca89995a2 | ||
|
f6139db0b5 | ||
|
310d1bafd7 | ||
|
9e35dcf9cf | ||
|
f9d0fa4ae8 | ||
|
11988c73a6 | ||
|
7b51caecca | ||
|
38d09e2ef5 | ||
|
3c7ad3f395 | ||
|
31c03faca8 | ||
|
a081ef1f97 | ||
|
4888f2b1d0 | ||
|
7c6ac15901 | ||
|
eea79e28b9 | ||
|
ecbf438889 | ||
|
9cd12e3234 | ||
|
c2765fe953 | ||
|
9971fe95e2 | ||
|
9f130e2e85 | ||
|
dfbc24452b | ||
|
af4fbdd8cd | ||
|
b5af81b744 | ||
|
22a98e1781 | ||
|
2feb3295e1 | ||
|
d350d639cc | ||
|
81c202d730 | ||
|
022da71800 | ||
|
8e16b4a215 | ||
|
7bd3aac7c5 | ||
|
365a37b42d | ||
|
2bde6bb61c | ||
|
ccff32e6c1 | ||
|
22cbd7474a | ||
|
dd61b24eed | ||
|
ea8f481b01 | ||
|
7dcb34559b | ||
|
5db13a90e7 | ||
|
9ee5dbc956 | ||
|
d4c6ccdce3 | ||
|
9594b9ebd8 | ||
|
b011d98e07 | ||
|
ad864286fc | ||
|
13cff8caa0 | ||
|
5fc6245806 | ||
|
1dad0e14b8 | ||
|
b04c601ad6 | ||
|
3ec0f5a006 | ||
|
78bc85132f | ||
|
191928287f | ||
|
c0aab8b99d | ||
|
b37715d0ca | ||
|
411effd814 | ||
|
04f19c4609 | ||
|
a68dcac379 | ||
|
69be63df2a | ||
|
6c44aa895d | ||
|
8372c75e30 | ||
|
40cc0013a5 | ||
|
f2aa3dc8fd | ||
|
e887371bec | ||
|
5b91747ec1 | ||
|
8da2018302 | ||
|
03187745bf | ||
|
461a247ad3 | ||
|
834f25a639 | ||
|
46ff9be4a2 | ||
|
a1618bb18a | ||
|
a957d7ac0f | ||
|
f54b7b2dbf | ||
|
b6ca12ebff | ||
|
4a0ee8569b | ||
|
d52d622785 | ||
|
9643f66549 | ||
|
d26e33a055 | ||
|
0301427497 | ||
|
272556586e | ||
|
e82c14ec99 | ||
|
970b94bfa7 | ||
|
33454f68b8 | ||
|
6b2c60d552 | ||
|
46e6a85e84 | ||
|
8c832b44cd | ||
|
b4b782c52c | ||
|
e857fe91de | ||
|
79c9678492 | ||
|
7c49589944 | ||
|
f421cf1ce6 | ||
|
ba208ffd98 | ||
|
3e3fc7ad66 | ||
|
e8531f3faf | ||
|
2597cbd883 | ||
|
8dc6cd71cd | ||
|
36fad84ee2 | ||
|
eb6741145a | ||
|
8fa01343bc | ||
|
18b0ecdd68 | ||
|
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 |
40
.github/workflows/python-check.yml
vendored
Normal file
40
.github/workflows/python-check.yml
vendored
Normal file
@ -0,0 +1,40 @@
|
||||
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", "3.12"]
|
||||
|
||||
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 -r requirements_dev.txt
|
||||
- name: Lint with flake8
|
||||
run: |
|
||||
flake8 . --count --statistics
|
||||
- name: Type check with mypy
|
||||
run: |
|
||||
mypy pyhon/
|
||||
- name: Analysing the code with pylint
|
||||
run: |
|
||||
pylint $(git ls-files '*.py')
|
||||
- name: Check black style
|
||||
run: |
|
||||
black . --check
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -4,3 +4,4 @@ __pycache__/
|
||||
dist/
|
||||
**/*.egg-info/
|
||||
test*
|
||||
build/
|
||||
|
9
.pylintrc
Normal file
9
.pylintrc
Normal file
@ -0,0 +1,9 @@
|
||||
[MESSAGES CONTROL]
|
||||
|
||||
disable=missing-docstring
|
||||
|
||||
[FORMAT]
|
||||
|
||||
max-args=6
|
||||
max-attributes=8
|
||||
max-line-length=88
|
1
MANIFEST.in
Normal file
1
MANIFEST.in
Normal file
@ -0,0 +1 @@
|
||||
include pyhon/py.typed
|
86
README.md
86
README.md
@ -1,3 +1,14 @@
|
||||
# Announcement: I have to take the project down in the next few days
|
||||
> Dear User,
|
||||
>
|
||||
> We are writing to inform you that we have discovered two Home Assistant integration plug-ins developed by you ( https://github.com/Andre0512/hon and https://github.com/Andre0512/pyhOn ) that are in violation of our terms of service. Specifically, the plug-ins are using our services in an unauthorized manner which is causing significant economic harm to our Company.
|
||||
> We take the protection of our intellectual property very seriously and demand that you immediately cease and desist all illegal activities related to the development and distribution of these plug-ins. We also request that you remove the plug-ins from all stores and code hosting platforms where they are currently available.
|
||||
> Please be advised that we will take all necessary legal action to protect our interests if you fail to comply with this notice. We reserve the right to pursue all available remedies, including but not limited to monetary damages, injunctive relief, and attorney's fees.
|
||||
> We strongly urge you to take immediate action to rectify this situation and avoid any further legal action. If you have any questions or concerns, please do not hesitate to contact us.
|
||||
>
|
||||
> Haier Europe Security and Governance Department
|
||||
|
||||
|
||||
**This python package is unofficial and is not related in any way to Haier. It was developed by reversed engineered requests and can stop working at anytime!**
|
||||
|
||||
# pyhOn
|
||||
@ -6,7 +17,7 @@
|
||||
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyhOn)](https://www.python.org/)
|
||||
[![PyPI - License](https://img.shields.io/pypi/l/pyhOn)](https://github.com/Andre0512/pyhOn/blob/main/LICENSE)
|
||||
[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyhOn)](https://pypistats.org/packages/pyhon)
|
||||
Control your Haier appliances with python!
|
||||
Control your Haier, Candy and Hoover appliances with python!
|
||||
The idea behind this library is, to make the use of all available commands as simple as possible.
|
||||
|
||||
## Installation
|
||||
@ -19,47 +30,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 +94,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).
|
||||
@ -85,3 +118,6 @@ This library is used for the custom [HomeAssistant Integration "Haier hOn"](http
|
||||
## Contribution
|
||||
Any kind of contribution is welcome!
|
||||
|
||||
| Please add your appliances data to our [hon-test-data collection](https://github.com/Andre0512/hon-test-data). <br/>This helps us to develop new features and not to break compatibility in newer versions. |
|
||||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
|
||||
|
24
mypy.ini
Normal file
24
mypy.ini
Normal file
@ -0,0 +1,24 @@
|
||||
[mypy]
|
||||
check_untyped_defs = true
|
||||
disallow_any_generics = true
|
||||
disallow_any_unimported = true
|
||||
disallow_incomplete_defs = true
|
||||
disallow_subclassing_any = true
|
||||
disallow_untyped_calls = true
|
||||
disallow_untyped_decorators = true
|
||||
disallow_untyped_defs = true
|
||||
disable_error_code = annotation-unchecked
|
||||
enable_error_code = ignore-without-code, redundant-self, truthy-iterable
|
||||
follow_imports = silent
|
||||
local_partial_types = true
|
||||
no_implicit_optional = true
|
||||
no_implicit_reexport = true
|
||||
show_error_codes = true
|
||||
strict_concatenate = false
|
||||
strict_equality = true
|
||||
warn_incomplete_stub = true
|
||||
warn_redundant_casts = true
|
||||
warn_return_any = true
|
||||
warn_unreachable = true
|
||||
warn_unused_configs = true
|
||||
warn_unused_ignores = true
|
@ -1 +1,4 @@
|
||||
from .api import HonConnection
|
||||
from .connection.api import HonAPI
|
||||
from .hon import Hon
|
||||
|
||||
__all__ = ["Hon", "HonAPI"]
|
||||
|
@ -1,83 +1,116 @@
|
||||
#!/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
|
||||
from typing import Tuple, Dict, Any
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.path.insert(0, str(Path(__file__).parent.parent))
|
||||
|
||||
from pyhon import HonConnection
|
||||
# pylint: disable=wrong-import-position
|
||||
from pyhon import Hon, HonAPI, diagnose, printer
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
def get_arguments():
|
||||
def get_arguments() -> Dict[str, Any]:
|
||||
"""Get parsed 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")
|
||||
export = subparser.add_parser("export")
|
||||
export.add_argument("export", help="export pyhon data", action="store_true")
|
||||
export.add_argument("--zip", help="create zip archive", action="store_true")
|
||||
export.add_argument("--anonymous", help="anonymize data", action="store_true")
|
||||
export.add_argument("directory", nargs="?", default=Path().cwd())
|
||||
translation = subparser.add_parser(
|
||||
"translate", help="print available translation keys"
|
||||
)
|
||||
translation.add_argument(
|
||||
"translate", help="language (de, en, fr...)", metavar="LANGUAGE"
|
||||
)
|
||||
translation.add_argument("--json", help="print as json", action="store_true")
|
||||
parser.add_argument(
|
||||
"-i", "--import", help="import pyhon data", nargs="?", default=Path().cwd()
|
||||
)
|
||||
return vars(parser.parse_args())
|
||||
|
||||
|
||||
# yaml.dump() would be done the same, but needs an additional dependency...
|
||||
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)
|
||||
async def translate(language: str, json_output: bool = False) -> None:
|
||||
async with HonAPI(anonymous=True) as hon:
|
||||
keys = await hon.translation_keys(language)
|
||||
if json_output:
|
||||
print(json.dumps(keys, indent=4))
|
||||
else:
|
||||
pretty_print(value, key=key, intend=intend)
|
||||
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(printer.pretty_print(keys))
|
||||
|
||||
|
||||
def create_command(commands):
|
||||
result = {}
|
||||
for name, command in commands.items():
|
||||
result[name] = {}
|
||||
for parameter, data in command.parameters.items():
|
||||
if data.typology == "enum":
|
||||
result[name][parameter] = data.values
|
||||
if data.typology == "range":
|
||||
result[name][parameter] = {"min": data.min, "max": data.max, "step": data.step}
|
||||
return result
|
||||
|
||||
|
||||
async def main():
|
||||
args = get_arguments()
|
||||
def get_login_data(args: Dict[str, str]) -> Tuple[str, str]:
|
||||
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})
|
||||
return user, password
|
||||
|
||||
|
||||
def start():
|
||||
async def main() -> None:
|
||||
args = get_arguments()
|
||||
if language := args.get("translate"):
|
||||
await translate(language, json_output=args.get("json", ""))
|
||||
return
|
||||
async with Hon(
|
||||
*get_login_data(args), test_data_path=Path(args.get("import", ""))
|
||||
) as hon:
|
||||
for device in hon.appliances:
|
||||
if args.get("export"):
|
||||
anonymous = args.get("anonymous", False)
|
||||
path = Path(args.get("directory", "."))
|
||||
if not args.get("zip"):
|
||||
for file in await diagnose.appliance_data(device, path, anonymous):
|
||||
print(f"Created {file}")
|
||||
else:
|
||||
archive = await diagnose.zip_archive(device, path, anonymous)
|
||||
print(f"Created {archive}")
|
||||
continue
|
||||
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(
|
||||
printer.key_print(getattr(data["attributes"], attr)("parameters"))
|
||||
)
|
||||
print(printer.key_print(getattr(data, attr)("appliance")))
|
||||
print(printer.key_print(data))
|
||||
print(
|
||||
printer.pretty_print(
|
||||
printer.create_commands(device.commands, concat=True)
|
||||
)
|
||||
)
|
||||
else:
|
||||
print(diagnose.yaml_export(device))
|
||||
|
||||
|
||||
def start() -> None:
|
||||
try:
|
||||
asyncio.run(main())
|
||||
except KeyboardInterrupt:
|
||||
print("Aborted.")
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
if __name__ == "__main__":
|
||||
start()
|
||||
|
142
pyhon/api.py
142
pyhon/api.py
@ -1,142 +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, loop=False):
|
||||
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:
|
||||
if response.status >= 400 and not loop:
|
||||
_LOGGER.error("%s - Error %s - %s", url, response.status, await response.text)
|
||||
await self.setup()
|
||||
return await self.load_attributes(device, loop=True)
|
||||
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
|
316
pyhon/appliance.py
Normal file
316
pyhon/appliance.py
Normal file
@ -0,0 +1,316 @@
|
||||
import importlib
|
||||
import logging
|
||||
import re
|
||||
from datetime import datetime, timedelta
|
||||
from pathlib import Path
|
||||
from typing import Optional, Dict, Any, TYPE_CHECKING, List, TypeVar, overload
|
||||
|
||||
from pyhon import diagnose, exceptions
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
from pyhon.attributes import HonAttribute
|
||||
from pyhon.command_loader import HonCommandLoader
|
||||
from pyhon.commands import HonCommand
|
||||
from pyhon.parameter.base import HonParameter
|
||||
from pyhon.parameter.enum import HonParameterEnum
|
||||
from pyhon.parameter.range import HonParameterRange
|
||||
from pyhon.typedefs import Parameter
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon import HonAPI
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
|
||||
# pylint: disable=too-many-public-methods,too-many-instance-attributes
|
||||
class HonAppliance:
|
||||
_MINIMAL_UPDATE_INTERVAL = 5 # seconds
|
||||
|
||||
def __init__(
|
||||
self, api: Optional["HonAPI"], info: Dict[str, Any], zone: int = 0
|
||||
) -> None:
|
||||
if attributes := info.get("attributes"):
|
||||
info["attributes"] = {v["parName"]: v["parValue"] for v in attributes}
|
||||
self._info: Dict[str, Any] = info
|
||||
self._api: Optional[HonAPI] = api
|
||||
self._appliance_model: Dict[str, Any] = {}
|
||||
|
||||
self._commands: Dict[str, HonCommand] = {}
|
||||
self._statistics: Dict[str, Any] = {}
|
||||
self._attributes: Dict[str, Any] = {}
|
||||
self._zone: int = zone
|
||||
self._additional_data: Dict[str, Any] = {}
|
||||
self._last_update: Optional[datetime] = None
|
||||
self._default_setting = HonParameter("", {}, "")
|
||||
|
||||
try:
|
||||
self._extra: Optional[ApplianceBase] = importlib.import_module(
|
||||
f"pyhon.appliances.{self.appliance_type.lower()}"
|
||||
).Appliance(self)
|
||||
except ModuleNotFoundError:
|
||||
self._extra = None
|
||||
|
||||
def _get_nested_item(self, item: str) -> Any:
|
||||
result: List[Any] | Dict[str, Any] = self.data
|
||||
for key in item.split("."):
|
||||
if all(k in "0123456789" for k in key) and isinstance(result, list):
|
||||
result = result[int(key)]
|
||||
elif isinstance(result, dict):
|
||||
result = result[key]
|
||||
return result
|
||||
|
||||
def __getitem__(self, item: str) -> Any:
|
||||
if self._zone:
|
||||
item += f"Z{self._zone}"
|
||||
if "." in item:
|
||||
return self._get_nested_item(item)
|
||||
if item in self.data:
|
||||
return self.data[item]
|
||||
if item in self.attributes["parameters"]:
|
||||
return self.attributes["parameters"][item].value
|
||||
return self.info[item]
|
||||
|
||||
@overload
|
||||
def get(self, item: str, default: None = None) -> Any:
|
||||
...
|
||||
|
||||
@overload
|
||||
def get(self, item: str, default: T) -> T:
|
||||
...
|
||||
|
||||
def get(self, item: str, default: Optional[T] = None) -> Any:
|
||||
try:
|
||||
return self[item]
|
||||
except (KeyError, IndexError):
|
||||
return default
|
||||
|
||||
def _check_name_zone(self, name: str, frontend: bool = True) -> str:
|
||||
zone = " Z" if frontend else "_z"
|
||||
attribute: str = self._info.get(name, "")
|
||||
if attribute and self._zone:
|
||||
return f"{attribute}{zone}{self._zone}"
|
||||
return attribute
|
||||
|
||||
@property
|
||||
def appliance_model_id(self) -> str:
|
||||
return str(self._info.get("applianceModelId", ""))
|
||||
|
||||
@property
|
||||
def appliance_type(self) -> str:
|
||||
return str(self._info.get("applianceTypeName", ""))
|
||||
|
||||
@property
|
||||
def mac_address(self) -> str:
|
||||
return str(self.info.get("macAddress", ""))
|
||||
|
||||
@property
|
||||
def unique_id(self) -> str:
|
||||
default_mac = "xx-xx-xx-xx-xx-xx"
|
||||
import_name = f"{self.appliance_type.lower()}_{self.appliance_model_id}"
|
||||
result = self._check_name_zone("macAddress", frontend=False)
|
||||
result = result.replace(default_mac, import_name)
|
||||
return result
|
||||
|
||||
@property
|
||||
def model_name(self) -> str:
|
||||
return self._check_name_zone("modelName")
|
||||
|
||||
@property
|
||||
def brand(self) -> str:
|
||||
brand = self._check_name_zone("brand")
|
||||
return brand[0].upper() + brand[1:]
|
||||
|
||||
@property
|
||||
def nick_name(self) -> str:
|
||||
result = self._check_name_zone("nickName")
|
||||
if not result or re.findall("^[xX1\\s-]+$", result):
|
||||
return self.model_name
|
||||
return result
|
||||
|
||||
@property
|
||||
def code(self) -> str:
|
||||
code: str = self.info.get("code", "")
|
||||
if code:
|
||||
return code
|
||||
serial_number: str = self.info.get("serialNumber", "")
|
||||
return serial_number[:8] if len(serial_number) < 18 else serial_number[:11]
|
||||
|
||||
@property
|
||||
def model_id(self) -> int:
|
||||
return int(self._info.get("applianceModelId", 0))
|
||||
|
||||
@property
|
||||
def options(self) -> Dict[str, Any]:
|
||||
return dict(self._appliance_model.get("options", {}))
|
||||
|
||||
@property
|
||||
def commands(self) -> Dict[str, HonCommand]:
|
||||
return self._commands
|
||||
|
||||
@property
|
||||
def attributes(self) -> Dict[str, Any]:
|
||||
return self._attributes
|
||||
|
||||
@property
|
||||
def statistics(self) -> Dict[str, Any]:
|
||||
return self._statistics
|
||||
|
||||
@property
|
||||
def info(self) -> Dict[str, Any]:
|
||||
return self._info
|
||||
|
||||
@property
|
||||
def additional_data(self) -> Dict[str, Any]:
|
||||
return self._additional_data
|
||||
|
||||
@property
|
||||
def zone(self) -> int:
|
||||
return self._zone
|
||||
|
||||
@property
|
||||
def api(self) -> "HonAPI":
|
||||
"""api connection object"""
|
||||
if self._api is None:
|
||||
raise exceptions.NoAuthenticationException("Missing hOn login")
|
||||
return self._api
|
||||
|
||||
async def load_commands(self) -> None:
|
||||
command_loader = HonCommandLoader(self.api, self)
|
||||
await command_loader.load_commands()
|
||||
self._commands = command_loader.commands
|
||||
self._additional_data = command_loader.additional_data
|
||||
self._appliance_model = command_loader.appliance_data
|
||||
self.sync_params_to_command("settings")
|
||||
|
||||
async def load_attributes(self) -> None:
|
||||
attributes = await self.api.load_attributes(self)
|
||||
for name, values in attributes.pop("shadow", {}).get("parameters", {}).items():
|
||||
if name in self._attributes.get("parameters", {}):
|
||||
self._attributes["parameters"][name].update(values)
|
||||
else:
|
||||
self._attributes.setdefault("parameters", {})[name] = HonAttribute(
|
||||
values
|
||||
)
|
||||
self._attributes |= attributes
|
||||
if self._extra:
|
||||
self._attributes = self._extra.attributes(self._attributes)
|
||||
|
||||
async def load_statistics(self) -> None:
|
||||
self._statistics = await self.api.load_statistics(self)
|
||||
self._statistics |= await self.api.load_maintenance(self)
|
||||
|
||||
async def update(self, force: bool = False) -> None:
|
||||
now = datetime.now()
|
||||
min_age = now - timedelta(seconds=self._MINIMAL_UPDATE_INTERVAL)
|
||||
if force or not self._last_update or self._last_update < min_age:
|
||||
self._last_update = now
|
||||
await self.load_attributes()
|
||||
self.sync_params_to_command("settings")
|
||||
|
||||
@property
|
||||
def command_parameters(self) -> Dict[str, Dict[str, str | float]]:
|
||||
return {n: c.parameter_value for n, c in self._commands.items()}
|
||||
|
||||
@property
|
||||
def settings(self) -> Dict[str, Parameter]:
|
||||
result: Dict[str, Parameter] = {}
|
||||
for name, command in self._commands.items():
|
||||
for key in command.setting_keys:
|
||||
setting = command.settings.get(key, self._default_setting)
|
||||
result[f"{name}.{key}"] = setting
|
||||
if self._extra:
|
||||
return self._extra.settings(result)
|
||||
return result
|
||||
|
||||
@property
|
||||
def available_settings(self) -> List[str]:
|
||||
result = []
|
||||
for name, command in self._commands.items():
|
||||
for key in command.setting_keys:
|
||||
result.append(f"{name}.{key}")
|
||||
return result
|
||||
|
||||
@property
|
||||
def data(self) -> Dict[str, Any]:
|
||||
result = {
|
||||
"attributes": self.attributes,
|
||||
"appliance": self.info,
|
||||
"statistics": self.statistics,
|
||||
"additional_data": self._additional_data,
|
||||
**self.command_parameters,
|
||||
**self.attributes,
|
||||
}
|
||||
return result
|
||||
|
||||
@property
|
||||
def diagnose(self) -> str:
|
||||
return diagnose.yaml_export(self, anonymous=True)
|
||||
|
||||
async def data_archive(self, path: Path) -> str:
|
||||
return await diagnose.zip_archive(self, path, anonymous=True)
|
||||
|
||||
def sync_command_to_params(self, command_name: str) -> None:
|
||||
if not (command := self.commands.get(command_name)):
|
||||
return
|
||||
for key in self.attributes.get("parameters", {}):
|
||||
if new := command.parameters.get(key):
|
||||
self.attributes["parameters"][key].update(
|
||||
str(new.intern_value), shield=True
|
||||
)
|
||||
|
||||
def sync_params_to_command(self, command_name: str) -> None:
|
||||
if not (command := self.commands.get(command_name)):
|
||||
return
|
||||
for key in command.setting_keys:
|
||||
if (
|
||||
new := self.attributes.get("parameters", {}).get(key)
|
||||
) is None or new.value == "":
|
||||
continue
|
||||
setting = command.settings[key]
|
||||
try:
|
||||
if not isinstance(setting, HonParameterRange):
|
||||
command.settings[key].value = str(new.value)
|
||||
else:
|
||||
command.settings[key].value = float(new.value)
|
||||
except ValueError as error:
|
||||
_LOGGER.info("Can't set %s - %s", key, error)
|
||||
continue
|
||||
|
||||
def sync_command(
|
||||
self,
|
||||
main: str,
|
||||
target: Optional[List[str] | str] = None,
|
||||
to_sync: Optional[List[str] | bool] = None,
|
||||
) -> None:
|
||||
base: Optional[HonCommand] = self.commands.get(main)
|
||||
if not base:
|
||||
return
|
||||
for command, data in self.commands.items():
|
||||
if command == main or target and command not in target:
|
||||
continue
|
||||
|
||||
for name, target_param in data.parameters.items():
|
||||
if not (base_param := base.parameters.get(name)):
|
||||
continue
|
||||
if to_sync and (
|
||||
(isinstance(to_sync, list) and name not in to_sync)
|
||||
or not base_param.mandatory
|
||||
):
|
||||
continue
|
||||
self.sync_parameter(base_param, target_param)
|
||||
|
||||
def sync_parameter(self, main: Parameter, target: Parameter) -> None:
|
||||
if isinstance(main, HonParameterRange) and isinstance(
|
||||
target, HonParameterRange
|
||||
):
|
||||
target.max = main.max
|
||||
target.min = main.min
|
||||
target.step = main.step
|
||||
elif isinstance(target, HonParameterRange):
|
||||
target.max = int(main.value)
|
||||
target.min = int(main.value)
|
||||
target.step = 1
|
||||
elif isinstance(target, HonParameterEnum):
|
||||
target.values = main.values
|
||||
target.value = main.value
|
0
pyhon/appliances/__init__.py
Normal file
0
pyhon/appliances/__init__.py
Normal file
25
pyhon/appliances/base.py
Normal file
25
pyhon/appliances/base.py
Normal file
@ -0,0 +1,25 @@
|
||||
from typing import Dict, Any, TYPE_CHECKING
|
||||
|
||||
from pyhon.parameter.program import HonParameterProgram
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.appliance import HonAppliance
|
||||
|
||||
|
||||
class ApplianceBase:
|
||||
def __init__(self, appliance: "HonAppliance"):
|
||||
self.parent = appliance
|
||||
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
program_name = "No Program"
|
||||
if program := int(str(data.get("parameters", {}).get("prCode", "0"))):
|
||||
if start_cmd := self.parent.settings.get("startProgram.program"):
|
||||
if isinstance(start_cmd, HonParameterProgram) and (
|
||||
ids := start_cmd.ids
|
||||
):
|
||||
program_name = ids.get(program, program_name)
|
||||
data["programName"] = program_name
|
||||
return data
|
||||
|
||||
def settings(self, settings: Dict[str, Any]) -> Dict[str, Any]:
|
||||
return settings
|
13
pyhon/appliances/dw.py
Normal file
13
pyhon/appliances/dw.py
Normal file
@ -0,0 +1,13 @@
|
||||
# pylint: disable=duplicate-code
|
||||
from typing import Any, Dict
|
||||
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
|
||||
data["parameters"]["machMode"].value = "0"
|
||||
data["active"] = bool(data.get("activity"))
|
||||
return data
|
16
pyhon/appliances/ov.py
Normal file
16
pyhon/appliances/ov.py
Normal file
@ -0,0 +1,16 @@
|
||||
from typing import Any, Dict
|
||||
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
|
||||
data["parameters"]["temp"].value = 0
|
||||
data["parameters"]["onOffStatus"].value = 0
|
||||
data["parameters"]["remoteCtrValid"].value = 0
|
||||
data["parameters"]["remainingTimeMM"].value = 0
|
||||
|
||||
data["active"] = data["parameters"]["onOffStatus"].value == 1
|
||||
return data
|
25
pyhon/appliances/ref.py
Normal file
25
pyhon/appliances/ref.py
Normal file
@ -0,0 +1,25 @@
|
||||
from typing import Dict, Any
|
||||
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
if data["parameters"]["holidayMode"] == "1":
|
||||
data["modeZ1"] = "holiday"
|
||||
elif data["parameters"]["intelligenceMode"] == "1":
|
||||
data["modeZ1"] = "auto_set"
|
||||
elif data["parameters"].get("quickModeZ1") == "1":
|
||||
data["modeZ1"] = "super_cool"
|
||||
else:
|
||||
data["modeZ1"] = "no_mode"
|
||||
|
||||
if data["parameters"].get("quickModeZ2") == "1":
|
||||
data["modeZ2"] = "super_freeze"
|
||||
elif data["parameters"]["intelligenceMode"] == "1":
|
||||
data["modeZ2"] = "auto_set"
|
||||
else:
|
||||
data["modeZ2"] = "no_mode"
|
||||
|
||||
return data
|
21
pyhon/appliances/td.py
Normal file
21
pyhon/appliances/td.py
Normal file
@ -0,0 +1,21 @@
|
||||
# pylint: disable=duplicate-code
|
||||
from typing import Any, Dict
|
||||
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
from pyhon.parameter.fixed import HonParameterFixed
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
|
||||
data["parameters"]["machMode"].value = "0"
|
||||
data["active"] = bool(data.get("activity"))
|
||||
data["pause"] = data["parameters"]["machMode"] == "3"
|
||||
return data
|
||||
|
||||
def settings(self, settings: Dict[str, Any]) -> Dict[str, Any]:
|
||||
dry_level = settings.get("startProgram.dryLevel")
|
||||
if isinstance(dry_level, HonParameterFixed) and dry_level.value == "11":
|
||||
settings.pop("startProgram.dryLevel", None)
|
||||
return settings
|
5
pyhon/appliances/wc.py
Normal file
5
pyhon/appliances/wc.py
Normal file
@ -0,0 +1,5 @@
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
pass
|
17
pyhon/appliances/wd.py
Normal file
17
pyhon/appliances/wd.py
Normal file
@ -0,0 +1,17 @@
|
||||
# pylint: disable=duplicate-code
|
||||
from typing import Dict, Any
|
||||
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
|
||||
data["parameters"]["machMode"].value = "0"
|
||||
data["active"] = bool(data.get("activity"))
|
||||
data["pause"] = data["parameters"]["machMode"] == "3"
|
||||
return data
|
||||
|
||||
def settings(self, settings: Dict[str, Any]) -> Dict[str, Any]:
|
||||
return settings
|
16
pyhon/appliances/wh.py
Normal file
16
pyhon/appliances/wh.py
Normal file
@ -0,0 +1,16 @@
|
||||
from typing import Any, Dict
|
||||
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
from pyhon.parameter.base import HonParameter
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
parameter = data.get("parameters", {}).get("onOffStatus")
|
||||
is_class = isinstance(parameter, HonParameter)
|
||||
data["active"] = parameter.value == 1 if is_class else parameter == 1
|
||||
return data
|
||||
|
||||
def settings(self, settings: Dict[str, Any]) -> Dict[str, Any]:
|
||||
return settings
|
@ -1,8 +1,17 @@
|
||||
class Appliance:
|
||||
def __init__(self, data):
|
||||
self._data = data
|
||||
# pylint: disable=duplicate-code
|
||||
from typing import Any, Dict
|
||||
|
||||
def get(self):
|
||||
if self._data["lastConnEvent.category"] == "DISCONNECTED":
|
||||
self._data["machMode"] = "0"
|
||||
return self._data
|
||||
from pyhon.appliances.base import ApplianceBase
|
||||
|
||||
|
||||
class Appliance(ApplianceBase):
|
||||
def attributes(self, data: Dict[str, Any]) -> Dict[str, Any]:
|
||||
data = super().attributes(data)
|
||||
if data.get("lastConnEvent", {}).get("category", "") == "DISCONNECTED":
|
||||
data["parameters"]["machMode"].value = "0"
|
||||
data["active"] = bool(data.get("activity"))
|
||||
data["pause"] = data["parameters"]["machMode"] == "3"
|
||||
return data
|
||||
|
||||
def settings(self, settings: Dict[str, Any]) -> Dict[str, Any]:
|
||||
return settings
|
||||
|
58
pyhon/attributes.py
Normal file
58
pyhon/attributes.py
Normal file
@ -0,0 +1,58 @@
|
||||
from datetime import datetime, timedelta
|
||||
from typing import Optional, Final, Dict
|
||||
|
||||
from pyhon.helper import str_to_float
|
||||
|
||||
|
||||
class HonAttribute:
|
||||
_LOCK_TIMEOUT: Final = 10
|
||||
|
||||
def __init__(self, data: Dict[str, str] | str):
|
||||
self._value: str = ""
|
||||
self._last_update: Optional[datetime] = None
|
||||
self._lock_timestamp: Optional[datetime] = None
|
||||
self.update(data)
|
||||
|
||||
@property
|
||||
def value(self) -> float | str:
|
||||
"""Attribute value"""
|
||||
try:
|
||||
return str_to_float(self._value)
|
||||
except ValueError:
|
||||
return self._value
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str) -> None:
|
||||
self._value = value
|
||||
|
||||
@property
|
||||
def last_update(self) -> Optional[datetime]:
|
||||
"""Timestamp of last api update"""
|
||||
return self._last_update
|
||||
|
||||
@property
|
||||
def lock(self) -> bool:
|
||||
"""Shows if value changes are forbidden"""
|
||||
if not self._lock_timestamp:
|
||||
return False
|
||||
lock_until = self._lock_timestamp + timedelta(seconds=self._LOCK_TIMEOUT)
|
||||
return lock_until >= datetime.utcnow()
|
||||
|
||||
def update(self, data: Dict[str, str] | str, shield: bool = False) -> bool:
|
||||
if self.lock and not shield:
|
||||
return False
|
||||
if shield:
|
||||
self._lock_timestamp = datetime.utcnow()
|
||||
if isinstance(data, str):
|
||||
self.value = data
|
||||
return True
|
||||
self.value = data.get("parNewVal", "")
|
||||
if last_update := data.get("lastUpdate"):
|
||||
try:
|
||||
self._last_update = datetime.fromisoformat(last_update)
|
||||
except ValueError:
|
||||
self._last_update = None
|
||||
return True
|
||||
|
||||
def __str__(self) -> str:
|
||||
return self._value
|
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
|
227
pyhon/command_loader.py
Normal file
227
pyhon/command_loader.py
Normal file
@ -0,0 +1,227 @@
|
||||
import asyncio
|
||||
from contextlib import suppress
|
||||
from copy import copy
|
||||
from typing import Dict, Any, Optional, TYPE_CHECKING, List
|
||||
|
||||
from pyhon.commands import HonCommand
|
||||
from pyhon.exceptions import NoAuthenticationException
|
||||
from pyhon.parameter.fixed import HonParameterFixed
|
||||
from pyhon.parameter.program import HonParameterProgram
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon import HonAPI
|
||||
from pyhon.appliance import HonAppliance
|
||||
|
||||
|
||||
class HonCommandLoader:
|
||||
"""Loads and parses hOn command data"""
|
||||
|
||||
def __init__(self, api: "HonAPI", appliance: "HonAppliance") -> None:
|
||||
self._api: "HonAPI" = api
|
||||
self._appliance: "HonAppliance" = appliance
|
||||
self._api_commands: Dict[str, Any] = {}
|
||||
self._favourites: List[Dict[str, Any]] = []
|
||||
self._command_history: List[Dict[str, Any]] = []
|
||||
self._commands: Dict[str, HonCommand] = {}
|
||||
self._appliance_data: Dict[str, Any] = {}
|
||||
self._additional_data: Dict[str, Any] = {}
|
||||
|
||||
@property
|
||||
def api(self) -> "HonAPI":
|
||||
"""api connection object"""
|
||||
if self._api is None:
|
||||
raise NoAuthenticationException("Missing hOn login")
|
||||
return self._api
|
||||
|
||||
@property
|
||||
def appliance(self) -> "HonAppliance":
|
||||
"""appliance object"""
|
||||
return self._appliance
|
||||
|
||||
@property
|
||||
def commands(self) -> Dict[str, HonCommand]:
|
||||
"""Get list of hon commands"""
|
||||
return self._commands
|
||||
|
||||
@property
|
||||
def appliance_data(self) -> Dict[str, Any]:
|
||||
"""Get command appliance data"""
|
||||
return self._appliance_data
|
||||
|
||||
@property
|
||||
def additional_data(self) -> Dict[str, Any]:
|
||||
"""Get command additional data"""
|
||||
return self._additional_data
|
||||
|
||||
async def load_commands(self) -> None:
|
||||
"""Trigger loading of command data"""
|
||||
await self._load_data()
|
||||
self._appliance_data = self._api_commands.pop("applianceModel", {})
|
||||
self._get_commands()
|
||||
self._add_favourites()
|
||||
self._recover_last_command_states()
|
||||
|
||||
async def _load_commands(self) -> None:
|
||||
self._api_commands = await self._api.load_commands(self._appliance)
|
||||
|
||||
async def _load_favourites(self) -> None:
|
||||
self._favourites = await self._api.load_favourites(self._appliance)
|
||||
|
||||
async def _load_command_history(self) -> None:
|
||||
self._command_history = await self._api.load_command_history(self._appliance)
|
||||
|
||||
async def _load_data(self) -> None:
|
||||
"""Callback parallel all relevant data"""
|
||||
await asyncio.gather(
|
||||
*[
|
||||
self._load_commands(),
|
||||
self._load_favourites(),
|
||||
self._load_command_history(),
|
||||
]
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _is_command(data: Dict[str, Any]) -> bool:
|
||||
"""Check if dict can be parsed as command"""
|
||||
return (
|
||||
data.get("description") is not None and data.get("protocolType") is not None
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _clean_name(category: str) -> str:
|
||||
"""Clean up category name"""
|
||||
if "PROGRAM" in category:
|
||||
return category.split(".")[-1].lower()
|
||||
return category
|
||||
|
||||
def _get_commands(self) -> None:
|
||||
"""Generates HonCommand dict from api data"""
|
||||
commands = []
|
||||
for name, data in self._api_commands.items():
|
||||
if command := self._parse_command(data, name):
|
||||
commands.append(command)
|
||||
self._commands = {c.name: c for c in commands}
|
||||
|
||||
def _parse_command(
|
||||
self,
|
||||
data: Dict[str, Any] | str,
|
||||
command_name: str,
|
||||
categories: Optional[Dict[str, "HonCommand"]] = None,
|
||||
category_name: str = "",
|
||||
) -> Optional[HonCommand]:
|
||||
"""Try to crate HonCommand object"""
|
||||
if not isinstance(data, dict):
|
||||
self._additional_data[command_name] = data
|
||||
return None
|
||||
if self._is_command(data):
|
||||
return HonCommand(
|
||||
command_name,
|
||||
data,
|
||||
self._appliance,
|
||||
category_name=category_name,
|
||||
categories=categories,
|
||||
)
|
||||
if category := self._parse_categories(data, command_name):
|
||||
return category
|
||||
return None
|
||||
|
||||
def _parse_categories(
|
||||
self, data: Dict[str, Any], command_name: str
|
||||
) -> Optional[HonCommand]:
|
||||
"""Parse categories and create reference to other"""
|
||||
categories: Dict[str, HonCommand] = {}
|
||||
for category, value in data.items():
|
||||
if command := self._parse_command(
|
||||
value, command_name, category_name=category, categories=categories
|
||||
):
|
||||
categories[self._clean_name(category)] = command
|
||||
if categories:
|
||||
# setParameters should be at first place
|
||||
if "setParameters" in categories:
|
||||
return categories["setParameters"]
|
||||
return list(categories.values())[0]
|
||||
return None
|
||||
|
||||
def _get_last_command_index(self, name: str) -> Optional[int]:
|
||||
"""Get index of last command execution"""
|
||||
return next(
|
||||
(
|
||||
index
|
||||
for (index, d) in enumerate(self._command_history)
|
||||
if d.get("command", {}).get("commandName") == name
|
||||
),
|
||||
None,
|
||||
)
|
||||
|
||||
def _set_last_category(
|
||||
self, command: HonCommand, name: str, parameters: Dict[str, Any]
|
||||
) -> HonCommand:
|
||||
"""Set category to last state"""
|
||||
if command.categories:
|
||||
if program := parameters.pop("program", None):
|
||||
command.category = self._clean_name(program)
|
||||
elif category := parameters.pop("category", None):
|
||||
command.category = category
|
||||
else:
|
||||
return command
|
||||
return self.commands[name]
|
||||
return command
|
||||
|
||||
def _recover_last_command_states(self) -> None:
|
||||
"""Set commands to last state"""
|
||||
for name, command in self.commands.items():
|
||||
if (last_index := self._get_last_command_index(name)) is None:
|
||||
continue
|
||||
last_command = self._command_history[last_index]
|
||||
parameters = last_command.get("command", {}).get("parameters", {})
|
||||
command = self._set_last_category(command, name, parameters)
|
||||
for key, data in command.settings.items():
|
||||
if parameters.get(key) is None:
|
||||
continue
|
||||
with suppress(ValueError):
|
||||
data.value = parameters.get(key)
|
||||
|
||||
def _add_favourites(self) -> None:
|
||||
"""Patch program categories with favourites"""
|
||||
for favourite in self._favourites:
|
||||
name, command_name, base = self._get_favourite_info(favourite)
|
||||
if not base:
|
||||
continue
|
||||
base_command: HonCommand = copy(base)
|
||||
self._update_base_command_with_data(base_command, favourite)
|
||||
self._update_base_command_with_favourite(base_command)
|
||||
self._update_program_categories(command_name, name, base_command)
|
||||
|
||||
def _get_favourite_info(
|
||||
self, favourite: Dict[str, Any]
|
||||
) -> tuple[str, str, HonCommand | None]:
|
||||
name: str = favourite.get("favouriteName", {})
|
||||
command = favourite.get("command", {})
|
||||
command_name: str = command.get("commandName", "")
|
||||
program_name = self._clean_name(command.get("programName", ""))
|
||||
base_command = self.commands[command_name].categories.get(program_name)
|
||||
return name, command_name, base_command
|
||||
|
||||
def _update_base_command_with_data(
|
||||
self, base_command: HonCommand, command: Dict[str, Any]
|
||||
) -> None:
|
||||
for data in command.values():
|
||||
if isinstance(data, str):
|
||||
continue
|
||||
for key, value in data.items():
|
||||
if not (parameter := base_command.parameters.get(key)):
|
||||
continue
|
||||
with suppress(ValueError):
|
||||
parameter.value = value
|
||||
|
||||
def _update_base_command_with_favourite(self, base_command: HonCommand) -> None:
|
||||
extra_param = HonParameterFixed("favourite", {"fixedValue": "1"}, "custom")
|
||||
base_command.parameters.update(favourite=extra_param)
|
||||
|
||||
def _update_program_categories(
|
||||
self, command_name: str, name: str, base_command: HonCommand
|
||||
) -> None:
|
||||
program = base_command.parameters["program"]
|
||||
if isinstance(program, HonParameterProgram):
|
||||
program.set_value(name)
|
||||
self.commands[command_name].categories[name] = base_command
|
@ -1,71 +1,208 @@
|
||||
from pyhon.parameter import HonParameterFixed, HonParameterEnum, HonParameterRange, HonParameterProgram
|
||||
import logging
|
||||
from typing import Optional, Dict, Any, List, TYPE_CHECKING, Union
|
||||
|
||||
from pyhon import exceptions
|
||||
from pyhon.exceptions import ApiError, NoAuthenticationException
|
||||
from pyhon.parameter.base import HonParameter
|
||||
from pyhon.parameter.enum import HonParameterEnum
|
||||
from pyhon.parameter.fixed import HonParameterFixed
|
||||
from pyhon.parameter.program import HonParameterProgram
|
||||
from pyhon.parameter.range import HonParameterRange
|
||||
from pyhon.rules import HonRuleSet
|
||||
from pyhon.typedefs import Parameter
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon import HonAPI
|
||||
from pyhon.appliance import HonAppliance
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class HonCommand:
|
||||
def __init__(self, name, attributes, connector, device, multi=None, category=""):
|
||||
self._connector = connector
|
||||
self._device = device
|
||||
self._name = name
|
||||
self._multi = multi or {}
|
||||
self._category = category
|
||||
self._description = attributes.get("description", "")
|
||||
self._parameters = self._create_parameters(attributes.get("parameters", {}))
|
||||
self._ancillary_parameters = self._create_parameters(attributes.get("ancillaryParameters", {}))
|
||||
def __init__(
|
||||
self,
|
||||
name: str,
|
||||
attributes: Dict[str, Any],
|
||||
appliance: "HonAppliance",
|
||||
categories: Optional[Dict[str, "HonCommand"]] = None,
|
||||
category_name: str = "",
|
||||
):
|
||||
self._name: str = name
|
||||
self._api: Optional[HonAPI] = None
|
||||
self._appliance: "HonAppliance" = appliance
|
||||
self._categories: Optional[Dict[str, "HonCommand"]] = categories
|
||||
self._category_name: str = category_name
|
||||
self._parameters: Dict[str, Parameter] = {}
|
||||
self._data: Dict[str, Any] = {}
|
||||
self._rules: List[HonRuleSet] = []
|
||||
attributes.pop("description", "")
|
||||
attributes.pop("protocolType", "")
|
||||
self._load_parameters(attributes)
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return f"{self._name} command"
|
||||
|
||||
def _create_parameters(self, parameters):
|
||||
result = {}
|
||||
for parameter, attributes in parameters.items():
|
||||
match attributes.get("typology"):
|
||||
case "range":
|
||||
result[parameter] = HonParameterRange(parameter, attributes)
|
||||
case "enum":
|
||||
result[parameter] = HonParameterEnum(parameter, attributes)
|
||||
case "fixed":
|
||||
result[parameter] = HonParameterFixed(parameter, attributes)
|
||||
if self._multi:
|
||||
result["program"] = HonParameterProgram("program", self)
|
||||
return result
|
||||
@property
|
||||
def name(self) -> str:
|
||||
return self._name
|
||||
|
||||
@property
|
||||
def parameters(self):
|
||||
def api(self) -> "HonAPI":
|
||||
if self._api is None and self._appliance:
|
||||
self._api = self._appliance.api
|
||||
if self._api is None:
|
||||
raise exceptions.NoAuthenticationException("Missing hOn login")
|
||||
return self._api
|
||||
|
||||
@property
|
||||
def appliance(self) -> "HonAppliance":
|
||||
return self._appliance
|
||||
|
||||
@property
|
||||
def data(self) -> Dict[str, Any]:
|
||||
return self._data
|
||||
|
||||
@property
|
||||
def parameters(self) -> Dict[str, HonParameter]:
|
||||
return self._parameters
|
||||
|
||||
@property
|
||||
def ancillary_parameters(self):
|
||||
return {key: parameter.value for key, parameter in self._ancillary_parameters.items()}
|
||||
def settings(self) -> Dict[str, HonParameter]:
|
||||
return self._parameters
|
||||
|
||||
async def send(self):
|
||||
parameters = {name: parameter.value for name, parameter in self._parameters}
|
||||
return await self._connector.send_command(self._device, self._name, parameters, self.ancillary_parameters)
|
||||
@property
|
||||
def parameter_groups(self) -> Dict[str, Dict[str, Union[str, float]]]:
|
||||
result: Dict[str, Dict[str, Union[str, float]]] = {}
|
||||
for name, parameter in self._parameters.items():
|
||||
result.setdefault(parameter.group, {})[name] = parameter.intern_value
|
||||
return result
|
||||
|
||||
def get_programs(self):
|
||||
return self._multi
|
||||
@property
|
||||
def mandatory_parameter_groups(self) -> Dict[str, Dict[str, Union[str, float]]]:
|
||||
result: Dict[str, Dict[str, Union[str, float]]] = {}
|
||||
for name, parameter in self._parameters.items():
|
||||
if parameter.mandatory:
|
||||
result.setdefault(parameter.group, {})[name] = parameter.intern_value
|
||||
return result
|
||||
|
||||
def set_program(self, program):
|
||||
self._device.commands[self._name] = self._multi[program]
|
||||
@property
|
||||
def parameter_value(self) -> Dict[str, Union[str, float]]:
|
||||
return {n: p.value for n, p in self._parameters.items()}
|
||||
|
||||
def _get_settings_keys(self, command=None):
|
||||
command = command or self
|
||||
keys = []
|
||||
for key, parameter in command._parameters.items():
|
||||
if isinstance(parameter, HonParameterFixed):
|
||||
def _load_parameters(self, attributes: Dict[str, Dict[str, Any] | Any]) -> None:
|
||||
for key, items in attributes.items():
|
||||
if not isinstance(items, dict):
|
||||
_LOGGER.info("Loading Attributes - Skipping %s", str(items))
|
||||
continue
|
||||
if key not in keys:
|
||||
keys.append(key)
|
||||
return keys
|
||||
for name, data in items.items():
|
||||
self._create_parameters(data, name, key)
|
||||
for rule in self._rules:
|
||||
rule.patch()
|
||||
|
||||
def _create_parameters(
|
||||
self, data: Dict[str, Any], name: str, parameter: str
|
||||
) -> None:
|
||||
if name == "zoneMap" and self._appliance.zone:
|
||||
data["default"] = self._appliance.zone
|
||||
if data.get("category") == "rule":
|
||||
if "fixedValue" in data:
|
||||
self._rules.append(HonRuleSet(self, data["fixedValue"]))
|
||||
elif "enumValues" in data:
|
||||
self._rules.append(HonRuleSet(self, data["enumValues"]))
|
||||
else:
|
||||
_LOGGER.warning("Rule not supported: %s", data)
|
||||
match data.get("typology"):
|
||||
case "range":
|
||||
self._parameters[name] = HonParameterRange(name, data, parameter)
|
||||
case "enum":
|
||||
self._parameters[name] = HonParameterEnum(name, data, parameter)
|
||||
case "fixed":
|
||||
self._parameters[name] = HonParameterFixed(name, data, parameter)
|
||||
case _:
|
||||
self._data[name] = data
|
||||
return
|
||||
if self._category_name:
|
||||
name = "program" if "PROGRAM" in self._category_name else "category"
|
||||
self._parameters[name] = HonParameterProgram(name, self, "custom")
|
||||
|
||||
async def send(self, only_mandatory: bool = False) -> bool:
|
||||
grouped_params = (
|
||||
self.mandatory_parameter_groups if only_mandatory else self.parameter_groups
|
||||
)
|
||||
params = grouped_params.get("parameters", {})
|
||||
return await self.send_parameters(params)
|
||||
|
||||
async def send_specific(self, param_names: List[str]) -> bool:
|
||||
params: Dict[str, str | float] = {}
|
||||
for key, parameter in self._parameters.items():
|
||||
if key in param_names or parameter.mandatory:
|
||||
params[key] = parameter.value
|
||||
return await self.send_parameters(params)
|
||||
|
||||
async def send_parameters(self, params: Dict[str, str | float]) -> bool:
|
||||
ancillary_params = self.parameter_groups.get("ancillaryParameters", {})
|
||||
ancillary_params.pop("programRules", None)
|
||||
if "prStr" in params:
|
||||
params["prStr"] = self._category_name.upper()
|
||||
self.appliance.sync_command_to_params(self.name)
|
||||
try:
|
||||
result = await self.api.send_command(
|
||||
self._appliance,
|
||||
self._name,
|
||||
params,
|
||||
ancillary_params,
|
||||
self._category_name,
|
||||
)
|
||||
if not result:
|
||||
_LOGGER.error(result)
|
||||
raise ApiError("Can't send command")
|
||||
except NoAuthenticationException:
|
||||
_LOGGER.error("No Authentication")
|
||||
return False
|
||||
return result
|
||||
|
||||
@property
|
||||
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)]
|
||||
return list(set(result + ["program"]))
|
||||
def categories(self) -> Dict[str, "HonCommand"]:
|
||||
if self._categories is None:
|
||||
return {"_": self}
|
||||
return self._categories
|
||||
|
||||
@property
|
||||
def settings(self):
|
||||
"""Parameters with typology enum and range"""
|
||||
return {s: self._parameters[s] for s in self.setting_keys}
|
||||
def category(self) -> str:
|
||||
return self._category_name
|
||||
|
||||
@category.setter
|
||||
def category(self, category: str) -> None:
|
||||
if category in self.categories:
|
||||
self._appliance.commands[self._name] = self.categories[category]
|
||||
|
||||
@property
|
||||
def setting_keys(self) -> List[str]:
|
||||
return list(
|
||||
{param for cmd in self.categories.values() for param in cmd.parameters}
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _more_options(first: Parameter, second: Parameter) -> Parameter:
|
||||
if isinstance(first, HonParameterFixed) and not isinstance(
|
||||
second, HonParameterFixed
|
||||
):
|
||||
return second
|
||||
if len(second.values) > len(first.values):
|
||||
return second
|
||||
return first
|
||||
|
||||
@property
|
||||
def available_settings(self) -> Dict[str, Parameter]:
|
||||
result: Dict[str, Parameter] = {}
|
||||
for command in self.categories.values():
|
||||
for name, parameter in command.parameters.items():
|
||||
if name in result:
|
||||
result[name] = self._more_options(result[name], parameter)
|
||||
else:
|
||||
result[name] = parameter
|
||||
return result
|
||||
|
||||
def reset(self) -> None:
|
||||
for parameter in self._parameters.values():
|
||||
parameter.reset()
|
||||
|
0
pyhon/connection/__init__.py
Normal file
0
pyhon/connection/__init__.py
Normal file
333
pyhon/connection/api.py
Normal file
333
pyhon/connection/api.py
Normal file
@ -0,0 +1,333 @@
|
||||
import json
|
||||
import logging
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from pprint import pformat
|
||||
from types import TracebackType
|
||||
from typing import Dict, Optional, Any, List, no_type_check, Type
|
||||
|
||||
from aiohttp import ClientSession
|
||||
from typing_extensions import Self
|
||||
|
||||
from pyhon import const, exceptions
|
||||
from pyhon.appliance import HonAppliance
|
||||
from pyhon.connection.auth import HonAuth
|
||||
from pyhon.connection.handler.anonym import HonAnonymousConnectionHandler
|
||||
from pyhon.connection.handler.hon import HonConnectionHandler
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
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: Optional[Type[BaseException]],
|
||||
exc: Optional[BaseException],
|
||||
traceback: Optional[TracebackType],
|
||||
) -> 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) -> HonConnectionHandler:
|
||||
if self._hon_handler is None:
|
||||
raise exceptions.NoAuthenticationException
|
||||
return self._hon_handler
|
||||
|
||||
@property
|
||||
def _hon_anonymous(self) -> HonAnonymousConnectionHandler:
|
||||
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) -> List[Dict[str, Any]]:
|
||||
async with self._hon.get(f"{const.API_URL}/commands/v1/appliance") as resp:
|
||||
result = await resp.json()
|
||||
if result:
|
||||
appliances: List[Dict[str, Any]] = result.get("payload", {}).get(
|
||||
"appliances", {}
|
||||
)
|
||||
return appliances
|
||||
return []
|
||||
|
||||
async def load_commands(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
params: Dict[str, str | int] = {
|
||||
"applianceType": appliance.appliance_type,
|
||||
"applianceModelId": appliance.appliance_model_id,
|
||||
"macAddress": appliance.mac_address,
|
||||
"os": const.OS,
|
||||
"appVersion": const.APP_VERSION,
|
||||
"code": appliance.code,
|
||||
}
|
||||
if firmware_id := appliance.info.get("eepromId"):
|
||||
params["firmwareId"] = firmware_id
|
||||
if firmware_version := appliance.info.get("fwVersion"):
|
||||
params["fwVersion"] = firmware_version
|
||||
if series := appliance.info.get("series"):
|
||||
params["series"] = series
|
||||
url: str = f"{const.API_URL}/commands/v1/retrieve"
|
||||
async with self._hon.get(url, params=params) as response:
|
||||
result: Dict[str, Any] = (await response.json()).get("payload", {})
|
||||
if not result or result.pop("resultCode") != "0":
|
||||
_LOGGER.error(await response.json())
|
||||
return {}
|
||||
return result
|
||||
|
||||
async def load_command_history(
|
||||
self, appliance: HonAppliance
|
||||
) -> List[Dict[str, Any]]:
|
||||
url: str = (
|
||||
f"{const.API_URL}/commands/v1/appliance/{appliance.mac_address}/history"
|
||||
)
|
||||
async with self._hon.get(url) as response:
|
||||
result: Dict[str, Any] = await response.json()
|
||||
if not result or not result.get("payload"):
|
||||
return []
|
||||
command_history: List[Dict[str, Any]] = result["payload"]["history"]
|
||||
return command_history
|
||||
|
||||
async def load_favourites(self, appliance: HonAppliance) -> List[Dict[str, Any]]:
|
||||
url: str = (
|
||||
f"{const.API_URL}/commands/v1/appliance/{appliance.mac_address}/favourite"
|
||||
)
|
||||
async with self._hon.get(url) as response:
|
||||
result: Dict[str, Any] = await response.json()
|
||||
if not result or not result.get("payload"):
|
||||
return []
|
||||
favourites: List[Dict[str, Any]] = result["payload"]["favourites"]
|
||||
return favourites
|
||||
|
||||
async def load_last_activity(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
url: str = f"{const.API_URL}/commands/v1/retrieve-last-activity"
|
||||
params: Dict[str, str] = {"macAddress": appliance.mac_address}
|
||||
async with self._hon.get(url, params=params) as response:
|
||||
result: Dict[str, Any] = await response.json()
|
||||
if result:
|
||||
activity: Dict[str, Any] = result.get("attributes", "")
|
||||
if activity:
|
||||
return activity
|
||||
return {}
|
||||
|
||||
async def load_appliance_data(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
url: str = f"{const.API_URL}/commands/v1/appliance-model"
|
||||
params: Dict[str, str] = {
|
||||
"code": appliance.code,
|
||||
"macAddress": appliance.mac_address,
|
||||
}
|
||||
async with self._hon.get(url, params=params) as response:
|
||||
result: Dict[str, Any] = await response.json()
|
||||
if result:
|
||||
appliance_data: Dict[str, Any] = result.get("payload", {}).get(
|
||||
"applianceModel", {}
|
||||
)
|
||||
return appliance_data
|
||||
return {}
|
||||
|
||||
async def load_attributes(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
params: Dict[str, str] = {
|
||||
"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:
|
||||
attributes: Dict[str, Any] = (await response.json()).get("payload", {})
|
||||
return attributes
|
||||
|
||||
async def load_statistics(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
params: Dict[str, str] = {
|
||||
"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:
|
||||
statistics: Dict[str, Any] = (await response.json()).get("payload", {})
|
||||
return statistics
|
||||
|
||||
async def load_maintenance(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
url = f"{const.API_URL}/commands/v1/maintenance-cycle"
|
||||
params = {"macAddress": appliance.mac_address}
|
||||
async with self._hon.get(url, params=params) as response:
|
||||
maintenance: Dict[str, Any] = (await response.json()).get("payload", {})
|
||||
return maintenance
|
||||
|
||||
async def send_command(
|
||||
self,
|
||||
appliance: HonAppliance,
|
||||
command: str,
|
||||
parameters: Dict[str, Any],
|
||||
ancillary_parameters: Dict[str, Any],
|
||||
program_name: str = "",
|
||||
) -> bool:
|
||||
now: str = datetime.utcnow().isoformat()
|
||||
data: Dict[str, Any] = {
|
||||
"macAddress": appliance.mac_address,
|
||||
"timestamp": f"{now[:-3]}Z",
|
||||
"commandName": command,
|
||||
"transactionId": f"{appliance.mac_address}_{now[:-3]}Z",
|
||||
"applianceOptions": appliance.options,
|
||||
"device": self._hon.device.get(mobile=True),
|
||||
"attributes": {
|
||||
"channel": "mobileApp",
|
||||
"origin": "standardProgram",
|
||||
"energyLabel": "0",
|
||||
},
|
||||
"ancillaryParameters": ancillary_parameters,
|
||||
"parameters": parameters,
|
||||
"applianceType": appliance.appliance_type,
|
||||
}
|
||||
if command == "startProgram" and program_name:
|
||||
data.update({"programName": program_name.upper()})
|
||||
url: str = f"{const.API_URL}/commands/v1/send"
|
||||
async with self._hon.post(url, json=data) as response:
|
||||
json_data: Dict[str, Any] = await response.json()
|
||||
if json_data.get("payload", {}).get("resultCode") == "0":
|
||||
return True
|
||||
_LOGGER.error(await response.text())
|
||||
_LOGGER.error("%s - Payload:\n%s", url, pformat(data))
|
||||
return False
|
||||
|
||||
async def appliance_configuration(self) -> Dict[str, Any]:
|
||||
url: str = f"{const.API_URL}/config/v1/program-list-rules"
|
||||
async with self._hon_anonymous.get(url) as response:
|
||||
result: Dict[str, Any] = await response.json()
|
||||
data: Dict[str, Any] = result.get("payload", {})
|
||||
return data
|
||||
|
||||
async def app_config(
|
||||
self, language: str = "en", beta: bool = True
|
||||
) -> Dict[str, Any]:
|
||||
url: str = f"{const.API_URL}/app-config"
|
||||
payload_data: Dict[str, str | int] = {
|
||||
"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:
|
||||
result = await response.json()
|
||||
data: Dict[str, Any] = result.get("payload", {})
|
||||
return data
|
||||
|
||||
async def translation_keys(self, language: str = "en") -> Dict[str, Any]:
|
||||
config = await self.app_config(language=language)
|
||||
if not (url := config.get("language", {}).get("jsonPath")):
|
||||
return {}
|
||||
async with self._hon_anonymous.get(url) as response:
|
||||
result: Dict[str, Any] = await response.json()
|
||||
return result
|
||||
|
||||
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()
|
||||
|
||||
|
||||
class TestAPI(HonAPI):
|
||||
def __init__(self, path: Path):
|
||||
super().__init__()
|
||||
self._anonymous = True
|
||||
self._path: Path = path
|
||||
|
||||
def _load_json(self, appliance: HonAppliance, file: str) -> Dict[str, Any]:
|
||||
directory = f"{appliance.appliance_type}_{appliance.appliance_model_id}".lower()
|
||||
if not (path := self._path / directory / f"{file}.json").exists():
|
||||
_LOGGER.warning("Can't open %s", str(path))
|
||||
return {}
|
||||
with open(path, "r", encoding="utf-8") as json_file:
|
||||
text = json_file.read()
|
||||
try:
|
||||
data: Dict[str, Any] = json.loads(text)
|
||||
return data
|
||||
except json.decoder.JSONDecodeError as error:
|
||||
_LOGGER.error("%s - %s", str(path), error)
|
||||
return {}
|
||||
|
||||
async def load_appliances(self) -> List[Dict[str, Any]]:
|
||||
result = []
|
||||
for appliance in self._path.glob("*/"):
|
||||
file = appliance / "appliance_data.json"
|
||||
with open(file, "r", encoding="utf-8") as json_file:
|
||||
try:
|
||||
result.append(json.loads(json_file.read()))
|
||||
except json.decoder.JSONDecodeError as error:
|
||||
_LOGGER.error("%s - %s", str(file), error)
|
||||
return result
|
||||
|
||||
async def load_commands(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
return self._load_json(appliance, "commands")
|
||||
|
||||
@no_type_check
|
||||
async def load_command_history(
|
||||
self, appliance: HonAppliance
|
||||
) -> List[Dict[str, Any]]:
|
||||
return self._load_json(appliance, "command_history")
|
||||
|
||||
async def load_favourites(self, appliance: HonAppliance) -> List[Dict[str, Any]]:
|
||||
return []
|
||||
|
||||
async def load_last_activity(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
return {}
|
||||
|
||||
async def load_appliance_data(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
return self._load_json(appliance, "appliance_data")
|
||||
|
||||
async def load_attributes(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
return self._load_json(appliance, "attributes")
|
||||
|
||||
async def load_statistics(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
return self._load_json(appliance, "statistics")
|
||||
|
||||
async def load_maintenance(self, appliance: HonAppliance) -> Dict[str, Any]:
|
||||
return self._load_json(appliance, "maintenance")
|
||||
|
||||
async def send_command(
|
||||
self,
|
||||
appliance: HonAppliance,
|
||||
command: str,
|
||||
parameters: Dict[str, Any],
|
||||
ancillary_parameters: Dict[str, Any],
|
||||
program_name: str = "",
|
||||
) -> bool:
|
||||
_LOGGER.info(
|
||||
"%s - %s - %s",
|
||||
str(parameters),
|
||||
str(ancillary_parameters),
|
||||
str(program_name),
|
||||
)
|
||||
return True
|
291
pyhon/connection/auth.py
Normal file
291
pyhon/connection/auth.py
Normal file
@ -0,0 +1,291 @@
|
||||
import json
|
||||
import logging
|
||||
import re
|
||||
import secrets
|
||||
import urllib
|
||||
from contextlib import suppress
|
||||
from dataclasses import dataclass
|
||||
from datetime import datetime, timedelta
|
||||
from typing import Dict, Optional, Any, List
|
||||
from urllib import parse
|
||||
from urllib.parse import quote
|
||||
|
||||
import aiohttp
|
||||
from aiohttp import ClientResponse
|
||||
from yarl import URL
|
||||
|
||||
from pyhon import const, exceptions
|
||||
from pyhon.connection.device import HonDevice
|
||||
from pyhon.connection.handler.auth import HonAuthConnectionHandler
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class HonLoginData:
|
||||
url: str = ""
|
||||
email: str = ""
|
||||
password: str = ""
|
||||
fw_uid: str = ""
|
||||
loaded: Optional[Dict[str, Any]] = None
|
||||
|
||||
|
||||
@dataclass
|
||||
class HonAuthData:
|
||||
access_token: str = ""
|
||||
refresh_token: str = ""
|
||||
cognito_token: str = ""
|
||||
id_token: str = ""
|
||||
|
||||
|
||||
class HonAuth:
|
||||
_TOKEN_EXPIRES_AFTER_HOURS = 8
|
||||
_TOKEN_EXPIRE_WARNING_HOURS = 7
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
session: aiohttp.ClientSession,
|
||||
email: str,
|
||||
password: str,
|
||||
device: HonDevice,
|
||||
) -> None:
|
||||
self._session = session
|
||||
self._request = HonAuthConnectionHandler(session)
|
||||
self._login_data = HonLoginData()
|
||||
self._login_data.email = email
|
||||
self._login_data.password = password
|
||||
self._device = device
|
||||
self._expires: datetime = datetime.utcnow()
|
||||
self._auth = HonAuthData()
|
||||
|
||||
@property
|
||||
def cognito_token(self) -> str:
|
||||
return self._auth.cognito_token
|
||||
|
||||
@property
|
||||
def id_token(self) -> str:
|
||||
return self._auth.id_token
|
||||
|
||||
@property
|
||||
def access_token(self) -> str:
|
||||
return self._auth.access_token
|
||||
|
||||
@property
|
||||
def refresh_token(self) -> str:
|
||||
return self._auth.refresh_token
|
||||
|
||||
def _check_token_expiration(self, hours: int) -> bool:
|
||||
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: ClientResponse, fail: bool = True) -> None:
|
||||
output = "hOn Authentication Error\n"
|
||||
for i, (status, url) in enumerate(self._request.called_urls):
|
||||
output += f" {i + 1: 2d} {status} - {url}\n"
|
||||
output += f"ERROR - {response.status} - {response.request_info.url}\n"
|
||||
output += f"{15 * '='} Response {15 * '='}\n{await response.text()}\n{40 * '='}"
|
||||
_LOGGER.error(output)
|
||||
if fail:
|
||||
raise exceptions.HonAuthenticationError("Can't login")
|
||||
|
||||
@staticmethod
|
||||
def _generate_nonce() -> str:
|
||||
nonce = secrets.token_hex(16)
|
||||
return f"{nonce[:8]}-{nonce[8:12]}-{nonce[12:16]}-{nonce[16:20]}-{nonce[20:]}"
|
||||
|
||||
async def _load_login(self) -> bool:
|
||||
login_url = await self._introduce()
|
||||
login_url = await self._handle_redirects(login_url)
|
||||
return await self._login_url(login_url)
|
||||
|
||||
async def _introduce(self) -> str:
|
||||
redirect_uri = urllib.parse.quote(f"{const.APP}://mobilesdk/detect/oauth/done")
|
||||
params = {
|
||||
"response_type": "token+id_token",
|
||||
"client_id": const.CLIENT_ID,
|
||||
"redirect_uri": redirect_uri,
|
||||
"display": "touch",
|
||||
"scope": "api openid refresh_token web",
|
||||
"nonce": self._generate_nonce(),
|
||||
}
|
||||
params_encode = "&".join([f"{k}={v}" for k, v in params.items()])
|
||||
url = f"{const.AUTH_API}/services/oauth2/authorize/expid_Login?{params_encode}"
|
||||
async with self._request.get(url) as response:
|
||||
text = await response.text()
|
||||
self._expires = datetime.utcnow()
|
||||
login_url: List[str] = re.findall("url = '(.+?)'", text)
|
||||
if not login_url:
|
||||
if "oauth/done#access_token=" in text:
|
||||
self._parse_token_data(text)
|
||||
raise exceptions.HonNoAuthenticationNeeded()
|
||||
await self._error_logger(response)
|
||||
return login_url[0]
|
||||
|
||||
async def _manual_redirect(self, url: str) -> str:
|
||||
async with self._request.get(url, allow_redirects=False) as response:
|
||||
if not (new_location := response.headers.get("Location", "")):
|
||||
await self._error_logger(response)
|
||||
return new_location
|
||||
|
||||
async def _handle_redirects(self, login_url: str) -> str:
|
||||
redirect1 = await self._manual_redirect(login_url)
|
||||
redirect2 = await self._manual_redirect(redirect1)
|
||||
return f"{redirect2}&System=IoT_Mobile_App&RegistrationSubChannel=hOn"
|
||||
|
||||
async def _login_url(self, login_url: str) -> bool:
|
||||
headers = {"user-agent": const.USER_AGENT}
|
||||
url = URL(login_url, encoded=True)
|
||||
async with self._request.get(url, headers=headers) as response:
|
||||
text = await response.text()
|
||||
if context := re.findall('"fwuid":"(.*?)","loaded":(\\{.*?})', text):
|
||||
fw_uid, loaded_str = context[0]
|
||||
self._login_data.fw_uid = fw_uid
|
||||
self._login_data.loaded = json.loads(loaded_str)
|
||||
self._login_data.url = login_url.replace(const.AUTH_API, "")
|
||||
return True
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
|
||||
async def _login(self) -> str:
|
||||
start_url = self._login_data.url.rsplit("startURL=", maxsplit=1)[-1]
|
||||
start_url = parse.unquote(start_url).split("%3D")[0]
|
||||
action = {
|
||||
"id": "79;a",
|
||||
"descriptor": "apex://LightningLoginCustomController/ACTION$login",
|
||||
"callingDescriptor": "markup://c:loginForm",
|
||||
"params": {
|
||||
"username": self._login_data.email,
|
||||
"password": self._login_data.password,
|
||||
"startUrl": start_url,
|
||||
},
|
||||
}
|
||||
data = {
|
||||
"message": {"actions": [action]},
|
||||
"aura.context": {
|
||||
"mode": "PROD",
|
||||
"fwuid": self._login_data.fw_uid,
|
||||
"app": "siteforce:loginApp2",
|
||||
"loaded": self._login_data.loaded,
|
||||
"dn": [],
|
||||
"globals": {},
|
||||
"uad": False,
|
||||
},
|
||||
"aura.pageURI": self._login_data.url,
|
||||
"aura.token": None,
|
||||
}
|
||||
params = {"r": 3, "other.LightningLoginCustom.login": 1}
|
||||
async with self._request.post(
|
||||
const.AUTH_API + "/s/sfsites/aura",
|
||||
headers={"Content-Type": "application/x-www-form-urlencoded"},
|
||||
data="&".join(f"{k}={quote(json.dumps(v))}" for k, v in data.items()),
|
||||
params=params,
|
||||
) as response:
|
||||
if response.status == 200:
|
||||
with suppress(json.JSONDecodeError, KeyError):
|
||||
result = await response.json()
|
||||
url: str = result["events"][0]["attributes"]["values"]["url"]
|
||||
return url
|
||||
await self._error_logger(response)
|
||||
return ""
|
||||
|
||||
def _parse_token_data(self, text: str) -> bool:
|
||||
if access_token := re.findall("access_token=(.*?)&", text):
|
||||
self._auth.access_token = access_token[0]
|
||||
if refresh_token := re.findall("refresh_token=(.*?)&", text):
|
||||
self._auth.refresh_token = refresh_token[0]
|
||||
if id_token := re.findall("id_token=(.*?)&", text):
|
||||
self._auth.id_token = id_token[0]
|
||||
return bool(access_token and refresh_token and id_token)
|
||||
|
||||
async def _get_token(self, url: str) -> bool:
|
||||
async with self._request.get(url) as response:
|
||||
if response.status != 200:
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
url_search = re.findall(
|
||||
"href\\s*=\\s*[\"'](.+?)[\"']", await response.text()
|
||||
)
|
||||
if not url_search:
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
if "ProgressiveLogin" in url_search[0]:
|
||||
async with self._request.get(url_search[0]) as response:
|
||||
if response.status != 200:
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
url_search = re.findall(
|
||||
"href\\s*=\\s*[\"'](.*?)[\"']", await response.text()
|
||||
)
|
||||
url = const.AUTH_API + url_search[0]
|
||||
async with self._request.get(url) as response:
|
||||
if response.status != 200:
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
if not self._parse_token_data(await response.text()):
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
return True
|
||||
|
||||
async def _api_auth(self) -> bool:
|
||||
post_headers = {"id-token": self._auth.id_token}
|
||||
data = self._device.get()
|
||||
async with self._request.post(
|
||||
f"{const.API_URL}/auth/v1/login", headers=post_headers, json=data
|
||||
) as response:
|
||||
try:
|
||||
json_data = await response.json()
|
||||
except json.JSONDecodeError:
|
||||
await self._error_logger(response)
|
||||
return False
|
||||
self._auth.cognito_token = json_data.get("cognitoUser", {}).get("Token", "")
|
||||
if not self._auth.cognito_token:
|
||||
_LOGGER.error(json_data)
|
||||
raise exceptions.HonAuthenticationError()
|
||||
return True
|
||||
|
||||
async def authenticate(self) -> None:
|
||||
self.clear()
|
||||
try:
|
||||
if not await self._load_login():
|
||||
raise exceptions.HonAuthenticationError("Can't open login page")
|
||||
if not (url := await self._login()):
|
||||
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) -> bool:
|
||||
params = {
|
||||
"client_id": const.CLIENT_ID,
|
||||
"refresh_token": self._auth.refresh_token,
|
||||
"grant_type": "refresh_token",
|
||||
}
|
||||
async with self._request.post(
|
||||
f"{const.AUTH_API}/services/oauth2/token", params=params
|
||||
) as response:
|
||||
if response.status >= 400:
|
||||
await self._error_logger(response, fail=False)
|
||||
return False
|
||||
data = await response.json()
|
||||
self._expires = datetime.utcnow()
|
||||
self._auth.id_token = data["id_token"]
|
||||
self._auth.access_token = data["access_token"]
|
||||
return await self._api_auth()
|
||||
|
||||
def clear(self) -> None:
|
||||
self._session.cookie_jar.clear_domain(const.AUTH_API.split("/")[-2])
|
||||
self._request.called_urls = []
|
||||
self._auth.cognito_token = ""
|
||||
self._auth.id_token = ""
|
||||
self._auth.access_token = ""
|
||||
self._auth.refresh_token = ""
|
45
pyhon/connection/device.py
Normal file
45
pyhon/connection/device.py
Normal file
@ -0,0 +1,45 @@
|
||||
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_type(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[str, str | int]:
|
||||
result: Dict[str, str | int] = {
|
||||
"appVersion": self.app_version,
|
||||
"mobileId": self.mobile_id,
|
||||
"os": self.os_type,
|
||||
"osVersion": self.os_version,
|
||||
"deviceModel": self.device_model,
|
||||
}
|
||||
if mobile:
|
||||
result |= {"mobileOs": result.pop("os", "")}
|
||||
return result
|
0
pyhon/connection/handler/__init__.py
Normal file
0
pyhon/connection/handler/__init__.py
Normal file
27
pyhon/connection/handler/anonym.py
Normal file
27
pyhon/connection/handler/anonym.py
Normal file
@ -0,0 +1,27 @@
|
||||
import logging
|
||||
from collections.abc import AsyncIterator
|
||||
from contextlib import asynccontextmanager
|
||||
from typing import Dict, Any
|
||||
|
||||
import aiohttp
|
||||
from yarl import URL
|
||||
|
||||
from pyhon import const
|
||||
from pyhon.connection.handler.base import ConnectionHandler
|
||||
from pyhon.typedefs import Callback
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class HonAnonymousConnectionHandler(ConnectionHandler):
|
||||
_HEADERS: Dict[str, str] = ConnectionHandler._HEADERS | {"x-api-key": const.API_KEY}
|
||||
|
||||
@asynccontextmanager
|
||||
async def _intercept(
|
||||
self, method: Callback, url: str | URL, *args: Any, **kwargs: Dict[str, Any]
|
||||
) -> AsyncIterator[aiohttp.ClientResponse]:
|
||||
kwargs["headers"] = kwargs.pop("headers", {}) | self._HEADERS
|
||||
async with method(url, *args, **kwargs) as response:
|
||||
if response.status == 403:
|
||||
_LOGGER.error("Can't authenticate anymore")
|
||||
yield response
|
38
pyhon/connection/handler/auth.py
Normal file
38
pyhon/connection/handler/auth.py
Normal file
@ -0,0 +1,38 @@
|
||||
import logging
|
||||
from collections.abc import AsyncIterator
|
||||
from contextlib import asynccontextmanager
|
||||
from typing import Optional, List, Tuple, Any, Dict
|
||||
|
||||
import aiohttp
|
||||
from yarl import URL
|
||||
|
||||
from pyhon import const
|
||||
from pyhon.connection.handler.base import ConnectionHandler
|
||||
from pyhon.typedefs import Callback
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class HonAuthConnectionHandler(ConnectionHandler):
|
||||
_HEADERS = {"user-agent": const.USER_AGENT}
|
||||
|
||||
def __init__(self, session: Optional[aiohttp.ClientSession] = None) -> None:
|
||||
super().__init__(session)
|
||||
self._called_urls: List[Tuple[int, str]] = []
|
||||
|
||||
@property
|
||||
def called_urls(self) -> List[Tuple[int, str]]:
|
||||
return self._called_urls
|
||||
|
||||
@called_urls.setter
|
||||
def called_urls(self, called_urls: List[Tuple[int, str]]) -> None:
|
||||
self._called_urls = called_urls
|
||||
|
||||
@asynccontextmanager
|
||||
async def _intercept(
|
||||
self, method: Callback, url: str | URL, *args: Any, **kwargs: Dict[str, Any]
|
||||
) -> AsyncIterator[aiohttp.ClientResponse]:
|
||||
kwargs["headers"] = kwargs.pop("headers", {}) | self._HEADERS
|
||||
async with method(url, *args, **kwargs) as response:
|
||||
self._called_urls.append((response.status, str(response.request_info.url)))
|
||||
yield response
|
80
pyhon/connection/handler/base.py
Normal file
80
pyhon/connection/handler/base.py
Normal file
@ -0,0 +1,80 @@
|
||||
import logging
|
||||
from collections.abc import AsyncIterator
|
||||
from contextlib import asynccontextmanager
|
||||
from types import TracebackType
|
||||
from typing import Optional, Dict, Type, Any
|
||||
|
||||
import aiohttp
|
||||
from typing_extensions import Self
|
||||
from yarl import URL
|
||||
|
||||
from pyhon import const, exceptions
|
||||
from pyhon.typedefs import Callback
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class ConnectionHandler:
|
||||
_HEADERS: Dict[str, str] = {
|
||||
"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
|
||||
|
||||
async def __aenter__(self) -> Self:
|
||||
return await self.create()
|
||||
|
||||
async def __aexit__(
|
||||
self,
|
||||
exc_type: Optional[Type[BaseException]],
|
||||
exc: Optional[BaseException],
|
||||
traceback: Optional[TracebackType],
|
||||
) -> None:
|
||||
await self.close()
|
||||
|
||||
@property
|
||||
def session(self) -> aiohttp.ClientSession:
|
||||
if self._session is None:
|
||||
raise exceptions.NoSessionException
|
||||
return self._session
|
||||
|
||||
async def create(self) -> Self:
|
||||
if self._create_session:
|
||||
self._session = aiohttp.ClientSession()
|
||||
return self
|
||||
|
||||
@asynccontextmanager
|
||||
async def _intercept(
|
||||
self, method: Callback, url: str | URL, *args: Any, **kwargs: Dict[str, Any]
|
||||
) -> AsyncIterator[aiohttp.ClientResponse]:
|
||||
async with method(url, *args, **kwargs) as response:
|
||||
yield response
|
||||
|
||||
@asynccontextmanager
|
||||
async def get(
|
||||
self, *args: Any, **kwargs: Any
|
||||
) -> AsyncIterator[aiohttp.ClientResponse]:
|
||||
if self._session is None:
|
||||
raise exceptions.NoSessionException()
|
||||
response: aiohttp.ClientResponse
|
||||
args = self._session.get, *args
|
||||
async with self._intercept(*args, **kwargs) as response:
|
||||
yield response
|
||||
|
||||
@asynccontextmanager
|
||||
async def post(
|
||||
self, *args: Any, **kwargs: Any
|
||||
) -> AsyncIterator[aiohttp.ClientResponse]:
|
||||
if self._session is None:
|
||||
raise exceptions.NoSessionException()
|
||||
response: aiohttp.ClientResponse
|
||||
args = self._session.post, *args
|
||||
async with self._intercept(*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()
|
105
pyhon/connection/handler/hon.py
Normal file
105
pyhon/connection/handler/hon.py
Normal file
@ -0,0 +1,105 @@
|
||||
import json
|
||||
import logging
|
||||
from collections.abc import AsyncIterator
|
||||
from contextlib import asynccontextmanager
|
||||
from typing import Optional, Dict, Any
|
||||
|
||||
import aiohttp
|
||||
from typing_extensions import Self
|
||||
from yarl import URL
|
||||
|
||||
from pyhon.connection.auth import HonAuth
|
||||
from pyhon.connection.device import HonDevice
|
||||
from pyhon.connection.handler.base import ConnectionHandler
|
||||
from pyhon.exceptions import HonAuthenticationError, NoAuthenticationException
|
||||
from pyhon.typedefs import Callback
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class HonConnectionHandler(ConnectionHandler):
|
||||
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")
|
||||
self._auth: Optional[HonAuth] = None
|
||||
|
||||
@property
|
||||
def auth(self) -> HonAuth:
|
||||
if self._auth is None:
|
||||
raise NoAuthenticationException()
|
||||
return self._auth
|
||||
|
||||
@property
|
||||
def device(self) -> HonDevice:
|
||||
return self._device
|
||||
|
||||
async def create(self) -> Self:
|
||||
await super().create()
|
||||
self._auth = HonAuth(self.session, self._email, self._password, self._device)
|
||||
return self
|
||||
|
||||
async def _check_headers(self, headers: Dict[str, str]) -> Dict[str, str]:
|
||||
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: Callback, url: str | URL, *args: Any, **kwargs: Any
|
||||
) -> AsyncIterator[aiohttp.ClientResponse]:
|
||||
loop: int = kwargs.pop("loop", 0)
|
||||
kwargs["headers"] = await self._check_headers(kwargs.get("headers", {}))
|
||||
async with method(url, *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, url, *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, url, *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 as exc:
|
||||
_LOGGER.warning(
|
||||
"%s - JsonDecodeError %s - %s",
|
||||
response.request_info.url,
|
||||
response.status,
|
||||
await response.text(),
|
||||
)
|
||||
raise HonAuthenticationError("Decode Error") from exc
|
@ -1,10 +1,13 @@
|
||||
AUTH_API = "https://he-accounts.force.com/SmartHome"
|
||||
AUTH_API = "https://account2.hon-smarthome.com"
|
||||
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"
|
||||
CLIENT_ID = (
|
||||
"3MVG9QDx8IX8nP5T2Ha8ofvlmjLZl5L_gvfbT9."
|
||||
"HJvpHGKoAS_dcMN8LYpTSYeVFCraUnV.2Ag1Ki7m4znVO6"
|
||||
)
|
||||
APP_VERSION = "2.4.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.value
|
||||
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
|
99
pyhon/diagnose.py
Normal file
99
pyhon/diagnose.py
Normal file
@ -0,0 +1,99 @@
|
||||
import asyncio
|
||||
import json
|
||||
import re
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING, List, Tuple
|
||||
|
||||
from pyhon import printer
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.appliance import HonAppliance
|
||||
|
||||
|
||||
def anonymize_data(data: str) -> str:
|
||||
default_date = "1970-01-01T00:00:00.0Z"
|
||||
default_mac = "xx-xx-xx-xx-xx-xx"
|
||||
data = re.sub("[0-9A-Fa-f]{2}(-[0-9A-Fa-f]{2}){5}", default_mac, data)
|
||||
data = re.sub("[\\d-]{10}T[\\d:]{8}(.\\d+)?Z", default_date, data)
|
||||
for sensible in [
|
||||
"serialNumber",
|
||||
"code",
|
||||
"nickName",
|
||||
"mobileId",
|
||||
"PK",
|
||||
"SK",
|
||||
"lat",
|
||||
"lng",
|
||||
]:
|
||||
for match in re.findall(f'"{sensible}.*?":\\s"?(.+?)"?,?\\n', data):
|
||||
replace = re.sub("[a-z]", "x", match)
|
||||
replace = re.sub("[A-Z]", "X", replace)
|
||||
replace = re.sub("\\d", "1", replace)
|
||||
data = data.replace(match, replace)
|
||||
return data
|
||||
|
||||
|
||||
async def load_data(appliance: "HonAppliance", topic: str) -> Tuple[str, str]:
|
||||
return topic, await getattr(appliance.api, f"load_{topic}")(appliance)
|
||||
|
||||
|
||||
def write_to_json(data: str, topic: str, path: Path, anonymous: bool = False) -> Path:
|
||||
json_data = json.dumps(data, indent=4)
|
||||
if anonymous:
|
||||
json_data = anonymize_data(json_data)
|
||||
file = path / f"{topic}.json"
|
||||
with open(file, "w", encoding="utf-8") as json_file:
|
||||
json_file.write(json_data)
|
||||
return file
|
||||
|
||||
|
||||
async def appliance_data(
|
||||
appliance: "HonAppliance", path: Path, anonymous: bool = False
|
||||
) -> List[Path]:
|
||||
requests = [
|
||||
"commands",
|
||||
"attributes",
|
||||
"command_history",
|
||||
"statistics",
|
||||
"maintenance",
|
||||
"appliance_data",
|
||||
]
|
||||
path /= f"{appliance.appliance_type}_{appliance.model_id}".lower()
|
||||
path.mkdir(parents=True, exist_ok=True)
|
||||
api_data = await asyncio.gather(*[load_data(appliance, name) for name in requests])
|
||||
return [write_to_json(data, topic, path, anonymous) for topic, data in api_data]
|
||||
|
||||
|
||||
async def zip_archive(
|
||||
appliance: "HonAppliance", path: Path, anonymous: bool = False
|
||||
) -> str:
|
||||
data = await appliance_data(appliance, path, anonymous)
|
||||
archive = data[0].parent
|
||||
shutil.make_archive(str(archive), "zip", archive)
|
||||
shutil.rmtree(archive)
|
||||
return f"{archive.stem}.zip"
|
||||
|
||||
|
||||
def yaml_export(appliance: "HonAppliance", anonymous: bool = False) -> str:
|
||||
data = {
|
||||
"attributes": appliance.attributes.copy(),
|
||||
"appliance": appliance.info,
|
||||
"statistics": appliance.statistics,
|
||||
"additional_data": appliance.additional_data,
|
||||
}
|
||||
data |= {n: c.parameter_groups for n, c in appliance.commands.items()}
|
||||
extra = {n: c.data for n, c in appliance.commands.items() if c.data}
|
||||
if extra:
|
||||
data |= {"extra_command_data": extra}
|
||||
if anonymous:
|
||||
for sensible in ["serialNumber", "coords"]:
|
||||
data.get("appliance", {}).pop(sensible, None)
|
||||
result = printer.pretty_print({"data": data})
|
||||
if commands := printer.create_commands(appliance.commands):
|
||||
result += printer.pretty_print({"commands": commands})
|
||||
if rules := printer.create_rules(appliance.commands):
|
||||
result += printer.pretty_print({"rules": rules})
|
||||
if anonymous:
|
||||
result = anonymize_data(result)
|
||||
return result
|
18
pyhon/exceptions.py
Normal file
18
pyhon/exceptions.py
Normal file
@ -0,0 +1,18 @@
|
||||
class HonAuthenticationError(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class HonNoAuthenticationNeeded(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class NoSessionException(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class NoAuthenticationException(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class ApiError(Exception):
|
||||
pass
|
5
pyhon/helper.py
Normal file
5
pyhon/helper.py
Normal file
@ -0,0 +1,5 @@
|
||||
def str_to_float(string: str | float) -> float:
|
||||
try:
|
||||
return int(string)
|
||||
except ValueError:
|
||||
return float(str(string).replace(",", "."))
|
113
pyhon/hon.py
Normal file
113
pyhon/hon.py
Normal file
@ -0,0 +1,113 @@
|
||||
import asyncio
|
||||
import logging
|
||||
from pathlib import Path
|
||||
from types import TracebackType
|
||||
from typing import List, Optional, Dict, Any, Type
|
||||
|
||||
from aiohttp import ClientSession
|
||||
from typing_extensions import Self
|
||||
|
||||
from pyhon.appliance import HonAppliance
|
||||
from pyhon.connection.api import HonAPI
|
||||
from pyhon.connection.api import TestAPI
|
||||
from pyhon.exceptions import NoAuthenticationException
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Hon:
|
||||
def __init__(
|
||||
self,
|
||||
email: Optional[str] = "",
|
||||
password: Optional[str] = "",
|
||||
session: Optional[ClientSession] = None,
|
||||
test_data_path: Optional[Path] = None,
|
||||
):
|
||||
self._email: Optional[str] = email
|
||||
self._password: Optional[str] = password
|
||||
self._session: ClientSession | None = session
|
||||
self._appliances: List[HonAppliance] = []
|
||||
self._api: Optional[HonAPI] = None
|
||||
self._test_data_path: Path = test_data_path or Path().cwd()
|
||||
|
||||
async def __aenter__(self) -> Self:
|
||||
return await self.create()
|
||||
|
||||
async def __aexit__(
|
||||
self,
|
||||
exc_type: Optional[Type[BaseException]],
|
||||
exc: Optional[BaseException],
|
||||
traceback: Optional[TracebackType],
|
||||
) -> None:
|
||||
await self.close()
|
||||
|
||||
@property
|
||||
def api(self) -> HonAPI:
|
||||
if self._api is None:
|
||||
raise NoAuthenticationException
|
||||
return self._api
|
||||
|
||||
@property
|
||||
def email(self) -> str:
|
||||
if not self._email:
|
||||
raise ValueError("Missing email")
|
||||
return self._email
|
||||
|
||||
@property
|
||||
def password(self) -> str:
|
||||
if not self._password:
|
||||
raise ValueError("Missing password")
|
||||
return self._password
|
||||
|
||||
async def create(self) -> Self:
|
||||
self._api = await HonAPI(
|
||||
self.email, self.password, session=self._session
|
||||
).create()
|
||||
await self.setup()
|
||||
return self
|
||||
|
||||
@property
|
||||
def appliances(self) -> List[HonAppliance]:
|
||||
return self._appliances
|
||||
|
||||
@appliances.setter
|
||||
def appliances(self, appliances: List[HonAppliance]) -> None:
|
||||
self._appliances = appliances
|
||||
|
||||
async def _create_appliance(
|
||||
self, appliance_data: Dict[str, Any], api: HonAPI, zone: int = 0
|
||||
) -> None:
|
||||
appliance = HonAppliance(api, appliance_data, zone=zone)
|
||||
if appliance.mac_address == "":
|
||||
return
|
||||
try:
|
||||
await asyncio.gather(
|
||||
*[
|
||||
appliance.load_attributes(),
|
||||
appliance.load_commands(),
|
||||
appliance.load_statistics(),
|
||||
]
|
||||
)
|
||||
except (KeyError, ValueError, IndexError) as error:
|
||||
_LOGGER.exception(error)
|
||||
_LOGGER.error("Device data - %s", appliance_data)
|
||||
self._appliances.append(appliance)
|
||||
|
||||
async def setup(self) -> None:
|
||||
appliances = await self.api.load_appliances()
|
||||
for appliance in appliances:
|
||||
if (zones := int(appliance.get("zone", "0"))) > 1:
|
||||
for zone in range(zones):
|
||||
await self._create_appliance(
|
||||
appliance.copy(), self.api, zone=zone + 1
|
||||
)
|
||||
await self._create_appliance(appliance, self.api)
|
||||
if (
|
||||
test_data := self._test_data_path / "hon-test-data" / "test_data"
|
||||
).exists() or (test_data := test_data / "test_data").exists():
|
||||
api = TestAPI(test_data)
|
||||
for appliance in await api.load_appliances():
|
||||
await self._create_appliance(appliance, api)
|
||||
|
||||
async def close(self) -> None:
|
||||
await self.api.close()
|
@ -1,127 +0,0 @@
|
||||
class HonParameter:
|
||||
def __init__(self, key, attributes):
|
||||
self._key = key
|
||||
self._category = attributes.get("category")
|
||||
self._typology = attributes.get("typology")
|
||||
self._mandatory = attributes.get("mandatory")
|
||||
self._value = ""
|
||||
|
||||
@property
|
||||
def key(self):
|
||||
return self._key
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
return self._value if self._value is not None else "0"
|
||||
|
||||
@property
|
||||
def category(self):
|
||||
return self._category
|
||||
|
||||
@property
|
||||
def typology(self):
|
||||
return self._typology
|
||||
|
||||
@property
|
||||
def mandatory(self):
|
||||
return self._mandatory
|
||||
|
||||
|
||||
class HonParameterFixed(HonParameter):
|
||||
def __init__(self, key, attributes):
|
||||
super().__init__(key, attributes)
|
||||
self._value = attributes["fixedValue"]
|
||||
|
||||
def __repr__(self):
|
||||
return f"{self.__class__} (<{self.key}> fixed)"
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
return self._value if self._value is not None else "0"
|
||||
|
||||
@value.setter
|
||||
def value(self, value):
|
||||
if not value == self._value:
|
||||
raise ValueError("Can't change fixed value")
|
||||
|
||||
|
||||
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._value = self._default
|
||||
|
||||
def __repr__(self):
|
||||
return f"{self.__class__} (<{self.key}> [{self._min} - {self._max}])"
|
||||
|
||||
@property
|
||||
def min(self):
|
||||
return self._min
|
||||
|
||||
@property
|
||||
def max(self):
|
||||
return self._max
|
||||
|
||||
@property
|
||||
def step(self):
|
||||
return self._step
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
return self._value if self._value is not None else self._min
|
||||
|
||||
@value.setter
|
||||
def value(self, 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}")
|
||||
|
||||
|
||||
class HonParameterEnum(HonParameter):
|
||||
def __init__(self, key, attributes):
|
||||
super().__init__(key, attributes)
|
||||
self._default = attributes.get("defaultValue")
|
||||
self._value = self._default or "0"
|
||||
self._values = attributes.get("enumValues")
|
||||
|
||||
def __repr__(self):
|
||||
return f"{self.__class__} (<{self.key}> {self.values})"
|
||||
|
||||
@property
|
||||
def values(self):
|
||||
return [str(value) for value in self._values]
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
return self._value if self._value is not None else self.values[0]
|
||||
|
||||
@value.setter
|
||||
def value(self, value):
|
||||
if value in self.values:
|
||||
self._value = value
|
||||
else:
|
||||
raise ValueError(f"Allowed values {self._value}")
|
||||
|
||||
|
||||
class HonParameterProgram(HonParameterEnum):
|
||||
def __init__(self, key, command):
|
||||
super().__init__(key, {})
|
||||
self._command = command
|
||||
self._value = command._category
|
||||
self._values = command._multi
|
||||
self._typology = "enum"
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
return self._value
|
||||
|
||||
@value.setter
|
||||
def value(self, value):
|
||||
if value in self.values:
|
||||
self._command.set_program(value)
|
||||
else:
|
||||
raise ValueError(f"Allowed values {self._values}")
|
0
pyhon/parameter/__init__.py
Normal file
0
pyhon/parameter/__init__.py
Normal file
98
pyhon/parameter/base.py
Normal file
98
pyhon/parameter/base.py
Normal file
@ -0,0 +1,98 @@
|
||||
from typing import Dict, Any, List, Tuple, Callable, TYPE_CHECKING
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.rules import HonRule
|
||||
|
||||
|
||||
class HonParameter:
|
||||
def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
|
||||
self._key = key
|
||||
self._attributes = attributes
|
||||
self._category: str = ""
|
||||
self._typology: str = ""
|
||||
self._mandatory: int = 0
|
||||
self._value: str | float = ""
|
||||
self._group: str = group
|
||||
self._triggers: Dict[
|
||||
str, List[Tuple[Callable[["HonRule"], None], "HonRule"]]
|
||||
] = {}
|
||||
self._set_attributes()
|
||||
|
||||
def _set_attributes(self) -> None:
|
||||
self._category = self._attributes.get("category", "")
|
||||
self._typology = self._attributes.get("typology", "")
|
||||
self._mandatory = self._attributes.get("mandatory", 0)
|
||||
|
||||
@property
|
||||
def key(self) -> str:
|
||||
return self._key
|
||||
|
||||
@property
|
||||
def value(self) -> str | float:
|
||||
return self._value if self._value is not None else "0"
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str | float) -> None:
|
||||
self._value = value
|
||||
self.check_trigger(value)
|
||||
|
||||
@property
|
||||
def intern_value(self) -> str:
|
||||
return str(self.value)
|
||||
|
||||
@property
|
||||
def values(self) -> List[str]:
|
||||
return [str(self.value)]
|
||||
|
||||
@property
|
||||
def category(self) -> str:
|
||||
return self._category
|
||||
|
||||
@property
|
||||
def typology(self) -> str:
|
||||
return self._typology
|
||||
|
||||
@property
|
||||
def mandatory(self) -> int:
|
||||
return self._mandatory
|
||||
|
||||
@property
|
||||
def group(self) -> str:
|
||||
return self._group
|
||||
|
||||
def add_trigger(
|
||||
self, value: str, func: Callable[["HonRule"], None], data: "HonRule"
|
||||
) -> None:
|
||||
if self._value == value:
|
||||
func(data)
|
||||
self._triggers.setdefault(value, []).append((func, data))
|
||||
|
||||
def check_trigger(self, value: str | float) -> None:
|
||||
triggers = {str(k).lower(): v for k, v in self._triggers.items()}
|
||||
if str(value).lower() in triggers:
|
||||
for trigger in triggers[str(value)]:
|
||||
func, args = trigger
|
||||
func(args)
|
||||
|
||||
@property
|
||||
def triggers(self) -> Dict[str, Any]:
|
||||
result: Dict[str, Any] = {}
|
||||
for value, rules in self._triggers.items():
|
||||
for _, rule in rules:
|
||||
if rule.extras:
|
||||
param = result.setdefault(value, {})
|
||||
for extra_key, extra_value in rule.extras.items():
|
||||
param = param.setdefault(extra_key, {}).setdefault(
|
||||
extra_value, {}
|
||||
)
|
||||
else:
|
||||
param = result.setdefault(value, {})
|
||||
if fixed_value := rule.param_data.get("fixedValue"):
|
||||
param[rule.param_key] = fixed_value
|
||||
else:
|
||||
param[rule.param_key] = rule.param_data.get("defaultValue", "")
|
||||
|
||||
return result
|
||||
|
||||
def reset(self) -> None:
|
||||
self._set_attributes()
|
51
pyhon/parameter/enum.py
Normal file
51
pyhon/parameter/enum.py
Normal file
@ -0,0 +1,51 @@
|
||||
from typing import Dict, Any, List
|
||||
|
||||
from pyhon.parameter.base import HonParameter
|
||||
|
||||
|
||||
def clean_value(value: str | float) -> str:
|
||||
return str(value).strip("[]").replace("|", "_").lower()
|
||||
|
||||
|
||||
class HonParameterEnum(HonParameter):
|
||||
def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
|
||||
super().__init__(key, attributes, group)
|
||||
self._default: str | float = ""
|
||||
self._value: str | float = ""
|
||||
self._values: List[str] = []
|
||||
self._set_attributes()
|
||||
if self._default and clean_value(self._default.strip("[]")) not in self.values:
|
||||
self._values.append(self._default)
|
||||
|
||||
def _set_attributes(self) -> None:
|
||||
super()._set_attributes()
|
||||
self._default = self._attributes.get("defaultValue", "")
|
||||
self._value = self._default or "0"
|
||||
self._values = self._attributes.get("enumValues", [])
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"{self.__class__} (<{self.key}> {self.values})"
|
||||
|
||||
@property
|
||||
def values(self) -> List[str]:
|
||||
return [clean_value(value) for value in self._values]
|
||||
|
||||
@values.setter
|
||||
def values(self, values: List[str]) -> None:
|
||||
self._values = values
|
||||
|
||||
@property
|
||||
def intern_value(self) -> str:
|
||||
return str(self._value) if self._value is not None else str(self.values[0])
|
||||
|
||||
@property
|
||||
def value(self) -> str | float:
|
||||
return clean_value(self._value) if self._value is not None else self.values[0]
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str) -> None:
|
||||
if value in self.values:
|
||||
self._value = value
|
||||
self.check_trigger(value)
|
||||
else:
|
||||
raise ValueError(f"Allowed values: {self._values} But was: {value}")
|
27
pyhon/parameter/fixed.py
Normal file
27
pyhon/parameter/fixed.py
Normal file
@ -0,0 +1,27 @@
|
||||
from typing import Dict, Any
|
||||
|
||||
from pyhon.parameter.base import HonParameter
|
||||
|
||||
|
||||
class HonParameterFixed(HonParameter):
|
||||
def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
|
||||
super().__init__(key, attributes, group)
|
||||
self._value: str | float = ""
|
||||
self._set_attributes()
|
||||
|
||||
def _set_attributes(self) -> None:
|
||||
super()._set_attributes()
|
||||
self._value = self._attributes.get("fixedValue", "")
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"{self.__class__} (<{self.key}> fixed)"
|
||||
|
||||
@property
|
||||
def value(self) -> str | float:
|
||||
return self._value if self._value != "" else "0"
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str | float) -> None:
|
||||
# Fixed values seems being not so fixed as thought
|
||||
self._value = value
|
||||
self.check_trigger(value)
|
56
pyhon/parameter/program.py
Normal file
56
pyhon/parameter/program.py
Normal file
@ -0,0 +1,56 @@
|
||||
from typing import List, TYPE_CHECKING, Dict
|
||||
|
||||
from pyhon.parameter.enum import HonParameterEnum
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.commands import HonCommand
|
||||
|
||||
|
||||
class HonParameterProgram(HonParameterEnum):
|
||||
_FILTER = ["iot_recipe", "iot_guided"]
|
||||
|
||||
def __init__(self, key: str, command: "HonCommand", group: str) -> None:
|
||||
super().__init__(key, {}, group)
|
||||
self._command = command
|
||||
if "PROGRAM" in command.category:
|
||||
self._value = command.category.split(".")[-1].lower()
|
||||
else:
|
||||
self._value = command.category
|
||||
self._programs: Dict[str, "HonCommand"] = command.categories
|
||||
self._typology: str = "enum"
|
||||
|
||||
@property
|
||||
def value(self) -> str | float:
|
||||
return self._value
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str) -> None:
|
||||
if value in self.values:
|
||||
self._command.category = value
|
||||
else:
|
||||
raise ValueError(f"Allowed values: {self.values} But was: {value}")
|
||||
|
||||
@property
|
||||
def values(self) -> List[str]:
|
||||
values = [v for v in self._programs if all(f not in v for f in self._FILTER)]
|
||||
return sorted(values)
|
||||
|
||||
@values.setter
|
||||
def values(self, values: List[str]) -> None:
|
||||
raise ValueError("Cant set values {values}")
|
||||
|
||||
@property
|
||||
def ids(self) -> Dict[int, str]:
|
||||
values: Dict[int, str] = {}
|
||||
for name, parameter in self._programs.items():
|
||||
if "iot_" in name:
|
||||
continue
|
||||
if parameter.parameters.get("prCode"):
|
||||
continue
|
||||
if (fav := parameter.parameters.get("favourite")) and fav.value == "1":
|
||||
continue
|
||||
values[int(parameter.parameters["prCode"].value)] = name
|
||||
return dict(sorted(values.items()))
|
||||
|
||||
def set_value(self, value: str) -> None:
|
||||
self._value = value
|
72
pyhon/parameter/range.py
Normal file
72
pyhon/parameter/range.py
Normal file
@ -0,0 +1,72 @@
|
||||
from typing import Dict, Any, List
|
||||
|
||||
from pyhon.helper import str_to_float
|
||||
from pyhon.parameter.base import HonParameter
|
||||
|
||||
|
||||
class HonParameterRange(HonParameter):
|
||||
def __init__(self, key: str, attributes: Dict[str, Any], group: str) -> None:
|
||||
super().__init__(key, attributes, group)
|
||||
self._min: float = 0
|
||||
self._max: float = 0
|
||||
self._step: float = 0
|
||||
self._default: float = 0
|
||||
self._value: float = 0
|
||||
self._set_attributes()
|
||||
|
||||
def _set_attributes(self) -> None:
|
||||
super()._set_attributes()
|
||||
self._min = str_to_float(self._attributes.get("minimumValue", 0))
|
||||
self._max = str_to_float(self._attributes.get("maximumValue", 0))
|
||||
self._step = str_to_float(self._attributes.get("incrementValue", 0))
|
||||
self._default = str_to_float(self._attributes.get("defaultValue", self.min))
|
||||
self._value = self._default
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return f"{self.__class__} (<{self.key}> [{self.min} - {self.max}])"
|
||||
|
||||
@property
|
||||
def min(self) -> float:
|
||||
return self._min
|
||||
|
||||
@min.setter
|
||||
def min(self, mini: float) -> None:
|
||||
self._min = mini
|
||||
|
||||
@property
|
||||
def max(self) -> float:
|
||||
return self._max
|
||||
|
||||
@max.setter
|
||||
def max(self, maxi: float) -> None:
|
||||
self._max = maxi
|
||||
|
||||
@property
|
||||
def step(self) -> float:
|
||||
if not self._step:
|
||||
return 1
|
||||
return self._step
|
||||
|
||||
@step.setter
|
||||
def step(self, step: float) -> None:
|
||||
self._step = step
|
||||
|
||||
@property
|
||||
def value(self) -> str | float:
|
||||
return self._value if self._value is not None else self.min
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str | float) -> None:
|
||||
value = str_to_float(value)
|
||||
if self.min <= value <= self.max and not ((value - self.min) * 100) % (
|
||||
self.step * 100
|
||||
):
|
||||
self._value = value
|
||||
self.check_trigger(value)
|
||||
else:
|
||||
allowed = f"min {self.min} max {self.max} step {self.step}"
|
||||
raise ValueError(f"Allowed: {allowed} But was: {value}")
|
||||
|
||||
@property
|
||||
def values(self) -> List[str]:
|
||||
return [str(i) for i in range(int(self.min), int(self.max) + 1, int(self.step))]
|
87
pyhon/printer.py
Normal file
87
pyhon/printer.py
Normal file
@ -0,0 +1,87 @@
|
||||
from typing import Dict, Any, TYPE_CHECKING, List
|
||||
|
||||
from pyhon.parameter.enum import HonParameterEnum
|
||||
from pyhon.parameter.range import HonParameterRange
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.commands import HonCommand
|
||||
|
||||
|
||||
def key_print(data: Any, key: str = "", start: bool = True) -> str:
|
||||
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: Any,
|
||||
key: str = "",
|
||||
intend: int = 0,
|
||||
is_list: bool = False,
|
||||
whitespace: str = " ",
|
||||
) -> str:
|
||||
result = ""
|
||||
space = whitespace * intend
|
||||
if isinstance(data, (dict, list)) and key:
|
||||
result += f"{space}{'- ' if is_list else ''}{key}:\n"
|
||||
intend += 1
|
||||
if isinstance(data, list):
|
||||
for i, value in enumerate(data):
|
||||
result += pretty_print(
|
||||
value, intend=intend, is_list=True, whitespace=whitespace
|
||||
)
|
||||
elif isinstance(data, dict):
|
||||
for i, (list_key, value) in enumerate(sorted(data.items())):
|
||||
result += pretty_print(
|
||||
value,
|
||||
key=list_key,
|
||||
intend=intend + (is_list if i else 0),
|
||||
is_list=is_list and not i,
|
||||
whitespace=whitespace,
|
||||
)
|
||||
else:
|
||||
result += f"{space}{'- ' if is_list else ''}{key}{': ' if key else ''}{data}\n"
|
||||
return result
|
||||
|
||||
|
||||
def create_commands(
|
||||
commands: Dict[str, "HonCommand"], concat: bool = False
|
||||
) -> Dict[str, Any]:
|
||||
result: Dict[str, Any] = {}
|
||||
for name, command in commands.items():
|
||||
for parameter, data in command.available_settings.items():
|
||||
if isinstance(data, HonParameterEnum):
|
||||
value: List[str] | Dict[str, str | float] = data.values
|
||||
elif isinstance(data, HonParameterRange):
|
||||
value = {"min": data.min, "max": data.max, "step": data.step}
|
||||
else:
|
||||
continue
|
||||
if not concat:
|
||||
result.setdefault(name, {})[parameter] = value
|
||||
else:
|
||||
result[f"{name}.{parameter}"] = value
|
||||
return result
|
||||
|
||||
|
||||
def create_rules(
|
||||
commands: Dict[str, "HonCommand"], concat: bool = False
|
||||
) -> Dict[str, Any]:
|
||||
result: Dict[str, Any] = {}
|
||||
for name, command in commands.items():
|
||||
for parameter, data in command.available_settings.items():
|
||||
value = data.triggers
|
||||
if not value:
|
||||
continue
|
||||
if not concat:
|
||||
result.setdefault(name, {})[parameter] = value
|
||||
else:
|
||||
result[f"{name}.{parameter}"] = value
|
||||
return result
|
0
pyhon/py.typed
Normal file
0
pyhon/py.typed
Normal file
145
pyhon/rules.py
Normal file
145
pyhon/rules.py
Normal file
@ -0,0 +1,145 @@
|
||||
from dataclasses import dataclass
|
||||
from typing import List, Dict, TYPE_CHECKING, Any, Optional
|
||||
|
||||
from pyhon.parameter.enum import HonParameterEnum
|
||||
from pyhon.parameter.range import HonParameterRange
|
||||
from pyhon.typedefs import Parameter
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.commands import HonCommand
|
||||
from pyhon.parameter.base import HonParameter
|
||||
|
||||
|
||||
@dataclass
|
||||
class HonRule:
|
||||
trigger_key: str
|
||||
trigger_value: str
|
||||
param_key: str
|
||||
param_data: Dict[str, Any]
|
||||
extras: Optional[Dict[str, str]] = None
|
||||
|
||||
|
||||
class HonRuleSet:
|
||||
def __init__(self, command: "HonCommand", rule: Dict[str, Any]):
|
||||
self._command: "HonCommand" = command
|
||||
self._rules: Dict[str, List[HonRule]] = {}
|
||||
self._parse_rule(rule)
|
||||
|
||||
@property
|
||||
def rules(self) -> Dict[str, List[HonRule]]:
|
||||
return self._rules
|
||||
|
||||
def _parse_rule(self, rule: Dict[str, Any]) -> None:
|
||||
for param_key, params in rule.items():
|
||||
param_key = self._command.appliance.options.get(param_key, param_key)
|
||||
for trigger_key, trigger_data in params.items():
|
||||
self._parse_conditions(param_key, trigger_key, trigger_data)
|
||||
|
||||
def _parse_conditions(
|
||||
self,
|
||||
param_key: str,
|
||||
trigger_key: str,
|
||||
trigger_data: Dict[str, Any],
|
||||
extra: Optional[Dict[str, str]] = None,
|
||||
) -> None:
|
||||
trigger_key = trigger_key.replace("@", "")
|
||||
trigger_key = self._command.appliance.options.get(trigger_key, trigger_key)
|
||||
for multi_trigger_value, param_data in trigger_data.items():
|
||||
for trigger_value in multi_trigger_value.split("|"):
|
||||
if isinstance(param_data, dict) and "typology" in param_data:
|
||||
self._create_rule(
|
||||
param_key, trigger_key, trigger_value, param_data, extra
|
||||
)
|
||||
elif isinstance(param_data, dict):
|
||||
if extra is None:
|
||||
extra = {}
|
||||
extra[trigger_key] = trigger_value
|
||||
for extra_key, extra_data in param_data.items():
|
||||
self._parse_conditions(param_key, extra_key, extra_data, extra)
|
||||
else:
|
||||
param_data = {"typology": "fixed", "fixedValue": param_data}
|
||||
self._create_rule(
|
||||
param_key, trigger_key, trigger_value, param_data, extra
|
||||
)
|
||||
|
||||
def _create_rule(
|
||||
self,
|
||||
param_key: str,
|
||||
trigger_key: str,
|
||||
trigger_value: str,
|
||||
param_data: Dict[str, Any],
|
||||
extras: Optional[Dict[str, str]] = None,
|
||||
) -> None:
|
||||
if param_data.get("fixedValue") == f"@{param_key}":
|
||||
return
|
||||
self._rules.setdefault(trigger_key, []).append(
|
||||
HonRule(trigger_key, trigger_value, param_key, param_data, extras)
|
||||
)
|
||||
|
||||
def _duplicate_for_extra_conditions(self) -> None:
|
||||
new: Dict[str, List[HonRule]] = {}
|
||||
for rules in self._rules.values():
|
||||
for rule in rules:
|
||||
if rule.extras is None:
|
||||
continue
|
||||
for key, value in rule.extras.items():
|
||||
extras = rule.extras.copy()
|
||||
extras.pop(key)
|
||||
extras[rule.trigger_key] = rule.trigger_value
|
||||
new.setdefault(key, []).append(
|
||||
HonRule(key, value, rule.param_key, rule.param_data, extras)
|
||||
)
|
||||
for key, rules in new.items():
|
||||
for rule in rules:
|
||||
self._rules.setdefault(key, []).append(rule)
|
||||
|
||||
def _extra_rules_matches(self, rule: HonRule) -> bool:
|
||||
if rule.extras:
|
||||
for key, value in rule.extras.items():
|
||||
if not self._command.parameters.get(key):
|
||||
return False
|
||||
if str(self._command.parameters.get(key)) != str(value):
|
||||
return False
|
||||
return True
|
||||
|
||||
def _apply_fixed(self, param: Parameter, value: str | float) -> None:
|
||||
if isinstance(param, HonParameterEnum) and set(param.values) != {str(value)}:
|
||||
param.values = [str(value)]
|
||||
param.value = str(value)
|
||||
elif isinstance(param, HonParameterRange):
|
||||
if float(value) < param.min:
|
||||
param.min = float(value)
|
||||
elif float(value) > param.max:
|
||||
param.max = float(value)
|
||||
param.value = float(value)
|
||||
return
|
||||
param.value = str(value)
|
||||
|
||||
def _apply_enum(self, param: Parameter, rule: HonRule) -> None:
|
||||
if not isinstance(param, HonParameterEnum):
|
||||
return
|
||||
if enum_values := rule.param_data.get("enumValues"):
|
||||
param.values = enum_values.split("|")
|
||||
if default_value := rule.param_data.get("defaultValue"):
|
||||
param.value = default_value
|
||||
|
||||
def _add_trigger(self, parameter: "HonParameter", data: HonRule) -> None:
|
||||
def apply(rule: HonRule) -> None:
|
||||
if not self._extra_rules_matches(rule):
|
||||
return
|
||||
if not (param := self._command.parameters.get(rule.param_key)):
|
||||
return
|
||||
if fixed_value := rule.param_data.get("fixedValue", ""):
|
||||
self._apply_fixed(param, fixed_value)
|
||||
elif rule.param_data.get("typology") == "enum":
|
||||
self._apply_enum(param, rule)
|
||||
|
||||
parameter.add_trigger(data.trigger_value, apply, data)
|
||||
|
||||
def patch(self) -> None:
|
||||
self._duplicate_for_extra_conditions()
|
||||
for name, parameter in self._command.parameters.items():
|
||||
if name not in self._rules:
|
||||
continue
|
||||
for data in self._rules.get(name, []):
|
||||
self._add_trigger(parameter, data)
|
27
pyhon/typedefs.py
Normal file
27
pyhon/typedefs.py
Normal file
@ -0,0 +1,27 @@
|
||||
from typing import Union, Any, TYPE_CHECKING, Protocol
|
||||
|
||||
import aiohttp
|
||||
from yarl import URL
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from pyhon.parameter.base import HonParameter
|
||||
from pyhon.parameter.enum import HonParameterEnum
|
||||
from pyhon.parameter.fixed import HonParameterFixed
|
||||
from pyhon.parameter.program import HonParameterProgram
|
||||
from pyhon.parameter.range import HonParameterRange
|
||||
|
||||
|
||||
class Callback(Protocol): # pylint: disable=too-few-public-methods
|
||||
def __call__(
|
||||
self, url: str | URL, *args: Any, **kwargs: Any
|
||||
) -> aiohttp.client._RequestContextManager:
|
||||
...
|
||||
|
||||
|
||||
Parameter = Union[
|
||||
"HonParameter",
|
||||
"HonParameterRange",
|
||||
"HonParameterEnum",
|
||||
"HonParameterFixed",
|
||||
"HonParameterProgram",
|
||||
]
|
@ -1 +1,3 @@
|
||||
aiohttp
|
||||
aiohttp>=3.8
|
||||
yarl>=1.8
|
||||
typing-extensions>=4.8
|
||||
|
5
requirements_dev.txt
Normal file
5
requirements_dev.txt
Normal file
@ -0,0 +1,5 @@
|
||||
black>=22.12
|
||||
flake8>=6.0
|
||||
mypy>=0.991
|
||||
pylint>=2.15
|
||||
setuptools>=62.3
|
15
setup.py
15
setup.py
@ -2,16 +2,16 @@
|
||||
|
||||
from setuptools import setup, find_packages
|
||||
|
||||
with open("README.md", "r") as f:
|
||||
with open("README.md", "r", encoding="utf-8") as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name="pyhOn",
|
||||
version="0.2.6",
|
||||
version="0.15.15",
|
||||
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",
|
||||
@ -21,7 +21,7 @@ setup(
|
||||
packages=find_packages(),
|
||||
include_package_data=True,
|
||||
python_requires=">=3.10",
|
||||
install_requires=["aiohttp"],
|
||||
install_requires=["aiohttp>=3.8", "typing-extensions>=4.8", "yarl>=1.8"],
|
||||
classifiers=[
|
||||
"Development Status :: 4 - Beta",
|
||||
"Environment :: Console",
|
||||
@ -30,11 +30,12 @@ setup(
|
||||
"Operating System :: OS Independent",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
],
|
||||
entry_points={
|
||||
'console_scripts': [
|
||||
'pyhOn = pyhon.__main__:start',
|
||||
"console_scripts": [
|
||||
"pyhOn = pyhon.__main__:start",
|
||||
]
|
||||
}
|
||||
},
|
||||
)
|
||||
|
Loading…
Reference in New Issue
Block a user