aioebus 0.1.0__tar.gz

aioebus-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aioebus-0.1.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: aioebus
+Version: 0.1.0
+Summary: Standalone async eBUS library (decode-first). No ebusd daemon required.
+Author-email: dneprojects <dne.projects.1@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/dneprojects/aioebus
+Project-URL: Repository, https://github.com/dneprojects/aioebus
+Project-URL: Issues, https://github.com/dneprojects/aioebus/issues
+Keywords: ebus,ebusd,vaillant,heating,home-assistant,asyncio
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# aioebus
+
+A **standalone, async, pure-Python eBUS library** — the goal is to talk to an
+eBUS adapter (enhanced protocol) and decode Vaillant/eBUS messages **without a
+separate ebusd daemon**, so a Home Assistant integration can embed it directly
+(lib in PyPI, thin integration in HA Core).
+
+This is an incremental port of [ebusd](https://github.com/john30/ebusd)'s
+behaviour to Python — **not** a line-by-line transpile. Each layer is ported by
+spec and checked against real captured telegrams (a conformance harness), so the
+long tail of real-world quirks is caught automatically.
+
+## Status
+
+| Phase | Scope | State |
+|---|---|---|
+| 0 | Scaffold + conformance harness (real captures as golden data) | ✅ |
+| 1 | **Datatype codecs** (`datatype.cpp` port) + CSV type specs | ✅ |
+| 2 | **Message model + CSV ingest + decode** (default rows, IGN, value tables) | ✅ |
+| 2.5 | **Full datatypes** (date/time/float/bit), **conditions** as metadata | ✅ |
+| 3 | **eBUS frame/CRC + passive decode** (wire bytes → named values) | ✅ |
+| 3b | **Enhanced-adapter transport** (protocol ✅; live socket needs a window) | ◐ |
+| 4 | Active read: build + scheduler + **send FSM ✅ (offline)**; live send, scan, write | ◐ |
+| 5 | Thin HA integration swaps its ebusd-HTTP client for this lib | ⏳ |
+
+The enhanced adapter does bus arbitration in hardware, so the timing-critical
+part is offloaded — Phase 3 ports a documented host↔adapter byte protocol, not
+microsecond timing.
+
+## Phase 1 — what works now
+
+Pure, offline decoding of eBUS field types, validated against telegrams captured
+from a real Vaillant cascade (2× aroTHERM, sensoCOMFORT, eloBlock, VR 71):
+
+```python
+from aioebus import decode
+
+decode("D2C", "bd01")            # 27.8125  (flow temp)
+decode("UCH", "0f")             # 15
+decode("STR:5", "4e45545833")   # "NETX3"
+decode("HEX:6", "090264186418") # "09 02 64 18 64 18"
+decode("SIN", "f401", divisor=10)  # 50.0  (CSV divisor column)
+decode("UCH", "ff")             # None  (invalid/replacement sentinel)
+```
+
+Supported types: the integers (UCH SCH UIN SIN ULG U2L U4L, reversed UIR SIR),
+fixed-point D1B D1C D2B D2C FLT, floats EXP/EXR, BCD[:n] PIN, HEX:n, STR:n/STR:*,
+IGN:n, bit fields BI0..BI7[:n], and the date/time family (TTM TTH TTQ, HTM BTM
+VTM, HTI BTI VTI, HDA BDA[:3], BDY HDY, DTM DAY) -- with the CSV divisor column
+and ebusd's replacement (invalid) handling. This resolves every field type used
+across the 104 stock Vaillant configs.
+
+## Phase 2 — structured messages + CSV ingest
+
+The in-memory model is structured dataclasses (`MessageDef` / `FieldDef`), never
+CSV-shaped. The community ebusd-CSV library is read *into* the model with Python's
+`csv` module (so quoted commas no longer abort a file). Our own curated
+definitions can instead live in the native JSON format (`convert.py`) — both
+become the same objects.
+
+```python
+from aioebus.messages import parse_csv
+
+msgs = {m.name: m for m in parse_csv(open("38.v32.csv").read())}
+msgs["Statenumber"].decode_labeled(slave="1f")   # {'Statenumber': 'sommer'}
+msgs["PositionValveSet"].decode_labeled(slave="64")  # {'PositionValveSet': 'dhw'}
+```
+
+`tools/demo_live.py <csv> <telegrams.db>` parses a real config and decodes the
+newest live telegram for every message — pure Python, no ebusd decoding.
+`python -m aioebus.convert <csv> [out.json]` converts curated CSVs to the native
+structured format.
+
+## Phase 3 — frame layer + passive decode
+
+The wire format is parsed end to end: escaping (`A9 01`→`AA`, `A9 00`→`A9`), the
+eBUS CRC-8 (polynomial `0x9B`, computed over the *escaped* stream), and the full
+frame structure incl. NAK-retransmission. Combined with the message model this
+turns raw bytes seen on the bus into named values, read-only:
+
+```python
+from aioebus import parse_csv, MessageRegistry, decode_raw
+
+reg = MessageRegistry(parse_csv(open("38.v32.csv").read()))
+decode_raw(reg, "3138b509030d1800740003910100bb00")   # (FlowTemp def, {'FlowTemp': 25.0625})
+```
+
+Validated bit-exact against **285 358** complete telegrams captured from the live
+bus: every one parses, matches ebusd's own decoded columns and verifies CRC
+(`tools/validate_frame_db.py`).
+
+## Phase 3b — enhanced-adapter transport
+
+`transport.py` decodes the adapter's framed byte stream (`11ccccdd 10dddddd`
+symbols, short form for bytes < 0x80), assembles telegrams on SYN and decodes
+them — all read-only, nothing is ever written to the bus:
+
+```python
+from aioebus import parse_csv, MessageRegistry, listen
+
+reg = MessageRegistry(parse_csv(open("38.v32.csv").read()))
+async for msgdef, values in listen("192.168.178.179", 9999, reg):
+    print(values)
+```
+
+The protocol logic is validated offline by round-tripping real telegrams through
+a synthetic adapter stream, including arbitrary read fragmentation
+(`tests/test_transport.py`). Live listening is gated on hardware: the enhanced
+adapter is single-client, so ebusd must be stopped first (a maintenance window).
+It has been run live against the reference adapter — passive decode works
+end-to-end without ebusd.
+
+## Phase 4 — active reads under limited bandwidth
+
+`active.build_read()` constructs the on-wire master request; its CRC matches
+ebusd for every real read in the log. `poll.PollScheduler` decides *what* to read
+and *when*, because eBUS is ~2400 baud and only a handful of reads fit per second:
+
+- only `r1`..`r9` are polled; the priority digit scales the interval (`r1` most
+  frequent), plain `r` is on-demand, `w`/`u` never;
+- **passive-first** — a value seen on the bus refreshes that register's timer, so
+  broadcasts are never re-polled (on the live bus this is most of the traffic);
+- one request at a time — the scheduler hands back only the most-overdue message.
+
+The bus *send* FSM (`active.ReadDriver`/`ActiveReader`) is ported from ebusd's
+`protocol_direct.cpp`: arbitrate (START with QQ) → send `ZZ PB SB NN DD` + CRC,
+each byte echoed back and **verified for collision** → master ACK → read the
+slave frame and check its CRC → ACK → SYN. The pure `ReadDriver` is driven in
+tests by a simulated adapter through a full round-trip (arbitration-won, echoes,
+answer, decode) plus the arbitration-lost and collision paths — all offline.
+
+The live send (`tools/active_read.py`, reads only) uses master address **0x31**,
+the address ebusd itself uses on the reference bus: known-good, and free exactly
+while ebusd is stopped (which the single-client adapter requires anyway). It has
+not been run on hardware yet — that is the next maintenance window.
+
+## Native config format + converter
+
+`configs/vaillant/*.json` are native-format device definitions (eloBlock, netx3)
+— **our own, independently-created** definitions, Apache-2.0. `aioebus.convert`
+turns any ebusd CSV into this format:
+
+```bash
+python -m aioebus.convert path/to/15.ctlv3.csv ctlv3.json
+```
+
+The ebusd-configuration CSVs are GPL-3.0, so a file converted from them is a
+GPL-3.0 derivative: convert those **locally, against your own copy** — this
+Apache-2.0 library ships only our own definitions, never a derivative of that
+GPL data. `tools/convert_configs.py` regenerates our own set and the HA
+translations base.
+
+Names are **not** baked in: `aioebus.translations.ha_strings()` derives a stable
+`translation_key` per field and emits `configs/vaillant/translations/strings.json`
+(the English base); a `de.json` is a translated copy with the same keys.
+
+## Dev
+
+```bash
+python -m pytest            # conformance tests (real captures)
+python tools/validate_frame_db.py /path/to/telegrams.db   # frames vs ebusd (100%)
+python tools/validate_against_db.py /path/to/telegrams.db  # optional field decode
+```

aioebus-0.1.0/README.md

@@ -0,0 +1,163 @@
+# aioebus
+
+A **standalone, async, pure-Python eBUS library** — the goal is to talk to an
+eBUS adapter (enhanced protocol) and decode Vaillant/eBUS messages **without a
+separate ebusd daemon**, so a Home Assistant integration can embed it directly
+(lib in PyPI, thin integration in HA Core).
+
+This is an incremental port of [ebusd](https://github.com/john30/ebusd)'s
+behaviour to Python — **not** a line-by-line transpile. Each layer is ported by
+spec and checked against real captured telegrams (a conformance harness), so the
+long tail of real-world quirks is caught automatically.
+
+## Status
+
+| Phase | Scope | State |
+|---|---|---|
+| 0 | Scaffold + conformance harness (real captures as golden data) | ✅ |
+| 1 | **Datatype codecs** (`datatype.cpp` port) + CSV type specs | ✅ |
+| 2 | **Message model + CSV ingest + decode** (default rows, IGN, value tables) | ✅ |
+| 2.5 | **Full datatypes** (date/time/float/bit), **conditions** as metadata | ✅ |
+| 3 | **eBUS frame/CRC + passive decode** (wire bytes → named values) | ✅ |
+| 3b | **Enhanced-adapter transport** (protocol ✅; live socket needs a window) | ◐ |
+| 4 | Active read: build + scheduler + **send FSM ✅ (offline)**; live send, scan, write | ◐ |
+| 5 | Thin HA integration swaps its ebusd-HTTP client for this lib | ⏳ |
+
+The enhanced adapter does bus arbitration in hardware, so the timing-critical
+part is offloaded — Phase 3 ports a documented host↔adapter byte protocol, not
+microsecond timing.
+
+## Phase 1 — what works now
+
+Pure, offline decoding of eBUS field types, validated against telegrams captured
+from a real Vaillant cascade (2× aroTHERM, sensoCOMFORT, eloBlock, VR 71):
+
+```python
+from aioebus import decode
+
+decode("D2C", "bd01")            # 27.8125  (flow temp)
+decode("UCH", "0f")             # 15
+decode("STR:5", "4e45545833")   # "NETX3"
+decode("HEX:6", "090264186418") # "09 02 64 18 64 18"
+decode("SIN", "f401", divisor=10)  # 50.0  (CSV divisor column)
+decode("UCH", "ff")             # None  (invalid/replacement sentinel)
+```
+
+Supported types: the integers (UCH SCH UIN SIN ULG U2L U4L, reversed UIR SIR),
+fixed-point D1B D1C D2B D2C FLT, floats EXP/EXR, BCD[:n] PIN, HEX:n, STR:n/STR:*,
+IGN:n, bit fields BI0..BI7[:n], and the date/time family (TTM TTH TTQ, HTM BTM
+VTM, HTI BTI VTI, HDA BDA[:3], BDY HDY, DTM DAY) -- with the CSV divisor column
+and ebusd's replacement (invalid) handling. This resolves every field type used
+across the 104 stock Vaillant configs.
+
+## Phase 2 — structured messages + CSV ingest
+
+The in-memory model is structured dataclasses (`MessageDef` / `FieldDef`), never
+CSV-shaped. The community ebusd-CSV library is read *into* the model with Python's
+`csv` module (so quoted commas no longer abort a file). Our own curated
+definitions can instead live in the native JSON format (`convert.py`) — both
+become the same objects.
+
+```python
+from aioebus.messages import parse_csv
+
+msgs = {m.name: m for m in parse_csv(open("38.v32.csv").read())}
+msgs["Statenumber"].decode_labeled(slave="1f")   # {'Statenumber': 'sommer'}
+msgs["PositionValveSet"].decode_labeled(slave="64")  # {'PositionValveSet': 'dhw'}
+```
+
+`tools/demo_live.py <csv> <telegrams.db>` parses a real config and decodes the
+newest live telegram for every message — pure Python, no ebusd decoding.
+`python -m aioebus.convert <csv> [out.json]` converts curated CSVs to the native
+structured format.
+
+## Phase 3 — frame layer + passive decode
+
+The wire format is parsed end to end: escaping (`A9 01`→`AA`, `A9 00`→`A9`), the
+eBUS CRC-8 (polynomial `0x9B`, computed over the *escaped* stream), and the full
+frame structure incl. NAK-retransmission. Combined with the message model this
+turns raw bytes seen on the bus into named values, read-only:
+
+```python
+from aioebus import parse_csv, MessageRegistry, decode_raw
+
+reg = MessageRegistry(parse_csv(open("38.v32.csv").read()))
+decode_raw(reg, "3138b509030d1800740003910100bb00")   # (FlowTemp def, {'FlowTemp': 25.0625})
+```
+
+Validated bit-exact against **285 358** complete telegrams captured from the live
+bus: every one parses, matches ebusd's own decoded columns and verifies CRC
+(`tools/validate_frame_db.py`).
+
+## Phase 3b — enhanced-adapter transport
+
+`transport.py` decodes the adapter's framed byte stream (`11ccccdd 10dddddd`
+symbols, short form for bytes < 0x80), assembles telegrams on SYN and decodes
+them — all read-only, nothing is ever written to the bus:
+
+```python
+from aioebus import parse_csv, MessageRegistry, listen
+
+reg = MessageRegistry(parse_csv(open("38.v32.csv").read()))
+async for msgdef, values in listen("192.168.178.179", 9999, reg):
+    print(values)
+```
+
+The protocol logic is validated offline by round-tripping real telegrams through
+a synthetic adapter stream, including arbitrary read fragmentation
+(`tests/test_transport.py`). Live listening is gated on hardware: the enhanced
+adapter is single-client, so ebusd must be stopped first (a maintenance window).
+It has been run live against the reference adapter — passive decode works
+end-to-end without ebusd.
+
+## Phase 4 — active reads under limited bandwidth
+
+`active.build_read()` constructs the on-wire master request; its CRC matches
+ebusd for every real read in the log. `poll.PollScheduler` decides *what* to read
+and *when*, because eBUS is ~2400 baud and only a handful of reads fit per second:
+
+- only `r1`..`r9` are polled; the priority digit scales the interval (`r1` most
+  frequent), plain `r` is on-demand, `w`/`u` never;
+- **passive-first** — a value seen on the bus refreshes that register's timer, so
+  broadcasts are never re-polled (on the live bus this is most of the traffic);
+- one request at a time — the scheduler hands back only the most-overdue message.
+
+The bus *send* FSM (`active.ReadDriver`/`ActiveReader`) is ported from ebusd's
+`protocol_direct.cpp`: arbitrate (START with QQ) → send `ZZ PB SB NN DD` + CRC,
+each byte echoed back and **verified for collision** → master ACK → read the
+slave frame and check its CRC → ACK → SYN. The pure `ReadDriver` is driven in
+tests by a simulated adapter through a full round-trip (arbitration-won, echoes,
+answer, decode) plus the arbitration-lost and collision paths — all offline.
+
+The live send (`tools/active_read.py`, reads only) uses master address **0x31**,
+the address ebusd itself uses on the reference bus: known-good, and free exactly
+while ebusd is stopped (which the single-client adapter requires anyway). It has
+not been run on hardware yet — that is the next maintenance window.
+
+## Native config format + converter
+
+`configs/vaillant/*.json` are native-format device definitions (eloBlock, netx3)
+— **our own, independently-created** definitions, Apache-2.0. `aioebus.convert`
+turns any ebusd CSV into this format:
+
+```bash
+python -m aioebus.convert path/to/15.ctlv3.csv ctlv3.json
+```
+
+The ebusd-configuration CSVs are GPL-3.0, so a file converted from them is a
+GPL-3.0 derivative: convert those **locally, against your own copy** — this
+Apache-2.0 library ships only our own definitions, never a derivative of that
+GPL data. `tools/convert_configs.py` regenerates our own set and the HA
+translations base.
+
+Names are **not** baked in: `aioebus.translations.ha_strings()` derives a stable
+`translation_key` per field and emits `configs/vaillant/translations/strings.json`
+(the English base); a `de.json` is a translated copy with the same keys.
+
+## Dev
+
+```bash
+python -m pytest            # conformance tests (real captures)
+python tools/validate_frame_db.py /path/to/telegrams.db   # frames vs ebusd (100%)
+python tools/validate_against_db.py /path/to/telegrams.db  # optional field decode
+```

aioebus-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[project]
+name = "aioebus"
+version = "0.1.0"
+description = "Standalone async eBUS library (decode-first). No ebusd daemon required."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "Apache-2.0"
+authors = [{ name = "dneprojects", email = "dne.projects.1@gmail.com" }]
+keywords = ["ebus", "ebusd", "vaillant", "heating", "home-assistant", "asyncio"]
+dependencies = []
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Home Automation",
+  "Typing :: Typed",
+]
+
+[project.urls]
+Homepage = "https://github.com/dneprojects/aioebus"
+Repository = "https://github.com/dneprojects/aioebus"
+Issues = "https://github.com/dneprojects/aioebus/issues"
+
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+aioebus = ["py.typed"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 110
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "SIM", "C4", "RUF"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["E501", "SIM102", "RUF059", "RUF015", "C401"]
+"tools/*" = ["E501", "RUF015", "SIM105", "B007"]

aioebus-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

aioebus-0.1.0/src/aioebus/__init__.py

@@ -0,0 +1,67 @@
+"""aioebus -- standalone async eBUS library (work in progress).
+
+Pure, offline eBUS decoding validated against real captured telegrams:
+  - codecs: datatype decoding (ebusd datatype.cpp port)
+  - messages: structured definitions + ebusd-CSV ingest + decode
+  - frame: on-the-wire telegram parsing, escaping, eBUS CRC-8
+  - passive: raw wire bytes -> matched message -> named values (read-only)
+  - transport/active/engine: enhanced-adapter I/O, active read/write, and a
+    passive-first engine that caches decoded values and interleaves reads.
+"""
+from .active import (
+    ActiveReader,
+    ActiveWriter,
+    ReadDriver,
+    ReadError,
+    WriteDriver,
+    build_read,
+    build_read_frame,
+    build_write_frame,
+)
+from .codecs import Codec, decode, encode, make_codec
+from .conditions import ConditionContext, context_from_scan, evaluate, evaluate_all
+from .engine import EbusEngine, value_key
+from .frame import Telegram, crc8, escape, parse_telegram, unescape
+from .messages import FieldDef, MessageDef, parse_csv
+from .passive import MessageRegistry, decode_raw
+from .poll import PollScheduler
+from .scan import ScanResult, decode_scan
+from .transport import EnhDecoder, PassiveListener, listen
+
+__all__ = [
+    "ActiveReader",
+    "ActiveWriter",
+    "Codec",
+    "ConditionContext",
+    "EbusEngine",
+    "EnhDecoder",
+    "FieldDef",
+    "MessageDef",
+    "MessageRegistry",
+    "PassiveListener",
+    "PollScheduler",
+    "ReadDriver",
+    "ReadError",
+    "ScanResult",
+    "Telegram",
+    "WriteDriver",
+    "build_read",
+    "build_read_frame",
+    "build_write_frame",
+    "context_from_scan",
+    "crc8",
+    "decode",
+    "decode_raw",
+    "decode_scan",
+    "encode",
+    "escape",
+    "evaluate",
+    "evaluate_all",
+    "listen",
+    "make_codec",
+    "parse_csv",
+    "parse_telegram",
+    "unescape",
+    "value_key",
+]
+__version__ = "0.1.0"