Solar circuit

Endpoint group client.solar_circuit (SolarCircuitEndpoints).

API Endpoints to send and retrieve the solar circuit data.

Example

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

get_name

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

Get the solar circuit name.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• str: Solar circuit name

get_operating_mode

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

Get the operating mode from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, 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 solar circuit.

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 solar circuit, starting at 1

get_priority_1_before_2

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

Get priority 1 before 2 for the pumps from the solar circuit.

Parameters

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

Returns

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

set_priority_1_before_2

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

Set the priority 1 before 2 for the pumps from the solar circuit.

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 solar circuit, starting at 1

get_source_temperature

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

Get source temperature from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Temperature in °C

get_pump_1_speed

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

Get pump 1 speed.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

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

get_pump_2_speed

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

Get pump 2 speed.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

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

get_current_temperature_1

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

Get current temperature 1 from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Temperature in °C

get_current_temperature_2

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

Get current temperature 2 from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Temperature in °C

get_target_temperature_1

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

Get target temperature 1 from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Temperature in °C

set_target_temperature_1

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

Set the target temperature 1 from the solar circuit.

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 solar circuit, starting at 1

get_target_temperature_2

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

Get target temperature 2 from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Temperature in °C

set_target_temperature_2

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

Set the target temperature 2 from the solar circuit.

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 solar circuit, starting at 1

get_heat_request_1

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

Get the heat request 1 state from the solar circuit.

Parameters

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

Returns

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

get_heat_request_2

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

Get the heat request 2 state from the solar circuit.

Parameters

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

Returns

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

get_heating_energy

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

Get heating energy from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Heating energy in J

get_daily_energy

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

Get daily energy from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Daily energy in J

get_actual_power

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

Get actual power from the solar circuit.

Parameters

• position int (default: 1): Position of the solar circuit, starting at 1

Returns

• float: Actual power in W