zwave-js-server-python 0.71.0__tar.gz → 0.73.0__tar.gz

{zwave_js_server_python-0.71.0/zwave_js_server_python.egg-info → zwave_js_server_python-0.73.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zwave-js-server-python
-Version: 0.71.0
+Version: 0.73.0
 Summary: Python wrapper for zwave-js-server
 Author-email: Home Assistant Team <hello@home-assistant.io>
 License-Expression: Apache-2.0

{zwave_js_server_python-0.71.0 → zwave_js_server_python-0.73.0}/zwave_js_server/const/__init__.py

@@ -8,12 +8,12 @@ import logging
 from typing import TypedDict
 
 PACKAGE_NAME = "zwave-js-server-python"
-__version__ = "0.71.0"
+__version__ = "0.73.0"
 
 # minimal server schema version we can handle
-MIN_SERVER_SCHEMA_VERSION = 47
+MIN_SERVER_SCHEMA_VERSION = 49
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 48
+MAX_SERVER_SCHEMA_VERSION = 50
 
 VALUE_UNKNOWN = "unknown"
 

{zwave_js_server_python-0.71.0 → zwave_js_server_python-0.73.0}/zwave_js_server/model/access_control.py

@@ -107,6 +107,7 @@ class UserCapabilitiesDataType(TypedDict, total=False):
     supportedUserTypes: list[UserCredentialUserType]
     maxUserNameLength: int
     supportedCredentialRules: list[UserCredentialRule]
+    supportsUsersWithoutCredentials: bool
 
 
 @dataclass
@@ -117,6 +118,7 @@ class UserCapabilities:
     supported_user_types: list[UserCredentialUserType] = field(default_factory=list)
     max_user_name_length: int | None = None
     supported_credential_rules: list[UserCredentialRule] = field(default_factory=list)
+    supports_users_without_credentials: bool = False
 
     @classmethod
     def from_dict(cls, data: UserCapabilitiesDataType) -> Self:
@@ -132,6 +134,9 @@ class UserCapabilities:
                 UserCredentialRule(rule)
                 for rule in data.get("supportedCredentialRules", [])
             ],
+            supports_users_without_credentials=data.get(
+                "supportsUsersWithoutCredentials", False
+            ),
         )
 
     def to_dict(self) -> UserCapabilitiesDataType:
@@ -140,6 +145,9 @@ class UserCapabilities:
             "maxUsers": self.max_users,
             "supportedUserTypes": list(self.supported_user_types),
             "supportedCredentialRules": list(self.supported_credential_rules),
+            "supportsUsersWithoutCredentials": (
+                self.supports_users_without_credentials
+            ),
         }
         if self.max_user_name_length is not None:
             data["maxUserNameLength"] = self.max_user_name_length
@@ -291,6 +299,31 @@ class SetUserOptions:
         return data
 
 
+class AddUserCredentialDataType(TypedDict):
+    """Represent a credential serialized for an add-user command."""
+
+    credentialType: UserCredentialType
+    credentialSlot: int
+    data: str | BufferObjectDataType
+
+
+@dataclass
+class AddUserCredential:
+    """Credential to write together with a new user via add_user."""
+
+    credential_type: UserCredentialType
+    credential_slot: int
+    data: str | bytes
+
+    def to_dict(self) -> AddUserCredentialDataType:
+        """Return the serialized credential for an add-user command."""
+        return {
+            "credentialType": self.credential_type,
+            "credentialSlot": self.credential_slot,
+            "data": serialize_credential_data(self.data),
+        }
+
+
 class CredentialDataDataType(TypedDict, total=False):
     """Represent access-control credential payload."""
 
@@ -331,6 +364,43 @@ class CredentialData:
         return data
 
 
+class AddUserResultDataType(TypedDict, total=False):
+    """Represent the result of an add-user command."""
+
+    user: SetUserResult
+    credential: SetCredentialResult
+
+
+@dataclass
+class AddUserResult:
+    """Result of an add-user command.
+
+    Mirrors zwave-js's ``addUser`` return value: the result of adding the user
+    and, when a credential was provided, the result of writing it.
+    """
+
+    user: SetUserResult
+    credential: SetCredentialResult | None = None
+
+    @classmethod
+    def from_dict(cls, data: AddUserResultDataType) -> Self:
+        """Return add-user result from serialized payload."""
+        credential = data.get("credential")
+        return cls(
+            user=SetUserResult(data["user"]),
+            credential=(
+                SetCredentialResult(credential) if credential is not None else None
+            ),
+        )
+
+    def to_dict(self) -> AddUserResultDataType:
+        """Return the serialized add-user result."""
+        data: AddUserResultDataType = {"user": self.user}
+        if self.credential is not None:
+            data["credential"] = self.credential
+        return data
+
+
 class UserDeletedArgsDataType(TypedDict):
     """Represent access-control user deleted event args."""
 
@@ -622,6 +692,31 @@ class AccessControlAPI:
         assert result is not None
         return SetUserResult(result["result"])
 
+    async def add_user(
+        self,
+        user_id: int,
+        options: SetUserOptions,
+        credential: AddUserCredential | None = None,
+    ) -> AddUserResult:
+        """Create a new user, optionally writing a credential in the same call.
+
+        On devices using User Code CC, users and credentials cannot be stored
+        separately, so ``credential`` is required there.
+        """
+        cmd_kwargs: dict[str, Any] = {}
+        if credential is not None:
+            cmd_kwargs["credential"] = credential.to_dict()
+        result = await self._endpoint.async_send_command(
+            "access_control.add_user",
+            userId=user_id,
+            options=options.to_dict(),
+            require_schema=49,
+            wait_for_result=True,
+            **cmd_kwargs,
+        )
+        assert result is not None
+        return AddUserResult.from_dict(cast(AddUserResultDataType, result["result"]))
+
     async def delete_user(self, user_id: int) -> SetUserResult:
         """Delete an access-control user."""
         result = await self._endpoint.async_send_command(

{zwave_js_server_python-0.71.0 → zwave_js_server_python-0.73.0}/zwave_js_server/model/node/__init__.py

@@ -1114,6 +1114,12 @@ class Node(EventBase):
         self.data["ready"] = False
         self.data["interviewStage"] = None
 
+    def handle_interview_progress(self, event: Event) -> None:
+        """Process a node interview progress event."""
+        # Do not override the interview stage here. The stage of the
+        # `interview progress` event is the _current_ one, while the
+        # `interviewStage` field is the _last completed_ stage.
+
     def handle_interview_stage_completed(self, event: Event) -> None:
         """Process a node interview stage completed event."""
         self.data["interviewStage"] = event.data["stageName"]

{zwave_js_server_python-0.71.0 → zwave_js_server_python-0.73.0}/zwave_js_server/model/node/event_model.py

@@ -163,6 +163,29 @@ class InterviewFailedEventModel(BaseNodeEventModel):
         )
 
 
+class InterviewProgressEventModel(BaseNodeEventModel):
+    """Model for `interview progress` event data."""
+
+    event: Literal["interview progress"]
+    stage: str
+    progress: float
+    endpoint: int | None = None
+    commandClass: int | None = None
+
+    @classmethod
+    def from_dict(cls, data: dict) -> InterviewProgressEventModel:
+        """Initialize from dict."""
+        return cls(
+            source=data["source"],
+            event=data["event"],
+            nodeId=data["nodeId"],
+            stage=data["stage"],
+            progress=data["progress"],
+            endpoint=data.get("endpoint"),
+            commandClass=data.get("commandClass"),
+        )
+
+
 class InterviewStageCompletedEventModel(BaseNodeEventModel):
     """Model for `interview stage completed` event data."""
 
@@ -452,6 +475,7 @@ NODE_EVENT_MODEL_MAP: dict[str, type[BaseNodeEventModel]] = {
     "firmware update progress": FirmwareUpdateProgressEventModel,
     "interview completed": InterviewCompletedEventModel,
     "interview failed": InterviewFailedEventModel,
+    "interview progress": InterviewProgressEventModel,
     "interview stage completed": InterviewStageCompletedEventModel,
     "interview started": InterviewStartedEventModel,
     "metadata updated": MetadataUpdatedEventModel,

{zwave_js_server_python-0.71.0 → zwave_js_server_python-0.73.0}/zwave_js_server/model/node/firmware.py

@@ -89,7 +89,9 @@ class NodeFirmwareUpdateCapabilities:
         """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:
+        if (
+            val := self.data.get("continuesToFunction", VALUE_UNKNOWN)
+        ) == VALUE_UNKNOWN:
             return None
         assert isinstance(val, bool)
         return val
@@ -99,7 +101,7 @@ class NodeFirmwareUpdateCapabilities:
         """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:
+        if (val := self.data.get("supportsActivation", VALUE_UNKNOWN)) == VALUE_UNKNOWN:
             return None
         assert isinstance(val, bool)
         return val

{zwave_js_server_python-0.71.0 → zwave_js_server_python-0.73.0/zwave_js_server_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: zwave-js-server-python
-Version: 0.71.0
+Version: 0.73.0
 Summary: Python wrapper for zwave-js-server
 Author-email: Home Assistant Team <hello@home-assistant.io>
 License-Expression: Apache-2.0