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

ramses_tx/protocol.py

@@ -66,7 +66,7 @@ class _BaseProtocol(asyncio.Protocol):
         self._msg_handler = msg_handler
         self._msg_handlers: list[MsgHandlerT] = []
 
-        self._transport: RamsesTransportT = None  # type: ignore[assignment]
+        self._transport: RamsesTransportT | None = None
         self._loop = asyncio.get_running_loop()
 
         self._pause_writing = False  # FIXME: Start in R/O mode as no connection yet?
@@ -80,6 +80,9 @@ class _BaseProtocol(asyncio.Protocol):
 
         self._is_evofw3: bool | None = None
 
+        self._active_hgi: DeviceIdT | None = None
+        self._context: ProtocolContext | None = None
+
     @property
     def hgi_id(self) -> DeviceIdT:
         return HGI_DEV_ADDR.id
@@ -140,7 +143,16 @@ class _BaseProtocol(asyncio.Protocol):
         received or the connection was aborted or closed).
         """
 
-        assert self._wait_connection_lost  # mypy
+        # FIX: Check if _wait_connection_lost exists before asserting
+        # This handles cases where connection was never fully established (e.g. timeout)
+        if not self._wait_connection_lost:
+            _LOGGER.debug(
+                "connection_lost called but no connection was established (ignoring)"
+            )
+            # Reset the connection made future for next attempt
+            if self._wait_connection_made.done():
+                self._wait_connection_made = self._loop.create_future()
+            return
 
         if self._wait_connection_lost.done():  # BUG: why is callback invoked twice?
             return
@@ -199,6 +211,10 @@ class _BaseProtocol(asyncio.Protocol):
 
         self._pause_writing = False
 
+    async def _send_impersonation_alert(self, cmd: Command) -> None:
+        """Allow the Protocol to send an impersonation alert (stub)."""
+        return
+
     async def send_cmd(
         self,
         cmd: Command,
@@ -207,22 +223,64 @@ class _BaseProtocol(asyncio.Protocol):
         gap_duration: float = DEFAULT_GAP_DURATION,
         num_repeats: int = DEFAULT_NUM_REPEATS,
         priority: Priority = Priority.DEFAULT,
-        qos: QosParams = DEFAULT_QOS,
+        qos: QosParams = DEFAULT_QOS,  # max_retries, timeout, wait_for_reply
     ) -> Packet:
-        """This is the wrapper for self._send_cmd(cmd)."""
+        """Send a Command with Qos (with retries, until success or ProtocolError).
 
-        # if not self._transport:
-        #     raise exc.ProtocolSendFailed("There is no connected Transport")
+        Returns the Command's response Packet or the Command echo if a response is not
+        expected (e.g. sending an RP).
 
-        if _DBG_FORCE_LOG_PACKETS:
-            _LOGGER.warning(f"QUEUED:     {cmd}")
-        else:
-            _LOGGER.debug(f"QUEUED:     {cmd}")
+        If wait_for_reply is True, return the RQ's RP (or W's I), or raise an exception
+        if one doesn't arrive. If it is False, return the echo of the Command only. If
+        it is None (the default), act as True for RQs, and False for all other Commands.
 
-        if self._pause_writing:
-            raise exc.ProtocolError("The Protocol is currently read-only/paused")
+        num_repeats is # of times to send the Command, in addition to the fist transmit,
+        with gap_duration seconds between each transmission. If wait_for_reply is True,
+        then num_repeats is ignored.
+
+        Commands are queued and sent FIFO, except higher-priority Commands are always
+        sent first.
+
+        Will raise:
+            ProtocolSendFailed: tried to Tx Command, but didn't get echo/reply
+            ProtocolError:      didn't attempt to Tx Command for some reason
+        """
 
-        return await self._send_cmd(
+        assert gap_duration == DEFAULT_GAP_DURATION
+        assert 0 <= num_repeats <= 3  # if QoS, only Tx x1, with no repeats
+
+        # FIX: Patch command with actual HGI ID if it uses the default placeholder
+        # NOTE: HGI80s (TI 3410) require the default ID (18:000730), or they will silent-fail
+        if (
+            self._active_hgi
+            and self._is_evofw3  # Only patch if using evofw3 (not HGI80)
+            and cmd._addrs[0].id == HGI_DEV_ADDR.id
+            and self._active_hgi != HGI_DEV_ADDR.id
+        ):
+            # The command uses the default 18:000730, but we know the real ID.
+            # Reconstruct the command string with the correct address.
+
+            # Get current addresses as strings
+            new_addrs = [a.id for a in cmd._addrs]
+
+            # ONLY patch the Source Address (Index 0).
+            # Leave Dest (Index 1/2) alone to avoid breaking tests that expect 18:000730 there.
+            new_addrs[0] = self._active_hgi
+
+            new_frame = f"{cmd.verb} {cmd.seqn} {new_addrs[0]} {new_addrs[1]} {new_addrs[2]} {cmd.code} {int(cmd.len_):03d} {cmd.payload}"
+            cmd = Command(new_frame)
+
+        if qos and not self._context:
+            _LOGGER.warning(f"{cmd} < QoS is currently disabled by this Protocol")
+
+        if cmd.src.id != self.hgi_id:  # Was HGI_DEV_ADDR.id
+            await self._send_impersonation_alert(cmd)
+
+        if qos.wait_for_reply and num_repeats:
+            _LOGGER.warning(f"{cmd} < num_repeats set to 0, as wait_for_reply is True")
+            num_repeats = 0  # the lesser crime over wait_for_reply=False
+
+        pkt = await self._send_cmd(  # may: raise ProtocolError/ProtocolSendFailed
             cmd,
             gap_duration=gap_duration,
             num_repeats=num_repeats,
@@ -230,6 +288,11 @@ class _BaseProtocol(asyncio.Protocol):
             qos=qos,
         )
 
+        if not pkt:  # HACK: temporary workaround for returning None
+            raise exc.ProtocolSendFailed(f"Failed to send command: {cmd} (REPORT THIS)")
+
+        return pkt
+
     async def _send_cmd(
         self,
         cmd: Command,
@@ -249,6 +312,10 @@ class _BaseProtocol(asyncio.Protocol):
         self, frame: str, num_repeats: int = 0, gap_duration: float = 0.0
     ) -> None:  # _send_frame() -> transport
         """Write to the transport."""
+
+        if self._transport is None:
+            raise exc.ProtocolSendFailed("Transport is not connected")
+
         await self._transport.write_frame(frame)
         for _ in range(num_repeats - 1):
             await asyncio.sleep(gap_duration)
@@ -555,8 +622,17 @@ class PortProtocol(_DeviceIdFilterMixin, _BaseProtocol):
         super().connection_made(transport)
         # TODO: needed? self.resume_writing()
 
-        self._set_active_hgi(self._transport.get_extra_info(SZ_ACTIVE_HGI))
-        self._is_evofw3 = self._transport.get_extra_info(SZ_IS_EVOFW3)
+        # ROBUSTNESS FIX: Ensure self._transport is set even if the wait future was cancelled
+        if self._transport is None:
+            _LOGGER.warning(
+                f"{self}: Transport bound after wait cancelled (late connection)"
+            )
+            self._transport = transport
+
+        # Safe access with check (optional but recommended)
+        if self._transport:
+            self._set_active_hgi(self._transport.get_extra_info(SZ_ACTIVE_HGI))
+            self._is_evofw3 = self._transport.get_extra_info(SZ_IS_EVOFW3)
 
         if not self._context:
             return
@@ -583,7 +659,7 @@ class PortProtocol(_DeviceIdFilterMixin, _BaseProtocol):
             self._context.pause_writing()
 
     def resume_writing(self) -> None:
-        """Inform the FSM that the Protocol has been paused."""
+        """Inform the FSM that the Protocol has been resumed."""
 
         super().resume_writing()
         if self._context:
@@ -597,7 +673,7 @@ class PortProtocol(_DeviceIdFilterMixin, _BaseProtocol):
             self._context.pkt_received(pkt)
 
     async def _send_impersonation_alert(self, cmd: Command) -> None:
-        """Send an puzzle packet warning that impersonation is occurring."""
+        """Send a puzzle packet warning that impersonation is occurring."""
 
         if _DBG_DISABLE_IMPERSONATION_ALERTS:
             return
@@ -656,6 +732,8 @@ class PortProtocol(_DeviceIdFilterMixin, _BaseProtocol):
         #         f"{self}: Failed to send {cmd._hdr}: excluded by list"
         #     )
 
+        assert self._context
+
         try:
             return await self._context.send_cmd(send_cmd, cmd, priority, qos)
         # except InvalidStateError as err:  # TODO: handle InvalidStateError separately
@@ -701,9 +779,6 @@ class PortProtocol(_DeviceIdFilterMixin, _BaseProtocol):
         if qos and not self._context:
             _LOGGER.warning(f"{cmd} < QoS is currently disabled by this Protocol")
 
-        if cmd.src.id != HGI_DEV_ADDR.id:  # or actual HGI addr
-            await self._send_impersonation_alert(cmd)
-
         if qos.wait_for_reply and num_repeats:
             _LOGGER.warning(f"{cmd} < num_repeats set to 0, as wait_for_reply is True")
             num_repeats = 0  # the lesser crime over wait_for_reply=False

ramses_tx/ramses.py

@@ -377,10 +377,10 @@ CODES_SCHEMA: dict[Code, dict[str, Any]] = {  # rf_unknown
         I_: r"^(0[0-9A-F][0-9A-F]{8}0[12]){1,4}(0[12]03)?$",  # (0[12]03)? only if len(array) == 1
         W_: r"^(0[0-9A-F][0-9A-F]{8}0[12])$",  # never an array
     },
-    Code._22D0: {  # unknown_22d0, HVAC system switch?
+    Code._22D0: {  # unknown_22d0, Spider thermostat, HVAC system switch?
         SZ_NAME: "message_22d0",
-        I_: r"^(00|03)",
-        W_: r"^03",
+        I_: r"^(00|03)[0-9]{6}$",
+        W_: r"^03[0-9]{4}1E14030020$",
     },
     Code._22D9: {  # boiler_setpoint
         SZ_NAME: "boiler_setpoint",
@@ -843,6 +843,7 @@ _DEV_KLASSES_HEAT: dict[str, dict[Code, dict[VerbT, Any]]] = {
         Code._000C: {I_: {}},
         Code._000E: {I_: {}},
         Code._0016: {RQ: {}},
+        Code._01FF: {I_: {}, RQ: {}},
         Code._042F: {I_: {}},
         Code._1030: {I_: {}},
         Code._1060: {I_: {}},
@@ -853,9 +854,11 @@ _DEV_KLASSES_HEAT: dict[str, dict[Code, dict[VerbT, Any]]] = {
         Code._1F09: {I_: {}},
         Code._1FC9: {I_: {}},
         Code._22C9: {W_: {}},  # DT4R
+        Code._22D0: {W_: {}},  # Spider master THM
         Code._2309: {I_: {}, RQ: {}, W_: {}},
         Code._2349: {RQ: {}, W_: {}},
         Code._30C9: {I_: {}},
+        Code._3110: {I_: {}},  # Spider THM
         Code._3120: {I_: {}},
         Code._313F: {
             I_: {}
@@ -880,6 +883,7 @@ _DEV_KLASSES_HEAT: dict[str, dict[Code, dict[VerbT, Any]]] = {
         Code._3110: {I_: {}},  # Spider Autotemp
         Code._3150: {I_: {}},
         Code._4E01: {I_: {}},  # Spider Autotemp Zone controller
+        Code._4E04: {I_: {}},  # idem
     },
     DevType.TRV: {  # e.g. HR92/HR91: Radiator Controller
         Code._0001: {W_: {r"^0[0-9A-F]"}},
@@ -1178,9 +1182,9 @@ _CODE_ONLY_FROM_CTL: tuple[Code, ...] = tuple(
 CODES_ONLY_FROM_CTL: tuple[Code, ...] = (
     Code._1030,
     Code._1F09,
-    Code._22D0,
+    # Code._22D0,  # also _W from the Spider master THM! issue #340
     Code._313F,
-)  # I packets, TODO: 31Dx too?
+)  # I packets, TODO: 31Dx too? not 31D9/31DA!
 
 #
 ########################################################################################

ramses_tx/transport.py

@@ -103,7 +103,7 @@ if TYPE_CHECKING:
 
 
 _DEFAULT_TIMEOUT_PORT: Final[float] = 3
-_DEFAULT_TIMEOUT_MQTT: Final[float] = 9
+_DEFAULT_TIMEOUT_MQTT: Final[float] = 60  # Updated from 9s to 60s for robustness
 
 _SIGNATURE_GAP_SECS = 0.05
 _SIGNATURE_MAX_TRYS = 40  # was: 24
@@ -1368,7 +1368,13 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
             )
         # FIXME: convert all dt early, and convert to aware, i.e. dt.now().astimezone()
 
-        self._frame_read(dtm.isoformat(), _normalise(payload["msg"]))
+        try:
+            self._frame_read(dtm.isoformat(), _normalise(payload["msg"]))
+        except exc.TransportError:
+            # If the transport is closing, we expect this error and can safely ignore it
+            # prevents "Uncaught thread exception" in paho.mqtt client
+            if not self._closing:
+                raise
 
     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).
@@ -1572,13 +1578,31 @@ async def transport_factory(
     assert port_config is not None  # mypy check
 
     # MQTT
-    if port_name[:4] == "mqtt":  # TODO: handle disable_sending
+    if port_name[:4] == "mqtt":
+        # Check for custom timeout in kwargs, fallback to constant
+        mqtt_timeout = kwargs.get("timeout", _DEFAULT_TIMEOUT_MQTT)
+
         transport = MqttTransport(
-            port_name, protocol, extra=extra, loop=loop, log_all=log_all, **kwargs
+            port_name,
+            protocol,
+            disable_sending=bool(
+                disable_sending
+            ),  # Feature Added: handled disable_sending
+            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)
+        try:
+            # Robustness Fix: Wait with timeout, handle failure gracefully
+            await protocol.wait_for_connection_made(timeout=mqtt_timeout)
+        except Exception:
+            # CRITICAL FIX: Close the transport if setup fails to prevent "Zombie" callbacks
+            # This prevents the "AttributeError: 'NoneType'..." crash later on
+            transport.close()
+            raise
+
         return transport
 
     # Serial
@@ -1598,4 +1622,5 @@ async def transport_factory(
 
     # TODO: remove this? better to invoke timeout after factory returns?
     await protocol.wait_for_connection_made(timeout=_DEFAULT_TIMEOUT_PORT)
+    # pytest-cov times out in virtual_rf.py when set below 30.0 on GitHub Actions
     return transport

ramses_tx/version.py

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

ramses_rf-0.52.3.dist-info/RECORD

@@ -1,55 +0,0 @@
-ramses_cli/__init__.py,sha256=uvGzWqOf4avvgzxJNSLFWEelIWqSZ-AeLAZzg5x58bc,397
-ramses_cli/client.py,sha256=NTLhHhTiYmp7nyE3vqIFR9zjwfot1wdIT7QuMUgubD0,20350
-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=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=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=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=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=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=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
-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=Fl6EqAUU2DnLOiA2_87sS7VPBEyxA1a_ICCmg55WMMA,11494
-ramses_tx/helpers.py,sha256=J4OCRckp3JshGQTvvqEskFjB1hPS7uA_opVsuIqmZds,32915
-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=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=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=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,,