mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Correct some minor typos (#10675)
* Correct some minor typos
Also provide some additional information and provide consistency with not capitalizing "ecobee" (except in the title)
* ✏️ Tweaks
This commit is contained in:
J
Franck Nijhof
parent
0ca9f96f82
commit
051c09007c
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Ecobee"
|
||||
description: "Instructions for how to integrate Ecobee thermostats and sensors within Home Assistant."
|
||||
description: "Instructions for how to integrate ecobee thermostats and sensors within Home Assistant."
|
||||
logo: ecobee.png
|
||||
ha_category:
|
||||
- Sensor
|
||||
@ -13,11 +13,11 @@ ha_release: 0.9
|
||||
ha_iot_class: Cloud Poll
|
||||
---
|
||||
|
||||
The `ecobee` integration lets you control thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats and remote sensors.
|
||||
The `ecobee` integration lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats.
|
||||
|
||||
## Preliminary Step
|
||||
|
||||
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, first, you need to register your thermostat which should be done as part of the ecobee installation. Once you have done that, perform the following steps.
|
||||
You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this integration. To get the key, you first need to register your thermostat which, should be done as part of the ecobee installation. Once you have done that, perform the following steps.
|
||||
|
||||
1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/).
|
||||
2. Log in with your ecobee credentials.
|
||||
@ -25,7 +25,7 @@ You will need to obtain an API key from ecobee's [developer site](https://www.ec
|
||||
4. Fill in the fields.
|
||||
5. Click **save**.
|
||||
|
||||
Now login to the regular consumer portal and in the hamburger menu, there will be a new option **Developer**. Now we can create an Application to link to Home Assistant.
|
||||
Log in to the regular consumer portal, and click the overflow menu button in the upper right. You will see a new option named **Developer**. Now we can create the Application to hook up to Home Assistant.
|
||||
|
||||
1. Select the **Developer** option from the hamburger menu.
|
||||
2. Select **Create New**.
|
||||
@ -34,15 +34,15 @@ Now login to the regular consumer portal and in the hamburger menu, there will b
|
||||
5. You don't need an Application Icon or Detailed Description.
|
||||
6. Click **Create**.
|
||||
|
||||
Now under the Name and Summary Section, you will have an API key. Copy this key as you will need it in the steps that follow. Click the **X** to close the Developer section.
|
||||
Under the Name and Summary Section, you will now have an API key. Copy this key and use it in your configuration section below. Click the **X** to close the Developer section.
|
||||
|
||||
## Configuring the Integration
|
||||
|
||||
To configure the ecobee integration in Home Assistant, you can either use the **Configuration** -> **Integrations** menu, or add an entry to `configuration.yaml`.
|
||||
To configure the ecobee integration in Home Assistant, you can either use the **Configuration** > **Integrations** menu, or add an entry to `configuration.yaml`.
|
||||
|
||||
### Setup via the Integrations menu
|
||||
|
||||
1. In the **Configuration** -> **Integrations** menu, click **+** and then select `ecobee` from the pop-up menu.
|
||||
1. In the **Configuration** > **Integrations** menu, click **+** and then select `ecobee` from the pop-up menu.
|
||||
2. In the pop-up box, enter the API key you obtained from ecobee.com.
|
||||
3. In the next pop-up box, you will be presented with a unique four-character PIN code which you will need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by logging in, selecting **My Apps** from the hamburger menu, clicking **Add Application** on the left, entering the PIN code from Home Assistant, and clicking **Validate** and then **Add Application** in the bottom right.
|
||||
4. After authorizing the App on ecobee.com, return to Home Assistant and hit **Submit**. If the authorization was successful, a config entry will be created and your thermostats and sensors will be available in Home Assistant.
|
||||
@ -57,11 +57,9 @@ ecobee:
|
||||
api_key: YOUR_API_KEY
|
||||
```
|
||||
|
||||
[Restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. In the **Configuration** -> **Integrations** menu, hit **Configure** next to the discovered `ecobee` entry, and continue to authorize the App per the Integration menu instructions above.
|
||||
|
||||
{% configuration %}
|
||||
api_key:
|
||||
description: Your ecobee API key. This is only needed for the initial setup of the integration. Once registered it can be removed. If you revoke the key in the ecobee portal, you will need to remove the existing `ecobee` configuration in the **Integrations** menu, update this, and then configure the Integration again.
|
||||
description: Your ecobee API key. This is only needed for the initial setup of the integration. Once registered it can be removed. If you revoke the key in the ecobee portal, you will need to remove the existing `ecobee` configuration in the **Integrations** menu, update this, and then configure the integration again.
|
||||
required: false
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
@ -71,9 +69,19 @@ api_key:
|
||||
<img src='{{site_root}}/images/screenshots/ecobee-thermostat-card.png' />
|
||||
</p>
|
||||
|
||||
[Restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. In the **Configuration** -> **Integrations** menu, hit **Configure** next to the discovered `ecobee` entry, and continue to authorize the App per the Integration menu instructions above.
|
||||
|
||||
The first time you (re)run Home Assistant with this integration it will give you a PIN code that you need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by clicking **Add Application** in the **My Apps** section in the sidebar.
|
||||
|
||||
The PIN can be found in the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in the States developer tool.
|
||||
|
||||
- If you do not have an ecobee card, you may be using groups with `default_view` that don't show the card. To get around this, you can temporarily comment out the `default_view` section or add the `configurator.ecobee` integration to your `default_view` and restart Home Assistant.
|
||||
|
||||
Once you enter the PIN on the ecobee site, wait approximately 5 minutes, and then click on the **I have authorized the app** link at the bottom of the ecobee pop-up window. If everything worked correctly, you should now be able to restart Home Assistant again to see the full ecobee card with all of the sensors populated or see the list of sensors in the developer tools. Now you can re-enable your `default_view` (if you had to disable it) and add the ecobee sensors to a group and/or view.
|
||||
|
||||
## Notifications
|
||||
|
||||
To get your Ecobee notifications working with Home Assistant, you must first have the main Ecobee integration loaded and running. Once you have that configured, you can set up this integration to send messages to your Ecobee device.
|
||||
To get your ecobee notifications working with Home Assistant, you must first have the main ecobee integration loaded and running. Once you have that configured, you can set up this integration to send messages to your ecobee device.
|
||||
|
||||
To use this notification platform in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
@ -98,7 +106,7 @@ To use notifications, please see the [getting started with automation page](/get
|
||||
|
||||
### Concepts
|
||||
|
||||
The Ecobee Thermostat supports the following key concepts.
|
||||
The ecobee thermostat supports the following key concepts.
|
||||
|
||||
The _target temperature_ is the temperature that the device attempts
|
||||
to achieve. The target temperature is either determined by the
|
||||
@ -113,7 +121,7 @@ limits).
|
||||
|
||||
A _climate_ is a predefined or user-defined set of presets that the
|
||||
thermostat aims to achieve. The ecobee thermostat provides three predefined
|
||||
climates: Home, Away, and Sleep. The user can define additional climates.
|
||||
climates: Home, Away, and Sleep. Ecobee refers to these as _comfort settings_. The user can define additional climates.
|
||||
|
||||
A _preset_ is an override of the target temperature defined in the
|
||||
currently active climate. The temperature targeted in the preset mode may be
|
||||
@ -122,30 +130,30 @@ climate (home, away, sleep, etc.), or it may be derived from a vacation
|
||||
defined by the thermostat. All holds are temporary. Temperature and
|
||||
climate holds expire when the thermostat transitions to the next climate
|
||||
defined in its program. A vacation hold starts at the beginning of the
|
||||
defined vacation period, and expires when the vacation period ends.
|
||||
defined vacation period and expires when the vacation period ends.
|
||||
|
||||
When in _away preset_, the target temperature is permanently overridden by
|
||||
the target temperature defined for the away climate. The away preset is a
|
||||
simple way to emulate a vacation mode.
|
||||
|
||||
The _HVAC mode_ of the device is the currently active operational
|
||||
modes that the Ecobee thermostat provides: heat, auxHeatOnly, cool,
|
||||
modes that the ecobee thermostat provides: heat, auxHeatOnly, cool,
|
||||
auto, and off.
|
||||
|
||||
## Attributes
|
||||
|
||||
The Ecobee climate entity has some extra attributes to represent the state of the thermostat.
|
||||
The ecobee climate entity has some extra attributes to represent the state of the thermostat.
|
||||
|
||||
| Name | Description |
|
||||
| ------------------- | ------------------------------------------------------------------------------------- |
|
||||
| `fan` | If the fan is currently on or off: `on` / `off`. |
|
||||
| `climate_mode` | This is the climate mode that is active, or would be active if no override is active. |
|
||||
| `equipment_running` | This is a comma seperated list of equipment that is currently running. |
|
||||
| `fan_min_on_time` | The minimum amount of minutes that the fan will be on when it's turned on. |
|
||||
| Name | Description |
|
||||
| ---- | ----------- |
|
||||
| `fan` | If the fan is currently on or off: `on` / `off`.
|
||||
| `climate_mode` | This is the climate mode that is active, or would be active if no override is active.
|
||||
| `equipment_running` | This is a comma-separated list of equipment that is currently running.
|
||||
| `fan_min_on_time` | The minimum amount of time (in minutes) that the fan will run per hour. This is determined by the minimum fan runtime setting which can be changed in the ecobee app or on the thermostat itself.
|
||||
|
||||
## Services
|
||||
|
||||
Besides the standard services provided by the Home Assistant [Climate](/integrations/climate/) integration, the following extra services are provided by the Ecobee integration:
|
||||
Besides the standard services provided by the Home Assistant [Climate](/integrations/climate/) integration, the following extra services are provided by the ecobee integration:
|
||||
|
||||
- `ecobee.create_vacation`
|
||||
- `ecobee.delete_vacation`
|
||||
@ -159,7 +167,7 @@ Creates a vacation on the selected ecobee thermostat.
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | no | ecobee thermostat on which to create the vacation |
|
||||
| `vacation_name` | no | Name of the vacation to create; must be unique on the thermostat |
|
||||
| `vacation_name` | no | Name of the vacation to create. Must be unique on the thermostat |
|
||||
| `cool_temp` | no | Cooling temperature during the vacation |
|
||||
| `heat_temp` | no | Heating temperature during the vacation |
|
||||
| `start_date` | yes | Date the vacation starts in YYYY-MM-DD format |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user