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

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/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/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/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/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.2"
+__version__ = "0.52.3"
 VERSION = __version__

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

@@ -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.2.dist-info → ramses_rf-0.52.3.dist-info}/RECORD

@@ -5,26 +5,26 @@ 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=vp2TyFGqc1fGQHsevhmaw0QEmSSCnZx7fqizKiEwHtw,1245
-ramses_rf/binding_fsm.py,sha256=uZAOl3i19KCXqqlaLJWkEqMMP7NJBhVPW3xTikQD1fY,25996
+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=pfCOt6wvABAaW275mNLoRnObFSQ9nT5d7PtDLMTvgr4,20340
+ramses_rf/database.py,sha256=rMfEJvapc3Zh6SFqjPjntuuaYynuZiAdYTw1pcXsJPE,20344
 ramses_rf/dispatcher.py,sha256=YjEU-QrBLo9IfoEhJo2ikg_FxOaMYoWvzelr9Vi-JZ8,11398
-ramses_rf/entity_base.py,sha256=OPdQEeJ5zk49FKCFmRui4urFQVR2tLBS1iWCTWeZkNo,55712
+ramses_rf/entity_base.py,sha256=uN8QGGv0cutCYTT-oyDkvzv4xpBEObWF4jo9ArtvbLE,57640
 ramses_rf/exceptions.py,sha256=mt_T7irqHSDKir6KLaf6oDglUIdrw0S40JbOrWJk5jc,3657
 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=jvpx0hZiMhaogyxbxnrbxS7m2GekKK4DFfVTNs7h-WQ,13476
-ramses_rf/version.py,sha256=3xbuWkwVUOezgu-nlN98fGrnAgqtfivOcMVKjCTSBds,125
+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=hvTX32Evp23vqjXu-YHqTuneem4_QBRSxCkYR7dg4VI,54705
+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_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=tqVECwd_QokEcRv2MSk7TUU4JSBzCZcJh1eQ0jIGgoY,125122
@@ -32,9 +32,9 @@ 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
@@ -43,13 +43,13 @@ 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=U8SkwbW41zac0MQe0NgP6qTUqymmbeCG-UHPEw_GAv0,13267
-ramses_tx/transport.py,sha256=kyvnVf2RpuA_8YRO6C4S60YHctDag0ywfoMzb0wWDGY,58552
+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=NEkkAJQW7Hx8GmvkR9BZpLSOi30OMi9Awth13sWXuTQ,123
-ramses_rf-0.52.2.dist-info/METADATA,sha256=Fm3vwa0FvFkMEHz44B8FDq0PjboTn_g9sGHyK7HiydA,4000
-ramses_rf-0.52.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ramses_rf-0.52.2.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
-ramses_rf-0.52.2.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
-ramses_rf-0.52.2.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/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)

ramses_tx/schemas.py

@@ -413,6 +413,7 @@ SZ_EVOFW_FLAG: Final = "evofw_flag"
 SZ_SQLITE_INDEX: Final = (
     "sqlite_index"  # temporary 0.52.x SQLite dev config option in ramses_cc
 )
+SZ_LOG_ALL_MQTT: Final = "log_all_mqtt"
 SZ_USE_REGEX: Final = "use_regex"
 
 SCH_ENGINE_DICT = {
@@ -427,6 +428,9 @@ SCH_ENGINE_DICT = {
     vol.Optional(
         SZ_SQLITE_INDEX, default=False
     ): bool,  # temporary 0.52.x dev config option
+    vol.Optional(
+        SZ_LOG_ALL_MQTT, default=False
+    ): bool,  # log all incoming MQTT traffic config option
     vol.Optional(SZ_USE_REGEX): dict,  # vol.All(ConvertNullToDict(), dict),
     vol.Optional(SZ_COMMS_PARAMS): SCH_COMMS_PARAMS,
 }

ramses_tx/transport.py

@@ -1024,6 +1024,7 @@ class PortTransport(_RegHackMixin, _FullTransport, _PortTransportAbstractor):  #
 
 class MqttTransport(_FullTransport, _MqttTransportAbstractor):
     """Send/receive packets to/from ramses_esp via MQTT.
+    For full RX logging, turn on debug logging.
 
     See: https://github.com/IndaloTech/ramses_esp
     """
@@ -1066,6 +1067,9 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
         self._max_tokens: float = self._MAX_TOKENS * 2  # allow for the initial burst
         self._num_tokens: float = self._MAX_TOKENS * 2
 
+        # set log MQTT flag
+        self._log_all = kwargs.pop("log_all", False)
+
         # instantiate a paho mqtt client
         self.client = mqtt.Client(
             protocol=mqtt.MQTTv5, callback_api_version=CallbackAPIVersion.VERSION2
@@ -1283,8 +1287,9 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
 
         if _DBG_FORCE_FRAME_LOGGING:
             _LOGGER.warning("Rx: %s", msg.payload)
-        elif _LOGGER.getEffectiveLevel() == logging.INFO:  # log for INFO not DEBUG
-            _LOGGER.info("Rx: %s", msg.payload)
+        elif self._log_all and _LOGGER.getEffectiveLevel() == logging.INFO:
+            # log for INFO not DEBUG
+            _LOGGER.info("mq Rx: %s", msg.payload)  # TODO remove mq marker?
 
         if msg.topic[-3:] != "/rx":  # then, e.g. 'RAMSES/GATEWAY/18:017804'
             if msg.payload == b"offline":
@@ -1507,6 +1512,7 @@ async def transport_factory(
     disable_sending: bool | None = False,
     extra: dict[str, Any] | None = None,
     loop: asyncio.AbstractEventLoop | None = None,
+    log_all: bool = False,
     **kwargs: Any,  # HACK: odd/misc params
 ) -> RamsesTransportT:
     """Create and return a Ramses-specific async packet Transport."""
@@ -1558,19 +1564,24 @@ async def transport_factory(
             "Packet source must be exactly one of: packet_dict, packet_log, port_name"
         )
 
+    # File
     if (pkt_source := packet_log or packet_dict) is not None:
         return FileTransport(pkt_source, protocol, extra=extra, loop=loop, **kwargs)
 
     assert port_name is not None  # mypy check
     assert port_config is not None  # mypy check
 
+    # MQTT
     if port_name[:4] == "mqtt":  # TODO: handle disable_sending
-        transport = MqttTransport(port_name, protocol, extra=extra, loop=loop, **kwargs)
+        transport = MqttTransport(
+            port_name, protocol, extra=extra, loop=loop, log_all=log_all, **kwargs
+        )
 
         # TODO: remove this? better to invoke timeout after factory returns?
         await protocol.wait_for_connection_made(timeout=_DEFAULT_TIMEOUT_MQTT)
         return transport
 
+    # Serial
     ser_instance = get_serial_instance(port_name, port_config)
 
     if os.name == "nt" or ser_instance.portstr[:7] in ("rfc2217", "socket:"):

ramses_tx/version.py

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