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

ramses_rf/system/heat.py

@@ -532,7 +532,7 @@ class MultiZone(SystemBase):  # 0005 (+/- 000C?)
         schema = shrink(SCH_TCS_ZONES_ZON(schema))
 
         zon: Zone = self.zone_by_idx.get(zone_idx)  # type: ignore[assignment]
-        if zon is None:
+        if zon is None:  # not found in tcs, create it
             zon = zone_factory(self, zone_idx, msg=msg, **schema)  # type: ignore[unreachable]
             self.zone_by_idx[zon.idx] = zon
             self.zones.append(zon)

ramses_rf/system/zones.py

@@ -36,7 +36,7 @@ from ramses_rf.device import (
     TrvActuator,
     UfhController,
 )
-from ramses_rf.entity_base import Child, Entity, Parent, class_by_attr
+from ramses_rf.entity_base import _ID_SLICE, Child, Entity, Parent, class_by_attr
 from ramses_rf.helpers import shrink
 from ramses_rf.schemas import (
     SCH_TCS_DHW,
@@ -728,13 +728,33 @@ class Zone(ZoneSchedule):
         """Set the target temperature, until the next scheduled setpoint."""
 
         if value is None:
-            return self.reset_mode()
+            self.reset_mode()
 
         cmd = Command.set_zone_setpoint(self.ctl.id, self.idx, value)
         self._gwy.send_cmd(cmd, priority=Priority.HIGH)
 
     @property
     def temperature(self) -> float | None:  # 30C9
+        if self._gwy.msg_db:
+            # evohome zones only get initial temp from src + idx, so use zone sensor if newer
+            sql = f"""
+                SELECT dtm from messages WHERE verb in (' I', 'RP')
+                AND code = '30C9'
+                AND (plk LIKE '%{SZ_TEMPERATURE}%')
+                AND ((src = ? AND ctx = ?) OR src = ?)
+            """
+            sensor_id = "aa:aaaaaa"  # should not match any device_id
+            if self._sensor:
+                sensor_id = self._sensor.id
+            # custom SQLite query on MessageIndex
+            msgs = self._gwy.msg_db.qry(
+                sql, (self.id[:_ID_SLICE], self.idx, sensor_id[:_ID_SLICE])
+            )
+            if msgs and len(msgs) > 0:
+                msgs_sorted = sorted(msgs, reverse=True)
+                return msgs_sorted[0].payload.get(SZ_TEMPERATURE)  # type: ignore[no-any-return]
+            return None
+        # else: TODO Q1 2026 remove remainder
         return self._msg_value(Code._30C9, key=SZ_TEMPERATURE)  # type: ignore[no-any-return]
 
     @property

ramses_rf/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.52.3
+Version: 0.52.5
 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
@@ -22,6 +22,7 @@ Description-Content-Type: text/markdown
 ![Linting](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-lint.yml/badge.svg)
 ![Typing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-type.yml/badge.svg)
 ![Testing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-test.yml/badge.svg)
+[![Coverage](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-cov.yml/badge.svg?event=push)](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-cov.yml)
 
 ## Overview
 

ramses_rf-0.52.5.dist-info/RECORD

@@ -0,0 +1,55 @@
+ramses_cli/__init__.py,sha256=uvGzWqOf4avvgzxJNSLFWEelIWqSZ-AeLAZzg5x58bc,397
+ramses_cli/client.py,sha256=h6liNKFXGsR2q9Unn81ushK53zqKgmkT0oAWNB5Jn0I,20369
+ramses_cli/debug.py,sha256=PLcz-3PjUiMVqtD_p6VqTA92eHUM58lOBFXh_qgQ_wA,576
+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=N3LxGe3_0pclijtmYW-ChqCuPTzbkoJA4XNAnoSnBk0,1806
+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=9nY1Wt2hjkBoDvDqopzPP3mPSH5-Q5XHPQuJnM2GHOw,21362
+ramses_rf/dispatcher.py,sha256=YjEU-QrBLo9IfoEhJo2ikg_FxOaMYoWvzelr9Vi-JZ8,11398
+ramses_rf/entity_base.py,sha256=Psa75zsZf6GOvXIv4c37vJDbg5iVQ1gQCADkBNOz1m8,58912
+ramses_rf/exceptions.py,sha256=mt_T7irqHSDKir6KLaf6oDglUIdrw0S40JbOrWJk5jc,3657
+ramses_rf/gateway.py,sha256=B7BlrNHx26lIHzjgy6-4NMtohb_GATaBuucgsUUxRj4,22005
+ramses_rf/helpers.py,sha256=TNk_QkpIOB3alOp1sqnA9LOzi4fuDCeapNlW3zTzNas,4250
+ramses_rf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ramses_rf/schemas.py,sha256=0_qQZSGj2ixq4UCtMxoAeWklOJiM4bbBUzMsPw8gUPw,13475
+ramses_rf/version.py,sha256=wV7QvKiXDL06V_DHo0XYcc-6CIYMlhztVGzCh1m45D8,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/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_tx/__init__.py,sha256=sqnjM7pUGJDmec6igTtKViSB8FLX49B5gwhAmcY9ERY,3596
+ramses_tx/address.py,sha256=IuwUwZxykn3fP1UCRcv4D-zbTICBe2FJjDAFX5X6VoI,9108
+ramses_tx/command.py,sha256=NeqWbdaWrXjP5KEZgXFicy_1UYOoUznRHN2ZfhVyDH0,125652
+ramses_tx/const.py,sha256=AMwHitDq115rB24f3fzclNGC4ArMW16DbqiFWQc0U5o,30306
+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/logger.py,sha256=1iKRHKUaqHqGd76CkE_6mCVR0sYODtxshRRwfY61fTk,10426
+ramses_tx/message.py,sha256=HUSNiBgGlnWEBeBqb4K28GcU5oB7RbS9a0JC2p9SGe4,13676
+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/protocol.py,sha256=ApA__ubfxM63c1OAxRcH6fhjMQTdC07SnSH9cGfWO2U,32427
+ramses_tx/protocol_fsm.py,sha256=ZKtehCr_4TaDdfdlfidFLJaOVTYtaEq5h4tLqNIhb9s,26827
+ramses_tx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ramses_tx/ramses.py,sha256=vp748Tf_a-56OMM8CWDA2ZktRfTuj0QVyPRcnsOstSM,53983
+ramses_tx/schemas.py,sha256=bqKW_V0bR6VbBD8ZQiBExNtVdXs0fryVKe3GEhupgIo,13424
+ramses_tx/transport.py,sha256=-Ikwj_Hy6JEnQPS9gBalV3H5AKQd3ATxKskR7Dy7_sE,59774
+ramses_tx/typed_dicts.py,sha256=w-0V5t2Q3GiNUOrRAWiW9GtSwbta_7luME6GfIb1zhI,10869
+ramses_tx/typing.py,sha256=eF2SlPWhNhEFQj6WX2AhTXiyRQVXYnFutiepllYl2rI,5042
+ramses_tx/version.py,sha256=j7HXmU97PXKJClRv1saySQ_JZYHAxBznxUTdWH64uHE,123
+ramses_rf-0.52.5.dist-info/METADATA,sha256=gGSPoi37fljrfFxDIVHXFUU5RuzGu6wwwD0JbvdwiVQ,4179
+ramses_rf-0.52.5.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+ramses_rf-0.52.5.dist-info/entry_points.txt,sha256=NnyK29baOCNg8DinPYiZ368h7MTH7bgTW26z2A1NeIE,50
+ramses_rf-0.52.5.dist-info/licenses/LICENSE,sha256=-Kc35W7l1UkdiQ4314_yVWv7vDDrg7IrJfMLUiq6Nfs,1074
+ramses_rf-0.52.5.dist-info/RECORD,,

{ramses_rf-0.52.3.dist-info → ramses_rf-0.52.5.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

ramses_tx/address.py

@@ -39,7 +39,12 @@ class Address:
     _SLUG = None
 
     def __init__(self, device_id: DeviceIdT) -> None:
-        """Create an address from a valid device id."""
+        """Create an address from a valid device ID.
+
+        :param device_id: The RAMSES II device ID (e.g., '01:123456')
+        :type device_id: DeviceIdT
+        :raises ValueError: If the device_id is not a valid format.
+        """
 
         # if device_id is None:
         #     device_id = NON_DEVICE_ID
@@ -91,7 +96,15 @@ class Address:
 
     @classmethod
     def convert_from_hex(cls, device_hex: str, friendly_id: bool = False) -> str:
-        """Convert (say) '06368E' to '01:145038' (or 'CTL:145038')."""
+        """Convert a 6-character hex string to a device ID.
+
+        :param device_hex: The hex string to convert (e.g., '06368E')
+        :type device_hex: str
+        :param friendly_id: If True, returns a named ID (e.g., 'CTL:145038'), defaults to False
+        :type friendly_id: bool
+        :return: The formatted device ID string
+        :rtype: str
+        """
 
         if device_hex == "FFFFFE":  # aka '63:262142'
             return ">null dev<" if friendly_id else ALL_DEVICE_ID
@@ -191,11 +204,13 @@ def is_valid_dev_id(value: str, dev_class: None | str = None) -> bool:
 
 @lru_cache(maxsize=256)  # there is definite benefit in caching this
 def pkt_addrs(addr_fragment: str) -> tuple[Address, Address, Address, Address, Address]:
-    """Return the address fields from (e.g): '01:078710 --:------ 01:144246'.
-
-    returns: src_addr, dst_addr, addr_0, addr_1, addr_2
+    """Parse address fields from a 30-character address fragment.
 
-    Will raise an InvalidAddrSetError if the address fields are not valid.
+    :param addr_fragment: The 30-char fragment (e.g., '01:078710 --:------ 01:144246')
+    :type addr_fragment: str
+    :return: A tuple of (src_addr, dst_addr, addr_0, addr_1, addr_2)
+    :rtype: tuple[Address, Address, Address, Address, Address]
+    :raises PacketAddrSetInvalid: If the address fields are not valid.
     """
     # for debug: print(pkt_addrs.cache_info())
 

ramses_tx/command.py

@@ -2254,7 +2254,13 @@ class Command(Frame):
 
     @classmethod  # constructor for RQ|2E04
     def get_system_mode(cls, ctl_id: DeviceIdT | str) -> Command:
-        """Constructor to get the mode of a system (c.f. parser_2e04)."""
+        """Get the mode of a system (c.f. parser_2e04).
+
+        :param ctl_id: The device ID of the controller
+        :type ctl_id: DeviceIdT | str
+        :return: A Command object for the RQ|2E04 message
+        :rtype: Command
+        """
 
         return cls.from_attrs(RQ, ctl_id, Code._2E04, FF)
 
@@ -2453,7 +2459,17 @@ class Command(Frame):
         datetime: dt | str,
         is_dst: bool = False,
     ) -> Command:
-        """Constructor to set the datetime of a system (c.f. parser_313f)."""
+        """Set the datetime of a system (c.f. parser_313f).
+
+        :param ctl_id: The device ID of the controller
+        :type ctl_id: DeviceIdT | str
+        :param datetime: The target date and time
+        :type datetime: dt | str
+        :param is_dst: Whether Daylight Saving Time is active, defaults to False
+        :type is_dst: bool
+        :return: A Command object for the W|313F message
+        :rtype: Command
+        """
         # .W --- 30:185469 01:037519 --:------ 313F 009 0060003A0C1B0107E5
 
         dt_str = hex_from_dtm(datetime, is_dst=is_dst, incl_seconds=True)

ramses_tx/const.py

@@ -440,7 +440,7 @@ DEV_TYPE_MAP = attr_dict_factory(
         ),  # CH/DHW devices instead of HVAC/other
         "HEAT_ZONE_SENSORS": ("00", "01", "03", "04", "12", "22", "34"),
         "HEAT_ZONE_ACTUATORS": ("00", "02", "04", "13"),
-        "THM_DEVICES": ("03", "12", "22", "34"),
+        "THM_DEVICES": ("03", "12", "21", "22", "34"),
         "TRV_DEVICES": ("00", "04"),
         "CONTROLLERS": ("01", "02", "12", "22", "23", "34"),  # potentially controllers
         "PROMOTABLE_SLUGS": (DevType.DEV, DevType.HEA, DevType.HVC),

ramses_tx/helpers.py

@@ -131,28 +131,36 @@ file_time = _FILE_TIME()
 def timestamp() -> float:
     """Return the number of seconds since the Unix epoch.
 
-    Return an accurate value, even for Windows-based systems.
+    This function attempts to return a high-precision value, using specific
+    system calls on Windows if available.
+    :return: The current timestamp in seconds.
+    :rtype: float
     """
 
     # see: https://www.python.org/dev/peps/pep-0564/
-    if sys.platform != "win32":  # since 1970-01-01T00:00:00Z, time.gmtime(0)
+    if sys.platform == "win32":
+        # Windows uses a different epoch (1601-01-01)
+        ctypes.windll.kernel32.GetSystemTimePreciseAsFileTime(ctypes.byref(file_time))
+        _time = (file_time.dwLowDateTime + (file_time.dwHighDateTime << 32)) / 1e7
+        return float(_time - 134774 * 24 * 60 * 60)
+    else:
+        # Linux/macOS uses the Unix epoch (1970-01-01)
         return time.time_ns() / 1e9
 
-    # otherwise, is since 1601-01-01T00:00:00Z
-    ctypes.windll.kernel32.GetSystemTimePreciseAsFileTime(ctypes.byref(file_time))  # type: ignore[unreachable]
-    _time = (file_time.dwLowDateTime + (file_time.dwHighDateTime << 32)) / 1e7
-    return _time - 134774 * 24 * 60 * 60
-
 
 def dt_now() -> dt:
     """Return 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.
+
+    :return: The current local datetime.
+    :rtype: dt
     """
     if sys.platform == "win32":
         return dt.fromtimestamp(timestamp())
-    return dt.now()
+    else:
+        return dt.now()
 
 
 def dt_str() -> str:
@@ -369,7 +377,14 @@ def hex_from_str(value: str) -> str:
 
 
 def hex_to_temp(value: HexStr4) -> bool | float | None:  # TODO: remove bool
-    """Convert a 2's complement 4-byte hex string to a float."""
+    """Convert a 4-byte 2's complement hex string to a float temperature ('C).
+
+    :param value: The 4-character hex string (e.g., '07D0')
+    :type value: HexStr4
+    :return: The temperature in Celsius, or None if N/A
+    :rtype: float | None
+    :raises ValueError: If input is not a 4-char hex string or temperature is invalid.
+    """
     if not isinstance(value, str) or len(value) != 4:
         raise ValueError(f"Invalid value: {value}, is not a 4-char hex string")
     if value == "31FF":  # means: N/A (== 127.99, 2s complement), signed?
@@ -488,13 +503,18 @@ AIR_QUALITY_BASIS: dict[str, str] = {
 
 # 31DA[2:6] and 12C8[2:6]
 def parse_air_quality(value: HexStr4) -> PayDictT.AIR_QUALITY:
-    """Return the air quality (%): poor (0.0) to excellent (1.0).
+    """Return the air quality percentage (0.0 to 1.0) and its basis.
 
     The basis of the air quality level should be one of: VOC, CO2 or relative humidity.
     If air_quality is EF, air_quality_basis should be 00.
 
     The sensor value is None if there is no sensor present (is not an error).
     The dict does not include the key if there is a sensor fault.
+
+    :param value: The 4-character hex string encoding quality and basis
+    :type value: HexStr4
+    :return: A dictionary containing the air quality and its basis (e.g., CO2, VOC)
+    :rtype: PayDictT.AIR_QUALITY
     """  # VOC: Volatile organic compounds
 
     # TODO: remove this as API used only internally...

ramses_tx/message.py

@@ -54,7 +54,9 @@ class MessageBase:
     def __init__(self, pkt: Packet) -> None:
         """Create a message from a valid packet.
 
-        :raises InvalidPacketError if message payload is invalid.
+        :param pkt: The packet to process into a message
+        :type pkt: Packet
+        :raises PacketInvalid: If the packet payload cannot be parsed.
         """
 
         self._pkt = pkt
@@ -359,10 +361,14 @@ def re_compile_re_match(regex: str, string: str) -> bool:  # Optional[Match[Any]
 
 
 def _check_msg_payload(msg: MessageBase, payload: str) -> None:
-    """Validate the packet's payload against its verb/code pair.
-
-    :raises InvalidPayloadError if the payload is seen as invalid. Such payloads may
-    actually be valid, in which case the rules (likely the regex) will need updating.
+    """Validate a packet's payload against its verb/code pair.
+
+    :param msg: The message object being validated
+    :type msg: MessageBase
+    :param payload: The raw hex payload string
+    :type payload: str
+    :raises PacketInvalid: If the code is unknown or verb/code pair is invalid.
+    :raises PacketPayloadInvalid: If the payload does not match the expected regex.
     """
 
     _ = repr(msg._pkt)  # HACK: ? raise InvalidPayloadError

ramses_tx/packet.py

@@ -48,9 +48,14 @@ class Packet(Frame):
     _rssi: str
 
     def __init__(self, dtm: dt, frame: str, **kwargs: Any) -> None:
-        """Create a packet from a string (actually from f"{RSSI} {frame}").
-
-        Will raise InvalidPacketError if it is invalid.
+        """Create a packet from a raw frame string.
+
+        :param dtm: The timestamp when the packet was received
+        :type dtm: dt
+        :param frame: The raw frame string, typically including RSSI
+        :type frame: str
+        :param kwargs: Metadata including 'comment', 'err_msg', or 'raw_frame'
+        :raises PacketInvalid: If the frame content is malformed.
         """
 
         super().__init__(frame[4:])  # remove RSSI
@@ -156,9 +161,12 @@ class Packet(Frame):
 
 # TODO: remove None as a possible return value
 def pkt_lifespan(pkt: Packet) -> td:  # import OtbGateway??
-    """Return the pkt lifespan, or dt.max() if the packet does not expire.
+    """Return the lifespan of a packet before it expires.
 
-    Some codes require a valid payload to best determine lifespan (e.g. 1F09).
+    :param pkt: The packet instance to evaluate
+    :type pkt: Packet
+    :return: The duration the packet's data remains valid
+    :rtype: td
     """
 
     if pkt.verb in (RQ, W_):