From ceeeee99c6cc3c355acabcaf074bbdddf0678ba7 Mon Sep 17 00:00:00 2001 From: Mark Coombes Date: Sun, 22 Sep 2019 17:06:18 -0400 Subject: [PATCH 1/6] Change to Cloud Poll --- source/_components/ecobee.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 2f02b20e83d1..ab7ba931940d 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -10,7 +10,7 @@ ha_category: - Weather featured: true ha_release: 0.9 -ha_iot_class: Cloud Push +ha_iot_class: Cloud Poll redirect_from: - /components/sensor.ecobee/ - /components/binary_sensor.ecobee/ From 5a5acdba71958d9613ae7bc323ac881bd2de6190 Mon Sep 17 00:00:00 2001 From: Mark Coombes Date: Sun, 22 Sep 2019 17:27:24 -0400 Subject: [PATCH 2/6] Update ecobee.markdown Changes required to documentation as a result of addition of config flow to ecobee. --- source/_components/ecobee.markdown | 43 ++++++++++++++++-------------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index ab7ba931940d..bc03b358fdf9 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -19,11 +19,11 @@ redirect_from: - /components/weather.ecobee/ --- -The `ecobee` integration lets you control a thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats. +The `ecobee` integration lets you control thermostats and view sensor data from [ecobee](https://ecobee.com) thermostats and remote sensors. -## Configuration +## Preliminary Step -You will need to obtain an API key from ecobee's [developer site](https://www.ecobee.com/developers/) to use this component. 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, 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. 1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/). 2. Login with your ecobee credentials. @@ -31,18 +31,31 @@ 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 the Application to hook up to Home Assistant. +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. 1. Select the Developer option. 2. Select **Create New**. -3. Give your app a name (it appears to need to be unique across all users, as I tried 'home-assistant' and it said it was already in use. Try -home-assistant) and a summary (neither of these are important as they are not used anywhere). +3. Give your app a name (it must be unique across all ecobee users; try -home-assistant) and a summary (neither of these are important as they are not used anywhere in Home Assistant). 4. For Authorization method select **ecobee PIN**. 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 and use it in you configuration section below. Click the **X** to close the Developer section. +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. -To add the Ecobee integration to Home Assistant, add the following information to your [`configuration.yaml`](/docs/configuration/) file: +## Configuring the Integration + +To configure the ecobee integration in Home Assistant, you 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. +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, then clicking **Add Application** and entering the PIN code from Home Assistant when prompted. +4. After authorizing the App on ecobee.com, return to Home Assistant and hit **Submit**. If authorization was successful, a config entry will be created and your thermostats and sensors will be available in Home Assistant. + +### Setup via configuration.yaml + +If you prefer to initially set up this integration in [`configuration.yaml`](/docs/configuration/), you may do so by adding your API key (and optional parameters) as follows: ```yaml # Example configuration.yaml entry @@ -50,20 +63,12 @@ ecobee: api_key: YOUR_API_KEY ``` -[Restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. - -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 from the Home Assistant portal on the Ecobee card or from the **configurator.ecobee** entity in states in the portal. - -- 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. +[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 component. Once registered it can be removed. If you revoke the key in the ecobee portal you will need to update this again and remove the ecobee.conf file in the `.homeassistant` configuration path. - required: true + 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 hold_temp: description: Whether or not to hold changes indefinitely (`true`) or until the next scheduled event. @@ -77,8 +82,6 @@ hold_temp:

-If for whatever reason you delete and re-create your ecobee app at ecobee.com such that your developer API key changes, you will need to delete your `/conf/ecobee.conf file`. You will also need to update the `api_key:` in the `configuration.yaml` or `secrets.yaml` file. - ## 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 setup this integration to send messages to your Ecobee device. From 771103e523fcff5e51775fb82444460f0e6c9004 Mon Sep 17 00:00:00 2001 From: Mark Coombes Date: Mon, 23 Sep 2019 09:51:26 -0400 Subject: [PATCH 3/6] Finish documentation clean up --- source/_components/ecobee.markdown | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index bc03b358fdf9..b7ae2d7d4efd 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -33,9 +33,9 @@ You will need to obtain an API key from ecobee's [developer site](https://www.ec 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. -1. Select the Developer option. +1. Select the **Developer** option from the hamburger menu. 2. Select **Create New**. -3. Give your app a name (it must be unique across all ecobee users; try -home-assistant) and a summary (neither of these are important as they are not used anywhere in Home Assistant). +3. Give your app a name (it must be unique across all ecobee users; try your-name-or-alias-home-assistant) and a summary (which need not be unique). Neither of these are important as they are not used anywhere in Home Assistant. 4. For Authorization method select **ecobee PIN**. 5. You don't need an Application Icon or Detailed Description. 6. Click **Create**. @@ -44,18 +44,18 @@ Now under the Name and Summary Section you will have an API key. Copy this key a ## Configuring the Integration -To configure the ecobee integration in Home Assistant, you 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. 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, then clicking **Add Application** and entering the PIN code from Home Assistant when prompted. +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 authorization was successful, a config entry will be created and your thermostats and sensors will be available in Home Assistant. ### Setup via configuration.yaml -If you prefer to initially set up this integration in [`configuration.yaml`](/docs/configuration/), you may do so by adding your API key (and optional parameters) as follows: +If you prefer to initially set up this integration in [`configuration.yaml`](/docs/configuration/), you may do so by adding your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** menu): ```yaml # Example configuration.yaml entry @@ -156,9 +156,9 @@ The Ecobee climate entity has some extra attributes to represent the state of th ## Services -Besides the standard services provided by the Home Assistant [Climate](https://www.home-assistant.io/components/climate/) integration, the following extra service is provided by the Ecobee Thermostat: `resume_program`. +Besides the standard services provided by the Home Assistant [Climate](https://www.home-assistant.io/components/climate/) integration, the following extra services are provided by the Ecobee Thermostat: `ecobee.resume_program` and `ecobee.set_fan_min_on_time`. -### Service `resume_program` +### Service `ecobee.resume_program` Resumes the currently active schedule. @@ -166,3 +166,12 @@ Resumes the currently active schedule. | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. | `resume_all` | no | true or false + +### Service `ecobee.set_fan_min_on_time` + +Sets the minimum amount of time that the fan will run per hour. + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Else targets all. +| `fan_min_on_time` | no | integer (e.g. 5) From bcdfc7028c08f9e1e05cadad7ae2d1368aab9623 Mon Sep 17 00:00:00 2001 From: Mark Coombes Date: Mon, 23 Sep 2019 10:37:12 -0400 Subject: [PATCH 4/6] Update ecobee.markdown --- source/_components/ecobee.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index b7ae2d7d4efd..18c5d67b4520 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -169,7 +169,7 @@ Resumes the currently active schedule. ### Service `ecobee.set_fan_min_on_time` -Sets the minimum amount of time that the fan will run per hour. +Sets the minimum amount of time that the fan will run. | Service data attribute | Optional | Description | | ---------------------- | -------- | ----------- | From e55285bd7f0ad0ec5559f56f36b5cbb887412cc2 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Mon, 23 Sep 2019 20:01:05 +0200 Subject: [PATCH 5/6] :pencil2: Tweaks --- source/_components/ecobee.markdown | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 18c5d67b4520..e0346ca5cd66 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -23,24 +23,24 @@ The `ecobee` integration lets you control thermostats and view sensor data from ## 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, 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. 1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/developers/). -2. Login with your ecobee credentials. +2. Log in with your ecobee credentials. 3. Accept the SDK agreement. 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. +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. 1. Select the **Developer** option from the hamburger menu. 2. Select **Create New**. -3. Give your app a name (it must be unique across all ecobee users; try your-name-or-alias-home-assistant) and a summary (which need not be unique). Neither of these are important as they are not used anywhere in Home Assistant. -4. For Authorization method select **ecobee PIN**. +3. Give your App a name (it must be unique across all ecobee users; try your-name-or-alias-home-assistant) and a summary (which need not be unique). Neither of these are important as they are not used anywhere in Home Assistant. +4. For authorization method select **ecobee PIN**. 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. +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. ## Configuring the Integration @@ -51,7 +51,7 @@ To configure the ecobee integration in Home Assistant, you can either use the ** 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 authorization was successful, a config entry will be created and your thermostats and sensors will be available in Home Assistant. +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. ### Setup via configuration.yaml @@ -67,7 +67,7 @@ ecobee: {% 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 hold_temp: @@ -84,7 +84,7 @@ hold_temp: ## 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 setup 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: From 537d558bfa9792d916c6cf2b95a02c82c44533d6 Mon Sep 17 00:00:00 2001 From: Mark Coombes Date: Tue, 24 Sep 2019 10:34:35 -0400 Subject: [PATCH 6/6] Remove hold_temp instructions hold_temp parameter has been removed from HA. --- source/_components/ecobee.markdown | 5 ----- 1 file changed, 5 deletions(-) diff --git a/source/_components/ecobee.markdown b/source/_components/ecobee.markdown index 18c5d67b4520..196d3f734971 100644 --- a/source/_components/ecobee.markdown +++ b/source/_components/ecobee.markdown @@ -70,11 +70,6 @@ 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. required: false type: string -hold_temp: - description: Whether or not to hold changes indefinitely (`true`) or until the next scheduled event. - required: false - default: false - type: boolean {% endconfiguration %}