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

Public Member Functions

None __init__ (self, EvoBroker evo_broker, evo.HotWater|evo.Zone evo_device)
 
None async_update (self)
 
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)
 
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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
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)
 
dict[str, Any]|None capability_attributes (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)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 

Private Member Functions

None _update_schedule (self)
 

Private Attributes

 _device_state_attrs
 
 _evo_tcs
 
 _schedule
 
 _setpoints
 

Additional Inherited Members

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

Detailed Description

Base for any evohome-compatible child entity (DHW, zone).

This includes (1 to 12) heating zones and (optionally) a DHW controller.

Definition at line 89 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.evohome.entity.EvoChild.__init__ (   self,
EvoBroker  evo_broker,
evo.HotWater | evo.Zone   evo_device 
)
Initialize an evohome-compatible child entity (DHW, zone).

Definition at line 97 of file entity.py.

Member Function Documentation

◆ _update_schedule()

None homeassistant.components.evohome.entity.EvoChild._update_schedule (   self)
private
Get the latest schedule, if any.

Definition at line 183 of file entity.py.

◆ async_update()

None homeassistant.components.evohome.entity.EvoChild.async_update (   self)
Get the latest state data.

Reimplemented in homeassistant.components.evohome.water_heater.EvoDHW, and homeassistant.components.evohome.climate.EvoZone.

Definition at line 204 of file entity.py.

◆ current_temperature()

float | None homeassistant.components.evohome.entity.EvoChild.current_temperature (   self)
Return the current temperature of a Zone.

Definition at line 109 of file entity.py.

◆ setpoints()

dict[str, Any] homeassistant.components.evohome.entity.EvoChild.setpoints (   self)
Return the current/next setpoints from the schedule.

Only Zones & DHW controllers (but not the TCS) can have schedules.

Definition at line 120 of file entity.py.

Member Data Documentation

◆ _device_state_attrs

homeassistant.components.evohome.entity.EvoChild._device_state_attrs
private

Definition at line 211 of file entity.py.

◆ _evo_tcs

homeassistant.components.evohome.entity.EvoChild._evo_tcs
private

Definition at line 103 of file entity.py.

◆ _schedule

homeassistant.components.evohome.entity.EvoChild._schedule
private

Definition at line 198 of file entity.py.

◆ _setpoints

homeassistant.components.evohome.entity.EvoChild._setpoints
private

Definition at line 175 of file entity.py.


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