Skip to main content

Hot water tank

Endpoint group client.hot_water_tank (HotWaterTankEndpoints).

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

Example

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

get_name​

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

Get the hot water tank name.

Parameters

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

Returns

  • str: Hot water tank name

get_current_temperature​

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

Get the current temperature from the hot water tank.

Parameters

  • position int (default: 1): Position of the hot water 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 hot water tank.

Parameters

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

Returns

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

set_operating_mode​

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

Set the operating mode from the hot water 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 hot water tank, starting at 1

get_min_target_temperature​

async def get_min_target_temperature(position: int = 1) -> int

Get the minimum target temperature from the hot water tank.

Parameters

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

Returns

  • int: Temperature in °C

get_max_target_temperature​

async def get_max_target_temperature(position: int = 1) -> int

Get the maximum target temperature from the hot water tank.

Parameters

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

Returns

  • int: Temperature in °C

get_standby_temperature​

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

Get the standby temperature from the hot water tank.

Parameters

  • position int (default: 1): Position of the hot water 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 hot water 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 hot water tank, starting at 1

get_target_temperature​

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

Get the target temperature from the hot water tank.

Parameters

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

Returns

  • float: Temperature in °C

set_target_temperature​

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

Set the target temperature from the hot water 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 target temperature in °C
  • position int (default: 1): Position of the hot water tank, starting at 1

get_excess_energy_target_temperature​

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

Get the excess energy target temperature from the hot water tank.

Parameters

  • position int (default: 1): Position of the hot water 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 hot water 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 hot water 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 hot water tank.

Parameters

  • position int (default: 1): Position of the hot water 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 hot water 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 hot water 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 hot water 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 hot water 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 hot water 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 hot water tank.

Parameters

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

Returns

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

has_fresh_water_module​

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

Check if fresh water module is available.

Parameters

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

Returns

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

get_fresh_water_flow​

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

Get the fresh water flow from the fresh water module.

Parameters

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

Returns

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

get_fresh_water_module_temperature​

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

Get the fresh water module temperature.

Parameters

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

Returns

  • float: Temperature in °C

get_fresh_water_module_pump_speed​

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

Get the fresh water module pump speed.

Parameters

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

Returns

  • float: Pump speed as a fraction from 0 to 1 (1 = 100 %)

get_circulation_return_temperature​

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

Get the circulation return temperature.

Parameters

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

Returns

  • float: Temperature in °C

get_circulation_pump_state​

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

Get the circulation pump state.

Parameters

  • position int (default: 1): Position of the hot water 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