System

API Endpoints to send and retrieve the system data.

Examples:

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

get_positions() async

Get the number of installed devices e.g. heat circuit, solar circuit, etc.

RETURNS	DESCRIPTION
tuple	A named tuple with the position information

get_info() async

Get the system information.

RETURNS	DESCRIPTION
dict	A dictionary with system information

get_hmi_info() async

Get the Web HMI information.

RETURNS	DESCRIPTION
dict	A dictionary with Web HMI information

get_device_info() async

Get the control unit information.

RETURNS	DESCRIPTION
dict	A dictionary with control unit information

get_number_of_heating_circuits() async

Get the number of heating circuits.

RETURNS	DESCRIPTION
int	Number of installed heating circuits

get_outdoor_temperature() async

Get the outdoor temperature.

RETURNS	DESCRIPTION
float	Temperature in °C

get_operating_mode(*, human_readable=True) async

Get the operating mode from the system.

PARAMETER	DESCRIPTION
human_readable	Return a human-readable string TYPE: bool DEFAULT: True

RETURNS	DESCRIPTION
integer or string	-1(SETUP) / (0) STANDBY / (1) SUMMER / (2) AUTO_HEAT / (3) AUTO_COOL / (4) AUTO

set_operating_mode(mode) async

Set the operating mode from the system.

PARAMETER	DESCRIPTION
mode	Set the mode as integer or string (human-readable) e.g. 0 or STANDBY TYPE: int | str

get_cpu_usage() async

Get the CPU usage.

RETURNS	DESCRIPTION
float	CPU usage in percent

get_webview_cpu_usage() async

Get the webview CPU usage.

RETURNS	DESCRIPTION
float	Webview CPU usage in percent

get_webserver_cpu_usage() async

Get the webserver CPU usage.

RETURNS	DESCRIPTION
float	Webserver CPU usage in percent

get_control_cpu_usage() async

Get the control CPU usage.

RETURNS	DESCRIPTION
float	Control CPU usage in percent

get_ram_usage() async

Get the RAM usage.

RETURNS	DESCRIPTION
int	RAM usage in kilobyte

get_free_ram() async

Get the free RAM.

RETURNS	DESCRIPTION
int	Free RAM in kilobyte.