Add support for Multilevel Switch Notification (#397)

* Adding Multilevel Switch Notification Type Support

* Adding Multilevel Switch Notification Support

* Update zwave_js_server/model/notification.py

Co-authored-by: Raman Gupta <[email protected]>

* Added enum for possible MultilevelSwitch Command Values

* import IntEnum

* add .

* fix key

* Addition of tests for Multilevel Switch CC Notification

* remove whitespace

* lint changes

* Update test_node.py

Co-authored-by: Raman Gupta <[email protected]>

Author: reubenbijl

test/model/test_node.py

@@ -19,6 +19,9 @@
     EntryControlEventType,
 )
 from zwave_js_server.const.command_class.power_level import PowerLevelTestStatus
+from zwave_js_server.const.command_class.multilevel_switch import (
+    MultilevelSwitchCommand,
+)
 from zwave_js_server.event import Event
 from zwave_js_server.exceptions import (
     FailedCommand,
@@ -804,6 +807,48 @@ async def test_notification(lock_schlage_be469: node_pkg.Node):
     assert event.data["notification"].status == PowerLevelTestStatus.FAILED
     assert event.data["notification"].acknowledged_frames == 2
 
+    # Validate that Multilevel Switch CC notification event is received as expected
+    event = Event(
+        type="notification",
+        data={
+            "source": "node",
+            "event": "notification",
+            "nodeId": 23,
+            "ccId": CommandClass.SWITCH_MULTILEVEL.value,
+            "args": {"direction": "up", "eventType": 4},
+        },
+    )
+
+    node.handle_notification(event)
+    assert event.data["notification"].command_class == CommandClass.SWITCH_MULTILEVEL
+    assert event.data["notification"].node_id == 23
+    assert event.data["notification"].direction == "up"
+    assert (
+        event.data["notification"].event_type
+        == MultilevelSwitchCommand.START_LEVEL_CHANGE
+    )
+
+    # Validate that Multilevel Switch CC notification event without a direction is valid
+    event = Event(
+        type="notification",
+        data={
+            "source": "node",
+            "event": "notification",
+            "nodeId": 23,
+            "ccId": CommandClass.SWITCH_MULTILEVEL.value,
+            "args": {"eventType": 4},
+        },
+    )
+
+    node.handle_notification(event)
+    assert event.data["notification"].command_class == CommandClass.SWITCH_MULTILEVEL
+    assert event.data["notification"].node_id == 23
+    assert event.data["notification"].direction is None
+    assert (
+        event.data["notification"].event_type
+        == MultilevelSwitchCommand.START_LEVEL_CHANGE
+    )
+
 
 async def test_notification_unknown(lock_schlage_be469: node_pkg.Node, caplog):
     """Test unrecognized command class notification events."""

zwave_js_server/const/command_class/multilevel_switch.py

@@ -1,8 +1,16 @@
 """Constants for the Multilevel Switch CC."""
+from enum import IntEnum
 
 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 MultilevelSwitchCommand(IntEnum):
+    """Enum for known multilevel switch notifications."""
+
+    START_LEVEL_CHANGE = 4
+    STOP_LEVEL_CHANGE = 5

zwave_js_server/model/node/__init__.py

@@ -33,6 +33,8 @@
     NotificationNotificationDataType,
     PowerLevelNotification,
     PowerLevelNotificationDataType,
+    MultilevelSwitchNotification,
+    MultilevelSwitchNotificationDataType,
 )
 from ..value import (
     ConfigurationValue,
@@ -783,6 +785,10 @@ def handle_notification(self, event: Event) -> None:
             event.data["notification"] = NotificationNotification(
                 self, cast(NotificationNotificationDataType, event.data)
             )
+        elif command_class == CommandClass.SWITCH_MULTILEVEL:
+            event.data["notification"] = MultilevelSwitchNotification(
+                self, cast(MultilevelSwitchNotificationDataType, event.data)
+            )
         elif command_class == CommandClass.ENTRY_CONTROL:
             event.data["notification"] = EntryControlNotification(
                 self, cast(EntryControlNotificationDataType, event.data)

zwave_js_server/model/notification.py

@@ -8,6 +8,7 @@
 
 from ..const import TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED
 from ..const.command_class.power_level import PowerLevelTestStatus
+from ..const.command_class.multilevel_switch import MultilevelSwitchCommand
 from ..util.helpers import parse_buffer
 
 if TYPING_EXTENSION_FOR_TYPEDDICT_REQUIRED:
@@ -184,3 +185,49 @@ def status(self) -> PowerLevelTestStatus:
     def acknowledged_frames(self) -> int:
         """Return acknowledged frames property."""
         return self.data["args"]["acknowledgedFrames"]
+
+
+class MultilevelSwitchNotificationArgsDataType(TypedDict, total=False):
+    """Represent args for a Multi Level Switch CC notification event data dict type."""
+
+    eventType: int  # required
+    direction: str
+
+
+class MultilevelSwitchNotificationDataType(BaseNotificationDataType):
+    """Represent a Multi Level Switch CC notification event data dict type."""
+
+    args: MultilevelSwitchNotificationArgsDataType  # required
+
+
+class MultilevelSwitchNotification:
+    """Model for a Zwave Node's Multi Level CC notification event."""
+
+    def __init__(
+        self, node: "Node", data: MultilevelSwitchNotificationDataType
+    ) -> None:
+        """Initialize."""
+        self.node = node
+        self.data = data
+
+    @property
+    def node_id(self) -> int:
+        """Return node ID property."""
+        return self.data["nodeId"]
+
+    @property
+    def command_class(self) -> int:
+        """Return command class."""
+        return self.data["ccId"]
+
+    @property
+    def event_type(self) -> MultilevelSwitchCommand:
+        """Return event type property."""
+        return MultilevelSwitchCommand(self.data["args"]["eventType"])
+
+    @property
+    def direction(self) -> Optional[str]:
+        """Return direction property."""
+        if direction := self.data["args"].get("direction"):
+            return direction
+        return None