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

Public Member Functions

None __init__ (self, EvoBroker evo_broker, evo.Zone 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_update (self)
 
None async_zone_svc_request (self, str service, dict[str, Any] data)
 
HVACMode|None hvac_mode (self)
 
float max_temp (self)
 
float min_temp (self)
 
str|None name (self)
 
str|None preset_mode (self)
 
float|None target_temperature (self)
 
- Public Member Functions inherited from homeassistant.components.evohome.entity.EvoChild
None __init__ (self, EvoBroker evo_broker, evo.HotWater|evo.Zone evo_device)
 
float|None current_temperature (self)
 
dict[str, Any] setpoints (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_tcs_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)
 
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)
 
float|None current_temperature (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 min_humidity (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_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 Attributes

 _attr_precision
 
 _attr_supported_features
 
 _attr_unique_id
 
 _evo_id
 

Static Private Attributes

 _attr_preset_modes = list(HA_PRESET_TO_EVO)
 

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 heating zone.

Definition at line 156 of file climate.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.evohome.climate.EvoZone.__init__ (   self,
EvoBroker  evo_broker,
evo.Zone  evo_device 
)
Initialize an evohome-compatible heating zone.

Definition at line 163 of file climate.py.

Member Function Documentation

◆ async_set_hvac_mode()

None homeassistant.components.evohome.climate.EvoZone.async_set_hvac_mode (   self,
HVACMode  hvac_mode 
)
Set a Zone to one of its native EVO_* operating modes.

Zones inherit their _effective_ operating mode from their Controller.

Usually, Zones are in 'FollowSchedule' mode, where their setpoints are a
function of their own schedule and the Controller's operating mode, e.g.
'AutoWithEco' mode means their setpoint is (by default) 3C less than scheduled.

However, Zones can _override_ these setpoints, either indefinitely,
'PermanentOverride' mode, or for a set period of time, 'TemporaryOverride' mode
(after which they will revert back to 'FollowSchedule' mode).

Finally, some of the Controller's operating modes are _forced_ upon the Zones,
regardless of any override mode, e.g. 'HeatingOff', Zones to (by default) 5C,
and 'Away', Zones to (by default) 12C.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 284 of file climate.py.

◆ async_set_preset_mode()

None homeassistant.components.evohome.climate.EvoZone.async_set_preset_mode (   self,
str  preset_mode 
)
Set the preset mode; if None, then revert to following the schedule.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 308 of file climate.py.

◆ async_set_temperature()

None homeassistant.components.evohome.climate.EvoZone.async_set_temperature (   self,
**Any  kwargs 
)
Set a new target temperature.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 263 of file climate.py.

◆ async_update()

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

Reimplemented from homeassistant.components.evohome.entity.EvoChild.

Definition at line 330 of file climate.py.

◆ async_zone_svc_request()

None homeassistant.components.evohome.climate.EvoZone.async_zone_svc_request (   self,
str  service,
dict[str, Any]  data 
)
Process a service request (setpoint override) for a zone.

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

Definition at line 189 of file climate.py.

◆ hvac_mode()

HVACMode | None homeassistant.components.evohome.climate.EvoZone.hvac_mode (   self)
Return the current operating mode of a Zone.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 219 of file climate.py.

◆ max_temp()

float homeassistant.components.evohome.climate.EvoZone.max_temp (   self)
Return the maximum target temperature of a Zone.

The default is 35, but is user-configurable within 21-35 (in Celsius).

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 254 of file climate.py.

◆ min_temp()

float homeassistant.components.evohome.climate.EvoZone.min_temp (   self)
Return the minimum target temperature of a Zone.

The default is 5, but is user-configurable within 5-21 (in Celsius).

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 244 of file climate.py.

◆ name()

str | None homeassistant.components.evohome.climate.EvoZone.name (   self)
Return the name of the evohome entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 214 of file climate.py.

◆ preset_mode()

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

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 235 of file climate.py.

◆ target_temperature()

float | None homeassistant.components.evohome.climate.EvoZone.target_temperature (   self)
Return the target temperature of a Zone.

Reimplemented from homeassistant.components.climate.ClimateEntity.

Definition at line 230 of file climate.py.

Member Data Documentation

◆ _attr_precision

homeassistant.components.evohome.climate.EvoZone._attr_precision
private

Definition at line 176 of file climate.py.

◆ _attr_preset_modes

homeassistant.components.evohome.climate.EvoZone._attr_preset_modes = list(HA_PRESET_TO_EVO)
staticprivate

Definition at line 159 of file climate.py.

◆ _attr_supported_features

homeassistant.components.evohome.climate.EvoZone._attr_supported_features
private

Definition at line 182 of file climate.py.

◆ _attr_unique_id

homeassistant.components.evohome.climate.EvoZone._attr_unique_id
private

Definition at line 171 of file climate.py.

◆ _evo_id

homeassistant.components.evohome.climate.EvoZone._evo_id
private

Definition at line 167 of file climate.py.


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