-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Doc page for Honeywell evohome CH/DHW controllers #6252
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
36c0d32
First version of a basic documentation page
zxdavb 9bb0abf
Better title for page
zxdavb 23585d7
Raise standards of docs
zxdavb 2aaf73c
evohome is a hub as well as a device
zxdavb 1f8849d
Update climate.evohome.markdown
zxdavb 3db57a5
remove Oxford comma
zxdavb 33c6e28
Merge branch 'next' of https://github.com/home-assistant/home-assista…
zxdavb ab4605b
Merge branch 'next' of https://github.com/home-assistant/home-assista…
zxdavb 759c83f
merge back in
zxdavb 0b4fa1a
Main PR accepted into 0.80dev)
zxdavb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| layout: page | ||
| title: "Honeywell evohome CH/DHW Controller" | ||
| description: "Instructions on how to integrate a Honeywell evohome controller with Home Assistant." | ||
| date: 2018-09-25 12:00 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| logo: honeywell.png | ||
| ha_category: Climate | ||
| 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. | ||
|
|
||
| It is related to the honeywell climate component](/components/climate.honeywell/), which allows limited integration with evohome Heating zones. These two components should be usuable side-by-side, but YMMV. | ||
|
|
||
| The evohome evotouch controller supports seven distict modes: Auto, AutoWithEco, Away, DayOff, HeatingOff, and Custom; AutoWithReset is a 7th, hidden, mode. | ||
|
|
||
| Currently, only the standard HA operating modes are supported: 'Eco' (AutoWithEco), and 'Off' (HeatingOff), and 'Auto' (all other evohome modes). 'Away' (Away) mode is supported separately. | ||
|
|
||
| The actual operating modes are tracked/reported via `device_state_attributes`. | ||
|
|
||
| <p class='note'> | ||
| Full configuration details can be found on the main [evohome component](/components/evohome/) page. | ||
| </p> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| layout: page | ||
| title: "Honeywell evohome" | ||
| description: "Instructions on how to integrate Honeywell evohome devices with Home Assistant." | ||
| date: 2018-09-25 12:00 | ||
| sidebar: true | ||
| comments: false | ||
| sharing: true | ||
| footer: true | ||
| logo: honeywell.png | ||
| ha_category: Hub | ||
| 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. | ||
|
|
||
| It uses the [evohomeclient](https://pypi.org/project/evohomeclient/) client library and so will let you control (only) _EU-based_ [Honeywell Connect Comfort](https://international.mytotalconnectcomfort.com/Account/Login) systems. | ||
|
|
||
| Currently, only Controllers are supported; support for Heating zones and DHW controllers will be added at a later time. | ||
|
|
||
| It is related to the [honeywell](/components/climate.honeywell/) climate component, which allows limited integration with evohome Heating zones. These two components should be usuable side-by-side, but YMMV. | ||
|
|
||
|
|
||
| ## {% 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 | ||
| location_idx: 0 | ||
| ``` | ||
| This is a IoT cloud-polling device, and the `scan_interval` is currently fixed at 3 minutes. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell. | ||
|
|
||
|
|
||
| ### {% linkable_title Configuration variables %} | ||
|
|
||
| {% 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 | ||
| location_idx: | ||
| description: Used to select which location to use, if your login has access to more than one location. Multiple locations are not supported. | ||
| required: false | ||
| type: int | ||
| default: 0 | ||
| {% endconfiguration %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This page is for the component, so it sounds weird to talk about platform.