Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.osoenergy.water_heater Namespace Reference

Classes

class  OSOEnergyWaterHeater
 

Functions

list[JsonValueType] _convert_profile_to_local (list[float] values)
 
dt.datetime _get_local_hour (int utc_hour)
 
dt.datetime _get_utc_hour (int local_hour)
 
None async_setup_entry (HomeAssistant hass, ConfigEntry entry, AddEntitiesCallback async_add_entities)
 

Variables

string ATTR_UNTIL_TEMP_LIMIT = "until_temp_limit"
 
string ATTR_V40MIN = "v40_min"
 
string SERVICE_GET_PROFILE = "get_profile"
 
string SERVICE_SET_PROFILE = "set_profile"
 
string SERVICE_SET_V40MIN = "set_v40_min"
 
string SERVICE_TURN_OFF = "turn_off"
 
string SERVICE_TURN_ON = "turn_on"
 

Detailed Description

Support for OSO Energy water heaters.

Function Documentation

◆ _convert_profile_to_local()

list[JsonValueType] homeassistant.components.osoenergy.water_heater._convert_profile_to_local ( list[float]  values)
private
Convert UTC profile to local.

Receives a device temperature schedule - 24 values for the day where the index represents the hour of the day in UTC.
Converts the schedule to local time.

Args:
    values: list of floats representing the 24 hour temperature schedule for the device
Returns:
    The device temperature schedule in local time.

Definition at line 138 of file water_heater.py.

◆ _get_local_hour()

dt.datetime homeassistant.components.osoenergy.water_heater._get_local_hour ( int  utc_hour)
private
Convert the requested utc hour to a local hour for the day.

Args:
    utc_hour: the utc hour (0-23) for the current day to be converted.

Returns:
    Datetime representation for the requested hour in local time for the day.

Definition at line 123 of file water_heater.py.

◆ _get_utc_hour()

dt.datetime homeassistant.components.osoenergy.water_heater._get_utc_hour ( int  local_hour)
private
Convert the requested local hour to a utc hour for the day.

Args:
    local_hour: the local hour (0-23) for the current day to be converted.

Returns:
    Datetime representation for the requested hour in utc time for the day.

Definition at line 108 of file water_heater.py.

◆ async_setup_entry()

None homeassistant.components.osoenergy.water_heater.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry,
AddEntitiesCallback   async_add_entities 
)
Set up OSO Energy heater based on a config entry.

Definition at line 51 of file water_heater.py.

Variable Documentation

◆ ATTR_UNTIL_TEMP_LIMIT

string homeassistant.components.osoenergy.water_heater.ATTR_UNTIL_TEMP_LIMIT = "until_temp_limit"

Definition at line 29 of file water_heater.py.

◆ ATTR_V40MIN

string homeassistant.components.osoenergy.water_heater.ATTR_V40MIN = "v40_min"

Definition at line 30 of file water_heater.py.

◆ SERVICE_GET_PROFILE

string homeassistant.components.osoenergy.water_heater.SERVICE_GET_PROFILE = "get_profile"

Definition at line 44 of file water_heater.py.

◆ SERVICE_SET_PROFILE

string homeassistant.components.osoenergy.water_heater.SERVICE_SET_PROFILE = "set_profile"

Definition at line 45 of file water_heater.py.

◆ SERVICE_SET_V40MIN

string homeassistant.components.osoenergy.water_heater.SERVICE_SET_V40MIN = "set_v40_min"

Definition at line 46 of file water_heater.py.

◆ SERVICE_TURN_OFF

string homeassistant.components.osoenergy.water_heater.SERVICE_TURN_OFF = "turn_off"

Definition at line 47 of file water_heater.py.

◆ SERVICE_TURN_ON

string homeassistant.components.osoenergy.water_heater.SERVICE_TURN_ON = "turn_on"

Definition at line 48 of file water_heater.py.