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

ramses_rf/__init__.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 """RAMSES RF - a RAMSES-II protocol decoder & analyser.
+`ramses_rf` takes care of the device (upper) layer.
 
 Works with (amongst others):
 - evohome (up to 12 zones)

ramses_rf/binding_fsm.py

@@ -178,6 +178,8 @@ class BindContextBase:
         self, state: type[BindStateBase], result: asyncio.Future[Message] | None = None
     ) -> None:
         """Transition the State of the Context, and process the result, if any."""
+        # Ensure prev_state is always available, not only during debugging
+        prev_state = self._state
 
         # if False and result:
         #     try:
@@ -185,10 +187,6 @@ class BindContextBase:
         #     except exc.BindingError as err:
         #         self._fut.set_result(err)
 
-        if _DBG_MAINTAIN_STATE_CHAIN:  # HACK for debugging
-            # if prev_state in (None, )
-            prev_state = self._state
-
         self._state = state(self)
         if not self.is_binding:
             self._is_respondent = None
@@ -197,6 +195,14 @@ class BindContextBase:
         elif state is SuppSendOfferWaitForAccept:
             self._is_respondent = False
 
+        # Log binding completion transitions
+        if isinstance(
+            self._state, (RespHasBoundAsRespondent, SuppHasBoundAsSupplicant)
+        ):
+            _LOGGER.info(
+                f"{self._dev.id}: Binding process completed: {type(prev_state).__name__} -> {state.__name__} (role: {self.role})"
+            )
+
         if _DBG_MAINTAIN_STATE_CHAIN:  # HACK for debugging
             setattr(self._state, "_prev_state", prev_state)  # noqa: B010
 
@@ -663,6 +669,10 @@ class RespHasBoundAsRespondent(BindStateBase):
 
     _attr_role = BindRole.IS_DORMANT
 
+    def __init__(self, context: BindContextBase) -> None:
+        super().__init__(context)
+        _LOGGER.info(f"{context._dev.id}: Binding completed as respondent")
+
 
 class RespIsWaitingForAddenda(_DevIsWaitingForMsg, BindStateBase):
     """Respondent has received a Confirm & is waiting for an Addenda."""
@@ -715,6 +725,10 @@ class SuppHasBoundAsSupplicant(BindStateBase):
 
     _attr_role = BindRole.IS_DORMANT
 
+    def __init__(self, context: BindContextBase) -> None:
+        super().__init__(context)
+        _LOGGER.info(f"{context._dev.id}: Binding completed as supplicant")
+
 
 class SuppIsReadyToSendAddenda(
     _DevIsReadyToSendCmd, BindStateBase

ramses_rf/database.py

@@ -1,5 +1,25 @@
 #!/usr/bin/env python3
-"""RAMSES RF - Message database and index."""
+"""
+RAMSES RF - Message database and index.
+
+.. table:: Database Query Methods[^1][#fn1]
+   :widths: auto
+
+   =====  ============  ===========  ==========  ====  ========================
+    ix    method name   args         returns     uses  used by
+   =====  ============  ===========  ==========  ====  ========================
+   i1     get           Msg, kwargs  tuple(Msg)  i3
+   i2     contains      kwargs       bool        i4
+   i3     _select_from  kwargs       tuple(Msg)  i4
+   i4     qry_dtms      kwargs       list(dtm)
+   i5     qry           sql, kwargs  tuple(Msg)        _msgs()
+   i6     qry_field     sql, kwargs  tuple(fld)        e4, e5
+   i7     get_rp_codes  src, dst     list(Code)        Discovery-supported_cmds
+   =====  ============  ===========  ==========  ====  ========================
+
+[#fn1] A word of explanation.
+[^1]: ex = entity_base.py query methods
+"""
 
 from __future__ import annotations
 
@@ -62,9 +82,10 @@ def payload_keys(parsed_payload: list[dict] | dict) -> str:  # type: ignore[type
 
 
 class MessageIndex:
-    """A simple in-memory SQLite3 database for indexing RF messages.
-    Index holds the latest message to & from all devices by header
-    (example of a hdr: 000C|RP|01:223036|0208)."""
+    """A central in-memory SQLite3 database for indexing RF messages.
+    Index holds all the latest messages to & from all devices by `dtm`
+    (timestamp) and `hdr` header
+    (example of a hdr: ``000C|RP|01:223036|0208``)."""
 
     _housekeeping_task: asyncio.Task[None]
 
@@ -72,7 +93,8 @@ class MessageIndex:
         """Instantiate a message database/index."""
 
         self.maintain = maintain
-        self._msgs: MsgDdT = OrderedDict()  # stores all messages for retrieval. Filled & cleaned up in housekeeping_loop.
+        self._msgs: MsgDdT = OrderedDict()  # stores all messages for retrieval.
+        # Filled & cleaned up in housekeeping_loop.
 
         # Connect to a SQLite DB in memory
         self._cx = sqlite3.connect(
@@ -122,16 +144,17 @@ class MessageIndex:
     def _setup_db_schema(self) -> None:
         """Set up the message database schema.
 
-        messages TABLE Fields:
-
-        - dtm  message timestamp
-        - verb " I", "RQ" etc.
-        - src  message origin address
-        - dst  message destination address
-        - 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
+        .. note::
+            messages TABLE Fields:
+
+            - dtm  message timestamp
+            - verb " I", "RQ" etc.
+            - src  message origin address
+            - dst  message destination address
+            - 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
         """
 
         self._cu.execute(
@@ -160,7 +183,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."""
 
         async def housekeeping(dt_now: dt, _cutoff: td = td(days=1)) -> None:
             """
@@ -196,6 +219,7 @@ class MessageIndex:
         """
         Add a single message to the MessageIndex.
         Logs a warning if there is a duplicate dtm.
+
         :returns: any message that was removed because it had the same header
         """
         # TODO: eventually, may be better to use SqlAlchemy
@@ -239,7 +263,11 @@ class MessageIndex:
 
     def add_record(self, src: str, code: str = "", verb: str = "") -> None:
         """
-        Add a single record to the MessageIndex with timestamp now() and no Message contents.
+        Add a single record to the MessageIndex with timestamp `now()` and no Message contents.
+
+        :param src: device id to use as source address
+        :param code: device id to use as destination address (can be identical)
+        :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]
@@ -274,6 +302,7 @@ class MessageIndex:
     def _insert_into(self, msg: Message) -> Message | None:
         """
         Insert a message into the index.
+
         :returns: any message replaced (by same hdr)
         """
         assert msg._pkt._hdr is not None, "Skipping: Packet has no hdr: {msg._pkt}"
@@ -305,7 +334,7 @@ class MessageIndex:
                 payload_keys(msg.payload),
             ),
         )
-        _LOGGER.debug(f"Added {msg} to gwy.msg_db")
+        # _LOGGER.debug(f"Added {msg} to gwy.msg_db")
 
         return _old_msgs[0] if _old_msgs else None
 
@@ -348,6 +377,7 @@ class MessageIndex:
 
     def _delete_from(self, **kwargs: bool | dt | str) -> tuple[Message, ...]:
         """Remove message(s) from the index.
+
         :returns: any messages that were removed"""
 
         msgs = self._select_from(**kwargs)
@@ -359,32 +389,14 @@ class MessageIndex:
 
         return msgs
 
-    # MessageIndex msg_db query methods > copy to docs/source/ramses_rf.rst
-    # (ex = entity_base.py query methods
-    #
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | ix |method name   | args        | returns    | uses | used by                  |
-    # +====+==============+=============+============+======+==========================+
-    # | i1 | get          | Msg/kwargs  | tuple[Msg] | i3   |                          |
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | i2 | contains     | kwargs      | bool       | i4   |                          |
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | i3 | _select_from | kwargs      | tuple[Msg] | i4   |                          |
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | i4 | qry_dtms     | kwargs      | list(dtm)  |      |                          |
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | i5 | qry          | sql, kwargs | tuple[Msg] |      | _msgs()                  |
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | i6 | qry_field    | sql, kwargs | tuple[fld] |      | e4, e5                   |
-    # +----+--------------+-------------+------------+------+--------------------------+
-    # | i7 | get_rp_codes | src, dst    | list[Code] |      | Discovery#supported_cmds |
-    # +----+--------------+-------------+------------+------+--------------------------+
+    # MessageIndex msg_db query methods
 
     def get(
         self, msg: Message | None = None, **kwargs: bool | dt | str
     ) -> tuple[Message, ...]:
         """
         Public method to get a set of message(s) from the index.
+
         :param msg: Message to return, by dtm (expect a single result as dtm is unique key)
         :param kwargs: data table field names and criteria, e.g. (hdr=...)
         :return: tuple of matching Messages
@@ -401,6 +413,7 @@ class MessageIndex:
     def contains(self, **kwargs: bool | dt | str) -> bool:
         """
         Check if the MessageIndex contains at least 1 record that matches the provided fields.
+
         :param kwargs: (exact) SQLite table field_name: required_value pairs
         :return: True if at least one message fitting the given conditions is present, False when qry returned empty
         """
@@ -410,6 +423,7 @@ class MessageIndex:
     def _select_from(self, **kwargs: bool | dt | str) -> tuple[Message, ...]:
         """
         Select message(s) using the MessageIndex.
+
         :param kwargs: (exact) SQLite table field_name: required_value pairs
         :returns: a tuple of qualifying messages
         """
@@ -421,7 +435,8 @@ class MessageIndex:
 
     def qry_dtms(self, **kwargs: bool | dt | str) -> list[Any]:
         """
-        Select from the ImageIndex a list of dtms that match the provided arguments.
+        Select from the MessageIndex a list of dtms that match the provided arguments.
+
         :param kwargs: data table field names and criteria
         :return: list of unformatted dtms that match, useful for msg lookup, or an empty list if 0 matches
         """
@@ -444,6 +459,7 @@ class MessageIndex:
     def qry(self, sql: str, parameters: tuple[str, ...]) -> tuple[Message, ...]:
         """
         Get a tuple of messages from _msgs using the index, given sql and parameters.
+
         :param sql: a bespoke SQL query SELECT string that should return dtm as first field
         :param parameters: tuple of kwargs with the selection filter
         :return: a tuple of qualifying messages
@@ -474,6 +490,7 @@ class MessageIndex:
     def get_rp_codes(self, parameters: tuple[str, ...]) -> list[Code]:
         """
         Get a list of Codes from the index, given parameters.
+
         :param parameters: tuple of additional kwargs
         :return: list of Code: value pairs
         """
@@ -499,6 +516,7 @@ class MessageIndex:
     ) -> list[tuple[dt | str, str]]:
         """
         Get a list of fields from the index, given select sql and parameters.
+
         :param sql: a bespoke SQL query SELECT string
         :param parameters: tuple of additional kwargs
         :return: list of key: value pairs as defined in sql

ramses_rf/device/heat.py

@@ -120,7 +120,7 @@ _LOGGER = logging.getLogger(__name__)
 
 class Actuator(DeviceHeat):  # 3EF0, 3EF1 (for 10:/13:)
     # .I --- 13:109598 --:------ 13:109598 3EF0 003 00C8FF                # event-driven, 00/C8
-    # RP --- 13:109598 18:002563 --:------ 0008 002 00C8                  # 00/C8, as abobe
+    # RP --- 13:109598 18:002563 --:------ 0008 002 00C8                  # 00/C8, as above
     # RP --- 13:109598 18:002563 --:------ 3EF1 007 0000BF-00BFC8FF       # 00/C8, as above
 
     # RP --- 10:048122 18:140805 --:------ 3EF1 007 007FFF-003C2A10       # 10:s only RP, always 7FFF
@@ -668,11 +668,8 @@ class OtbGateway(Actuator, HeatDemand):  # OTB (10): 3220 (22D9, others)
         self._child_id = FC  # NOTE: domain_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?
+            self._add_record(address=self.addr, 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:
@@ -1263,6 +1260,7 @@ class BdrSwitch(Actuator, RelayDemand):  # BDR (13):
     """The BDR class, such as a BDR91.
 
     BDR91s can be used in six distinct modes, including:
+
     - x2 boiler controller (FC/TPI): either traditional, or newer heat pump-aware
     - x1 electric heat zones (0x/ELE)
     - x1 zone valve zones (0x/VAL)
@@ -1410,7 +1408,7 @@ class UfhCircuit(Child, Entity):  # FIXME
     def __init__(self, ufc: UfhController, ufh_idx: str) -> None:
         super().__init__(ufc._gwy)
 
-        # FIXME: ZZZ entities must know their parent device ID and their own idx
+        # FIXME: gwy.msg_db entities must know their parent device ID and their own idx
         self._z_id = ufc.id
         self._z_idx = ufh_idx
 

ramses_rf/device/hvac.py

@@ -728,12 +728,15 @@ class HvacVentilator(FilterChange):  # FAN: RP/31DA, I/31D[9A], 2411
         In HomeAssistant, ramses_cc, you can set a bound device in the device configuration.
 
         System schema and known devices example:
-        "32:153289":
-          bound: "37:168270"
-          class: FAN
-        "37:168270":
-          class: REM
-          faked: true
+
+        .. code-block::
+
+            "32:153289":
+              bound: "37:168270"
+              class: FAN
+            "37:168270":
+              class: REM
+              faked: true
 
         :param device_id: The unique identifier of the device to bind
         :type device_id: str
@@ -1142,7 +1145,7 @@ def class_dev_hvac(
 ) -> type[DeviceHvac]:
     """Return a device class, but only if the device must be from the HVAC group.
 
-    May return a base clase, DeviceHvac, which will need promotion.
+    May return a base class, `DeviceHvac`, which will need promotion.
     """
 
     if not eavesdrop:
@@ -1206,54 +1209,111 @@ _REMOTES = {
 # see: https://github.com/arjenhiemstra/ithowifi/blob/master/software/NRG_itho_wifi/src/IthoPacket.h
 
 """
-# CVE/HRU remote (536-0124) [RFT W: 3 modes, timer]
-    "away":       (Code._22F1, 00, 01|04"),  # how to invoke?
-    "low":        (Code._22F1, 00, 02|04"),  # aka eco
-    "medium":     (Code._22F1, 00, 03|04"),  # aka auto (with sensors) - is that only for 63?
-    "high":       (Code._22F1, 00, 04|04"),  # aka full
-
-    "timer_1":    (Code._22F3, 00, 00|0A"),  # 10 minutes full speed
-    "timer_2":    (Code._22F3, 00, 00|14"),  # 20 minutes full speed
-    "timer_3":    (Code._22F3, 00, 00|1E"),  # 30 minutes full speed
-
-# RFT-AUTO (536-0150) [RFT CAR: 2 modes, auto, timer]: idx = 63, essentially same as above, but also...
-    "auto_night": (Code._22F8, 63, 02|03"),  # additional - press auto x2
-
-# RFT-RV (04-00046), RFT-CO2 (04-00045) - sensors with control
-    "medium":     (Code._22F1, 00, 03|07"), 1=away, 2=low?
-    "auto":       (Code._22F1, 00, 05|07"), 4=high
-    "auto_night": (Code._22F1, 00, 0B|0B"),
-
-    "timer_1":    (Code._22F3, 00, 00|0A, 00|00, 0000"),  # 10 minutes
-    "timer_2":    (Code._22F3, 00, 00|14, 00|00, 0000"),  # 20 minutes
-    "timer_3":    (Code._22F3, 00, 00|1E, 00|00, 0000"),  # 30 minutes
-
-# RFT-PIR (545-7550) - presence sensor
-
-# RFT_DF: DemandFlow remote (536-0146)
-    "timer_1":    (Code._22F3, 00, 42|03, 03|03"),  # 0b01-000-010 = 3 hrs, back to last mode
-    "timer_2":    (Code._22F3, 00, 42|06, 03|03"),  # 0b01-000-010 = 6 hrs, back to last mode
-    "timer_3":    (Code._22F3, 00, 42|09, 03|03"),  # 0b01-000-010 = 9 hrs, back to last mode
-    "cook_30":    (Code._22F3, 00, 02|1E, 02|03"),  # 30 mins (press 1x)
-    "cook_60":    (Code._22F3, 00, 02|3C, 02|03"),  # 60 mins (press 2x)
-
-    "low":        (Code._22F8, 00, 01|02"),  # ?eco     co2 <= 1200 ppm?
-    "high":       (Code._22F8, 00, 02|02"),  # ?comfort co2 <= 1000 ppm?
-
-# Join commands:
-    "CVERFT":     (Code._1FC9,  00, Code._22F1, 0x000000,                        01, Code._10E0, 0x000000"),  # CVE/HRU remote    (536-0124)
-    "AUTORFT":    (Code._1FC9,  63, Code._22F8, 0x000000,                        01, Code._10E0, 0x000000"),  # AUTO RFT          (536-0150)
-    "DF":         (Code._1FC9,  00, Code._22F8, 0x000000,                        00, Code._10E0, 0x000000"),  # DemandFlow remote (536-0146)
-    "RV":         (Code._1FC9,  00, Code._12A0, 0x000000,                        01, Code._10E0, 0x000000,  00, Code._31E0, 0x000000,  00, Code._1FC9, 0x000000"),  # RFT-RV   (04-00046)
-    "CO2":        (Code._1FC9,  00, Code._1298, 0x000000,  00, Code._2E10, 0x000000,  01, Code._10E0, 0x000000,  00, Code._31E0, 0x000000,  00, Code._1FC9, 0x000000"),  # RFT-CO2  (04-00045)
-
-# Leave commands:
-    "Others":      (Code._1FC9, 00, Code._1FC9, 0x000000"),  # standard leave command
-    "AUTORFT":     (Code._1FC9, 63, Code._1FC9, 0x000000"),  # leave command of AUTO RFT (536-0150)
-
-    # RQ 0x00
-    # I_ 0x01
-    # W_ 0x02
-    # RP 0x03
+Itho Remote (model) enums.
+
+CVE/HRU remote (536-0124) RFT W: 3 modes, timer
+-------------------------------------------------
+
+.. table:: 536-0124
+   :widths: auto
+
+   ===========  =========================  ================================================
+    "away":     (Code._22F1, 00, 01|04"),  how to invoke?
+    "low":      (Code._22F1, 00, 02|04"),  aka eco
+    "medium":   (Code._22F1, 00, 03|04"),  aka auto (with sensors) - is that only for 63?
+    "high":     (Code._22F1, 00, 04|04"),  aka full
+
+    "timer_1":  (Code._22F3, 00, 00|0A"),  10 minutes full speed
+    "timer_2":  (Code._22F3, 00, 00|14"),  20 minutes full speed
+    "timer_3":  (Code._22F3, 00, 00|1E"),  30 minutes full speed
+   ===========  =========================  ================================================
+
+RFT-AUTO (536-0150) RFT CAR: 2 modes, auto, timer: idx = 63, essentially same as above, but also...
+-----------------------------------------------------------------------------------------------------
+
+.. table:: 536-0150
+   :widths: auto
+
+   =============  =========================  ================================================
+   "auto_night":  (Code._22F8, 63, 02|03"),  additional - press auto x2
+   =============  =========================  ================================================
+
+RFT-RV (04-00046), RFT-CO2 (04-00045) - sensors with control
+------------------------------------------------------------
+
+.. table:: 04-00046
+   :widths: auto
+
+   ==============  ========================================   =============
+    "medium":      (Code._22F1, 00, 03|07"),                  1=away, 2=low?
+    "auto":        (Code._22F1, 00, 05|07"),                  4=high
+    "auto_night":  (Code._22F1, 00, 0B|0B"),
+
+    "timer_1":     (Code._22F3, 00, 00|0A, 00|00, 0000"),     10 minutes
+    "timer_2":     (Code._22F3, 00, 00|14, 00|00, 0000"),     20 minutes
+    "timer_3":     (Code._22F3, 00, 00|1E, 00|00, 0000"),     30 minutes
+   ==============  ========================================   =============
+
+RFT-PIR (545-7550) - presence sensor
+------------------------------------
+
+RFT_DF: DemandFlow remote (536-0146)
+------------------------------------
+
+.. table:: 536-0146
+   :widths: auto
+
+   ===========  ================================  =========================================
+    "timer_1":  (Code._22F3, 00, 42|03, 03|03"),  0b01-000-010 = 3 hrs, back to last mode
+    "timer_2":  (Code._22F3, 00, 42|06, 03|03"),  0b01-000-010 = 6 hrs, back to last mode
+    "timer_3":  (Code._22F3, 00, 42|09, 03|03"),  0b01-000-010 = 9 hrs, back to last mode
+    "cook_30":  (Code._22F3, 00, 02|1E, 02|03"),  30 mins (press 1x)
+    "cook_60":  (Code._22F3, 00, 02|3C, 02|03"),  60 mins (press 2x)
+
+    "low":      (Code._22F8, 00, 01|02"),         ?eco     co2 <= 1200 ppm?
+    "high":     (Code._22F8, 00, 02|02"),         ?comfort co2 <= 1000 ppm?
+   ===========  ================================  =========================================
+
+
+Join commands:
+--------------
+
+.. table:: join per accessory type
+   :widths: auto
+
+   ==========  =================  =====================  =========================  ==========================  =========================  ==========================  =================  ==========
+   type        set 1              set 2                  set 3                      set 4                       set 5                      set 6                       description        art #
+   ==========  =================  =====================  =========================  ==========================  =========================  ==========================  =================  ==========
+   "CVERFT":   (Code._1FC9,  00,  Code._22F1, 0x000000,                             01, Code._10E0, 0x000000")                                                         CVE/HRU remote     (536-0124)
+   "AUTORFT":  (Code._1FC9,  63,  Code._22F8, 0x000000,                             01, Code._10E0, 0x000000")                                                         AUTO RFT           (536-0150)
+   "DF":       (Code._1FC9,  00,  Code._22F8, 0x000000,                             00, Code._10E0, 0x000000")                                                         DemandFlow remote  (536-0146)
+   "RV":       (Code._1FC9,  00,  Code._12A0, 0x000000,                             01, Code._10E0, 0x000000,   00, Code._31E0, 0x000000,  00, Code._1FC9, 0x000000")  RFT-RV             (04-00046)
+   "CO2":      (Code._1FC9,  00,  Code._1298, 0x000000,  00, Code._2E10, 0x000000,  01, Code._10E0, 0x000000,   00, Code._31E0, 0x000000,  00, Code._1FC9, 0x000000")  RFT-CO2            (04-00045)
+   ==========  =================  =====================  =========================  ==========================  =========================  ==========================  =================  ==========
+
+Leave commands:
+---------------
+
+.. table:: leave per accessory type
+   :widths: auto
+
+   ==========  =================  ======================  =========================  ==========
+   type        set 1              set 2                   description                art #
+   ==========  =================  ======================  =========================  ==========
+   "Others":   (Code._1FC9, 00,   Code._1FC9, 0x000000")  standard leave command
+   "AUTORFT":  (Code._1FC9, 63,   Code._1FC9, 0x000000")  leave command of AUTO RFT  (536-0150)
+   ==========  =================  ======================  =========================  ==========
+
+.. table:: verbs
+   :widths: 2, 4
+
+   ======  ========
+   verb    byte
+   ======  ========
+   ``RQ``  ``0x00``
+   ``I_``  ``0x01``
+   ``W_``  ``0x02``
+   ``RP``  ``0x03``
+   ======  ========
 
 """

ramses_rf/dispatcher.py

@@ -186,6 +186,12 @@ def process_msg(gwy: Gateway, msg: Message) -> None:
     # which requires a valid payload only for 000C.
 
     def logger_xxxx(msg: Message) -> None:
+        """
+        Log msg according to src, code, log.debug setting.
+
+        :param msg: the Message being processed
+        :return: None
+        """
         if _DBG_FORCE_LOG_MESSAGES:
             _LOGGER.warning(msg)
         elif msg.src != gwy.hgi or (msg.code != Code._PUZZ and msg.verb != RQ):
@@ -268,10 +274,9 @@ def process_msg(gwy: Gateway, msg: Message) -> None:
 
     else:
         logger_xxxx(msg)
-        # if gwy.msg_db:
-        #     gwy.msg_db.add(
-        #         msg
-        #     )  # why add it? passes all tests without
+        if gwy.msg_db:
+            gwy.msg_db.add(msg)
+            # why add it? enable for evohome
 
 
 # TODO: this needs cleaning up (e.g. handle intervening packet)