Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ollo69 committed May 27, 2024
1 parent 3678c00 commit 9a7d27d
Showing 1 changed file with 25 additions and 12 deletions.
37 changes: 25 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@
[![](https://img.shields.io/badge/COMMUNITY-FORUM-success?style=for-the-badge)](https://community.home-assistant.io)

# MELCloud HomeAssistant custom component

## ℹ️ Note
Due to the latest restrictions introduced by MELCloud platform (see [here](https://github.com/ollo69/ha-melcloud-custom/issues/13)) I decided to implement the control of my AC devices through the adoption of small and economical `ESP8266` devices connected to `CN105` units connector which allow real-time control via MQTT (see [here](https://github.com/dzungpv/mitsubishi2MQTT) an example).

As consequence I no longer have a way to maintain this integration, fixing bug, implementing new features and adapting to HA architecture changes.

If anyone is interested in taking charge of it, they can possibly fork this repository and I will report the new reference link here in the notes.

*This repository will be shortly moved in state `archived`.

## Description
A full featured Homeassistant custom component to drive MELCloud ATA and ATW devices.

This custom component is based on the native Home Assistant [MELCloud component](https://github.com/home-assistant/core/tree/dev/homeassistant/components/melcloud) released with version 0.106 and on the same underlying [PyMelCloud library](https://github.com/vilppuvuorinen/pymelcloud).
Expand All @@ -22,6 +33,8 @@ I just added some features to the existing native components, waiting for the sa

1. Added some attributes to the sensors to provide additional information (SerialNo, Unit Info, etc)

1. Implemented use of `coordinator` to have update for all entities syncronizes

## Installation & configuration
You can install this component in two ways: via HACS or manually.

Expand Down Expand Up @@ -49,8 +62,8 @@ After a correct installation, your configuration directory should look like the
```

**Note**: if the custom_components directory does not exist, you need to create it.
### Component setup

### Component setup
Once the component has been installed, you need to configure it in order to make it work.
There are two ways of doing so:
- Using the web interface (Lovelace) [**recommended**]
Expand All @@ -60,18 +73,18 @@ There are two ways of doing so:
Simply add a new "integration" and look for "MELCloud Custom" among the proposed ones. Do not confuse with "MELCloud" that is the native one!

#### Option B: Configuration via editing configuration.yaml
Follow these steps only if the previous configuration method did not work for you.
Follow these steps only if the previous configuration method did not work for you.

1. Setup your MELCloud credentials. Edit/create the `secrets.yaml` file,
which is located within the config directory as well. Add the following:

```
melcloud_username: [email protected]
melcloud_password: my_melcloud_password
```
Where "[email protected]" is your MELCloud account email and "my_melcloud_password" is the associated password.

Where "[email protected]" is your MELCloud account email and "my_melcloud_password" is the associated password.

1. Enable the component by editing the configuration.yaml file (within the config directory as well).
Edit it by adding the following lines:
```
Expand All @@ -80,9 +93,9 @@ Edit it by adding the following lines:
password: !secret melcloud_password
language: my_melcloud_language
```
Where "my_melcloud_language" is your MELCloud account language and can be one of the following (eg: EN):

Where "my_melcloud_language" is your MELCloud account language and can be one of the following (eg: EN):

EN = English
BG = Bulgarian
CS = Czech
Expand Down Expand Up @@ -110,8 +123,8 @@ Edit it by adding the following lines:
RO = Romanian
SL = Slovenian

**Note!** In this case you do not need to replace "!secret melcloud_username" and "!secret melcloud_password".
Those are place holders that homeassistant automatically replaces by looking at the secrets.yaml file.
**Note!** In this case you do not need to replace "!secret melcloud_username" and "!secret melcloud_password".
Those are place holders that homeassistant automatically replaces by looking at the secrets.yaml file.

1. Reboot home assistant
1. Congrats! You're all set!
Expand Down

0 comments on commit 9a7d27d

Please sign in to comment.