Merge pull request #232 from plugwise/join-services

Auto-joining, replace device-add/-remove services

Author: bouwew

.github/workflows/verify.yml

@@ -4,7 +4,7 @@
 name: Latest commit
 
 env:
-  CACHE_VERSION: 22
+  CACHE_VERSION: 24
   DEFAULT_PYTHON: "3.13"
   PRE_COMMIT_HOME: ~/.cache/pre-commit
 
@@ -22,7 +22,7 @@ jobs:
     name: Prepare
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
         uses: actions/setup-python@v5
@@ -71,7 +71,7 @@ jobs:
     needs: prepare
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -124,7 +124,7 @@ jobs:
       - dependencies_check
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
         uses: actions/setup-python@v5
@@ -175,7 +175,7 @@ jobs:
         python-version: ["3.13"]
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         id: python
         uses: actions/setup-python@v5
@@ -215,7 +215,7 @@ jobs:
 
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         id: python
         uses: actions/setup-python@v5
@@ -253,7 +253,7 @@ jobs:
     needs: pytest
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
@@ -293,7 +293,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Run ShellCheck
         uses: ludeeus/action-shellcheck@master
 
@@ -303,7 +303,7 @@ jobs:
     name: Dependency
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Run dependency checker
         run: scripts/dependencies_check.sh debug
 
@@ -313,7 +313,7 @@ jobs:
     needs: pytest
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
         uses: actions/setup-python@v5
@@ -358,7 +358,7 @@ jobs:
     needs: [coverage, mypy]
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
         uses: actions/setup-python@v5
@@ -401,7 +401,7 @@ jobs:
     needs: coverage
     steps:
       - name: Check out committed code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@v4
       - name: Set up Python ${{ env.DEFAULT_PYTHON }}
         id: python
         uses: actions/setup-python@v5

CODEOWNERS

@@ -3,13 +3,11 @@
 
 # Specific files
 setup.cfg @plugwise/plugwise-usb
-setup.py @plugwise/plugwise-usb
 pyproject.toml @plugwise/plugwise-usb
 requirements*.txt @plugwise/plugwise-usb
 
 # Main code
-/plugwise/ @plugwise/plugwise-usb
-/userdata/ @plugwise/plugwise-usb
+/plugwise_usb/ @plugwise/plugwise-usb
 
 # Tests and development support
 /tests/ @plugwise/plugwise-usb

plugwise_usb/__init__.py

@@ -14,7 +14,7 @@
 
 from .api import NodeEvent, PlugwiseNode, StickEvent
 from .connection import StickController
-from .exceptions import StickError, SubscriptionError
+from .exceptions import MessageError, NodeError, StickError, SubscriptionError
 from .network import StickNetwork
 
 FuncT = TypeVar("FuncT", bound=Callable[..., Any])
@@ -190,20 +190,27 @@ def accept_join_request(self) -> bool | None:
             return None
         return self._network.accept_join_request
 
-    @accept_join_request.setter
-    def accept_join_request(self, state: bool) -> None:
+    async def set_accept_join_request(self, state: bool) -> bool:
         """Configure join request setting."""
         if not self._controller.is_connected:
             raise StickError(
                 "Cannot accept joining node"
                 + " without an active USB-Stick connection."
             )
+
         if self._network is None or not self._network.is_running:
             raise StickError(
                 "Cannot accept joining node"
                 + "without node discovery be activated. Call discover() first."
             )
-        self._network.accept_join_request = state
+
+        # Observation: joining is only temporarily possible after a HA (re)start or
+        # Integration reload, force the setting when used otherwise
+        try:
+            await self._network.allow_join_requests(state)
+        except (MessageError, NodeError) as exc:
+            raise NodeError(f"Failed setting accept joining: {exc}") from exc
+        return True
 
     async def clear_cache(self) -> None:
         """Clear current cache."""
@@ -347,15 +354,22 @@ async def register_node(self, mac: str) -> bool:
         """Add node to plugwise network."""
         if self._network is None:
             return False
-        return await self._network.register_node(mac)
+
+        try:
+            return await self._network.register_node(mac)
+        except NodeError as exc:
+            raise NodeError(f"Unable to add Node ({mac}): {exc}") from exc
 
     @raise_not_connected
     @raise_not_initialized
     async def unregister_node(self, mac: str) -> None:
         """Remove node to plugwise network."""
         if self._network is None:
             return
-        await self._network.unregister_node(mac)
+        try:
+            await self._network.unregister_node(mac)
+        except MessageError as exc:
+            raise NodeError(f"Unable to remove Node ({mac}): {exc}") from exc
 
     async def disconnect(self) -> None:
         """Disconnect from USB-Stick."""

plugwise_usb/connection/__init__.py

@@ -214,7 +214,7 @@ async def get_node_details(
                 self.send, bytes(mac, UTF8), retries=1
             )
             try:
-                ping_response = await ping_request.send(suppress_node_errors=True)
+                ping_response = await ping_request.send()
             except StickError:
                 return (None, None)
             if ping_response is None:
@@ -230,7 +230,9 @@ async def get_node_details(
         return (info_response, ping_response)
 
     async def send(
-        self, request: PlugwiseRequest, suppress_node_errors: bool = True
+        self,
+        request: PlugwiseRequest,
+        suppress_node_errors=True,
     ) -> PlugwiseResponse | None:
         """Submit request to queue and return response."""
         if not suppress_node_errors:

plugwise_usb/connection/queue.py

@@ -75,46 +75,53 @@ async def stop(self) -> None:
         _LOGGER.debug("queue stopped")
 
     async def submit(self, request: PlugwiseRequest) -> PlugwiseResponse | None:
-        """Add request to queue and return the response of node. Raises an error when something fails."""
+        """Add request to queue and return the received node-response when applicable.
+        
+        Raises an error when something fails.
+        """
         if request.waiting_for_response:
             raise MessageError(
                 f"Cannot send message {request} which is currently waiting for response."
             )
 
-        while request.resend and not request.waiting_for_response:
+        while request.resend:
             _LOGGER.debug("submit | start (%s) %s", request.retries_left, request)
             if not self._running or self._stick is None:
                 raise StickError(
                     f"Cannot send message {request.__class__.__name__} for"
                     + f"{request.mac_decoded} because queue manager is stopped"
                 )
+
             await self._add_request_to_queue(request)
+            if request.no_response:
+                return None
+
             try:
                 response: PlugwiseResponse = await request.response_future()
                 return response
-            except (NodeTimeout, StickTimeout) as e:
+            except (NodeTimeout, StickTimeout) as exc:
                 if isinstance(request, NodePingRequest):
                     # For ping requests it is expected to receive timeouts, so lower log level
                     _LOGGER.debug(
-                        "%s, cancel because timeout is expected for NodePingRequests", e
+                        "%s, cancel because timeout is expected for NodePingRequests", exc
                     )
                 elif request.resend:
-                    _LOGGER.debug("%s, retrying", e)
+                    _LOGGER.debug("%s, retrying", exc)
                 else:
-                    _LOGGER.warning("%s, cancel request", e)  # type: ignore[unreachable]
-            except StickError as exception:
-                _LOGGER.error(exception)
+                    _LOGGER.warning("%s, cancel request", exc)  # type: ignore[unreachable]
+            except StickError as exc:
+                _LOGGER.error(exc)
                 self._stick.correct_received_messages(1)
                 raise StickError(
                     f"No response received for {request.__class__.__name__} "
                     + f"to {request.mac_decoded}"
-                ) from exception
-            except BaseException as exception:
+                ) from exc
+            except BaseException as exc:
                 self._stick.correct_received_messages(1)
                 raise StickError(
                     f"No response received for {request.__class__.__name__} "
                     + f"to {request.mac_decoded}"
-                ) from exception
+                ) from exc
 
         return None
 
@@ -132,7 +139,7 @@ async def _send_queue_worker(self) -> None:
         _LOGGER.debug("Send_queue_worker started")
         while self._running and self._stick is not None:
             request = await self._submit_queue.get()
-            _LOGGER.debug("Send from send queue %s", request)
+            _LOGGER.debug("Sending from send queue %s", request)
             if request.priority == Priority.CANCEL:
                 self._submit_queue.task_done()
                 return

plugwise_usb/connection/receiver.py

@@ -271,6 +271,7 @@ async def _put_message_in_queue(
         _LOGGER.debug("Add response to queue: %s", response)
         await self._message_queue.put(response)
         if self._message_worker_task is None or self._message_worker_task.done():
+            _LOGGER.debug("Queue: start new worker-task")
             self._message_worker_task = self._loop.create_task(
                 self._message_queue_worker(),
                 name="Plugwise message receiver queue worker",
@@ -281,6 +282,7 @@ async def _message_queue_worker(self) -> None:
         _LOGGER.debug("Message queue worker started")
         while self.is_connected:
             response: PlugwiseResponse = await self._message_queue.get()
+            _LOGGER.debug("Priority: %s", response.priority)
             if response.priority == Priority.CANCEL:
                 self._message_queue.task_done()
                 return
@@ -511,5 +513,4 @@ async def _notify_node_response_subscribers(
             name=f"Postpone subscription task for {node_response.seq_id!r} retry {node_response.retries}",
         )
 
-
 # endregion

plugwise_usb/connection/sender.py

@@ -75,13 +75,15 @@ async def write_request_to_port(self, request: PlugwiseRequest) -> None:
         self._stick_response = self._loop.create_future()
 
         request.add_send_attempt()
-        _LOGGER.info("Send %s", request)
+        _LOGGER.info("Sending %s", request)
 
         # Write message to serial port buffer
         serialized_data = request.serialize()
         _LOGGER.debug("write_request_to_port | Write %s to port as %s", request, serialized_data)
         self._transport.write(serialized_data)
-        request.start_response_timeout()
+        # Don't timeout when no response expected
+        if not request.no_response:
+            request.start_response_timeout()
 
         # Wait for USB stick to accept request
         try:
@@ -118,7 +120,7 @@ async def write_request_to_port(self, request: PlugwiseRequest) -> None:
                         self._receiver.subscribe_to_stick_responses,
                         self._receiver.subscribe_to_node_responses,
                     )
-                _LOGGER.debug("write_request_to_port | request has subscribed : %s", request)
+                    _LOGGER.debug("write_request_to_port | request has subscribed : %s", request)
             elif response.response_type == StickResponseType.TIMEOUT:
                 _LOGGER.warning(
                     "USB-Stick directly responded with communication timeout for %s",

plugwise_usb/constants.py

@@ -30,8 +30,11 @@
 MESSAGE_HEADER: Final = b"\x05\x05\x03\x03"
 
 # Max timeout in seconds
-STICK_TIME_OUT: Final = 11  # Stick responds with timeout messages within 10s.
-NODE_TIME_OUT: Final = 15  # In bigger networks a response from a node could take up a while, so lets use 15 seconds.
+# Stick responds with timeout messages within 10s.
+STICK_TIME_OUT: Final = 11 
+# In bigger networks a response from a Node could take up a while, so lets use 15 seconds.
+NODE_TIME_OUT: Final = 15
+
 MAX_RETRIES: Final = 3
 SUPPRESS_INITIALIZATION_WARNINGS: Final = 10  # Minutes to suppress (expected) communication warning messages after initialization
 

plugwise_usb/messages/__init__.py

@@ -11,7 +11,7 @@
 from ..helpers.util import crc_fun
 
 
-class Priority(int, Enum):
+class Priority(Enum):
     """Message priority levels for USB-stick message requests."""
 
     CANCEL = 0