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:
|
| 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:
|
human_readable
|
Return a human-readable string
TYPE:
|
| 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:
|
| 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:
|
human_readable
|
Return a human-readable string
TYPE:
|
| 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:
|
| 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:
|
| 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:
|
| 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:
|
| 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:
|
| 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:
|
| 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:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_selected_target_temperature(position=1)
async
¶
Get the selected target temperature from the heat circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat circuits
TYPE:
|
| 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:
|
| 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.
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.
| PARAMETER | DESCRIPTION |
|---|---|
temperature
|
The target temperature for the day in °C
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
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:
|
| 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:
|
| 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.
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.
| PARAMETER | DESCRIPTION |
|---|---|
temperature
|
The target temperature for the day in °C
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
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:
|
| 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:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
set_target_temperature_away(temperature, position=1)
async
¶
Set the target temperature when away for the heat 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.
| PARAMETER | DESCRIPTION |
|---|---|
temperature
|
The target temperature for the day in °C
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
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:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
set_target_temperature_offset(offset, position=1)
async
¶
Set the target temperature offset for the heat 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.
| PARAMETER | DESCRIPTION |
|---|---|
offset
|
The target temperature offset
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
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:
|
human_readable
|
Return a human-readable string
TYPE:
|
| 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.
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.
| PARAMETER | DESCRIPTION |
|---|---|
mode
|
Set the mode as integer or string (human-readable) e.g. 0 or OFF
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
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:
|
human_readable
|
Return a human-readable string
TYPE:
|
| 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:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
get_away_start_date(position=1)
async
¶
Get the away start date from the heating circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat circuits
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Start date as unix timestamp |
set_away_start_date(timestamp, position=1)
async
¶
Set the away start date from the heating 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.
| PARAMETER | DESCRIPTION |
|---|---|
timestamp
|
Start date as unix timestamp
TYPE:
|
position
|
The number of the external heat circuits
TYPE:
|
get_away_end_date(position=1)
async
¶
Get the away end date from the heating circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat circuits
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Start date as unix timestamp |
set_away_end_date(timestamp, position=1)
async
¶
Set the away end date from the heating 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.
| PARAMETER | DESCRIPTION |
|---|---|
timestamp
|
Start date as unix timestamp
TYPE:
|
position
|
The number of the external heat circuits
TYPE:
|
get_heating_curve_offset(position=1)
async
¶
Get the heating curve offset from the heat circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat circuits
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Offset in °C |
set_heating_curve_offset(offset, position=1)
async
¶
Set the heating curve offset from the heat 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.
| PARAMETER | DESCRIPTION |
|---|---|
offset
|
The offset in °C
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
get_heating_curve_slope(position=1)
async
¶
Get the heating curve slope from the heat circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat circuits
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Slope |
set_heating_curve_slope(slope, position=1)
async
¶
Set the heating curve slope from the heat 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.
| PARAMETER | DESCRIPTION |
|---|---|
slope
|
The slope
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
get_use_heating_curve(position=1, *, human_readable=True)
async
¶
Get the use heating curve from the heat circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat circuits
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
(0) OFF / (1) ON |
set_use_heating_curve(mode, position=1)
async
¶
Set the use heating curve.
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.
| PARAMETER | DESCRIPTION |
|---|---|
mode
|
Set the mode as integer or string (human-readable) e.g. 0 or OFF
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
get_heating_curve(position=1)
async
¶
Get the heating curve from the heat circuit.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat circuits
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
string
|
|
set_heating_curve(heating_curve, position=1)
async
¶
Set the heating curve from the heat 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.
| PARAMETER | DESCRIPTION |
|---|---|
heating_curve
|
The heating curve name
TYPE:
|
position
|
The number of the heat circuits
TYPE:
|
get_heating_curve_points(heating_curve=None)
async
¶
Get the heating curve points.
| PARAMETER | DESCRIPTION |
|---|---|
heating_curve
|
The heating curve name
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
dict
|
One or more heating curves and the points |
set_heating_curve_points(heating_curve, points)
async
¶
Set the heating curve points.
| PARAMETER | DESCRIPTION |
|---|---|
heating_curve
|
The heating curve name
TYPE:
|
points
|
Heating curve points
TYPE:
|
get_available_heating_curves()
async
¶
Get available heating curves.
| RETURNS | DESCRIPTION |
|---|---|
tuple
|
Index and heating curve name pairs |
get_pump_speed(position=1)
async
¶
Get pump speed.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat circuits
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Pump speed in percent |