ramses-rf 0.53.0__py3-none-any.whl → 0.53.1__py3-none-any.whl

ramses_cli/__init__.py

@@ -12,7 +12,7 @@ _DBG_FORCE_CLI_DEBUGGING: Final[bool] = (
 )
 
 
-if _DBG_FORCE_CLI_DEBUGGING:
+if _DBG_FORCE_CLI_DEBUGGING:  # pragma: no cover
     from .debug import start_debugging
 
     start_debugging(True)

ramses_cli/client.py

@@ -23,7 +23,7 @@ from ramses_rf.schemas import (
     SZ_ENABLE_EAVESDROP,
     SZ_REDUCE_PROCESSING,
 )
-from ramses_tx import is_valid_dev_id, transport_factory
+from ramses_tx import is_valid_dev_id
 from ramses_tx.logger import CONSOLE_COLS, DEFAULT_DATEFMT, DEFAULT_FMT
 from ramses_tx.schemas import (
     SZ_DISABLE_QOS,
@@ -607,15 +607,25 @@ async def async_main(command: str, lib_kwargs: dict[str, Any], **kwargs: Any) ->
         ]
         lib_kwargs = lib_kwargs | state["schema"]
 
+    # Explicitly extract input_file if present to ensure it's passed as a named arg
+    input_file = lib_kwargs.pop(SZ_INPUT_FILE, None)
+
     # if serial_port == "/dev/ttyMOCK":
     #     from tests.deprecated.mocked_rf import MockGateway  # FIXME: for test/dev
     #     gwy = MockGateway(serial_port, **lib_kwargs)
     # else:
+
+    # Instantiate Gateway, note: transport_factory is the default, so we don't need to pass it
     gwy = Gateway(
-        serial_port, transport_constructor=transport_factory, **lib_kwargs
+        serial_port,
+        input_file=input_file,
+        **lib_kwargs,
     )  # passes action to gateway
 
-    if int(lib_kwargs[SZ_CONFIG][SZ_REDUCE_PROCESSING]) < DONT_CREATE_MESSAGES:
+    if (
+        int(lib_kwargs.get(SZ_CONFIG, {}).get(SZ_REDUCE_PROCESSING, 0))
+        < DONT_CREATE_MESSAGES
+    ):
         # library will not send MSGs to STDOUT, so we'll send PKTs instead
         colorama_init(autoreset=True)  # WIP: remove strip=True
         gwy.add_msg_handler(handle_msg)
@@ -678,7 +688,7 @@ cli.add_command(execute)
 cli.add_command(listen)
 
 
-def main() -> None:
+def main() -> None:  # pragma: no cover
     """Entry point for the CLI.
 
     Parses arguments, sets up the event loop (including Windows-specific policies),
@@ -718,5 +728,5 @@ def main() -> None:
     print(" - finished ramses_rf.\r\n")
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # pragma: no cover
     main()

ramses_cli/discovery.py

@@ -17,10 +17,6 @@ from ramses_rf.device import Fakeable
 from ramses_tx import CODES_SCHEMA, Command, DeviceIdT, Priority
 from ramses_tx.opentherm import OTB_DATA_IDS
 
-# Beware, none of this is reliable - it is all subject to random change
-# However, these serve as examples how to use the other modules
-
-
 from ramses_rf.const import (  # noqa: F401, isort: skip, pylint: disable=unused-import
     I_,
     RP,
@@ -44,22 +40,19 @@ SCAN_FULL: Final = "scan_full"
 SCAN_HARD: Final = "scan_hard"
 SCAN_XXXX: Final = "scan_xxxx"
 
-# DEVICE_ID_REGEX = re.compile(DEVICE_ID_REGEX.ANY)
-
-
 _LOGGER = logging.getLogger(__name__)
 
 
 def script_decorator(fnc: Callable[..., Any]) -> Callable[..., Any]:
     @functools.wraps(fnc)
-    def wrapper(gwy: Gateway, *args: Any, **kwargs: Any) -> None:
+    async def wrapper(gwy: Gateway, *args: Any, **kwargs: Any) -> None:
         gwy.send_cmd(
             Command._puzzle(message="Script begins:"),
             priority=Priority.HIGHEST,
             num_repeats=3,
         )
 
-        fnc(gwy, *args, **kwargs)
+        await fnc(gwy, *args, **kwargs)
 
         gwy.send_cmd(
             Command._puzzle(message="Script done."),
@@ -67,8 +60,6 @@ def script_decorator(fnc: Callable[..., Any]) -> Callable[..., Any]:
             num_repeats=3,
         )
 
-        return None
-
     return wrapper
 
 
@@ -93,7 +84,12 @@ def spawn_scripts(gwy: Gateway, **kwargs: Any) -> list[asyncio.Task[None]]:
             _LOGGER.warning(f"Script: {kwargs[EXEC_SCR][0]}() - unknown script")
         else:
             _LOGGER.info(f"Script: {kwargs[EXEC_SCR][0]}().- starts...")
-            tasks += [asyncio.create_task(script(gwy, kwargs[EXEC_SCR][1]))]
+            # script_poll_device returns a list of tasks, others return a coroutine
+            result = script(gwy, kwargs[EXEC_SCR][1])
+            if isinstance(result, list):
+                tasks.extend(result)
+            else:
+                tasks.append(asyncio.create_task(result))
 
     gwy._tasks.extend(tasks)
     return tasks
@@ -104,14 +100,6 @@ async def exec_cmd(gwy: Gateway, **kwargs: Any) -> None:
     await gwy.async_send_cmd(cmd, priority=Priority.HIGH, wait_for_reply=True)
 
 
-# @script_decorator
-# async def script_scan_001(gwy: Gateway, dev_id: DeviceIdT):
-#     _LOGGER.warning("scan_001() invoked - expect a lot of nonsense")
-#     for idx in range(0x10):
-#         gwy.send_cmd(Command.from_attrs(W_, dev_id, Code._000E, f"{idx:02X}0050"))
-#         gwy.send_cmd(Command.from_attrs(RQ, dev_id, Code._000E, f"{idx:02X}00C8"))
-
-
 async def get_faults(
     gwy: Gateway, ctl_id: DeviceIdT, start: int = 0, limit: int = 0x3F
 ) -> None:
@@ -199,7 +187,7 @@ def script_poll_device(gwy: Gateway, dev_id: DeviceIdT) -> list[asyncio.Task[Non
 async def script_scan_disc(gwy: Gateway, dev_id: DeviceIdT) -> None:
     _LOGGER.warning("scan_disc() invoked...")
 
-    await gwy.get_device(dev_id).discover()  # discover_flag=Discover.DEFAULT)
+    await gwy.get_device(dev_id).discover()
 
 
 @script_decorator
@@ -340,9 +328,7 @@ async def script_scan_otb_hard(gwy: Gateway, dev_id: DeviceIdT) -> None:
 
 
 @script_decorator
-async def script_scan_otb_map(
-    gwy: Gateway, dev_id: DeviceIdT
-) -> None:  # Tested only upon a R8820A
+async def script_scan_otb_map(gwy: Gateway, dev_id: DeviceIdT) -> None:
     _LOGGER.warning("script_scan_otb_map invoked - expect a lot of nonsense")
 
     RAMSES_TO_OPENTHERM = {
@@ -364,9 +350,7 @@ async def script_scan_otb_map(
 
 
 @script_decorator
-async def script_scan_otb_ramses(
-    gwy: Gateway, dev_id: DeviceIdT
-) -> None:  # Tested only upon a R8820A
+async def script_scan_otb_ramses(gwy: Gateway, dev_id: DeviceIdT) -> None:
     _LOGGER.warning("script_scan_otb_ramses invoked - expect a lot of nonsense")
 
     _CODES = (
@@ -394,7 +378,7 @@ async def script_scan_otb_ramses(
         Code._3223,
         Code._3EF0,  # rel. modulation level  / RelativeModulationLevel (also, below)
         Code._3EF1,  # rel. modulation level  / RelativeModulationLevel
-    )  # excl. 3150, 3220
+    )
 
     for c in _CODES:
         gwy.send_cmd(Command.from_attrs(RQ, dev_id, c, "00"), priority=Priority.LOW)

ramses_rf/database.py

@@ -272,18 +272,21 @@ class MessageIndex:
 
         return old
 
-    def add_record(self, src: str, code: str = "", verb: str = "") -> None:
+    def add_record(
+        self, src: str, code: str = "", verb: str = "", payload: str = "00"
+    ) -> None:
         """
         Add a single record to the MessageIndex with timestamp `now()` and no Message contents.
 
         :param src: device id to use as source address
         :param code: device id to use as destination address (can be identical)
         :param verb: two letter verb str to use
+        :param payload: payload str to use
         """
-        # Used by OtbGateway init, via entity_base.py
+        # Used by OtbGateway init, via entity_base.py (code=_3220)
         _now: dt = dt.now()
         dtm: DtmStrT = _now.isoformat(timespec="microseconds")  # type: ignore[assignment]
-        hdr = f"{code}|{verb}|{src}|00"  # dummy record has no contents
+        hdr = f"{code}|{verb}|{src}|{payload}"
 
         dup = self._delete_from(hdr=hdr)
 

ramses_rf/device/heat.py

@@ -668,11 +668,13 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
         self._child_id = FC  # NOTE: domain_id
 
         # TODO(eb): cleanup
-        if self._gwy.msg_db:
-            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:
+        if not self._gwy.msg_db:
+            # self._add_record(
+            #     id=self.id, code=Code._3220, verb="RP", payload="00C0060101"
+            # )  # is parsed but pollutes the client.py
+            # 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:
             self._msgz[Code._3220] = {RP: {}}  # No ctx! (not None)
 
         # lf._use_ot = self._gwy.config.use_native_ot

ramses_rf/entity_base.py

@@ -324,12 +324,16 @@ class _MessageDB(_Entity):
         ]
 
     def _add_record(
-        self, id: DeviceIdT, code: Code | None = None, verb: str = " I"
+        self,
+        id: DeviceIdT,
+        code: Code | None = None,
+        verb: str = " I",
+        payload: str = "00",
     ) -> None:
         """Add a (dummy) record to the central SQLite MessageIndex."""
-        # used by heat.py init
+        # used by heat.py.OtbGateway init
         if self._gwy.msg_db:
-            self._gwy.msg_db.add_record(id, code=str(code), verb=verb)
+            self._gwy.msg_db.add_record(id, code=str(code), verb=verb, payload=payload)
         # else:
         #     _LOGGER.warning("Missing MessageIndex")
         # raise NotImplementedError

ramses_rf/gateway.py

@@ -107,7 +107,7 @@ class Gateway(Engine):
 
         :param port_name: The serial port name (e.g., '/dev/ttyUSB0') or None if using a file.
         :type port_name: str | None
-        :param input_file: Path to a packet log file for playback, defaults to None.
+        :param input_file: Path to a packet log file for playback/parsing, defaults to None.
         :type input_file: str | None, optional
         :param port_config: Configuration dictionary for the serial port, defaults to None.
         :type port_config: PortConfigT | None, optional
@@ -224,9 +224,10 @@ class Gateway(Engine):
         )
 
         # initialize SQLite index, set in _tx/Engine
-        if self._sqlite_index:  # TODO(eb): default to ON in Q4 2025
+        if self._sqlite_index:  # TODO(eb): default to True in Q1 2026
             _LOGGER.info("Ramses RF starts SQLite MessageIndex")
-            self.create_sqlite_message_index()  # if activated in ramses_cc > Engine
+            # if activated in ramses_cc > Engine or set in tests
+            self.create_sqlite_message_index()
 
         # temporarily turn on discovery, remember original state
         self.config.disable_discovery, disable_discovery = (

ramses_rf/system/zones.py

@@ -689,7 +689,7 @@ class Zone(ZoneSchedule):
 
     @property
     def heating_type(self) -> str | None:
-        """Return the type of the zone/DHW (e.g. electric_zone, stored_dhw)."""
+        """Get the type of the zone/DHW (e.g. electric_zone, stored_dhw)."""
 
         if self._SLUG is None:  # isinstance(self, ???)
             return None
@@ -697,12 +697,13 @@ class Zone(ZoneSchedule):
 
     @property
     def name(self) -> str | None:  # 0004
-        """Return the name of the zone."""
+        """Get the name of the zone."""
 
         if self._gwy.msg_db:
             msgs = self._gwy.msg_db.get(
                 code=Code._0004, src=self._z_id, ctx=self._z_idx
             )
+            _LOGGER.debug(f"Pick Zone.name from: {msgs}[0])")  # DEBUG issue #317
             return msgs[0].payload.get(SZ_NAME) if msgs else None
 
         return self._msg_value(Code._0004, key=SZ_NAME)  # type: ignore[no-any-return]

ramses_rf/version.py

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

{ramses_rf-0.53.0.dist-info → ramses_rf-0.53.1.dist-info}/METADATA

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

@@ -1,56 +1,56 @@
-ramses_cli/__init__.py,sha256=uvGzWqOf4avvgzxJNSLFWEelIWqSZ-AeLAZzg5x58bc,397
-ramses_cli/client.py,sha256=OpsVfrdwChrBKia_yfAlI60ERMg7KAk3BWRpQyY3AWA,24762
+ramses_cli/__init__.py,sha256=d_3uIFkK8JnWOxknrBloKCe6-vI9Ouo_KGqR4kfBQW8,417
+ramses_cli/client.py,sha256=Fd6hXGBvI-i89Xu8QbBU9NW-dWlQjSer-_LYAtvJPW4,25055
 ramses_cli/debug.py,sha256=PLcz-3PjUiMVqtD_p6VqTA92eHUM58lOBFXh_qgQ_wA,576
-ramses_cli/discovery.py,sha256=MWoahBnAAVzfK2S7EDLsY2WYqN_ZK9L-lktrj8_4cb0,12978
+ramses_cli/discovery.py,sha256=WTcoFH5hNhQ1AeOZtpdZIVYwdUfmUKlq2iBpa-KcgoI,12512
 ramses_cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramses_cli/utils/cat_slow.py,sha256=AhUpM5gnegCitNKU-JGHn-DrRzSi-49ZR1Qw6lxe_t8,607
 ramses_cli/utils/convert.py,sha256=N3LxGe3_0pclijtmYW-ChqCuPTzbkoJA4XNAnoSnBk0,1806
 ramses_rf/__init__.py,sha256=AXsCK1Eh9FWeAI9D_zY_2KB0dqrTb9a5TNY1NvyQaDM,1271
 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=9nY1Wt2hjkBoDvDqopzPP3mPSH5-Q5XHPQuJnM2GHOw,21362
+ramses_rf/database.py,sha256=AHXIx5pO0qgiHbBQxLBegnk0e1M4SFwD9Spd4eyW_eQ,21428
 ramses_rf/dispatcher.py,sha256=YjEU-QrBLo9IfoEhJo2ikg_FxOaMYoWvzelr9Vi-JZ8,11398
-ramses_rf/entity_base.py,sha256=6jsHQD_5buaV56rF6nTgzPKOLsXFGVly9EHAeigqeRg,59039
+ramses_rf/entity_base.py,sha256=L47P_6CRz3tLDzOzII9AgmueKDb-Bp7Ot3vVsr8jo10,59121
 ramses_rf/exceptions.py,sha256=mt_T7irqHSDKir6KLaf6oDglUIdrw0S40JbOrWJk5jc,3657
-ramses_rf/gateway.py,sha256=KWE7ZkHGPcZFp9eaKN9zXchkykMJLEx_k5Le99or5lQ,30064
+ramses_rf/gateway.py,sha256=hHsXbpeZ2Fetpu3jzv8UeUwlNf4rsxOD7eOHuLY83Xk,30101
 ramses_rf/helpers.py,sha256=TNk_QkpIOB3alOp1sqnA9LOzi4fuDCeapNlW3zTzNas,4250
 ramses_rf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramses_rf/schemas.py,sha256=X1GAK3kttuLMiSCUDY2s-85fgBxPeU8xiDa6gJ1I5mY,13543
-ramses_rf/version.py,sha256=FlL_C6hC_miMOJxgK12zDE2CvaAfRA3KoLOL1_U-7QE,125
+ramses_rf/version.py,sha256=yMI3sQ8wyLuGx_Hm7ZYNuwbqFZ3Qhr3GJXdkdsGwh7s,125
 ramses_rf/device/__init__.py,sha256=sUbH5dhbYFXSoM_TPFRutpRutBRpup7_cQ9smPtDTy8,4858
 ramses_rf/device/base.py,sha256=Tu5I8Lj7KplfRsIBQAYjilS6YPgTyjpU8qgKugMR2Jk,18281
-ramses_rf/device/heat.py,sha256=T-ENFzH1AEOd0m4-TgV-Qk0TnLNir_pYmyKlJtxy6NI,54538
+ramses_rf/device/heat.py,sha256=CU6GlIgjuYD21braJ_RJlS56zP47TGXNxXnZeavfEMY,54654
 ramses_rf/device/hvac.py,sha256=vdgiPiLtCAGr7CVsGhQl6XuAFkyYdQSE_2AEdCmRl2I,48502
 ramses_rf/system/__init__.py,sha256=uZLKio3gLlBzePa2aDQ1nxkcp1YXOGrn6iHTG8LiNIw,711
 ramses_rf/system/faultlog.py,sha256=GdGmVGT3137KsTlV_nhccgIFEmYu6DFsLTn4S-8JSok,12799
 ramses_rf/system/heat.py,sha256=qQmzgmyHy2x87gHAstn0ee7ZVVOq-GJIfDxCrC-6gFU,39254
 ramses_rf/system/schedule.py,sha256=Ts6tdZPTQLV5NkgwA73tPa5QUsnZNIIuYoKC-8VsXDk,18808
-ramses_rf/system/zones.py,sha256=qMv7CuvZUKBNLpPRXgFA70NFRStgVJcw062h5mc3Y8Q,37034
+ramses_rf/system/zones.py,sha256=6VbPsOuNbGwBUuiRu8w9D1Q18SHKkuZa2YtKTE5nqlo,37110
 ramses_tx/__init__.py,sha256=sqnjM7pUGJDmec6igTtKViSB8FLX49B5gwhAmcY9ERY,3596
 ramses_tx/address.py,sha256=IuwUwZxykn3fP1UCRcv4D-zbTICBe2FJjDAFX5X6VoI,9108
 ramses_tx/command.py,sha256=drxmpdM4YgyPg4h0QIr1ouxK9QjfeLVgnFpDRox0CCY,125652
-ramses_tx/const.py,sha256=gmRQ59V5AJx2TlACL3tDSBy5VpvEOVbQfG0z7WjFCKE,32941
+ramses_tx/const.py,sha256=jiE2UaGBJ5agr68EMrcEHWtVz2KMidU7c7rRYCIiaoM,33010
 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=Fl6EqAUU2DnLOiA2_87sS7VPBEyxA1a_ICCmg55WMMA,11494
-ramses_tx/helpers.py,sha256=VIPSw0lrDrE3S92YchzeRo7G2AlQ_vE8OuYUF-rlpQw,33616
+ramses_tx/gateway.py,sha256=H4JtIkp7JFMyZZ76sij67rTbjc1i3iWaIf6tuxIpHAg,11529
+ramses_tx/helpers.py,sha256=96OvSOWYuMcr89_c-3dRnqHZaMOctCO94uo1hETh3bc,33613
 ramses_tx/logger.py,sha256=1iKRHKUaqHqGd76CkE_6mCVR0sYODtxshRRwfY61fTk,10426
-ramses_tx/message.py,sha256=HUSNiBgGlnWEBeBqb4K28GcU5oB7RbS9a0JC2p9SGe4,13676
+ramses_tx/message.py,sha256=zsyDQztSUYeqj3-P598LSmy9ODQY2BUCzWxSoZds6bM,13953
 ramses_tx/opentherm.py,sha256=58PXz9l5x8Ou6Fm3y-R_UnGHCYahoi2RKIDdYStUMzk,42378
 ramses_tx/packet.py,sha256=_nzuInS_WhdOI26SYvgsdDqIaDvVNguc2YDwdPOVCbU,7661
-ramses_tx/parsers.py,sha256=qQz8VOKaH26MUvo9AfUwhrnbH7VwXLxFc2gKJYvjXvY,148571
+ramses_tx/parsers.py,sha256=vHaVdapzW9TtQhCjR9XuaLLkp5ZMXKmTm05zbu0ekW0,148576
 ramses_tx/protocol.py,sha256=nBPKCD1tcGp_FiX0qhsY0XoGO_h87w5cYywBjSpum4w,33048
 ramses_tx/protocol_fsm.py,sha256=o9vLvlXor3LkPgsY1zii5P1R01GzYLf_PECDdoxtC24,27520
 ramses_tx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ramses_tx/ramses.py,sha256=vp748Tf_a-56OMM8CWDA2ZktRfTuj0QVyPRcnsOstSM,53983
 ramses_tx/schemas.py,sha256=Hrmf_q9bAZtkKJzGu6GtUO0QV_-K9i4L99EzGWR13eE,13408
-ramses_tx/transport.py,sha256=Tk2CPAu9W0T4HCe6Q2VUYex2bFNZlyYsluP7iLf0rdQ,76277
+ramses_tx/transport.py,sha256=hktWSDOzKUME967w58JB4z3MgmCMiQ0QZI0x4-Awaas,76419
 ramses_tx/typed_dicts.py,sha256=w-0V5t2Q3GiNUOrRAWiW9GtSwbta_7luME6GfIb1zhI,10869
 ramses_tx/typing.py,sha256=eF2SlPWhNhEFQj6WX2AhTXiyRQVXYnFutiepllYl2rI,5042
-ramses_tx/version.py,sha256=DToXw6Td-r5_4JxS4fbBBGkajaXoEj8xCJOh7vaNcQI,123
-ramses_rf-0.53.0.dist-info/METADATA,sha256=YkSNqr4RWgOsSi-z8SO5H4LEbzOI87IVYurjHWpUgRc,4179
-ramses_rf-0.53.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-ramses_rf-0.53.0.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
-ramses_rf-0.53.0.dist-info/licenses/LICENSE,sha256=ptVutrtSMr7X-ek6LduiD8Cce4JsNn_8sR8MYlm-fvo,1086
-ramses_rf-0.53.0.dist-info/RECORD,,
+ramses_tx/version.py,sha256=g3EPkHx--jzBHNq9oau7n6DOcVjdbcDWz5m13ZpzvEQ,123
+ramses_rf-0.53.1.dist-info/METADATA,sha256=OC2EXqy23YPE-jCqrXSdLM4cN5_7a9M3fBWh15r3kqg,4179
+ramses_rf-0.53.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ramses_rf-0.53.1.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
+ramses_rf-0.53.1.dist-info/licenses/LICENSE,sha256=ptVutrtSMr7X-ek6LduiD8Cce4JsNn_8sR8MYlm-fvo,1086
+ramses_rf-0.53.1.dist-info/RECORD,,

ramses_tx/const.py

@@ -276,7 +276,9 @@ class AttrDict(dict):  # type: ignore[type-arg]
             return self._forward[name[1:]]
         elif name.isupper() and name.lower() in self._reverse:  # map.DHW_SENSOR -> "0D"
             return self[name.lower()]
-        return self.__getattribute__(name)
+        raise AttributeError(
+            f"'{type(self).__name__}' object has no attribute '{name}'"
+        )
 
     def _hex(self, key: str) -> str:
         """Return the key/ID (2-byte hex string) of the two-way dict (e.g. '04').

ramses_tx/gateway.py

@@ -114,7 +114,9 @@ class Engine:
             self._include,
             self._exclude,
         )
-        self._sqlite_index = kwargs.pop(SZ_SQLITE_INDEX, False)  # default True?
+        self._sqlite_index = kwargs.pop(
+            SZ_SQLITE_INDEX, False
+        )  # TODO Q1 2026: default True
         self._log_all_mqtt = kwargs.pop(SZ_LOG_ALL_MQTT, False)
         self._kwargs: dict[str, Any] = kwargs  # HACK
 

ramses_tx/helpers.py

@@ -149,7 +149,7 @@ def timestamp() -> float:
 
 
 def dt_now() -> dt:
-    """Return the current datetime as a local/naive datetime object.
+    """Get the current datetime as a local/naive datetime object.
 
     This is slower, but potentially more accurate, than dt.now(), and is used mainly for
     packet timestamps.

ramses_tx/message.py

@@ -70,22 +70,24 @@ class MessageBase:
         self.verb: VerbT = pkt.verb
         self.seqn: str = (
             pkt.seqn
-        )  # the msg is part of a set for 1 Code, received in order
+        )  # the msg is part of a set for a Code, received in order
         self.code: Code = pkt.code
         self.len: int = pkt._len
 
-        self._payload = self._validate(
-            self._pkt.payload
-        )  # ? may raise InvalidPacketError
+        self._payload = self._validate(self._pkt.payload)  # ? may raise PacketInvalid
 
         self._str: str = None  # type: ignore[assignment]
 
     def __repr__(self) -> str:
-        """Return an unambiguous string representation of this object."""
+        """
+        :return: an unambiguous string representation of this object.
+        """
         return str(self._pkt)  # repr or str?
 
     def __str__(self) -> str:
-        """Return a brief readable string representation of this object."""
+        """
+        :return: a brief readable string representation of this object.
+        """
 
         def ctx(pkt: Packet) -> str:
             ctx = {True: "[..]", False: "", None: "??"}.get(pkt._ctx, pkt._ctx)  # type: ignore[arg-type]
@@ -128,17 +130,22 @@ class MessageBase:
         return self.dtm < other.dtm
 
     def _name(self, addr: Address) -> str:
-        """Return a friendly name for an Address, or a Device."""
+        """
+        :return: a friendly name for an Address, or a Device.
+        """
         return f" {addr.id}"  # can't do 'CTL:123456' instead of ' 01:123456'
 
     @property
     def payload(self):  # type: ignore[no-untyped-def]  # FIXME -> dict | list:
-        """Return the payload."""
+        """
+        :return: the payload.
+        """
         return self._payload
 
     @property
     def _has_payload(self) -> bool:
-        """Return False if there is no payload (may falsely Return True).
+        """
+        :return: False if there is no payload (may falsely return True).
 
         The message (i.e. the raw payload) may still have an idx.
         """
@@ -234,7 +241,7 @@ class MessageBase:
             return {}
 
         # TODO: also 000C (but is a complex idx)
-        # TODO: also 3150 (when not domain, and will be array if so)
+        # TODO: also 3150 (when not domain; will be array in that case)
         if self.code in (Code._000A, Code._2309) and self.src.type == DEV_TYPE_MAP.UFC:
             assert isinstance(self._pkt._idx, str)  # mypy hint
             return {IDX_NAMES[Code._22C9]: self._pkt._idx}
@@ -250,7 +257,7 @@ class MessageBase:
         """Validate a message packet payload, and parse it if valid.
 
         :return: a dict containing key: value pairs, or a list of those created from the payload
-        :raises an InvalidPacketError exception if it is not valid.
+        :raises PacketInvalid exception if it is not valid.
         """
 
         try:  # parse the payload
@@ -292,7 +299,7 @@ class MessageBase:
 
 
 class Message(MessageBase):
-    """Extend the Message class, so is useful to a stateful Gateway.
+    """Extend the Message class, so it is useful to a stateful Gateway.
 
     Adds _expired attr to the Message class.
     """
@@ -303,7 +310,7 @@ class Message(MessageBase):
     # .HAS_DIED = 1.0  # fraction_expired >= 1.0 (is expected lifespan)
     IS_EXPIRING = 0.8  # fraction_expired >= 0.8 (and < HAS_EXPIRED)
 
-    _gwy: Gateway
+    _gwy: Gateway | None = None
     _fraction_expired: float | None = None
 
     @classmethod
@@ -318,13 +325,19 @@ class Message(MessageBase):
 
     @property
     def _expired(self) -> bool:
-        """Return True if the message is dated (or False otherwise)."""
+        """
+        :return: True if the message is dated, False otherwise
+        """
         # fraction_expired = (dt_now - self.dtm - _TD_SECONDS_003) / self._pkt._lifespan
         # TODO: keep none >7d, even 10E0, etc.
 
         def fraction_expired(lifespan: td) -> float:
-            """Return the packet's age as fraction of its 'normal' life span."""
-            return (self._gwy._dt_now() - self.dtm - _TD_SECS_003) / lifespan
+            """
+            :return: the packet's age as fraction of its 'normal' life span.
+            """
+            if self._gwy:  # self._gwy is set in ramses_tx.gateway.Engine._msg_handler
+                return (self._gwy._dt_now() - self.dtm - _TD_SECS_003) / lifespan
+            return (dt.now() - self.dtm - _TD_SECS_003) / lifespan
 
         # 1. Look for easy win...
         if self._fraction_expired is not None:

ramses_tx/parsers.py

@@ -3291,13 +3291,13 @@ def parser_3220(payload: str, msg: Message) -> dict[str, Any]:
         "FFFF",
     ), f"OpenTherm: Invalid msg-type|data-value: {ot_type}|{payload[6:10]}"
 
-    # HACK: These OT data id can pop in/out of 47AB, which is an invalid value
+    # HACK: These OT data id's can pop in/out of 47AB, which is an invalid value
     if payload[6:] == "47AB" and ot_id in (0x12, 0x13, 0x19, 0x1A, 0x1B, 0x1C):
         ot_value[SZ_VALUE] = None
     # HACK: This OT data id can be 1980, which is an invalid value
     if payload[6:] == "1980" and ot_id:  # CH pressure is 25.5 bar!
         ot_value[SZ_VALUE] = None
-    # HACK: Done above, not in OT.decode_frame() as they isn't in the OT specification
+    # HACK: Done above, not in OT.decode_frame() as values aren't in the OT specification
 
     if ot_type not in _LIST:
         assert ot_type in (

ramses_tx/transport.py

@@ -772,7 +772,7 @@ class _ReadTransport(_BaseTransport):
         if self._closing is True:  # raise, or warn & return?
             raise exc.TransportError("Transport is closing or has closed")
 
-        # TODO: can we switch to call_soon now QoS has been refactored?
+        # TODO: can we switch to call_soon now that QoS has been refactored?
         # NOTE: No need to use call_soon() here, and they may break Qos/Callbacks
         # NOTE: Thus, excepts need checking
         try:  # below could be a call_soon?
@@ -783,7 +783,7 @@ class _ReadTransport(_BaseTransport):
             _LOGGER.error("%s < exception from msg layer: %s", pkt, err)
 
     async def write_frame(self, frame: str, disable_tx_limits: bool = False) -> None:
-        """ "Transmit a frame via the underlying handler (e.g. serial port, MQTT).
+        """Transmit a frame via the underlying handler (e.g. serial port, MQTT).
 
         :param frame: The frame to write.
         :type frame: str
@@ -811,7 +811,7 @@ class _FullTransport(_ReadTransport):  # asyncio.Transport
         self._transmit_times: deque[dt] = deque(maxlen=_MAX_TRACKED_TRANSMITS)
 
     def _dt_now(self) -> dt:
-        """Return a precise datetime, using the current dtm.
+        """Get a precise datetime, using the current dtm.
 
         :return: Current datetime.
         :rtype: dt
@@ -1945,7 +1945,7 @@ async def transport_factory(
     :type port_name: SerPortNameT | None, optional
     :param port_config: Configuration dictionary for serial port, defaults to None.
     :type port_config: PortConfigT | None, optional
-    :param packet_log: Path to a file containing packet logs for playback, defaults to None.
+    :param packet_log: Path to a file containing packet logs for playback/parsing, defaults to None.
     :type packet_log: str | None, optional
     :param packet_dict: Dictionary of packets for playback, defaults to None.
     :type packet_dict: dict[str, str] | None, optional
@@ -2024,6 +2024,9 @@ async def transport_factory(
         )
 
     if len([x for x in (packet_dict, packet_log, port_name) if x is not None]) != 1:
+        _LOGGER.warning(
+            f"Input: packet_dict: {packet_dict}, packet_log: {packet_log}, port_name: {port_name}"
+        )
         raise exc.TransportSourceInvalid(
             "Packet source must be exactly one of: packet_dict, packet_log, port_name"
         )

ramses_tx/version.py

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