zwave-js-server-python 0.32.0__tar.gz → 0.33.0__tar.gz

{zwave-js-server-python-0.32.0 → zwave-js-server-python-0.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.32.0
+Version: 0.33.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.32.0 → zwave-js-server-python-0.33.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.32.0"
+VERSION = "0.33.0"
 
 
 setup(

{zwave-js-server-python-0.32.0 → zwave-js-server-python-0.33.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': 11}\n"
+        "'minSchemaVersion': 0, 'maxSchemaVersion': 12}\n"
         "{'type': 'result', 'success': True, 'result': {}, 'messageId': 'api-schema-id'}\n"
         "test_result\n"
     )

{zwave-js-server-python-0.32.0 → zwave-js-server-python-0.33.0}/zwave_js_server/const/__init__.py

@@ -2,9 +2,9 @@
 from enum import Enum, IntEnum
 
 # minimal server schema version we can handle
-MIN_SERVER_SCHEMA_VERSION = 11
+MIN_SERVER_SCHEMA_VERSION = 12
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 11
+MAX_SERVER_SCHEMA_VERSION = 12
 
 VALUE_UNKNOWN = "unknown"
 
@@ -237,3 +237,14 @@ class Protocols(IntEnum):
     # https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/capabilities/Protocols.ts#L1-L4
     ZWAVE = 0
     ZWAVE_LONG_RANGE = 1
+
+
+# https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/security/QR.ts#L41
+MINIMUM_QR_STRING_LENGTH = 52
+
+
+class ZwaveFeature(IntEnum):
+    """Enum for all known Zwave features."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Features.ts#L4
+    SMART_START = 0

{zwave-js-server-python-0.32.0 → zwave-js-server-python-0.33.0}/zwave_js_server/model/controller.py

@@ -12,7 +12,14 @@ from typing import (
     cast,
 )
 
-from ..const import InclusionStrategy, Protocols, QRCodeVersion, SecurityClass
+from ..const import (
+    MINIMUM_QR_STRING_LENGTH,
+    InclusionStrategy,
+    Protocols,
+    QRCodeVersion,
+    SecurityClass,
+    ZwaveFeature,
+)
 from ..event import Event, EventBase
 from .association import Association, AssociationGroup
 from .node import Node
@@ -442,9 +449,26 @@ class Controller(EventBase):
             require_schema = 11
             # String is assumed to be the QR code string so we can pass as is
             if isinstance(provisioning, str):
+                if len(
+                    provisioning
+                ) < MINIMUM_QR_STRING_LENGTH or not provisioning.startswith("90"):
+                    raise ValueError(
+                        f"QR code string must be at least {MINIMUM_QR_STRING_LENGTH} characters "
+                        "long and start with `90`"
+                    )
                 options["provisioning"] = provisioning
+            # If we get a Smart Start QR code, we provision the node and return because
+            # inclusion is over
+            elif (
+                isinstance(provisioning, QRProvisioningInformation)
+                and provisioning.version == QRCodeVersion.SMART_START
+            ):
+                raise ValueError(
+                    "Smart Start QR codes can't use the normal inclusion process. Use the "
+                    "provision_smart_start_node command to provision this device."
+                )
             # Otherwise we assume the data is ProvisioningEntry or
-            # QRProvisioningInformation
+            # QRProvisioningInformation that is not a Smart Start QR code
             else:
                 options["provisioning"] = provisioning.to_dict()
 
@@ -462,6 +486,13 @@ class Controller(EventBase):
         provisioning_info: Union[ProvisioningEntry, QRProvisioningInformation, str],
     ) -> None:
         """Send provisionSmartStartNode command to Controller."""
+        if (
+            isinstance(provisioning_info, QRProvisioningInformation)
+            and provisioning_info.version == QRCodeVersion.S2
+        ):
+            raise ValueError(
+                "An S2 QR Code can't be used to pre-provision a Smart Start node"
+            )
         await self.client.async_send_command(
             {
                 "command": "controller.provision_smart_start_node",
@@ -573,11 +604,19 @@ class Controller(EventBase):
             require_schema = 11
             # String is assumed to be the QR code string so we can pass as is
             if isinstance(provisioning, str):
+                if len(
+                    provisioning
+                ) < MINIMUM_QR_STRING_LENGTH or not provisioning.startswith("90"):
+                    raise ValueError(
+                        f"QR code string must be at least {MINIMUM_QR_STRING_LENGTH} characters "
+                        "long and start with `90`"
+                    )
                 options["provisioning"] = provisioning
             # Otherwise we assume the data is ProvisioningEntry or
             # QRProvisioningInformation
             else:
                 options["provisioning"] = provisioning.to_dict()
+
         data = await self.client.async_send_command(
             {
                 "command": "controller.replace_failed_node",
@@ -751,6 +790,19 @@ class Controller(EventBase):
             }
         )
 
+    async def async_supports_feature(self, feature: ZwaveFeature) -> Optional[bool]:
+        """
+        Send supportsFeature command to Controller.
+
+        When None is returned it means the driver does not yet know whether the
+        controller supports the input feature.
+        """
+        data = await self.client.async_send_command(
+            {"command": "controller.supports_feature", "feature": feature.value},
+            require_schema=12,
+        )
+        return cast(Optional[bool], data.get("supported"))
+
     def receive_event(self, event: Event) -> None:
         """Receive an event."""
         if event.data["source"] == "node":

{zwave-js-server-python-0.32.0 → zwave-js-server-python-0.33.0}/zwave_js_server/model/utils.py

@@ -1,4 +1,5 @@
 """Model for utils commands."""
+from zwave_js_server.const import MINIMUM_QR_STRING_LENGTH
 from ..client import Client
 from .controller import QRProvisioningInformation
 
@@ -7,6 +8,13 @@ async def async_parse_qr_code_string(
     client: Client, qr_code_string: str
 ) -> QRProvisioningInformation:
     """Parse a QR code string into a QRProvisioningInformation object."""
+    if len(qr_code_string) < MINIMUM_QR_STRING_LENGTH or not qr_code_string.startswith(
+        "90"
+    ):
+        raise ValueError(
+            f"QR code string must be at least {MINIMUM_QR_STRING_LENGTH} characters "
+            "long and start with `90`"
+        )
     data = await client.async_send_command(
         {"command": "utils.parse_qr_code_string", "qr": qr_code_string}
     )

{zwave-js-server-python-0.32.0 → zwave-js-server-python-0.33.0}/zwave_js_server_python.egg-info/PKG-INFO

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