Classes
class	Thermostat

Functions
None	async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)

Variables
string	ATTR_AUTO_AWAY = "auto_away"

string	ATTR_COOL_TEMP = "cool_temp"

string	ATTR_DST_ENABLED = "dst_enabled"

string	ATTR_END_DATE = "end_date"

string	ATTR_END_TIME = "end_time"

string	ATTR_FAN_MIN_ON_TIME = "fan_min_on_time"

string	ATTR_FAN_MODE = "fan_mode"

string	ATTR_FOLLOW_ME = "follow_me"

string	ATTR_HEAT_TEMP = "heat_temp"

string	ATTR_MIC_ENABLED = "mic_enabled"

string	ATTR_PRESET_MODE = "preset_mode"

string	ATTR_RESUME_ALL = "resume_all"

string	ATTR_SENSOR_LIST = "device_ids"

string	ATTR_START_DATE = "start_date"

string	ATTR_START_TIME = "start_time"

string	ATTR_VACATION_NAME = "vacation_name"

	CREATE_VACATION_SCHEMA

int	DEFAULT_MAX_HUMIDITY = 50

int	DEFAULT_MIN_HUMIDITY = 15

bool	DEFAULT_RESUME_ALL = False

	DELETE_VACATION_SCHEMA

tuple	DTGROUP_END_INCLUSIVE_MSG

tuple	DTGROUP_START_INCLUSIVE_MSG

dictionary	ECOBEE_HVAC_ACTION_TO_HASS

	ECOBEE_HVAC_TO_HASS

dictionary	ECOBEE_TO_HASS_PRESET

string	HAS_HEAT_PUMP = "hasHeatPump"

dictionary	HASS_TO_ECOBEE_HVAC

dictionary	HASS_TO_ECOBEE_PRESET = {v: k for k, v in ECOBEE_TO_HASS_PRESET.items()}

string	HUMIDIFIER_MANUAL_MODE = "manual"

string	PRESET_AWAY_INDEFINITELY = "away_indefinitely"

string	PRESET_HOLD_INDEFINITE = "indefinite"

string	PRESET_HOLD_NEXT_TRANSITION = "next_transition"

string	PRESET_TEMPERATURE = "temp"

dictionary	PRESET_TO_ECOBEE_HOLD

string	PRESET_VACATION = "vacation"

	RESUME_PROGRAM_SCHEMA

string	SERVICE_CREATE_VACATION = "create_vacation"

string	SERVICE_DELETE_VACATION = "delete_vacation"

string	SERVICE_RESUME_PROGRAM = "resume_program"

string	SERVICE_SET_DST_MODE = "set_dst_mode"

string	SERVICE_SET_FAN_MIN_ON_TIME = "set_fan_min_on_time"

string	SERVICE_SET_MIC_MODE = "set_mic_mode"

string	SERVICE_SET_OCCUPANCY_MODES = "set_occupancy_modes"

string	SERVICE_SET_SENSORS_USED_IN_CLIMATE = "set_sensors_used_in_climate"

	SET_FAN_MIN_ON_TIME_SCHEMA

tuple	SUPPORT_FLAGS

Detailed Description

Support for Ecobee Thermostats.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.ecobee.climate.async_setup_entry	(	HomeAssistant	hass,
		ConfigEntry	config_entry,
		AddEntitiesCallback	async_add_entities
	)

Set up the ecobee thermostat.

Definition at line 202 of file climate.py.

Variable Documentation

◆ ATTR_AUTO_AWAY

string homeassistant.components.ecobee.climate.ATTR_AUTO_AWAY = "auto_away"

Definition at line 66 of file climate.py.

◆ ATTR_COOL_TEMP

string homeassistant.components.ecobee.climate.ATTR_COOL_TEMP = "cool_temp"

Definition at line 54 of file climate.py.

◆ ATTR_DST_ENABLED

string homeassistant.components.ecobee.climate.ATTR_DST_ENABLED = "dst_enabled"

Definition at line 64 of file climate.py.

◆ ATTR_END_DATE

string homeassistant.components.ecobee.climate.ATTR_END_DATE = "end_date"

Definition at line 55 of file climate.py.

◆ ATTR_END_TIME

string homeassistant.components.ecobee.climate.ATTR_END_TIME = "end_time"

Definition at line 56 of file climate.py.

◆ ATTR_FAN_MIN_ON_TIME

string homeassistant.components.ecobee.climate.ATTR_FAN_MIN_ON_TIME = "fan_min_on_time"

Definition at line 57 of file climate.py.

◆ ATTR_FAN_MODE

string homeassistant.components.ecobee.climate.ATTR_FAN_MODE = "fan_mode"

Definition at line 58 of file climate.py.

◆ ATTR_FOLLOW_ME

string homeassistant.components.ecobee.climate.ATTR_FOLLOW_ME = "follow_me"

Definition at line 67 of file climate.py.

◆ ATTR_HEAT_TEMP

string homeassistant.components.ecobee.climate.ATTR_HEAT_TEMP = "heat_temp"

Definition at line 59 of file climate.py.

◆ ATTR_MIC_ENABLED

string homeassistant.components.ecobee.climate.ATTR_MIC_ENABLED = "mic_enabled"

Definition at line 65 of file climate.py.

◆ ATTR_PRESET_MODE

string homeassistant.components.ecobee.climate.ATTR_PRESET_MODE = "preset_mode"

Definition at line 69 of file climate.py.

◆ ATTR_RESUME_ALL

string homeassistant.components.ecobee.climate.ATTR_RESUME_ALL = "resume_all"

Definition at line 60 of file climate.py.

◆ ATTR_SENSOR_LIST

string homeassistant.components.ecobee.climate.ATTR_SENSOR_LIST = "device_ids"

Definition at line 68 of file climate.py.

◆ ATTR_START_DATE

string homeassistant.components.ecobee.climate.ATTR_START_DATE = "start_date"

Definition at line 61 of file climate.py.

◆ ATTR_START_TIME

string homeassistant.components.ecobee.climate.ATTR_START_TIME = "start_time"

Definition at line 62 of file climate.py.

◆ ATTR_VACATION_NAME

string homeassistant.components.ecobee.climate.ATTR_VACATION_NAME = "vacation_name"

Definition at line 63 of file climate.py.

◆ CREATE_VACATION_SCHEMA

homeassistant.components.ecobee.climate.CREATE_VACATION_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_ENTITY_ID): cv.entity_id,
         vol.Required(ATTR_VACATION_NAME): vol.All(cv.string, vol.Length(max=12)),
         vol.Required(ATTR_COOL_TEMP): vol.Coerce(float),
         vol.Required(ATTR_HEAT_TEMP): vol.Coerce(float),
         vol.Inclusive(
             ATTR_START_DATE, "dtgroup_start", msg=DTGROUP_START_INCLUSIVE_MSG
         ): ecobee_date,
         vol.Inclusive(
             ATTR_START_TIME, "dtgroup_start", msg=DTGROUP_START_INCLUSIVE_MSG
         ): ecobee_time,
         vol.Inclusive(
             ATTR_END_DATE, "dtgroup_end", msg=DTGROUP_END_INCLUSIVE_MSG
         ): ecobee_date,
         vol.Inclusive(
             ATTR_END_TIME, "dtgroup_end", msg=DTGROUP_END_INCLUSIVE_MSG
         ): ecobee_time,
         vol.Optional(ATTR_FAN_MODE, default="auto"): vol.Any("auto", "on"),
         vol.Optional(ATTR_FAN_MIN_ON_TIME, default=0): vol.All(
             int, vol.Range(min=0, max=60)
         ),
     }
 )

Definition at line 147 of file climate.py.

◆ DEFAULT_MAX_HUMIDITY

int homeassistant.components.ecobee.climate.DEFAULT_MAX_HUMIDITY = 50

Definition at line 80 of file climate.py.

◆ DEFAULT_MIN_HUMIDITY

int homeassistant.components.ecobee.climate.DEFAULT_MIN_HUMIDITY = 15

Definition at line 79 of file climate.py.

◆ DEFAULT_RESUME_ALL

bool homeassistant.components.ecobee.climate.DEFAULT_RESUME_ALL = False

Definition at line 71 of file climate.py.

◆ DELETE_VACATION_SCHEMA

homeassistant.components.ecobee.climate.DELETE_VACATION_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Required(ATTR_ENTITY_ID): cv.entity_id,
         vol.Required(ATTR_VACATION_NAME): vol.All(cv.string, vol.Length(max=12)),
     }
 )

Definition at line 172 of file climate.py.

◆ DTGROUP_END_INCLUSIVE_MSG

tuple homeassistant.components.ecobee.climate.DTGROUP_END_INCLUSIVE_MSG

Initial value:

 =  (
     f"{ATTR_END_DATE} and {ATTR_END_TIME} must be specified together"
 )

Definition at line 143 of file climate.py.

◆ DTGROUP_START_INCLUSIVE_MSG

tuple homeassistant.components.ecobee.climate.DTGROUP_START_INCLUSIVE_MSG

Initial value:

 =  (
     f"{ATTR_START_DATE} and {ATTR_START_TIME} must be specified together"
 )

Definition at line 139 of file climate.py.

◆ ECOBEE_HVAC_ACTION_TO_HASS

dictionary homeassistant.components.ecobee.climate.ECOBEE_HVAC_ACTION_TO_HASS

Initial value:

 =  {
     # Map to None if we do not know how to represent.
     "heatPump": HVACAction.HEATING,
     "heatPump2": HVACAction.HEATING,
     "heatPump3": HVACAction.HEATING,
     "compCool1": HVACAction.COOLING,
     "compCool2": HVACAction.COOLING,
     "auxHeat1": HVACAction.HEATING,
     "auxHeat2": HVACAction.HEATING,
     "auxHeat3": HVACAction.HEATING,
     "fan": HVACAction.FAN,
     "humidifier": None,
     "dehumidifier": HVACAction.DRYING,
     "ventilator": HVACAction.FAN,
     "economizer": HVACAction.FAN,
     "compHotWater": None,
     "auxHotWater": None,
     "compWaterHeater": None,
 }

Definition at line 98 of file climate.py.

◆ ECOBEE_HVAC_TO_HASS

homeassistant.components.ecobee.climate.ECOBEE_HVAC_TO_HASS

Initial value:

 =  collections.OrderedDict(
     [
         ("heat", HVACMode.HEAT),
         ("cool", HVACMode.COOL),
         ("auto", HVACMode.HEAT_COOL),
         ("off", HVACMode.OFF),
         (ECOBEE_AUX_HEAT_ONLY, HVACMode.HEAT),
     ]
 )

Definition at line 84 of file climate.py.

◆ ECOBEE_TO_HASS_PRESET

dictionary homeassistant.components.ecobee.climate.ECOBEE_TO_HASS_PRESET

Initial value:

 =  {
     "Away": PRESET_AWAY,
     "Home": PRESET_HOME,
     "Sleep": PRESET_SLEEP,
 }

Definition at line 118 of file climate.py.

◆ HAS_HEAT_PUMP

string homeassistant.components.ecobee.climate.HAS_HEAT_PUMP = "hasHeatPump"

Definition at line 77 of file climate.py.

◆ HASS_TO_ECOBEE_HVAC

dictionary homeassistant.components.ecobee.climate.HASS_TO_ECOBEE_HVAC

Initial value:

 =  {
     v: k for k, v in ECOBEE_HVAC_TO_HASS.items() if k != ECOBEE_AUX_HEAT_ONLY
 }

Definition at line 94 of file climate.py.

◆ HASS_TO_ECOBEE_PRESET

dictionary homeassistant.components.ecobee.climate.HASS_TO_ECOBEE_PRESET = {v: k for k, v in ECOBEE_TO_HASS_PRESET.items()}

Definition at line 123 of file climate.py.

◆ HUMIDIFIER_MANUAL_MODE

string homeassistant.components.ecobee.climate.HUMIDIFIER_MANUAL_MODE = "manual"

Definition at line 81 of file climate.py.

◆ PRESET_AWAY_INDEFINITELY

string homeassistant.components.ecobee.climate.PRESET_AWAY_INDEFINITELY = "away_indefinitely"

Definition at line 72 of file climate.py.

◆ PRESET_HOLD_INDEFINITE

string homeassistant.components.ecobee.climate.PRESET_HOLD_INDEFINITE = "indefinite"

Definition at line 76 of file climate.py.

◆ PRESET_HOLD_NEXT_TRANSITION

string homeassistant.components.ecobee.climate.PRESET_HOLD_NEXT_TRANSITION = "next_transition"

Definition at line 75 of file climate.py.

◆ PRESET_TEMPERATURE

string homeassistant.components.ecobee.climate.PRESET_TEMPERATURE = "temp"

Definition at line 73 of file climate.py.

◆ PRESET_TO_ECOBEE_HOLD

dictionary homeassistant.components.ecobee.climate.PRESET_TO_ECOBEE_HOLD

Initial value:

 =  {
     PRESET_HOLD_NEXT_TRANSITION: "nextTransition",
     PRESET_HOLD_INDEFINITE: "indefinite",
 }

Definition at line 125 of file climate.py.

◆ PRESET_VACATION

string homeassistant.components.ecobee.climate.PRESET_VACATION = "vacation"

Definition at line 74 of file climate.py.

◆ RESUME_PROGRAM_SCHEMA

homeassistant.components.ecobee.climate.RESUME_PROGRAM_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
         vol.Optional(ATTR_RESUME_ALL, default=DEFAULT_RESUME_ALL): cv.boolean,
     }
 )

Definition at line 179 of file climate.py.

◆ SERVICE_CREATE_VACATION

string homeassistant.components.ecobee.climate.SERVICE_CREATE_VACATION = "create_vacation"

Definition at line 130 of file climate.py.

◆ SERVICE_DELETE_VACATION

string homeassistant.components.ecobee.climate.SERVICE_DELETE_VACATION = "delete_vacation"

Definition at line 131 of file climate.py.

◆ SERVICE_RESUME_PROGRAM

string homeassistant.components.ecobee.climate.SERVICE_RESUME_PROGRAM = "resume_program"

Definition at line 132 of file climate.py.

◆ SERVICE_SET_DST_MODE

string homeassistant.components.ecobee.climate.SERVICE_SET_DST_MODE = "set_dst_mode"

Definition at line 134 of file climate.py.

◆ SERVICE_SET_FAN_MIN_ON_TIME

string homeassistant.components.ecobee.climate.SERVICE_SET_FAN_MIN_ON_TIME = "set_fan_min_on_time"

Definition at line 133 of file climate.py.

◆ SERVICE_SET_MIC_MODE

string homeassistant.components.ecobee.climate.SERVICE_SET_MIC_MODE = "set_mic_mode"

Definition at line 135 of file climate.py.

◆ SERVICE_SET_OCCUPANCY_MODES

string homeassistant.components.ecobee.climate.SERVICE_SET_OCCUPANCY_MODES = "set_occupancy_modes"

Definition at line 136 of file climate.py.

◆ SERVICE_SET_SENSORS_USED_IN_CLIMATE

string homeassistant.components.ecobee.climate.SERVICE_SET_SENSORS_USED_IN_CLIMATE = "set_sensors_used_in_climate"

Definition at line 137 of file climate.py.

◆ SET_FAN_MIN_ON_TIME_SCHEMA

homeassistant.components.ecobee.climate.SET_FAN_MIN_ON_TIME_SCHEMA

Initial value:

 =  vol.Schema(
     {
         vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
         vol.Required(ATTR_FAN_MIN_ON_TIME): vol.Coerce(int),
     }
 )

Definition at line 186 of file climate.py.

◆ SUPPORT_FLAGS

tuple homeassistant.components.ecobee.climate.SUPPORT_FLAGS

Initial value:

 =  (
     ClimateEntityFeature.TARGET_TEMPERATURE
     | ClimateEntityFeature.PRESET_MODE
     | ClimateEntityFeature.TARGET_TEMPERATURE_RANGE
     | ClimateEntityFeature.FAN_MODE
 )

Definition at line 194 of file climate.py.

Home Assistant Unofficial Reference 2024.12.1

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ async_setup_entry()

Variable Documentation

◆ ATTR_AUTO_AWAY

◆ ATTR_COOL_TEMP

◆ ATTR_DST_ENABLED

◆ ATTR_END_DATE

◆ ATTR_END_TIME

◆ ATTR_FAN_MIN_ON_TIME

◆ ATTR_FAN_MODE

◆ ATTR_FOLLOW_ME

◆ ATTR_HEAT_TEMP

◆ ATTR_MIC_ENABLED

◆ ATTR_PRESET_MODE

◆ ATTR_RESUME_ALL

◆ ATTR_SENSOR_LIST

◆ ATTR_START_DATE

◆ ATTR_START_TIME

◆ ATTR_VACATION_NAME

◆ CREATE_VACATION_SCHEMA

◆ DEFAULT_MAX_HUMIDITY

◆ DEFAULT_MIN_HUMIDITY

◆ DEFAULT_RESUME_ALL

◆ DELETE_VACATION_SCHEMA

◆ DTGROUP_END_INCLUSIVE_MSG

◆ DTGROUP_START_INCLUSIVE_MSG

◆ ECOBEE_HVAC_ACTION_TO_HASS

◆ ECOBEE_HVAC_TO_HASS

◆ ECOBEE_TO_HASS_PRESET

◆ HAS_HEAT_PUMP

◆ HASS_TO_ECOBEE_HVAC

◆ HASS_TO_ECOBEE_PRESET

◆ HUMIDIFIER_MANUAL_MODE

◆ PRESET_AWAY_INDEFINITELY

◆ PRESET_HOLD_INDEFINITE

◆ PRESET_HOLD_NEXT_TRANSITION

◆ PRESET_TEMPERATURE

◆ PRESET_TO_ECOBEE_HOLD

◆ PRESET_VACATION

◆ RESUME_PROGRAM_SCHEMA

◆ SERVICE_CREATE_VACATION

◆ SERVICE_DELETE_VACATION

◆ SERVICE_RESUME_PROGRAM

◆ SERVICE_SET_DST_MODE

◆ SERVICE_SET_FAN_MIN_ON_TIME

◆ SERVICE_SET_MIC_MODE

◆ SERVICE_SET_OCCUPANCY_MODES

◆ SERVICE_SET_SENSORS_USED_IN_CLIMATE

◆ SET_FAN_MIN_ON_TIME_SCHEMA

◆ SUPPORT_FLAGS