Skip to main content

Control hOn devices with python

Project description

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 PyPI PyPI - Python Version PyPI - License PyPI - Downloads
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

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.

$ 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

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

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

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

$ 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

$ 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".

Contribution

Any kind of contribution is welcome!

Please add your appliances data to our hon-test-data collection.
This helps us to develop new features and not to break compatibility in newer versions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhon_2-0.17.5.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhon_2-0.17.5-py3-none-any.whl (41.5 kB view details)

Uploaded Python 3

File details

Details for the file pyhon_2-0.17.5.tar.gz.

File metadata

  • Download URL: pyhon_2-0.17.5.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for pyhon_2-0.17.5.tar.gz
Algorithm Hash digest
SHA256 7cbeaeb1ebd66a674b9c78484868848d0ea510435977b835d28a667a5daef626
MD5 815fc07f3a287fb2244a21dc78eefee1
BLAKE2b-256 66b91119f73594fafefcfe4caa84c3fc7478c1a97d8d1039c07b67c2bbab02ae

See more details on using hashes here.

File details

Details for the file pyhon_2-0.17.5-py3-none-any.whl.

File metadata

  • Download URL: pyhon_2-0.17.5-py3-none-any.whl
  • Upload date:
  • Size: 41.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for pyhon_2-0.17.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a52a131be8a82a70812c99a9197668b2d5325eaf771367dea3e3ad43178e2e54
MD5 cb5bc6e58fe1c08eff39047ea71487c8
BLAKE2b-256 d21c7dec8ce85e6c0041f5d3da2b21688d3432d6010279adb2e65088936bbe70

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page