{"id":29624123,"url":"https://github.com/superbox-dev/keba_keenergy_api","last_synced_at":"2026-05-05T06:04:53.052Z","repository":{"id":198788986,"uuid":"701086523","full_name":"superbox-dev/keba_keenergy_api","owner":"superbox-dev","description":"A Python wrapper for the KEBA KeEnergy API used by the Web HMI.","archived":false,"fork":false,"pushed_at":"2026-04-19T18:13:33.000Z","size":2216,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-04-19T18:15:13.943Z","etag":null,"topics":["api","home-assistant","homeassistant","keba","keba-keenergy","m-tec","windhager"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/superbox-dev.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-10-05T22:18:08.000Z","updated_at":"2026-04-13T05:03:14.000Z","dependencies_parsed_at":"2026-02-13T00:00:42.915Z","dependency_job_id":null,"html_url":"https://github.com/superbox-dev/keba_keenergy_api","commit_stats":null,"previous_names":["superbox-dev/keba-keenergy-api"],"tags_count":75,"template":false,"template_full_name":null,"purl":"pkg:github/superbox-dev/keba_keenergy_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superbox-dev%2Fkeba_keenergy_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superbox-dev%2Fkeba_keenergy_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superbox-dev%2Fkeba_keenergy_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superbox-dev%2Fkeba_keenergy_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/superbox-dev","download_url":"https://codeload.github.com/superbox-dev/keba_keenergy_api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superbox-dev%2Fkeba_keenergy_api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32123608,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T00:31:26.853Z","status":"online","status_checked_at":"2026-04-22T02:00:05.693Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","home-assistant","homeassistant","keba","keba-keenergy","m-tec","windhager"],"created_at":"2025-07-21T05:32:45.991Z","updated_at":"2026-04-22T06:07:23.328Z","avatar_url":"https://github.com/superbox-dev.png","language":"Python","funding_links":["https://ko-fi.com/F2F0KXO6D"],"categories":[],"sub_categories":[],"readme":"# KEBA KeEnergy API\n\n\u003c!--start-home--\u003e\nA Python wrapper for the KEBA KeEnergy API used by the Web HMI.\n\n![coverage-badge](https://raw.githubusercontent.com/superbox-dev/keba_keenergy_api/main/coverage-badge.svg)\n[![Version](https://img.shields.io/pypi/pyversions/keba-keenergy-api.svg)][pypi-version]\n[![CI](https://github.com/superbox-dev/keba_keenergy_api/actions/workflows/ci.yml/badge.svg?branch=main)][workflow-ci]\n\n[pypi-version]: https://pypi.python.org/pypi/keba-keenergy-api\n[workflow-ci]: https://github.com/superbox-dev/keba_keenergy_api/actions/workflows/ci.yml\n\n\u003c!--end-home--\u003e\n\n## Donation\n\n\u003c!--start-donation--\u003e\n\nI put a lot of time into this project. If you like it, you can support me with a donation.\n\n[![KoFi](https://raw.githubusercontent.com/superbox-dev/.github/refs/heads/main/profile/superbox-kofi.jpg)][kofi]\n\n[kofi]: https://ko-fi.com/F2F0KXO6D\n\n\u003c!--end-donation--\u003e\n\n\u003c!--start-home--\u003e\n\n## Getting started\n\n```bash\npip install keba-keenergy-api\n```\n\n## Usage\n\n```python\nimport asyncio\nfrom typing import Any\n\nfrom keba_keenergy_api import KebaKeEnergyAPI\nfrom keba_keenergy_api.constants import HeatCircuit\nfrom keba_keenergy_api.constants import HeatCircuitOperatingMode\n\nasync def main():\n    client = KebaKeEnergyAPI(\n        host=\"ap4400.local\",\n        username=\"test\",\n        password=\"test\",\n        ssl=True,\n        skip_ssl_verification=True\n    )\n\n    # Get current outdoor temperature\n    outdoor_temperature = await client.system.get_outdoor_temperature()\n\n    # Get heat circuit temperature from heat circuit 2\n    heat_circuit_temperature = await client.heat_circuit.get_target_temperature(\n        position=2\n    )\n\n    # Read multiple values\n    data = await client.read_data(\n        request=[\n            HeatCircuit.TARGET_TEMPERATURE,\n            HeatCircuit.TARGET_TEMPERATURE_DAY\n        ],\n        extra_attributes=True\n    )\n\n    # Enable \"day\" mode for heat circuit 2\n    await client.heat_circuit.set_operating_mode(\n        mode=HeatCircuitOperatingMode.DAY.value,\n        position=2\n    )\n\n    # Write multiple values\n    await client.write_data(\n        request={\n            # Write heat circuit on position 1 and 3\n            HeatCircuit.TARGET_TEMPERATURE_DAY: (20, None, 5),\n            # Write night temperature on position 1\n            HeatCircuit.TARGET_TEMPERATURE_NIGHT: (16,),\n        },\n    )\n\nasyncio.run(main())\n```\n\nBy default, the library creates a new connection to `KEBA KeEnergy API` with each coroutine. If you are calling a large\nnumber of coroutines, an `aiohttp ClientSession()` can be used for connection pooling:\n\n```python\nimport asyncio\n\nfrom keba_keenergy_api import KebaKeEnergyAPI\n\nfrom aiohttp import ClientSession\n\nasync def main():\n    async with ClientSession() as session:\n        client = KebaKeEnergyAPI(\n            host=\"ap4400.local\",\n            username=\"test\",\n            password=\"test\",\n            ssl=True,\n            skip_ssl_verification=True,\n            session=session\n        )\n        ...\n\nasyncio.run(main())\n```\n\n### ⚠️ Write warnings\n\nThis is a low-level API that allows writing values outside the safe operating range.\nImproper use can damage heating systems and hardware. Always check the `attributes`,\nas these may contain minimum and maximum values.\n\n*Use at your own risk!*\n\n**Example:**\n\nThe upper limit from the hot water tank temperature is 52 °C. Do not write larger values under any circumstances,\neven if it would be possible.\n\n```json\n{\n    \"name\": \"APPL.CtrlAppl.sParam.hotWaterTank[0].param.normalSetTempMax.value\",\n    \"attributes\": {\n        \"dynUpperLimit\": 1,\n        \"formatId\": \"fmtTemp\",\n        \"longText\": \"Temp. nom.\",\n        \"lowerLimit\": \"0\",\n        \"unitId\": \"Temp\",\n        \"upperLimit\": \"52\"\n    },\n    \"value\": \"50\"\n}\n```\n\n**And one last warning:**\n\n\u003e **Attention!** Writing values should remain within normal limits, as is the case with typical use of the\n\u003e Web HMI. Permanent and very frequent writing of values reduces the lifetime of the built-in flash memory.\n\u003e **Be carefully!**\n\n\u003c!--end-home--\u003e\n\n## Documentation\n\nRead the full API documentation on [api.superbox.one](https://api.superbox.one).\n\n## Changelog\n\nThe changelog lives in the [CHANGELOG.md](CHANGELOG.md) document.\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).\n\n\u003c!--start-contributing--\u003e\n\n## Get Involved\n\nThe **KEBA KeEnergy API** is an open-source project and contributions are welcome. You can:\n\n* Report [issues](https://github.com/superbox-dev/keba_keenergy_api/issues/new/choose) or request new features\n* Improve documentation\n* Contribute code\n* Support the project by starring it on GitHub ⭐\n\n\u003c!--end-contributing--\u003e\n\nI'm happy about your contributions to the project!\nYou can get started by reading the [CONTRIBUTING.md](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperbox-dev%2Fkeba_keenergy_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperbox-dev%2Fkeba_keenergy_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperbox-dev%2Fkeba_keenergy_api/lists"}