ramses-rf 0.51.6__py3-none-any.whl → 0.51.8__py3-none-any.whl

ramses_tx/helpers.py

@@ -470,7 +470,7 @@ def parse_valve_demand(
     if int(value, 16) & 0xF0 == 0xF0:
         return _faulted_device(SZ_HEAT_DEMAND, value)
 
-    result = int(value, 16) / 200  # c.f. hex_to_percentage
+    result = int(value, 16) / 200  # c.f. hex_to_percent
     if result == 1.01:  # HACK - does it mean maximum?
         result = 1.0
     elif result > 1.0:
@@ -606,12 +606,9 @@ def _parse_hvac_humidity(
     if int(value, 16) & 0xF0 == 0xF0:
         return _faulted_sensor(param_name, value)
 
-    percentage = int(value, 16) / 100  # TODO: confirm not 200
-    assert percentage <= 1.0, value  # TODO: raise exception if > 1.0?
+    percentage = hex_to_percent(value, False)  # TODO: confirm not /200
 
-    result: dict[str, float | str | None] = {
-        param_name: percentage
-    }  # was: percent_from_hex(value, high_res=False)
+    result: dict[str, float | str | None] = {param_name: percentage}
     if temp:
         result |= {SZ_TEMPERATURE: hex_to_temp(temp)}
     if dewpoint:
@@ -790,9 +787,9 @@ def fan_info_to_byte(info: str) -> int:
 
 def fan_info_flags(flags_list: list[int]) -> int:
     flag_res: int = 0
-    for index, shft in enumerate(range(7, 4, -1)):  # index = 7, 6 and 5
+    for index, shift in enumerate(range(7, 4, -1)):  # index = 7, 6 and 5
         if flags_list[index] == 1:
-            flag_res |= 1 << shft  # set bits
+            flag_res |= 1 << shift  # set bits
     return flag_res
 
 
@@ -881,7 +878,7 @@ def _parse_fan_heater(param_name: str, value: HexStr2) -> Mapping[str, float | N
     if int(value, 16) & 0xF0 == 0xF0:
         return _faulted_sensor(param_name, value)  # type: ignore[return-value]
 
-    percentage = int(value, 16) / 200  # Siber DF EVO 2 is /200, not /100 (?Others)
+    percentage = int(value, 16) / 200  # Siber DF EVO 2 is /200, not /100 (Others?)
     assert percentage <= 1.0, value  # TODO: raise exception if > 1.0?
 
     return {param_name: percentage}  # was: percent_from_hex(value, high_res=False)

ramses_tx/logger.py

@@ -173,33 +173,6 @@ class TimedRotatingFileHandler(_TimedRotatingFileHandler):
     #         self.doRollover()
     #     return super().emit(record)
 
-    # To fix issue ramses_cc 293, test if this override is still required
-    # async def getFilesToDelete(self) -> list[str]:  # zxdavb: my version
-    #     """Determine the files to delete when rolling over.
-    #
-    #     Overridden as old log files were not being deleted.
-    #     """
-    #     # See bpo-44753 (this code is as was before that commit), bpo45628, bpo-46063
-    #     dirName, baseName = os.path.split(self.baseFilename)
-    #     loop = asyncio.get_running_loop()
-    #     # Must run async in executor to prevent HA blocking call on rollover (ramses_cc issue 293)
-    #     file_names = await loop.run_in_executor(None, os.listdir, dirName) < doesn't work
-    #
-    #     result = []
-    #     prefix = baseName + "."
-    #     plen = len(prefix)
-    #     for fileName in file_names:
-    #         if fileName[:plen] == prefix:
-    #             suffix = fileName[plen:]
-    #             if self.extMatch.match(suffix):
-    #                 result.append(os.path.join(dirName, fileName))
-    #     if len(result) < self.backupCount:
-    #         result = []
-    #     else:
-    #         result.sort()
-    #         result = result[: len(result) - self.backupCount]
-    #     return result
-
 
 def getLogger(  # permits a bespoke Logger class
     name: str | None = None, pkt_log: bool = False

ramses_tx/parsers.py

@@ -1391,15 +1391,18 @@ def parser_2210(payload: str, msg: Message) -> dict[str, Any]:
             "02",  # requested by CO2 level/sensor
             "03",  # requested by humidity level/sensor
         ), f"expected req_reason (00|02|03), not {payload[20:22]}"
-        assert payload[78:80] in ("00", "02"), (
-            f"expected byte 39 (00|02), not {payload[78:80]}"
-        )
-        assert payload[80:82] in ("01", "08"), (
-            f"expected byte 40 (01|08), not {payload[80:82]}"
-        )
-        assert payload[82:] in ("00", "40"), (
-            f"expected byte 41- (00|40), not {payload[82:]}"
-        )
+        assert payload[78:80] in (
+            "00",
+            "02",
+        ), f"expected byte 39 (00|02), not {payload[78:80]}"
+        assert payload[80:82] in (
+            "01",
+            "08",
+        ), f"expected byte 40 (01|08), not {payload[80:82]}"
+        assert payload[82:] in (
+            "00",
+            "40",
+        ), f"expected byte 41- (00|40), not {payload[82:]}"
 
     except AssertionError as err:
         _LOGGER.warning(f"{msg!r} < {_INFORM_DEV_MSG} ({err})")
@@ -1648,21 +1651,17 @@ def parser_22f3(payload: str, msg: Message) -> dict[str, Any]:
         _LOGGER.warning(f"{msg!r} < {_INFORM_DEV_MSG} ({err})")
 
     new_speed = {  # from now, until timer expiry
-        0x00: "fan_boost",  # #    set fan off, or 'boost' mode?
-        0x01: "per_request",  # #  set fan as per payload[6:10]?
-        0x02: "per_vent_speed",  # set fan as per current fan mode/speed?
+        0x00: "fan_boost",  # set fan off, or 'boost' mode?
+        0x01: "per_request?",  # set fan as per payload[6:10]?
+        0x02: "per_request",  # set fan as per payload[6:10]
     }.get(int(payload[2:4], 0x10) & 0x07)  # 0b0000-0111
 
-    fallback_speed: str | None
-    if msg.len == 7 and payload[9:10] == "06":  # Vasco and ClimaRad REM
-        fallback_speed = "per_vent_speed"  # after timer expiry
-        # set fan as per current fan mode/speed
-    else:
-        fallback_speed = {  # after timer expiry
-            0x08: "fan_off",  # #      set fan off?
-            0x10: "per_request",  # #  set fan as per payload[6:10], or payload[10:]?
-            0x18: "per_vent_speed",  # set fan as per current fan mode/speed?
-        }.get(int(payload[2:4], 0x10) & 0x38)  # 0b0011-1000
+    fallback_speed = {  # after timer expiry
+        0x00: "per_vent_speed",  # set fan as per current fan mode
+        0x08: "fan_off",  # set fan off?
+        0x10: "per_request",  # set fan as per payload[10:14]
+        0x18: "per_vent_speed?",  # set fan as per current fan mode/speed?
+    }.get(int(payload[2:4], 0x10) & 0x38)  # 0b0011-1000
 
     units = {
         0x00: "minutes",
@@ -1677,15 +1676,21 @@ def parser_22f3(payload: str, msg: Message) -> dict[str, Any]:
         result = {
             "minutes" if units != "index" else "index": duration,
             "flags": hex_to_flag8(payload[2:4]),
-            "_new_speed_mode": new_speed,
-            "_fallback_speed_mode": fallback_speed,
+            "new_speed_mode": new_speed,
+            "fallback_speed_mode": fallback_speed,
         }
 
-    if msg.len >= 5 and payload[6:10] != "0000":  # new speed?
-        result["rate"] = parser_22f1(f"00{payload[6:10]}", msg).get("rate")
+    if msg._addrs[0] == NON_DEV_ADDR and msg.len <= 3:
+        result["_scheme"] = "itho"
+
+    if msg.len >= 5 and payload[6:10] != "0000":  # new speed
+        mode_info = parser_22f1(f"00{payload[6:10]}", msg)
+        result["_scheme"] = mode_info.get("_scheme")
+        result["fan_mode"] = mode_info.get("fan_mode")
 
-    if msg.len >= 7:  # fallback speed?
-        result.update({"_unknown_5": payload[10:]})
+    if msg.len >= 7 and payload[10:14] != "0000":  # fallback speed
+        mode_info = parser_22f1(f"00{payload[10:14]}", msg)
+        result["fallback_fan_mode"] = mode_info.get("fan_mode")
 
     return result
 

ramses_tx/protocol.py

@@ -332,7 +332,7 @@ class _DeviceIdFilterMixin(_BaseProtocol):
         /,
         *,
         disable_warnings: bool = False,
-        strick_checking: bool = False,
+        strict_checking: bool = False,
     ) -> DeviceIdT | None:
         """Return the device_id of the gateway specified in the include_list, if any.
 
@@ -384,7 +384,7 @@ class _DeviceIdFilterMixin(_BaseProtocol):
                 f"The {SZ_KNOWN_LIST} includes exactly one gateway (HGI): {known_hgi}"
             )
 
-        if strick_checking:
+        if strict_checking:
             return known_hgi if [known_hgi] == explicit_hgis else None
         return known_hgi
 

ramses_tx/protocol_fsm.py

@@ -291,7 +291,7 @@ class ProtocolContext:
         # may want to set some instance variables, according to type of transport
         self._state.connection_made()
 
-    # TODO: Should we clear the buffer if connection is lost (and apoligise to senders?
+    # TODO: Should we clear the buffer if connection is lost (and apologise to senders?
     def connection_lost(self, err: ExceptionT | None) -> None:
         self._state.connection_lost()
 

ramses_tx/ramses.py

@@ -223,7 +223,7 @@ CODES_SCHEMA: dict[Code, dict[str, Any]] = {  # rf_unknown
         SZ_NAME: "device_info",
         I_: r"^(00|FF)([0-9A-F]{30,})?$",  # r"^[0-9A-F]{32,}$" might be OK
         RQ: r"^00$",  # NOTE: 63 seen (no RP), some devices will accept [0-9A-F]{2}
-        # RP: r"^[0-9A-F]{2}([0-9A-F]){30,}$",  # NOTE: indx same as RQ
+        # RP: r"^[0-9A-F]{2}([0-9A-F]){30,}$",  # NOTE: index same as RQ
         SZ_LIFESPAN: False,
     },
     Code._10E1: {  # device_id
@@ -480,6 +480,7 @@ CODES_SCHEMA: dict[Code, dict[str, Any]] = {  # rf_unknown
         SZ_NAME: "fan_params",
         I_: r"^(00|01|15|16|17|21)00[0-9A-F]{6}([0-9A-F]{8}){4}[0-9A-F]{4}$",
         RQ: r"^(00|01|15|16|17|21)00[0-9A-F]{2}((00){19})?$",
+        RP: r"^(00|01|15|16|17|21)00[0-9A-F]{6}[0-9A-F]{8}(([0-9A-F]{8}){3}[0-9A-F]{4})?$",
         W_: r"^(00|01|15|16|17|21)00[0-9A-F]{6}[0-9A-F]{8}(([0-9A-F]{8}){3}[0-9A-F]{4})?$",
     },
     Code._2420: {  # unknown_2420, from OTB
@@ -1220,6 +1221,7 @@ SZ_MIN_VALUE: Final = "min_value"
 SZ_MAX_VALUE: Final = "max_value"
 SZ_PRECISION: Final = "precision"
 SZ_DATA_TYPE: Final = "data_type"
+SZ_DATA_UNIT: Final = "data_unit"
 
 _22F1_MODE_ITHO: dict[str, str] = {
     "00": "off",  # not seen
@@ -1265,12 +1267,13 @@ _22F1_SCHEMES: dict[str, dict[str, str]] = {
 
 # unclear if true for only Orcon/*all* models
 _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
-    "31": {  # slot 09
+    "31": {  # slot 09 (FANs produced after 2021)
         SZ_DESCRIPTION: "Time to change filter (days)",
         SZ_MIN_VALUE: 0,
         SZ_MAX_VALUE: 1800,
         SZ_PRECISION: 30,
         SZ_DATA_TYPE: "10",
+        SZ_DATA_UNIT: "days",
     },
     "3D": {  # slot 00
         SZ_DESCRIPTION: "Away mode Supply fan rate (%)",
@@ -1278,6 +1281,7 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 0.4,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "3E": {  # slot 01
         SZ_DESCRIPTION: "Away mode Exhaust fan rate (%)",
@@ -1285,6 +1289,7 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 0.4,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "3F": {  # slot 02
         SZ_DESCRIPTION: "Low mode Supply fan rate (%)",
@@ -1292,6 +1297,7 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 0.8,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "40": {  # slot 03
         SZ_DESCRIPTION: "Low mode Exhaust fan rate (%)",
@@ -1299,13 +1305,15 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 0.8,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "41": {  # slot 04
         SZ_DESCRIPTION: "Medium mode Supply fan rate (%)",
-        SZ_MIN_VALUE: 0.0,
+        SZ_MIN_VALUE: 0.1,  # Orcon FAN responds with 0.0, but I guess this should be the same as for "42"
         SZ_MAX_VALUE: 1.0,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "42": {  # slot 05
         SZ_DESCRIPTION: "Medium mode Exhaust fan rate (%)",
@@ -1313,13 +1321,15 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 1.0,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "43": {  # slot 06
         SZ_DESCRIPTION: "High mode Supply fan rate (%)",
-        SZ_MIN_VALUE: 0.0,
+        SZ_MIN_VALUE: 0.1,
         SZ_MAX_VALUE: 1.0,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
     "44": {  # slot 07
         SZ_DESCRIPTION: "High mode Exhaust fan rate (%)",
@@ -1327,6 +1337,15 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 1.0,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
+    },
+    "4B": {  # slot 09 (FANs produced before 2021) Also check code 22F7
+        SZ_DESCRIPTION: "(Test) Bypass Valve (0=auto, 1=open, 2=closed)",
+        SZ_MIN_VALUE: 0,
+        SZ_MAX_VALUE: 2,
+        SZ_PRECISION: 1,
+        SZ_DATA_TYPE: "00",
+        SZ_DATA_UNIT: "",
     },
     "4E": {  # slot 0A
         SZ_DESCRIPTION: "Moisture scenario position (0=medium, 1=high)",
@@ -1334,13 +1353,15 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 1,
         SZ_PRECISION: 1,
         SZ_DATA_TYPE: "00",
+        SZ_DATA_UNIT: "",
     },
     "52": {  # slot 0B
         SZ_DESCRIPTION: "Sensor sensitivity (%)",
         SZ_MIN_VALUE: 0,
         SZ_MAX_VALUE: 25.0,
         SZ_PRECISION: 0.1,
-        SZ_DATA_TYPE: "0F",
+        SZ_DATA_TYPE: "01",
+        SZ_DATA_UNIT: "%",
     },
     "54": {  # slot 0C
         SZ_DESCRIPTION: "Moisture sensor overrun time (mins)",
@@ -1348,13 +1369,15 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 60,
         SZ_PRECISION: 1,
         SZ_DATA_TYPE: "00",
+        SZ_DATA_UNIT: "min",
     },
     "75": {  # slot 0D
         SZ_DESCRIPTION: "Comfort temperature (°C)",
         SZ_MIN_VALUE: 0.0,
         SZ_MAX_VALUE: 30.0,
         SZ_PRECISION: 0.01,
-        SZ_DATA_TYPE: 92,
+        SZ_DATA_TYPE: "92",
+        SZ_DATA_UNIT: "°C",
     },
     "95": {  # slot 08
         SZ_DESCRIPTION: "Boost mode Supply/exhaust fan rate (%)",
@@ -1362,6 +1385,7 @@ _2411_PARAMS_SCHEMA: dict[str, dict[str, Any]] = {
         SZ_MAX_VALUE: 1.0,
         SZ_PRECISION: 0.005,
         SZ_DATA_TYPE: "0F",
+        SZ_DATA_UNIT: "%",
     },
 }
 
@@ -1456,3 +1480,19 @@ _31DA_FAN_INFO: dict[int, str] = {
 # RAMSES_ZONES_ALL = RAMSES_ZONES.pop("ALL")
 # RAMSES_ZONES_DHW = RAMSES_ZONES[ZON_ROLE.DHW]
 # [RAMSES_ZONES[k].update(RAMSES_ZONES_ALL) for k in RAMSES_ZONES if k != ZON_ROLE.DHW]
+
+__all__ = [
+    "CODES_BY_DEV_SLUG",
+    "CODES_SCHEMA",
+    "CODE_NAME_LOOKUP",
+    "CODES_BY_DEV_SLUG",
+    "CODES_SCHEMA",
+    "HVAC_KLASS_BY_VC_PAIR",
+    "_2411_PARAMS_SCHEMA",
+    "SZ_DESCRIPTION",
+    "SZ_MIN_VALUE",
+    "SZ_MAX_VALUE",
+    "SZ_PRECISION",
+    "SZ_DATA_TYPE",
+    "SZ_DATA_UNIT",
+]

ramses_tx/schemas.py

@@ -215,6 +215,7 @@ def ConvertNullToDict() -> Callable[[_T | None], _T | dict[Never, Never]]:
 
 
 SZ_ALIAS: Final = "alias"
+SZ_BOUND_TO: Final = "bound"
 SZ_CLASS: Final = "class"
 SZ_FAKED: Final = "faked"
 SZ_SCHEME: Final = "scheme"
@@ -296,6 +297,8 @@ def sch_global_traits_dict_factory(
             vol.Optional(SZ_CLASS, default="HVC"): vol.Any(
                 None, *hvac_slugs, *(str(DEV_TYPE_MAP[s]) for s in hvac_slugs)
             ),  # TODO: consider removing None
+            # Add 'bound' trait for FAN devices
+            vol.Optional(SZ_BOUND_TO): vol.Any(None, vol.Match(DEVICE_ID_REGEX.ANY)),
         }
     )
     SCH_TRAITS_HVAC = SCH_TRAITS_HVAC.extend(

ramses_tx/transport.py

@@ -1033,6 +1033,8 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
         self._topic_base = validate_topic_path(self._broker_url.path)
         self._topic_pub = ""
         self._topic_sub = ""
+        # Track if we've subscribed to a wildcard data topic (e.g. ".../+/rx")
+        self._data_wildcard_topic = ""
 
         self._mqtt_qos = int(parse_qs(self._broker_url.query).get("qos", ["0"])[0])
 
@@ -1143,17 +1145,30 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
         # Subscribe to base topic to see 'online' messages
         self.client.subscribe(self._topic_base)  # hope to see 'online' message
 
-        # Also subscribe to data topics with wildcard for reliability after reconnect
-        # This ensures we get data even if we miss the 'online' message
-        if self._topic_base.endswith("/+"):
+        # Also subscribe to data topics with wildcard for reliability, but only
+        # until a specific device topic is known. Once _topic_sub is set, avoid
+        # overlapping subscriptions that would duplicate messages.
+        if self._topic_base.endswith("/+") and not (
+            hasattr(self, "_topic_sub") and self._topic_sub
+        ):
             data_wildcard = self._topic_base.replace("/+", "/+/rx")
             self.client.subscribe(data_wildcard, qos=self._mqtt_qos)
+            self._data_wildcard_topic = data_wildcard
             _LOGGER.debug(f"Subscribed to data wildcard: {data_wildcard}")
 
         # If we already have specific topics, re-subscribe to them
         if hasattr(self, "_topic_sub") and self._topic_sub:
             self.client.subscribe(self._topic_sub, qos=self._mqtt_qos)
             _LOGGER.debug(f"Re-subscribed to specific topic: {self._topic_sub}")
+            # If we had a wildcard subscription, drop it to prevent duplicates
+            if getattr(self, "_data_wildcard_topic", ""):
+                try:
+                    self.client.unsubscribe(self._data_wildcard_topic)
+                    _LOGGER.debug(
+                        f"Unsubscribed data wildcard after specific subscribe: {self._data_wildcard_topic}"
+                    )
+                finally:
+                    self._data_wildcard_topic = ""
 
     def _on_connect_fail(
         self,
@@ -1225,6 +1240,17 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
 
         self.client.subscribe(self._topic_sub, qos=self._mqtt_qos)
 
+        # If we previously subscribed to a wildcard data topic, unsubscribe now
+        # to avoid duplicate delivery (wildcard and specific both matching)
+        if getattr(self, "_data_wildcard_topic", ""):
+            try:
+                self.client.unsubscribe(self._data_wildcard_topic)
+                _LOGGER.debug(
+                    f"Unsubscribed data wildcard after device online: {self._data_wildcard_topic}"
+                )
+            finally:
+                self._data_wildcard_topic = ""
+
         # Only call connection_made on first connection, not reconnections
         if not self._connection_established:
             self._connection_established = True
@@ -1295,6 +1321,21 @@ class MqttTransport(_FullTransport, _MqttTransportAbstractor):
                 self._connection_established = True
                 self._make_connection(gwy_id=gateway_id)  # type: ignore[arg-type]
 
+                # Ensure we subscribe specifically to the device topic and drop the
+                # wildcard subscription to prevent duplicates
+                try:
+                    self.client.subscribe(self._topic_sub, qos=self._mqtt_qos)
+                except Exception as err:  # pragma: no cover - defensive
+                    _LOGGER.debug(f"Error subscribing specific topic: {err}")
+                if getattr(self, "_data_wildcard_topic", ""):
+                    try:
+                        self.client.unsubscribe(self._data_wildcard_topic)
+                        _LOGGER.debug(
+                            f"Unsubscribed data wildcard after inferring device: {self._data_wildcard_topic}"
+                        )
+                    finally:
+                        self._data_wildcard_topic = ""
+
         try:
             payload = json.loads(msg.payload)
         except json.JSONDecodeError:

ramses_tx/version.py

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