Hot water tanks

API Endpoints to send and retrieve the hot water tank data.

Examples:

>>> client = KebaKeEnergyAPI(
>>>     host="ap4400.local",
>>>     username="test",
>>>     password="test",
>>>     ssl=True,
>>>     skip_ssl_verification=True
>>> )
>>> client.hot_water_tank.get_name()

get_name(position=1) async

Get the hot water tank name.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
string	Hot water tank name

get_current_temperature(position=1) async

Get the current temperature from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_operating_mode(position=1, *, human_readable=True) async

Get the operating mode from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1
human_readable	Return a human-readable string TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
integer or string	(0) OFF / (1) AUTO / (2) ON / (3) HEAT_UP

set_operating_mode(mode, position=1) async

Set the operating mode from the hot water tank.

PARAMETER	DESCRIPTION
mode	Set the mode as integer or string (human-readable) e.g. 0 or OFF TYPE: int | str
position	The number of the hot water tanks TYPE: int DEFAULT: 1

get_min_target_temperature(position=1) async

Get the minimum target temperature from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_max_target_temperature(position=1) async

Get the maximum target temperature from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_standby_temperature(position=1) async

Get the standby temperature from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

set_standby_temperature(temperature, position=1) async

Set the standby temperature from the hot water tank.

PARAMETER	DESCRIPTION
temperature	The standby temperature in °C TYPE: int
position	The number of the hot water tanks TYPE: int DEFAULT: 1

get_target_temperature(position=1) async

Get the target temperature from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature(temperature, position=1) async

Set the target temperature from the hot water tank.

PARAMETER	DESCRIPTION
temperature	The target temperature in °C TYPE: int
position	The number of the hot water tanks TYPE: int DEFAULT: 1

get_heat_request(position=1, *, human_readable=True) async

Get the heat request state from the hot water tank.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1
human_readable	Return a human-readable string TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
integer or string	0 (OFF) / 1 (ON)

get_hot_water_flow(position=1, *, human_readable=True) async

Get the hot water flow from the fresh water module.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1
human_readable	Return a human-readable string TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
integer or string	0 (OFF) / 1 (ON)

get_fresh_water_module_temperature(position=1) async

Get the fresh water module temperature.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_fresh_water_module_pump_speed(position=1) async

Get the fresh water module pump speed.

PARAMETER	DESCRIPTION
position	The number of the hot water tanks TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Pump speed in percent