[climate] Migrate honeywell docs for climate-1.0 (#9816)

* initial commit

* initial commit 2
This commit is contained in:
David Bonnes 2019-07-09 18:03:26 +01:00 committed by Franck Nijhof
parent bcbff78a40
commit 567f16a538

View File

@ -16,34 +16,37 @@ redirect_from:
- /components/climate.honeywell/ - /components/climate.honeywell/
--- ---
The `honeywell` climate platform lets you control Honeywell TCC (Total Connect Comfort) climate systems from Home Assistant. It does not integrate with Honeywell TCC alarm systems. The `honeywell` climate platform integrates Home Assistant with _US-based_ [Honeywell Total Connect Comfort (TCC)](https://mytotalconnectcomfort.com/portal/]) climate systems.
It does not support the home security functionality of TCC.
It uses the [somecomfort](https://github.com/kk7ds/somecomfort) client library.
<p class='note'> <p class='note'>
There is some potential confusion over this integration because it is currently implemented as a combination of two _distinct_ climate systems, one being US-based, the other is EU-based. There is some potential confusion over this integration because it was previously implemented as a combination of two _distinct_ climate systems, one being US-based, the other EU-based.
These two regions are _not_ interchangeable, so you must be clear which applies to your climate system. These two regions are _not_ interchangeable, and the `eu` region is now deprecated. Ongoing support for such systems is available via the [evohome](/components/evohome/) integration.
</p> </p>
## US-based Systems ### US-based Systems
These systems are based in North America, and temperatures are usually in Fahrenheit. They would likely be HVAC systems. They always use the [somecomfort](https://github.com/kk7ds/somecomfort) client library. In this integration, this is called the `us` region. These systems are based in North America, and temperatures are usually in Fahrenheit. They would likely be HVAC systems. They always use the [somecomfort](https://github.com/kk7ds/somecomfort) client library. In this integration, this is called the `us` region.
If your system is US-based, then you can access your system via [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/) (note the `/portal/`). If your system is US-based, then you can access your system via [https://mytotalconnectcomfort.com/portal/](https://mytotalconnectcomfort.com/portal/) (note the `/portal/`).
## EU-based Systems ### EU-based Systems
These systems are based in Europe (including the UK & Ireland), and temperatures are usually in Celsius. They would likely be heating-only systems. They always use the [evohome-client](https://github.com/watchforstock/evohome-client) client library. In this integration, this is called the `eu` region. These systems are based in Europe (including the UK & Ireland), and temperatures are usually in Celsius. They would likely be heating-only systems. They always use the [evohome-client](https://github.com/watchforstock/evohome-client) client library. In this integration, this is called the `eu` region.
If your system is US-based, then you can access it via [https://international.mytotalconnectcomfort.com/](https://international.mytotalconnectcomfort.com/) (note the `international`). If your system is EU-based, then you can access it via [https://international.mytotalconnectcomfort.com/](https://international.mytotalconnectcomfort.com/) (note the `international`).
The `eu` region is soon to be deprecated, and ongoing support for such systems is available via the [evohome](/components/evohome/) integration.
## Configuration ## Configuration
To set up this integration, first confirm your region, then add the following information to your **configuration.yaml** file (the below example is for US-based systems): To set up this integration, add the following to the `climate:` section of your **configuration.yaml** file:
```yaml ```yaml
climate: climate:
# Example configuration.yaml entry
- platform: honeywell - platform: honeywell
username: YOUR_USERNAME username: YOUR_USERNAME
password: YOUR_PASSWORD password: YOUR_PASSWORD
@ -60,22 +63,17 @@ password:
required: true required: true
type: string type: string
region: region:
description: Region identifier, either 'eu' or 'us'. description: Region identifier.
required: false required: true
default: eu default: us
type: string type: string
away_temperature:
description: "(*only for the EU region*) Heating setpoint when away mode is on, in degrees Celsius."
required: false
default: 16.0
type: float
away_cool_temperature: away_cool_temperature:
description: "(*only for the US region*) Cooling setpoint when away mode is on, in degrees Fahrenheit." description: "Cooling setpoint when away mode is on, in degrees Fahrenheit."
required: false required: false
default: 88 default: 88
type: integer type: integer
away_heat_temperature: away_heat_temperature:
description: "(*only for the US region*) Heating setpoint when away mode is on, in degrees Fahrenheit." description: "Heating setpoint when away mode is on, in degrees Fahrenheit."
required: false required: false
default: 61 default: 61
type: integer type: integer