zwave-js-server-python 0.37.2__py3-none-any.whl → 0.38.0__py3-none-any.whl

zwave_js_server/const/__init__.py

@@ -3,14 +3,15 @@ import sys
 from enum import Enum, IntEnum
 
 # minimal server schema version we can handle
-MIN_SERVER_SCHEMA_VERSION = 17
+MIN_SERVER_SCHEMA_VERSION = 18
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 17
+MAX_SERVER_SCHEMA_VERSION = 18
 
 TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED = sys.version_info < (3, 9, 2)
 
 VALUE_UNKNOWN = "unknown"
 
+NOT_INTERVIEWED = "None"
 INTERVIEW_FAILED = "Failed"
 
 CURRENT_STATE_PROPERTY = "currentState"

zwave_js_server/firmware.py

@@ -16,6 +16,7 @@ async def begin_firmware_update(
     file: bytes,
     session: aiohttp.ClientSession,
     file_format: Optional[str] = None,
+    target: Optional[int] = None,
 ) -> None:
     """Send beginFirmwareUpdate command to Node."""
     client = Client(url, session)
@@ -33,7 +34,10 @@ async def begin_firmware_update(
     if file_format is not None:
         cmd["firmwareFileFormat"] = file_format
 
-    await client.async_send_command(cmd, require_schema=5)
+    if target is not None:
+        cmd["target"] = target
+
+    await client.async_send_command(cmd, require_schema=18)
     await client.disconnect()
     if not receive_task.done():
         receive_task.cancel()

zwave_js_server/model/controller/__init__.py

@@ -733,6 +733,9 @@ class Controller(EventBase):
     def handle_exclusion_stopped(self, event: Event) -> None:
         """Process an exclusion stopped event."""
 
+    def handle_node_found(self, event: Event) -> None:
+        """Process a node found event."""
+
     def handle_node_added(self, event: Event) -> None:
         """Process a node added event."""
         node = event.data["node"] = Node(self.client, event.data["node"])

zwave_js_server/model/controller/event_model.py

@@ -97,6 +97,13 @@ class NodeAddedEventModel(BaseControllerEventModel):
     result: InclusionResultDataType
 
 
+class NodeFoundEventModel(BaseControllerEventModel):
+    """Model for `node found` event data."""
+
+    event: Literal["node found"]
+    node: NodeDataType
+
+
 class NodeRemovedEventModel(BaseControllerEventModel):
     """Model for `node removed` event data."""
 
@@ -158,6 +165,7 @@ CONTROLLER_EVENT_MODEL_MAP: Dict[str, Type["BaseControllerEventModel"]] = {
     "inclusion started": InclusionStartedEventModel,
     "inclusion stopped": InclusionStoppedEventModel,
     "node added": NodeAddedEventModel,
+    "node found": NodeFoundEventModel,
     "node removed": NodeRemovedEventModel,
     "nvm backup progress": NVMBackupProgressEventModel,
     "nvm convert progress": NVMConvertProgressEventModel,

zwave_js_server/model/firmware.py

@@ -1,8 +1,8 @@
 """Provide a model for Z-Wave firmware."""
 from enum import IntEnum
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING, List, Optional, Union
 
-from ..const import TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED
+from ..const import TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED, VALUE_UNKNOWN
 
 if TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED:
     from typing_extensions import TypedDict
@@ -13,6 +13,75 @@ if TYPE_CHECKING:
     from .node import Node
 
 
+class FirmwareUpdateCapabilitiesDataType(TypedDict, total=False):
+    """Represent a firmware update capabilities dict type."""
+
+    firmwareUpgradable: bool  # required
+    firmwareTargets: List[int]
+    continuesToFunction: Union[bool, str]
+    supportsActivation: Union[bool, str]
+
+
+class FirmwareUpdateCapabilitiesDict(TypedDict, total=False):
+    """Represent a dict from FirmwareUpdateCapabilities."""
+
+    firmware_upgradable: bool  # required
+    firmware_targets: List[int]
+    continues_to_function: Optional[bool]
+    supports_activation: Optional[bool]
+
+
+class FirmwareUpdateCapabilities:
+    """Model for firmware update capabilities."""
+
+    def __init__(self, data: FirmwareUpdateCapabilitiesDataType) -> None:
+        """Initialize class."""
+        self.data = data
+
+    @property
+    def firmware_upgradable(self) -> bool:
+        """Return whether firmware is upgradable."""
+        return self.data["firmwareUpgradable"]
+
+    @property
+    def firmware_targets(self) -> List[int]:
+        """Return firmware targets."""
+        if not self.firmware_upgradable:
+            raise TypeError("Firmware is not upgradeable.")
+        return self.data["firmwareTargets"]
+
+    @property
+    def continues_to_function(self) -> Optional[bool]:
+        """Return whether node continues to function during update."""
+        if not self.firmware_upgradable:
+            raise TypeError("Firmware is not upgradeable.")
+        if (val := self.data["continuesToFunction"]) == VALUE_UNKNOWN:
+            return None
+        assert isinstance(val, bool)
+        return val
+
+    @property
+    def supports_activation(self) -> Optional[bool]:
+        """Return whether node supports delayed activation of the new firmware."""
+        if not self.firmware_upgradable:
+            raise TypeError("Firmware is not upgradeable.")
+        if (val := self.data["supportsActivation"]) == VALUE_UNKNOWN:
+            return None
+        assert isinstance(val, bool)
+        return val
+
+    def to_dict(self) -> FirmwareUpdateCapabilitiesDict:
+        """Return dict representation of the object."""
+        if not self.firmware_upgradable:
+            return {"firmware_upgradable": self.firmware_upgradable}
+        return {
+            "firmware_upgradable": self.firmware_upgradable,
+            "firmware_targets": self.firmware_targets,
+            "continues_to_function": self.continues_to_function,
+            "supports_activation": self.supports_activation,
+        }
+
+
 class FirmwareUpdateStatus(IntEnum):
     """Enum with all Firmware update status values.
 

zwave_js_server/model/node/__init__.py

@@ -4,6 +4,7 @@ from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union, cast
 
 from ...const import (
     INTERVIEW_FAILED,
+    NOT_INTERVIEWED,
     CommandClass,
     NodeStatus,
     PowerLevel,
@@ -21,6 +22,8 @@ from ..device_class import DeviceClass
 from ..device_config import DeviceConfig
 from ..endpoint import Endpoint
 from ..firmware import (
+    FirmwareUpdateCapabilities,
+    FirmwareUpdateCapabilitiesDataType,
     FirmwareUpdateFinished,
     FirmwareUpdateFinishedDataType,
     FirmwareUpdateProgress,
@@ -269,7 +272,16 @@ class Node(EventBase):
     @property
     def in_interview(self) -> bool:
         """Return whether node is currently being interviewed."""
-        return not self.ready and self.interview_stage != INTERVIEW_FAILED
+        return (
+            not self.ready
+            and not self.awaiting_manual_interview
+            and self.interview_stage != INTERVIEW_FAILED
+        )
+
+    @property
+    def awaiting_manual_interview(self) -> bool:
+        """Return whether node requires a manual interview."""
+        return self.interview_stage in (None, NOT_INTERVIEWED)
 
     @property
     def command_classes(self) -> List[CommandClassInfo]:
@@ -496,9 +508,23 @@ class Node(EventBase):
         )
         return ValueMetadata(cast(MetaDataType, data))
 
+    async def async_get_firmware_update_capabilities(
+        self,
+    ) -> FirmwareUpdateCapabilities:
+        """Send getFirmwareUpdateCapabilities command to Node."""
+        data = await self.async_send_command(
+            "get_firmware_update_capabilities",
+            require_schema=7,
+            wait_for_result=True,
+        )
+        assert data
+        return FirmwareUpdateCapabilities(
+            cast(FirmwareUpdateCapabilitiesDataType, data["capabilities"])
+        )
+
     async def async_abort_firmware_update(self) -> None:
         """Send abortFirmwareUpdate command to Node."""
-        await self.async_send_command("abort_firmware_update", wait_for_result=False)
+        await self.async_send_command("abort_firmware_update", wait_for_result=True)
 
     async def async_poll_value(self, val: Union[Value, str]) -> None:
         """Send pollValue command to Node for given value (or value_id)."""
@@ -644,6 +670,18 @@ class Node(EventBase):
         )
         self.data["location"] = location
 
+    async def async_get_firmware_update_progress(self) -> bool:
+        """
+        Send getFirmwareUpdateProgress command to Node.
+
+        If `True`, a firmware update for this node is in progress.
+        """
+        data = await self.async_send_command(
+            "get_firmware_update_progress", require_schema=18, wait_for_result=True
+        )
+        assert data
+        return cast(bool, data["progress"])
+
     async def async_set_keep_awake(self, keep_awake: bool) -> None:
         """Set node keep awake state."""
         await self.async_send_command(

{zwave_js_server_python-0.37.2.dist-info → zwave_js_server_python-0.38.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.37.2
+Version: 0.38.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.37.2.dist-info → zwave_js_server_python-0.38.0.dist-info}/RECORD

@@ -4,10 +4,10 @@ zwave_js_server/client.py,sha256=Fu_QlYYo-HrpENdcUxFDsSQmEQBxW6kA3_JAYo8LPgs,149
 zwave_js_server/dump.py,sha256=hTyeW8fPleyQyYyPjFeR_JxwmFRHvtpmpn1L9uNpfiw,1213
 zwave_js_server/event.py,sha256=E2bIEb635al9MsCB5rkk3ZklU4-YkmqmXtifzlbxXaQ,1958
 zwave_js_server/exceptions.py,sha256=guJlsUNQMGl-P8dVydup686_xzpbzCkd1870RbqZ6PE,5623
-zwave_js_server/firmware.py,sha256=40kf1yTcZjoO8oiQ5HdXG1sGt-g-cbEJcJQfRrLLbdc,1045
+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=FnImJja993dn8Hdrss29P5eq6oGoMZ0ZYu3QGidVU68,8481
+zwave_js_server/const/__init__.py,sha256=hmYMLOcJKwHOOqXYF7N7lNMvA8dl9L4YFnkvApcFKlI,8506
 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
@@ -30,7 +30,7 @@ zwave_js_server/model/device_class.py,sha256=KpSM101bGa_3Mig4C-_rkE4CzqImK2JPIUt
 zwave_js_server/model/device_config.py,sha256=7NaMa4BZ5tGe2p0YtOQFIUjBwRVF7GYWVExLwAgIUtE,6659
 zwave_js_server/model/driver.py,sha256=u5jOFZ2-mRWqAbiNB5yX_3qC7Uw1mjJdxLgeNignnho,6289
 zwave_js_server/model/endpoint.py,sha256=YGZts5-5y1ok6gIi7NsjM8puLwpv4XDVJhfUUTJ4rJQ,6001
-zwave_js_server/model/firmware.py,sha256=0AlV2mbjlmejV1eh0oHCUU-2Ysyec9a0X9BTvHG3wYs,2493
+zwave_js_server/model/firmware.py,sha256=-ercachu45pHd8cafzhDey5XpxX4b0CCufSFistJQYQ,4996
 zwave_js_server/model/log_config.py,sha256=F-QM7oHUXAfAxbdkrvmi6k6woM4VOwxB3qRrGmTQiQA,1722
 zwave_js_server/model/log_message.py,sha256=IxZ4USpXTeHsuRNS61NDPYMSIflv1KDO_EjUy4_vavE,5859
 zwave_js_server/model/notification.py,sha256=yLTUgOa_N0wedIsuJNDdhXEbfPVSIdXof7h_A_aibEU,6706
@@ -38,12 +38,12 @@ 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=d7T0W66vERzugpLn1Qxt8mG5CU4BGIuj8D_AOB3pKgc,29677
+zwave_js_server/model/controller/__init__.py,sha256=L4tBNDlocsQy3Xbi1u51IyZqUt99URrXG5oD8BHCBFs,29775
 zwave_js_server/model/controller/data_model.py,sha256=On7ZCEe5-vbVPs_ucFqlquxpjilT2TDGtiZwE8odtV4,970
-zwave_js_server/model/controller/event_model.py,sha256=a_YtQFyEbDs9nDX12GnTLiiKsJai5gUOq4RlENLa4eY,4941
+zwave_js_server/model/controller/event_model.py,sha256=PseC6YMT4NSRovUKbdYy_lZtB0qe1ujspK3W7miJ1rU,5137
 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=Q4QWFL908uyKQLvEeEjhIlOUfZjomLSfIJeVt02Om60,29290
+zwave_js_server/model/node/__init__.py,sha256=69UwPFVPApQ8uxknIoYvOkf-FU0c5B2kOLomXSp1GaI,30564
 zwave_js_server/model/node/data_model.py,sha256=Zdl68Oa9vUn2wegriFOcU70Q2yJO41rGKpdAdIbbtAU,1730
 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
@@ -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.37.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-zwave_js_server_python-0.37.2.dist-info/METADATA,sha256=XhLZxR5yeoqXZvMi7z7ODiKpQw6uIu_8_ZWieNs1xw4,1712
-zwave_js_server_python-0.37.2.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-zwave_js_server_python-0.37.2.dist-info/entry_points.txt,sha256=_8Swg1yhKiBElo6k1fxIEd6E8uPz8PDxQpwQoZ29FZE,74
-zwave_js_server_python-0.37.2.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
-zwave_js_server_python-0.37.2.dist-info/RECORD,,
+zwave_js_server_python-0.38.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+zwave_js_server_python-0.38.0.dist-info/METADATA,sha256=oIWlUj5T-6dPuxhpqQJa59Y6WqFekvIeCn5exT2PRLk,1712
+zwave_js_server_python-0.38.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+zwave_js_server_python-0.38.0.dist-info/entry_points.txt,sha256=_8Swg1yhKiBElo6k1fxIEd6E8uPz8PDxQpwQoZ29FZE,74
+zwave_js_server_python-0.38.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
+zwave_js_server_python-0.38.0.dist-info/RECORD,,