ramses-rf 0.51.1__tar.gz → 0.51.3__tar.gz

{ramses_rf-0.51.1 → ramses_rf-0.51.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ramses_rf
-Version: 0.51.1
+Version: 0.51.3
 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.51.1 → ramses_rf-0.51.3}/ramses_rf/device/hvac.py

@@ -378,16 +378,11 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A]
     @property
     def bypass_position(self) -> float | str | None:
         """
-        Position info is found in 22F7 and in 31DA. Both are picked up, ignoring None.
+        Position info is found in 22F7 and in 31DA. The most recent packet is returned.
         :return: bypass position as percentage: 0.0 (closed) or 1.0 (open), on error: "x_faulted"
         """
-        for code in [c for c in (Code._22F7, Code._31DA) if c in self._msgs]:
-            if v := self._msgs[code].payload.get(SZ_BYPASS_POSITION):
-                if v is not None:  # skip none (to fetch other code)
-                    assert isinstance(v, (float | str))
-                    return v
-                # if both packets exist and both have the key, return the most recent
-        return None
+        # if both packets exist and both have the key, returns the most recent
+        return self._msg_value((Code._22F7, Code._31DA), key=SZ_BYPASS_POSITION)
 
     @property
     def bypass_state(self) -> str | None:
@@ -426,13 +421,6 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A]
 
     @property
     def exhaust_temp(self) -> float | None:
-        if Code._12A0 in self._msgs and isinstance(
-            self._msgs[Code._12A0].payload, list
-        ):  # FAN Ventura sends RH/temps as a list, use element [2] for exhaust temp
-            if v := self._msgs[Code._12A0].payload[2].get(SZ_TEMPERATURE):
-                assert isinstance(v, (float | type(None)))
-                return v
-            return None
         return self._msg_value(Code._31DA, key=SZ_EXHAUST_TEMP)
 
     @property
@@ -482,32 +470,24 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A]
         """
         if Code._12A0 in self._msgs and isinstance(
             self._msgs[Code._12A0].payload, list
-        ):  # FAN Ventura sends a list, use element [0]
+        ):  # FAN Ventura sends RH/temps as a list; element [0] contains indoor_hum
             if v := self._msgs[Code._12A0].payload[0].get(SZ_INDOOR_HUMIDITY):
                 assert isinstance(v, (float | type(None)))
                 return v
-            return None  # prevent AttributeError: 'list' object has no attribute 'get'
-        for code in [c for c in (Code._12A0, Code._31DA) if c in self._msgs]:
-            if v := self._msgs[code].payload.get(SZ_INDOOR_HUMIDITY):
-                if v is not None:  # skip none (to check the other code)
-                    assert isinstance(v, float)
-                    return v
-        return None
+        return self._msg_value((Code._12A0, Code._31DA), key=SZ_INDOOR_HUMIDITY)
 
     @property
     def indoor_temp(self) -> float | None:
+        return self._msg_value(Code._31DA, key=SZ_INDOOR_TEMP)
+
+    @property
+    def outdoor_humidity(self) -> float | None:
         if Code._12A0 in self._msgs and isinstance(
             self._msgs[Code._12A0].payload, list
-        ):  # FAN Ventura sends RH/temps as a list; element [0] is indoor_temp
-            if v := self._msgs[Code._12A0].payload[0].get(SZ_TEMPERATURE):
+        ):  # FAN Ventura sends RH/temps as a list; element [1] contains outdoor_hum
+            if v := self._msgs[Code._12A0].payload[1].get(SZ_OUTDOOR_HUMIDITY):
                 assert isinstance(v, (float | type(None)))
                 return v
-        else:
-            return self._msg_value(Code._31DA, key=SZ_INDOOR_TEMP)
-        return None
-
-    @property
-    def outdoor_humidity(self) -> float | None:
         return self._msg_value(Code._31DA, key=SZ_OUTDOOR_HUMIDITY)
 
     @property
@@ -540,6 +520,13 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A]
 
     @property
     def supply_temp(self) -> float | None:
+        if Code._12A0 in self._msgs and isinstance(
+            self._msgs[Code._12A0].payload, list
+        ):  # FAN Ventura sends RH/temps as a list;
+            # pass element [0] in place of supply_temp, which is always None in VenturaV1x 31DA
+            if v := self._msgs[Code._12A0].payload[1].get(SZ_TEMPERATURE):
+                assert isinstance(v, (float | type(None)))
+                return v
         return self._msg_value(Code._31DA, key=SZ_SUPPLY_TEMP)
 
     @property
@@ -557,6 +544,12 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A]
 
     @property
     def temperature(self) -> float | None:  # Celsius
+        if Code._12A0 in self._msgs and isinstance(
+            self._msgs[Code._12A0].payload, list
+        ):  # FAN Ventura sends RH/temps as a list; use element [1]
+            if v := self._msgs[Code._12A0].payload[0].get(SZ_TEMPERATURE):
+                assert isinstance(v, (float | type(None)))
+                return v
         # ClimaRad minibox FAN sends (indoor) temp in 12A0
         return self._msg_value(Code._12A0, key=SZ_TEMPERATURE)
 

{ramses_rf-0.51.1 → ramses_rf-0.51.3}/ramses_rf/entity_base.py

@@ -300,7 +300,10 @@ class _MessageDB(_Entity):
         if isinstance(code, str | tuple):  # a code or a tuple of codes
             return self._msg_value_code(code, *args, **kwargs)
         # raise RuntimeError
-        return self._msg_value_msg(code, *args, **kwargs)  # assume is a Message
+        assert isinstance(code, Message), (
+            f"Invalid format: _msg_value({code})"
+        )  # catch invalidly formatted code, only Message
+        return self._msg_value_msg(code, *args, **kwargs)
 
     def _msg_value_code(
         self,

{ramses_rf-0.51.1 → ramses_rf-0.51.3}/ramses_rf/version.py

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

{ramses_rf-0.51.1 → ramses_rf-0.51.3}/ramses_tx/version.py

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

{ramses_rf-0.51.1 → ramses_rf-0.51.3}/tests/tests/test_apis_hvac.py

@@ -11,7 +11,7 @@ from ramses_tx.packet import Packet
 
 
 def _test_api(api: Callable, packets: dict[str]) -> None:  # NOTE: incl. addr_set check
-    """Test a verb|code pair that has a Command constructor."""
+    """Test a verb|code pair that has a Command constructor, src and dst."""
 
     for pkt_line, kwargs in packets.items():
         pkt = _create_pkt_from_frame(pkt_line)
@@ -22,6 +22,20 @@ def _test_api(api: Callable, packets: dict[str]) -> None:  # NOTE: incl. addr_se
         _test_api_from_msg(api, msg)
 
 
+def _test_api_one(
+    api: Callable, packets: dict[str]
+) -> None:  # NOTE: incl. addr_set check
+    """Test a verb|code pair that has a Command constructor and src, but no dst."""
+
+    for pkt_line, kwargs in packets.items():
+        pkt = _create_pkt_from_frame(pkt_line)
+
+        msg = Message(pkt)
+
+        _test_api_one_from_kwargs(api, pkt, **kwargs)
+        _test_api_one_from_msg(api, msg)
+
+
 def _create_pkt_from_frame(pkt_line: str) -> Packet:
     """Create a pkt from a pkt_line and assert their frames match."""
 
@@ -31,7 +45,8 @@ def _create_pkt_from_frame(pkt_line: str) -> Packet:
 
 
 def _test_api_from_msg(api: Callable, msg: Message) -> Command:
-    """Create a cmd from a msg and assert they're equal (*also* asserts payload)."""
+    """Create a cmd from a msg with a src_id, and assert they're equal
+    (*also* asserts payload)."""
 
     cmd: Command = api(
         msg.dst.id,
@@ -44,12 +59,39 @@ def _test_api_from_msg(api: Callable, msg: Message) -> Command:
     return cmd
 
 
+def _test_api_one_from_msg(api: Callable, msg: Message) -> Command:
+    """Create a cmd from a msg and assert they're equal (*also* asserts payload)."""
+
+    cmd: Command = api(
+        msg.dst.id,
+        **{k: v for k, v in msg.payload.items()},  # if k[:1] != "_"},
+        # requirement turned off as it skips required item like _unknown_fan_info_flags
+    )
+
+    assert cmd == msg._pkt  # must have exact same addr set
+
+    return cmd
+
+
 def _test_api_from_kwargs(api: Callable, pkt: Packet, **kwargs: Any) -> None:
+    """
+    Test comparing a created packet to an expected result.
+
+    :param api: Command lookup by Verb|Code
+    :param pkt: expected result to match
+    :param kwargs: arguments for the Command
+    """
     cmd = api(HRU, src_id=REM, **kwargs)
 
     assert str(cmd) == str(pkt)
 
 
+def _test_api_one_from_kwargs(api: Callable, pkt: Packet, **kwargs: Any) -> None:
+    cmd = api(HRU, **kwargs)
+
+    assert str(cmd) == str(pkt)
+
+
 def test_set() -> None:
     for test_pkts in (SET_22F1_KWARGS, SET_22F7_KWARGS):
         pkt = list(test_pkts)[0]
@@ -57,7 +99,7 @@ def test_set() -> None:
         _test_api(api, test_pkts)
 
 
-HRU = "32:155617"
+HRU = "32:155617"  # also used as a FAN
 REM = "37:171871"
 NUL = "--:------"
 
@@ -108,3 +150,31 @@ SET_22F7_KWARGS = {
     f"002  W --- {REM} {HRU} {NUL} 22F7 002 0000": {"bypass_mode": "off"},
     f"002  W --- {REM} {HRU} {NUL} 22F7 002 00C8": {"bypass_mode": "on"},
 }
+
+
+# new tests
+def test_get() -> None:
+    for test_pkts in (GET_12A0_KWARGS, GET_1298_KWARGS):
+        pkt = list(test_pkts)[0]
+        api = CODE_API_MAP[f"{pkt[4:6]}|{pkt[41:45]}"]
+        _test_api_one(api, test_pkts)
+
+
+GET_12A0_KWARGS = {
+    f"000  I --- {HRU} {NUL} {HRU} 12A0 002 00EF": {
+        "indoor_humidity": None
+    },  # shouldn't be OK
+    #
+    f"082  I --- {HRU} {NUL} {HRU} 12A0 002 0037": {"indoor_humidity": 0.55},
+}
+
+GET_1298_KWARGS = {
+    f"064  I --- {HRU} {NUL} {HRU} 1298 003 000322": {"co2_level": 802},
+}
+
+# TODO Add tests to get states from 31DA
+# (verifies SQLite refactoring)
+# set up HVAC system first from messages
+#
+# Example: current_temperature(self) in ramses_cc.climate.py
+# simulates requesting Climate self._device.indoor_temp from a system