Raise standards of docs

This commit is contained in:
David Bonnes 2018-09-10 23:32:04 +01:00
parent 36c0d324ff
commit 23585d700f

View File

@ -1,7 +1,7 @@
--- ---
layout: page layout: page
title: "Honeywell evohome Controller" 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 date: 2018-09-10 12:00
sidebar: true sidebar: true
comments: false 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. 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 ```yaml
# Example configuration.yaml entry
evohome: evohome:
- username: YOUR_USERNAME - username: YOUR_USERNAME
password: YOUR_PASSWORD password: YOUR_PASSWORD
scan_interval: 180 scan_interval: 300
``` ```
<p class='note'> <p class='note'>
Having a scan_interval to short may result in too-frequent polling and cause you to rate-limited by Honeywell. Having a scan_interval to short may result in too-frequent polling and cause you to rate-limited by Honeywell.
</p> </p>
Configuration variables: ### {% linkable_title Configuration variables %}
- **username** (*Required*): The username (email address). {% configuration %}
- **password** (*Required*): The password. username:
- **scan_interval** (*Optional*): Scan interval is expressed in seconds. Recommended value of 600 seconds. Default value is 180 seconds. description: The username (email address) that has access to [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) web site.
- **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. required: true
- **away_temp** (*Optional*): Heating setpoint when Away mode is on. Defaults to 5.0 deg C. type: string
- **off_temp** (*Optional*): Cooling setpoint when away mode is on. Defaults to 15.0 deg C. 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 %}