Heat circuits

API Endpoints to send and retrieve the heat circuit data.

Examples:

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

get_name(position=1) async

Get the heat circuit name.

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

RETURNS	DESCRIPTION
string	Heat circuit name

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

Check if room temperature from the heat circuit is available.

PARAMETER	DESCRIPTION
position	The number of the heat 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_room_temperature(position=1) async

Get the room temperature from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

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

Check if room humidity from the heat circuit is available.

PARAMETER	DESCRIPTION
position	The number of the heat 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_room_humidity(position=1) async

Get the room humidity from the heat circuit.

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

RETURNS	DESCRIPTION
float	Humidity in percent

get_dew_point(position=1) async

Get the dew point from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_flow_temperature_setpoint(position=1) async

Get the flow temperature setpoint from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_mixer_flow_temperature(position=1) async

Get the mixer flow temperature from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_mixer_return_flow_temperature(position=1) async

Get the mixer return flow temperature from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_return_flow_temperature(position=1) async

Get the return flow temperature from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_target_temperature(position=1) async

Get the target temperature from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_target_temperature_day(position=1) async

Get the target temperature for the day from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature_day(temperature, position=1) async

Set the target temperature for the day from the heat circuit.

PARAMETER	DESCRIPTION
temperature	The target temperature for the day in °C TYPE: int
position	The number of the heat circuits TYPE: int DEFAULT: 1

get_heating_limit_day(position=1) async

Get the heating limit for the day from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_target_temperature_night(position=1) async

Get the target temperature for the night from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature_night(temperature, position=1) async

Set the target temperature for the night from the heat circuit.

PARAMETER	DESCRIPTION
temperature	The target temperature for the day in °C TYPE: int
position	The number of the heat circuits TYPE: int DEFAULT: 1

get_heating_limit_night(position=1) async

Get the heating limit for the night from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

get_target_temperature_away(position=1) async

Get the target temperature when away for the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature_away(temperature, position=1) async

Set the target temperature when away for the heat circuit.

PARAMETER	DESCRIPTION
temperature	The target temperature for the day in °C TYPE: int
position	The number of the heat circuits TYPE: int DEFAULT: 1

get_target_temperature_offset(position=1) async

Get the target temperature offset from the heat circuit.

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

RETURNS	DESCRIPTION
float	Temperature in °C

set_target_temperature_offset(offset, position=1) async

Set the target temperature offset for the heat circuit.

PARAMETER	DESCRIPTION
offset	The target temperature offset TYPE: float
position	The number of the heat circuits TYPE: int DEFAULT: 1

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

Get the operating mode from the heat circuit.

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

RETURNS	DESCRIPTION
integer or string	0 (OFF) / 1 (AUTO) / (2) DAY / (3) NIGHT / (4) HOLIDAY / (5) PARTY / (8) EXTERNAL / (9) ROOM_CONTROL

set_operating_mode(mode, position=1) async

Set the operating mode from the heat 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 heat circuits TYPE: int DEFAULT: 1

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

Get the heat request state from the heat circuit.

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

Get the cool request state from the heat circuit.

PARAMETER	DESCRIPTION
position	The number of the external heat 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)