Skip to main content

Buffer tank

Endpoint group client.buffer_tank (BufferTankEndpoints).

API Endpoints to send and retrieve the buffer tank data.

Example

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

get_name​

async def get_name(position: int = 1) -> str

Get the buffer tank name.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • str: Buffer tank name

get_current_top_temperature​

async def get_current_top_temperature(position: int = 1) -> float

Get the current top temperature from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

get_current_bottom_temperature​

async def get_current_bottom_temperature(position: int = 1) -> float

Get the current bottom temperature from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

get_operating_mode​

async def get_operating_mode(position: int = 1, *, human_readable: bool = True) -> int | str

Get the operating mode from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1
  • human_readable bool (default: True): Return a human-readable string

Returns

  • int | str: 0 (OFF) / 1 (ON) / 2 (HEAT_UP)

set_operating_mode​

async def set_operating_mode(mode: int | str, position: int = 1) -> None

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.

Parameters

  • mode int | str: Set the mode as integer or string (human-readable) e.g. 0 or OFF
  • position int (default: 1): Position of the buffer tank, starting at 1

get_standby_temperature​

async def get_standby_temperature(position: int = 1) -> float

Get the standby temperature from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

set_standby_temperature​

async def set_standby_temperature(temperature: float, position: int = 1) -> None

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.

Parameters

  • temperature float: The standby temperature in °C
  • position int (default: 1): Position of the buffer tank, starting at 1

get_target_temperature​

async def get_target_temperature(position: int = 1) -> float

Get the target temperature from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

get_excess_energy_target_temperature​

async def get_excess_energy_target_temperature(position: int = 1) -> float

Get the excess energy target temperature from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

set_excess_energy_target_temperature​

async def set_excess_energy_target_temperature(temperature: float, position: int = 1) -> None

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.

Parameters

  • temperature float: The excess energy target temperature in °C
  • position int (default: 1): Position of the buffer tank, starting at 1

get_excess_energy_target_temperature_hysteresis​

async def get_excess_energy_target_temperature_hysteresis(position: int = 1) -> float

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

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

set_excess_energy_target_temperature_hysteresis​

async def set_excess_energy_target_temperature_hysteresis(
    temperature: float,
    position: int = 1,
) -> None

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.

Parameters

  • temperature float: The excess energy target temperature in °C
  • position int (default: 1): Position of the buffer tank, starting at 1

get_outdoor_temperature_excess_energy_limit​

async def get_outdoor_temperature_excess_energy_limit(position: int = 1) -> float

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

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1

Returns

  • float: Temperature in °C

set_outdoor_temperature_excess_energy_limit​

async def set_outdoor_temperature_excess_energy_limit(temperature: float, position: int = 1) -> None

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.

Parameters

  • temperature float: The outdoor temperature excess energy limit temperature in °C
  • position int (default: 1): Position of the buffer tank, starting at 1

get_use_excess_energy​

async def get_use_excess_energy(position: int = 1, *, human_readable: bool = True) -> int | str

Get the use excess energy state.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1
  • human_readable bool (default: True): Return a human-readable string

Returns

  • int | str: (0) OFF / (1) ON

set_use_excess_energy​

async def set_use_excess_energy(mode: int | str, position: int = 1) -> None

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.

Parameters

  • mode int | str: Set the mode as integer or string (human-readable) e.g. 0 or OFF
  • position int (default: 1): Position of the buffer tank, starting at 1

get_excess_energy_mode​

async def get_excess_energy_mode(position: int = 1, *, human_readable: bool = True) -> int | str

Get the excess energy mode.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1
  • human_readable bool (default: True): Return a human-readable string

Returns

  • int | str: (0) OFF / (1) HEATING / (2) COOLING

get_heat_request​

async def get_heat_request(position: int = 1, *, human_readable: bool = True) -> int | str

Get the heat request state from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1
  • human_readable bool (default: True): Return a human-readable string

Returns

  • int | str: 0 (OFF) / 1 (ON)

get_cool_request​

async def get_cool_request(position: int = 1, *, human_readable: bool = True) -> int | str

Get the cool request state from the buffer tank.

Parameters

  • position int (default: 1): Position of the buffer tank, starting at 1
  • human_readable bool (default: True): Return a human-readable string

Returns

  • int | str: 0 (OFF) / 1 (ON)
KEBAKEBALatest version on PyPI

An asynchronous Python client for the KEBA KeEnergy Web HMI, used by the Home Assistant integration.

A community project, not affiliated with or endorsed by KEBA. KEBA is a registered trademark of its owner.

Requires Python 3.11 or newer.

View source on GitHub
View known issues
Request a feature
View on PyPI
Changelog

Maintainer

@mh-superbox

On this page