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

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"
@@ -172,7 +171,31 @@ class _Entity:
 
 
 class _MessageDB(_Entity):
-    """Maintain/utilize an entity's state database."""
+    """Maintain/utilize an entity's state database.
+
+        EntityBase msg_db query methods
+
+        (ix = database.py.MessageIndex method)
+
+    .. table:: Database Query Methods
+       :widths: auto
+
+       ====  ======================  ====================  ============  ==========  ==========
+        e.   method name             args                  returns       uses        used by
+       ====  ======================  ====================  ============  ==========  ==========
+       e1    _get_msg_by_hdr         hdr                   Message       i3          discover
+       e2    _msg_value              code(s), Msg, args    dict[k,v]     e3,e4
+       e3    _msg_value_code         code, verb, key       dict[k,v]     e4,e5,e6    e6
+       e4    _msg_value_msg          Msg, (code)           dict[k,v]                 e2,e3
+       e5    _msg_qry_by_code_key    code, key, (verb=)                              e6,
+       e6    _msg_value_qry_by_code  key   code, key       str/float     e3,e5
+       e7    _msg_qry                sql                                             e8
+       e8    _msg_count              sql                                 e7
+       e9    supported_cmds                                list(Codes)   i7
+       e10   _msgs()                                                     i5
+       ====  ======================  ====================  ============  ==========  ==========
+
+    """
 
     _gwy: Gateway
     ctl: Controller
@@ -220,7 +243,14 @@ class _MessageDB(_Entity):
             return  # don't store the rest
 
         if self._gwy.msg_db:  # central SQLite MessageIndex
-            self._gwy.msg_db.add(msg)
+            _LOGGER.debug(
+                "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,
+            )
             debug_code: Code = Code._3150
             if msg.code == debug_code and msg.src.id.startswith("01:"):
                 _LOGGER.debug(
@@ -234,6 +264,7 @@ class _MessageDB(_Entity):
                 # msg.src = 01:073976 (CTL)
                 # Added msg from 01:073976 (CTL) with code 0005 to _gwy.msg_db
                 # query is for: 01:073976  < no suffix, extended lookup to [:12] chars
+            self._gwy.msg_db.add(msg)
 
             # ignore any replaced message that might be returned
         else:  # TODO(eb): remove Q1 2026
@@ -260,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] = []
@@ -271,7 +302,14 @@ class _MessageDB(_Entity):
                         # safeguard against lookup failures ("sim" packets?)
                         msg_list_qry.append(self._msgs[c])
                     else:
-                        _LOGGER.debug("Could not fetch self._msgs[%s]", c)
+                        # 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,
+                            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()]
@@ -316,32 +354,7 @@ class _MessageDB(_Entity):
                 with contextlib.suppress(KeyError):
                     del obj._msgz_[msg.code][msg.verb][msg._pkt._ctx]
 
-    # EntityBase msg_db query methods > copy to docs/source/ramses_rf.rst
-    # (ix = database.py.MessageIndex method)
-    #
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e. |method name           | args               | returns    | uses     | used by  |
-    # +====+======================+====================+============+==========+==========+
-    # | e1 | _get_msg_by_hdr      | hdr                | Message    | i3       | discover |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e2 | _msg_value           | code(s), Msg, args | dict[k,v]  | e3,e4    |          |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e3 | _msg_value_code      | code, verb, key    | dict[k,v]  | e4,e5,e6 | e6       |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e4 | _msg_value_msg       | Msg, (code)        | dict[k,v]  |          | e2,e3    |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e5 | _msg_qry_by_code_key | code, key, (verb=) |            |          | e6,      |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e6 | _msg_value_qry_by_code_key | code, key    | str/float  | e3,e5    |          |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e7 | _msg_qry             | sql                |            |          | e8       |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e8 | _msg_count           | sql                |            | e7       |          |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e9 | supported_cmds       |                    | list(Codes)| i7       |          |
-    # +----+----------------------+--------------------+------------+----------+----------+
-    # | e10| _msgs()              |                    |            | i5       |          |
-    # +----+----------------------+--------------------+------------+----------+----------+
+    ### entity_base query methods
 
     def _get_msg_by_hdr(self, hdr: HeaderT) -> Message | None:
         """Return a msg, if any, that matches a given header."""
@@ -417,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, (
@@ -433,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]
@@ -445,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)
@@ -520,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:
@@ -549,40 +584,58 @@ class _MessageDB(_Entity):
         Retrieve from the MessageIndex the most current Code for a code(s) &
         keyword combination involving this device.
 
-        :param code: (optional) a message Code to use, e.g. 31DA or a tuple of Codes
+        :param code: (optional) a message Code to use, e.g. Code._31DA or a tuple of Codes
         :param key: (optional) message keyword to fetch, e.g. SZ_HUMIDITY
         :param kwargs: optional verb='vb' single verb
         :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("Fetched from index: %s", rec)
+                _LOGGER.debug(
+                    "_msg_qry_by_code_key fetched rec: %s, code: %s", rec, code_qry
+                )
                 assert isinstance(rec[0], dt)  # mypy hint
                 if rec[0] > latest:  # dtm, only use most recent
                     res = Code(rec[1])
@@ -641,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)
@@ -681,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
@@ -773,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)
@@ -805,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])
@@ -936,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/gateway.py

@@ -213,7 +213,7 @@ class Gateway(Engine):
     def _pause(self, *args: Any) -> None:
         """Pause the (unpaused) gateway (disables sending/discovery).
 
-        There is the option to save other objects, as *args.
+        There is the option to save other objects, as `args`.
         """
         _LOGGER.debug("Gateway: Pausing engine...")
 
@@ -228,7 +228,7 @@ class Gateway(Engine):
     def _resume(self) -> tuple[Any]:
         """Resume the (paused) gateway (enables sending/discovery, if applicable).
 
-        Will restore other objects, as *args.
+        Will restore other objects, as `args`.
         """
         args: tuple[Any]
 

ramses_rf/schemas.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 """RAMSES RF - a RAMSES-II protocol decoder & analyser.
 
-Schema processor for upper layer.
+:term:`Schema` processor for upper layer.
 """
 
 from __future__ import annotations

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/version.py

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

{ramses_rf-0.52.1.dist-info → ramses_rf-0.52.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.52.1
+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.1.dist-info → ramses_rf-0.52.3.dist-info}/RECORD

@@ -4,52 +4,52 @@ ramses_cli/debug.py,sha256=vgR0lOHoYjWarN948dI617WZZGNuqHbeq6Tc16Da7b4,608
 ramses_cli/discovery.py,sha256=MWoahBnAAVzfK2S7EDLsY2WYqN_ZK9L-lktrj8_4cb0,12978
 ramses_cli/utils/cat_slow.py,sha256=AhUpM5gnegCitNKU-JGHn-DrRzSi-49ZR1Qw6lxe_t8,607
 ramses_cli/utils/convert.py,sha256=D_YiCyX5na9pgC-_NhBlW9N1dgRKUK-uLtLBfofjzZM,1804
-ramses_rf/__init__.py,sha256=VG3E9GHbtC6lx6E1DMQJeFitHnydMKJyPxQBethdrzg,1193
-ramses_rf/binding_fsm.py,sha256=uZAOl3i19KCXqqlaLJWkEqMMP7NJBhVPW3xTikQD1fY,25996
+ramses_rf/__init__.py,sha256=vp2TyFGqc1fGQHsevhmaw0QEmSSCnZx7fqizKiEwHtw,1245
+ramses_rf/binding_fsm.py,sha256=fuqvcc9YW-wr8SPH8zadpPqrHAvzl_eeWF-IBtlLppY,26632
 ramses_rf/const.py,sha256=L3z31CZ-xqno6oZp_h-67CB_5tDDqTwSWXsqRtsjMcs,5460
-ramses_rf/database.py,sha256=aQntZW-ARiJ8GFVeT5T4LLWMeshs_lw_tnNet_S146U,20785
-ramses_rf/dispatcher.py,sha256=UqilAoL6T85ZFPkcpvcfuidNbusONngQoCVWHV6vOzk,11277
-ramses_rf/entity_base.py,sha256=T3NCo41l6KDqip6ptLdYn2b7pmGit37NgAHoBvhT42s,56063
+ramses_rf/database.py,sha256=rMfEJvapc3Zh6SFqjPjntuuaYynuZiAdYTw1pcXsJPE,20344
+ramses_rf/dispatcher.py,sha256=YjEU-QrBLo9IfoEhJo2ikg_FxOaMYoWvzelr9Vi-JZ8,11398
+ramses_rf/entity_base.py,sha256=uN8QGGv0cutCYTT-oyDkvzv4xpBEObWF4jo9ArtvbLE,57640
 ramses_rf/exceptions.py,sha256=mt_T7irqHSDKir6KLaf6oDglUIdrw0S40JbOrWJk5jc,3657
-ramses_rf/gateway.py,sha256=AEgVKoW1I3D8zYIkQfMnC6CN3TV1gxamfIaXRQ2IUSk,21216
+ramses_rf/gateway.py,sha256=VYZqMppU_kDYhT3EUmqpHf0LuLXPMH7ASx9jylAopWE,21218
 ramses_rf/helpers.py,sha256=TNk_QkpIOB3alOp1sqnA9LOzi4fuDCeapNlW3zTzNas,4250
 ramses_rf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ramses_rf/schemas.py,sha256=UhvRhV4nZ3kvrLLM3wwIguQUIjIgd_AKvp2wkTSpNEA,13468
-ramses_rf/version.py,sha256=X_vGsHP_Eb6ovijJi7zzwEWH5kud2r0V1sImKWLqKv4,125
+ramses_rf/schemas.py,sha256=jvpx0hZiMhaogyxbxnrbxS7m2GekKK4DFfVTNs7h-WQ,13476
+ramses_rf/version.py,sha256=E3rkZTOmbKgrnpOmzEdweYaquvnmc18LcdiXXdsnakM,125
 ramses_rf/device/__init__.py,sha256=sUbH5dhbYFXSoM_TPFRutpRutBRpup7_cQ9smPtDTy8,4858
 ramses_rf/device/base.py,sha256=Yx0LZwMEb49naY8FolZ8HEBFb6XCPQBTVN_TWyO2nKg,17777
-ramses_rf/device/heat.py,sha256=UmZuA-5czrfoClVEeUAPWgze5obWNQpYI7ZPQpVJB6s,54704
-ramses_rf/device/hvac.py,sha256=0iQt9yFXgapaaiLWimGYF1Mh2c_TR58JyaYvWU1nSdE,45605
+ramses_rf/device/heat.py,sha256=tjORTbjxBKFzgPQbfpLuj74IlrVtOmj9GpzslK9j0A0,54569
+ramses_rf/device/hvac.py,sha256=gdpVACUvtq6ERMI0mwRhqIJtKYEmybzJA2NeyN1ELrs,48431
 ramses_rf/system/__init__.py,sha256=uZLKio3gLlBzePa2aDQ1nxkcp1YXOGrn6iHTG8LiNIw,711
 ramses_rf/system/faultlog.py,sha256=GdGmVGT3137KsTlV_nhccgIFEmYu6DFsLTn4S-8JSok,12799
 ramses_rf/system/heat.py,sha256=3jaFEChU-HlWCRMY1y7u09s7AH4hT0pC63hnqwdmZOc,39223
 ramses_rf/system/schedule.py,sha256=Ts6tdZPTQLV5NkgwA73tPa5QUsnZNIIuYoKC-8VsXDk,18808
-ramses_rf/system/zones.py,sha256=9AH7ooN5QfiqvWuor2P1Dn8aILjQb2RWL9rWqDH1IjA,36075
-ramses_tx/__init__.py,sha256=qNMTe8hBkIuecvtCiekUB0pKdD8atb0SjWxVNVe3yhE,3538
+ramses_rf/system/zones.py,sha256=YN_HAbeaa2YioUOjafEpp-0IHmIwmKNSK_77pPcjtns,36072
+ramses_tx/__init__.py,sha256=sqnjM7pUGJDmec6igTtKViSB8FLX49B5gwhAmcY9ERY,3596
 ramses_tx/address.py,sha256=F5ZE-EbPNNom1fW9XXUILvD7DYSMBxNJvsHVliT5gjw,8452
-ramses_tx/command.py,sha256=r9dNaofjjOQXZSUrZjsNpvEukNn4rSGy0OLr2Dyd2TI,125129
+ramses_tx/command.py,sha256=tqVECwd_QokEcRv2MSk7TUU4JSBzCZcJh1eQ0jIGgoY,125122
 ramses_tx/const.py,sha256=pnxq5upXvLUizv9Ye_I1llD9rAa3wddHgsSkc91AIUc,30300
 ramses_tx/exceptions.py,sha256=FJSU9YkvpKjs3yeTqUJX1o3TPFSe_B01gRGIh9b3PNc,2632
 ramses_tx/fingerprints.py,sha256=nfftA1E62HQnb-eLt2EqjEi_la0DAoT0wt-PtTMie0s,11974
 ramses_tx/frame.py,sha256=GzNsXr15YLeidJYGtk_xPqsZQh4ehDDlUCtT6rTDhT8,22046
-ramses_tx/gateway.py,sha256=8o9NyEAyIui3B6HA0R8o64u4U8NZFlNl0TQ6rhwMoCk,11369
+ramses_tx/gateway.py,sha256=Fl6EqAUU2DnLOiA2_87sS7VPBEyxA1a_ICCmg55WMMA,11494
 ramses_tx/helpers.py,sha256=J4OCRckp3JshGQTvvqEskFjB1hPS7uA_opVsuIqmZds,32915
-ramses_tx/logger.py,sha256=qYbUoNPnPaFWKVsYvLG6uTVuPTdZ8HsMzBbGx0DpBqc,10177
+ramses_tx/logger.py,sha256=1iKRHKUaqHqGd76CkE_6mCVR0sYODtxshRRwfY61fTk,10426
 ramses_tx/message.py,sha256=-moQ8v3HVlNSl-x3U0DDfDcj8WQ7vLqclMNxsohbmnw,13449
 ramses_tx/opentherm.py,sha256=58PXz9l5x8Ou6Fm3y-R_UnGHCYahoi2RKIDdYStUMzk,42378
 ramses_tx/packet.py,sha256=_qHiPFWpQpKueZOgf1jJ93Y09iZjo3LZWStLglVkXg4,7370
-ramses_tx/parsers.py,sha256=e6IwVEMLv2EL8gbZaM2s-qA3E2AN8dCwdIgfEbFo730,111029
+ramses_tx/parsers.py,sha256=Z0ochrNyO2l8SAP0oJxN-tx2nJluEaNP_uJCIm_lsA8,111279
 ramses_tx/protocol.py,sha256=9R3aCzuiWEyXmugmB5tyR_RhBlgfnpUXj7AsMP9BzzU,28867
 ramses_tx/protocol_fsm.py,sha256=ZKtehCr_4TaDdfdlfidFLJaOVTYtaEq5h4tLqNIhb9s,26827
 ramses_tx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramses_tx/ramses.py,sha256=NG81GBNZlap-Gi9ac-r6OFE-KaHvXsgPDWy-I2Irr-4,53698
-ramses_tx/schemas.py,sha256=IYCDH0jp3446Gtl_378aBmWyXN90e-uYudfkZkOKR24,13147
-ramses_tx/transport.py,sha256=bGprlfuuwBgQ1bmBRSrcicuk7s-jVqyuKpZCfQ-sSpw,58469
+ramses_tx/schemas.py,sha256=bqKW_V0bR6VbBD8ZQiBExNtVdXs0fryVKe3GEhupgIo,13424
+ramses_tx/transport.py,sha256=oVClKNnCfHioIk5tF0TGmYspJhpggQ6EspOYeyBBR4g,58841
 ramses_tx/typed_dicts.py,sha256=w-0V5t2Q3GiNUOrRAWiW9GtSwbta_7luME6GfIb1zhI,10869
 ramses_tx/typing.py,sha256=eF2SlPWhNhEFQj6WX2AhTXiyRQVXYnFutiepllYl2rI,5042
-ramses_tx/version.py,sha256=Wf50ZhDvYDcZoyYmD6Yu8apfRhpvbfMyTBj_GYjoYbw,123
-ramses_rf-0.52.1.dist-info/METADATA,sha256=7mrN8yPSMpAdK4-lYvWCmhKyRLrJgr2WQE4px21H7t0,4000
-ramses_rf-0.52.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramses_rf-0.52.1.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
-ramses_rf-0.52.1.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
-ramses_rf-0.52.1.dist-info/RECORD,,
+ramses_tx/version.py,sha256=OmZAmWYXnodOMX2FqbBZjLsKSaBVpA4Y37368OIox1o,123
+ramses_rf-0.52.3.dist-info/METADATA,sha256=u8gl35WcjLN5rO1P_BTfchK23MayeJLDQxFEhHOM-v4,4000
+ramses_rf-0.52.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ramses_rf-0.52.3.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
+ramses_rf-0.52.3.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
+ramses_rf-0.52.3.dist-info/RECORD,,

ramses_tx/__init__.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
-"""RAMSES RF - a RAMSES-II protocol decoder & analyser."""
+"""RAMSES RF - a RAMSES-II protocol decoder & analyser.
+`ramses_tx` takes care of the RF protocol (lower) layer.
+"""
 
 from __future__ import annotations
 

ramses_tx/command.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
-"""RAMSES RF - a RAMSES-II protocol decoder & analyser.
+"""
+RAMSES RF - a RAMSES-II protocol decoder & analyser.
 
 This module provides the `Command` class for constructing and managing RAMSES-II protocol
 commands (packets) that are to be sent to HVAC devices. It includes methods for creating
@@ -1394,7 +1395,7 @@ class Command(Frame):
 
         :param ctl_id: The device ID of the DHW controller
         :type ctl_id: DeviceIdT | str
-        :param **kwargs: Additional parameters (currently only 'dhw_idx' is supported)
+        :param kwargs: Additional parameters (currently only 'dhw_idx' is supported)
         :key dhw_idx: The DHW circuit index (0 or 1, defaults to 0 for single-DHW systems)
         :type dhw_idx: int, optional
         :return: A Command object for the RQ|1F41 message
@@ -1438,7 +1439,7 @@ class Command(Frame):
         :type until: datetime | str | None
         :param duration: Duration in seconds for temporary mode (alternative to 'until')
         :type duration: int | None
-        :param **kwargs: Additional parameters (currently only 'dhw_idx' is supported)
+        :param kwargs: Additional parameters (currently only 'dhw_idx' is supported)
         :key dhw_idx: The DHW circuit index (0 or 1, defaults to 0 for single-DHW systems)
         :type dhw_idx: int, optional
         :return: A Command object for the W|1F41 message
@@ -1501,7 +1502,7 @@ class Command(Frame):
         :type codes: Code | Iterable[Code] | None
         :param dst_id: Optional destination device ID (defaults to broadcast)
         :type dst_id: DeviceIdT | str | None
-        :param **kwargs: Additional parameters
+        :param kwargs: Additional parameters
         :key oem_code: OEM code for bind offers (only used with I-type messages)
         :type oem_code: str, optional
         :return: A Command object for the bind operation
@@ -2531,7 +2532,7 @@ class Command(Frame):
         :type supply_flow: float | None
         :param exhaust_flow: Current exhaust air flow rate (if available)
         :type exhaust_flow: float | None
-        :param **kwargs: Additional parameters (reserved for future use)
+        :param kwargs: Additional parameters (reserved for future use)
         :return: A configured Command object for the HVAC fan status update
         :rtype: Command
 

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_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)