diff --git a/source/_integrations/ecobee.markdown b/source/_integrations/ecobee.markdown index 3e0b8929982f..ad42b361821f 100644 --- a/source/_integrations/ecobee.markdown +++ b/source/_integrations/ecobee.markdown @@ -30,65 +30,33 @@ ha_integration_type: hub The **ecobee** {% term integration %} lets you control and view sensor data from [ecobee](https://ecobee.com) thermostats. -## Preliminary 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, your thermostat must be registered on ecobee's website (which you likely would have already done while installing your thermostat). Once you have done that, perform the following steps. - -{% warning %} -As of March 28th, 2024, ecobee is no longer accepting new developer subscriptions, nor are existing developer accounts able to create new API keys. There is no ETA for when they will be allowed again. Existing API keys will continue to function. - -In the meantime, you can use the [HomeKit Device](/integrations/homekit_controller/) integration as a fully functional alternative. -{% endwarning %} - -1. Click on the **Become a developer** link on the [developer site](https://www.ecobee.com/home/developer/loginDeveloper.jsp). -2. Log in with your ecobee credentials. (Make sure multifactor authentication is disabled to meet the developer login form's limits. If you've already enabled MFA, the web portal doesn't support disabling it. The iOS and Android apps do under Account > Account Security. You can re-enable MFA after becoming a developer.) -3. Accept the SDK agreement. -4. Fill in the fields. -5. Click **save**. - -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 an application can be created to integrate with Home Assistant. - -1. Select the **Developer** option from the hamburger menu on the top-right. -2. Select **Create New**. -3. Complete the form on the right. (Neither of the fields are referenced by Home Assistant) - - Name: Must be unique across all ecobee users. - - Summary: Does not need to be unique. -4. Click *Authorization method* and select **ecobee PIN**. -5. Click **Create**. - -Your new application will now appear on the left. Upon clicking on the application, API key will appear on the right. Copy this key and use it in the configuration section below. Click **X** to close the Developer section. - -## Configuration - -1. In the {% my integrations title="**Settings** > **Devices & services**" %} 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's [developer portal](https://ecobee.com/developers). -3. In the next pop-up box, you will be presented with a unique 8 character code separated by a dash (format: XXXX-XXXX), 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, clicking **Validate** and then **Add Application** in the bottom right. -4. After authorizing the app with ecobee, return to Home Assistant and click **Submit**. If the authorization was successful, a configuration entry will be created and your thermostats, ventilators and sensors will be available in Home Assistant. - -## Manual configuration - -If you prefer to set up the integration in your {% term "`configuration.yaml`" %} file, add your API key (and optional parameters) as follows (however, you must still complete authorization via the **Integrations** panel). -{% include integrations/restart_ha_after_config_inclusion.md %} - -```yaml -# Example configuration.yaml entry -ecobee: - api_key: YOUR_API_KEY -``` - -{% 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** panel, update this, and then configure the integration again. - required: false - type: string -{% endconfiguration %} -

+

-You must [restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. After restarting, go to {% my integrations title="**Settings** > **Devices & services**" %} and select the integration. Then, select **Configure** and continue to authorize the app according to the above **Automatic Configuration**, starting at step 2. +## Prerequisites + +- Username and password for [ecobee.com](https://ecobee.com). + - You will need it when adding the integration to set up a connection between the integration and Home Assistant. +- Have the devices connected to your ecobee.com account. + - You can add devices either before or after you configure the service in Home Assistant, but having them connected to your ecobee.com account ahead of time is recommended to confirm that they are picked up by the service correctly. + +{% note %} +Since version 2026.3, it is no longer required to get a [developer API key](https://www.ecobee.com/developers/) to use this integration. Existing API keys will continue to function. If you revoke your existing key in the ecobee portal, the integration will fail, and you will need to remove the service in Home Assistant and set it up again. +{% endnote %} + +{% include integrations/config_flow.md %} + +{% configuration_basic %} +API key: + description: If you have a developer API key, use this field and ignore the others. If you are logging in without an API key, leave this field blank and use username and password. +username: + description: The email address you use to sign in to [ecobee.com](https://ecobee.com). +password: + description: The password for the above account. +{% endconfiguration_basic %} ## Notifications