zwave-js-server-python 0.28.0__py3-none-any.whl → 0.29.0__py3-none-any.whl

zwave_js_server/const.py

@@ -1,11 +1,11 @@
 """Constants for the Z-Wave JS python library."""
 from enum import Enum, IntEnum
-from typing import Dict, List
+from typing import Dict, List, Set, Type, Union
 
 # minimal server schema version we can handle
-MIN_SERVER_SCHEMA_VERSION = 7
+MIN_SERVER_SCHEMA_VERSION = 8
 # max server schema version we can handle (and our code is compatible with)
-MAX_SERVER_SCHEMA_VERSION = 7
+MAX_SERVER_SCHEMA_VERSION = 8
 
 VALUE_UNKNOWN = "unknown"
 
@@ -90,7 +90,6 @@ class LogLevel(str, Enum):
 class CommandClass(IntEnum):
     """Enum with all known CommandClasses."""
 
-    ALARM = 113
     SENSOR_ALARM = 156
     SILENCE_ALARM = 157
     SWITCH_ALL = 39
@@ -265,6 +264,7 @@ THERMOSTAT_MODE_PROPERTY = "mode"
 THERMOSTAT_SETPOINT_PROPERTY = "setpoint"
 THERMOSTAT_OPERATING_STATE_PROPERTY = "state"
 THERMOSTAT_CURRENT_TEMP_PROPERTY = "Air temperature"
+THERMOSTAT_HUMIDITY_PROPERTY = "Humidity"
 
 
 class ThermostatMode(IntEnum):
@@ -390,6 +390,14 @@ class BarrierState(IntEnum):
     OPEN = 255
 
 
+COVER_OPEN_PROPERTY = "Open"
+COVER_UP_PROPERTY = "Up"
+COVER_ON_PROPERTY = "On"
+COVER_CLOSE_PROPERTY = "Close"
+COVER_DOWN_PROPERTY = "Down"
+COVER_OFF_PROPERTY = "Off"
+
+
 class ColorComponent(IntEnum):
     """Enum with all (known/used) Color Switch CC colors."""
 
@@ -405,6 +413,23 @@ class ColorComponent(IntEnum):
     INDEX = 8
 
 
+# Keys for the Color Switch CC combined colors value
+# https://github.com/zwave-js/node-zwave-js/pull/1782
+COLOR_SWITCH_COMBINED_RED = "red"
+COLOR_SWITCH_COMBINED_GREEN = "green"
+COLOR_SWITCH_COMBINED_BLUE = "blue"
+COLOR_SWITCH_COMBINED_AMBER = "amber"
+COLOR_SWITCH_COMBINED_CYAN = "cyan"
+COLOR_SWITCH_COMBINED_PURPLE = "purple"
+COLOR_SWITCH_COMBINED_WARM_WHITE = "warmWhite"
+COLOR_SWITCH_COMBINED_COLD_WHITE = "coldWhite"
+
+CURRENT_COLOR_PROPERTY = "currentColor"
+TARGET_COLOR_PROPERTY = "targetColor"
+TARGET_STATE_PROPERTY = "targetState"
+TARGET_VALUE_PROPERTY = "targetValue"
+
+
 class ToneID(IntEnum):
     """Enum with all known Sound Switch CC tone IDs."""
 
@@ -414,13 +439,263 @@ class ToneID(IntEnum):
 
 
 class NodeStatus(IntEnum):
-    """Enum with all Node status values.
-
-    https://zwave-js.github.io/node-zwave-js/#/api/node?id=status
-    """
+    """Enum with all Node status values."""
 
+    # https://zwave-js.github.io/node-zwave-js/#/api/node?id=status
     UNKNOWN = 0
     ASLEEP = 1
     AWAKE = 2
     DEAD = 3
     ALIVE = 4
+
+
+CC_SPECIFIC_SCALE = "scale"
+
+
+# Multilevel Sensor constants
+CC_SPECIFIC_SENSOR_TYPE = "sensorType"
+
+
+class MultilevelSensorType(IntEnum):
+    """Enum with all known multilevel sensor types."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/config/config/sensorTypes.json
+    AIR_TEMPERATURE = 1
+    GENERAL_PURPOSE = 2
+    ILLUMINANCE = 3
+    POWER = 4
+    HUMIDITY = 5
+    VELOCITY = 6
+    DIRECTION = 7
+    ATMOSPHERIC_PRESSURE = 8
+    BAROMETRIC_PRESSURE = 9
+    SOLAR_RADIATION = 10
+    DEW_POINT = 11
+    RAIN_RATE = 12
+    TIDE_LEVEL = 13
+    WEIGHT = 14
+    VOLTAGE = 15
+    CURRENT = 16
+    CARBON_DIOXIDE_LEVEL = 17
+    AIR_FLOW = 18
+    TANK_CAPACITY = 19
+    DISTANCE = 20
+    ANGLE_POSITION = 21
+    ROTATION = 22
+    WATER_TEMPERATURE = 23
+    SOIL_TEMPERATURE = 24
+    SEISMIC_INTENSITY = 25
+    SEISMIC_MAGNITUDE = 26
+    ULTRAVIOLET = 27
+    ELECTRICAL_RESISTIVITY = 28
+    ELECTRICAL_CONDUCTIVITY = 29
+    LOUDNESS = 30
+    MOISTURE = 31
+    FREQUENCY = 32
+    TIME = 33
+    TARGET_TEMPERATURE = 34
+    PARTICULATE_MATTER_25 = 35
+    FORMALDEHYDE_LEVEL = 36
+    RADON_CONCENTRATION = 37
+    METHANE_DENSITY = 38
+    VOLATILE_ORGANIC_COMPOUND_LEVEL = 39
+    CARBON_MONOXIDE_LEVEL = 40
+    SOIL_HUMIDITY = 41
+    SOIL_REACTIVITY = 42
+    SOIL_SALINITY = 43
+    HEART_RATE = 44
+    BLOOD_PRESSURE = 45
+    MUSCLE_MASS = 46
+    FAT_MASS = 47
+    BONE_MASS = 48
+    TOTAL_BODY_WATER = 49
+    BASIS_METABOLIC_RATE = 50
+    BODY_MASS_INDEX = 51
+    ACCELERATION_X_AXIS = 52
+    ACCELERATION_Y_AXIS = 53
+    ACCELERATION_Z_AXIS = 54
+    SMOKE_DENSITY = 55
+    WATER_FLOW = 56
+    WATER_PRESSURE = 57
+    RF_SIGNAL_STRENGTH = 58
+    PARTICULATE_MATTER_10 = 59
+    RESPIRATORY_RATE = 60
+    RELATIVE_MODULATION_LEVEL = 61
+    BOILER_WATER_TEMPERATURE = 62
+    DOMESTIC_HOT_WATER_TEMPERATURE = 63
+    OUTSIDE_TEMPERATURE = 64
+    EXHAUST_TEMPERATURE = 65
+    WATER_CHLORINE_LEVEL = 66
+    WATER_ACIDITY = 67
+    WATER_OXIDATION_REDUCTION_POTENTIAL = 68
+    HEART_RATE_LF_HF_RATIO = 69
+    MOTION_DIRECTION = 70
+    APPLIED_FORCE_ON_THE_SENSOR = 71
+    RETURN_AIR_TEMPERATURE = 72
+    SUPPLY_AIR_TEMPERATURE = 73
+    CONDENSER_COIL_TEMPERATURE = 74
+    EVAPORATOR_COIL_TEMPERATURE = 75
+    LIQUID_LINE_TEMPERATURE = 76
+    DISCHARGE_LINE_TEMPERATURE = 77
+    SUCTION_PRESSURE = 78
+    DISCHARGE_PRESSURE = 79
+    DEFROST_TEMPERATURE = 80
+    OZONE = 81
+    SULFUR_DIOXIDE = 82
+    NITROGEN_DIOXIDE = 83
+    AMMONIA = 84
+    LEAD = 85
+    PARTICULATE_MATTER_1 = 86
+
+
+CO_SENSORS = {MultilevelSensorType.CARBON_MONOXIDE_LEVEL}
+CO2_SENSORS = {MultilevelSensorType.CARBON_DIOXIDE_LEVEL}
+CURRENT_SENSORS = {MultilevelSensorType.CURRENT}
+ENERGY_SENSORS = {MultilevelSensorType.BASIS_METABOLIC_RATE}
+HUMIDITY_SENSORS = {MultilevelSensorType.HUMIDITY}
+ILLUMINANCE_SENSORS = {MultilevelSensorType.ILLUMINANCE}
+POWER_SENSORS = {MultilevelSensorType.POWER}
+PRESSURE_SENSORS = {
+    MultilevelSensorType.BLOOD_PRESSURE,
+    MultilevelSensorType.WATER_PRESSURE,
+    MultilevelSensorType.SUCTION_PRESSURE,
+    MultilevelSensorType.DISCHARGE_PRESSURE,
+    MultilevelSensorType.BAROMETRIC_PRESSURE,
+    MultilevelSensorType.ATMOSPHERIC_PRESSURE,
+}
+SIGNAL_STRENGTH_SENSORS = {MultilevelSensorType.RF_SIGNAL_STRENGTH}
+TEMPERATURE_SENSORS = {
+    MultilevelSensorType.AIR_TEMPERATURE,
+    MultilevelSensorType.DEW_POINT,
+    MultilevelSensorType.WATER_TEMPERATURE,
+    MultilevelSensorType.SOIL_TEMPERATURE,
+    MultilevelSensorType.TARGET_TEMPERATURE,
+    MultilevelSensorType.BOILER_WATER_TEMPERATURE,
+    MultilevelSensorType.DOMESTIC_HOT_WATER_TEMPERATURE,
+    MultilevelSensorType.OUTSIDE_TEMPERATURE,
+    MultilevelSensorType.EXHAUST_TEMPERATURE,
+    MultilevelSensorType.RETURN_AIR_TEMPERATURE,
+    MultilevelSensorType.SUPPLY_AIR_TEMPERATURE,
+    MultilevelSensorType.CONDENSER_COIL_TEMPERATURE,
+    MultilevelSensorType.EVAPORATOR_COIL_TEMPERATURE,
+    MultilevelSensorType.LIQUID_LINE_TEMPERATURE,
+    MultilevelSensorType.DISCHARGE_LINE_TEMPERATURE,
+    MultilevelSensorType.DEFROST_TEMPERATURE,
+}
+TIMESTAMP_SENSORS = {MultilevelSensorType.TIME}
+VOLTAGE_SENSORS = {
+    MultilevelSensorType.VOLTAGE,
+    MultilevelSensorType.WATER_OXIDATION_REDUCTION_POTENTIAL,
+}
+
+
+# Meter CC constants
+
+CC_SPECIFIC_METER_TYPE = "meterType"
+CC_SPECIFIC_RATE_TYPE = "rateType"
+
+RESET_METER_CC_API = "reset"
+
+# optional attributes when calling the Meter CC reset API.
+# https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/commandclass/MeterCC.ts#L873-L881
+RESET_METER_OPTION_TARGET_VALUE = TARGET_VALUE_PROPERTY
+RESET_METER_OPTION_TYPE = "type"
+
+
+# https://github.com/zwave-js/node-zwave-js/blob/master/packages/config/config/meters.json
+class MeterType(IntEnum):
+    """Enum with all known meter types."""
+
+    ELECTRIC = 1
+    GAS = 2
+    WATER = 3
+    HEATING = 4
+    COOLING = 5
+
+
+class ElectricScale(IntEnum):
+    """Enum with all known electric meter scale values."""
+
+    KILOWATT_HOUR = 0
+    KILOVOLT_AMPERE_HOUR = 1
+    WATT = 2
+    PULSE = 3
+    VOLT = 4
+    AMPERE = 5
+    POWER_FACTOR = 6
+    KILOVOLT_AMPERE_REACTIVE = 7
+    KILOVOLT_AMPERE_REACTIVE_HOUR = 8
+
+
+class GasScale(IntEnum):
+    """Enum with all known gas meter scale values."""
+
+    CUBIC_METER = 0
+    CUBIC_FEET = 1
+    PULSE_COUNT = 3
+
+
+class WaterScale(IntEnum):
+    """Enum with all known water meter scale values."""
+
+    CUBIC_METER = 0
+    CUBIC_FEET = 1
+    US_GALLON = 2
+    PULSE_COUNT = 3
+
+
+class HeatingScale(IntEnum):
+    """Enum with all known heating meter scale values."""
+
+    KILOWATT_HOUR = 0
+
+
+CoolingScale = HeatingScale
+
+MeterScaleType = Union[CoolingScale, ElectricScale, GasScale, HeatingScale, WaterScale]
+
+METER_TYPE_TO_SCALE_ENUM_MAP: Dict[MeterType, Type[MeterScaleType]] = {
+    MeterType.ELECTRIC: ElectricScale,
+    MeterType.GAS: GasScale,
+    MeterType.WATER: WaterScale,
+    MeterType.HEATING: HeatingScale,
+    MeterType.COOLING: CoolingScale,
+}
+
+ENERGY_METER_TYPES: Set[MeterScaleType] = {
+    ElectricScale.KILOWATT_HOUR,
+    ElectricScale.KILOVOLT_AMPERE_HOUR,
+    ElectricScale.KILOVOLT_AMPERE_REACTIVE_HOUR,
+    HeatingScale.KILOWATT_HOUR,
+    CoolingScale.KILOWATT_HOUR,
+}
+POWER_METER_TYPES: Set[MeterScaleType] = {
+    ElectricScale.WATT,
+    ElectricScale.PULSE,
+    ElectricScale.KILOVOLT_AMPERE_REACTIVE,
+}
+POWER_FACTOR_METER_TYPES: Set[MeterScaleType] = {ElectricScale.POWER_FACTOR}
+VOLTAGE_METER_TYPES: Set[MeterScaleType] = {ElectricScale.VOLT}
+CURRENT_METER_TYPES: Set[MeterScaleType] = {ElectricScale.AMPERE}
+
+
+class InclusionStrategy(IntEnum):
+    """Enum for all known inclusion strategies."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L9-L46
+    DEFAULT = 0
+    SMART_START = 1
+    INSECURE = 2
+    SECURITY_S0 = 3
+    SECURITY_S2 = 4
+
+
+class SecurityClass(IntEnum):
+    """Enum for all known security classes."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/core/src/security/SecurityClass.ts#L3-L17
+    NONE = -1
+    S2_UNAUTHENTICATED = 0
+    S2_AUTHENTICATED = 1
+    S2_ACCESS_CONTROL = 2
+    S0_LEGACY = 7

zwave_js_server/exceptions.py

@@ -1,7 +1,10 @@
 """Exceptions for zwave-js-server."""
+from typing import Optional, TYPE_CHECKING
 
+from .const import CommandClass
 
-from typing import Optional
+if TYPE_CHECKING:
+    from .model.value import Value
 
 
 class BaseZwaveJSServerError(Exception):
@@ -120,3 +123,34 @@ class BulkSetConfigParameterFailed(BaseZwaveJSServerError):
 
     Derived from another exception
     """
+
+
+class InvalidCommandClass(BaseZwaveJSServerError):
+    """Exception raised when Zwave Value has an invalid command class."""
+
+    def __init__(self, value: "Value", command_class: CommandClass) -> None:
+        """Initialize an invalid Command Class error."""
+        self.value = value
+        self.command_class = command_class
+        super().__init__(
+            f"Value {value} does not match expected command class: {command_class}"
+        )
+
+
+class UnknownValueData(BaseZwaveJSServerError):
+    """
+    Exception raised when Zwave Value has data that the library can't parse.
+
+    This can be caused by an upstream issue with the driver, or missing support in the
+    library.
+    """
+
+    def __init__(self, value: "Value", path: str) -> None:
+        """Initialize an unknown data error."""
+        self.value = value
+        self.path = path
+        super().__init__(
+            f"Value {value} has unknown data in the following location: {path}. "
+            "Please report this issue, it can be caused by either an upstream issue "
+            "with the driver or missing support for this data in the library"
+        )

zwave_js_server/model/controller.py

@@ -1,6 +1,8 @@
 """Provide a model for the Z-Wave JS controller."""
-from typing import TYPE_CHECKING, Dict, List, Optional, TypedDict, cast
+from dataclasses import dataclass
+from typing import Literal, TYPE_CHECKING, Dict, List, Optional, TypedDict, Union, cast
 
+from ..const import InclusionStrategy, SecurityClass
 from ..event import Event, EventBase
 from .association import Association, AssociationGroup
 from .node import Node
@@ -9,9 +11,41 @@ if TYPE_CHECKING:
     from ..client import Client
 
 
+class InclusionGrantDataType(TypedDict):
+    """Representation of an inclusion grant data dict type."""
+
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/Inclusion.ts#L48-L56
+    securityClasses: List[SecurityClass]
+    clientSideAuth: bool
+
+
+@dataclass
+class InclusionGrant:
+    """Representation of an inclusion grant."""
+
+    security_classes: List[SecurityClass]
+    client_side_auth: bool
+
+    def to_dict(self) -> InclusionGrantDataType:
+        """Return InclusionGrantDataType dict from self."""
+        return {
+            "securityClasses": self.security_classes,
+            "clientSideAuth": self.client_side_auth,
+        }
+
+    @classmethod
+    def from_dict(cls, data: InclusionGrantDataType) -> "InclusionGrant":
+        """Return InclusionGrant from InclusionGrantDataType dict."""
+        return cls(
+            [SecurityClass(sec_cls) for sec_cls in data["securityClasses"]],
+            data["clientSideAuth"],
+        )
+
+
 class ControllerStatisticsDataType(TypedDict):
     """Represent a controller statistics data dict type."""
 
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/controller/ControllerStatistics.ts#L20-L39
     messagesTX: int
     messagesRX: int
     messagesDroppedTX: int
@@ -244,14 +278,37 @@ class Controller(EventBase):
         return self._heal_network_progress
 
     async def async_begin_inclusion(
-        self, include_non_secure: Optional[bool] = None
+        self,
+        inclusion_strategy: Union[
+            Literal[InclusionStrategy.SECURITY_S0],
+            Literal[InclusionStrategy.SECURITY_S2],
+            Literal[InclusionStrategy.INSECURE],
+        ],
     ) -> bool:
         """Send beginInclusion command to Controller."""
         data = await self.client.async_send_command(
             {
                 "command": "controller.begin_inclusion",
-                "includeNonSecure": include_non_secure,
-            }
+                "options": {"inclusionStrategy": inclusion_strategy},
+            },
+            require_schema=8,
+        )
+        return cast(bool, data["success"])
+
+    async def async_begin_inclusion_default(
+        self,
+        force_security: Optional[bool] = None,
+    ) -> bool:
+        """Send beginInclusion command to Controller using Default inclusion method."""
+        data = await self.client.async_send_command(
+            {
+                "command": "controller.begin_inclusion",
+                "options": {
+                    "inclusionStrategy": InclusionStrategy.DEFAULT,
+                    "forceSecurity": force_security,
+                },
+            },
+            require_schema=8,
         )
         return cast(bool, data["success"])
 
@@ -283,15 +340,22 @@ class Controller(EventBase):
         )
 
     async def async_replace_failed_node(
-        self, node_id: int, include_non_secure: Optional[bool] = None
+        self,
+        node_id: int,
+        inclusion_strategy: Union[
+            Literal[InclusionStrategy.SECURITY_S0],
+            Literal[InclusionStrategy.SECURITY_S2],
+            Literal[InclusionStrategy.INSECURE],
+        ],
     ) -> bool:
         """Send replaceFailedNode command to Controller."""
         data = await self.client.async_send_command(
             {
                 "command": "controller.replace_failed_node",
                 "nodeId": node_id,
-                "includeNonSecure": include_non_secure,
-            }
+                "options": {"inclusionStrategy": inclusion_strategy},
+            },
+            require_schema=8,
         )
         return cast(bool, data["success"])
 
@@ -438,6 +502,26 @@ class Controller(EventBase):
         )
         return cast(List[int], data["neighbors"])
 
+    async def async_grant_security_classes(
+        self, inclusion_grant: InclusionGrant
+    ) -> None:
+        """Send grantSecurityClasses command to Controller."""
+        await self.client.async_send_command(
+            {
+                "command": "controller.grant_security_classes",
+                "inclusionGrant": inclusion_grant.to_dict(),
+            }
+        )
+
+    async def async_validate_dsk_and_enter_pin(self, pin: str) -> None:
+        """Send validateDSKAndEnterPIN command to Controller."""
+        await self.client.async_send_command(
+            {
+                "command": "controller.validate_dsk_and_enter_pin",
+                "pin": pin,
+            }
+        )
+
     def receive_event(self, event: Event) -> None:
         """Receive an event."""
         if event.data["source"] == "node":
@@ -502,3 +586,12 @@ class Controller(EventBase):
         """Process a statistics updated event."""
         self._statistics.data.update(event.data["statistics"])
         event.data["statistics_updated"] = self.statistics
+
+    def handle_grant_security_classes(self, event: Event) -> None:
+        """Process a grant security classes event."""
+        event.data["requested_grant"] = InclusionGrant.from_dict(
+            event.data["requested"]
+        )
+
+    def handle_validate_dsk_and_enter_pin(self, event: Event) -> None:
+        """Process a validate dsk and enter pin event."""

zwave_js_server/model/log_config.py

@@ -38,10 +38,10 @@ class LogConfig:
         }
         return cast(LogConfigDataType, {k: v for k, v in data.items() if v is not None})
 
-    @staticmethod
-    def from_dict(data: LogConfigDataType) -> "LogConfig":
+    @classmethod
+    def from_dict(cls, data: LogConfigDataType) -> "LogConfig":
         """Return LogConfig from LogConfigDataType dict."""
-        return LogConfig(
+        return cls(
             data.get("enabled"),
             LogLevel(data["level"]) if "level" in data else None,
             data.get("logToFile"),

zwave_js_server/model/node.py

@@ -1,7 +1,7 @@
 """Provide a model for the Z-Wave JS node."""
 from typing import TYPE_CHECKING, Any, Dict, List, Optional, TypedDict, Union, cast
 
-from ..const import INTERVIEW_FAILED, CommandClass, NodeStatus
+from ..const import INTERVIEW_FAILED, CommandClass, NodeStatus, SecurityClass
 from ..event import Event
 from ..exceptions import (
     FailedCommand,
@@ -42,6 +42,7 @@ if TYPE_CHECKING:
 class NodeStatisticsDataType(TypedDict):
     """Represent a node statistics data dict type."""
 
+    # https://github.com/zwave-js/node-zwave-js/blob/master/packages/zwave-js/src/lib/node/NodeStatistics.ts#L21-L33
     commandsTX: int
     commandsRX: int
     commandsDroppedTX: int
@@ -511,6 +512,25 @@ class Node(Endpoint):
         )
         return cast(bool, data.get("responded", False))
 
+    async def async_has_security_class(self, security_class: SecurityClass) -> bool:
+        """Return whether node has the given security class."""
+        data = await self.async_send_command(
+            "has_security_class",
+            securityClass=security_class,
+            require_schema=8,
+            wait_for_result=True,
+        )
+        assert data
+        return cast(bool, data["hasSecurityClass"])
+
+    async def async_get_highest_security_class(self) -> SecurityClass:
+        """Get the highest security class that a node supports."""
+        data = await self.async_send_command(
+            "get_highest_security_class", require_schema=8, wait_for_result=True
+        )
+        assert data
+        return SecurityClass(data["highestSecurityClass"])
+
     def handle_wake_up(self, event: Event) -> None:
         """Process a node wake up event."""
         # pylint: disable=unused-argument

zwave_js_server/util/command_class.py

@@ -0,0 +1,49 @@
+"""Command Class specific utility functions for values."""
+from ..const import (
+    CC_SPECIFIC_METER_TYPE,
+    CC_SPECIFIC_SCALE,
+    CC_SPECIFIC_SENSOR_TYPE,
+    METER_TYPE_TO_SCALE_ENUM_MAP,
+    CommandClass,
+    MeterScaleType,
+    MeterType,
+    MultilevelSensorType,
+)
+from ..exceptions import InvalidCommandClass, UnknownValueData
+from ..model.value import Value
+
+
+def get_meter_type(value: Value) -> MeterType:
+    """Get the MeterType for a given value."""
+    if value.command_class != CommandClass.METER:
+        raise InvalidCommandClass(value, CommandClass.METER)
+    try:
+        return MeterType(value.metadata.cc_specific[CC_SPECIFIC_METER_TYPE])
+    except ValueError:
+        raise UnknownValueData(  # pylint: disable=raise-missing-from
+            value, f"metadata.cc_specific.{CC_SPECIFIC_METER_TYPE}"
+        )
+
+
+def get_meter_scale_type(value: Value) -> MeterScaleType:
+    """Get the ScaleType for a given value."""
+    meter_type = get_meter_type(value)
+    scale_enum = METER_TYPE_TO_SCALE_ENUM_MAP[meter_type]
+    try:
+        return scale_enum(value.metadata.cc_specific[CC_SPECIFIC_SCALE])
+    except ValueError:
+        raise UnknownValueData(  # pylint: disable=raise-missing-from
+            value, f"metadata.cc_specific.{CC_SPECIFIC_SCALE}"
+        )
+
+
+def get_multilevel_sensor_type(value: Value) -> MultilevelSensorType:
+    """Get the MultilevelSensorType for a given value."""
+    if value.command_class != CommandClass.SENSOR_MULTILEVEL:
+        raise InvalidCommandClass(value, CommandClass.SENSOR_MULTILEVEL)
+    try:
+        return MultilevelSensorType(value.metadata.cc_specific[CC_SPECIFIC_SENSOR_TYPE])
+    except ValueError:
+        raise UnknownValueData(  # pylint: disable=raise-missing-from
+            value, f"metadata.cc_specific.{CC_SPECIFIC_SENSOR_TYPE}"
+        )

{zwave_js_server_python-0.28.0.dist-info → zwave_js_server_python-0.29.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zwave-js-server-python
-Version: 0.28.0
+Version: 0.29.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.28.0.dist-info → zwave_js_server_python-0.29.0.dist-info}/RECORD

@@ -1,35 +1,36 @@
 zwave_js_server/__init__.py,sha256=Ey3O4Tha56uU-M92oLJmQHupCJ7B9oZmxlQTo8pGUM8,45
 zwave_js_server/__main__.py,sha256=1gWC927sa3FwcA47ndmrRWW0HlfYVdiUarjEsccRF2k,3624
 zwave_js_server/client.py,sha256=kVaxlUfrj2izdwjbzgBZFVi0vZDZflkCtUDDBhugPYk,11946
-zwave_js_server/const.py,sha256=6SPXg7Qywi3SIUuRHGT5-CGNKOM3y1DS9bxdlFujzps,11366
+zwave_js_server/const.py,sha256=V-kS0EkzPaqTDM0-Yr2yuNzguPma5uYAjw9AqpU7nQ8,19220
 zwave_js_server/dump.py,sha256=inv0Q-i0DbzEcbwXeLDiu29U2I248pPMyNUTQDp5wYY,1184
 zwave_js_server/event.py,sha256=0Aw3NzkzKMnhS7AxBh6BwAVYXRu4zDKeUDib9mHjj8w,1772
-zwave_js_server/exceptions.py,sha256=YTu7OTXsTnVxBVfjStPCMXRGgC2QVRD_Rz8Qx9OnUS8,3503
+zwave_js_server/exceptions.py,sha256=mbuiWMwmVjmQrimhZROCguQFYQuFP93pubDJKs1FcVc,4741
 zwave_js_server/firmware.py,sha256=F5selNpOWWICuLs3L8zBjddnGKrEmip7LriijjL9pDA,878
 zwave_js_server/version.py,sha256=RDFP2kSU3cCVIQbgMWggdeDnvhtVsZzzZg9pOjH7CC8,364
 zwave_js_server/model/__init__.py,sha256=XfyKH8lxZ3CB7CbRkOr5sR-eV0GrklZiBtNPmlnCJ_8,123
 zwave_js_server/model/association.py,sha256=FsgKAha7mw6dpk7u7zdQoNEajTyiL0S5eOYcY4M2Rx4,529
 zwave_js_server/model/command_class.py,sha256=CPKZOJNr6T3Y-ShfFB0CDZOLmITtXm5p1cOHbnRHMaI,1118
-zwave_js_server/model/controller.py,sha256=CpTmJC95N4g4mc8PRNLNNTbNwl6RrO7sEsQzeEDgMlc,17279
+zwave_js_server/model/controller.py,sha256=1eQfRwErjBrOtUYyTtTBSoqeWw6mSxO3XTWV8pi2wzw,20577
 zwave_js_server/model/device_class.py,sha256=XxiTRVxY-Dc5cVHfJQFc2IkUHEXRiLpL5-V49PkwMxg,1708
 zwave_js_server/model/device_config.py,sha256=gn3xMGs8efn3B1BQ31VsXOG2u-CdMFJeIKDqIyMPBj8,5882
 zwave_js_server/model/driver.py,sha256=IEmcukQw7r_Wrls_ZeyZ77RnnTKW9eopeDExOUoFm88,5166
 zwave_js_server/model/endpoint.py,sha256=EJ_178hg2O4A3oc2xUegLnv6mshv0zo1h6ZwZ1Ws0qo,4110
 zwave_js_server/model/firmware.py,sha256=ATSCz3fbCipthqfmTbw7C1bfeK4DhrWOiaGdxHNqPds,2315
-zwave_js_server/model/log_config.py,sha256=21_roDDPzxKuYl1TNiIJ0vhtPI2Zx6tzzAVwql-cbLM,1571
+zwave_js_server/model/log_config.py,sha256=Qti1p8Y1T1-mXJJydqLAa9JPbglzIzAd34koftG6U0w,1569
 zwave_js_server/model/log_message.py,sha256=9HQnvVZkwg7V_ENn4YLylEoX6OkmU9EOWMmK9BCQ92k,2607
-zwave_js_server/model/node.py,sha256=OgT1BMOgrk_ttGKA9e7uknDjOh7Lk9fDmXBV9EDUxjo,22086
+zwave_js_server/model/node.py,sha256=QlTlRfoJDjuwnq-uODjblXyma584M-0sRfI5pks9Jsk,22991
 zwave_js_server/model/notification.py,sha256=hflkoNjr6ZrS7D1rpdTmeVfi6h9L87EqGCVupgmBAZY,3689
 zwave_js_server/model/value.py,sha256=rpJNKYEzxfoZvUS4kRruRseGJCDOzVk04tpZHs34NCI,8450
 zwave_js_server/model/version.py,sha256=FTdCCyHW69NW4CXeeuNMx339SF0tV2ZipPt24eVcl2o,1000
 zwave_js_server/util/__init__.py,sha256=ArF1K885aW0GdVd7Lo8fl8Atf70gvsxO5Ra_WoJTG28,42
+zwave_js_server/util/command_class.py,sha256=RQ9iJ1JbhYom1qc-FH25Hrk_Ef-WUyv6hoNBqXaOr6E,1822
 zwave_js_server/util/helpers.py,sha256=RfIqYFVARlGzvG5oIs1SIvbUkHT5JVjRX3Cs-5SzhdA,1475
 zwave_js_server/util/lock.py,sha256=m_bRvshaRHV0v_YBaCIrgVDUPLab6xFoXZxXuxknD5E,3806
 zwave_js_server/util/multicast.py,sha256=iZZ1BcbtH4WqMm6DoHqH_ft0AwdUNSIjU8Yu-QYeKFk,4303
 zwave_js_server/util/node.py,sha256=tYS9UaPs4UCD6Q0_yiRySOlFH-vjf5bdgozYhSAybTo,12314
-zwave_js_server_python-0.28.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-zwave_js_server_python-0.28.0.dist-info/METADATA,sha256=Myet-nCZ-vLPlsfDfHozCdLId-W7SWePd8lI5hC-ZJw,1627
-zwave_js_server_python-0.28.0.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
-zwave_js_server_python-0.28.0.dist-info/entry_points.txt,sha256=_8Swg1yhKiBElo6k1fxIEd6E8uPz8PDxQpwQoZ29FZE,74
-zwave_js_server_python-0.28.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
-zwave_js_server_python-0.28.0.dist-info/RECORD,,
+zwave_js_server_python-0.29.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+zwave_js_server_python-0.29.0.dist-info/METADATA,sha256=RL7OTpRpFPtQkvWHGZjCjUaNeIbOVXOUVgfkY3qBhQA,1627
+zwave_js_server_python-0.29.0.dist-info/WHEEL,sha256=ewwEueio1C2XeHTvT17n8dZUJgOvyCWCt0WVNLClP9o,92
+zwave_js_server_python-0.29.0.dist-info/entry_points.txt,sha256=_8Swg1yhKiBElo6k1fxIEd6E8uPz8PDxQpwQoZ29FZE,74
+zwave_js_server_python-0.29.0.dist-info/top_level.txt,sha256=-hwsl-i4Av5Op_yfOHC_OP56KPmzp_iVEkeohRIN5Ng,16
+zwave_js_server_python-0.29.0.dist-info/RECORD,,

{zwave_js_server_python-0.28.0.dist-info → zwave_js_server_python-0.29.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.36.2)
+Generator: bdist_wheel (0.37.0)
 Root-Is-Purelib: true
 Tag: py3-none-any