First version of a basic documentation page

This commit is contained in:
David Bonnes 2018-09-10 22:47:49 +01:00
parent cbdf2d7b40
commit 36c0d324ff

View File

@ -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
```
<p class='note'>
Having a scan_interval to short may result in too-frequent polling and cause you to rate-limited by Honeywell.
</p>
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.