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

Public Member Functions

None __init__ (self, OSOEnergy instance, OSOEnergyWaterHeaterData entity_data)
 
ServiceResponse async_get_profile (self)
 
None async_oso_turn_off (self, until_temp_limit)
 
None async_oso_turn_on (self, until_temp_limit)
 
None async_set_profile (self, **Any kwargs)
 
None async_set_temperature (self, **Any kwargs)
 
None async_set_v40_min (self, v40_min)
 
None async_turn_off (self, **kwargs)
 
None async_turn_on (self, **kwargs)
 
None async_update (self)
 
bool available (self)
 
str current_operation (self)
 
float current_temperature (self)
 
float max_temp (self)
 
float min_temp (self)
 
float target_temperature (self)
 
float target_temperature_high (self)
 
float target_temperature_low (self)
 
- 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_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)
 
bool|None is_away_mode_on (self)
 
list[str]|None operation_list (self)
 
float precision (self)
 
None set_operation_mode (self, str operation_mode)
 
None set_temperature (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
WaterHeaterEntityFeature supported_features (self)
 
WaterHeaterEntityFeature supported_features_compat (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 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)
 
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 Attributes

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

Private Attributes

 _attr_unique_id
 

Static Private Attributes

 _attr_name = None
 
tuple _attr_supported_features
 
 _attr_temperature_unit = UnitOfTemperature.CELSIUS
 

Additional Inherited Members

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

Detailed Description

OSO Energy Water Heater Device.

Definition at line 158 of file water_heater.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.__init__ (   self,
OSOEnergy  instance,
OSOEnergyWaterHeaterData  entity_data 
)
Initialize the OSO Energy water heater.

Definition at line 169 of file water_heater.py.

Member Function Documentation

◆ async_get_profile()

ServiceResponse homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_get_profile (   self)
Return the current temperature profile of the device.

Definition at line 244 of file water_heater.py.

◆ async_oso_turn_off()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_oso_turn_off (   self,
  until_temp_limit 
)
Handle the service call.

Definition at line 266 of file water_heater.py.

◆ async_oso_turn_on()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_oso_turn_on (   self,
  until_temp_limit 
)
Handle the service call.

Definition at line 270 of file water_heater.py.

◆ async_set_profile()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_set_profile (   self,
**Any  kwargs 
)
Handle the service call.

Definition at line 250 of file water_heater.py.

◆ async_set_temperature()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_set_temperature (   self,
**Any  kwargs 
)
Set new target temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 237 of file water_heater.py.

◆ async_set_v40_min()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_set_v40_min (   self,
  v40_min 
)
Handle the service call.

Definition at line 262 of file water_heater.py.

◆ async_turn_off()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_turn_off (   self,
**  kwargs 
)
Turn off hotwater.

Definition at line 233 of file water_heater.py.

◆ async_turn_on()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_turn_on (   self,
**  kwargs 
)
Turn on hotwater.

Definition at line 229 of file water_heater.py.

◆ async_update()

None homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.async_update (   self)
Update all Node data from Hive.

Definition at line 274 of file water_heater.py.

◆ available()

bool homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.available (   self)
Return if the device is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 179 of file water_heater.py.

◆ current_operation()

str homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.current_operation (   self)
Return current operation.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 184 of file water_heater.py.

◆ current_temperature()

float homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.current_temperature (   self)
Return the current temperature of the heater.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 200 of file water_heater.py.

◆ max_temp()

float homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.max_temp (   self)
Return the maximum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 225 of file water_heater.py.

◆ min_temp()

float homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.min_temp (   self)
Return the minimum temperature.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 220 of file water_heater.py.

◆ target_temperature()

float homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.target_temperature (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 205 of file water_heater.py.

◆ target_temperature_high()

float homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.target_temperature_high (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 210 of file water_heater.py.

◆ target_temperature_low()

float homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.target_temperature_low (   self)
Return the temperature we try to reach.

Reimplemented from homeassistant.components.water_heater.WaterHeaterEntity.

Definition at line 215 of file water_heater.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater._attr_name = None
staticprivate

Definition at line 163 of file water_heater.py.

◆ _attr_supported_features

tuple homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater._attr_supported_features
staticprivate
Initial value:
= (
WaterHeaterEntityFeature.TARGET_TEMPERATURE | WaterHeaterEntityFeature.ON_OFF
)

Definition at line 164 of file water_heater.py.

◆ _attr_temperature_unit

homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater._attr_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 167 of file water_heater.py.

◆ _attr_unique_id

homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater._attr_unique_id
private

Definition at line 176 of file water_heater.py.

◆ entity_data

homeassistant.components.osoenergy.water_heater.OSOEnergyWaterHeater.entity_data

Definition at line 277 of file water_heater.py.


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