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

Public Member Functions

None __init__ (self, EvoBroker evo_broker, evo.ControlSystem evo_device)
 
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)
 
None async_tcs_svc_request (self, str service, dict[str, Any] data)
 
None async_update (self)
 
float|None current_temperature (self)
 
HVACMode hvac_mode (self)
 
str|None preset_mode (self)
 
- Public Member Functions inherited from homeassistant.components.evohome.entity.EvoDevice
None __init__ (self, EvoBroker evo_broker, evo.ControlSystem|evo.HotWater|evo.Zone evo_device)
 
None async_added_to_hass (self)
 
None async_refresh (self, dict|None payload=None)
 
None async_zone_svc_request (self, str service, dict[str, Any] data)
 
dict[str, Any] extra_state_attributes (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_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)
 
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)
 
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.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)
 
HVACAction|None hvac_action (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)
 
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 (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
float|None target_temperature_step (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)
 

Private Member Functions

None _set_tcs_mode (self, str mode, datetime|None until=None)
 

Private Attributes

 _attr_name
 
 _attr_preset_modes
 
 _attr_supported_features
 
 _attr_unique_id
 
 _device_state_attrs
 
 _evo_id
 
 _evo_modes
 

Static Private Attributes

string _attr_icon = "mdi:thermostat"
 
 _attr_precision = PRECISION_TENTHS
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 hvac_mode
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.climate.ClimateEntity
 bool
 
 ClimateEntityFeature
 
 float
 
 None
 

Detailed Description

Base for any evohome-compatible controller.

The Controller (aka TCS, temperature control system) is the parent of all the child
(CH/DHW) devices. It is implemented as a Climate entity to expose the controller's
operating modes to HA.

It is assumed there is only one TCS per location, and they are thus synonymous.

Definition at line 338 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.evohome.climate.EvoController.__init__ (   self,
EvoBroker  evo_broker,
evo.ControlSystem  evo_device 
)
Initialize an evohome-compatible controller.

Definition at line 353 of file climate.py.

Member Function Documentation

◆ _set_tcs_mode()

None homeassistant.components.evohome.climate.EvoController._set_tcs_mode (   self,
str  mode,
datetime | None   until = None 
)
private
Set a Controller to any of its native EVO_* operating modes.

Definition at line 394 of file climate.py.

◆ async_set_hvac_mode()

None homeassistant.components.evohome.climate.EvoController.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set an operating mode for a Controller.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 431 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.evohome.climate.EvoController.async_set_preset_mode (   self,
str  preset_mode 
)
Set the preset mode; if None, then revert to 'Auto' mode.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 441 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.evohome.climate.EvoController.async_set_temperature (   self,
**Any  kwargs 
)
Raise exception as Controllers don't have a target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 427 of file climate.py.

◆ async_tcs_svc_request()

None homeassistant.components.evohome.climate.EvoController.async_tcs_svc_request (   self,
str  service,
dict[str, Any]  data 
)
Process a service request (system mode) for a controller.

Data validation is not required, it will have been done upstream.

Reimplemented from homeassistant.components.evohome.entity.EvoDevice.

Definition at line 372 of file climate.py.

◆ async_update()

None homeassistant.components.evohome.climate.EvoController.async_update (   self)
Get the latest state data for a Controller.

Definition at line 445 of file climate.py.

◆ current_temperature()

float | None homeassistant.components.evohome.climate.EvoController.current_temperature (   self)
Return the average current temperature of the heating Zones.

Controllers do not have a current temp, but one is expected by HA.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 408 of file climate.py.

◆ hvac_mode()

HVACMode homeassistant.components.evohome.climate.EvoController.hvac_mode (   self)
Return the current operating mode of a Controller.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 402 of file climate.py.

◆ preset_mode()

str | None homeassistant.components.evohome.climate.EvoController.preset_mode (   self)
Return the current preset mode, e.g., home, away, temp.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 421 of file climate.py.

Member Data Documentation

◆ _attr_icon

string homeassistant.components.evohome.climate.EvoController._attr_icon = "mdi:thermostat"
staticprivate

Definition at line 348 of file climate.py.

◆ _attr_name

homeassistant.components.evohome.climate.EvoController._attr_name
private

Definition at line 360 of file climate.py.

◆ _attr_precision

homeassistant.components.evohome.climate.EvoController._attr_precision = PRECISION_TENTHS
staticprivate

Definition at line 349 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.evohome.climate.EvoController._attr_preset_modes
private

Definition at line 363 of file climate.py.

◆ _attr_supported_features

homeassistant.components.evohome.climate.EvoController._attr_supported_features
private

Definition at line 367 of file climate.py.

◆ _attr_unique_id

homeassistant.components.evohome.climate.EvoController._attr_unique_id
private

Definition at line 359 of file climate.py.

◆ _device_state_attrs

homeassistant.components.evohome.climate.EvoController._device_state_attrs
private

Definition at line 447 of file climate.py.

◆ _evo_id

homeassistant.components.evohome.climate.EvoController._evo_id
private

Definition at line 357 of file climate.py.

◆ _evo_modes

homeassistant.components.evohome.climate.EvoController._evo_modes
private

Definition at line 362 of file climate.py.


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