From 36c0d324ff6bfccc06c910f7b051fbee68b41d09 Mon Sep 17 00:00:00 2001 From: David Bonnes Date: Mon, 10 Sep 2018 22:47:49 +0100 Subject: [PATCH 1/7] First version of a basic documentation page --- source/_components/climate.evohome.markdown | 39 +++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 source/_components/climate.evohome.markdown diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown new file mode 100644 index 00000000000..5f770c1e8b0 --- /dev/null +++ b/source/_components/climate.evohome.markdown @@ -0,0 +1,39 @@ +--- +layout: page +title: "Honeywell evohome Controller" +description: "Instructions on how to integrate a Honeywell evohome controllers within Home Assistant." +date: 2018-09-10 12:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: honeywell.png +ha_category: Climate +ha_release: TBA (post 0.78) +ha_iot_class: "Cloud Polling" +--- + +The `evohome` climate platform lets you control EU-based [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW controllers from Home Assistant. + +It uses the [evohomeclient](https://pypi.org/project/evohomeclient/) client library. Currently, Heating zones, and DHW controllers are not supported (they will be added at a later time). + +To set it up, add the following information to your `configuration.yaml` file: + +```yaml +evohome: + - username: YOUR_USERNAME + password: YOUR_PASSWORD + scan_interval: 180 +``` +

+Having a scan_interval to short may result in too-frequent polling and cause you to rate-limited by Honeywell. +

+ +Configuration variables: + +- **username** (*Required*): The username (email address). +- **password** (*Required*): The password. +- **scan_interval** (*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 180 seconds. +- **location_idx** (*Optional*): The location to use if the account hass access to more than one location. You cannot have multiple locations active at the one time. +- **away_temp** (*Optional*): Heating setpoint when Away mode is on. Defaults to 5.0 deg C. +- **off_temp** (*Optional*): Cooling setpoint when away mode is on. Defaults to 15.0 deg C. From 9bb0abfbcffa1de9956fe976be2ed1ff98adee60 Mon Sep 17 00:00:00 2001 From: David Bonnes Date: Mon, 10 Sep 2018 22:50:58 +0100 Subject: [PATCH 2/7] Better title for page --- source/_components/climate.evohome.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index 5f770c1e8b0..5ecedc92efd 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -1,6 +1,6 @@ --- layout: page -title: "Honeywell evohome Controller" +title: "Honeywell evohome CH/DHW Controller" description: "Instructions on how to integrate a Honeywell evohome controllers within Home Assistant." date: 2018-09-10 12:00 sidebar: true From 23585d700fceed71d7af410d13ce060dabe1fa10 Mon Sep 17 00:00:00 2001 From: David Bonnes Date: Mon, 10 Sep 2018 23:32:04 +0100 Subject: [PATCH 3/7] Raise standards of docs --- source/_components/climate.evohome.markdown | 34 ++++++++++++++------- 1 file changed, 23 insertions(+), 11 deletions(-) diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index 5f770c1e8b0..7a1e6ee8a27 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -1,7 +1,7 @@ --- layout: page title: "Honeywell evohome Controller" -description: "Instructions on how to integrate a Honeywell evohome controllers within Home Assistant." +description: "Instructions on how to setup the Honeywell evohome component in Home Assistant." date: 2018-09-10 12:00 sidebar: true comments: false @@ -15,25 +15,37 @@ ha_iot_class: "Cloud Polling" The `evohome` climate platform lets you control EU-based [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW controllers from Home Assistant. -It uses the [evohomeclient](https://pypi.org/project/evohomeclient/) client library. Currently, Heating zones, and DHW controllers are not supported (they will be added at a later time). +It uses the [evohomeclient](https://pypi.org/project/evohomeclient/) client library. Currently, Heating zones and DHW controllers are not supported (they will be added at a later time). -To set it up, add the following information to your `configuration.yaml` file: +## {% linkable_title Configuration %} + +To use this component in your installation, add the following to your `configuration.yaml` file: ```yaml +# Example configuration.yaml entry evohome: - username: YOUR_USERNAME password: YOUR_PASSWORD - scan_interval: 180 + scan_interval: 300 ```

Having a scan_interval to short may result in too-frequent polling and cause you to rate-limited by Honeywell.

-Configuration variables: +### {% linkable_title Configuration variables %} -- **username** (*Required*): The username (email address). -- **password** (*Required*): The password. -- **scan_interval** (*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 180 seconds. -- **location_idx** (*Optional*): The location to use if the account hass access to more than one location. You cannot have multiple locations active at the one time. -- **away_temp** (*Optional*): Heating setpoint when Away mode is on. Defaults to 5.0 deg C. -- **off_temp** (*Optional*): Cooling setpoint when away mode is on. Defaults to 15.0 deg C. +{% configuration %} +username: + description: The username (email address) that has access to [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) web site. + required: true + type: string +password: + description: The password corresponding to the above username. + required: true + type: string +scan_interval: + description: How often the web site is polled for data, in seconds. It is rounded up to nearest minute, and the minimum value is 180. The recommended value is 300. + required: false + type: int + default: 180 +{% endconfiguration %} From 2aaf73c54820e09b0cda8830859762766dfbd6f5 Mon Sep 17 00:00:00 2001 From: David Bonnes Date: Mon, 10 Sep 2018 23:33:25 +0100 Subject: [PATCH 4/7] evohome is a hub as well as a device --- source/_components/{climate.evohome.markdown => evohome.markdown} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/_components/{climate.evohome.markdown => evohome.markdown} (100%) diff --git a/source/_components/climate.evohome.markdown b/source/_components/evohome.markdown similarity index 100% rename from source/_components/climate.evohome.markdown rename to source/_components/evohome.markdown From 1f8849d42ac0df4abda133f5b1f7677b8ad92042 Mon Sep 17 00:00:00 2001 From: zxdavb Date: Sun, 23 Sep 2018 23:59:41 +0100 Subject: [PATCH 5/7] Update climate.evohome.markdown Tidy up to reflect all the recent changes in the main PR --- source/_components/climate.evohome.markdown | 8 -------- 1 file changed, 8 deletions(-) diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index 5ecedc92efd..a88b33520b0 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -23,17 +23,9 @@ To set it up, add the following information to your `configuration.yaml` file: evohome: - username: YOUR_USERNAME password: YOUR_PASSWORD - scan_interval: 180 ``` -

-Having a scan_interval to short may result in too-frequent polling and cause you to rate-limited by Honeywell. -

- Configuration variables: - **username** (*Required*): The username (email address). - **password** (*Required*): The password. -- **scan_interval** (*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 180 seconds. - **location_idx** (*Optional*): The location to use if the account hass access to more than one location. You cannot have multiple locations active at the one time. -- **away_temp** (*Optional*): Heating setpoint when Away mode is on. Defaults to 5.0 deg C. -- **off_temp** (*Optional*): Cooling setpoint when away mode is on. Defaults to 15.0 deg C. From 3db57a56943eedbd1e34d851aa55c8b0d98aaee0 Mon Sep 17 00:00:00 2001 From: David Bonnes Date: Mon, 24 Sep 2018 17:50:48 +0100 Subject: [PATCH 6/7] remove Oxford comma --- source/_components/climate.evohome.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index a88b33520b0..100b1c20f15 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -15,7 +15,7 @@ ha_iot_class: "Cloud Polling" The `evohome` climate platform lets you control EU-based [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW controllers from Home Assistant. -It uses the [evohomeclient](https://pypi.org/project/evohomeclient/) client library. Currently, Heating zones, and DHW controllers are not supported (they will be added at a later time). +It uses the [evohomeclient](https://pypi.org/project/evohomeclient/) client library. Currently, Heating zones and DHW controllers are not supported (they will be added at a later time). To set it up, add the following information to your `configuration.yaml` file: @@ -29,3 +29,4 @@ Configuration variables: - **username** (*Required*): The username (email address). - **password** (*Required*): The password. - **location_idx** (*Optional*): The location to use if the account hass access to more than one location. You cannot have multiple locations active at the one time. + From 0b4fa1a3a2d6bc93e8efe23b6264ae5bb11883ae Mon Sep 17 00:00:00 2001 From: David Bonnes Date: Thu, 27 Sep 2018 13:03:12 +0100 Subject: [PATCH 7/7] Main PR accepted into 0.80dev) --- source/_components/climate.evohome.markdown | 4 ++-- source/_components/evohome.markdown | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/source/_components/climate.evohome.markdown b/source/_components/climate.evohome.markdown index b8b34d50336..a6c2444f2d6 100644 --- a/source/_components/climate.evohome.markdown +++ b/source/_components/climate.evohome.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: honeywell.png ha_category: Climate -ha_release: TBA (post 0.78) -ha_iot_class: "Cloud Polling" +ha_release: 0.80 +ha_iot_class: "Cloud Polling" --- The `evohome` climate platform integrates your _EU-based_ [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW controller into Home Assistant, enabling control of its operating mode. diff --git a/source/_components/evohome.markdown b/source/_components/evohome.markdown index 58bed6e3304..6a69e5b7413 100644 --- a/source/_components/evohome.markdown +++ b/source/_components/evohome.markdown @@ -9,8 +9,8 @@ sharing: true footer: true logo: honeywell.png ha_category: Hub -ha_release: TBA (post 0.78) -ha_iot_class: "Cloud Polling" +ha_release: 0.80 +ha_iot_class: "Cloud Polling" --- The `evohome` platform is the main component to set up and integrate all supported evohome devices.