add ecobee ventilator documentation (#25215)

This commit is contained in:
Marc-Olivier Arsenault 2023-02-20 02:48:01 -07:00 committed by GitHub
parent dd10151420
commit 6f9a4d9ce0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,6 +6,7 @@ ha_category:
- Climate
- Humidifier
- Notifications
- Number
- Sensor
- Weather
featured: true
@ -20,6 +21,7 @@ ha_platforms:
- climate
- humidifier
- notify
- number
- sensor
- weather
ha_zeroconf: true
@ -56,7 +58,7 @@ Your new application will now appear on the left. Upon clicking on the applicati
1. In the **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 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, 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 and sensors will be available in Home Assistant.
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
@ -117,7 +119,7 @@ The _HVAC mode_ of the device is the currently active operational modes that the
The _target humidity_ is the humidity set point of the thermostat when a humidifier is connected and in manual control or "On" mode.
## Attributes
### Attributes
The ecobee climate entity has some extra attributes to represent the state of the thermostat.
@ -128,6 +130,19 @@ The ecobee climate entity has some extra attributes to represent the state of th
| `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.
## Ventilator
### Concepts
The ecobee thermostat supports the addition of an accessory. If you have an air exchanger (ventilator, HRV, or ERV), you can control it via the min time home and min time away numbers.
### Number
| Name | Description |
| ---- | ----------- |
| `ventilator_min_on_time_home` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are home. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself.
| `ventilator_min_on_time_away` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are away. This is determined by the minimum ventilator 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:
@ -210,4 +225,4 @@ Enable/disable Smart Home/Away and Follow Me modes.
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set occupancy modes |
| `auto_away` | yes | true or false |
| `follow_me` | yes | true or false |
| `follow_me` | yes | true or false |