Buffer tanks

API Endpoints to send and retrieve the buffer tank data.

Examples:

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

get_name(position=1) async

Get the buffer tank name.

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

RETURNS	DESCRIPTION
string	Buffer tank name

get_current_top_temperature(position=1) async

Get the current top temperature from the buffer tank.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_current_bottom_temperature(position=1) async

Get the current bottom temperature from the buffer tank.

PARAMETER	DESCRIPTION
position	The number of the buffer 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 buffer tank.

PARAMETER	DESCRIPTION
position	The number of the buffer 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) / 2 (HEAT_UP)

set_operating_mode(mode, position=1) async

Set the operating mode from the buffer tank.

Attention! Writing values should remain within normal limits, as is the case with typical use of the Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.

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 buffer tanks TYPE: int DEFAULT: 1

get_standby_temperature(position=1) async

Get the standby temperature from the buffer tank.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_standby_temperature(temperature, position=1) async

Set the standby temperature from the buffer tank.

Attention! Writing values should remain within normal limits, as is the case with typical use of the Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.

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

get_target_temperature(position=1) async

Get the target temperature from the buffer tank.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_excess_energy_target_temperature(position=1) async

Get the excess energy target temperature from the buffer tank.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_excess_energy_target_temperature(temperature, position=1) async

Set the excess energy target temperature from the buffer tank.

Attention! Writing values should remain within normal limits, as is the case with typical use of the Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.

PARAMETER	DESCRIPTION
temperature	The excess energy target temperature in °C TYPE: float
position	The number of the buffer tanks TYPE: int DEFAULT: 1

get_excess_energy_target_temperature_hysteresis(position=1) async

Get the excess energy target temperature hysteresis from the buffer tank.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_excess_energy_target_temperature_hysteresis(temperature, position=1) async

Set the excess energy target temperature hysteresis from the buffer tank.

Attention! Writing values should remain within normal limits, as is the case with typical use of the Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.

PARAMETER	DESCRIPTION
temperature	The excess energy target temperature in °C TYPE: float
position	The number of the buffer tanks TYPE: int DEFAULT: 1

get_outdoor_temperature_excess_energy_limit(position=1) async

Get the outdoor temperature excess energy limit from the buffer tank.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_outdoor_temperature_excess_energy_limit(temperature, position=1) async

Set the outdoor temperature excess energy limit from the buffer tank.

Attention! Writing values should remain within normal limits, as is the case with typical use of the Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.

PARAMETER	DESCRIPTION
temperature	The outdoor temperature excess energy limit temperature in °C TYPE: float
position	The number of the buffer tanks TYPE: int DEFAULT: 1

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

Get the use excess energy state.

PARAMETER	DESCRIPTION
position	The number of the buffer 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

set_use_excess_energy(mode, position=1) async

Set the use excess energy.

Attention! Writing values should remain within normal limits, as is the case with typical use of the Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.

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 buffer tanks TYPE: int DEFAULT: 1

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

Get the excess energy mode.

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

RETURNS	DESCRIPTION
integer or string	(0) OFF / (1) HEATING / (1) COOLING

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

Get the heat request state from the buffer tank.

PARAMETER	DESCRIPTION
position	The number of the buffer 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_cool_request(position=1, *, human_readable=True) async

Get the cool request state from the buffer tank.

PARAMETER	DESCRIPTION
position	The number of the buffer 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)