Skip to main content

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.

coverage-badge

CI Typing: strict Code style: Ruff

Donation

I put a lot of time into this project. If you like it, you can support me with a donation.

KoFi

or donate with PayPal

Getting started

pip install keba-keenergy-api
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:
        print(await client.system.get_outdoor_temperature())


asyncio.run(main())

See Usage for reading and writing multiple values and sharing a session.

⚠️ 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 for minimum and maximum values, 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.

Metadata

Release files for keba-keenergy-api 2.13.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for keba-keenergy-api 2.13.0
File Size Uploaded Provenance
keba_keenergy_api-2.13.0.tar.gz 475.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for keba-keenergy-api 2.13.0
File Interpreter ABI Platform
keba_keenergy_api-2.13.0-py3-none-any.whl Python 3 none any Details

Total release size: 512.5 kB

Release files / keba_keenergy_api-2.13.0.tar.gz

Download URL keba_keenergy_api-2.13.0.tar.gz
Size 475.2 kB
Tags Source
SHA-256 checksum
How to use checksums
24f6769fdb329637356c801cdf9e6af445529aff0b23d062bf21cd6c7671a2cf
BLAKE2b-256 checksum
How to use checksums
6454f4202e8de210725f1df46a90f735b12733e0bf239109c1edfac0d366ee49
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / keba_keenergy_api-2.13.0-py3-none-any.whl

Download URL keba_keenergy_api-2.13.0-py3-none-any.whl
Size 37.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1fdfb788364c7d3876d1636dede49ad02f5d1ba71d527603abd4d4423d622000
BLAKE2b-256 checksum
How to use checksums
276bf31921a562c5908dc015825898d75e79b5625fbf63d35aa77dbf0a97180f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for keba-keenergy-api 2.13.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.13.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page