Add new metadata fields from zwave-js v15.21.0 / SCHEMA 46

test/model/test_value.py

@@ -252,6 +252,8 @@ def test_configuration_value_metadata(inovelli_switch_state):
     assert metadata.no_bulk_support is None
     assert metadata.value_size is None
     assert metadata.format is None
+    assert metadata.allowed is None
+    assert metadata.purpose is None
 
     value = ConfigurationValue(
         inovelli_switch_state,
@@ -273,6 +275,8 @@ def test_configuration_value_metadata(inovelli_switch_state):
                 noBulkSupport=True,
                 valueSize=1,
                 format=0,
+                allowed=[{"value": 0}, {"from": 5, "to": 10, "step": 1}],
+                purpose="state_after_power_failure",
             ),
         ),
     )
@@ -284,3 +288,5 @@ def test_configuration_value_metadata(inovelli_switch_state):
     assert metadata.no_bulk_support
     assert metadata.value_size == 1
     assert metadata.format == ConfigurationValueFormat.SIGNED_INTEGER
+    assert metadata.allowed == [{"value": 0}, {"from": 5, "to": 10, "step": 1}]
+    assert metadata.purpose == "state_after_power_failure"

zwave_js_server/const/__init__.py

@@ -13,7 +13,7 @@
 # minimal server schema version we can handle
 MIN_SERVER_SCHEMA_VERSION = 44
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 44
+MAX_SERVER_SCHEMA_VERSION = 46
 
 VALUE_UNKNOWN = "unknown"
 

zwave_js_server/model/value.py

@@ -4,7 +4,7 @@
 
 from dataclasses import dataclass, field
 from enum import IntEnum, StrEnum
-from typing import TYPE_CHECKING, Any, TypedDict
+from typing import TYPE_CHECKING, Any, NotRequired, TypedDict
 
 from ..const import (
     VALUE_UNKNOWN,
@@ -30,20 +30,37 @@ class ValueType(StrEnum):
     STRING = "string"
 
 
+class AllowedValueSingleDataType(TypedDict):
+    """Represent a single value in a list of allowed values."""
+
+    value: int
+
+
+AllowedValueRangeDataType = TypedDict(
+    "AllowedValueRangeDataType",
+    # not using class based definition as `from` is a reserved keyword
+    {"from": int, "to": int, "step": NotRequired[int]},
+)
+
+AllowedValueDataType = AllowedValueSingleDataType | AllowedValueRangeDataType
+
+
 class MetaDataType(TypedDict, total=False):
     """Represent a metadata data dict type."""
 
     type: str  # required
+    purpose: str
     readable: bool  # required
     writeable: bool  # required
-    description: str
     label: str
+    description: str  # further clarifies the label
     min: int | None
     max: int | None
     unit: str | None
     states: dict[str, str]
     ccSpecific: dict[str, Any]
     valueChangeOptions: list[str]
+    allowed: list[AllowedValueDataType]
     allowManualEntry: bool
     stateful: bool
     secret: bool
@@ -164,6 +181,11 @@ def value_change_options(self) -> list[str]:
         """Return valueChangeOptions."""
         return self.data.get("valueChangeOptions", [])
 
+    @property
+    def allowed(self) -> list[AllowedValueDataType] | None:
+        """Return allowed."""
+        return self.data.get("allowed")
+
     @property
     def allow_manual_entry(self) -> bool | None:
         """Return allowManualEntry."""
@@ -216,6 +238,11 @@ def is_from_config(self) -> bool | None:
         """Return isFromConfig."""
         return self.data.get("isFromConfig")
 
+    @property
+    def purpose(self) -> str | None:
+        """Return purpose."""
+        return self.data.get("purpose")
+
     def update(self, data: MetaDataType) -> None:
         """Update data."""
         self.data.update(data)