ramses-rf 0.52.2__tar.gz → 0.52.3__tar.gz

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/.github/workflows/check-lint.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install ruff  # pip install -r requirements_dev.txt
+          pip install ruff  # pip install -r requirements/requirements_dev.txt
 
       - name: Check with ruff
         run: ruff check --output-format=github .

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/.github/workflows/check-test.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
+          pip install -r requirements/requirements_dev.txt
 
       - name: Install the package (and its dependencies)
         run: pip install -e .

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/.github/workflows/check-type.yml

@@ -41,7 +41,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements_dev.txt
+          pip install -r requirements/requirements_dev.txt
 
       - name: Install the package (its dependencies are needed for typing)
         run: pip install -e .

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/.github/workflows/publish-hatch.yml

@@ -26,7 +26,7 @@ jobs:
         run: hatch build
 
       - name: Upload dist
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: dist
           path: dist/
@@ -40,7 +40,7 @@ jobs:
       url: https://pypi.org/project/ramses_rf
     steps:
       - name: Download dist
-        uses: actions/download-artifact@v5
+        uses: actions/download-artifact@v6
         with:
           name: dist
           path: dist/

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.52.2
+Version: 0.52.3
 Summary: A stateful RAMSES-II protocol decoder & analyser.
 Project-URL: Homepage, https://github.com/ramses-rf/ramses_rf
 Project-URL: Bug Tracker, https://github.com/ramses-rf/ramses_rf/issues

ramses_rf-0.52.3/docs/source/binding_process_diagram.md

@@ -0,0 +1,159 @@
+# RAMSES RF Binding Process Diagram
+
+## Overview
+This diagram shows the binding finite state machine (FSM) for RAMSES RF devices, illustrating the complete process from initial state to binding completion.
+
+## State Machine Diagram
+
+```mermaid
+stateDiagram-v2
+    direction LR
+    [*] --> DevIsNotBinding
+    DevIsNotBinding --> InitiateBindingProcess : initiate_binding_process()
+    InitiateBindingProcess --> SuppSendOfferWaitForAccept
+    SuppSendOfferWaitForAccept --> OfferSent : _make_offer()
+    OfferSent --> SuppSendOfferWaitForAccept : wait_for_accept()
+    DevIsNotBinding --> RespIsWaitingForOffer : wait_for_binding_request()
+    RespIsWaitingForOffer --> OfferReceived : _wait_for_offer()
+    OfferReceived --> RespSendAcceptWaitForConfirm : _accept_offer()
+    RespSendAcceptWaitForConfirm --> SuppIsReadyToSendConfirm : wait_for_confirm()
+    SuppIsReadyToSendConfirm --> StateDecisionPoint : cast_confirm_accept()
+    StateDecisionPoint --> RespHasBoundAsRespondent : No addenda
+    StateDecisionPoint --> SuppHasBoundAsSupplicant : Yes addenda / Complete
+    RespHasBoundAsRespondent --> DevIsNotBinding
+    SuppHasBoundAsSupplicant --> DevIsNotBinding
+    DevIsNotBinding --> [*] : Binding Complete
+
+    subgraph Supplicant Role
+        SuppSendOfferWaitForAccept
+        OfferSent
+        SuppIsReadyToSendConfirm
+        SuppHasBoundAsSupplicant
+    end
+
+    subgraph Respondent Role
+        RespIsWaitingForOffer
+        OfferReceived
+        RespSendAcceptWaitForConfirm
+        RespHasBoundAsRespondent
+    end
+
+    classDef supplicant fill:#006400,stroke:#ffffff,stroke-width:2px
+    classDef respondent fill:#00008B,stroke:#ffffff,stroke-width:2px
+
+    class SuppSendOfferWaitForAccept,OfferSent,SuppIsReadyToSendConfirm,SuppHasBoundAsSupplicant supplicant
+    class RespIsWaitingForOffer,OfferReceived,RespSendAcceptWaitForConfirm,RespHasBoundAsRespondent respondent
+    class Supplicant Role supplicant
+    class Respondent Role respondent
+
+    note right of DevIsNotBinding
+        Not binding<br/>Ready to start
+    end note
+
+    note right of SuppSendOfferWaitForAccept
+        Made Offer<br/>Waiting for Accept
+    end note
+
+    note right of RespIsWaitingForOffer
+        Waiting for Offer
+    end note
+
+    note right of RespSendAcceptWaitForConfirm
+        Sent Accept<br/>Waiting for Confirm
+    end note
+
+    note right of SuppIsReadyToSendConfirm
+        Received Accept<br/>Ready to send Confirm
+    end note
+
+    note right of StateDecisionPoint
+        If addenda: SendAddenda<br/>If no addenda: Complete
+    end note
+
+    note right of RespHasBoundAsRespondent
+        Binding Complete
+    end note
+
+    note right of SuppHasBoundAsSupplicant
+        Binding Complete<br/>Nothing more to do
+    end note
+```
+
+## Method Flow by Role
+
+### Supplicant Flow (Device initiating binding)
+```python
+async def initiate_binding_process(self, offer_codes, confirm_code=None, ratify_cmd=None):
+    1. _make_offer(offer_codes, oem_code)           # Send Offer packet
+    2. _wait_for_accept(tender)                     # Wait for Accept response
+    3. _confirm_accept(accept, confirm_code)        # Send Confirm packet
+    4. _cast_addenda(accept, ratify_cmd)            # Optional: Send Addenda
+
+    # Result: SuppHasBoundAsSupplicant state
+```
+
+### Respondent Flow (Device responding to binding)
+```python
+async def wait_for_binding_request(self, accept_codes, idx="00", require_ratify=False):
+    1. _wait_for_offer()                            # Wait for Offer packet
+    2. _accept_offer(tender, accept_codes, idx)     # Send Accept packet
+    3. _wait_for_confirm(accept)                    # Wait for Confirm packet
+    4. _wait_for_addenda(accept)                    # Optional: Wait for Addenda
+
+    # Result: RespHasBoundAsRespondent state
+```
+
+## State Details
+
+| State | Role | Description | Key Methods |
+|-------|------|-------------|-------------|
+| `DevIsNotBinding` | Any | Initial/final state, not participating in binding | - |
+| `RespIsWaitingForOffer` | Respondent | Waiting for binding offer from supplicant | `wait_for_offer()` |
+| `RespSendAcceptWaitForConfirm` | Respondent | Sent Accept, waiting for Confirm | `cast_accept_offer()`, `wait_for_confirm()` |
+| `RespIsWaitingForAddenda` | Respondent | Received Confirm, waiting for optional Addenda | `wait_for_addenda()` |
+| `RespHasBoundAsRespondent` | Respondent | Binding completed successfully | ✅ **NEW LOGGING HERE** |
+| `SuppSendOfferWaitForAccept` | Supplicant | Sent Offer, waiting for Accept | `cast_offer()`, `wait_for_accept()` |
+| `SuppIsReadyToSendConfirm` | Supplicant | Received Accept, ready to send Confirm | `cast_confirm_accept()` |
+| `SuppIsReadyToSendAddenda` | Supplicant | Sent Confirm, ready to send Addenda | `cast_addenda()` |
+| `SuppHasBoundAsSupplicant` | Supplicant | Binding completed successfully | ✅ **NEW LOGGING HERE** |
+| `DevHasFailedBinding` | Any | Binding failed, error state | - |
+
+## Binding Phases (Packet Types)
+
+| Phase | Packet Type | Description | Direction |
+|-------|-------------|-------------|-----------|
+| `TENDER` | `1FC9` (I_) | Offer phase - initial binding proposal | Supplicant → Respondent |
+| `ACCEPT` | `1FC9` (W_) | Accept phase - acceptance of offer | Respondent → Supplicant |
+| `AFFIRM` | `1FC9` (I_) | Confirm phase - confirmation of acceptance | Supplicant → Respondent |
+| `RATIFY` | `10E0` (I_) | Addenda phase - optional additional binding info | Either direction |
+
+## New Logging Implementation
+
+The following log.info statements have been added at binding completion points:
+
+### 1. Constructor Logging (Immediate Confirmation)
+- **`RespHasBoundAsRespondent.__init__()`**: Logs when respondent binding completes
+- **`SuppHasBoundAsSupplicant.__init__()`**: Logs when supplicant binding completes
+
+### 2. State Transition Logging (Complete Flow)
+- **`BindContextBase.set_state()`**: Logs the complete state transition to bound states, including:
+  - Previous state name
+  - New bound state name  
+  - Final role (respondent/supplicant)
+
+## Example Log Output
+```
+INFO:ramses_rf.binding_fsm:32:123456: Binding completed as respondent
+INFO:ramses_rf.binding_fsm:37:789012: Binding completed as supplicant  
+INFO:ramses_rf.binding_fsm:32:123456: Binding process completed: RespSendAcceptWaitForConfirm -> RespHasBoundAsRespondent (role: BindRole.RESPONDENT)
+```
+
+## Error Handling
+- **Timeout**: Binding fails if expected packets not received within timeout periods
+- **Retry Limits**: Automatic failure after retry limits exceeded
+- **Exception**: `BindingFlowFailed` raised on binding errors
+
+## Configuration Constants
+- `CONFIRM_RETRY_LIMIT`: 3 (automatic binding after this many confirm sends)
+- `CONFIRM_TIMEOUT_SECS`: 3 (automatic binding after this many seconds)
+- `WAITING_TIMEOUT_SECS`: 5 (fail if no packet received within this time)

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/docs/source/conf.py

@@ -36,6 +36,7 @@ extensions = [
     "sphinx.ext.githubpages",
     "sphinx_design",
     "myst_parser",  # to use Markdown inside reST
+    "sphinxcontrib.mermaid",  # to show mermaid diagrams in docs
 ]
 pygments_style = "sphinx"  # enable syntax highlighting
 
@@ -72,3 +73,4 @@ autosummary_generate_overwrite = True
 # Myst
 myst_enable_extensions = ["colon_fence"]
 myst_heading_anchors = 4
+myst_fence_as_directive = ["mermaid"]

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/docs/source/index.rst

@@ -11,6 +11,7 @@ ramses_rf
 
    usage
    glossary
+   binding_process_diagram
 
 .. toctree::
    :maxdepth: 2

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/docs/source/usage.md

@@ -15,7 +15,7 @@ MyST [markup](https://myst-parser.readthedocs.io/en/latest/syntax/organising_con
 
 - Activate your virtual environment for ramses_rf as described in the [Wiki](https://github.com/ramses-rf/ramses_rf/blob/master/README-developers.md).
 
-- Install the extra required dependencies by running ``pip install -r requirements_docs.txt`` so you can build a local set.
+- Install the extra required dependencies by running ``pip install -r requirements/requirements_docs.txt`` so you can build a local set.
 
 - Then, in a Terminal, enter `cd docs/` and run `sphinx-build -b html source build/html`.
 

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_rf/binding_fsm.py

@@ -178,6 +178,8 @@ class BindContextBase:
         self, state: type[BindStateBase], result: asyncio.Future[Message] | None = None
     ) -> None:
         """Transition the State of the Context, and process the result, if any."""
+        # Ensure prev_state is always available, not only during debugging
+        prev_state = self._state
 
         # if False and result:
         #     try:
@@ -185,10 +187,6 @@ class BindContextBase:
         #     except exc.BindingError as err:
         #         self._fut.set_result(err)
 
-        if _DBG_MAINTAIN_STATE_CHAIN:  # HACK for debugging
-            # if prev_state in (None, )
-            prev_state = self._state
-
         self._state = state(self)
         if not self.is_binding:
             self._is_respondent = None
@@ -197,6 +195,14 @@ class BindContextBase:
         elif state is SuppSendOfferWaitForAccept:
             self._is_respondent = False
 
+        # Log binding completion transitions
+        if isinstance(
+            self._state, (RespHasBoundAsRespondent, SuppHasBoundAsSupplicant)
+        ):
+            _LOGGER.info(
+                f"{self._dev.id}: Binding process completed: {type(prev_state).__name__} -> {state.__name__} (role: {self.role})"
+            )
+
         if _DBG_MAINTAIN_STATE_CHAIN:  # HACK for debugging
             setattr(self._state, "_prev_state", prev_state)  # noqa: B010
 
@@ -663,6 +669,10 @@ class RespHasBoundAsRespondent(BindStateBase):
 
     _attr_role = BindRole.IS_DORMANT
 
+    def __init__(self, context: BindContextBase) -> None:
+        super().__init__(context)
+        _LOGGER.info(f"{context._dev.id}: Binding completed as respondent")
+
 
 class RespIsWaitingForAddenda(_DevIsWaitingForMsg, BindStateBase):
     """Respondent has received a Confirm & is waiting for an Addenda."""
@@ -715,6 +725,10 @@ class SuppHasBoundAsSupplicant(BindStateBase):
 
     _attr_role = BindRole.IS_DORMANT
 
+    def __init__(self, context: BindContextBase) -> None:
+        super().__init__(context)
+        _LOGGER.info(f"{context._dev.id}: Binding completed as supplicant")
+
 
 class SuppIsReadyToSendAddenda(
     _DevIsReadyToSendCmd, BindStateBase

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_rf/database.py

@@ -334,7 +334,7 @@ class MessageIndex:
                 payload_keys(msg.payload),
             ),
         )
-        _LOGGER.debug(f"Added {msg} to gwy.msg_db")
+        # _LOGGER.debug(f"Added {msg} to gwy.msg_db")
 
         return _old_msgs[0] if _old_msgs else None
 
@@ -435,7 +435,7 @@ class MessageIndex:
 
     def qry_dtms(self, **kwargs: bool | dt | str) -> list[Any]:
         """
-        Select from the ImageIndex a list of dtms that match the provided arguments.
+        Select from the MessageIndex a list of dtms that match the provided arguments.
 
         :param kwargs: data table field names and criteria
         :return: list of unformatted dtms that match, useful for msg lookup, or an empty list if 0 matches

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_rf/device/heat.py

@@ -120,7 +120,7 @@ _LOGGER = logging.getLogger(__name__)
 
 class Actuator(DeviceHeat):  # 3EF0, 3EF1 (for 10:/13:)
     # .I --- 13:109598 --:------ 13:109598 3EF0 003 00C8FF                # event-driven, 00/C8
-    # RP --- 13:109598 18:002563 --:------ 0008 002 00C8                  # 00/C8, as abobe
+    # RP --- 13:109598 18:002563 --:------ 0008 002 00C8                  # 00/C8, as above
     # RP --- 13:109598 18:002563 --:------ 3EF1 007 0000BF-00BFC8FF       # 00/C8, as above
 
     # RP --- 10:048122 18:140805 --:------ 3EF1 007 007FFF-003C2A10       # 10:s only RP, always 7FFF
@@ -668,11 +668,8 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
         self._child_id = FC  # NOTE: domain_id
 
         # TODO(eb): cleanup
-        # should fix src/ramses_rf/database.py _add_record try/except when activating next line
         if self._gwy.msg_db:
-            self._add_record(
-                address=self.addr, code=Code._3220, verb="RP"
-            )  # << essential?
+            self._add_record(address=self.addr, code=Code._3220, verb="RP")
         # adds a "sim" RP opentherm_msg to the SQLite MessageIndex with code _3220
         # causes exc when fetching ALL, when no "real" msg was added to _msgs_. We skip those.
         else:
@@ -1411,7 +1408,7 @@ class UfhCircuit(Child, Entity):  # FIXME
     def __init__(self, ufc: UfhController, ufh_idx: str) -> None:
         super().__init__(ufc._gwy)
 
-        # FIXME: ZZZ entities must know their parent device ID and their own idx
+        # FIXME: gwy.msg_db entities must know their parent device ID and their own idx
         self._z_id = ufc.id
         self._z_idx = ufh_idx
 

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_rf/entity_base.py

@@ -67,8 +67,7 @@ if TYPE_CHECKING:
 
 
 _QOS_TX_LIMIT = 12  # TODO: needs work
-_ID_SLICE = 9  # base address only, legacy _msgs 9
-_SQL_SLICE = 12  # msg_db dst field query 12
+_ID_SLICE = 9
 _SZ_LAST_PKT: Final = "last_msg"
 _SZ_NEXT_DUE: Final = "next_due"
 _SZ_TIMEOUT: Final = "timeout"
@@ -248,6 +247,7 @@ class _MessageDB(_Entity):
                 "For %s (z_id %s) add msg %s, src %s, dst %s to msg_db.",
                 self.id,
                 self._z_id,
+                msg,
                 msg.src,
                 msg.dst,
             )
@@ -291,7 +291,7 @@ class _MessageDB(_Entity):
 
     @property
     def _msg_list(self) -> list[Message]:
-        """Return a flattened list of all messages logged on device."""
+        """Return a flattened list of all messages logged on this device."""
         # (only) used in gateway.py#get_state() and in tests/tests/test_eavesdrop_schema.py
         if self._gwy.msg_db:
             msg_list_qry: list[Message] = []
@@ -302,6 +302,8 @@ class _MessageDB(_Entity):
                         # safeguard against lookup failures ("sim" packets?)
                         msg_list_qry.append(self._msgs[c])
                     else:
+                        # evohome has these errors
+                        # _msg_list could not fetch self._msgs[7FFF] for 18:072981 (z_id 18:072981)
                         _LOGGER.debug(
                             "_msg_list could not fetch self._msgs[%s] for %s (z_id %s)",
                             c,
@@ -428,7 +430,7 @@ class _MessageDB(_Entity):
         :param code: filter messages by Code or a tuple of Codes, optional
         :param verb: filter on I, RQ, RP, optional, only with a single Code
         :param key: value keyword to retrieve, not together with verb RQ
-        :param kwargs: not used for now
+        :param kwargs: extra filter, e.g. zone_idx='01'
         :return: a dict containing key: value pairs, or a list of those
         """
         assert not isinstance(code, tuple) or verb is None, (
@@ -444,7 +446,9 @@ class _MessageDB(_Entity):
                 key = None
             try:
                 if self._gwy.msg_db:  # central SQLite MessageIndex, use verb= kwarg
-                    code = Code(self._msg_qry_by_code_key(code, key, verb=verb))
+                    code = Code(
+                        self._msg_qry_by_code_key(code, key, **kwargs, verb=verb)
+                    )
                     msg = self._msgs.get(code)
                 else:  # deprecated lookup in nested _msgz
                     msgs = self._msgz[code][verb]
@@ -456,7 +460,9 @@ class _MessageDB(_Entity):
             msgs = [m for m in self._msgs.values() if m.code in code]
             msg = max(msgs) if msgs else None
             # return highest = latest? value found in code:value pairs
-        else:
+        else:  # single Code
+            # for Zones, this doesn't work, returns first result = often wrong
+            # TODO fix in _msg_qry_by_code_key()
             msg = self._msgs.get(code)
 
         return self._msg_value_msg(msg, key=key, **kwargs)
@@ -531,19 +537,37 @@ class _MessageDB(_Entity):
 
         :return: list of Codes or empty list when query returned empty
         """
+
         if self._gwy.msg_db:
             # SQLite query on MessageIndex
-            sql = """
-                SELECT code from messages WHERE verb in (' I', 'RP')
-                AND (src = ? OR dst = ?)
-            """
             res: list[Code] = []
+            if self.id[_ID_SLICE:] == "_HW":
+                sql = """
+                    SELECT code from messages WHERE
+                    verb in (' I', 'RP')
+                    AND (src = ? OR dst = ?)
+                    AND (ctx IN ('FC', 'FA', 'F9', 'FA') OR plk LIKE ?)
+                """
+                _ctx_qry = "%dhw_idx%"  # syntax error ?
+            else:
+                sql = """
+                    SELECT code from messages WHERE
+                    verb in (' I', 'RP')
+                    AND (src = ? OR dst = ?)
+                    AND ctx LIKE ?
+                """
+                _ctx_qry = f"%{self.id[_ID_SLICE + 1 :]}%"
 
             for rec in self._gwy.msg_db.qry_field(
-                sql, (self.id[:_SQL_SLICE], self.id[:_SQL_SLICE])
+                sql, (self.id[:_ID_SLICE], self.id[:_ID_SLICE], _ctx_qry)
             ):
-                _LOGGER.debug("Fetched from index: %s", rec[0])
-                # Example: "Fetched from index: code 1FD4"
+                _LOGGER.debug(
+                    "Fetched from index: %s for %s (z_id %s)",
+                    rec[0],
+                    self.id,
+                    self._z_id,
+                )
+                # Example: "Fetched from index: code 1FD4 for 01:123456 (z_id 01)"
                 res.append(Code(str(rec[0])))
             return res
         else:
@@ -566,32 +590,48 @@ class _MessageDB(_Entity):
         :return: Code of most recent query result message or None when query returned empty
         """
         if self._gwy.msg_db:
-            code_qry: str = ""
+            code_qry: str = "= "
             if code is None:
-                code_qry = "*"
+                code_qry = "LIKE '%'"  # wildcard
             elif isinstance(code, tuple):
                 for cd in code:
                     code_qry += f"'{str(cd)}' OR code = '"
                 code_qry = code_qry[:-13]  # trim last OR
             else:
-                code_qry = str(code)
-            key = "*" if key is None else f"%{key}%"
+                code_qry += str(code)
             if kwargs["verb"] and kwargs["verb"] in (" I", "RP"):
                 vb = f"('{str(kwargs['verb'])}',)"
             else:
                 vb = "(' I', 'RP',)"
+            ctx_qry = "%"
+            if kwargs["zone_idx"]:
+                ctx_qry = f"%{kwargs['zone_idx']}%"
+            elif kwargs["dhw_idx"]:  # DHW
+                ctx_qry = f"%{kwargs['dhw_idx']}%"
+            key_qry = "%" if key is None else f"%{key}%"
+
             # SQLite query on MessageIndex
             sql = """
-                SELECT dtm, code from messages WHERE verb in ?
+                SELECT dtm, code from messages WHERE
+                verb in ?
                 AND (src = ? OR dst = ?)
-                AND (code = ?)
+                AND (code ?)
+                AND (ctx LIKE ?)
                 AND (plk LIKE ?)
             """
             latest: dt = dt(0, 0, 0)
             res = None
 
             for rec in self._gwy.msg_db.qry_field(
-                sql, (vb, self.id[:_SQL_SLICE], self.id[:_SQL_SLICE], code_qry, key)
+                sql,
+                (
+                    vb,
+                    self.id[:_ID_SLICE],
+                    self.id[:_ID_SLICE],
+                    code_qry,
+                    ctx_qry,
+                    key_qry,
+                ),
             ):
                 _LOGGER.debug(
                     "_msg_qry_by_code_key fetched rec: %s, code: %s", rec, code_qry
@@ -654,7 +694,7 @@ class _MessageDB(_Entity):
             # """SELECT code from messages WHERE verb in (' I', 'RP') AND (src = ? OR dst = ?)
             # AND (code = '31DA' OR ...) AND (plk LIKE '%{SZ_FAN_INFO}%' OR ...)""" = 2 params
             for rec in self._gwy.msg_db.qry_field(
-                sql, (self.id[:_SQL_SLICE], self.id[:_SQL_SLICE])
+                sql, (self.id[:_ID_SLICE], self.id[:_ID_SLICE])
             ):
                 _pl = self._msgs[Code(rec[0])].payload
                 # add payload dict to res(ults)
@@ -694,24 +734,38 @@ class _MessageDB(_Entity):
             # _LOGGER.warning("Missing MessageIndex")
             # raise NotImplementedError
 
-        if self.id[:3] == "18:":  # HGI, confirm this is correct, tests suggest so
-            return {}
+        # if self.id[:3] == "18:":  # HGI, confirm this is correct, tests suggest so
+        #     return {}
 
-        sql = """
-            SELECT dtm from messages WHERE verb in (' I', 'RP') AND (src = ? OR dst = ?)
-        """
-
-        # handy routine to debug dict creation, see test_systems.py
+        # a routine to debug dict creation, see test_systems.py:
         # print(f"Create _msgs for {self.id}:")
         # results = self._gwy.msg_db._cu.execute("SELECT dtm, src, code from messages WHERE verb in (' I', 'RP') and code is '3150'")
         # for r in results:
         #     print(r)
 
-        _msg_dict = {  # ? use ctx (context) instead of just the address?
+        if self.id[_ID_SLICE:] == "_HW":
+            sql = """
+                SELECT dtm from messages WHERE
+                verb in (' I', 'RP')
+                AND (src = ? OR dst = ?)
+                AND (ctx IN ('FC', 'FA', 'F9', 'FA') OR plk LIKE ?)
+            """
+            _ctx_qry = "%dhw_idx%"
+            # TODO add Children messages? self.ctl.dhw
+        else:
+            sql = """
+                SELECT dtm from messages WHERE
+                verb in (' I', 'RP')
+                AND (src = ? OR dst = ?)
+                AND ctx LIKE ?
+            """
+            _ctx_qry = f"%{self.id[_ID_SLICE + 1 :]}%"
+
+        _msg_dict = {  # since 0.52.3 use ctx (context) instead of just the address
             m.code: m
             for m in self._gwy.msg_db.qry(
-                sql, (self.id[:_SQL_SLICE], self.id[:_SQL_SLICE])
-            )  # e.g. 01:123456_HW
+                sql, (self.id[:_ID_SLICE], self.id[:_ID_SLICE], _ctx_qry)
+            )  # e.g. 01:123456_HW, 01:123456_02 (Zone)
         }
         # if CTL, remove 3150, 3220 heat_demand, both are only stored on children
         # HACK
@@ -786,7 +840,7 @@ class _Discovery(_MessageDB):
                 code: CODES_SCHEMA[code][SZ_NAME]
                 for code in sorted(
                     self._gwy.msg_db.get_rp_codes(
-                        (self.id[:_SQL_SLICE], self.id[:_SQL_SLICE])
+                        (self.id[:_ID_SLICE], self.id[:_ID_SLICE])
                     )
                 )
                 if self._is_not_deprecated_cmd(code)
@@ -818,7 +872,7 @@ class _Discovery(_MessageDB):
                 AND (src = ? OR dst = ?)
             """
             for rec in self._gwy.msg_db.qry_field(
-                sql, (self.id[:_SQL_SLICE], self.id[:_SQL_SLICE])
+                sql, (self.id[:_ID_SLICE], self.id[:_ID_SLICE])
             ):
                 _LOGGER.debug("Fetched OT ctx from index: %s", rec[0])
                 res.append(rec[0])
@@ -949,8 +1003,8 @@ class _Discovery(_MessageDB):
                             sql,
                             (
                                 task[_SZ_COMMAND].code,
-                                self.tcs.id[:_ID_SLICE],  # OK? not _SQL_SLICE?
-                                self.tcs.id[:_ID_SLICE],  # OK? not _SQL_SLICE?
+                                self.tcs.id[:_ID_SLICE],
+                                self.tcs.id[:_ID_SLICE],
                             ),
                         )[0]  # expect 1 Message in returned tuple
                     else:  # TODO(eb) remove next Q1 2026

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_rf/system/zones.py

@@ -233,7 +233,7 @@ class DhwZone(ZoneSchedule):  # CS92A
         # def eavesdrop_dhw_sensor(this: Message, *, prev: Message | None = None) -> None:
         # """Eavesdrop packets, or pairs of packets, to maintain the system state.
 
-        # There are only 2 ways to to find a controller's DHW sensor:
+        # There are only 2 ways to find a controller's DHW sensor:
         # 1. The 10A0 RQ/RP *from/to a 07:* (1x/4h) - reliable
         # 2. Use sensor temp matching - non-deterministic
 

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_rf/version.py

@@ -1,4 +1,4 @@
 """RAMSES RF - a RAMSES-II protocol decoder & analyser (application layer)."""
 
-__version__ = "0.52.2"
+__version__ = "0.52.3"
 VERSION = __version__

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_tx/gateway.py

@@ -34,6 +34,7 @@ from .schemas import (
     SZ_DISABLE_QOS,
     SZ_DISABLE_SENDING,
     SZ_ENFORCE_KNOWN_LIST,
+    SZ_LOG_ALL_MQTT,
     SZ_PACKET_LOG,
     SZ_PORT_CONFIG,
     SZ_PORT_NAME,
@@ -114,6 +115,7 @@ class Engine:
             self._exclude,
         )
         self._sqlite_index = kwargs.pop(SZ_SQLITE_INDEX, False)  # default True?
+        self._log_all_mqtt = kwargs.pop(SZ_LOG_ALL_MQTT, False)
         self._kwargs: dict[str, Any] = kwargs  # HACK
 
         self._engine_lock = Lock()  # FIXME: threading lock, or asyncio lock?
@@ -197,6 +199,7 @@ class Engine:
             self._protocol,
             disable_sending=self._disable_sending,
             loop=self._loop,
+            log_all=self._log_all_mqtt,
             **pkt_source,
             **self._kwargs,  # HACK: odd/misc params, e.g. comms_params
         )

{ramses_rf-0.52.2 → ramses_rf-0.52.3}/ramses_tx/logger.py

@@ -162,6 +162,14 @@ class StdOutFilter(logging.Filter):  # record.levelno < logging.WARNING
         return record.levelno < logging.WARNING
 
 
+class BlockMqttFilter(logging.Filter):
+    """Block mqtt traffic"""
+
+    def filter(self, record: logging.LogRecord) -> bool:
+        """Return True if the record is to be processed."""
+        return not record.getMessage().startswith("mq Rx: ")
+
+
 class TimedRotatingFileHandler(_TimedRotatingFileHandler):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)