Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ecobee Namespace Reference

Namespaces

 binary_sensor
 
 climate
 
 config_flow
 
 const
 
 entity
 
 humidifier
 
 notify
 
 number
 
 sensor
 
 switch
 
 util
 
 weather
 

Classes

class  EcobeeData
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

 CONFIG_SCHEMA
 
 MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=180)
 

Detailed Description

Support for ecobee.

Function Documentation

◆ async_setup()

bool homeassistant.components.ecobee.async_setup ( HomeAssistant  hass,
ConfigType  config 
)
Ecobee uses config flow for configuration.

But, an "ecobee:" entry in configuration.yaml will trigger an import flow
if a config entry doesn't already exist. If ecobee.conf exists, the import
flow will attempt to import it and create a config entry, to assist users
migrating from the old ecobee integration. Otherwise, the user will have to
continue setting up the integration via the config flow.

Definition at line 31 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.ecobee.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up ecobee via a config entry.

Definition at line 55 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.ecobee.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload the config entry and platforms.

Definition at line 120 of file __init__.py.

Variable Documentation

◆ CONFIG_SCHEMA

homeassistant.components.ecobee.CONFIG_SCHEMA
Initial value:
1 = vol.Schema(
2  {DOMAIN: vol.Schema({vol.Optional(CONF_API_KEY): cv.string})}, extra=vol.ALLOW_EXTRA
3 )

Definition at line 26 of file __init__.py.

◆ MIN_TIME_BETWEEN_UPDATES

homeassistant.components.ecobee.MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=180)

Definition at line 24 of file __init__.py.