Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.ecobee.climate.Thermostat Class Reference
Inheritance diagram for homeassistant.components.ecobee.climate.Thermostat:
[legend]
Collaboration diagram for homeassistant.components.ecobee.climate.Thermostat:
[legend]

Public Member Functions

None __init__ (self, EcobeeData data, int thermostat_index, dict thermostat, HomeAssistant hass)
 
list active_sensor_devices_in_preset_mode (self)
 
list active_sensors_in_preset_mode (self)
 
None async_update (self)
 
bool available (self)
 
dict[str, strcomfort_settings (self)
 
def create_vacation (self, service_data)
 
int|None current_humidity (self)
 
float current_temperature (self)
 
def delete_vacation (self, vacation_name)
 
DeviceInfo device_info (self)
 
dict[str, Any]|None extra_state_attributes (self)
 
def fan (self)
 
def fan_mode (self)
 
bool has_humidifier_control (self)
 
def hold_hours (self)
 
def hold_preference (self)
 
def hvac_action (self)
 
def hvac_mode (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (self)
 
list remote_sensor_devices (self)
 
list remote_sensor_ids_names (self)
 
list remote_sensors (self)
 
def resume_program (self, resume_all)
 
def set_auto_temp_hold (self, heat_temp, cool_temp)
 
def set_dst_mode (self, dst_enabled)
 
def set_fan_min_on_time (self, fan_min_on_time)
 
None set_fan_mode (self, str fan_mode)
 
None set_humidity (self, int humidity)
 
None set_hvac_mode (self, HVACMode hvac_mode)
 
def set_mic_mode (self, mic_enabled)
 
def set_occupancy_modes (self, auto_away=None, follow_me=None)
 
None set_preset_mode (self, str preset_mode)
 
None set_sensors_used_in_climate (self, list[str] device_ids, str|None preset_mode=None)
 
def set_temp_hold (self, temp)
 
None set_temperature (self, **Any kwargs)
 
dict[str, Any] settings (self)
 
ClimateEntityFeature supported_features (self)
 
int|None target_humidity (self)
 
float|None target_temperature (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
float target_temperature_step (self)
 
None turn_on (self)
 
- Public Member Functions inherited from homeassistant.components.climate.ClimateEntity
Any __getattribute__ (self, str name)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_handle_set_fan_mode_service (self, str fan_mode)
 
None async_handle_set_hvac_mode_service (self, HVACMode hvac_mode)
 
None async_handle_set_preset_mode_service (self, str preset_mode)
 
None async_handle_set_swing_horizontal_mode_service (self, str swing_horizontal_mode)
 
None async_handle_set_swing_mode_service (self, str swing_mode)
 
None async_set_fan_mode (self, str fan_mode)
 
None async_set_humidity (self, int humidity)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None async_set_swing_mode (self, str swing_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_toggle (self)
 
None async_turn_aux_heat_off (self)
 
None async_turn_aux_heat_on (self)
 
None async_turn_off (self)
 
None async_turn_on (self)
 
dict[str, Any]|None capability_attributes (self)
 
list[str]|None fan_modes (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float max_temp (self)
 
float min_humidity (self)
 
float min_temp (self)
 
float precision (self)
 
None set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None set_swing_mode (self, str swing_mode)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
str|None swing_horizontal_mode (self)
 
list[str]|None swing_horizontal_modes (self)
 
str|None swing_mode (self)
 
list[str]|None swing_modes (self)
 
str temperature_unit (self)
 
None toggle (self)
 
None turn_aux_heat_off (self)
 
None turn_aux_heat_on (self)
 
None turn_off (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
str|None device_class (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Public Attributes

 data
 
 hvac_mode
 
 preset_mode
 
 thermostat
 
 thermostat_index
 
 update_without_throttle
 
 vacation
 
- Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 hvac_mode
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

list[str_sensor_devices_in_preset_mode (self, str|None preset_mode)
 
list[str_sensors_in_preset_mode (self, str|None preset_mode)
 

Private Attributes

 _attr_hvac_modes
 
 _attr_unique_id
 
 _hass
 
 _last_active_hvac_mode
 
 _last_hvac_mode_before_aux_heat
 
 _preset_modes
 
 _sensors
 

Static Private Attributes

list _attr_fan_modes = [FAN_AUTO, FAN_ON]
 
bool _attr_has_entity_name = True
 
 _attr_max_humidity = DEFAULT_MAX_HUMIDITY
 
 _attr_min_humidity = DEFAULT_MIN_HUMIDITY
 
 _attr_name = None
 
 _attr_precision = PRECISION_TENTHS
 
 _attr_temperature_unit = UnitOfTemperature.FAHRENHEIT
 
string _attr_translation_key = "ecobee"
 
bool _enable_turn_on_off_backwards_compatibility = False
 
 _unrecorded_attributes = frozenset({ATTR_AVAILABLE_SENSORS, ATTR_ACTIVE_SENSORS})
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 bool
 
 ClimateEntityFeature
 
 float
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

A thermostat class for Ecobee.

Definition at line 346 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ecobee.climate.Thermostat.__init__ (   self,
EcobeeData  data,
int  thermostat_index,
dict  thermostat,
HomeAssistant  hass 
)
Initialize the thermostat.

Definition at line 359 of file climate.py.

Member Function Documentation

◆ _sensor_devices_in_preset_mode()

list[str] homeassistant.components.ecobee.climate.Thermostat._sensor_devices_in_preset_mode (   self,
str | None  preset_mode 
)
private
Return current sensor device name_by_user or name used in climate.

Definition at line 920 of file climate.py.

◆ _sensors_in_preset_mode()

list[str] homeassistant.components.ecobee.climate.Thermostat._sensors_in_preset_mode (   self,
str | None  preset_mode 
)
private
Return current sensors used in climate.

Definition at line 911 of file climate.py.

◆ active_sensor_devices_in_preset_mode()

list homeassistant.components.ecobee.climate.Thermostat.active_sensor_devices_in_preset_mode (   self)
Return the currently active/participating sensor devices.

Definition at line 640 of file climate.py.

◆ active_sensors_in_preset_mode()

list homeassistant.components.ecobee.climate.Thermostat.active_sensors_in_preset_mode (   self)
Return the currently active/participating sensors.

Definition at line 631 of file climate.py.

◆ async_update()

None homeassistant.components.ecobee.climate.Thermostat.async_update (   self)
Get the latest state from the thermostat.

Definition at line 391 of file climate.py.

◆ available()

bool homeassistant.components.ecobee.climate.Thermostat.available (   self)
Return if device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 403 of file climate.py.

◆ comfort_settings()

dict[str, str] homeassistant.components.ecobee.climate.Thermostat.comfort_settings (   self)
Return ecobee API comfort settings.

Definition at line 706 of file climate.py.

◆ create_vacation()

def homeassistant.components.ecobee.climate.Thermostat.create_vacation (   self,
  service_data 
)
Create a vacation with user-specified parameters.

Definition at line 962 of file climate.py.

◆ current_humidity()

int | None homeassistant.components.ecobee.climate.Thermostat.current_humidity (   self)
Return the current humidity.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 542 of file climate.py.

◆ current_temperature()

float homeassistant.components.ecobee.climate.Thermostat.current_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 437 of file climate.py.

◆ delete_vacation()

def homeassistant.components.ecobee.climate.Thermostat.delete_vacation (   self,
  vacation_name 
)
Delete a vacation with the specified name.

Definition at line 1010 of file climate.py.

◆ device_info()

DeviceInfo homeassistant.components.ecobee.climate.Thermostat.device_info (   self)
Return device information for this ecobee thermostat.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 420 of file climate.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.ecobee.climate.Thermostat.extra_state_attributes (   self)
Return device specific state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 582 of file climate.py.

◆ fan()

def homeassistant.components.ecobee.climate.Thermostat.fan (   self)
Return the current fan status.

Definition at line 492 of file climate.py.

◆ fan_mode()

def homeassistant.components.ecobee.climate.Thermostat.fan_mode (   self)
Return the fan setting.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 499 of file climate.py.

◆ has_humidifier_control()

bool homeassistant.components.ecobee.climate.Thermostat.has_humidifier_control (   self)
Return true if humidifier connected to thermostat and set to manual/on mode.

Definition at line 466 of file climate.py.

◆ hold_hours()

def homeassistant.components.ecobee.climate.Thermostat.hold_hours (   self)
Return user preference setting for hold duration in hours.

Definition at line 949 of file climate.py.

◆ hold_preference()

def homeassistant.components.ecobee.climate.Thermostat.hold_preference (   self)
Return user preference setting for hold time.

Definition at line 933 of file climate.py.

◆ hvac_action()

def homeassistant.components.ecobee.climate.Thermostat.hvac_action (   self)
Return current HVAC action.

Ecobee returns a CSV string with different equipment that is active.
We are prioritizing any heating/cooling equipment, otherwise look at
drying/fanning. Idle if nothing going on.

We are unable to map all actions to HA equivalents.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 550 of file climate.py.

◆ hvac_mode()

def homeassistant.components.ecobee.climate.Thermostat.hvac_mode (   self)
Return current operation.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 537 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.ecobee.climate.Thermostat.preset_mode (   self)
Return current preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 504 of file climate.py.

◆ preset_modes()

list[str] | None homeassistant.components.ecobee.climate.Thermostat.preset_modes (   self)
Return available preset modes.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 696 of file climate.py.

◆ remote_sensor_devices()

list homeassistant.components.ecobee.climate.Thermostat.remote_sensor_devices (   self)
Return the remote sensor device name_by_user or name for the thermostat.

Definition at line 603 of file climate.py.

◆ remote_sensor_ids_names()

list homeassistant.components.ecobee.climate.Thermostat.remote_sensor_ids_names (   self)
Return the remote sensor device id and name_by_user for the thermostat.

Definition at line 613 of file climate.py.

◆ remote_sensors()

list homeassistant.components.ecobee.climate.Thermostat.remote_sensors (   self)
Return the remote sensor names of the thermostat.

Definition at line 597 of file climate.py.

◆ resume_program()

def homeassistant.components.ecobee.climate.Thermostat.resume_program (   self,
  resume_all 
)
Resume the thermostat schedule program.

Definition at line 817 of file climate.py.

◆ set_auto_temp_hold()

def homeassistant.components.ecobee.climate.Thermostat.set_auto_temp_hold (   self,
  heat_temp,
  cool_temp 
)
Set temperature hold in auto mode.

Definition at line 713 of file climate.py.

◆ set_dst_mode()

def homeassistant.components.ecobee.climate.Thermostat.set_dst_mode (   self,
  dst_enabled 
)
Enable/disable automatic daylight savings time.

Definition at line 1028 of file climate.py.

◆ set_fan_min_on_time()

def homeassistant.components.ecobee.climate.Thermostat.set_fan_min_on_time (   self,
  fan_min_on_time 
)
Set the minimum fan on time.

Definition at line 812 of file climate.py.

◆ set_fan_mode()

None homeassistant.components.ecobee.climate.Thermostat.set_fan_mode (   self,
str  fan_mode 
)
Set the fan mode.  Valid values are "on" or "auto".

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 742 of file climate.py.

◆ set_humidity()

None homeassistant.components.ecobee.climate.Thermostat.set_humidity (   self,
int  humidity 
)
Set the humidity level.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 793 of file climate.py.

◆ set_hvac_mode()

None homeassistant.components.ecobee.climate.Thermostat.set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set HVAC mode (auto, auxHeatOnly, cool, heat, off).

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 803 of file climate.py.

◆ set_mic_mode()

def homeassistant.components.ecobee.climate.Thermostat.set_mic_mode (   self,
  mic_enabled 
)
Enable/disable Alexa mic (only for Ecobee 4).

Definition at line 1032 of file climate.py.

◆ set_occupancy_modes()

def homeassistant.components.ecobee.climate.Thermostat.set_occupancy_modes (   self,
  auto_away = None,
  follow_me = None 
)
Enable/disable Smart Home/Away and Follow Me modes.

Definition at line 1036 of file climate.py.

◆ set_preset_mode()

None homeassistant.components.ecobee.climate.Thermostat.set_preset_mode (   self,
str  preset_mode 
)
Activate a preset.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 648 of file climate.py.

◆ set_sensors_used_in_climate()

None homeassistant.components.ecobee.climate.Thermostat.set_sensors_used_in_climate (   self,
list[str device_ids,
str | None   preset_mode = None 
)
Set the sensors used on a climate for a thermostat.

Definition at line 824 of file climate.py.

◆ set_temp_hold()

def homeassistant.components.ecobee.climate.Thermostat.set_temp_hold (   self,
  temp 
)
Set temperature hold in modes other than auto.

Ecobee API: It is good practice to set the heat and cool hold
temperatures to be the same, if the thermostat is in either heat, cool,
auxHeatOnly, or off mode. If the thermostat is in auto mode, an
additional rule is required. The cool hold temperature must be greater
than the heat hold temperature by at least the amount in the
heatCoolMinDelta property.
https://www.ecobee.com/home/developer/api/examples/ex5.shtml

Definition at line 758 of file climate.py.

◆ set_temperature()

None homeassistant.components.ecobee.climate.Thermostat.set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 778 of file climate.py.

◆ settings()

dict[str, Any] homeassistant.components.ecobee.climate.Thermostat.settings (   self)
Return the settings of the thermostat.

Definition at line 461 of file climate.py.

◆ supported_features()

ClimateEntityFeature homeassistant.components.ecobee.climate.Thermostat.supported_features (   self)
Return the list of supported features.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 408 of file climate.py.

◆ target_humidity()

int | None homeassistant.components.ecobee.climate.Thermostat.target_humidity (   self)
Return the desired humidity set point.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 474 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.ecobee.climate.Thermostat.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 481 of file climate.py.

◆ target_temperature_high()

float | None homeassistant.components.ecobee.climate.Thermostat.target_temperature_high (   self)
Return the upper bound temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 449 of file climate.py.

◆ target_temperature_low()

float | None homeassistant.components.ecobee.climate.Thermostat.target_temperature_low (   self)
Return the lower bound temperature we try to reach.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 442 of file climate.py.

◆ target_temperature_step()

float homeassistant.components.ecobee.climate.Thermostat.target_temperature_step (   self)
Set target temperature step to halves.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 456 of file climate.py.

◆ turn_on()

None homeassistant.components.ecobee.climate.Thermostat.turn_on (   self)
Set the thermostat to the last active HVAC mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 1019 of file climate.py.

Member Data Documentation

◆ _attr_fan_modes

list homeassistant.components.ecobee.climate.Thermostat._attr_fan_modes = [FAN_AUTO, FAN_ON]
staticprivate

Definition at line 353 of file climate.py.

◆ _attr_has_entity_name

bool homeassistant.components.ecobee.climate.Thermostat._attr_has_entity_name = True
staticprivate

Definition at line 355 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.ecobee.climate.Thermostat._attr_hvac_modes
private

Definition at line 376 of file climate.py.

◆ _attr_max_humidity

homeassistant.components.ecobee.climate.Thermostat._attr_max_humidity = DEFAULT_MAX_HUMIDITY
staticprivate

Definition at line 352 of file climate.py.

◆ _attr_min_humidity

homeassistant.components.ecobee.climate.Thermostat._attr_min_humidity = DEFAULT_MIN_HUMIDITY
staticprivate

Definition at line 351 of file climate.py.

◆ _attr_name

homeassistant.components.ecobee.climate.Thermostat._attr_name = None
staticprivate

Definition at line 354 of file climate.py.

◆ _attr_precision

homeassistant.components.ecobee.climate.Thermostat._attr_precision = PRECISION_TENTHS
staticprivate

Definition at line 349 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.ecobee.climate.Thermostat._attr_temperature_unit = UnitOfTemperature.FAHRENHEIT
staticprivate

Definition at line 350 of file climate.py.

◆ _attr_translation_key

string homeassistant.components.ecobee.climate.Thermostat._attr_translation_key = "ecobee"
staticprivate

Definition at line 357 of file climate.py.

◆ _attr_unique_id

homeassistant.components.ecobee.climate.Thermostat._attr_unique_id
private

Definition at line 370 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.ecobee.climate.Thermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 356 of file climate.py.

◆ _hass

homeassistant.components.ecobee.climate.Thermostat._hass
private

Definition at line 374 of file climate.py.

◆ _last_active_hvac_mode

homeassistant.components.ecobee.climate.Thermostat._last_active_hvac_mode
private

Definition at line 372 of file climate.py.

◆ _last_hvac_mode_before_aux_heat

homeassistant.components.ecobee.climate.Thermostat._last_hvac_mode_before_aux_heat
private

Definition at line 373 of file climate.py.

◆ _preset_modes

homeassistant.components.ecobee.climate.Thermostat._preset_modes
private

Definition at line 385 of file climate.py.

◆ _sensors

homeassistant.components.ecobee.climate.Thermostat._sensors
private

Definition at line 384 of file climate.py.

◆ _unrecorded_attributes

homeassistant.components.ecobee.climate.Thermostat._unrecorded_attributes = frozenset({ATTR_AVAILABLE_SENSORS, ATTR_ACTIVE_SENSORS})
staticprivate

Definition at line 579 of file climate.py.

◆ data

homeassistant.components.ecobee.climate.Thermostat.data

Definition at line 367 of file climate.py.

◆ hvac_mode

homeassistant.components.ecobee.climate.Thermostat.hvac_mode

Definition at line 444 of file climate.py.

◆ preset_mode

homeassistant.components.ecobee.climate.Thermostat.preset_mode

Definition at line 658 of file climate.py.

◆ thermostat

homeassistant.components.ecobee.climate.Thermostat.thermostat

Definition at line 369 of file climate.py.

◆ thermostat_index

homeassistant.components.ecobee.climate.Thermostat.thermostat_index

Definition at line 368 of file climate.py.

◆ update_without_throttle

homeassistant.components.ecobee.climate.Thermostat.update_without_throttle

Definition at line 389 of file climate.py.

◆ vacation

homeassistant.components.ecobee.climate.Thermostat.vacation

Definition at line 371 of file climate.py.


The documentation for this class was generated from the following file: