openccu-data 2026.4.1__tar.gz

openccu_data-2026.4.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SukramJ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openccu_data-2026.4.1/NOTICE.md

@@ -0,0 +1,49 @@
+# NOTICE
+
+This repository ships two distinct kinds of files that are governed by
+different licenses. Please respect both when redistributing.
+
+## 1. Original code (MIT License)
+
+All Python source code in this repository — extractor modules, CLI entry
+points, tests, and packaging metadata — is original work and licensed under
+the [MIT License](./LICENSE).
+
+This covers everything under:
+
+- `openccu_data/` (except the `data/` subtree, see below)
+- `script/`
+- `tests/`
+- top-level configuration files (`pyproject.toml`, `.pre-commit-config.yaml`,
+  …)
+
+## 2. Extracted data artifacts (EQ-3 / OCCU License)
+
+The committed data artifacts under `openccu_data/data/` are derivative works
+generated from the
+[HomeMatic Open Central Control Unit SDK (HM-OCCU-SDK)](https://github.com/eq-3/occu)
+maintained by eQ-3 AG, and from compatible distributions such as
+[OpenCCU](https://github.com/jens-maus/RaspberryMatic).
+
+Specifically these files:
+
+- `openccu_data/data/easymode_extract.json.gz`
+- `openccu_data/data/translation_extract.json.gz`
+- `openccu_data/data/translation_custom/*.json` _(curated additions, MIT)_
+- `openccu_data/data/profiles/*.json`
+
+are obtained by parsing TCL configuration and JavaScript translation files
+shipped with OCCU/RaspberryMatic. They retain the licensing of the original
+upstream sources. Refer to OCCU's `LicenseDE.txt` for the full terms — in
+short: free for private and non-commercial use; commercial redistribution
+requires permission from eQ-3.
+
+The `translation_custom/` files are the exception inside the data tree: they
+contain hand-curated translation overrides authored by the openccu-data
+maintainers and are released under the MIT License together with the rest of
+the code.
+
+## Trademarks
+
+"Homematic" and "HomematicIP" are trademarks of eQ-3 AG. This project is not
+affiliated with or endorsed by eQ-3 AG.

openccu_data-2026.4.1/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.4
+Name: openccu-data
+Version: 2026.4.1
+Summary: Extract and distribute Homematic CCU/OpenCCU configuration metadata (translations, easymodes, link profiles).
+Author-email: SukramJ <sukramj@icloud.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/sukramj/openccu-data
+Project-URL: Source Code, https://github.com/sukramj/openccu-data
+Project-URL: Bug Reports, https://github.com/sukramj/openccu-data/issues
+Project-URL: Changelog, https://github.com/sukramj/openccu-data/blob/devel/changelog.md
+Keywords: home,automation,homematic,ccu,openccu,raspberrymatic,easymode
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Natural Language :: German
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE.md
+Provides-Extra: test
+Requires-Dist: pytest>=8.0.0; extra == "test"
+Requires-Dist: pytest-cov>=5.0.0; extra == "test"
+Dynamic: license-file
+
+# openccu-data
+
+Extract and distribute Homematic CCU configuration metadata
+(translations, easymodes, link profiles) from
+[OCCU](https://github.com/eq-3/occu) /
+[OpenCCU](https://github.com/jens-maus/RaspberryMatic) /
+[RaspberryMatic](https://github.com/jens-maus/RaspberryMatic).
+
+This repository is the **single source of truth** for the data artifacts that
+are consumed by [aiohomematic](https://github.com/sukramj/aiohomematic) and
+[aiohomematic-config](https://github.com/sukramj/aiohomematic-config). Both
+projects vendor the produced JSON archives at runtime.
+
+## What this provides
+
+| Extractor                      | Source                               | Output                                                                                 |
+| ------------------------------ | ------------------------------------ | -------------------------------------------------------------------------------------- |
+| `openccu-extract-easymodes`    | TCL config under `config/easymodes/` | `openccu_data/data/easymode_extract.json.gz`                                           |
+| `openccu-extract-translations` | JS translation files + stringtable   | `openccu_data/data/translation_extract.json.gz` + `translation_custom/`                |
+| `openccu-extract-profiles`     | TCL link-profile files per receiver  | `openccu_data/data/profiles/<RECEIVER_TYPE>.json.gz` (+ `_receiver_type_aliases.json`) |
+
+All three read from either:
+
+- a local OCCU/OpenCCU/RaspberryMatic checkout (`OCCU_PATH=/path/to/occu`), or
+- a running CCU instance over HTTP/HTTPS (`CCU_URL=https://my-ccu.local`).
+
+If both are set, the easymode/translation extractors merge results; the
+profile extractor prefers the running CCU and falls back to local.
+
+## Repository layout
+
+```
+openccu-data/
+├── LICENSE                MIT (covers the code)
+├── NOTICE.md              Data-artifact licensing (EQ-3/OCCU)
+├── README.md              this file
+├── CLAUDE.md              guide for AI assistants
+├── changelog.md
+├── pyproject.toml
+├── openccu_data/
+│   ├── const.py
+│   ├── easymodes/extractor.py        easymode metadata parser
+│   ├── translations/extractor.py     CCU WebUI translation parser
+│   ├── profiles/extractor.py         easymode link-profile parser
+│   └── data/                         committed, vendored output
+│       ├── easymode_extract.json.gz
+│       ├── translation_extract.json.gz
+│       ├── translation_custom/*.json
+│       └── profiles/*.json.gz (+ _receiver_type_aliases.json)
+├── script/                           CLI wrappers
+└── tests/
+```
+
+## Installation
+
+```bash
+python -m pip install -e .[test]
+```
+
+No third-party runtime dependencies; only the standard library.
+
+## Usage
+
+### Console scripts
+
+After installation, three console scripts are available on the PATH:
+
+```bash
+OCCU_PATH=/path/to/occu openccu-extract-easymodes
+OCCU_PATH=/path/to/occu openccu-extract-translations
+CCU_URL=https://my-ccu.local openccu-extract-profiles
+```
+
+Output lands in `openccu_data/data/` by default. Override via `OUTPUT_DIR`.
+
+### Without installation
+
+```bash
+OCCU_PATH=/path/to/occu python script/extract_easymodes.py
+OCCU_PATH=/path/to/occu python script/extract_translations.py
+CCU_URL=https://my-ccu.local python script/extract_profiles.py
+```
+
+### Environment variables
+
+| Variable     | Purpose                                                                  |
+| ------------ | ------------------------------------------------------------------------ |
+| `OCCU_PATH`  | Path to a local OCCU/RaspberryMatic checkout                             |
+| `CCU_URL`    | URL of a running CCU/OpenCCU instance (`http://` or `https://`)          |
+| `OUTPUT_DIR` | Override the default output directory                                    |
+| `RECEIVERS`  | (`extract_profiles` only) comma-separated list of receiver channel types |
+
+`.env` files at the repository root are auto-loaded (existing env vars win).
+
+## Vendoring into consumer projects
+
+The committed artifacts in `openccu_data/data/` are the **source of truth**.
+Consumers maintain their own runtime copies:
+
+| Consumer              | Vendored copy                                                              |
+| --------------------- | -------------------------------------------------------------------------- |
+| `aiohomematic`        | `aiohomematic/ccu_data/easymode_extract.json.gz`                           |
+| `aiohomematic`        | `aiohomematic/ccu_data/translation_extract.json.gz`                        |
+| `aiohomematic`        | `aiohomematic/ccu_data/translation_custom/*.json`                          |
+| `aiohomematic-config` | `aiohomematic_config/profiles/*.json.gz` (+ `_receiver_type_aliases.json`) |
+
+After regenerating any artifact, copy the relevant files into the consumer
+repository and open a PR there as well.
+
+## Development
+
+```bash
+python -m pip install -e .[test]
+pytest tests/
+ruff check openccu_data/ tests/
+mypy
+```
+
+## License
+
+- **Code**: [MIT](./LICENSE).
+- **Data artifacts** under `openccu_data/data/`: derivative of OCCU/RaspberryMatic
+  and subject to the EQ-3 license (see [NOTICE.md](./NOTICE.md)). The curated
+  `translation_custom/` overrides are MIT.
+
+"Homematic" and "HomematicIP" are trademarks of eQ-3 AG. This project is not
+affiliated with or endorsed by eQ-3 AG.

openccu_data-2026.4.1/README.md

@@ -0,0 +1,127 @@
+# openccu-data
+
+Extract and distribute Homematic CCU configuration metadata
+(translations, easymodes, link profiles) from
+[OCCU](https://github.com/eq-3/occu) /
+[OpenCCU](https://github.com/jens-maus/RaspberryMatic) /
+[RaspberryMatic](https://github.com/jens-maus/RaspberryMatic).
+
+This repository is the **single source of truth** for the data artifacts that
+are consumed by [aiohomematic](https://github.com/sukramj/aiohomematic) and
+[aiohomematic-config](https://github.com/sukramj/aiohomematic-config). Both
+projects vendor the produced JSON archives at runtime.
+
+## What this provides
+
+| Extractor                      | Source                               | Output                                                                                 |
+| ------------------------------ | ------------------------------------ | -------------------------------------------------------------------------------------- |
+| `openccu-extract-easymodes`    | TCL config under `config/easymodes/` | `openccu_data/data/easymode_extract.json.gz`                                           |
+| `openccu-extract-translations` | JS translation files + stringtable   | `openccu_data/data/translation_extract.json.gz` + `translation_custom/`                |
+| `openccu-extract-profiles`     | TCL link-profile files per receiver  | `openccu_data/data/profiles/<RECEIVER_TYPE>.json.gz` (+ `_receiver_type_aliases.json`) |
+
+All three read from either:
+
+- a local OCCU/OpenCCU/RaspberryMatic checkout (`OCCU_PATH=/path/to/occu`), or
+- a running CCU instance over HTTP/HTTPS (`CCU_URL=https://my-ccu.local`).
+
+If both are set, the easymode/translation extractors merge results; the
+profile extractor prefers the running CCU and falls back to local.
+
+## Repository layout
+
+```
+openccu-data/
+├── LICENSE                MIT (covers the code)
+├── NOTICE.md              Data-artifact licensing (EQ-3/OCCU)
+├── README.md              this file
+├── CLAUDE.md              guide for AI assistants
+├── changelog.md
+├── pyproject.toml
+├── openccu_data/
+│   ├── const.py
+│   ├── easymodes/extractor.py        easymode metadata parser
+│   ├── translations/extractor.py     CCU WebUI translation parser
+│   ├── profiles/extractor.py         easymode link-profile parser
+│   └── data/                         committed, vendored output
+│       ├── easymode_extract.json.gz
+│       ├── translation_extract.json.gz
+│       ├── translation_custom/*.json
+│       └── profiles/*.json.gz (+ _receiver_type_aliases.json)
+├── script/                           CLI wrappers
+└── tests/
+```
+
+## Installation
+
+```bash
+python -m pip install -e .[test]
+```
+
+No third-party runtime dependencies; only the standard library.
+
+## Usage
+
+### Console scripts
+
+After installation, three console scripts are available on the PATH:
+
+```bash
+OCCU_PATH=/path/to/occu openccu-extract-easymodes
+OCCU_PATH=/path/to/occu openccu-extract-translations
+CCU_URL=https://my-ccu.local openccu-extract-profiles
+```
+
+Output lands in `openccu_data/data/` by default. Override via `OUTPUT_DIR`.
+
+### Without installation
+
+```bash
+OCCU_PATH=/path/to/occu python script/extract_easymodes.py
+OCCU_PATH=/path/to/occu python script/extract_translations.py
+CCU_URL=https://my-ccu.local python script/extract_profiles.py
+```
+
+### Environment variables
+
+| Variable     | Purpose                                                                  |
+| ------------ | ------------------------------------------------------------------------ |
+| `OCCU_PATH`  | Path to a local OCCU/RaspberryMatic checkout                             |
+| `CCU_URL`    | URL of a running CCU/OpenCCU instance (`http://` or `https://`)          |
+| `OUTPUT_DIR` | Override the default output directory                                    |
+| `RECEIVERS`  | (`extract_profiles` only) comma-separated list of receiver channel types |
+
+`.env` files at the repository root are auto-loaded (existing env vars win).
+
+## Vendoring into consumer projects
+
+The committed artifacts in `openccu_data/data/` are the **source of truth**.
+Consumers maintain their own runtime copies:
+
+| Consumer              | Vendored copy                                                              |
+| --------------------- | -------------------------------------------------------------------------- |
+| `aiohomematic`        | `aiohomematic/ccu_data/easymode_extract.json.gz`                           |
+| `aiohomematic`        | `aiohomematic/ccu_data/translation_extract.json.gz`                        |
+| `aiohomematic`        | `aiohomematic/ccu_data/translation_custom/*.json`                          |
+| `aiohomematic-config` | `aiohomematic_config/profiles/*.json.gz` (+ `_receiver_type_aliases.json`) |
+
+After regenerating any artifact, copy the relevant files into the consumer
+repository and open a PR there as well.
+
+## Development
+
+```bash
+python -m pip install -e .[test]
+pytest tests/
+ruff check openccu_data/ tests/
+mypy
+```
+
+## License
+
+- **Code**: [MIT](./LICENSE).
+- **Data artifacts** under `openccu_data/data/`: derivative of OCCU/RaspberryMatic
+  and subject to the EQ-3 license (see [NOTICE.md](./NOTICE.md)). The curated
+  `translation_custom/` overrides are MIT.
+
+"Homematic" and "HomematicIP" are trademarks of eQ-3 AG. This project is not
+affiliated with or endorsed by eQ-3 AG.

openccu_data-2026.4.1/openccu_data/__init__.py

@@ -0,0 +1,5 @@
+"""openccu-data: extractors and vendored artifacts for Homematic CCU/OpenCCU metadata."""
+
+from openccu_data.const import VERSION
+
+__all__ = ("VERSION",)

openccu_data-2026.4.1/openccu_data/const.py

@@ -0,0 +1,7 @@
+"""Project-wide constants for openccu-data."""
+
+from __future__ import annotations
+
+from typing import Final
+
+VERSION: Final = "2026.4.1"

openccu_data-2026.4.1/openccu_data/data/__init__.py

@@ -0,0 +1,5 @@
+"""Vendored data artifacts extracted from OCCU/OpenCCU/RaspberryMatic.
+
+These files are derivative works subject to the upstream EQ-3/OCCU license
+terms. See ``NOTICE.md`` at the repository root for the full statement.
+"""

openccu_data-2026.4.1/openccu_data/data/profiles/_receiver_type_aliases.json

@@ -0,0 +1,5 @@
+{
+  "OPTICAL_SIGNAL_RECEIVER": "DIMMER_VIRTUAL_RECEIVER",
+  "SWITCH_TRANSCEIVER": "SWITCH_VIRTUAL_RECEIVER",
+  "UNIVERSAL_LIGHT_RECEIVER": "UNIVERSAL_LIGHT_RECEIVER_LSC"
+}

openccu_data-2026.4.1/openccu_data/data/translation_custom/channel_types_de.json

@@ -0,0 +1,21 @@
+{
+  "accesspoint_generic_receiver": "Access Point Generischer Empfänger",
+  "ddc": "Direkte Gerätekommunikation",
+  "digital_analog_input": "Digital-/Analogeingang",
+  "digital_analog_output": "Digital-/Analogausgang",
+  "digital_input": "Digitaleingang",
+  "digital_output": "Digitalausgang",
+  "ecokey": "ecoKey",
+  "generic": "Generischer Kanal",
+  "input_output": "Ein-/Ausgang",
+  "kwl_controller_transmitter": "Lüftungssteuerung",
+  "passage_detector": "Durchgangszähler",
+  "passage_detector_direction_transmitter": "Durchgangszähler Richtung",
+  "shading_receiver": "Beschattungsempfänger",
+  "shading_week_profile": "Beschattungs-Wochenprofil",
+  "simple_switch_receiver": "Einfacher Schaltempfänger",
+  "temp_humidity_particulate_matter_transmitter": "Temperatur-/Feuchte-/Feinstaubsensor",
+  "window": "Fensterkanal",
+  "ws_cs": "Wetterstation Kombinationssensor",
+  "ws_th": "Wetterstation Temperatur/Feuchte"
+}

openccu_data-2026.4.1/openccu_data/data/translation_custom/channel_types_en.json

@@ -0,0 +1,21 @@
+{
+  "accesspoint_generic_receiver": "Access Point Generic Receiver",
+  "ddc": "Direct Device Communication",
+  "digital_analog_input": "Digital/Analog Input",
+  "digital_analog_output": "Digital/Analog Output",
+  "digital_input": "Digital Input",
+  "digital_output": "Digital Output",
+  "ecokey": "ecoKey",
+  "generic": "Generic Channel",
+  "input_output": "Input/Output",
+  "kwl_controller_transmitter": "Ventilation Controller",
+  "passage_detector": "Passage Detector",
+  "passage_detector_direction_transmitter": "Passage Detector Direction",
+  "shading_receiver": "Shading Receiver",
+  "shading_week_profile": "Shading Week Profile",
+  "simple_switch_receiver": "Simple Switch Receiver",
+  "temp_humidity_particulate_matter_transmitter": "Temperature/Humidity/Particulate Matter Sensor",
+  "window": "Window Channel",
+  "ws_cs": "Weather Station Combination Sensor",
+  "ws_th": "Weather Station Temperature/Humidity"
+}

openccu_data-2026.4.1/openccu_data/data/translation_custom/device_icons.json

@@ -0,0 +1 @@
+{}