Heat pumps¶
API Endpoints to send and retrieve the heat pump data.
Examples:
>>> client = KebaKeEnergyAPI(
>>> host="ap4400.local",
>>> username="test",
>>> password="test",
>>> ssl=True,
>>> skip_ssl_verification=True
>>> )
>>> client.heat_pump.get_name()
get_name(position=1)
async
¶
Get the heat pump name.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
string
|
Heat pum tank name |
get_state(position=1, *, human_readable=True)
async
¶
Get the heat pump state.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
(0) STANDBY / (1) FLOW / (2) AUTO_HEAT / (3) DEFROST / (4) AUTO_COOL / (5) INFLOW / (6) PUMP_DOWN / (7) SHUTDOWN / (8) ERROR |
get_substate(position=1, *, human_readable=True)
async
¶
Get the heat pump substate.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
(0) NONE /(1) OIL_PREHEATING / (2, 3) PUMP_PRE_RUN / (4) RANDOM_DELAY / (5, 21, 22) PRESSURE_EQUALIZATION (6) DEFROST_PRE_FLOW / (7) DEFROST_MONITORING / (8) SNOW_DETECTION / (9) FLUSHING / (10) DEFROST_INITIALIZATION / (11) PREHEAT_FLOW / (12) DEFROST / (13, 25) DRIP / (14) DEFROST_END / (15, 16) OPEN / (17) COMPRESSOR_POST_RUN / (18) PUMP_POST_RUN / (19) LUBRICATION_PULSE / (20, 26) / REDUCED_SPEED / (23) COMPRESSOR_DELAY / (24) DEFROST_VENTING / (27) SWITCH_HEATING_COOLING / (28, 33) / WAIT_FOR_COMPRESSOR / (29) COMPRESSOR_STOP / (30) BIVALENT_LOCK / (31) LOCKED / (32) RETURN_FLOW_OFF / (34) MIXER_OPEN / (35) ZONE_VALVE / (36) ELECTRIC_DEFROST / (37) COUNTERFLOW_VALVE |
get_operating_mode(position=1, *, human_readable=True)
async
¶
Get the operating mode from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
(0) OFF / (1) ON / (2) BACKUP |
set_operating_mode(mode, position=1)
async
¶
Set the operating mode from the heat pump.
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 pumps
TYPE:
|
get_compressor_use_night_speed(position=1, *, human_readable=True)
async
¶
Get the compressor use night speed state.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the hot water tanks
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
(0) OFF / (1) ON |
set_compressor_use_night_speed(mode, position=1)
async
¶
Set the compressor use night speed.
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 pumps
TYPE:
|
get_compressor_night_speed(position=1, *, human_readable=True)
async
¶
Get the compressor night speed.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the hot water tanks
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Compressor night speed in percent |
set_compressor_night_speed(speed, position=1)
async
¶
Set the compressor night speed.
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 |
|---|---|
speed
|
Set the speed in percent
TYPE:
|
position
|
The number of the heat pumps
TYPE:
|
get_min_compressor_night_speed(position=1)
async
¶
Get the minimum compressor night speed.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Minimum compressor night speed in percent |
get_max_compressor_night_speed(position=1)
async
¶
Get the maximum compressor night speed.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Maximum compressor night speed in percent |
get_circulation_pump_speed(position=1)
async
¶
Get the circulation pump speed.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Circulation pump speed in percent |
get_source_pump_speed(position=1)
async
¶
Get the source pump speed.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Source pump speed in percent |
get_flow_temperature(position=1)
async
¶
Get the flow temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_return_flow_temperature(position=1)
async
¶
Get the return flow temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_source_input_temperature(position=1)
async
¶
Get the source input temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_source_output_temperature(position=1)
async
¶
Get the source output temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_compressor_input_temperature(position=1)
async
¶
Get the compressor input temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_compressor_output_temperature(position=1)
async
¶
Get the compressor output temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_compressor_speed(position=1)
async
¶
Get the compressor speed from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Compressor speed in percent |
get_condenser_temperature(position=1)
async
¶
Get the condenser temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_vaporizer_temperature(position=1)
async
¶
Get the vaporizer temperature from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_target_overheating(position=1)
async
¶
Get the target overheating from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_current_overheating(position=1)
async
¶
Get the current overheating from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_expansion_valve_position(position=1)
async
¶
Get the expansion valve position from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Step position |
get_high_pressure(position=1)
async
¶
Get the high pressure from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
High pressure in bar |
get_low_pressure(position=1)
async
¶
Get the low pressure from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Low pressure in bar |
get_heat_request(position=1, *, human_readable=True)
async
¶
Get the heat request state from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
get_compressor_power(position=1)
async
¶
Get the compressor power from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Compressor power in W |
get_heating_power(position=1)
async
¶
Get the heating power from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Heating power in W |
get_hot_water_power(position=1)
async
¶
Get the hot water power from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
hot water power in W |
get_cop(position=1)
async
¶
Get the COP from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
COP |
get_heating_energy(position=1)
async
¶
Get the heating energy from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Heating energy in kWh |
get_heating_energy_consumption(position=1)
async
¶
Get the energy consumption for heating from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Energy consumption for heating in kWh |
get_heating_spf(position=1)
async
¶
Get the heating SPF from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Heating SPF |
get_cooling_energy(position=1)
async
¶
Get the cooling energy from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Cooling energy in kWh |
get_cooling_energy_consumption(position=1)
async
¶
Get the cooling energy consumption from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Cooling energy consumption in kWh |
get_cooling_spf(position=1)
async
¶
Get the cooling SPF from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Cooling SPF |
get_hot_water_energy(position=1)
async
¶
Get the hot water energy from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Hot water energy in kWh |
get_hot_water_energy_consumption(position=1)
async
¶
Get the hot water energy consumption from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Hot water energy consumption in kWh. |
get_hot_water_spf(position=1)
async
¶
Get the hot water SPF from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Hot water SPF |
get_total_thermal_energy(position=1)
async
¶
Get the total thermal energy from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Total thermal energy in kWh |
get_total_energy_consumption(position=1)
async
¶
Get the total energy consumption from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Total energy consumption in kWh |
get_total_spf(position=1)
async
¶
Get the SPF from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
SPF |
has_passive_cooling(position=1, *, human_readable=True)
async
¶
Check if passive cooling for the heat pump is available.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
get_operating_time(position=1)
async
¶
Get the operating time from the external heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Operating time in seconds |
get_max_runtime(position=1)
async
¶
Get the maximum runtime from the external heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Maximum runtime in seconds |
get_activation_counter(position=1)
async
¶
Get the activation counter from the heat pump.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat pumps
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Number of external heat source activation |
has_compressor_failure(position=1, *, human_readable=True)
async
¶
Check if the heat pump has a compressor failure.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
has_source_failure(position=1, *, human_readable=True)
async
¶
Check if the heat pump has a source failure.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
has_source_actuator_failure(position=1, *, human_readable=True)
async
¶
Check if the heat pump has a source actuator failure.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
has_three_phase_failure(position=1, *, human_readable=True)
async
¶
Check if the heat pump has a three-phase failure.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
has_source_pressure_failure(position=1, *, human_readable=True)
async
¶
Check if the heat pump has a source pressure failure.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
has_vfd_failure(position=1, *, human_readable=True)
async
¶
Check if the heat pump has a source pressure variable frequency drive (VFD) failure.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the heat pumps
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |