Skip to content

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.

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.

PARAMETER DESCRIPTION
temperature

The standby temperature in °C

TYPE: int

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_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)