base on Control hOn devices with python **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 [email protected] --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. | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ", Assign "at most 3 tags" to the expected json: {"id":"7101","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"