External heat source¶
API Endpoints to retrieve the external heat source data.
Examples:
>>> client = KebaKeEnergyAPI(
>>> host="ap4400.local",
>>> username="test",
>>> password="test",
>>> ssl=True,
>>> skip_ssl_verification=True
>>> )
>>> client.external_heat_source.get_operating_mode()
get_operating_mode(position=1, *, human_readable=True)
async
¶
Get the operating mode from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
set_operating_mode(mode, position=1)
async
¶
Set the operating mode from the external heat source.
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 external heat sources
TYPE:
|
get_target_temperature(position=1)
async
¶
Get target temperature from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
float
|
Temperature in °C |
get_heat_request(position=1, *, human_readable=True)
async
¶
Get the heat request state from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
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 source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Operating time in seconds |
get_max_runtime(position=1)
async
¶
Get the maximum runtime from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Maximum runtime in seconds |
get_activation_counter(position=1)
async
¶
Get the activation counter from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Number of external heat source activation |
get_consuming_excess_energy(position=1, *, human_readable=True)
async
¶
Get the consuming excess energy from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
0 (OFF) / 1 (ON) |
get_excess_energy_operating_time(position=1)
async
¶
Get the excess energy operating time from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Excess energy operating time in seconds |
get_excess_energy_max_runtime(position=1)
async
¶
Get the excess energy maximum runtime from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Excess energy maximum runtime in seconds |
get_excess_energy_activation_counter(position=1)
async
¶
Get the excess energy activation counter from the external heat source.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer
|
Number of excess energy external heat source activation |
get_use_excess_energy(position=1, *, human_readable=True)
async
¶
Get the use excess energy state.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
human_readable
|
Return a human-readable string
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
integer or string
|
(0) OFF / (1) ON |
set_use_excess_energy(mode, position=1)
async
¶
Set the use excess energy.
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 external heat sources
TYPE:
|
get_min_runtime_excess_energy(position=1)
async
¶
Get the minimum runtime excess energy.
| PARAMETER | DESCRIPTION |
|---|---|
position
|
The number of the external heat sources
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
int
|
Runtime in minutes |
set_min_runtime_excess_energy(minute, position=1)
async
¶
Set the minimum runtime excess energy.
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 |
|---|---|
minute
|
The excess energy target temperature in minutes
TYPE:
|
position
|
The number of the external heat sources
TYPE:
|