Solar circuits

API Endpoints to send and retrieve the solar circuit data.

Examples:

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

get_name(position=1) async

Get the solar circuit name.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
string	Solar circuit name

get_operating_mode(position=1, *, human_readable=True) async

Get the operating mode from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1
human_readable	Return a human-readable string TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
integer or string	0 (OFF) / 1 (ON)

set_operating_mode(mode, position=1) async

Set the operating mode from the solar circuit.

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 solar circuits TYPE: int DEFAULT: 1

get_priority_1_before_2(position=1, *, human_readable=True) async

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

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1
human_readable	Return a human-readable string TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
integer or string	0 (OFF) / 1 (ON)

set_priority_1_before_2(mode, position=1) async

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

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 solar circuits TYPE: int DEFAULT: 1

get_source_temperature(position=1) async

Get source temperature from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_pump_1_speed(position=1) async

Get pump 1 speed.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Pump 1 speed in percent

get_pump_2_speed(position=1) async

Get pump 2 speed.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Pump 2 speed in percent

get_current_temperature_1(position=1) async

Get current temperature 1 from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_current_temperature_2(position=1) async

Get current temperature 2 from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

get_target_temperature_1(position=1) async

Get target temperature 1 from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature_1(temperature, position=1) async

Set the target temperature 1 from the solar circuit.

PARAMETER	DESCRIPTION
temperature	Set the mode as integer or string (human-readable) e.g. 0 or OFF TYPE: int
position	The number of the solar circuits TYPE: int DEFAULT: 1

get_target_temperature_2(position=1) async

Get target temperature 2 from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature_2(temperature, position=1) async

Set the target temperature 2 from the solar circuit.

PARAMETER	DESCRIPTION
temperature	Set the mode as integer or string (human-readable) e.g. 0 or OFF TYPE: int
position	The number of the solar circuits TYPE: int DEFAULT: 1

get_heat_request_1(position=1, *, human_readable=True) async

Get the heat request 1 state from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the external solar circuits 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_heat_request_2(position=1, *, human_readable=True) async

Get the heat request 2 state from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the external solar circuits 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_heating_energy(position=1) async

Get heating energy from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Heating energy in kWh

get_daily_energy(position=1) async

Get daily energy from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Daily energy in kWh

get_actual_power(position=1) async

Get actual power from the solar circuit.

PARAMETER	DESCRIPTION
position	The number of the solar circuits TYPE: int DEFAULT: 1

RETURNS	DESCRIPTION
float	Actual power in W