openccu-data

library2026.5.0pypypiunverified

A Python library for extracting and distributing configuration metadata from Homematic CCU/OpenCCU systems, including translations, easy modes, and link profiles. Current version is 2026.5.0. The library releases are pegged to the year and month of release, following a monthly cadence.

devops

pip install openccu-data

github ↗homepage ↗

INSTALL

IMPORT

SIG · OPENCCU-DATA

openccu-data

devopspythonv2026.5.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

OpenCCUData

✓ from openccu_data import OpenCCUData

✗ from openccu import OpenCCUData

The top-level package is 'openccu_data', not 'openccu'.

ConfigMetadata

✓ from openccu_data.models import ConfigMetadata

✗ from openccu_data import ConfigMetadata

ConfigMetadata lives in the models submodule.

fetch_config

✓ from openccu_data.fetch import fetch_config

Initialize the client with a CCU URL, fetch English translations, and print the first five keys.

import os from openccu_data import OpenCCUData ccu_url = os.environ.get('CCU_URL', 'http://homematic-ccu2') client = OpenCCUData(ccu_url) translations = client.get_translations('en') print(list(translations.keys())[:5])

Debug

Known issues

breakingVersion 2026.5.0 requires Python 3.14+. Earlier versions (pre-2026) supported Python 3.8+. Upgrade your Python interpreter before updating the library.

fix

Run `pip install 'openccu-data<2026'` if you are stuck on older Python, or upgrade Python to 3.14+.

affects: >=2026.0.0

breakingThe API endpoint format changed in version 2025.8. The method `get_translations` now requires a language code (e.g., 'en', 'de') and returns a dictionary. Previously it returned a list of strings.

fix

Update code: change `client.get_translations()` to `client.get_translations('en')`.

affects: >=2025.8.0

deprecatedThe `easy_mode` parameter in `get_device_metadata` is deprecated since v2025.10. Use the new `mode` parameter with values 'simple' or 'advanced'.

fix

Replace `easy_mode=True` with `mode='simple'`.

affects: >=2025.10.0

gotchaDo not import from 'openccu' directly; the package name on PyPI is 'openccu-data', and the importable module is 'openccu_data' (underscore).

fix

Use `from openccu_data import ...`.

affects: all

gotchaThe library expects the CCU to expose the XML-API addon. Without it, requests will fail with a ConnectionError. Ensure the addon is running at the configured URL.

fix

Install the XML-API addon on your CCU (https://github.com/homematic-community/XML-API).

affects: all

Upgrade

Version history

2026.5.0latest on PyPI · released May 10, 2026

Audit

Dependencies

lxmlrequiredXML parsing of Homematic device descriptions

requestsrequiredFetching metadata from CCU/OpenCCU

dataclasses-jsonrequiredSerialization of configuration objects

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/sukramj/openccu-data ↗

homepagehttps://github.com/sukramj/openccu-data ↗