This release is a pre-release and may not be stable for production use.
KEBA KeEnergy API
A Python wrapper for the KEBA KeEnergy API used by the Web HMI.
Donation
I put a lot of time into this project. If you like it, you can support me with a donation.
Getting started
pip install keba-keenergy-api
Usage
import asyncio
from keba_keenergy_api import KebaKeEnergyAPI
from keba_keenergy_api.constants import HeatCircuit
from keba_keenergy_api.constants import HeatCircuitOperatingMode
async def main():
client = KebaKeEnergyAPI(
host="ap4400.local", username="test", password="test", ssl=True, skip_ssl_verification=True
)
# Get current outdoor temperature
outdoor_temperature = await client.system.get_outdoor_temperature()
# Get heat circuit temperature from heat circuit 2
heat_circuit_temperature = await client.heat_circuit.get_target_temperature(position=2)
# Read multiple values
data = await client.read_data(
request=[HeatCircuit.TARGET_TEMPERATURE, HeatCircuit.TARGET_TEMPERATURE_DAY], extra_attributes=True
)
# Enable "day" mode for heat circuit 2
await client.heat_circuit.set_operating_mode(mode=HeatCircuitOperatingMode.DAY.value, position=2)
# Write multiple values
await client.write_data(
request={
# Write the day temperature of heat circuit 1 and 3
HeatCircuit.TARGET_TEMPERATURE_DAY: (20, None, 21),
# Write night temperature on position 1
HeatCircuit.TARGET_TEMPERATURE_NIGHT: (16,),
},
)
asyncio.run(main())
By default, the library creates a new connection to KEBA KeEnergy API with each coroutine. If you are calling a large
number of coroutines, use the client with async with, so that all requests share one connection:
import asyncio
from keba_keenergy_api import KebaKeEnergyAPI
async def main():
async with KebaKeEnergyAPI(
host="ap4400.local", username="test", password="test", ssl=True, skip_ssl_verification=True
) as client:
...
asyncio.run(main())
You can also pass your own aiohttp ClientSession(), e.g. to share it with other code. The client leaves it open:
import asyncio
from keba_keenergy_api import KebaKeEnergyAPI
from aiohttp import ClientSession
async def main():
async with ClientSession() as session:
client = KebaKeEnergyAPI(
host="ap4400.local", username="test", password="test", ssl=True, skip_ssl_verification=True, session=session
)
...
asyncio.run(main())
⚠️ Write warnings
This is a low-level API that allows writing values outside the safe operating range.
Improper use can damage heating systems and hardware. Always check the attributes,
as these may contain minimum and maximum values.
Use at your own risk!
Example:
The upper limit of the hot water tank temperature is 52 °C. Do not write larger values under any circumstances, even if it would be possible.
{
"name": "APPL.CtrlAppl.sParam.hotWaterTank[0].param.normalSetTempMax.value",
"attributes": {
"dynUpperLimit": 1,
"formatId": "fmtTemp",
"longText": "Temp. nom.",
"lowerLimit": "0",
"unitId": "Temp",
"upperLimit": "52"
},
"value": "50"
}
And one last warning:
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. Be careful!
Documentation
Read the full API documentation on api.superbox.one.
Changelog
The changelog lives in the CHANGELOG.md document. The format is based on Keep a Changelog.
Get Involved
The KEBA KeEnergy API is an open-source project and contributions are welcome. You can:
- Report issues or request new features
- Improve documentation
- Contribute code
- Support the project by starring it on GitHub ⭐
I'm happy about your contributions to the project! You can get started by reading the CONTRIBUTING.md.
1 maintainer
Metadata
1 maintainer
Release files for keba-keenergy-api 2.13.0b4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| keba_keenergy_api-2.13.0b4.tar.gz | 256.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| keba_keenergy_api-2.13.0b4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 294.0 kB
Release files / keba_keenergy_api-2.13.0b4.tar.gz
| Download URL | keba_keenergy_api-2.13.0b4.tar.gz |
|---|---|
| Size | 256.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
db19d2d993b317e9f11a6272f59a686972f4819ecf9018eb747c937e0c36b81c
|
|
BLAKE2b-256 checksum How to use checksums |
a2a7db7d4191cdf571314edf554ca03affad03c557943f934a57812b59e10818
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / keba_keenergy_api-2.13.0b4-py3-none-any.whl
| Download URL | keba_keenergy_api-2.13.0b4-py3-none-any.whl |
|---|---|
| Size | 37.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8cd6643f7324d0a11963968ee42dad34bcbdd60e54109cc544d54046dab463cc
|
|
BLAKE2b-256 checksum How to use checksums |
0609196995031adb53eaf397a757330bc3661d635690943582f6dd22cb8dfc02
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
