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

ramses_rf/device/heat.py

@@ -144,7 +144,7 @@ class Actuator(DeviceHeat):  # 3EF0, 3EF1 (for 10:/13:)
         if self._gwy.config.disable_discovery:
             return
 
-        # TODO: why are we doing this here? Should simply use dscovery poller!
+        # TODO: why are we doing this here? Should simply use discovery poller!
         if msg.code == Code._3EF0 and msg.verb == I_ and not self.is_faked:
             # lf._send_cmd(Command.get_relay_demand(self.id), qos=QOS_LOW)
             self._send_cmd(
@@ -429,7 +429,7 @@ class UfhController(Parent, DeviceHeat):  # UFC (02):
     def _handle_msg(self, msg: Message) -> None:
         super()._handle_msg(msg)
 
-        # Several assumptions ar emade, regarding 000C pkts:
+        # Several assumptions are made, regarding 000C pkts:
         # - UFC bound only to CTL (not, e.g. SEN)
         # - all circuits bound to the same controller
 
@@ -450,7 +450,7 @@ class UfhController(Parent, DeviceHeat):  # UFC (02):
                 #     )
                 #     self._send_cmd(cmd)
 
-        elif msg.code == Code._0008:  # relay_demand, TODO: use msg DB?
+        elif msg.code == Code._0008:  # relay_demand, TODO: use msgIndex DB?
             if msg.payload.get(SZ_DOMAIN_ID) == FC:
                 self._relay_demand = msg
             else:  # FA
@@ -491,7 +491,6 @@ class UfhController(Parent, DeviceHeat):  # UFC (02):
 
         # elif msg.code not in (Code._10E0, Code._22D0):
         #     print("xxx")
-
         # "0008|FA/FC", "22C9|array", "22D0|none", "3150|ZZ/array(/FC?)"
 
     # TODO: should be a private method
@@ -635,7 +634,7 @@ def _to_msg_id(data_id: OtDataId) -> MsgId:
     return f"{data_id:02X}"
 
 
-# NOTE: config.use_native_ot should enforces sends, but not reads from _msgz DB
+# NOTE: config.use_native_ot should enforce sends, but not reads from _msgz DB
 class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
     """The OTB class, specifically an OpenTherm Bridge (R8810A Bridge)."""
 
@@ -668,7 +667,16 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
 
         self._child_id = FC  # NOTE: domain_id
 
-        self._msgz[Code._3220] = {RP: {}}  # _msgz[Code._3220][RP][msg_id]
+        # TODO(eb): cleanup
+        # should fix src/ramses_rf/database.py _add_record try/except when activating next line
+        if self._gwy.msg_db:
+            self._add_record(
+                address=self.addr, code=Code._3220, verb="RP"
+            )  # << essential?
+        # 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
         self._msgs_ot: dict[MsgId, Message] = {}
@@ -758,7 +766,7 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
         if msg.payload.get(SZ_VALUE) is None:
             return
 
-        # msg_id is int in msg payload/opentherm.py, but MsgId (str) is in this module
+        # msg_id is int in msg payload/opentherm.py, but MsgId (str) in this module
         msg_id = _to_msg_id(msg.payload[SZ_MSG_ID])
         self._msgs_ot[msg_id] = msg
 

ramses_rf/device/hvac.py

@@ -426,7 +426,7 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
     Also handles 2411 parameter messages for configuration.
     Since 2411 is not supported by all vendors, discovery is used to determine if it is supported.
     Since more than 1 different parameters can be sent on 2411 messages,
-    we will process these in the dedicated _handle_2411_message method.
+    we process these in the dedicated _handle_2411_message method.
     """
 
     # Itho Daalderop (NL)
@@ -446,6 +446,7 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         """
         super().__init__(*args, **kwargs)
         self._supports_2411 = False  # Flag for 2411 parameter support
+        self._params_2411: dict[str, float] = {}  # Store 2411 parameters here
         self._initialized_callback = None  # Called when device is fully initialized
         self._param_update_callback = None  # Called when 2411 parameters are updated
         self._hgi: Any | None = None  # Will be set when HGI is available
@@ -517,7 +518,7 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         :param param_id: The ID of the parameter that was updated
         :type param_id: str
         :param value: The new value of the parameter
-        :type value: Any
+        :type value: float
         """
         if callable(self._param_update_callback):
             try:
@@ -541,12 +542,62 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         The HGI device provides additional functionality for certain operations.
 
         :return: The HGI device instance, or None if not available
-        :rtype: Any | None
+        :rtype: float | None
         """
         if self._hgi is None and self._gwy and hasattr(self._gwy, "hgi"):
             self._hgi = self._gwy.hgi
         return self._hgi
 
+    def get_2411_param(self, param_id: str) -> float | None:
+        """Get a 2411 parameter value.
+
+        :param param_id: The parameter ID to retrieve.
+        :type param_id: str
+        :return: The parameter value if found, None otherwise
+        :rtype: float | None
+        """
+        return self._params_2411.get(param_id)
+
+    def set_2411_param(self, param_id: str, value: float) -> bool:
+        """Set a 2411 parameter value.
+
+        :param param_id: The parameter ID to retrieve.
+        :type param_id: str
+        :param value: The parameter value to set.
+        :type value: float
+        :return: True if the parameter was set, False otherwise
+        :rtype: bool
+        """
+        if not self._supports_2411:
+            _LOGGER.warning("Device %s doesn't support 2411 parameters", self.id)
+            return False
+
+        self._params_2411[param_id] = value
+        return True
+
+    def get_fan_param(self, param_id: str) -> Any | None:
+        """Retrieve a fan parameter value from the device's message store.
+
+        This wrapper method gets a specific parameter value for a FAN device stored in
+        _params_2411 dict. It first makes sure we use the proper param_id format
+
+        :param param_id: The parameter ID to retrieve.
+        :type param_id: str
+        :return: The parameter value if found, None otherwise
+        :rtype: float | None
+        """
+        # Ensure param_id is uppercase and strip leading zeros for consistency
+        param_id = (
+            str(param_id).upper().lstrip("0") or "0"
+        )  # Handle case where param_id is "0"
+
+        param_value = self.get_2411_param(param_id)
+        if param_value is not None:
+            return param_value
+        else:
+            _LOGGER.debug("Parameter %s not found for %s", param_id, self.id)
+            return None
+
     def _handle_2411_message(self, msg: Message) -> None:
         """Handle incoming 2411 parameter messages.
 
@@ -555,7 +606,7 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         It handles parameter value normalization and validation.
 
         :param msg: The incoming 2411 message
-        :type msg: Message
+        :type msg: Message to process
         """
         if not hasattr(msg, "payload") or not isinstance(msg.payload, dict):
             _LOGGER.debug("Invalid 2411 message format: %s", msg)
@@ -568,33 +619,30 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
             _LOGGER.debug("Missing parameter ID or value in 2411 message: %s", msg)
             return
 
-        # Create a composite key for this parameter using the normalized ID
-        key = f"{Code._2411}_{param_id}"
+        # Mark that we support 2411 parameters
+        if not self._supports_2411:
+            self._supports_2411 = True
+            _LOGGER.debug("Device %s supports 2411 parameters", self.id)
 
-        # Store the message in the device's message store
-        old_value = self._msgs.get(Code._2411)
-        # Use direct assignment for Code._2411 key
-        self._msgs[Code._2411] = msg
-        # For the composite key, we need to bypass type checking
-        self._msgs[key] = msg  # type: ignore[index]
+        # Normalize the value if needed
+        if param_id == "75" and isinstance(param_value, (int, float)):
+            param_value = round(float(param_value), 1)
+        elif param_id in ("52", "95"):  # Percentage parameters
+            param_value = round(float(param_value), 3)  # Keep precision for percentages
 
+        # Store in params
+        old_value = self.get_2411_param(param_id)
+        self.set_2411_param(param_id, param_value)
+
+        # Log the update
         _LOGGER.debug(
-            "Updated 2411 parameter %s = %s (was: %s) for %s",
+            "Updated 2411 parameter %s: %s (was: %s) for %s",
             param_id,
             param_value,
-            old_value.payload if old_value else None,
+            old_value,
             self.id,
         )
 
-        # Mark that we support 2411 parameters
-        if not self._supports_2411:
-            self._supports_2411 = True
-            _LOGGER.debug("Device %s supports 2411 parameters", self.id)
-
-        # Round parameter 75 values to 1 decimal place
-        if param_id == "75" and isinstance(param_value, int | float):
-            param_value = round(float(param_value), 1)
-
         # call the 2411 parameter update callback
         self._handle_param_update(param_id, param_value)
 
@@ -605,7 +653,7 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         handling for 2411 parameter messages. It updates the device state and
         triggers any necessary callbacks.
 
-        After handling the messages, it calls the initialized callback if set to notify that
+        After handling the messages, it calls the initialized callback - if set - to notify that
         the device was fully initialized.
 
         :param msg: The incoming message to process
@@ -749,72 +797,6 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         _LOGGER.debug("No bound REM or DIS devices found for FAN %s", self.id)
         return None
 
-    def get_fan_param(self, param_id: str) -> Any | None:
-        """Retrieve a fan parameter value from the device's message store.
-
-        This method attempts to fetch a specific parameter value for a FAN device from the
-        stored messages. It first looks for the parameter using a composite key (e.g., '2411_3F')
-        and falls back to checking the general 2411 message if needed.
-
-        :param param_id: The parameter ID to retrieve.
-        :type param_id: str
-        :return: The parameter value if found, None otherwise
-        :rtype: Any | None
-        """
-        # Ensure param_id is uppercase and strip leading zeros for consistency
-        param_id = (
-            str(param_id).upper().lstrip("0") or "0"
-        )  # Handle case where param_id is "0"
-        # we need some extra workarounds to please mypy
-        # Create a composite key for this parameter using the normalized ID
-        key = f"{Code._2411}_{param_id}"
-
-        # Get the message using the composite key first, fall back to just the code
-        msg = None
-
-        # First try to get the specific parameter message
-        try:
-            # Try to access the message directly using the key
-            msg = self._msgs[key]  # type: ignore[index]
-        except (KeyError, TypeError):
-            # If that fails, try to find the message by iterating through the dictionary
-            msg = next((v for k, v in self._msgs.items() if str(k) == key), None)
-
-        # If not found, try to get the general 2411 message
-        if msg is None:
-            msg = self._msgs.get(Code._2411)
-
-        if not msg or not hasattr(msg, "payload"):
-            if not self.supports_2411:
-                _LOGGER.debug(
-                    "Cannot get parameter %s from %s: 2411 parameters not supported",
-                    param_id,
-                    self.id,
-                )
-            else:
-                _LOGGER.debug(
-                    "No payload found for parameter %s on %s", param_id, self.id
-                )
-            return None
-
-        # If we have a message but not the specific parameter, try to get it from the payload
-        if param_id and hasattr(msg.payload, "get"):
-            value = msg.payload.get("value")
-            if value is not None:
-                return value
-
-        # If we get here, the parameter wasn't found in the message
-        if not self.supports_2411:
-            _LOGGER.debug(
-                "Parameter %s not found for %s: 2411 parameters not supported",
-                param_id,
-                self.id,
-            )
-        else:
-            _LOGGER.debug("Parameter %s not found in payload for %s", param_id, self.id)
-
-        return None
-
     @property
     def air_quality(self) -> float | None:
         """Return the current air quality measurement.
@@ -929,14 +911,38 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
     @property
     def fan_info(self) -> str | None:
         """
-        Extract fan info description from _31D9 or _31DA message payload, e.g. "speed 2, medium".
+        Extract fan info description from MessageIndex _31D9 or _31DA payload,
+        e.g. "speed 2, medium".
         By its name, the result is picked up by a sensor in HA Climate UI.
         Some manufacturers (Orcon, Vasco) include the fan mode (auto, manual), others don't (Itho).
 
-        :return: a string describing fan mode, speed
-        """
+        :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.info(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.info(
+                f"{res_rate} # FAN_RATE FETCHED from MessageIndex"
+            )  # DEBUG always empty?
+
         if Code._31D9 in self._msgs:
-            # Itho, Vasco D60 and ClimaRad (MiniBox fan) send mode/speed in _31D9
+            # was a dict by Code
+            # Itho, Vasco D60 and ClimaRad MiniBox fan send mode/speed in _31D9
             v: str
             for k, v in self._msgs[Code._31D9].payload.items():
                 if k == SZ_FAN_MODE and len(v) > 2:  # prevent non-lookups to pass

ramses_rf/dispatcher.py

@@ -70,12 +70,12 @@ def _create_devices_from_addrs(gwy: Gateway, this: Message) -> None:
     # Devices need to know their controller, ?and their location ('parent' domain)
     # NB: only addrs processed here, packet metadata is processed elsewhere
 
-    # Determinging bindings to a controller:
+    # Determining bindings to a controller:
     #  - configury; As per any schema                                                   # codespell:ignore configury
     #  - discovery: If in 000C pkt, or pkt *to* device where src is a controller
     #  - eavesdrop: If pkt *from* device where dst is a controller
 
-    # Determinging location in a schema (domain/DHW/zone):
+    # Determining location in a schema (domain/DHW/zone):
     #  - configury; As per any schema                                                   # codespell:ignore configury
     #  - discovery: If in 000C pkt - unable for 10: & 00: (TRVs)
     #  - discovery: from packet fingerprint, excl. payloads (only for 10:)
@@ -99,7 +99,7 @@ def _create_devices_from_addrs(gwy: Gateway, this: Message) -> None:
 def _check_msg_addrs(msg: Message) -> None:  # TODO
     """Validate the packet's address set.
 
-    Raise InvalidAddrSetError if the meta data is invalid, otherwise simply return.
+    Raise InvalidAddrSetError if the metadata is invalid, otherwise simply return.
     """
 
     # TODO: needs work: doesn't take into account device's (non-HVAC) class
@@ -218,7 +218,7 @@ def process_msg(gwy: Gateway, msg: Message) -> None:
             and msg.dst != msg.src
         ):
             # HGI80 can do what it likes
-            # receiving an I isn't currently in the schema & so can't yet be tested
+            # receiving an I_ isn't currently in the schema & so can't yet be tested
             _check_dst_slug(msg)  # ? raise exc.PacketInvalid
 
         if gwy.config.reduce_processing >= DONT_UPDATE_ENTITIES:
@@ -268,8 +268,10 @@ def process_msg(gwy: Gateway, msg: Message) -> None:
 
     else:
         logger_xxxx(msg)
-        if gwy.msg_db:
-            gwy.msg_db.add(msg)
+        # if gwy.msg_db:
+        #     gwy.msg_db.add(
+        #         msg
+        #     )  # why add it? passes all tests without
 
 
 # TODO: this needs cleaning up (e.g. handle intervening packet)