ramses-rf 0.52.3__py3-none-any.whl → 0.52.5__py3-none-any.whl

ramses_cli/client.py

@@ -588,6 +588,7 @@ def main() -> None:
         print(" - event_loop_policy set for win32")  # do before asyncio.run()
         asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 
+    profile = None
     try:
         if _PROFILE_LIBRARY:
             profile = cProfile.Profile()

ramses_cli/debug.py

@@ -9,7 +9,7 @@ DEBUG_PORT = 5678
 
 
 def start_debugging(wait_for_client: bool) -> None:
-    import debugpy  # type: ignore[import-untyped]
+    import debugpy
 
     debugpy.listen(address=(DEBUG_ADDR, DEBUG_PORT))
     print(f" - Debugging is enabled, listening on: {DEBUG_ADDR}:{DEBUG_PORT}")

ramses_cli/utils/convert.py

@@ -17,7 +17,7 @@ parser.add_argument("-i", "--input-file", type=argparse.FileType("r"), default="
 args = parser.parse_args()
 
 
-def convert_json_to_yaml(data: dict) -> str:
+def convert_json_to_yaml(data: dict) -> None:
     """Convert from json (client.py -C config.json) to yaml (HA configuration.yaml)."""
     (config, schema, include, exclude) = load_config("/dev/ttyMOCK", None, **data)
 
@@ -37,7 +37,7 @@ def convert_json_to_yaml(data: dict) -> str:
     print(yaml.dump({"ramses_cc": result}, sort_keys=False))
 
 
-def convert_yaml_to_json(data: dict) -> str:
+def convert_yaml_to_json(data: dict) -> None:
     """Convert from yaml (HA configuration.yaml) to json (client.py -C config.json)."""
 
     result = data["ramses_cc"]

ramses_rf/database.py

@@ -30,7 +30,7 @@ from collections import OrderedDict
 from datetime import datetime as dt, timedelta as td
 from typing import TYPE_CHECKING, Any, NewType
 
-from ramses_tx import CODES_SCHEMA, Code, Message
+from ramses_tx import CODES_SCHEMA, RQ, Code, Message, Packet
 
 if TYPE_CHECKING:
     DtmStrT = NewType("DtmStrT", str)
@@ -130,11 +130,15 @@ class MessageIndex:
     def stop(self) -> None:
         """Stop the housekeeper loop."""
 
-        if self._housekeeping_task and (not self._housekeeping_task.done()):
+        if (
+            self.maintain
+            and self._housekeeping_task
+            and (not self._housekeeping_task.done())
+        ):
             self._housekeeping_task.cancel()  # stop the housekeeper
 
         self._cx.commit()  # just in case
-        # self._cx.close()  # may still need to do queries after engine has stopped?
+        self._cx.close()  # may still need to do queries after engine has stopped?
 
     @property
     def msgs(self) -> MsgDdT:
@@ -151,7 +155,7 @@ class MessageIndex:
             - verb " I", "RQ" etc.
             - src  message origin address
             - dst  message destination address
-            - code packet code aka command class e.g. _0005, _31DA
+            - code packet code aka command class e.g. 0005, 31DA
             - ctx  message context, created from payload as index + extra markers (Heat)
             - hdr  packet header e.g. 000C|RP|01:223036|0208 (see: src/ramses_tx/frame.py)
             - plk the keys stored in the parsed payload, separated by the | char
@@ -183,7 +187,7 @@ class MessageIndex:
 
     async def _housekeeping_loop(self) -> None:
         """Periodically remove stale messages from the index,
-        unless `self.maintain` is False."""
+        unless `self.maintain` is False - as in (most) tests."""
 
         async def housekeeping(dt_now: dt, _cutoff: td = td(days=1)) -> None:
             """
@@ -191,9 +195,10 @@ class MessageIndex:
             :param dt_now: current timestamp
             :param _cutoff: the oldest timestamp to retain, default is 24 hours ago
             """
-            dtm = dt_now - _cutoff  # .isoformat(timespec="microseconds") < needed?
+            msgs = None
+            dtm = dt_now - _cutoff
 
-            self._cu.execute("SELECT dtm FROM messages WHERE dtm => ?", (dtm,))
+            self._cu.execute("SELECT dtm FROM messages WHERE dtm >= ?", (dtm,))
             rows = self._cu.fetchall()  # fetch dtm of current messages to retain
 
             try:  # make this operation atomic, i.e. update self._msgs only on success
@@ -208,6 +213,10 @@ class MessageIndex:
                 self._msgs = msgs
             finally:
                 self._lock.release()
+                if msgs:
+                    _LOGGER.debug(
+                        "MessageIndex size was: %d, now: %d", len(rows), len(msgs)
+                    )
 
         while True:
             self._last_housekeeping = dt.now()
@@ -242,13 +251,17 @@ class MessageIndex:
         else:
             # _msgs dict requires a timestamp reformat
             dtm: DtmStrT = msg.dtm.isoformat(timespec="microseconds")  # type: ignore[assignment]
+            # add msg to self._msgs dict
             self._msgs[dtm] = msg
 
         finally:
             pass  # self._lock.release()
 
         if (
-            dup and msg.src is not msg.dst and not msg.dst.id.startswith("18:")  # HGI
+            dup
+            and (msg.src is not msg.dst)
+            and not msg.dst.id.startswith("18:")  # HGI
+            and msg.verb != RQ  # these may come very quickly
         ):  # when src==dst, expect to add duplicate, don't warn
             _LOGGER.debug(
                 "Overwrote dtm (%s) for %s: %s (contrived log?)",
@@ -256,8 +269,6 @@ class MessageIndex:
                 msg._pkt._hdr,
                 dup[0]._pkt,
             )
-        if old is not None:
-            _LOGGER.debug("Old msg replaced: %s", old)
 
         return old
 
@@ -270,7 +281,8 @@ class MessageIndex:
         :param verb: two letter verb str to use
         """
         # Used by OtbGateway init, via entity_base.py
-        dtm: DtmStrT = dt.strftime(dt.now(), "%Y-%m-%dT%H:%M:%S")  # type: ignore[assignment]
+        _now: dt = dt.now()
+        dtm: DtmStrT = _now.isoformat(timespec="microseconds")  # type: ignore[assignment]
         hdr = f"{code}|{verb}|{src}|00"  # dummy record has no contents
 
         dup = self._delete_from(hdr=hdr)
@@ -283,7 +295,7 @@ class MessageIndex:
             self._cu.execute(
                 sql,
                 (
-                    dtm,
+                    _now,
                     verb,
                     src,
                     src,
@@ -295,6 +307,14 @@ class MessageIndex:
             )
         except sqlite3.Error:
             self._cx.rollback()
+        else:
+            # also add dummy 3220 msg to self._msgs dict to allow maintenance loop
+            msg: Message = Message._from_pkt(
+                Packet(
+                    _now, f"... {verb} --- {src} --:------ {src} {code} 005 0000000000"
+                )
+            )
+            self._msgs[dtm] = msg
 
         if dup:  # expected when more than one heat system in schema
             _LOGGER.debug("Replaced record with same hdr: %s", hdr)
@@ -355,7 +375,7 @@ class MessageIndex:
         if not bool(msg) ^ bool(kwargs):
             raise ValueError("Either a Message or kwargs should be provided, not both")
         if msg:
-            kwargs["dtm"] = msg.dtm  # .isoformat(timespec="microseconds")
+            kwargs["dtm"] = msg.dtm
 
         msgs = None
         try:  # make this operation atomic, i.e. update self._msgs only on success
@@ -406,7 +426,7 @@ class MessageIndex:
             raise ValueError("Either a Message or kwargs should be provided, not both")
 
         if msg:
-            kwargs["dtm"] = msg.dtm  # .isoformat(timespec="microseconds")
+            kwargs["dtm"] = msg.dtm
 
         return self._select_from(**kwargs)
 
@@ -428,10 +448,15 @@ class MessageIndex:
         :returns: a tuple of qualifying messages
         """
 
-        return tuple(
-            self._msgs[row[0].isoformat(timespec="microseconds")]
-            for row in self.qry_dtms(**kwargs)
-        )
+        # CHANGE: Use a list comprehension with a check to avoid KeyError
+        res: list[Message] = []
+        for row in self.qry_dtms(**kwargs):
+            ts: DtmStrT = row[0].isoformat(timespec="microseconds")
+            if ts in self._msgs:
+                res.append(self._msgs[ts])
+            else:
+                _LOGGER.debug("MessageIndex timestamp %s not in device messages", ts)
+        return tuple(res)
 
     def qry_dtms(self, **kwargs: bool | dt | str) -> list[Any]:
         """
@@ -483,6 +508,7 @@ class MessageIndex:
             # _msgs stamp format: 2022-09-08T13:40:52.447364
             if ts in self._msgs:
                 lst.append(self._msgs[ts])
+                # _LOGGER.debug("MessageIndex ts %s added to qry.lst", ts)  # too frequent
             else:  # happens in tests with artificial msg from heat
                 _LOGGER.info("MessageIndex timestamp %s not in device messages", ts)
         return tuple(lst)
@@ -546,8 +572,9 @@ class MessageIndex:
             if ts in self._msgs:
                 # if include_expired or not self._msgs[ts].HAS_EXPIRED:  # not working
                 lst.append(self._msgs[ts])
-            else:  # happens in tests with dummy msg from heat init
-                _LOGGER.info("MessageIndex ts %s not in device messages", ts)
+                _LOGGER.debug("MessageIndex ts %s added to all.lst", ts)
+            else:  # happens in tests and real evohome setups with dummy msg from heat init
+                _LOGGER.debug("MessageIndex ts %s not in device messages", ts)
         return tuple(lst)
 
     def clr(self) -> None:

ramses_rf/device/base.py

@@ -87,9 +87,10 @@ class DeviceBase(Entity):
         return self.id < other.id  # type: ignore[no-any-return]
 
     def _update_traits(self, **traits: Any) -> None:
-        """Update a device with new schema attrs.
+        """Update a device with new schema attributes.
 
-        Raise an exception if the new schema is not a superset of the existing schema.
+        :param traits: The traits to apply (e.g., alias, class, faked)
+        :raises TypeError: If the device is not fakeable but 'faked' is set.
         """
 
         traits = shrink(SCH_TRAITS(traits))
@@ -342,7 +343,17 @@ class Fakeable(DeviceBase):
         idx: IndexT = "00",
         require_ratify: bool = False,
     ) -> tuple[Packet, Packet, Packet, Packet | None]:
-        """Listen for a binding and return the Offer, or raise an exception."""
+        """Listen for a binding and return the Offer packets.
+
+        :param accept_codes: The codes allowed for this binding
+        :type accept_codes: Iterable[Code]
+        :param idx: The index to bind to, defaults to "00"
+        :type idx: IndexT
+        :param require_ratify: Whether a ratification step is required, defaults to False
+        :type require_ratify: bool
+        :return: A tuple of the four binding transaction packets
+        :rtype: tuple[Packet, Packet, Packet, Packet | None]
+        """
 
         if not self._bind_context:
             raise TypeError(f"{self}: Faking not enabled")

ramses_rf/device/heat.py

@@ -450,7 +450,7 @@ class UfhController(Parent, DeviceHeat):  # UFC (02):
                 #     )
                 #     self._send_cmd(cmd)
 
-        elif msg.code == Code._0008:  # relay_demand, TODO: use msgIndex DB?
+        elif msg.code == Code._0008:  # relay_demand
             if msg.payload.get(SZ_DOMAIN_ID) == FC:
                 self._relay_demand = msg
             else:  # FA
@@ -669,7 +669,7 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
 
         # TODO(eb): cleanup
         if self._gwy.msg_db:
-            self._add_record(address=self.addr, code=Code._3220, verb="RP")
+            self._add_record(id=self.id, 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:

ramses_rf/device/hvac.py

@@ -921,27 +921,30 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
 
         :return: string describing fan mode, speed
         """
-        if self._gwy.msg_db:
-            # Use SQLite query on MessageIndex. res_rate/res_mode not exposed yet
-            sql = f"""
-                SELECT code from messages WHERE verb in (' I', 'RP')
-                AND (src = ? OR dst = ?)
-                AND (plk LIKE '%{SZ_FAN_MODE}%')
-            """
-            res_mode: list = self._msg_qry(sql)
-            # SQLite query on MessageIndex
-            _LOGGER.debug(f"{res_mode} # FAN_MODE FETCHED from MessageIndex")
-
-            sql = f"""
-                SELECT code from messages WHERE verb in (' I', 'RP')
-                AND (src = ? OR dst = ?)
-                AND (plk LIKE '%{SZ_FAN_RATE}%')
-            """
-            res_rate: list = self._msg_qry(sql)
-            # SQLite query on MessageIndex
-            _LOGGER.debug(
-                f"{res_rate} # FAN_RATE FETCHED from MessageIndex"
-            )  # DEBUG always empty?
+        # if self._gwy.msg_db:
+        # Use SQLite query on MessageIndex. res_rate/res_mode not exposed yet
+        # working fine in 0.52.4, no need to specify code, only payload key
+        # sql = f"""
+        #     SELECT code from messages WHERE verb in (' I', 'RP')
+        #     AND (src = ? OR dst = ?)
+        #     AND (plk LIKE '%{SZ_FAN_MODE}%')
+        # """
+        # res_mode: list = self._msg_qry(sql)
+        # # SQLite query on MessageIndex
+        # _LOGGER.debug(
+        #     f"# Fetched FAN_MODE for {self.id} from MessageIndex: {res_mode}"
+        # )
+
+        # sql = f"""
+        #     SELECT code from messages WHERE verb in (' I', 'RP')
+        #     AND (src = ? OR dst = ?)
+        #     AND (plk LIKE '%{SZ_FAN_RATE}%')
+        # """
+        # res_rate: list = self._msg_qry(sql)
+        # # SQLite query on MessageIndex
+        # _LOGGER.debug(
+        #     f"# Fetched FAN_RATE for {self.id} from MessageIndex: {res_rate}"
+        # )
 
         if Code._31D9 in self._msgs:
             # was a dict by Code

ramses_rf/entity_base.py

@@ -15,7 +15,7 @@ from types import ModuleType
 from typing import TYPE_CHECKING, Any, Final
 
 from ramses_rf.helpers import schedule_task
-from ramses_tx import Address, Priority, QosParams
+from ramses_tx import Priority, QosParams
 from ramses_tx.address import ALL_DEVICE_ID
 from ramses_tx.const import MsgId
 from ramses_tx.opentherm import OPENTHERM_MESSAGES
@@ -224,7 +224,10 @@ class _MessageDB(_Entity):
 
         # As of 0.52.1 we use SQLite MessageIndex, see ramses_rf/database.py
         # _msgz_ (nested) was only used in this module. Note:
-        # _msgz (now rebuilt from _msgs) also used in: client, base, device.heat
+        # _msgz (now rebuilt from _msgs) is also used in:
+        #   - client.py: for code in device._msgz.values()
+        #   - base.py: Code._1060 in self._msgz
+        #   [x] device.heat (no longer used)
 
     def _handle_msg(self, msg: Message) -> None:
         """Store a msg in the DBs.
@@ -244,14 +247,14 @@ class _MessageDB(_Entity):
 
         if self._gwy.msg_db:  # central SQLite MessageIndex
             _LOGGER.debug(
-                "For %s (z_id %s) add msg %s, src %s, dst %s to msg_db.",
+                "For %s (_z_id %s) add to msg_db: %s, src %s, dst %s",
                 self.id,
                 self._z_id,
                 msg,
                 msg.src,
                 msg.dst,
             )
-            debug_code: Code = Code._3150
+            debug_code: Code = Code._3150  # for debugging only log these, pick your own
             if msg.code == debug_code and msg.src.id.startswith("01:"):
                 _LOGGER.debug(
                     "Added msg from %s with code %s to _gwy.msg_db. hdr=%s",
@@ -293,6 +296,7 @@ class _MessageDB(_Entity):
     def _msg_list(self) -> list[Message]:
         """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
+        # TODO remove _msg_list Q1 2026
         if self._gwy.msg_db:
             msg_list_qry: list[Message] = []
             code_list = self._msg_dev_qry()
@@ -303,24 +307,29 @@ class _MessageDB(_Entity):
                         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)
+                        # _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)",
+                            "_msg_list could not fetch self._msgs[%s] for %s (_z_id %s)",
                             c,
                             self.id,
                             self._z_id,
                         )
             return msg_list_qry
         # else create from legacy nested dict
-        return [m for c in self._msgz.values() for v in c.values() for m in v.values()]
+        return [
+            msg
+            for code in self._msgz.values()
+            for ctx in code.values()
+            for msg in ctx.values()
+        ]
 
     def _add_record(
-        self, address: Address, code: Code | None = None, verb: str = " I"
+        self, id: DeviceIdT, code: Code | None = None, verb: str = " I"
     ) -> None:
         """Add a (dummy) record to the central SQLite MessageIndex."""
         # used by heat.py init
         if self._gwy.msg_db:
-            self._gwy.msg_db.add_record(str(address), code=str(code), verb=verb)
+            self._gwy.msg_db.add_record(id, code=str(code), verb=verb)
         # else:
         #     _LOGGER.warning("Missing MessageIndex")
         # raise NotImplementedError
@@ -424,7 +433,7 @@ class _MessageDB(_Entity):
         **kwargs: Any,
     ) -> dict | list | None:
         """
-        Query the message dict or the SQLite index for the most recent
+        Query the _msgz message dict or the SQLite MessageIndex for the most recent
         key: value pairs(s) for a given code.
 
         :param code: filter messages by Code or a tuple of Codes, optional
@@ -517,7 +526,7 @@ class _MessageDB(_Entity):
             or (idx == SZ_DOMAIN_ID)
         ), (
             f"full dict:{msg_dict}, payload:{msg.payload} < Coding error: key='{idx}', val='{val}'"
-        )  # should not be there (TODO(eb): BUG but occurs when using SQLite MessageIndex)
+        )  # should not be there
 
         if (
             key == "*" or not key
@@ -535,21 +544,35 @@ class _MessageDB(_Entity):
         """
         Retrieve from the MessageIndex a list of Code keys involving this device.
 
-        :return: list of Codes or empty list when query returned empty
+        :return: list of Codes or an empty list when the query returned empty
         """
 
         if self._gwy.msg_db:
             # SQLite query on MessageIndex
             res: list[Code] = []
-            if self.id[_ID_SLICE:] == "_HW":
+
+            if len(self.id) == 9:
+                # fetch a ctl's message codes (add all its children?)
+                sql = """
+                    SELECT code from messages WHERE
+                    verb in (' I', 'RP')
+                    AND (src = ? OR dst = ?)
+                    AND ctx LIKE ?
+                """
+                _ctx_qry = "%"
+
+            elif self.id[_ID_SLICE:] == "_HW":
+                # fetch a DHW entity's message codes
                 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 ?
+                _ctx_qry = "%dhw_idx%"
+
             else:
+                # fetch a zone's message codes
                 sql = """
                     SELECT code from messages WHERE
                     verb in (' I', 'RP')
@@ -562,12 +585,12 @@ class _MessageDB(_Entity):
                 sql, (self.id[:_ID_SLICE], self.id[:_ID_SLICE], _ctx_qry)
             ):
                 _LOGGER.debug(
-                    "Fetched from index: %s for %s (z_id %s)",
+                    "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)"
+                # Example: "Fetched from index: code 1FD4 for 01:123456 (_z_id 01)"
                 res.append(Code(str(rec[0])))
             return res
         else:
@@ -743,7 +766,18 @@ class _MessageDB(_Entity):
         # for r in results:
         #     print(r)
 
-        if self.id[_ID_SLICE:] == "_HW":
+        if len(self.id) == 9:
+            # fetch a ctl's message dtms (add all its children?)
+            sql = """
+                SELECT dtm from messages WHERE
+                verb in (' I', 'RP')
+                AND (src = ? OR dst = ?)
+                AND ctx LIKE ?
+            """
+            _ctx_qry = "%"
+
+        elif self.id[_ID_SLICE:] == "_HW":
+            # fetch a DHW entity's message dtms
             sql = """
                 SELECT dtm from messages WHERE
                 verb in (' I', 'RP')
@@ -753,6 +787,7 @@ class _MessageDB(_Entity):
             _ctx_qry = "%dhw_idx%"
             # TODO add Children messages? self.ctl.dhw
         else:
+            # fetch a zone's message dtms
             sql = """
                 SELECT dtm from messages WHERE
                 verb in (' I', 'RP')
@@ -769,14 +804,14 @@ class _MessageDB(_Entity):
         }
         # if CTL, remove 3150, 3220 heat_demand, both are only stored on children
         # HACK
-        if self.id[:3] == "01:" and self._SLUG == "CTL":
-            # with next ON: 2 errors , both 1x UFC, 1x CTR
-            # with next OFF: 4 errors, all CTR
-            # if Code._3150 in _msg_dict:  # Note: CTL can send a 3150 (see heat_ufc_00)
-            #     _msg_dict.pop(Code._3150)  # keep, prefer to have 2 extra instead of missing 1
-            if Code._3220 in _msg_dict:
-                _msg_dict.pop(Code._3220)
-            # _LOGGER.debug(f"Removed 3150/3220 from %s._msgs dict", self.id)
+        # if self.id[:3] == "01:" and self._SLUG == "CTL":
+        # with next ON: 2 errors , both 1x UFC, 1x CTR
+        # with next OFF: 4 errors, all CTR
+        # if Code._3150 in _msg_dict:  # Note: CTL can send a 3150 (see heat_ufc_00)
+        #     _msg_dict.pop(Code._3150)  # keep, prefer to have 2 extra instead of missing 1
+        # if Code._3220 in _msg_dict:
+        #     _msg_dict.pop(Code._3220)
+        # _LOGGER.debug(f"Removed 3150/3220 from %s._msgs dict", self.id)
         return _msg_dict
 
     @property
@@ -862,7 +897,6 @@ class _Discovery(_MessageDB):
         #     return f"{data_id:02X}"  # type: ignore[return-value]
 
         res: list[str] = []
-        # look for the "sim" OT 3220 record initially added in OtbGateway.init
         if self._gwy.msg_db:
             # SQLite query for ctx field on MessageIndex
             sql = """
@@ -995,18 +1029,24 @@ class _Discovery(_MessageDB):
                         sql = """
                             SELECT dtm from messages WHERE
                             code = ?
-                            verb = ' I'
+                            AND verb in (' I', 'RP')
                             AND ctx = 'True'
                             AND (src = ? OR dst = ?)
                         """
-                        msgs += self._gwy.msg_db.qry(
+                        res = self._gwy.msg_db.qry(
                             sql,
                             (
                                 task[_SZ_COMMAND].code,
                                 self.tcs.id[:_ID_SLICE],
                                 self.tcs.id[:_ID_SLICE],
                             ),
-                        )[0]  # expect 1 Message in returned tuple
+                        )
+                        if len(res) > 0:
+                            msgs += res[0]  # expect 1 Message in returned tuple
+                        else:
+                            _LOGGER.debug(
+                                f"No msg found for hdr {hdr}, task code {task[_SZ_COMMAND].code}"
+                            )
                     else:  # TODO(eb) remove next Q1 2026
                         msgs += [self.tcs._msgz[task[_SZ_COMMAND].code][I_][True]]
                         # raise NotImplementedError
@@ -1145,6 +1185,7 @@ class Parent(Entity):  # A System, Zone, DhwZone or a UfhController
     (incl. the DHW Zone), and also any UFH controllers.
 
     For a heating Zone, children are limited to a sensor, and a number of actuators.
+
     For the DHW Zone, the children are limited to a sensor, a DHW valve, and/or a
     heating valve.
 

ramses_rf/gateway.py

@@ -258,14 +258,6 @@ class Gateway(Engine):
             #     return True
             return include_expired or not msg._expired
 
-        msgs = [m for device in self.devices for m in device._msg_list]
-
-        for system in self.systems:
-            msgs.extend(list(system._msgs.values()))
-            msgs.extend([m for z in system.zones for m in z._msgs.values()])
-            # msgs.extend([m for z in system.dhw for m in z._msgs.values()])  # TODO: DHW
-            # Related to/Fixes ramses_cc Issue 249 non-existing via-device _HW ?
-
         if self.msg_db:
             pkts = {
                 f"{repr(msg._pkt)[:26]}": f"{repr(msg._pkt)[27:]}"
@@ -273,12 +265,20 @@ class Gateway(Engine):
                 if wanted_msg(msg, include_expired=include_expired)
             }
         else:  # deprecated, to be removed in Q1 2026
-            # _LOGGER.warning("Missing MessageIndex")
+            msgs = [m for device in self.devices for m in device._msg_list]
+            # add systems._msgs and zones._msgs
+            for system in self.systems:
+                msgs.extend(list(system._msgs.values()))
+                msgs.extend([m for z in system.zones for m in z._msgs.values()])
+                # msgs.extend([m for z in system.dhw for m in z._msgs.values()])  # TODO: DHW
+                # Related to/Fixes ramses_cc Issue 249 non-existing via-device _HW ?
+
             pkts = {  # BUG: assumes pkts have unique dtms: may be untrue for contrived logs
                 f"{repr(msg._pkt)[:26]}": f"{repr(msg._pkt)[27:]}"
                 for msg in msgs
                 if wanted_msg(msg, include_expired=include_expired)
             }
+            # _LOGGER.warning("Missing MessageIndex")
 
         self._resume()
 
@@ -360,13 +360,25 @@ class Gateway(Engine):
         child_id: str | None = None,
         is_sensor: bool | None = None,
     ) -> Device:  # TODO: **schema/traits) -> Device:  # may: LookupError
-        """Return a device, create it if required.
-
-        First, use the traits to create/update it, then pass it any msg to handle.
-        All devices have traits, but only controllers (CTL, UFC) have a schema.
-
-        Devices are uniquely identified by a device id.
-        If a device is created, attach it to the gateway.
+        """Return a device, creating it if it does not already exist.
+
+        This method uses provided traits to create or update a device and optionally
+        passes a message for it to handle. All devices have traits, but only
+        controllers (CTL, UFC) have a schema.
+
+        :param device_id: The unique identifier for the device (e.g., '01:123456')
+        :type device_id: DeviceIdT
+        :param msg: An optional initial message for the device to process, defaults to None
+        :type msg: Message | None
+        :param parent: The parent entity of this device, if any, defaults to None
+        :type parent: Parent | None
+        :param child_id: The specific ID of the child component if applicable, defaults to None
+        :type child_id: str | None
+        :param is_sensor: Indicates if this device should be treated as a sensor, defaults to None
+        :type is_sensor: bool | None
+        :return: The existing or newly created device instance
+        :rtype: Device
+        :raises LookupError: If the device ID is blocked or not in the allowed known_list.
         """
 
         def check_filter_lists(dev_id: DeviceIdT) -> None:  # may: LookupError
@@ -620,9 +632,8 @@ class Gateway(Engine):
         If wait_for_reply is True (*and* the Command has a rx_header), return the
         reply Packet. Otherwise, simply return the echo Packet.
 
-        If the expected Packet can't be returned, raise:
-            ProtocolSendFailed: tried to Tx Command, but didn't get echo/reply
-            ProtocolError:      didn't attempt to Tx Command for some reason
+        :raises ProtocolSendFailed: If the command was sent but no reply/echo was received.
+        :raises ProtocolError: If the system failed to attempt the transmission.
         """
 
         return await super().async_send_cmd(

ramses_rf/schemas.py

@@ -285,7 +285,7 @@ SCH_GLOBAL_CONFIG = (
 #
 # 6/7: External Schemas, to be used by clients of this library
 def NormaliseRestoreCache() -> Callable[[bool | dict[str, bool]], dict[str, bool]]:
-    """Convert a short-hand restore_cache bool to a dict.
+    """Convert a shorthand restore_cache bool to a dict.
 
     restore_cache: bool ->  restore_cache:
                               restore_schema: bool