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


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pyhOn-0.14.3.tar.gz (24.3 kB view details)

Uploaded Source

Built Distribution

pyhOn-0.14.3-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

Details for the file pyhOn-0.14.3.tar.gz.

File metadata

  • Download URL: pyhOn-0.14.3.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyhOn-0.14.3.tar.gz
Algorithm Hash digest
SHA256 0d97456b955aed08183b7afc13bead9d106ceedb268edb2a53fe9c98a2ebb624
MD5 c23bafa00678cae4d730746a9214c626
BLAKE2b-256 e54138419d4ef0b2bb5a7a5fb53eb07248f6a6827f1a21e704fe0a681dd4d3cb

See more details on using hashes here.

File details

Details for the file pyhOn-0.14.3-py3-none-any.whl.

File metadata

  • Download URL: pyhOn-0.14.3-py3-none-any.whl
  • Upload date:
  • Size: 36.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for pyhOn-0.14.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b615ab055484172fb8c1c406d8cae6f0d721bc656d405246e3bf0f912d754516
MD5 2a1de19097022c446808b7bdc804125d
BLAKE2b-256 69a42a87efbe65089179d4cb93a2782a134190eefc41639be5097e93dd777ddf

See more details on using hashes here.

Supported by

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