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

Public Member Functions

None __init__ (self, HomeAssistant hass, str name, str heater_entity_id, str sensor_entity_id, float|None min_temp, float|None max_temp, float|None target_temp, bool|None ac_mode, timedelta|None min_cycle_duration, float cold_tolerance, float hot_tolerance, timedelta|None keep_alive, HVACMode|None initial_hvac_mode, dict[str, float] presets, float|None precision, float|None target_temperature_step, UnitOfTemperature unit, str|None unique_id)
 
None async_added_to_hass (self)
 
None async_set_hvac_mode (self, HVACMode hvac_mode)
 
None async_set_preset_mode (self, str preset_mode)
 
None async_set_temperature (self, **Any kwargs)
 
float|None current_temperature (self)
 
HVACAction hvac_action (self)
 
HVACMode|None hvac_mode (self)
 
float max_temp (self)
 
float min_temp (self)
 
float precision (self)
 
float|None target_temperature (self)
 
float target_temperature_step (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_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None async_set_swing_mode (self, str swing_mode)
 
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)
 
float|None current_humidity (self)
 
str|None fan_mode (self)
 
list[str]|None fan_modes (self)
 
list[HVACMode] hvac_modes (self)
 
bool|None is_aux_heat (self)
 
float max_humidity (self)
 
float min_humidity (self)
 
str|None preset_mode (self)
 
list[str]|None preset_modes (self)
 
None set_fan_mode (self, str fan_mode)
 
None set_humidity (self, int humidity)
 
None set_hvac_mode (self, HVACMode hvac_mode)
 
None set_preset_mode (self, str preset_mode)
 
None set_swing_horizontal_mode (self, str swing_horizontal_mode)
 
None set_swing_mode (self, str swing_mode)
 
None set_temperature (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
ClimateEntityFeature supported_features (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)
 
float|None target_humidity (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
str temperature_unit (self)
 
None toggle (self)
 
None turn_aux_heat_off (self)
 
None turn_aux_heat_on (self)
 
None turn_off (self)
 
None turn_on (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_device_update (self, bool warning=True)
 
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)
 
bool available (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (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)
 
Mapping[str, Any]|None extra_state_attributes (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 Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Public Attributes

 ac_mode
 
 heater_entity_id
 
 min_cycle_duration
 
 sensor_entity_id
 
- 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

None _async_control_heating (self, datetime|None time=None, bool force=False)
 
None _async_heater_turn_off (self)
 
None _async_heater_turn_on (self)
 
None _async_sensor_changed (self, Event[EventStateChangedData] event)
 
None _async_switch_changed (self, Event[EventStateChangedData] event)
 
None _async_update_temp (self, State state)
 
None _check_switch_initial_state (self)
 
bool|None _is_device_active (self)
 

Private Attributes

 _active
 
 _attr_device_info
 
 _attr_hvac_modes
 
 _attr_name
 
 _attr_preset_mode
 
 _attr_preset_modes
 
 _attr_supported_features
 
 _attr_temperature_unit
 
 _attr_unique_id
 
 _cold_tolerance
 
 _cur_temp
 
 _hot_tolerance
 
 _hvac_mode
 
 _keep_alive
 
 _max_temp
 
 _min_temp
 
 _presets
 
 _saved_target_temp
 
 _target_temp
 
 _temp_lock
 
 _temp_precision
 
 _temp_target_temperature_step
 

Static Private Attributes

bool _attr_should_poll = False
 
bool _enable_turn_on_off_backwards_compatibility = False
 

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

Representation of a Generic Thermostat device.

Definition at line 204 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.generic_thermostat.climate.GenericThermostat.__init__ (   self,
HomeAssistant  hass,
str  name,
str  heater_entity_id,
str  sensor_entity_id,
float | None  min_temp,
float | None  max_temp,
float | None  target_temp,
bool | None  ac_mode,
timedelta | None  min_cycle_duration,
float  cold_tolerance,
float  hot_tolerance,
timedelta | None  keep_alive,
HVACMode | None  initial_hvac_mode,
dict[str, float presets,
float | None  precision,
float | None  target_temperature_step,
UnitOfTemperature  unit,
str | None  unique_id 
)
Initialize the thermostat.

Definition at line 210 of file climate.py.

Member Function Documentation

◆ _async_control_heating()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._async_control_heating (   self,
datetime | None   time = None,
bool   force = False 
)
private
Check if we need to turn heating on or off.

Definition at line 493 of file climate.py.

◆ _async_heater_turn_off()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._async_heater_turn_off (   self)
private
Turn heater toggleable device off.

Definition at line 576 of file climate.py.

◆ _async_heater_turn_on()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._async_heater_turn_on (   self)
private
Turn heater toggleable device on.

Definition at line 569 of file climate.py.

◆ _async_sensor_changed()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._async_sensor_changed (   self,
Event[EventStateChangedData event 
)
private
Handle temperature changes.

Definition at line 447 of file climate.py.

◆ _async_switch_changed()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._async_switch_changed (   self,
Event[EventStateChangedData event 
)
private
Handle heater switch state changes.

Definition at line 470 of file climate.py.

◆ _async_update_temp()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._async_update_temp (   self,
State  state 
)
private
Update thermostat with latest state from sensor.

Definition at line 483 of file climate.py.

◆ _check_switch_initial_state()

None homeassistant.components.generic_thermostat.climate.GenericThermostat._check_switch_initial_state (   self)
private
Prevent the device from keep running if HVACMode.OFF.

Definition at line 457 of file climate.py.

◆ _is_device_active()

bool | None homeassistant.components.generic_thermostat.climate.GenericThermostat._is_device_active (   self)
private
If the toggleable device is currently active.

Definition at line 562 of file climate.py.

◆ async_added_to_hass()

None homeassistant.components.generic_thermostat.climate.GenericThermostat.async_added_to_hass (   self)
Run when entity about to be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 273 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.generic_thermostat.climate.GenericThermostat.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set hvac mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 403 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.generic_thermostat.climate.GenericThermostat.async_set_preset_mode (   self,
str  preset_mode 
)
Set new preset mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 583 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.generic_thermostat.climate.GenericThermostat.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 421 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.generic_thermostat.climate.GenericThermostat.current_temperature (   self)
Return the sensor temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 375 of file climate.py.

◆ hvac_action()

HVACAction homeassistant.components.generic_thermostat.climate.GenericThermostat.hvac_action (   self)
Return the current running hvac operation if supported.

Need to be one of CURRENT_HVAC_*.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 385 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.generic_thermostat.climate.GenericThermostat.hvac_mode (   self)
Return current operation.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 380 of file climate.py.

◆ max_temp()

float homeassistant.components.generic_thermostat.climate.GenericThermostat.max_temp (   self)
Return the maximum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 439 of file climate.py.

◆ min_temp()

float homeassistant.components.generic_thermostat.climate.GenericThermostat.min_temp (   self)
Return the minimum temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 430 of file climate.py.

◆ precision()

float homeassistant.components.generic_thermostat.climate.GenericThermostat.precision (   self)
Return the precision of the system.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 360 of file climate.py.

◆ target_temperature()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 399 of file climate.py.

◆ target_temperature_step()

float homeassistant.components.generic_thermostat.climate.GenericThermostat.target_temperature_step (   self)
Return the supported step of target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 367 of file climate.py.

Member Data Documentation

◆ _active

homeassistant.components.generic_thermostat.climate.GenericThermostat._active
private

Definition at line 252 of file climate.py.

◆ _attr_device_info

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_device_info
private

Definition at line 235 of file climate.py.

◆ _attr_hvac_modes

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_hvac_modes
private

Definition at line 249 of file climate.py.

◆ _attr_name

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_name
private

Definition at line 232 of file climate.py.

◆ _attr_preset_mode

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_preset_mode
private

Definition at line 257 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_preset_modes
private

Definition at line 268 of file climate.py.

◆ _attr_should_poll

bool homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_should_poll = False
staticprivate

Definition at line 207 of file climate.py.

◆ _attr_supported_features

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_supported_features
private

Definition at line 261 of file climate.py.

◆ _attr_temperature_unit

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_temperature_unit
private

Definition at line 259 of file climate.py.

◆ _attr_unique_id

homeassistant.components.generic_thermostat.climate.GenericThermostat._attr_unique_id
private

Definition at line 260 of file climate.py.

◆ _cold_tolerance

homeassistant.components.generic_thermostat.climate.GenericThermostat._cold_tolerance
private

Definition at line 241 of file climate.py.

◆ _cur_temp

homeassistant.components.generic_thermostat.climate.GenericThermostat._cur_temp
private

Definition at line 489 of file climate.py.

◆ _enable_turn_on_off_backwards_compatibility

bool homeassistant.components.generic_thermostat.climate.GenericThermostat._enable_turn_on_off_backwards_compatibility = False
staticprivate

Definition at line 208 of file climate.py.

◆ _hot_tolerance

homeassistant.components.generic_thermostat.climate.GenericThermostat._hot_tolerance
private

Definition at line 242 of file climate.py.

◆ _hvac_mode

homeassistant.components.generic_thermostat.climate.GenericThermostat._hvac_mode
private

Definition at line 244 of file climate.py.

◆ _keep_alive

homeassistant.components.generic_thermostat.climate.GenericThermostat._keep_alive
private

Definition at line 243 of file climate.py.

◆ _max_temp

homeassistant.components.generic_thermostat.climate.GenericThermostat._max_temp
private

Definition at line 256 of file climate.py.

◆ _min_temp

homeassistant.components.generic_thermostat.climate.GenericThermostat._min_temp
private

Definition at line 255 of file climate.py.

◆ _presets

homeassistant.components.generic_thermostat.climate.GenericThermostat._presets
private

Definition at line 271 of file climate.py.

◆ _saved_target_temp

homeassistant.components.generic_thermostat.climate.GenericThermostat._saved_target_temp
private

Definition at line 245 of file climate.py.

◆ _target_temp

homeassistant.components.generic_thermostat.climate.GenericThermostat._target_temp
private

Definition at line 258 of file climate.py.

◆ _temp_lock

homeassistant.components.generic_thermostat.climate.GenericThermostat._temp_lock
private

Definition at line 254 of file climate.py.

◆ _temp_precision

homeassistant.components.generic_thermostat.climate.GenericThermostat._temp_precision
private

Definition at line 246 of file climate.py.

◆ _temp_target_temperature_step

homeassistant.components.generic_thermostat.climate.GenericThermostat._temp_target_temperature_step
private

Definition at line 247 of file climate.py.

◆ ac_mode

homeassistant.components.generic_thermostat.climate.GenericThermostat.ac_mode

Definition at line 239 of file climate.py.

◆ heater_entity_id

homeassistant.components.generic_thermostat.climate.GenericThermostat.heater_entity_id

Definition at line 233 of file climate.py.

◆ min_cycle_duration

homeassistant.components.generic_thermostat.climate.GenericThermostat.min_cycle_duration

Definition at line 240 of file climate.py.

◆ sensor_entity_id

homeassistant.components.generic_thermostat.climate.GenericThermostat.sensor_entity_id

Definition at line 234 of file climate.py.


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