Support schema 42

test/conftest.py

@@ -246,7 +246,7 @@ def version_data_fixture() -> dict[str, Any]:
         "serverVersion": "test_server_version",
         "homeId": "test_home_id",
         "minSchemaVersion": 0,
-        "maxSchemaVersion": 40,
+        "maxSchemaVersion": 42,
     }
 
 

test/model/test_controller.py

@@ -2233,7 +2233,7 @@ async def test_firmware_events(controller):
     event = Event(
         type="firmware update progress",
         data={
-            "source": "controller",
+            "source": "driver",
             "event": "firmware update progress",
             "progress": {
                 "sentFragments": 1,
@@ -2243,7 +2243,7 @@ async def test_firmware_events(controller):
         },
     )
 
-    controller.receive_event(event)
+    controller.handle_firmware_update_progress(event)
     progress = event.data["firmware_update_progress"]
     assert progress.sent_fragments == 1
     assert progress.total_fragments == 10
@@ -2256,13 +2256,13 @@ async def test_firmware_events(controller):
     event = Event(
         type="firmware update finished",
         data={
-            "source": "controller",
+            "source": "driver",
             "event": "firmware update finished",
             "result": {"status": 255, "success": True},
         },
     )
 
-    controller.receive_event(event)
+    controller.handle_firmware_update_finished(event)
     result = event.data["firmware_update_finished"]
     assert result.status == ControllerFirmwareUpdateStatus.OK
     assert result.success

test/model/test_driver.py

@@ -1,6 +1,7 @@
 """Test the driver model."""
 
 import json
+from unittest.mock import patch
 
 import pytest
 
@@ -409,3 +410,41 @@ def test_config_manager(driver):
     """Test the driver has the config manager property."""
     assert driver.config_manager is not None
     assert driver.config_manager._client is driver.client
+
+
+async def test_firmware_events(driver):
+    """Test firmware events."""
+    assert driver.controller.firmware_update_progress is None
+    event = Event(
+        type="firmware update progress",
+        data={
+            "source": "driver",
+            "event": "firmware update progress",
+            "progress": {
+                "sentFragments": 1,
+                "totalFragments": 10,
+                "progress": 10.0,
+            },
+        },
+    )
+
+    with patch(
+        "zwave_js_server.model.controller.Controller.handle_firmware_update_progress"
+    ) as mock:
+        driver.receive_event(event)
+        assert mock.called
+
+    event = Event(
+        type="firmware update finished",
+        data={
+            "source": "driver",
+            "event": "firmware update finished",
+            "result": {"status": 255, "success": True},
+        },
+    )
+
+    with patch(
+        "zwave_js_server.model.controller.Controller.handle_firmware_update_finished"
+    ) as mock:
+        driver.receive_event(event)
+        assert mock.called

test/test_client.py

@@ -463,7 +463,7 @@ async def test_additional_user_agent_components(client_session, url):
             {
                 "command": "initialize",
                 "messageId": "initialize",
-                "schemaVersion": 40,
+                "schemaVersion": 42,
                 "additionalUserAgentComponents": {
                     "zwave-js-server-python": __version__,
                     "foo": "bar",

test/test_dump.py

@@ -106,7 +106,7 @@ async def test_dump_additional_user_agent_components(
         {
             "command": "initialize",
             "messageId": "initialize",
-            "schemaVersion": 40,
+            "schemaVersion": 42,
             "additionalUserAgentComponents": {
                 "zwave-js-server-python": __version__,
                 "foo": "bar",

test/test_main.py

@@ -58,7 +58,7 @@ def test_dump_state(
     assert captured.out == (
         "{'type': 'version', 'driverVersion': 'test_driver_version', "
         "'serverVersion': 'test_server_version', 'homeId': 'test_home_id', "
-        "'minSchemaVersion': 0, 'maxSchemaVersion': 40}\n"
+        "'minSchemaVersion': 0, 'maxSchemaVersion': 42}\n"
         "{'type': 'result', 'success': True, 'result': {}, 'messageId': 'initialize'}\n"
         "test_result\n"
     )

zwave_js_server/const/__init__.py

@@ -11,9 +11,9 @@
 __version__ = "0.63.0"
 
 # minimal server schema version we can handle
-MIN_SERVER_SCHEMA_VERSION = 39
+MIN_SERVER_SCHEMA_VERSION = 41
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 40
+MAX_SERVER_SCHEMA_VERSION = 42
 
 VALUE_UNKNOWN = "unknown"
 

zwave_js_server/model/controller/event_model.py

@@ -7,10 +7,6 @@
 from ...const import InclusionState, InclusionStrategy, RemoveNodeReason
 from ...event import BaseEventModel
 from ..node.data_model import FoundNodeDataType, NodeDataType
-from .firmware import (
-    ControllerFirmwareUpdateProgressDataType,
-    ControllerFirmwareUpdateResultDataType,
-)
 from .inclusion_and_provisioning import InclusionGrantDataType
 from .statistics import ControllerStatisticsDataType
 
@@ -46,38 +42,6 @@ class ExclusionStoppedEventModel(BaseControllerEventModel):
     event: Literal["exclusion stopped"]
 
 
-class FirmwareUpdateFinishedEventModel(BaseControllerEventModel):
-    """Model for `firmware update finished` event data."""
-
-    event: Literal["firmware update finished"]
-    result: ControllerFirmwareUpdateResultDataType
-
-    @classmethod
-    def from_dict(cls, data: dict) -> FirmwareUpdateFinishedEventModel:
-        """Initialize from dict."""
-        return cls(
-            source=data["source"],
-            event=data["event"],
-            result=data["result"],
-        )
-
-
-class FirmwareUpdateProgressEventModel(BaseControllerEventModel):
-    """Model for `firmware update progress` event data."""
-
-    event: Literal["firmware update progress"]
-    progress: ControllerFirmwareUpdateProgressDataType
-
-    @classmethod
-    def from_dict(cls, data: dict) -> FirmwareUpdateProgressEventModel:
-        """Initialize from dict."""
-        return cls(
-            source=data["source"],
-            event=data["event"],
-            progress=data["progress"],
-        )
-
-
 class GrantSecurityClassesEventModel(BaseControllerEventModel):
     """Model for `grant security classes` event data."""
 
@@ -343,8 +307,6 @@ def from_dict(cls, data: dict) -> StatusChangedEventModel:
     "exclusion failed": ExclusionFailedEventModel,
     "exclusion started": ExclusionStartedEventModel,
     "exclusion stopped": ExclusionStoppedEventModel,
-    "firmware update finished": FirmwareUpdateFinishedEventModel,
-    "firmware update progress": FirmwareUpdateProgressEventModel,
     "grant security classes": GrantSecurityClassesEventModel,
     "rebuild routes done": RebuildRoutesDoneEventModel,
     "rebuild routes progress": RebuildRoutesProgressEventModel,

zwave_js_server/model/driver.py

@@ -7,6 +7,10 @@
 from ..event import BaseEventModel, Event, EventBase
 from .config_manager import ConfigManager
 from .controller import Controller
+from .controller.firmware import (
+    ControllerFirmwareUpdateProgressDataType,
+    ControllerFirmwareUpdateResultDataType,
+)
 from .log_config import LogConfig, LogConfigDataType
 from .log_message import LogMessage, LogMessageDataType
 
@@ -58,11 +62,45 @@ class DriverReadyEventModel(BaseDriverEventModel):
     event: Literal["driver ready"]
 
 
+class FirmwareUpdateFinishedEventModel(BaseDriverEventModel):
+    """Model for `firmware update finished` event data."""
+
+    event: Literal["firmware update finished"]
+    result: ControllerFirmwareUpdateResultDataType
+
+    @classmethod
+    def from_dict(cls, data: dict) -> FirmwareUpdateFinishedEventModel:
+        """Initialize from dict."""
+        return cls(
+            source=data["source"],
+            event=data["event"],
+            result=data["result"],
+        )
+
+
+class FirmwareUpdateProgressEventModel(BaseDriverEventModel):
+    """Model for `firmware update progress` event data."""
+
+    event: Literal["firmware update progress"]
+    progress: ControllerFirmwareUpdateProgressDataType
+
+    @classmethod
+    def from_dict(cls, data: dict) -> FirmwareUpdateProgressEventModel:
+        """Initialize from dict."""
+        return cls(
+            source=data["source"],
+            event=data["event"],
+            progress=data["progress"],
+        )
+
+
 DRIVER_EVENT_MODEL_MAP: dict[str, type[BaseDriverEventModel]] = {
     "all nodes ready": AllNodesReadyEventModel,
     "log config updated": LogConfigUpdatedEventModel,
     "logging": LoggingEventModel,
     "driver ready": DriverReadyEventModel,
+    "firmware update finished": FirmwareUpdateFinishedEventModel,
+    "firmware update progress": FirmwareUpdateProgressEventModel,
 }
 
 
@@ -210,3 +248,11 @@ def handle_all_nodes_ready(self, event: Event) -> None:
 
     def handle_driver_ready(self, event: Event) -> None:
         """Process a driver ready event."""
+
+    def handle_firmware_update_progress(self, event: Event) -> None:
+        """Process a firmware update progress event."""
+        self.controller.handle_firmware_update_progress(event)
+
+    def handle_firmware_update_finished(self, event: Event) -> None:
+        """Process a firmware update finished event."""
+        self.controller.handle_firmware_update_finished(event)

zwave_js_server/model/node/data_model.py

@@ -67,3 +67,4 @@ class NodeDataType(TypedDict, total=False):
     defaultVolume: int | float | None
     defaultTransitionDuration: int | float | None
     protocol: int
+    sdkVersion: str | None