zwave-js-server-python 0.36.0__tar.gz → 0.37.0__tar.gz

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.36.0
+Version: 0.37.0
 Summary: Python wrapper for zwave-js-server
 Home-page: https://github.com/home-assistant-libs/zwave-js-server-python
 Author: Home Assistant Team

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/setup.py

@@ -5,7 +5,7 @@ from setuptools import find_packages, setup
 
 PROJECT_DIR = Path(__file__).parent.resolve()
 README_FILE = PROJECT_DIR / "README.md"
-VERSION = "0.36.0"
+VERSION = "0.37.0"
 
 
 setup(
@@ -19,6 +19,7 @@ setup(
     long_description=README_FILE.read_text(encoding="utf-8"),
     long_description_content_type="text/markdown",
     packages=find_packages(exclude=["test.*", "test"]),
+    package_data={"zwave_js_server": ["py.typed"]},
     python_requires=">=3.8",
     install_requires=["aiohttp>3", "pydantic>=1.9.0"],
     entry_points={

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/test/test_main.py

@@ -64,7 +64,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': 16}\n"
+        "'minSchemaVersion': 0, 'maxSchemaVersion': 17}\n"
         "{'type': 'result', 'success': True, 'result': {}, 'messageId': 'api-schema-id'}\n"
         "test_result\n"
     )

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/const/__init__.py

@@ -3,9 +3,9 @@ import sys
 from enum import Enum, IntEnum
 
 # minimal server schema version we can handle
-MIN_SERVER_SCHEMA_VERSION = 16
+MIN_SERVER_SCHEMA_VERSION = 17
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 16
+MAX_SERVER_SCHEMA_VERSION = 17
 
 TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED = sys.version_info < (3, 9, 2)
 
@@ -317,3 +317,11 @@ class RssiError(IntEnum):
     NOT_AVAILABLE = 127
     RECEIVER_SATURATED = 126
     NO_SIGNAL_DETECTED = 125
+
+
+class ProvisioningEntryStatus(IntEnum):
+    """Enum for all known provisioning entry statuses."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L136
+    ACTIVE = 0
+    INACTIVE = 1

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/controller/__init__.py

@@ -278,17 +278,19 @@ class Controller(EventBase):
         )
 
     async def async_get_provisioning_entry(
-        self, dsk: str
+        self, dsk_or_node_id: Union[str, int]
     ) -> Optional[ProvisioningEntry]:
         """Send getProvisioningEntry command to Controller."""
         data = await self.client.async_send_command(
             {
                 "command": "controller.get_provisioning_entry",
-                "dsk": dsk,
+                "dskOrNodeId": dsk_or_node_id,
             },
-            require_schema=11,
+            require_schema=17,
         )
-        return ProvisioningEntry.from_dict(data["entry"])
+        if "entry" in data:
+            return ProvisioningEntry.from_dict(data["entry"])
+        return None
 
     async def async_get_provisioning_entries(self) -> List[ProvisioningEntry]:
         """Send getProvisioningEntries command to Controller."""
@@ -307,7 +309,9 @@ class Controller(EventBase):
         )
         return cast(bool, data["success"])
 
-    async def async_begin_exclusion(self, unprovision: Optional[bool] = None) -> bool:
+    async def async_begin_exclusion(
+        self, unprovision: Optional[Union[bool, Literal["inactive"]]] = None
+    ) -> bool:
         """Send beginExclusion command to Controller."""
         payload: Dict[str, Union[str, bool]] = {"command": "controller.begin_exclusion"}
         if unprovision is not None:
@@ -766,6 +770,9 @@ class Controller(EventBase):
     def handle_validate_dsk_and_enter_pin(self, event: Event) -> None:
         """Process a validate dsk and enter pin event."""
 
+    def handle_inclusion_aborted(self, event: Event) -> None:
+        """Process an inclusion aborted event."""
+
     def handle_nvm_backup_progress(self, event: Event) -> None:
         """Process a nvm backup progress event."""
         event.data["nvm_backup_progress"] = NVMProgress(

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/controller/event_model.py

@@ -64,6 +64,12 @@ class HealNetworkProgressEventModel(BaseControllerEventModel):
     progress: Dict[int, str]
 
 
+class InclusionAbortedEventModel(BaseControllerEventModel):
+    """Model for `inclusion aborted` event data."""
+
+    event: Literal["inclusion aborted"]
+
+
 class InclusionFailedEventModel(BaseControllerEventModel):
     """Model for `inclusion failed` event data."""
 
@@ -147,6 +153,7 @@ CONTROLLER_EVENT_MODEL_MAP: Dict[str, Type["BaseControllerEventModel"]] = {
     "grant security classes": GrantSecurityClassesEventModel,
     "heal network done": HealNetworkDoneEventModel,
     "heal network progress": HealNetworkProgressEventModel,
+    "inclusion aborted": InclusionAbortedEventModel,
     "inclusion failed": InclusionFailedEventModel,
     "inclusion started": InclusionStartedEventModel,
     "inclusion stopped": InclusionStoppedEventModel,

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/controller/inclusion_and_provisioning.py

@@ -5,6 +5,7 @@ from typing import Any, Dict, List, Optional
 from ...const import (
     TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED,
     Protocols,
+    ProvisioningEntryStatus,
     QRCodeVersion,
     SecurityClass,
 )
@@ -54,28 +55,46 @@ class ProvisioningEntry:
 
     dsk: str
     security_classes: List[SecurityClass]
+    requested_security_classes: Optional[List[SecurityClass]] = None
+    status: ProvisioningEntryStatus = ProvisioningEntryStatus.ACTIVE
     additional_properties: Optional[Dict[str, Any]] = None
 
     def to_dict(self) -> Dict[str, Any]:
         """Return PlannedProvisioning data dict from self."""
-        return {
+        data = {
             "dsk": self.dsk,
             "securityClasses": [sec_cls.value for sec_cls in self.security_classes],
+            "status": self.status.value,
             **(self.additional_properties or {}),
         }
+        if self.requested_security_classes:
+            data["requestedSecurityClasses"] = [
+                sec_cls.value for sec_cls in self.requested_security_classes
+            ]
+        return data
 
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "ProvisioningEntry":
         """Return ProvisioningEntry from data dict."""
-        return cls(
+        cls_instance = cls(
             dsk=data["dsk"],
             security_classes=[
                 SecurityClass(sec_cls) for sec_cls in data["securityClasses"]
             ],
             additional_properties={
-                k: v for k, v in data.items() if k not in {"dsk", "securityClasses"}
+                k: v
+                for k, v in data.items()
+                if k
+                not in {"dsk", "securityClasses", "requestedSecurityClasses", "status"}
             },
         )
+        if "requestedSecurityClasses" in data:
+            cls_instance.requested_security_classes = [
+                SecurityClass(sec_cls) for sec_cls in data["requestedSecurityClasses"]
+            ]
+        if "status" in data:
+            cls_instance.status = ProvisioningEntryStatus(data["status"])
+        return cls_instance
 
 
 @dataclass
@@ -105,6 +124,7 @@ class QRProvisioningInformation(ProvisioningEntry, QRProvisioningInformationMixi
             "version": self.version.value,
             "securityClasses": [sec_cls.value for sec_cls in self.security_classes],
             "dsk": self.dsk,
+            "status": self.status.value,
             "genericDeviceClass": self.generic_device_class,
             "specificDeviceClass": self.specific_device_class,
             "installerIconType": self.installer_icon_type,
@@ -114,6 +134,10 @@ class QRProvisioningInformation(ProvisioningEntry, QRProvisioningInformationMixi
             "applicationVersion": self.application_version,
             **(self.additional_properties or {}),
         }
+        if self.requested_security_classes:
+            data["requestedSecurityClasses"] = [
+                sec_cls.value for sec_cls in self.requested_security_classes
+            ]
         if self.max_inclusion_request_interval is not None:
             data["maxInclusionRequestInterval"] = self.max_inclusion_request_interval
         if self.uuid is not None:
@@ -127,7 +151,7 @@ class QRProvisioningInformation(ProvisioningEntry, QRProvisioningInformationMixi
     @classmethod
     def from_dict(cls, data: Dict[str, Any]) -> "QRProvisioningInformation":
         """Return QRProvisioningInformation from data dict."""
-        return cls(
+        cls_instance = cls(
             version=QRCodeVersion(data["version"]),
             security_classes=[
                 SecurityClass(sec_cls) for sec_cls in data["securityClasses"]
@@ -153,6 +177,7 @@ class QRProvisioningInformation(ProvisioningEntry, QRProvisioningInformationMixi
                 not in {
                     "version",
                     "securityClasses",
+                    "requestedSecurityClasses",
                     "dsk",
                     "genericDeviceClass",
                     "specificDeviceClass",
@@ -164,6 +189,14 @@ class QRProvisioningInformation(ProvisioningEntry, QRProvisioningInformationMixi
                     "maxInclusionRequestInterval",
                     "uuid",
                     "supportedProtocols",
+                    "status",
                 }
             },
         )
+        if "requestedSecurityClasses" in data:
+            cls_instance.requested_security_classes = [
+                SecurityClass(sec_cls) for sec_cls in data["requestedSecurityClasses"]
+            ]
+        if "status" in data:
+            cls_instance.status = ProvisioningEntryStatus(data["status"])
+        return cls_instance

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/driver.py

@@ -48,6 +48,7 @@ class CheckConfigUpdates:
 
     def __init__(self, data: dict) -> None:
         """Initialize class."""
+        self.installed_version: str = data["installedVersion"]
         self.update_available: bool = data["updateAvailable"]
         self.new_version: Optional[str] = data.get("newVersion")
 

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/endpoint.py

@@ -8,7 +8,7 @@ from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast
 
 from ..const import TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED, NodeStatus
 from ..event import EventBase
-from ..exceptions import FailedCommand
+from ..exceptions import FailedCommand, NotFoundError
 from .command_class import CommandClass, CommandClassInfo, CommandClassInfoDataType
 from .device_class import DeviceClass, DeviceClassDataType
 from .value import ConfigurationValue, Value
@@ -160,6 +160,10 @@ class Endpoint(EventBase):
         wait_for_result: bool = None,
     ) -> Any:
         """Call endpoint.invoke_cc_api command."""
+        if not any(cc.id == command_class.value for cc in self.command_classes):
+            raise NotFoundError(
+                f"Command class {command_class} not found on endpoint {self}"
+            )
         result = await self.async_send_command(
             "invoke_cc_api",
             commandClass=command_class.value,
@@ -168,7 +172,7 @@ class Endpoint(EventBase):
             require_schema=7,
             wait_for_result=wait_for_result,
         )
-        if result is None:
+        if not result:
             return None
         return result["response"]
 

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/node/__init__.py

@@ -71,8 +71,8 @@ class Node(EventBase):
         super().__init__()
         self.client = client
         self.data: NodeDataType = {}
-        self._device_config: DeviceConfig = DeviceConfig({})
-        self._statistics: NodeStatistics = NodeStatistics(client)
+        self._device_config = DeviceConfig({})
+        self._statistics = NodeStatistics(client, data.get("statistics"))
         self._firmware_update_progress: Optional[FirmwareUpdateProgress] = None
         self.values: Dict[str, Union[ConfigurationValue, Value]] = {}
         self.endpoints: Dict[int, Endpoint] = {}

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/node/statistics.py

@@ -34,7 +34,7 @@ class NodeStatistics:
     """Represent a node statistics update."""
 
     def __init__(
-        self, client: "Client", data: Optional[NodeStatisticsDataType] = None
+        self, client: "Client", data: Optional[NodeStatisticsDataType]
     ) -> None:
         """Initialize node statistics."""
         self.data = data or NodeStatisticsDataType(

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server/model/statistics.py

@@ -1,6 +1,6 @@
 """Common models for statistics."""
 from dataclasses import dataclass
-from typing import TYPE_CHECKING, List, Optional
+from typing import TYPE_CHECKING, List, Optional, Tuple
 
 from zwave_js_server.exceptions import RepeaterRssiErrorReceived, RssiErrorReceived
 
@@ -26,6 +26,16 @@ class RouteStatisticsDataType(TypedDict, total=False):
     routeFailedBetween: List[int]
 
 
+class RouteStatisticsDict(TypedDict):
+    """Represent a route statistics data dict type."""
+
+    protocol_data_rate: int
+    repeaters: List["Node"]
+    rssi: Optional[int]
+    repeater_rssi: List[int]
+    route_failed_between: Optional[Tuple["Node", "Node"]]
+
+
 @dataclass
 class RouteStatistics:
     """Represent route statistics."""
@@ -69,9 +79,28 @@ class RouteStatistics:
         return repeater_rssi
 
     @property
-    def route_failed_between(self) -> Optional[List["Node"]]:
+    def route_failed_between(self) -> Optional[Tuple["Node", "Node"]]:
         """Return route failed between."""
         if (node_ids := self.data.get("routeFailedBetween")) is None:
             return None
         assert self.client.driver
-        return [self.client.driver.controller.nodes[node_id] for node_id in node_ids]
+        assert len(node_ids) == 2
+        return (
+            self.client.driver.controller.nodes[node_ids[0]],
+            self.client.driver.controller.nodes[node_ids[1]],
+        )
+
+    def as_dict(self) -> RouteStatisticsDict:
+        """Return route statistics as dict."""
+        return {
+            "protocol_data_rate": self.protocol_data_rate.value,
+            "repeaters": self.repeaters,
+            "rssi": self.data.get("rssi"),
+            "repeater_rssi": self.data.get("repeaterRSSI", []),
+            "route_failed_between": (
+                self.route_failed_between[0],
+                self.route_failed_between[1],
+            )
+            if self.route_failed_between
+            else None,
+        }

{zwave-js-server-python-0.36.0 → zwave-js-server-python-0.37.0}/zwave_js_server_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.36.0
+Version: 0.37.0
 Summary: Python wrapper for zwave-js-server
 Home-page: https://github.com/home-assistant-libs/zwave-js-server-python
 Author: Home Assistant Team