pyhon-revived 0.18.0__tar.gz

pyhon_revived-0.18.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Andre Basche
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyhon_revived-0.18.0/MANIFEST.in

@@ -0,0 +1 @@
+include pyhon/py.typed

pyhon_revived-0.18.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: pyhon-revived
+Version: 0.18.0
+Summary: Control hOn devices with python
+Author: Andre Basche, Michał Małolepszy
+License: MIT
+Project-URL: GitHub, https://github.com/mmalolepszy/pyhon-revived
+Project-URL: PyPI, https://pypi.org/project/pyhon-revived
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8.6
+Requires-Dist: typing-extensions>=4.8
+Requires-Dist: yarl>=1.8
+Requires-Dist: awsiotsdk>=1.21.0
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: license-file
+Dynamic: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+**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
+[![PyPI - Status](https://img.shields.io/pypi/status/pyhOn)](https://pypi.org/project/pyhOn)
+[![PyPI](https://img.shields.io/pypi/v/pyhOn?color=blue)](https://pypi.org/project/pyhOn)
+[![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, 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
+```bash
+pip install pyhOn
+```
+
+### Quick overview
+To get an idea of what is possible, use the commandline-tool `pyhOn`. This command requests all available options of connected appliances from the hOn api of your Haier Account.
+```commandline
+$ pyhOn --user example@mail.com --password pass123
+========== WM - Waschmaschine ==========
+data:
+  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 Hon
+
+async def devices_example():
+    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 Hon(USER, PASSWORD) as hon:
+    washing_machine = hon.appliances[0]
+    pause_command = washing_machine.commands["pauseProgram"]
+    await pause_command.send()
+```
+
+### Set command parameter
+```python
+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)
+        print("Current value", setting.value)
+        if setting.typology == "enum":
+            print("Available values", setting.values)
+            setting.value = setting.values[0]
+        elif setting.typology == "range":
+            print("Min value", setting.min)
+            print("Max value", setting.max)
+            print("Step value", setting.step)
+            setting.value = setting.min + setting.step
+```
+
+## 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).
+
+## 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. |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+

pyhon_revived-0.18.0/README.md

@@ -0,0 +1,112 @@
+**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
+[![PyPI - Status](https://img.shields.io/pypi/status/pyhOn)](https://pypi.org/project/pyhOn)
+[![PyPI](https://img.shields.io/pypi/v/pyhOn?color=blue)](https://pypi.org/project/pyhOn)
+[![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, 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
+```bash
+pip install pyhOn
+```
+
+### Quick overview
+To get an idea of what is possible, use the commandline-tool `pyhOn`. This command requests all available options of connected appliances from the hOn api of your Haier Account.
+```commandline
+$ pyhOn --user example@mail.com --password pass123
+========== WM - Waschmaschine ==========
+data:
+  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 Hon
+
+async def devices_example():
+    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 Hon(USER, PASSWORD) as hon:
+    washing_machine = hon.appliances[0]
+    pause_command = washing_machine.commands["pauseProgram"]
+    await pause_command.send()
+```
+
+### Set command parameter
+```python
+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)
+        print("Current value", setting.value)
+        if setting.typology == "enum":
+            print("Available values", setting.values)
+            setting.value = setting.values[0]
+        elif setting.typology == "range":
+            print("Min value", setting.min)
+            print("Max value", setting.max)
+            print("Step value", setting.step)
+            setting.value = setting.min + setting.step
+```
+
+## 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).
+
+## 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. |
+|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+

pyhon_revived-0.18.0/pyhon/__init__.py

@@ -0,0 +1,4 @@
+from .connection.api import HonAPI
+from .hon import Hon
+
+__all__ = ["Hon", "HonAPI"]

pyhon_revived-0.18.0/pyhon/__main__.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env python
+import argparse
+import asyncio
+import json
+import logging
+import sys
+from getpass import getpass
+from pathlib import Path
+from typing import Tuple, Dict, Any
+
+if __name__ == "__main__":
+    sys.path.insert(0, str(Path(__file__).parent.parent))
+
+# pylint: disable=wrong-import-position
+from pyhon import Hon, HonAPI, diagnose, printer
+
+_LOGGER = logging.getLogger(__name__)
+
+
+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="?")
+    return vars(parser.parse_args())
+
+
+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:
+        clean_keys = (
+            json.dumps(keys)
+            .replace("\\n", "\\\\n")
+            .replace("\\\\r", "")
+            .replace("\\r", "")
+        )
+        keys = json.loads(clean_keys)
+        print(printer.pretty_print(keys))
+
+
+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: ")
+    return user, password
+
+
+async def main() -> None:
+    args = get_arguments()
+    if language := args.get("translate"):
+        await translate(language, json_output=args.get("json", ""))
+        return
+    test_data_path = Path(path) if (path := args.get("import", "")) else None
+    async with Hon(*get_login_data(args), test_data_path=test_data_path) 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__":
+    start()