External heat source

Endpoint group client.external_heat_source (ExternalHeatSourceEndpoints).

API Endpoints to retrieve the external heat source data.

Example

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

get_operating_mode

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

Get the operating mode from the external heat source.

Parameters

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

Returns

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

set_operating_mode

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

Set the operating mode from the external heat source.

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 external heat source, starting at 1

get_target_temperature

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

Get target temperature from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• float: Temperature in °C

get_heat_request

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

Get the heat request state from the external heat source.

Parameters

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

Returns

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

get_operating_time

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

Get the operating time from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Operating time in seconds

get_max_runtime

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

Get the maximum runtime from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Maximum runtime in seconds

get_activation_counter

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

Get the activation counter from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Number of external heat source activation

get_consuming_excess_energy

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

Get the consuming excess energy from the external heat source.

Parameters

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

Returns

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

get_excess_energy_operating_time

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

Get the excess energy operating time from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Excess energy operating time in seconds

get_excess_energy_max_runtime

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

Get the excess energy maximum runtime from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Excess energy maximum runtime in seconds

get_excess_energy_activation_counter

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

Get the excess energy activation counter from the external heat source.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Number of excess energy external heat source activation

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 external heat source, 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 external heat source, starting at 1

get_min_runtime_excess_energy

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

Get the minimum runtime excess energy.

Parameters

• position int (default: 1): Position of the external heat source, starting at 1

Returns

• int: Runtime in minutes

set_min_runtime_excess_energy

async def set_min_runtime_excess_energy(minute: int, position: int = 1) -> None

Set the minimum runtime 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

• minute int: The minimum runtime in minutes
• position int (default: 1): Position of the external heat source, starting at 1