hon/README.md

85 lines
4.0 KiB
Markdown
Raw Normal View History

2023-03-05 21:16:09 +01:00
# Haier hOn
2023-04-10 18:50:51 +02:00
[![hacs_badge](https://img.shields.io/badge/HACS-Default-41BDF5.svg)](https://hacs.xyz)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Andre0512/hon?color=green)](https://github.com/Andre0512/hon/releases/latest)
![GitHub](https://img.shields.io/github/license/Andre0512/hon?color=red)
[![Home Assistant installs](https://img.shields.io/badge/dynamic/json?color=blue&label=usage&suffix=%20installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.hon.total)](https://analytics.home-assistant.io/)
2023-04-02 02:43:20 +02:00
Home Assistant integration for Haier hOn: support for Haier/Candy/Hoover home appliances like washing machines.
2023-03-21 22:28:08 +01:00
## Supported Appliances
- Tumble Dryer
2023-04-08 06:15:33 +02:00
- Washer Dryer
- Washing Machine
- Oven
2023-04-02 02:43:20 +02:00
2023-03-05 01:22:05 +01:00
## Installation
2023-04-08 06:15:33 +02:00
**Method 1:** [![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=Andre0512&repository=hon&category=integration)
2023-04-02 02:43:20 +02:00
2023-04-08 06:15:33 +02:00
**Method 2:** [HACS](https://hacs.xyz/) > Integrations > Add Integration > **Haier hOn** > Install
2023-04-02 02:43:20 +02:00
2023-04-08 06:15:33 +02:00
**Method 3:** Manually copy `hon` folder from [latest release](https://github.com/Andre0512/hon/releases/latest) to `config/custom_components` folder.
2023-04-02 02:43:20 +02:00
2023-04-10 08:17:27 +02:00
_Restart Home Assistant_
2023-04-02 02:43:20 +02:00
## Configuration
2023-04-08 06:15:33 +02:00
**Method 1**: [![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=hon)
2023-04-02 02:43:20 +02:00
2023-04-08 06:15:33 +02:00
**Method 2**: Settings > Devices & Services > Add Integration > **Haier hOn**
_If the integration is not in the list, you need to clear the browser cache._
2023-03-05 01:22:05 +01:00
## Contribute
Any kind of contribution is welcome!
#### Add appliances or additional attributes
1. Install [pyhOn](https://github.com/Andre0512/pyhOn)
```commandline
$ pip install pyhOn
```
2. Use the commandline tool to read out all appliance data from your account
```commandline
$ pyhOn
User for hOn account: user.name@example.com
Password for hOn account: ********
========== WM - Washing Machine ==========
commands:
pauseProgram: pauseProgram command
resumeProgram: resumeProgram command
startProgram: startProgram command
stopProgram: stopProgram command
data:
actualWeight: 0
airWashTempLevel: 0
airWashTime: 0
antiAllergyStatus: 0
...
```
3. Fork this repository and clone it to your local machine
4. Add the keys of the attributes you'd like to have as `EntityDescription` into this Repository
_Example: Add pause button_
```python
BUTTONS: dict[str, tuple[ButtonEntityDescription, ...]] = {
"WM": ( # WM is the applianceTypeName
ButtonEntityDescription(
key="pauseProgram", # key from pyhOn
name="Pause Program", # name in home assistant
icon="mdi:pause", # icon in home assistant
...
),
...
```
5. Create a [pull request](https://github.com/Andre0512/hon/pulls)
#### Tips and Tricks
2023-04-10 08:17:27 +02:00
- If you want to have some states humanreadable, have a look at the `translation_key` parameter of the `EntityDescription`.
- If you need to implement some more logic, create a pull request to the underlying library. There we collect special requirements in the `appliances` directory.
2023-04-10 08:17:27 +02:00
- Use [pyhOn](https://github.com/Andre0512/pyhOn)s translate command to read out the official translations
2023-03-05 01:22:05 +01:00
## Tested Devices
2023-03-21 22:28:08 +01:00
- Haier WD90-B14TEAM5
- Haier HD80-A3959
2023-04-08 06:15:33 +02:00
- Haier HWO60SM2F3XH
- Hoover H-WASH 500
2023-03-05 01:22:05 +01:00
## About this Repo
The existing integrations missed some features from the app I liked to have in HomeAssistant.
I tried to create a pull request, but in the structures of these existing repos, I find it hard to fit in my needs, so I basically rewrote everything.
I moved the api related stuff into the package [pyhOn](https://github.com/Andre0512/pyhOn).