mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-07 17:36:50 +00:00
Correct Evohome integration docs (#12017)
* initial commit * small fixes * small fixes 2 * small fixes 3 * latest tweaks * samples * tidy up * tidy up * small fixes * small fixes 2 * small fixes 3 * small fixes 4 * small fixes 5 * Update source/_integrations/evohome.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/_integrations/evohome.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/_integrations/evohome.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/_integrations/evohome.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/_integrations/evohome.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Update source/_integrations/evohome.markdown Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * more tweaks Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
David Bonnes
GitHub
parent
e655105145
commit
ea87bd76d9
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Honeywell Total Connect Comfort (Europe)
|
||||
description: Instructions on how to integrate a Honeywell evohome/TCC system with Home Assistant.
|
||||
description: Instructions on how to integrate a Honeywell Evohome/TCC system with Home Assistant.
|
||||
logo: honeywell.png
|
||||
ha_category:
|
||||
- Hub
|
||||
@ -14,31 +14,18 @@ ha_codeowners:
|
||||
|
||||
The `evohome` integration links Home Assistant with all _non-US_ [Honeywell Total Connect Comfort (TCC)](https://international.mytotalconnectcomfort.com/Account/Login) CH/DHW systems, such as:
|
||||
|
||||
- the Honeywell evohome CH/DHW system, and
|
||||
- the Honeywell Round Thermostat
|
||||
- the Honeywell Mobile Access Kit
|
||||
- the Honeywell Evohome CH/DHW system, and
|
||||
- the Honeywell Mobile Access Kit with a Round Thermostat
|
||||
|
||||
It does not support the home security functionality of TCC.
|
||||
|
||||
It uses the [evohome-async](https://github.com/zxdavb/evohome-async) client library.
|
||||
|
||||
If your system is compatible with this integration, then you will be able to access it via [https://international.mytotalconnectcomfort.com/](https://international.mytotalconnectcomfort.com/) (note the `international`).
|
||||
|
||||
### Evohome
|
||||
|
||||
Evohome is a multi-zone system. Each zone is represented as a **Climate** entity: it will expose the zone's operating mode, temperature and setpoint.
|
||||
|
||||
The location (controller) is also represented as a **Climate** entity: it will expose the location's operating mode (see below for details). Note that the entity's current temperature is calculated as an average of all the Zones.
|
||||
|
||||
The DHW controller is represented as a **WaterHeater** entity: It will report its current temperature, and it can be turned on or off. The setpoint is not reported, and cannot cannot be changed.
|
||||
|
||||
### Round Thermostat
|
||||
|
||||
Such systems usually have only one Round Thermostat, although they can have two. Systems with one such thermostat are merged into a single **Climate** entity. Systems with two thermostats will have a 3rd entity for the TCC locations, much like evohome, above.
|
||||
For your system to be compatible with this integration, then you must be able to access it via [https://international.mytotalconnectcomfort.com/](https://international.mytotalconnectcomfort.com/) (note the 'international').
|
||||
|
||||
## Configuration
|
||||
|
||||
To set up this integration, add the following to your **configuration.yaml** file:
|
||||
To set up this integration, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
@ -49,7 +36,7 @@ evohome:
|
||||
|
||||
{% configuration %}
|
||||
username:
|
||||
description: The username (email address) that has access to [Honeywell TCC](https://international.mytotalconnectcomfort.com/Account/Login) web site.
|
||||
description: The username (email address) that has access to the [TCC](https://international.mytotalconnectcomfort.com/Account/Login) web site.
|
||||
required: true
|
||||
type: string
|
||||
password:
|
||||
@ -62,51 +49,134 @@ location_idx:
|
||||
type: integer
|
||||
default: 0
|
||||
scan_interval:
|
||||
description: How often updates are retrieved from Honeywell's web servers. The minimum value is 60 seconds.
|
||||
description: How often updates are retrieved from the vendor's web servers. The minimum interval is 60 seconds.
|
||||
required: false
|
||||
type: integer
|
||||
default: 300
|
||||
{% endconfiguration %}
|
||||
|
||||
This is an IoT cloud-polling integration, and the recommended `scan_interval` is 180 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by Honeywell.
|
||||
This is an IoT cloud-polling integration and the recommended minimum `scan_interval` is 180 seconds. Testing has indicated that this is a safe interval that - by itself - shouldn't cause you to be rate-limited by the vendor. There is little value in shorter intervals, as this integration will automatically force a refresh shortly after any configuration changes.
|
||||
|
||||
## Locations and Zones
|
||||
|
||||
TCC systems are implemented as a _location_, which consist of 1-12 _zones_ and, optionally, a DHW controller:
|
||||
|
||||
- The system location (e.g., a house) is used for operating modes such as home, away, economy, etc.
|
||||
- Heating zones (e.g., rooms) are used for the target temperature.
|
||||
|
||||
### Evohome
|
||||
|
||||
Each zone is represented as a **Climate** entity which will expose the zone's operating mode, current temperature and setpoint.
|
||||
|
||||
The Evohome location (controller) is also represented as a **Climate** entity that will expose the location's operating mode. Locations have neither a current temperature nor a setpoint, but as all **Climate** entities are required by Home Assistant to report a temperature, this is calculated as the average of all the zones.
|
||||
|
||||
The DHW controller is represented as a **WaterHeater** entity which will report its current temperature and can be turned on or off. Due to limitations with the vendor's RESTful API, the setpoint is not reported and cannot be changed.
|
||||
|
||||
Note that there is limited support for schedules: they cannot be changed and there is no facility to backup/restore that data (see [here](https://evohome.readthedocs.io/en/latest/) for such functionality).
|
||||
|
||||
### Round Thermostat
|
||||
|
||||
These systems use an internet gateway rather than an Evohome controller. They usually have only one Round Thermostat, although they can have two. Systems with one such thermostat will still appear as two **Climate** entities, one for location mode (away, economy, etc.), and another for the zone setpoint.
|
||||
|
||||
## Temperature Precision
|
||||
|
||||
Note that TCC devices may well measure temperatures with very high precision, but the vendor API will report temperatures rounded _towards_ the setpoint (i.e. either up or down) with a precision of 0.5 °C; this a proxy for the deadband as used by other climate systems. Where possible, this integration will leverage an older vendor API to obtain current temperatures with a precision of 0.01 °C.
|
||||
|
||||
Therefore, depending upon the above, Home Assistant will display/record current temperatures with a precision of either 0.5 °C or 0.1 °C (it's highest supported precision).
|
||||
|
||||
## System modes, Zone overrides and Inheritance
|
||||
|
||||
Evohome locations support up to six distinct operating modes: **Auto**, **AutoWithEco**, **Away**, **DayOff**, **HeatingOff**, and **Custom**. Not all evohome systems support all modes.
|
||||
TCC locations can support up to six distinct operating modes: **Auto**, **AutoWithEco**, **Away**, **DayOff**, **HeatingOff**, and **Custom**. Not all systems support all modes.
|
||||
|
||||
Zones support three setpoint modes: **FollowSchedule**, **TemporaryOverride**, and **PermanentOverride** but 'inherit' an operating mode from their location (the actual algorithm for this is a little more complicated than indicated below - please see your vendor's documentation).
|
||||
Zones support three setpoint modes: **FollowSchedule**, **TemporaryOverride**, and **PermanentOverride** but 'inherit' an operating mode from their location (the actual algorithm for this is a little more complicated than indicated below - please see the vendor's documentation).
|
||||
|
||||
For **FollowSchedule**, a zone's `temperature` (target temperature, a.k.a setpoint) is a function of its scheduled temperature and its inherited mode. For example, **AutoWithEco** would be scheduled temperature less 3C.
|
||||
For **FollowSchedule**, a zone's `setpoint` (target temperature) is a function of its scheduled target temperature and its inherited mode:
|
||||
|
||||
If the location is set to **HeatingOff** (temperature set to a minimum) or **Away** (temperature set to 12C), then the zones will inherit that setpoint regardless of their own mode. For **Away**, the DHW controller will also be turned off.
|
||||
- **Auto** setpoints are scheduled temperatures (the default)
|
||||
- **AutoWithEco** setpoints are scheduled temperatures, less 3 °C
|
||||
|
||||
If the zone's temperature is changed, then it will be a **TemporaryOverride** that will revert to **FollowSchedule** at the next scheduled setpoint (or in an hour, if there is no such schedule). Zones can be switched between the two override modes without changing the target temperature.
|
||||
If the zone's target temperature is changed then it will either be a **TemporaryOverride** or a **PermanentOverride**, depending. A **TemporaryOverride** will revert to **FollowSchedule** after some specified time. A **PermanentOverride** is a permanent change until some subsequent intervention is made. Zones can be switched between the two override modes without changing the target temperature.
|
||||
|
||||
For some location modes all zones will have a setpoint enforced upon them, regardless of their own mode:
|
||||
|
||||
- **Away** setpoints to 12 °C
|
||||
- **HeatingOff** setpoints to a minimum, usually 4 °C
|
||||
|
||||
For **Away**, the DHW controller will also be turned off.
|
||||
|
||||
Some locations have a hidden mode, **AutoWithReset**, that will behave as **Auto**, and will reset all zones to **FollowSchedule**.
|
||||
|
||||
In Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `systemModeStatus` and `setpointStatus`, below).
|
||||
In the Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `system_mode_status` and `setpoint_status`, below).
|
||||
|
||||
## Service Calls
|
||||
|
||||
This integration provide service calls to expose the full functionality of evohome beyond the limitations of Home Assistant's standardised schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
|
||||
This integration provides its own service calls to expose the full functionality of TCC systems beyond the limitations of Home Assistant's standardised schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
|
||||
|
||||
It is recommended to use the native service calls (e.g., `evohome.set_system_mode`) instead of Home Assistant's generic equivalents (e.g., `climate.set_hvac_mode`) whenever possible. However, it may be necessary to use the generic service calls for integration with 3rd party systems such as Amazon Alexa or Google Home.
|
||||
|
||||
### evohome.set_system_mode
|
||||
|
||||
This service call is used to set the system `mode`, either indefinitely, or for a set period of time, after which it will revert to **Auto** mode.
|
||||
This service call will set the operating `mode` of the system for a specified period of time, after which it will revert to **Auto**. However, if no period of time is provided, then the change is permanent.
|
||||
|
||||
For some modes, such as **Away**, the duration is in `days`, where 1 day will revert after midnight, and 2 days reverts at midnight tomorrow. For other modes, such as **AutoWithEco**, the duration is in `hours`.
|
||||
For **AutoWithEco**, the period of time is a `duration` is up to 24 hours.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- action:
|
||||
- service: evohome.set_system_mode
|
||||
data:
|
||||
mode: AutoWithEco
|
||||
duration: {hours: 1, minutes: 30}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
For the other modes, such as **Away**, the duration is a `period` of days, where 1 day will revert at midnight tonight, and 2 days reverts at midnight tomorrow.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- action:
|
||||
- service: evohome.set_system_mode
|
||||
data:
|
||||
mode: Away
|
||||
period: {days: 30}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### evohome.reset_system
|
||||
|
||||
This service call is used to set the system to **AutoWithReset**, and reset all the zones to **FollowSchedule**.
|
||||
This service call will set the operating mode of the system to **AutoWithReset**, and reset all the zones to **FollowSchedule**.
|
||||
|
||||
Not all systems support this feature.
|
||||
|
||||
### evohome.refresh_system
|
||||
|
||||
This service call is used to pull the latest state data from the vendor's servers.
|
||||
This service call will immediately pull the latest state data from the vendor's servers rather than waiting for the next `scan_interval`.
|
||||
|
||||
### evohome.set_zone_override
|
||||
|
||||
This service call is used to set the `temperature` of a zone as identified by its `entity_id`. This change can either be indefinite, or for a set period of time, after which it will revert to **FollowSchedule**. The duration can be in `minutes` from the current time, or `until` a specified time within the next 24 hours.
|
||||
This service call will set the `setpoint` of a zone, as identified by its `entity_id`, for a specified period of time (**TemporaryOverride**). However, if no period of time is provided (c.f. a duration of 0, below), then the change is permanent (**PermanentOverride**).
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- action:
|
||||
- service: evohome.set_zone_override
|
||||
data:
|
||||
entity_id: climate.loungeroom
|
||||
setpoint: 10
|
||||
```
|
||||
|
||||
The `duration` can be up to 24 hours, after which the zone mode will revert to schedule (**FollowSchedule**). If the `duration` is 0 hours, then the change will be until the next setpoint.
|
||||
|
||||
{% raw %}
|
||||
```yaml
|
||||
- action:
|
||||
- service: evohome.set_zone_override
|
||||
data:
|
||||
entity_id: climate.loungeroom
|
||||
setpoint: 10
|
||||
duration: {minutes: 0}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
### evohome.clear_zone_override
|
||||
|
||||
@ -114,7 +184,7 @@ This service call is used to set a zone, as identified by its `entity_id`, to **
|
||||
|
||||
## Useful Jinja Templates
|
||||
|
||||
The actual operating mode of evohome entities can be tracked via their state attributes, which includes a JSON data structure for the current state called `status`.
|
||||
The actual operating mode of Evohome entities can be tracked via their state attributes, which includes a JSON data structure for the current state called `status`.
|
||||
|
||||
For the location (controller), see `system_mode_status`:
|
||||
|
||||
@ -128,7 +198,7 @@ For the location (controller), see `system_mode_status`:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
For the Zones, it is `setpointStatus`:
|
||||
For the Zones, it is `setpoint_status`:
|
||||
|
||||
{% raw %}
|
||||
```text
|
||||
@ -144,7 +214,7 @@ The Zones will expose the current/upcoming scheduled `setpoints`:
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
All evohome entities may have faults, and these can be turned into sensors, or:
|
||||
All Evohome entities may have faults, and these can be turned into sensors, or:
|
||||
|
||||
{% raw %}
|
||||
```text
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user