zwave-js-server-python 0.40.0__py3-none-any.whl → 0.41.0__py3-none-any.whl

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 = 21
+MIN_SERVER_SCHEMA_VERSION = 22
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 21
+MAX_SERVER_SCHEMA_VERSION = 22
 
 TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED = sys.version_info < (3, 9, 2)
 
@@ -204,6 +204,24 @@ class ConfigurationValueType(str, Enum):
     UNDEFINED = "undefined"
 
 
+class NodeType(IntEnum):
+    """Enum with all Node types."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/capabilities/NodeInfo.ts#L151-L156
+    CONTROLLER = 0
+    END_NODE = 1
+
+
+# Exclusion enums
+class ExclusionStrategy(IntEnum):
+    """Enum with all exclusion strategies."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L49-L56
+    EXCLUDE_ONLY = 0
+    DISABLE_PROVISIONING_ENTRY = 1
+    UNPROVISION = 2
+
+
 # Inclusion enums
 class InclusionStrategy(IntEnum):
     """Enum for all known inclusion strategies."""

zwave_js_server/model/controller/__init__.py

@@ -6,8 +6,10 @@ from zwave_js_server.model.firmware import FirmwareUpdateFileInfo, FirmwareUpdat
 
 from ...const import (
     MINIMUM_QR_STRING_LENGTH,
+    ExclusionStrategy,
     InclusionState,
     InclusionStrategy,
+    NodeType,
     QRCodeVersion,
     RFRegion,
     ZwaveFeature,
@@ -87,9 +89,9 @@ class Controller(EventBase):
         return self.data.get("ownNodeId")
 
     @property
-    def is_secondary(self) -> Optional[bool]:
-        """Return is_secondary."""
-        return self.data.get("isSecondary")  # TODO: This is missing in the docs.
+    def is_primary(self) -> Optional[bool]:
+        """Return is_primary."""
+        return self.data.get("isPrimary")
 
     @property
     def is_using_home_id_from_other_network(self) -> Optional[bool]:
@@ -107,14 +109,16 @@ class Controller(EventBase):
         return self.data.get("wasRealPrimary")
 
     @property
-    def is_static_update_controller(self) -> Optional[bool]:
-        """Return is_static_update_controller."""
-        return self.data.get("isStaticUpdateController")
+    def is_suc(self) -> Optional[bool]:
+        """Return is_suc."""
+        return self.data.get("isSUC")
 
     @property
-    def is_slave(self) -> Optional[bool]:
-        """Return is_slave."""
-        return self.data.get("isSlave")
+    def node_type(self) -> Optional[NodeType]:
+        """Return node_type."""
+        if (node_type := self.data.get("nodeType")) is not None:
+            return NodeType(node_type)
+        return None
 
     @property
     def firmware_version(self) -> Optional[str]:
@@ -312,13 +316,15 @@ class Controller(EventBase):
         return cast(bool, data["success"])
 
     async def async_begin_exclusion(
-        self, unprovision: Optional[Union[bool, Literal["inactive"]]] = None
+        self, strategy: Optional[ExclusionStrategy] = None
     ) -> bool:
         """Send beginExclusion command to Controller."""
-        payload: Dict[str, Union[str, bool]] = {"command": "controller.begin_exclusion"}
-        if unprovision is not None:
-            payload["unprovision"] = unprovision
-        data = await self.client.async_send_command(payload)
+        payload: Dict[str, Union[str, ExclusionStrategy]] = {
+            "command": "controller.begin_exclusion"
+        }
+        if strategy is not None:
+            payload["strategy"] = strategy
+        data = await self.client.async_send_command(payload, require_schema=22)
         return cast(bool, data["success"])
 
     async def async_stop_exclusion(self) -> bool:
@@ -707,15 +713,16 @@ class Controller(EventBase):
         return cast(bool, data["progress"])
 
     async def async_get_available_firmware_updates(
-        self, node: Node
+        self, node: Node, api_key: str
     ) -> List[FirmwareUpdateInfo]:
         """Send getAvailableFirmwareUpdates command to Controller."""
         data = await self.client.async_send_command(
             {
                 "command": "controller.get_available_firmware_updates",
                 "nodeId": node.node_id,
+                "apiKey": api_key,
             },
-            require_schema=21,
+            require_schema=22,
         )
         assert data
         return [FirmwareUpdateInfo.from_dict(update) for update in data["updates"]]

zwave_js_server/model/controller/data_model.py

@@ -17,12 +17,12 @@ class ControllerDataType(TypedDict, total=False):
     type: int
     homeId: int
     ownNodeId: int
-    isSecondary: bool  # TODO: The following items are missing in the docs.
-    isUsingHomeIdFromOtherNetwork: bool
+    isPrimary: bool
+    isSUC: bool
+    nodeType: int
+    isUsingHomeIdFromOtherNetwork: bool  # TODO: The following items are missing in the docs.
     isSISPresent: bool
     wasRealPrimary: bool
-    isStaticUpdateController: bool
-    isSlave: bool
     firmwareVersion: str
     manufacturerId: int
     productType: int

zwave_js_server/model/controller/event_model.py

@@ -3,7 +3,7 @@ from typing import Dict, Literal, Type
 
 from ...const import TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED
 from ...event import BaseEventModel
-from ..node.data_model import NodeDataType
+from ..node.data_model import FoundNodeDataType, NodeDataType
 from .inclusion_and_provisioning import InclusionGrantDataType
 from .statistics import ControllerStatisticsDataType
 
@@ -101,7 +101,7 @@ class NodeFoundEventModel(BaseControllerEventModel):
     """Model for `node found` event data."""
 
     event: Literal["node found"]
-    node: NodeDataType
+    node: FoundNodeDataType
 
 
 class NodeRemovedEventModel(BaseControllerEventModel):

zwave_js_server/model/node/__init__.py

@@ -706,6 +706,14 @@ class Node(EventBase):
         )
         self.data["keepAwake"] = keep_awake
 
+    async def async_interview(self) -> None:
+        """Interview node."""
+        await self.async_send_command(
+            "interview",
+            wait_for_result=False,
+            require_schema=22,
+        )
+
     def handle_test_powerlevel_progress(self, event: Event) -> None:
         """Process a test power level progress event."""
         event.data["test_power_level_progress"] = TestPowerLevelProgress(

zwave_js_server/model/node/data_model.py

@@ -14,6 +14,13 @@ else:
     from typing import TypedDict
 
 
+class FoundNodeDataType(TypedDict, total=False):
+    """Represent a found node data dict type."""
+
+    nodeId: int
+    deviceClass: DeviceClassDataType
+
+
 class NodeDataType(TypedDict, total=False):
     """Represent a node data dict type."""
 

{zwave_js_server_python-0.40.0.dist-info → zwave_js_server_python-0.41.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.40.0
+Version: 0.41.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.40.0.dist-info → zwave_js_server_python-0.41.0.dist-info}/RECORD

@@ -7,7 +7,7 @@ zwave_js_server/exceptions.py,sha256=guJlsUNQMGl-P8dVydup686_xzpbzCkd1870RbqZ6PE
 zwave_js_server/firmware.py,sha256=Wo_o2e_jHeuX0mDTFUEJ-l_m3QOkXIwVFsLxBLYAC8E,1139
 zwave_js_server/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 zwave_js_server/version.py,sha256=RDFP2kSU3cCVIQbgMWggdeDnvhtVsZzzZg9pOjH7CC8,364
-zwave_js_server/const/__init__.py,sha256=zgv0hmw9-QKwxxsif4wEBPDeRvErypdhrqxxkYwEXBU,8506
+zwave_js_server/const/__init__.py,sha256=FLs78YmjFDzHQgUsaMIf1OaTB2aSd_FyA5wmKV4S1HE,9014
 zwave_js_server/const/command_class/__init__.py,sha256=WilOppnr9CXahDjEEkAXyh_j7iCq_qZ1GtBkjWLoQUg,37
 zwave_js_server/const/command_class/barrier_operator.py,sha256=NBhTp5T-6T31glpIKrEOLgbKTndkB5gqdQmCJlXFFUA,783
 zwave_js_server/const/command_class/color_switch.py,sha256=9jIDdmz8gJ5d1RdINHiK7Yh0NXg1I0U1xVzkrQJICk8,918
@@ -38,13 +38,13 @@ zwave_js_server/model/statistics.py,sha256=uG87o-iNGKHxJc4Kfr2ZJ0VY7NjCbdxwgWOqu
 zwave_js_server/model/utils.py,sha256=fLs1pOKG53yWQggBWUKvPgzlT0JkK3biLzRkhPBNArI,814
 zwave_js_server/model/value.py,sha256=dV6a3QMga1T-KfCQsle6lauK9rxSzd6rhF-eldRaJOU,8754
 zwave_js_server/model/version.py,sha256=W1H-UbhKdgMW5KdnY9MUfRFibfMZSOD3nljXOv1ZVVM,1398
-zwave_js_server/model/controller/__init__.py,sha256=jlekvMwT1nTVrY0ocMnFz9b0XPy50RzwLGKn1Q_08Ug,31321
-zwave_js_server/model/controller/data_model.py,sha256=On7ZCEe5-vbVPs_ucFqlquxpjilT2TDGtiZwE8odtV4,970
-zwave_js_server/model/controller/event_model.py,sha256=PseC6YMT4NSRovUKbdYy_lZtB0qe1ujspK3W7miJ1rU,5137
+zwave_js_server/model/controller/__init__.py,sha256=cpf9iVt2deMGTXZ7pwkX9gERVgaQEjOVxl8mZU4lUBc,31419
+zwave_js_server/model/controller/data_model.py,sha256=XepG9ICR3ooRwQuMOZPL5QG9mHCcMfH5-sa_GWISAdg,949
+zwave_js_server/model/controller/event_model.py,sha256=pDk0t_czfnpL107Z9OiiOyO3ZpQ70KgPXR9_5YX2V3c,5161
 zwave_js_server/model/controller/inclusion_and_provisioning.py,sha256=01YUq4YBhQe3gmJAIsN6ctMM3pcLEaGMSyIySBI9v2c,7497
 zwave_js_server/model/controller/statistics.py,sha256=7aeFjKq_-TvcHBWc-a4xQP6wvO3GoGjr9P-m8uyOco8,4031
-zwave_js_server/model/node/__init__.py,sha256=XEjQH3h6ZpaqzhkcTISDqLd7GhLbutB3WdITCV9bwOY,31078
-zwave_js_server/model/node/data_model.py,sha256=Zdl68Oa9vUn2wegriFOcU70Q2yJO41rGKpdAdIbbtAU,1730
+zwave_js_server/model/node/__init__.py,sha256=b9YxVXtosDDHSwBSqVZplGnIww9IyBWWK8MD17UHiPA,31294
+zwave_js_server/model/node/data_model.py,sha256=x7Nx4-l0K7fp4uJOXNhv2xDPzrhYcEFMbsbtsss5l6M,1884
 zwave_js_server/model/node/event_model.py,sha256=kY-HxdRpJUGiQaM4T7DInQBJ4rf4pw1JY-nImsF-1kY,6055
 zwave_js_server/model/node/health_check.py,sha256=EAOMBkMKd5q--fhax2GvJhWdhuuv5dX_-2Hf_mczODs,6054
 zwave_js_server/model/node/statistics.py,sha256=SgAdnXnvC-Hs2GdBvENz1mkbtnXOUf5E0s2OU0iUARE,3634
@@ -56,9 +56,9 @@ zwave_js_server/util/node.py,sha256=KUg-Z-7hdDLGKKCYLktc4oOgiPbDT7ZUYqUH_IPLwO4,
 zwave_js_server/util/command_class/__init__.py,sha256=sRxti47ekLTzfk8B609CMQumIbcD6mon2ZS0zwh9omY,59
 zwave_js_server/util/command_class/meter.py,sha256=Qkif1ul4KpV_k6Dc7yNXlSjlJLLTH8mCitgQk9J9W0A,1277
 zwave_js_server/util/command_class/multilevel_sensor.py,sha256=p92YLNRze5z3UWhfIDJO95F-j5tqx1PKUG9oamo9Dng,1446
-zwave_js_server_python-0.40.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-zwave_js_server_python-0.40.0.dist-info/METADATA,sha256=tkC4RpKYTXDjvkENk8t4pv2YsrHP0GRAsxyyYXvD7nA,1712
-zwave_js_server_python-0.40.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-zwave_js_server_python-0.40.0.dist-info/entry_points.txt,sha256=_8Swg1yhKiBElo6k1fxIEd6E8uPz8PDxQpwQoZ29FZE,74
-zwave_js_server_python-0.40.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
-zwave_js_server_python-0.40.0.dist-info/RECORD,,
+zwave_js_server_python-0.41.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+zwave_js_server_python-0.41.0.dist-info/METADATA,sha256=UWYOfP1-q--FhdMEJHWKivdCuzEImzUhalh_cOJGPl4,1712
+zwave_js_server_python-0.41.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+zwave_js_server_python-0.41.0.dist-info/entry_points.txt,sha256=_8Swg1yhKiBElo6k1fxIEd6E8uPz8PDxQpwQoZ29FZE,74
+zwave_js_server_python-0.41.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
+zwave_js_server_python-0.41.0.dist-info/RECORD,,