Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tado.water_heater.TadoWaterHeater Class Reference
Inheritance diagram for homeassistant.components.tado.water_heater.TadoWaterHeater:
[legend]
Collaboration diagram for homeassistant.components.tado.water_heater.TadoWaterHeater:
[legend]

Public Member Functions

None __init__ (self, TadoConnector tado, str zone_name, int zone_id, bool supports_temperature_control, min_temp, max_temp)
 
None async_added_to_hass (self)
 
str|None current_operation (self)
 
bool is_away_mode_on (self)
 
float max_temp (self)
 
float min_temp (self)
 
None set_operation_mode (self, str operation_mode)
 
None set_temperature (self, **Any kwargs)
 
def set_timer (self, int time_period, float|None temperature=None)
 
float|None target_temperature (self)
 
- Public Member Functions inherited from homeassistant.components.tado.entity.TadoZoneEntity
None __init__ (self, str zone_name, int home_id, int zone_id)
 
- 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)
 
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.components.water_heater.WaterHeaterEntity
None async_handle_set_operation_mode (self, str operation_mode)
 
None async_set_operation_mode (self, str operation_mode)
 
None async_set_temperature (self, **Any kwargs)
 
None async_turn_away_mode_off (self)
 
None async_turn_away_mode_on (self)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
dict[str, Any] capability_attributes (self)
 
float|None current_temperature (self)
 
list[str]|None operation_list (self)
 
float precision (self)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
WaterHeaterEntityFeature supported_features (self)
 
WaterHeaterEntityFeature supported_features_compat (self)
 
float|None target_temperature_high (self)
 
float|None target_temperature_low (self)
 
str temperature_unit (self)
 
None turn_away_mode_off (self)
 
None turn_away_mode_on (self)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Public Attributes

 zone_id
 
- Public Attributes inherited from homeassistant.components.tado.entity.TadoZoneEntity
 zone_id
 
 zone_name
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Member Functions

None _async_update_callback (self)
 
None _async_update_data (self)
 
def _control_heater (self, str|None hvac_mode=None, float|None target_temp=None, int|None duration=None)
 

Private Attributes

 _attr_supported_features
 
 _attr_unique_id
 
 _current_tado_hvac_mode
 
 _device_is_active
 
 _max_temperature
 
 _min_temperature
 
 _overlay_mode
 
 _supports_temperature_control
 
 _tado
 
 _tado_zone_data
 
 _target_temp
 

Static Private Attributes

 _attr_name = None
 
 _attr_operation_list = OPERATION_MODES
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.water_heater.WaterHeaterEntity
 None
 
 WaterHeaterEntityFeature
 

Detailed Description

Representation of a Tado water heater.

Definition at line 128 of file water_heater.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tado.water_heater.TadoWaterHeater.__init__ (   self,
TadoConnector  tado,
str  zone_name,
int  zone_id,
bool  supports_temperature_control,
  min_temp,
  max_temp 
)
Initialize of Tado water heater entity.

Definition at line 135 of file water_heater.py.

Member Function Documentation

◆ _async_update_callback()

None homeassistant.components.tado.water_heater.TadoWaterHeater._async_update_callback (   self)
private
Load tado data and update state.

Definition at line 244 of file water_heater.py.

◆ _async_update_data()

None homeassistant.components.tado.water_heater.TadoWaterHeater._async_update_data (   self)
private
Load tado data.

Definition at line 250 of file water_heater.py.

◆ _control_heater()

def homeassistant.components.tado.water_heater.TadoWaterHeater._control_heater (   self,
str | None   hvac_mode = None,
float | None   target_temp = None,
int | None   duration = None 
)
private
Send new target temperature.

Definition at line 256 of file water_heater.py.

◆ async_added_to_hass()

None homeassistant.components.tado.water_heater.TadoWaterHeater.async_added_to_hass (   self)
Register for sensor updates.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 167 of file water_heater.py.

◆ current_operation()

str | None homeassistant.components.tado.water_heater.TadoWaterHeater.current_operation (   self)
Return current readable operation mode.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 181 of file water_heater.py.

◆ is_away_mode_on()

bool homeassistant.components.tado.water_heater.TadoWaterHeater.is_away_mode_on (   self)
Return true if away mode is on.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 191 of file water_heater.py.

◆ max_temp()

float homeassistant.components.tado.water_heater.TadoWaterHeater.max_temp (   self)
Return the maximum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 201 of file water_heater.py.

◆ min_temp()

float homeassistant.components.tado.water_heater.TadoWaterHeater.min_temp (   self)
Return the minimum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 196 of file water_heater.py.

◆ set_operation_mode()

None homeassistant.components.tado.water_heater.TadoWaterHeater.set_operation_mode (   self,
str  operation_mode 
)
Set new operation mode.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 205 of file water_heater.py.

◆ set_temperature()

None homeassistant.components.tado.water_heater.TadoWaterHeater.set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 227 of file water_heater.py.

◆ set_timer()

def homeassistant.components.tado.water_heater.TadoWaterHeater.set_timer (   self,
int  time_period,
float | None   temperature = None 
)
Set the timer on the entity, and temperature if supported.

Definition at line 218 of file water_heater.py.

◆ target_temperature()

float | None homeassistant.components.tado.water_heater.TadoWaterHeater.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 186 of file water_heater.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.tado.water_heater.TadoWaterHeater._attr_name = None
staticprivate

Definition at line 131 of file water_heater.py.

◆ _attr_operation_list

homeassistant.components.tado.water_heater.TadoWaterHeater._attr_operation_list = OPERATION_MODES
staticprivate

Definition at line 132 of file water_heater.py.

◆ _attr_supported_features

homeassistant.components.tado.water_heater.TadoWaterHeater._attr_supported_features
private

Definition at line 159 of file water_heater.py.

◆ _attr_temperature_unit

homeassistant.components.tado.water_heater.TadoWaterHeater._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 133 of file water_heater.py.

◆ _attr_unique_id

homeassistant.components.tado.water_heater.TadoWaterHeater._attr_unique_id
private

Definition at line 149 of file water_heater.py.

◆ _current_tado_hvac_mode

homeassistant.components.tado.water_heater.TadoWaterHeater._current_tado_hvac_mode
private

Definition at line 163 of file water_heater.py.

◆ _device_is_active

homeassistant.components.tado.water_heater.TadoWaterHeater._device_is_active
private

Definition at line 151 of file water_heater.py.

◆ _max_temperature

homeassistant.components.tado.water_heater.TadoWaterHeater._max_temperature
private

Definition at line 155 of file water_heater.py.

◆ _min_temperature

homeassistant.components.tado.water_heater.TadoWaterHeater._min_temperature
private

Definition at line 154 of file water_heater.py.

◆ _overlay_mode

homeassistant.components.tado.water_heater.TadoWaterHeater._overlay_mode
private

Definition at line 164 of file water_heater.py.

◆ _supports_temperature_control

homeassistant.components.tado.water_heater.TadoWaterHeater._supports_temperature_control
private

Definition at line 153 of file water_heater.py.

◆ _tado

homeassistant.components.tado.water_heater.TadoWaterHeater._tado
private

Definition at line 145 of file water_heater.py.

◆ _tado_zone_data

homeassistant.components.tado.water_heater.TadoWaterHeater._tado_zone_data
private

Definition at line 253 of file water_heater.py.

◆ _target_temp

homeassistant.components.tado.water_heater.TadoWaterHeater._target_temp
private

Definition at line 267 of file water_heater.py.

◆ zone_id

homeassistant.components.tado.water_heater.TadoWaterHeater.zone_id

Definition at line 148 of file water_heater.py.


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