Merge branch 'main' into disable-chip-native-logger

Author: marcelveldt

.github/workflows/release.yml

@@ -3,6 +3,9 @@ name: Publish releases
 on:
   release:
     types: [published]
+env:
+  PYTHON_VERSION: "3.10"
+  NODE_VERSION: "18.x"
 
 jobs:
   build-and-publish-pypi:
@@ -28,10 +31,14 @@ jobs:
               exit 1
             fi
           fi
-      - name: Set up Python 3.10
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
         uses: actions/setup-python@v5.0.0
         with:
-          python-version: "3.10"
+          python-version: ${{ env.PYTHON_VERSION }}
+      - name: Set up Node ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
       - name: Install build
         run: >-
           pip install build tomli tomli-w
@@ -48,7 +55,13 @@ jobs:
 
           with open("pyproject.toml", "wb") as f:
             tomli_w.dump(pyproject, f)
-      - name: Build
+      - name: Build dashboard
+        run: |
+          cd dashboard
+          script/setup
+          script/build
+          cd ..
+      - name: Build python package
         run: >-
           python3 -m build
       - name: Publish release to PyPI
@@ -69,9 +82,9 @@ jobs:
       - name: Log in to the GitHub container registry
         uses: docker/login-action@v3.0.0
         with:
-            registry: ghcr.io
-            username: ${{ github.repository_owner }}
-            password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3.1.0
       - name: Version number for tags
@@ -95,8 +108,7 @@ jobs:
             ghcr.io/${{ github.repository_owner }}/python-matter-server:${{ steps.tags.outputs.major }},
             ghcr.io/${{ github.repository_owner }}/python-matter-server:stable
           push: true
-          build-args:
-            "PYTHON_MATTER_SERVER=${{ needs.build-and-publish-pypi.outputs.version }}"
+          build-args: "PYTHON_MATTER_SERVER=${{ needs.build-and-publish-pypi.outputs.version }}"
       - name: Build and Push pre-release
         uses: docker/build-push-action@v5.1.0
         if: github.event.release.prerelease == true
@@ -108,5 +120,4 @@ jobs:
             ghcr.io/${{ github.repository_owner }}/python-matter-server:${{ steps.tags.outputs.patch }},
             ghcr.io/${{ github.repository_owner }}/python-matter-server:beta
           push: true
-          build-args:
-            "PYTHON_MATTER_SERVER=${{ needs.build-and-publish-pypi.outputs.version }}"
+          build-args: "PYTHON_MATTER_SERVER=${{ needs.build-and-publish-pypi.outputs.version }}"

dashboard/src/entrypoint/main.ts

@@ -3,16 +3,19 @@ import { MatterClient } from "../client/client";
 async function main() {
   import("../pages/matter-dashboard-app");
 
-  // Turn httpX url into wsX url and append "/ws"
-  let url = "ws" + new URL("./ws", location.href).toString().substring(4);
-
-  // Inside Home Assistant ingress, we will not prompt for the URL
-  if (!location.pathname.endsWith("/ingress")) {
+  let url = "";
+  // Detect if we're running in the (production) webserver included in the matter server or not.
+  if (location.href.includes(":5580")) {
+    // production server running inside the matter server
+    // Turn httpX url into wsX url and append "/ws"
+    url = "ws" + new URL("./ws", location.href).toString().substring(4);
+  } else {
+    // development server, ask for url to matter server
     let storageUrl = localStorage.getItem("matterURL");
     if (!storageUrl) {
       storageUrl = prompt(
-        "Enter Matter URL",
-        "ws://homeassistant.local:5580/ws"
+        "Enter Websocket URL to a running Matter Server",
+        "ws://localhost:5580/ws"
       );
       if (!storageUrl) {
         alert("Unable to connect without URL");

dashboard/src/pages/matter-dashboard.ts

@@ -28,14 +28,19 @@ class MatterDashboard extends LitElement {
 
   render() {
     const nodes = this.nodeEntries(this.nodes);
+    const isProductionServer = location.href.includes(":5580")
 
     return html`
       <div class="header">
         <div>Python Matter Server</div>
         <div class="actions">
+        ${isProductionServer
+        ? ""
+        : html`
           <md-icon-button @click=${this._disconnect}>
             <ha-svg-icon .path=${mdiLogout}></ha-svg-icon>
           </md-icon-button>
+          `}
         </div>
       </div>
       <div class="container">
@@ -50,20 +55,20 @@ class MatterDashboard extends LitElement {
           </md-list-item>
           <md-divider></md-divider>
           ${nodes.map(([id, node]) => {
-            return html`
+          return html`
               <md-list-item type="link" href=${`#node/${node.node_id}`}>
                 <span slot="start">${node.node_id}</span>
                 <div slot="headline">
                   ${node.vendorName} ${node.productName}
                   ${node.available
-                    ? ""
-                    : html`<span class="status">OFFLINE</span>`}
+              ? ""
+              : html`<span class="status">OFFLINE</span>`}
                 </div>
                 <div slot="supporting-text">${node.serialNumber}</div>
                 <ha-svg-icon slot="end" .path=${mdiChevronRight}></ha-svg-icon>
               </md-list-item>
             `;
-          })}
+        })}
         </md-list>
       </div>
       <div class="footer">

matter_server/client/client.py

@@ -445,24 +445,26 @@ async def read_attribute(
         self,
         node_id: int,
         attribute_path: str,
-    ) -> Any:
-        """Read attribute(s) on a node."""
-        return await self.send_command(
+    ) -> dict[str, Any]:
+        """Read one or more attribute(s) on a node by specifying an attributepath."""
+        updated_values = await self.send_command(
             APICommand.READ_ATTRIBUTE,
             require_schema=4,
             node_id=node_id,
             attribute_path=attribute_path,
         )
+        if not isinstance(updated_values, dict):
+            # can happen is the server is running schema < 8
+            return {attribute_path: updated_values}
+        return cast(dict[str, Any], updated_values)
 
     async def refresh_attribute(
         self,
         node_id: int,
         attribute_path: str,
-    ) -> Any:
+    ) -> None:
         """Read attribute(s) on a node and store the updated value(s)."""
         updated_values = await self.read_attribute(node_id, attribute_path)
-        if not isinstance(updated_values, dict):
-            updated_values = {attribute_path: updated_values}
         for attr_path, value in updated_values.items():
             self._nodes[node_id].update_attribute(attr_path, value)
 

matter_server/server/__main__.py

@@ -115,6 +115,9 @@ def _setup_logging() -> None:
         # a whole list of errors when its trying to bind to internal interfaces on
         # the HA supervisor set-up.
         logging.getLogger("chip.native.DL").setLevel(logging.CRITICAL)
+        # (temporary) raise the log level of zeroconf as its a logs an annoying
+        # warning at startup while trying to bind to a loopback IPv6 interface
+        logging.getLogger("zeroconf").setLevel(logging.ERROR)
 
 
 def main() -> None:

matter_server/server/device_controller.py

@@ -9,6 +9,7 @@
 from datetime import datetime
 from functools import partial
 import logging
+from random import randint
 import time
 from typing import TYPE_CHECKING, Any, Callable, Iterable, TypeVar, cast
 
@@ -98,6 +99,7 @@ def __init__(
         self._nodes: dict[int, MatterNodeData] = {}
         self._last_known_ip_addresses: dict[int, list[str]] = {}
         self._last_subscription_attempt: dict[int, int] = {}
+        self._known_commissioning_params: dict[int, CommissioningParameters] = {}
         self.wifi_credentials_set: bool = False
         self.thread_credentials_set: bool = False
         self.compressed_fabric_id: int | None = None
@@ -403,8 +405,16 @@ async def open_commissioning_window(
         if self.chip_controller is None:
             raise RuntimeError("Device Controller not initialized.")
 
+        if (node := self._nodes.get(node_id)) is None or not node.available:
+            raise NodeNotReady(f"Node {node_id} is not (yet) available.")
+
+        if node_id in self._known_commissioning_params:
+            # node has already been put into commissioning mode,
+            # return previous parameters
+            return self._known_commissioning_params[node_id]
+
         if discriminator is None:
-            discriminator = 3840  # TODO generate random one
+            discriminator = randint(0, 4095)  # noqa: S311
 
         sdk_result = await self._call_sdk(
             self.chip_controller.OpenCommissioningWindow,
@@ -414,11 +424,18 @@ async def open_commissioning_window(
             discriminator=discriminator,
             option=option,
         )
-        return CommissioningParameters(
+        self._known_commissioning_params[node_id] = params = CommissioningParameters(
             setup_pin_code=sdk_result.setupPinCode,
             setup_manual_code=sdk_result.setupManualCode,
             setup_qr_code=sdk_result.setupQRCode,
         )
+        # we store the commission parameters and clear them after the timeout
+        if TYPE_CHECKING:
+            assert self.server.loop
+        self.server.loop.call_later(
+            timeout, self._known_commissioning_params.pop, node_id, None
+        )
+        return params
 
     @api_command(APICommand.DISCOVER)
     async def discover_commissionable_nodes(
@@ -545,8 +562,8 @@ async def send_device_command(
     @api_command(APICommand.READ_ATTRIBUTE)
     async def read_attribute(
         self, node_id: int, attribute_path: str, fabric_filtered: bool = False
-    ) -> Any:
-        """Read a single attribute (or Cluster) on a node."""
+    ) -> dict[str, Any]:
+        """Read one or more attribute(s) on a node by specifying an attributepath."""
         if self.chip_controller is None:
             raise RuntimeError("Device Controller not initialized.")
         if (node := self._nodes.get(node_id)) is None or not node.available:
@@ -576,9 +593,7 @@ async def read_attribute(
             # update cached info in node attributes
             self._nodes[node_id].attributes.update(read_atributes)
             self._write_node_state(node_id)
-            if len(read_atributes) > 1:
-                return read_atributes
-            return read_atributes.get(attribute_path, None)
+            return read_atributes
 
     @api_command(APICommand.WRITE_ATTRIBUTE)
     async def write_attribute(

matter_server/server/helpers/paa_certificates.py

@@ -106,7 +106,7 @@ async def fetch_dcl_certificates(
                     )
                     LAST_CERT_IDS.add(paa["subjectKeyId"])
                     fetch_count += 1
-    except ClientError as err:
+    except (ClientError, TimeoutError) as err:
         LOGGER.warning(
             "Fetching latest certificates failed: error %s", err, exc_info=err
         )
@@ -142,7 +142,7 @@ async def fetch_git_certificates() -> int:
                 await write_paa_root_cert(certificate, cert)
                 LAST_CERT_IDS.add(cert)
                 fetch_count += 1
-    except ClientError as err:
+    except (ClientError, TimeoutError) as err:
         LOGGER.warning(
             "Fetching latest certificates failed: error %s", err, exc_info=err
         )

matter_server/server/server.py

@@ -3,8 +3,11 @@
 from __future__ import annotations
 
 import asyncio
+from functools import partial
 import ipaddress
 import logging
+import os
+from pathlib import Path
 from typing import Any, Callable, Set, cast
 import weakref
 
@@ -31,6 +34,9 @@
 from .storage import StorageController
 from .vendor_info import VendorInfo
 
+DASHBOARD_DIR = Path(__file__).parent.joinpath("../../dashboard/dist/web/").resolve()
+DASHBOARD_DIR_EXISTS = DASHBOARD_DIR.exists()
+
 
 def mount_websocket(server: MatterServer, path: str) -> None:
     """Mount the websocket endpoint."""
@@ -106,7 +112,23 @@ async def start(self) -> None:
         await self.device_controller.start()
         await self.vendor_info.start()
         mount_websocket(self, "/ws")
-        self.app.router.add_route("GET", "/", self._handle_info)
+        self.app.router.add_route("GET", "/info", self._handle_info)
+
+        # Host dashboard if the prebuilt files are detected
+        if DASHBOARD_DIR_EXISTS:
+            dashboard_dir = str(DASHBOARD_DIR)
+            self.logger.debug("Detected dashboard files on %s", dashboard_dir)
+            for abs_dir, _, files in os.walk(dashboard_dir):
+                rel_dir = abs_dir.replace(dashboard_dir, "")
+                for filename in files:
+                    filepath = os.path.join(abs_dir, filename)
+                    handler = partial(self._serve_static, filepath)
+                    if rel_dir == "" and filename == "index.html":
+                        route_path = "/"
+                    else:
+                        route_path = f"{rel_dir}/{filename}"
+                    self.app.router.add_route("GET", route_path, handler)
+
         self._runner = web.AppRunner(self.app, access_log=None)
         await self._runner.setup()
         self._http = MultiHostTCPSite(
@@ -233,3 +255,10 @@ async def _handle_info(self, request: web.Request) -> web.Response:
         """Handle info endpoint to serve basic server (version) info."""
         # pylint: disable=unused-argument
         return web.json_response(self.get_info(), dumps=json_dumps)
+
+    async def _serve_static(
+        self, file_path: str, _request: web.Request
+    ) -> web.FileResponse:
+        """Serve file response."""
+        headers = {"Cache-Control": "no-cache"}
+        return web.FileResponse(file_path, headers=headers)

pyproject.toml

@@ -70,7 +70,7 @@ zip-safe = false
 matter_server = ["py.typed"]
 
 [tool.setuptools.packages.find]
-include = ["matter_server*"]
+include = ["matter_server*", "dashboard/dist/web*"]
 
 [tool.mypy]
 check_untyped_defs = true

tests/server/test_server.py

@@ -119,11 +119,11 @@ async def test_server_start(
     assert application.call_count == 1
     application_instance = application.return_value
     add_route = application_instance.router.add_route
-    assert add_route.call_count == 2
+    assert add_route.call_count >= 2
     assert add_route.call_args_list[0][0][0] == "GET"
     assert add_route.call_args_list[0][0][1] == "/ws"
     assert add_route.call_args_list[1][0][0] == "GET"
-    assert add_route.call_args_list[1][0][1] == "/"
+    assert add_route.call_args_list[1][0][1] == "/info"
     assert app_runner.call_count == 1
     assert app_runner.return_value.setup.call_count == 1
     assert multi_host_tcp_site.call_count == 1