From a815cca8feb731bad46649d560fa7f7d8f540886 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Thu, 30 Jan 2020 22:06:23 +0200 Subject: [PATCH 01/12] Add documentation for MELCloud integration --- source/_integrations/melcloud.markdown | 60 ++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 source/_integrations/melcloud.markdown diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown new file mode 100644 index 000000000000..fb84905697eb --- /dev/null +++ b/source/_integrations/melcloud.markdown @@ -0,0 +1,60 @@ +--- +title: MELCloud +description: MELCloud integration +logo: home-assistant.png +ha_category: + - Climate +ha_release: '0.106' +ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@vilppuvuorinen' +--- + +The `melcloud` integration integrates Mitsubishi Electric's MELCloud enabled devices into Home Assistant. + +## Device support + +- Air-to-Air heat pumps, i.e. AC units - **Supported** +- Air-to-Water heat pumps - **Work in progress** +- Energy recovery ventilators - **Not supported** +- Other - **Not supported** + +## Configuration + +MELCloud integration should be configured through the Home Assistant user interface using MELCloud login details. This is not optimal, but **the provided password is not stored**. + +The stored access token can later be updated by adding the MELCloud integration again with the same email address. + +Configuration is also possible through `configuration.yaml`. The token can be found from `X-MitsContextKey` header when logged into MELCloud with 'English' and 'Remember me'. + +```yaml +melcloud: + token: xxxxxxxxxxxxxxxxxxx +``` + +{% configuration %} +token: + description: X-MitsContextKey access token + required: true + type: string +{% endconfiguration %} + +## Air-to-Air device + +Air-to-Air heat pump provides `climate` and `sensor` platforms. + +### Climate + +Following parameters can be controlled throught the `climate` platform: + +- Target temperature +- Operation mode (HVAC mode) with emulated power off. +- Fan speed + +### Sensor + +Following parameters are provided through `sensor` platform: + +- Room temperature +- Energy - total consumed energy in kWh. From dfe33eb538b0aa9e1b4a724a958be4f72453af41 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Fri, 31 Jan 2020 07:03:09 +0200 Subject: [PATCH 02/12] Remove quotes from HA release --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index fb84905697eb..6bd5d0c035d9 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -4,7 +4,7 @@ description: MELCloud integration logo: home-assistant.png ha_category: - Climate -ha_release: '0.106' +ha_release: 0.106 ha_iot_class: Cloud Polling ha_config_flow: true ha_codeowners: From d059c841eda449513c7069b640827850be6f50b1 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:38:27 +0200 Subject: [PATCH 03/12] Make the text flow Co-Authored-By: Teemu R. --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 6bd5d0c035d9..c2c241e8190d 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -22,7 +22,7 @@ The `melcloud` integration integrates Mitsubishi Electric's MELCloud enabled dev ## Configuration -MELCloud integration should be configured through the Home Assistant user interface using MELCloud login details. This is not optimal, but **the provided password is not stored**. +The integration should be configured through the user interface ("Configurations -> Integrations") using the MELCloud login details. While not optimal, **the provided password is not stored**. The stored access token can later be updated by adding the MELCloud integration again with the same email address. From 9c7760235b4c3e5b05e0904deeaccd1a0f06eefd Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:38:51 +0200 Subject: [PATCH 04/12] Make the text flow 2 Co-Authored-By: Teemu R. --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index c2c241e8190d..b22d9c4c3a83 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -54,7 +54,7 @@ Following parameters can be controlled throught the `climate` platform: ### Sensor -Following parameters are provided through `sensor` platform: +The following attributes are available for `sensor` platform entities: - Room temperature - Energy - total consumed energy in kWh. From acae70984bbf6ded9ca07b6179d0f7959c658f8c Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:39:08 +0200 Subject: [PATCH 05/12] Make the text flow 3 Co-Authored-By: Teemu R. --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index b22d9c4c3a83..eb0d56353d8c 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -46,7 +46,7 @@ Air-to-Air heat pump provides `climate` and `sensor` platforms. ### Climate -Following parameters can be controlled throught the `climate` platform: +The following parameters can be controlled for the `climate` platform entities: - Target temperature - Operation mode (HVAC mode) with emulated power off. From 29f3d996fa1d152faf7a9bfc557bb7bac7f786e4 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:42:00 +0200 Subject: [PATCH 06/12] Add link to MELCloud --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index eb0d56353d8c..741abbffb50e 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -11,7 +11,7 @@ ha_codeowners: - '@vilppuvuorinen' --- -The `melcloud` integration integrates Mitsubishi Electric's MELCloud enabled devices into Home Assistant. +The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://www.melcloud.com/) enabled devices into Home Assistant. ## Device support From cf24e56414a2fccfe0e92d4da2d8bfb46e90100f Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:43:14 +0200 Subject: [PATCH 07/12] Switch that abbreviation --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 741abbffb50e..1dfe52abbd47 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -15,7 +15,7 @@ The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://w ## Device support -- Air-to-Air heat pumps, i.e. AC units - **Supported** +- Air-to-Air heat pumps, e.g. AC units - **Supported** - Air-to-Water heat pumps - **Work in progress** - Energy recovery ventilators - **Not supported** - Other - **Not supported** From fb3665aaa7e3659f36c6831c1f502251ddcf11b1 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:52:15 +0200 Subject: [PATCH 08/12] Clarify and update configuration.yaml setup --- source/_integrations/melcloud.markdown | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 1dfe52abbd47..3dd8b9c30fd1 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -26,14 +26,19 @@ The integration should be configured through the user interface ("Configurations The stored access token can later be updated by adding the MELCloud integration again with the same email address. -Configuration is also possible through `configuration.yaml`. The token can be found from `X-MitsContextKey` header when logged into MELCloud with 'English' and 'Remember me'. +Configuration is also possible through `configuration.yaml`. The token can be found from `X-MitsContextKey` header when logged into MELCloud. The language needs to be set to English and the "Remember me" option needs to be selected. ```yaml melcloud: + username: xxxx@xxxxxxx token: xxxxxxxxxxxxxxxxxxx ``` {% configuration %} +username: + description: Email address used to login to MELCloud + required: true + type: string token: description: X-MitsContextKey access token required: true From 718eaf2f0f027e54f39485aac50a632952174d02 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:55:25 +0200 Subject: [PATCH 09/12] Clarify configuration.yaml setup, vol 2 --- source/_integrations/melcloud.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 3dd8b9c30fd1..9d3deebb455f 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -26,7 +26,7 @@ The integration should be configured through the user interface ("Configurations The stored access token can later be updated by adding the MELCloud integration again with the same email address. -Configuration is also possible through `configuration.yaml`. The token can be found from `X-MitsContextKey` header when logged into MELCloud. The language needs to be set to English and the "Remember me" option needs to be selected. +Configuration is also possible through `configuration.yaml`. The required authentication token can be found in `X-MitsContextKey` header when logged into the MELCloud. The language needs to be set to English and the "Remember me" option needs to be selected. ```yaml melcloud: From f677b18e9de2ab4dbdefcdd5af70e052c6a7dbb6 Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:56:55 +0200 Subject: [PATCH 10/12] Clarify token refresh --- source/_integrations/melcloud.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 9d3deebb455f..e4af12a6914c 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -24,7 +24,8 @@ The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://w The integration should be configured through the user interface ("Configurations -> Integrations") using the MELCloud login details. While not optimal, **the provided password is not stored**. -The stored access token can later be updated by adding the MELCloud integration again with the same email address. + +An expired token needs to be updated manually by adding the MELCloud integration again with the same email address. Configuration is also possible through `configuration.yaml`. The required authentication token can be found in `X-MitsContextKey` header when logged into the MELCloud. The language needs to be set to English and the "Remember me" option needs to be selected. From 2a8699f0faa918116f6433caafad9c9c2f6546eb Mon Sep 17 00:00:00 2001 From: Vilppu Vuorinen Date: Tue, 11 Feb 2020 07:58:05 +0200 Subject: [PATCH 11/12] Try to clarify the power control --- source/_integrations/melcloud.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index e4af12a6914c..203c337ef34d 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -54,8 +54,9 @@ Air-to-Air heat pump provides `climate` and `sensor` platforms. The following parameters can be controlled for the `climate` platform entities: +- Power (using HVAC mode) - Target temperature -- Operation mode (HVAC mode) with emulated power off. +- Operation mode (HVAC mode) - Fan speed ### Sensor From df33858436e06ce984e98f728c701039e879cf4a Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 11 Feb 2020 11:56:39 +0100 Subject: [PATCH 12/12] Update melcloud.markdown --- source/_integrations/melcloud.markdown | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/_integrations/melcloud.markdown b/source/_integrations/melcloud.markdown index 203c337ef34d..f88eaea2f9ff 100644 --- a/source/_integrations/melcloud.markdown +++ b/source/_integrations/melcloud.markdown @@ -15,7 +15,7 @@ The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://w ## Device support -- Air-to-Air heat pumps, e.g. AC units - **Supported** +- Air-to-Air heat pumps, e.g., AC units - **Supported** - Air-to-Water heat pumps - **Work in progress** - Energy recovery ventilators - **Not supported** - Other - **Not supported** @@ -24,7 +24,6 @@ The `melcloud` integration integrates Mitsubishi Electric's [MELCloud](https://w The integration should be configured through the user interface ("Configurations -> Integrations") using the MELCloud login details. While not optimal, **the provided password is not stored**. - An expired token needs to be updated manually by adding the MELCloud integration again with the same email address. Configuration is also possible through `configuration.yaml`. The required authentication token can be found in `X-MitsContextKey` header when logged into the MELCloud. The language needs to be set to English and the "Remember me" option needs to be selected. @@ -48,7 +47,7 @@ token: ## Air-to-Air device -Air-to-Air heat pump provides `climate` and `sensor` platforms. +An Air-to-Air heat pump provides `climate` and `sensor` platforms. ### Climate @@ -64,4 +63,4 @@ The following parameters can be controlled for the `climate` platform entities: The following attributes are available for `sensor` platform entities: - Room temperature -- Energy - total consumed energy in kWh. +- Energy - The total consumed energy in kWh.