ramses-rf 0.52.4__tar.gz → 0.52.5__tar.gz

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/.github/workflows/publish-hatch.yml

@@ -26,7 +26,7 @@ jobs:
         run: hatch build
 
       - name: Upload dist
-        uses: actions/upload-artifact@v5
+        uses: actions/upload-artifact@v6
         with:
           name: dist
           path: dist/
@@ -40,7 +40,7 @@ jobs:
       url: https://pypi.org/project/ramses_rf
     steps:
       - name: Download dist
-        uses: actions/download-artifact@v6
+        uses: actions/download-artifact@v7
         with:
           name: dist
           path: dist/

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.52.4
+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

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_cli/client.py

@@ -588,6 +588,7 @@ def main() -> None:
         print(" - event_loop_policy set for win32")  # do before asyncio.run()
         asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy())
 
+    profile = None
     try:
         if _PROFILE_LIBRARY:
             profile = cProfile.Profile()

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_cli/debug.py

@@ -9,7 +9,7 @@ DEBUG_PORT = 5678
 
 
 def start_debugging(wait_for_client: bool) -> None:
-    import debugpy  # type: ignore[import-untyped]
+    import debugpy
 
     debugpy.listen(address=(DEBUG_ADDR, DEBUG_PORT))
     print(f" - Debugging is enabled, listening on: {DEBUG_ADDR}:{DEBUG_PORT}")

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_cli/utils/convert.py

@@ -17,7 +17,7 @@ parser.add_argument("-i", "--input-file", type=argparse.FileType("r"), default="
 args = parser.parse_args()
 
 
-def convert_json_to_yaml(data: dict) -> str:
+def convert_json_to_yaml(data: dict) -> None:
     """Convert from json (client.py -C config.json) to yaml (HA configuration.yaml)."""
     (config, schema, include, exclude) = load_config("/dev/ttyMOCK", None, **data)
 
@@ -37,7 +37,7 @@ def convert_json_to_yaml(data: dict) -> str:
     print(yaml.dump({"ramses_cc": result}, sort_keys=False))
 
 
-def convert_yaml_to_json(data: dict) -> str:
+def convert_yaml_to_json(data: dict) -> None:
     """Convert from yaml (HA configuration.yaml) to json (client.py -C config.json)."""
 
     result = data["ramses_cc"]

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/database.py

@@ -30,7 +30,7 @@ from collections import OrderedDict
 from datetime import datetime as dt, timedelta as td
 from typing import TYPE_CHECKING, Any, NewType
 
-from ramses_tx import CODES_SCHEMA, Code, Message
+from ramses_tx import CODES_SCHEMA, RQ, Code, Message, Packet
 
 if TYPE_CHECKING:
     DtmStrT = NewType("DtmStrT", str)
@@ -155,7 +155,7 @@ class MessageIndex:
             - verb " I", "RQ" etc.
             - src  message origin address
             - dst  message destination address
-            - code packet code aka command class e.g. _0005, _31DA
+            - code packet code aka command class e.g. 0005, 31DA
             - ctx  message context, created from payload as index + extra markers (Heat)
             - hdr  packet header e.g. 000C|RP|01:223036|0208 (see: src/ramses_tx/frame.py)
             - plk the keys stored in the parsed payload, separated by the | char
@@ -187,7 +187,7 @@ class MessageIndex:
 
     async def _housekeeping_loop(self) -> None:
         """Periodically remove stale messages from the index,
-        unless `self.maintain` is False."""
+        unless `self.maintain` is False - as in (most) tests."""
 
         async def housekeeping(dt_now: dt, _cutoff: td = td(days=1)) -> None:
             """
@@ -195,7 +195,8 @@ class MessageIndex:
             :param dt_now: current timestamp
             :param _cutoff: the oldest timestamp to retain, default is 24 hours ago
             """
-            dtm = dt_now - _cutoff  # .isoformat(timespec="microseconds") < needed?
+            msgs = None
+            dtm = dt_now - _cutoff
 
             self._cu.execute("SELECT dtm FROM messages WHERE dtm >= ?", (dtm,))
             rows = self._cu.fetchall()  # fetch dtm of current messages to retain
@@ -212,6 +213,10 @@ class MessageIndex:
                 self._msgs = msgs
             finally:
                 self._lock.release()
+                if msgs:
+                    _LOGGER.debug(
+                        "MessageIndex size was: %d, now: %d", len(rows), len(msgs)
+                    )
 
         while True:
             self._last_housekeeping = dt.now()
@@ -246,13 +251,17 @@ class MessageIndex:
         else:
             # _msgs dict requires a timestamp reformat
             dtm: DtmStrT = msg.dtm.isoformat(timespec="microseconds")  # type: ignore[assignment]
+            # add msg to self._msgs dict
             self._msgs[dtm] = msg
 
         finally:
             pass  # self._lock.release()
 
         if (
-            dup and msg.src is not msg.dst and not msg.dst.id.startswith("18:")  # HGI
+            dup
+            and (msg.src is not msg.dst)
+            and not msg.dst.id.startswith("18:")  # HGI
+            and msg.verb != RQ  # these may come very quickly
         ):  # when src==dst, expect to add duplicate, don't warn
             _LOGGER.debug(
                 "Overwrote dtm (%s) for %s: %s (contrived log?)",
@@ -260,8 +269,6 @@ class MessageIndex:
                 msg._pkt._hdr,
                 dup[0]._pkt,
             )
-        if old is not None:
-            _LOGGER.debug("Old msg replaced: %s", old)
 
         return old
 
@@ -274,7 +281,8 @@ class MessageIndex:
         :param verb: two letter verb str to use
         """
         # Used by OtbGateway init, via entity_base.py
-        dtm: DtmStrT = dt.strftime(dt.now(), "%Y-%m-%dT%H:%M:%S")  # type: ignore[assignment]
+        _now: dt = dt.now()
+        dtm: DtmStrT = _now.isoformat(timespec="microseconds")  # type: ignore[assignment]
         hdr = f"{code}|{verb}|{src}|00"  # dummy record has no contents
 
         dup = self._delete_from(hdr=hdr)
@@ -287,7 +295,7 @@ class MessageIndex:
             self._cu.execute(
                 sql,
                 (
-                    dtm,
+                    _now,
                     verb,
                     src,
                     src,
@@ -299,6 +307,14 @@ class MessageIndex:
             )
         except sqlite3.Error:
             self._cx.rollback()
+        else:
+            # also add dummy 3220 msg to self._msgs dict to allow maintenance loop
+            msg: Message = Message._from_pkt(
+                Packet(
+                    _now, f"... {verb} --- {src} --:------ {src} {code} 005 0000000000"
+                )
+            )
+            self._msgs[dtm] = msg
 
         if dup:  # expected when more than one heat system in schema
             _LOGGER.debug("Replaced record with same hdr: %s", hdr)
@@ -359,7 +375,7 @@ class MessageIndex:
         if not bool(msg) ^ bool(kwargs):
             raise ValueError("Either a Message or kwargs should be provided, not both")
         if msg:
-            kwargs["dtm"] = msg.dtm  # .isoformat(timespec="microseconds")
+            kwargs["dtm"] = msg.dtm
 
         msgs = None
         try:  # make this operation atomic, i.e. update self._msgs only on success
@@ -410,7 +426,7 @@ class MessageIndex:
             raise ValueError("Either a Message or kwargs should be provided, not both")
 
         if msg:
-            kwargs["dtm"] = msg.dtm  # .isoformat(timespec="microseconds")
+            kwargs["dtm"] = msg.dtm
 
         return self._select_from(**kwargs)
 
@@ -432,10 +448,15 @@ class MessageIndex:
         :returns: a tuple of qualifying messages
         """
 
-        return tuple(
-            self._msgs[row[0].isoformat(timespec="microseconds")]
-            for row in self.qry_dtms(**kwargs)
-        )
+        # CHANGE: Use a list comprehension with a check to avoid KeyError
+        res: list[Message] = []
+        for row in self.qry_dtms(**kwargs):
+            ts: DtmStrT = row[0].isoformat(timespec="microseconds")
+            if ts in self._msgs:
+                res.append(self._msgs[ts])
+            else:
+                _LOGGER.debug("MessageIndex timestamp %s not in device messages", ts)
+        return tuple(res)
 
     def qry_dtms(self, **kwargs: bool | dt | str) -> list[Any]:
         """
@@ -487,6 +508,7 @@ class MessageIndex:
             # _msgs stamp format: 2022-09-08T13:40:52.447364
             if ts in self._msgs:
                 lst.append(self._msgs[ts])
+                # _LOGGER.debug("MessageIndex ts %s added to qry.lst", ts)  # too frequent
             else:  # happens in tests with artificial msg from heat
                 _LOGGER.info("MessageIndex timestamp %s not in device messages", ts)
         return tuple(lst)
@@ -550,8 +572,9 @@ class MessageIndex:
             if ts in self._msgs:
                 # if include_expired or not self._msgs[ts].HAS_EXPIRED:  # not working
                 lst.append(self._msgs[ts])
-            else:  # happens in tests with dummy msg from heat init
-                _LOGGER.info("MessageIndex ts %s not in device messages", ts)
+                _LOGGER.debug("MessageIndex ts %s added to all.lst", ts)
+            else:  # happens in tests and real evohome setups with dummy msg from heat init
+                _LOGGER.debug("MessageIndex ts %s not in device messages", ts)
         return tuple(lst)
 
     def clr(self) -> None:

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/device/base.py

@@ -87,9 +87,10 @@ class DeviceBase(Entity):
         return self.id < other.id  # type: ignore[no-any-return]
 
     def _update_traits(self, **traits: Any) -> None:
-        """Update a device with new schema attrs.
+        """Update a device with new schema attributes.
 
-        Raise an exception if the new schema is not a superset of the existing schema.
+        :param traits: The traits to apply (e.g., alias, class, faked)
+        :raises TypeError: If the device is not fakeable but 'faked' is set.
         """
 
         traits = shrink(SCH_TRAITS(traits))
@@ -342,7 +343,17 @@ class Fakeable(DeviceBase):
         idx: IndexT = "00",
         require_ratify: bool = False,
     ) -> tuple[Packet, Packet, Packet, Packet | None]:
-        """Listen for a binding and return the Offer, or raise an exception."""
+        """Listen for a binding and return the Offer packets.
+
+        :param accept_codes: The codes allowed for this binding
+        :type accept_codes: Iterable[Code]
+        :param idx: The index to bind to, defaults to "00"
+        :type idx: IndexT
+        :param require_ratify: Whether a ratification step is required, defaults to False
+        :type require_ratify: bool
+        :return: A tuple of the four binding transaction packets
+        :rtype: tuple[Packet, Packet, Packet, Packet | None]
+        """
 
         if not self._bind_context:
             raise TypeError(f"{self}: Faking not enabled")

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/device/heat.py

@@ -669,7 +669,7 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
 
         # TODO(eb): cleanup
         if self._gwy.msg_db:
-            self._add_record(address=self.addr, code=Code._3220, verb="RP")
+            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:

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/device/hvac.py

@@ -921,27 +921,30 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
 
         :return: string describing fan mode, speed
         """
-        if self._gwy.msg_db:
-            # Use SQLite query on MessageIndex. res_rate/res_mode not exposed yet
-            sql = f"""
-                SELECT code from messages WHERE verb in (' I', 'RP')
-                AND (src = ? OR dst = ?)
-                AND (plk LIKE '%{SZ_FAN_MODE}%')
-            """
-            res_mode: list = self._msg_qry(sql)
-            # SQLite query on MessageIndex
-            _LOGGER.debug(f"{res_mode} # FAN_MODE FETCHED from MessageIndex")
-
-            sql = f"""
-                SELECT code from messages WHERE verb in (' I', 'RP')
-                AND (src = ? OR dst = ?)
-                AND (plk LIKE '%{SZ_FAN_RATE}%')
-            """
-            res_rate: list = self._msg_qry(sql)
-            # SQLite query on MessageIndex
-            _LOGGER.debug(
-                f"{res_rate} # FAN_RATE FETCHED from MessageIndex"
-            )  # DEBUG always empty?
+        # if self._gwy.msg_db:
+        # Use SQLite query on MessageIndex. res_rate/res_mode not exposed yet
+        # working fine in 0.52.4, no need to specify code, only payload key
+        # sql = f"""
+        #     SELECT code from messages WHERE verb in (' I', 'RP')
+        #     AND (src = ? OR dst = ?)
+        #     AND (plk LIKE '%{SZ_FAN_MODE}%')
+        # """
+        # res_mode: list = self._msg_qry(sql)
+        # # SQLite query on MessageIndex
+        # _LOGGER.debug(
+        #     f"# Fetched FAN_MODE for {self.id} from MessageIndex: {res_mode}"
+        # )
+
+        # sql = f"""
+        #     SELECT code from messages WHERE verb in (' I', 'RP')
+        #     AND (src = ? OR dst = ?)
+        #     AND (plk LIKE '%{SZ_FAN_RATE}%')
+        # """
+        # res_rate: list = self._msg_qry(sql)
+        # # SQLite query on MessageIndex
+        # _LOGGER.debug(
+        #     f"# Fetched FAN_RATE for {self.id} from MessageIndex: {res_rate}"
+        # )
 
         if Code._31D9 in self._msgs:
             # was a dict by Code

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/entity_base.py

@@ -15,7 +15,7 @@ from types import ModuleType
 from typing import TYPE_CHECKING, Any, Final
 
 from ramses_rf.helpers import schedule_task
-from ramses_tx import Address, Priority, QosParams
+from ramses_tx import Priority, QosParams
 from ramses_tx.address import ALL_DEVICE_ID
 from ramses_tx.const import MsgId
 from ramses_tx.opentherm import OPENTHERM_MESSAGES
@@ -247,7 +247,7 @@ class _MessageDB(_Entity):
 
         if self._gwy.msg_db:  # central SQLite MessageIndex
             _LOGGER.debug(
-                "For %s (_z_id %s) add msg %s, src %s, dst %s to msg_db.",
+                "For %s (_z_id %s) add to msg_db: %s, src %s, dst %s",
                 self.id,
                 self._z_id,
                 msg,
@@ -324,12 +324,12 @@ class _MessageDB(_Entity):
         ]
 
     def _add_record(
-        self, address: Address, code: Code | None = None, verb: str = " I"
+        self, id: DeviceIdT, code: Code | None = None, verb: str = " I"
     ) -> None:
         """Add a (dummy) record to the central SQLite MessageIndex."""
         # used by heat.py init
         if self._gwy.msg_db:
-            self._gwy.msg_db.add_record(str(address), code=str(code), verb=verb)
+            self._gwy.msg_db.add_record(id, code=str(code), verb=verb)
         # else:
         #     _LOGGER.warning("Missing MessageIndex")
         # raise NotImplementedError
@@ -1029,7 +1029,7 @@ class _Discovery(_MessageDB):
                         sql = """
                             SELECT dtm from messages WHERE
                             code = ?
-                            AND verb = ' I'
+                            AND verb in (' I', 'RP')
                             AND ctx = 'True'
                             AND (src = ? OR dst = ?)
                         """
@@ -1045,7 +1045,7 @@ class _Discovery(_MessageDB):
                             msgs += res[0]  # expect 1 Message in returned tuple
                         else:
                             _LOGGER.debug(
-                                f"No msg found for hdr {hdr}, tesk code {task[_SZ_COMMAND].code}"
+                                f"No msg found for hdr {hdr}, task code {task[_SZ_COMMAND].code}"
                             )
                     else:  # TODO(eb) remove next Q1 2026
                         msgs += [self.tcs._msgz[task[_SZ_COMMAND].code][I_][True]]

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/gateway.py

@@ -360,13 +360,25 @@ class Gateway(Engine):
         child_id: str | None = None,
         is_sensor: bool | None = None,
     ) -> Device:  # TODO: **schema/traits) -> Device:  # may: LookupError
-        """Return a device, create it if required.
-
-        First, use the traits to create/update it, then pass it any msg to handle.
-        All devices have traits, but only controllers (CTL, UFC) have a schema.
-
-        Devices are uniquely identified by a device id.
-        If a device is created, attach it to the gateway.
+        """Return a device, creating it if it does not already exist.
+
+        This method uses provided traits to create or update a device and optionally
+        passes a message for it to handle. All devices have traits, but only
+        controllers (CTL, UFC) have a schema.
+
+        :param device_id: The unique identifier for the device (e.g., '01:123456')
+        :type device_id: DeviceIdT
+        :param msg: An optional initial message for the device to process, defaults to None
+        :type msg: Message | None
+        :param parent: The parent entity of this device, if any, defaults to None
+        :type parent: Parent | None
+        :param child_id: The specific ID of the child component if applicable, defaults to None
+        :type child_id: str | None
+        :param is_sensor: Indicates if this device should be treated as a sensor, defaults to None
+        :type is_sensor: bool | None
+        :return: The existing or newly created device instance
+        :rtype: Device
+        :raises LookupError: If the device ID is blocked or not in the allowed known_list.
         """
 
         def check_filter_lists(dev_id: DeviceIdT) -> None:  # may: LookupError
@@ -620,9 +632,8 @@ class Gateway(Engine):
         If wait_for_reply is True (*and* the Command has a rx_header), return the
         reply Packet. Otherwise, simply return the echo Packet.
 
-        If the expected Packet can't be returned, raise:
-            ProtocolSendFailed: tried to Tx Command, but didn't get echo/reply
-            ProtocolError:      didn't attempt to Tx Command for some reason
+        :raises ProtocolSendFailed: If the command was sent but no reply/echo was received.
+        :raises ProtocolError: If the system failed to attempt the transmission.
         """
 
         return await super().async_send_cmd(

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/ramses_rf/schemas.py

@@ -285,7 +285,7 @@ SCH_GLOBAL_CONFIG = (
 #
 # 6/7: External Schemas, to be used by clients of this library
 def NormaliseRestoreCache() -> Callable[[bool | dict[str, bool]], dict[str, bool]]:
-    """Convert a short-hand restore_cache bool to a dict.
+    """Convert a shorthand restore_cache bool to a dict.
 
     restore_cache: bool ->  restore_cache:
                               restore_schema: bool

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/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-0.52.4 → ramses_rf-0.52.5}/ramses_rf/version.py

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

{ramses_rf-0.52.4 → ramses_rf-0.52.5}/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_rf-0.52.4 → ramses_rf-0.52.5}/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_rf-0.52.4 → ramses_rf-0.52.5}/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...