KEBA KeEnergy API

A Python wrapper for the KEBA KeEnergy API used by the Web HMI.

Note: This is an unofficial community project. It is not affiliated with, endorsed by or supported by KEBA. For support, open an issue, do not contact KEBA.

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

import asyncio

from keba_keenergy_api import KebaKeEnergyAPI
from keba_keenergy_api.endpoints import System


async def main():
    async with KebaKeEnergyAPI(
        host="ap4400.local", username="test", password="test", ssl=True, verify_ssl=False
    ) as client:
        readings = await client.read([System.OUTDOOR_TEMPERATURE])
        print(readings[System.OUTDOOR_TEMPERATURE][0].value)


asyncio.run(main())

See Usage for reading and writing multiple values and sharing a session, and Migration for upgrading from 2.x.

⚠️ 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 lower_limit and upper_limit of a reading, and write values only as often as the Web HMI would, as frequent writes wear out the built-in flash memory. Use at your own risk! Read the full write warnings before writing values.

Documentation

Read the full API documentation on superbox-dev.github.io/keba_keenergy_api.

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.