pyhOn/README.md

112 lines
3.4 KiB
Markdown
Raw Permalink Normal View History

2023-03-04 21:27:10 +01:00
**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
2023-03-04 22:38:43 +01:00
[![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/)
2023-03-06 18:57:08 +01:00
[![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)
2023-03-04 21:27:10 +01:00
Control your Haier appliances with python!
2023-03-04 22:19:48 +01:00
The idea behind this library is, to make the use of all available commands as simple as possible.
2023-03-04 22:38:43 +01:00
## Installation
```bash
pip install pyhOn
```
2023-03-04 21:27:10 +01:00
### Quick overview
2023-03-04 22:38:43 +01:00
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.
2023-03-04 21:27:10 +01:00
```commandline
$ pyhOn --user example@mail.com --password pass123
2023-03-05 18:46:51 +01:00
========== WM - Waschmaschine ==========
2023-03-04 21:27:10 +01:00
data:
2023-03-08 00:58:25 +01:00
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
...
2023-03-04 21:27:10 +01:00
```
## Python-API
### List devices
```python
import asyncio
2023-04-09 23:47:33 +02:00
from pyhon import Hon
2023-03-04 21:27:10 +01:00
async def devices_example():
2023-04-09 23:47:33 +02:00
async with Hon(USER, PASSWORD) as hon:
for appliance in hon.appliances:
print(appliance.nick_name)
2023-03-04 21:27:10 +01:00
asyncio.run(devices_example())
```
### Execute a command
```python
2023-04-09 23:47:33 +02:00
async with Hon(USER, PASSWORD) as hon:
washing_machine = hon.appliances[0]
2023-03-04 21:27:10 +01:00
pause_command = washing_machine.commands["pauseProgram"]
await pause_command.send()
```
2023-03-04 22:19:48 +01:00
### Set command parameter
```python
2023-04-09 23:47:33 +02:00
async with Hon(USER, PASSWORD) as hon:
washing_machine = hon.appliances[0]
2023-03-04 22:19:48 +01:00
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
```
2023-03-21 01:10:41 +01:00
## 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
```
2023-03-04 22:19:48 +01:00
## Tested devices
- Haier Washing Machine HW90
## Usage example
This library is used for the custom [HomeAssistant Integration "Haier hOn"](https://github.com/Andre0512/hOn).
2023-03-05 18:46:51 +01:00
## Contribution
Any kind of contribution is welcome!