Add contribution instructions to readme

This commit is contained in:
Andre Basche 2023-03-06 18:40:30 +01:00
parent 03a1e40b6e
commit 88c76b8056
3 changed files with 50 additions and 3 deletions

View file

@ -1,5 +1,7 @@
# Haier hOn # Haier hOn
Home Assistant component supporting hOn cloud. [![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)
Home Assistant component supporting devices of Haier's mobile app **hOn**.
## Installation ## Installation
#### Installing via HACS #### Installing via HACS
@ -14,6 +16,51 @@ Home Assistant component supporting hOn cloud.
9. Search for Haier hOn 9. Search for Haier hOn
10. Type your username used in the hOn App and hit submit 10. Type your username used in the hOn App and hit submit
## 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
- 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.
## Supported Appliances ## Supported Appliances
- Washing Machine - Washing Machine