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

Public Member Functions

None __init__ (self, str|None device_serial, PyViCareDeviceConfig device_config, PyViCareDevice device, PyViCareHeatingCircuit circuit)
 
str|None current_operation (self)
 
None set_temperature (self, **Any kwargs)
 
None update (self)
 
- Public Member Functions inherited from homeassistant.components.vicare.entity.ViCareEntity
None __init__ (self, str unique_id_suffix, str|None device_serial, PyViCareDeviceConfig device_config, PyViCareDevice device, PyViCareHeatingDeviceComponent|None component=None)
 
- 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_added_to_hass (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)
 
bool|None is_away_mode_on (self)
 
float max_temp (self)
 
float min_temp (self)
 
list[str]|None operation_list (self)
 
float precision (self)
 
None set_operation_mode (self, str operation_mode)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
WaterHeaterEntityFeature supported_features (self)
 
WaterHeaterEntityFeature supported_features_compat (self)
 
float|None target_temperature (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)
 

Static Public Attributes

 None
 
- 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
 

Private Attributes

 _attr_current_temperature
 
 _attr_target_temperature
 
 _circuit
 
 _current_mode
 

Static Private Attributes

 _attr_max_temp = VICARE_TEMP_WATER_MAX
 
 _attr_min_temp = VICARE_TEMP_WATER_MIN
 
 _attr_operation_list = list(HA_TO_VICARE_HVAC_DHW)
 
 _attr_precision = PRECISION_TENTHS
 
 _attr_supported_features = WaterHeaterEntityFeature.TARGET_TEMPERATURE
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 
string _attr_translation_key = "domestic_hot_water"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Representation of the ViCare domestic hot water device.

Definition at line 98 of file water_heater.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.vicare.water_heater.ViCareWater.__init__ (   self,
str | None  device_serial,
PyViCareDeviceConfig  device_config,
PyViCareDevice  device,
PyViCareHeatingCircuit  circuit 
)
Initialize the DHW water_heater device.

Definition at line 110 of file water_heater.py.

Member Function Documentation

◆ current_operation()

str | None homeassistant.components.vicare.water_heater.ViCareWater.current_operation (   self)
Return current operation ie. heat, cool, idle.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 154 of file water_heater.py.

◆ set_temperature()

None homeassistant.components.vicare.water_heater.ViCareWater.set_temperature (   self,
**Any  kwargs 
)
Set new target temperatures.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 147 of file water_heater.py.

◆ update()

None homeassistant.components.vicare.water_heater.ViCareWater.update (   self)
Let HA know there has been an update from the ViCare API.

Definition at line 122 of file water_heater.py.

Member Data Documentation

◆ _attr_current_temperature

homeassistant.components.vicare.water_heater.ViCareWater._attr_current_temperature
private

Definition at line 126 of file water_heater.py.

◆ _attr_max_temp

homeassistant.components.vicare.water_heater.ViCareWater._attr_max_temp = VICARE_TEMP_WATER_MAX
staticprivate

Definition at line 105 of file water_heater.py.

◆ _attr_min_temp

homeassistant.components.vicare.water_heater.ViCareWater._attr_min_temp = VICARE_TEMP_WATER_MIN
staticprivate

Definition at line 104 of file water_heater.py.

◆ _attr_operation_list

homeassistant.components.vicare.water_heater.ViCareWater._attr_operation_list = list(HA_TO_VICARE_HVAC_DHW)
staticprivate

Definition at line 106 of file water_heater.py.

◆ _attr_precision

homeassistant.components.vicare.water_heater.ViCareWater._attr_precision = PRECISION_TENTHS
staticprivate

Definition at line 101 of file water_heater.py.

◆ _attr_supported_features

homeassistant.components.vicare.water_heater.ViCareWater._attr_supported_features = WaterHeaterEntityFeature.TARGET_TEMPERATURE
staticprivate

Definition at line 102 of file water_heater.py.

◆ _attr_target_temperature

homeassistant.components.vicare.water_heater.ViCareWater._attr_target_temperature
private

Definition at line 131 of file water_heater.py.

◆ _attr_temperature_unit

homeassistant.components.vicare.water_heater.ViCareWater._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 103 of file water_heater.py.

◆ _attr_translation_key

string homeassistant.components.vicare.water_heater.ViCareWater._attr_translation_key = "domestic_hot_water"
staticprivate

Definition at line 107 of file water_heater.py.

◆ _circuit

homeassistant.components.vicare.water_heater.ViCareWater._circuit
private

Definition at line 119 of file water_heater.py.

◆ _current_mode

homeassistant.components.vicare.water_heater.ViCareWater._current_mode
private

Definition at line 136 of file water_heater.py.

◆ None

homeassistant.components.vicare.water_heater.ViCareWater.None
static

Definition at line 108 of file water_heater.py.


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