zhaquirks SINOPE SW2500ZB: Added support for both press and release button events in order to properly support short and long press events.

bassdr · bassdr · commit 14de93c63ff8 · 2024-10-17T01:12:47.000-04:00
Also added the pressed button in the event arguments to simplify automations processing it.
diff --git a/tests/test_sinope.py b/tests/test_sinope.py
@@ -11,7 +11,14 @@
 
 from tests.common import ClusterListener
 import zhaquirks
-from zhaquirks.const import COMMAND_BUTTON_DOUBLE, COMMAND_BUTTON_HOLD
+from zhaquirks.const import (
+    COMMAND_M_INITIAL_PRESS,
+    COMMAND_M_LONG_RELEASE,
+    COMMAND_M_MULTI_PRESS_COMPLETE,
+    COMMAND_M_SHORT_RELEASE,
+    TURN_OFF,
+    TURN_ON,
+)
 from zhaquirks.sinope import SINOPE_MANUFACTURER_CLUSTER_ID
 from zhaquirks.sinope.light import (
     SinopeTechnologieslight,
@@ -92,20 +99,22 @@ def _get_packet_data(
 
 @pytest.mark.parametrize("quirk", (SinopeTechnologieslight,))
 @pytest.mark.parametrize(
-    "press_type,exp_event",
+    "press_type,button,exp_event",
     (
-        (ButtonAction.Single_off, None),
-        (ButtonAction.Single_on, None),
-        (ButtonAction.Double_on, COMMAND_BUTTON_DOUBLE),
-        (ButtonAction.Double_off, COMMAND_BUTTON_DOUBLE),
-        (ButtonAction.Long_on, COMMAND_BUTTON_HOLD),
-        (ButtonAction.Long_off, COMMAND_BUTTON_HOLD),
+        (ButtonAction.Single_off, TURN_OFF, COMMAND_M_INITIAL_PRESS),
+        (ButtonAction.Single_on, TURN_ON, COMMAND_M_INITIAL_PRESS),
+        (ButtonAction.Single_release_off, TURN_OFF, COMMAND_M_SHORT_RELEASE),
+        (ButtonAction.Single_release_on, TURN_ON, COMMAND_M_SHORT_RELEASE),
+        (ButtonAction.Double_on, TURN_ON, COMMAND_M_MULTI_PRESS_COMPLETE),
+        (ButtonAction.Double_off, TURN_OFF, COMMAND_M_MULTI_PRESS_COMPLETE),
+        (ButtonAction.Long_on, TURN_ON, COMMAND_M_LONG_RELEASE),
+        (ButtonAction.Long_off, TURN_OFF, COMMAND_M_LONG_RELEASE),
         # Should gracefully handle broken actions.
-        (t.uint8_t(0x00), None),
+        (t.uint8_t(0x00), None, None),
     ),
 )
 async def test_sinope_light_switch(
-    zigpy_device_from_quirk, quirk, press_type, exp_event
+    zigpy_device_from_quirk, quirk, press_type, button, exp_event
 ):
     """Test that button presses are sent as events."""
     device: Device = zigpy_device_from_quirk(quirk)
@@ -137,6 +146,7 @@ class Listener:
             {
                 "attribute_id": 84,
                 "attribute_name": "action_report",
+                "button": button,
                 "value": press_type.value,
             },
         )
diff --git a/zhaquirks/sinope/__init__.py b/zhaquirks/sinope/__init__.py
@@ -7,15 +7,18 @@
     ARGS,
     ATTRIBUTE_ID,
     ATTRIBUTE_NAME,
+    BUTTON,
     CLUSTER_ID,
     COMMAND,
-    COMMAND_BUTTON_DOUBLE,
-    COMMAND_BUTTON_HOLD,
-    COMMAND_BUTTON_SINGLE,
+    COMMAND_M_INITIAL_PRESS,
+    COMMAND_M_LONG_RELEASE,
+    COMMAND_M_MULTI_PRESS_COMPLETE,
+    COMMAND_M_SHORT_RELEASE,
     DOUBLE_PRESS,
     ENDPOINT_ID,
-    LONG_PRESS,
+    LONG_RELEASE,
     SHORT_PRESS,
+    SHORT_RELEASE,
     TURN_OFF,
     TURN_ON,
     VALUE,
@@ -29,38 +32,90 @@
     (SHORT_PRESS, TURN_ON): {
         ENDPOINT_ID: 1,
         CLUSTER_ID: 65281,
-        COMMAND: COMMAND_BUTTON_SINGLE,
-        ARGS: {ATTRIBUTE_ID: 84, ATTRIBUTE_NAME: ATTRIBUTE_ACTION, VALUE: 2},
+        COMMAND: COMMAND_M_INITIAL_PRESS,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_ON,
+            VALUE: 1,
+        },
     },
     (SHORT_PRESS, TURN_OFF): {
         ENDPOINT_ID: 1,
         CLUSTER_ID: 65281,
-        COMMAND: COMMAND_BUTTON_SINGLE,
-        ARGS: {ATTRIBUTE_ID: 84, ATTRIBUTE_NAME: ATTRIBUTE_ACTION, VALUE: 18},
+        COMMAND: COMMAND_M_INITIAL_PRESS,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_OFF,
+            VALUE: 17,
+        },
+    },
+    (SHORT_RELEASE, TURN_ON): {
+        ENDPOINT_ID: 1,
+        CLUSTER_ID: 65281,
+        COMMAND: COMMAND_M_SHORT_RELEASE,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_ON,
+            VALUE: 2,
+        },
+    },
+    (SHORT_RELEASE, TURN_OFF): {
+        ENDPOINT_ID: 1,
+        CLUSTER_ID: 65281,
+        COMMAND: COMMAND_M_SHORT_RELEASE,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_OFF,
+            VALUE: 18,
+        },
     },
     (DOUBLE_PRESS, TURN_ON): {
         ENDPOINT_ID: 1,
         CLUSTER_ID: 65281,
-        COMMAND: COMMAND_BUTTON_DOUBLE,
-        ARGS: {ATTRIBUTE_ID: 84, ATTRIBUTE_NAME: ATTRIBUTE_ACTION, VALUE: 4},
+        COMMAND: COMMAND_M_MULTI_PRESS_COMPLETE,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_ON,
+            VALUE: 4,
+        },
     },
     (DOUBLE_PRESS, TURN_OFF): {
         ENDPOINT_ID: 1,
         CLUSTER_ID: 65281,
-        COMMAND: COMMAND_BUTTON_DOUBLE,
-        ARGS: {ATTRIBUTE_ID: 84, ATTRIBUTE_NAME: ATTRIBUTE_ACTION, VALUE: 20},
+        COMMAND: COMMAND_M_MULTI_PRESS_COMPLETE,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_OFF,
+            VALUE: 20,
+        },
     },
-    (LONG_PRESS, TURN_ON): {
+    (LONG_RELEASE, TURN_ON): {
         ENDPOINT_ID: 1,
         CLUSTER_ID: 65281,
-        COMMAND: COMMAND_BUTTON_HOLD,
-        ARGS: {ATTRIBUTE_ID: 84, ATTRIBUTE_NAME: ATTRIBUTE_ACTION, VALUE: 3},
+        COMMAND: COMMAND_M_LONG_RELEASE,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_ON,
+            VALUE: 3,
+        },
     },
-    (LONG_PRESS, TURN_OFF): {
+    (LONG_RELEASE, TURN_OFF): {
         ENDPOINT_ID: 1,
         CLUSTER_ID: 65281,
-        COMMAND: COMMAND_BUTTON_HOLD,
-        ARGS: {ATTRIBUTE_ID: 84, ATTRIBUTE_NAME: ATTRIBUTE_ACTION, VALUE: 19},
+        COMMAND: COMMAND_M_LONG_RELEASE,
+        ARGS: {
+            ATTRIBUTE_ID: 84,
+            ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: TURN_OFF,
+            VALUE: 19,
+        },
     },
 }
 
diff --git a/zhaquirks/sinope/light.py b/zhaquirks/sinope/light.py
@@ -29,18 +29,24 @@
 from zhaquirks.const import (
     ATTRIBUTE_ID,
     ATTRIBUTE_NAME,
-    COMMAND_BUTTON_DOUBLE,
-    COMMAND_BUTTON_HOLD,
+    BUTTON,
+    COMMAND_M_INITIAL_PRESS,
+    COMMAND_M_LONG_RELEASE,
+    COMMAND_M_MULTI_PRESS_COMPLETE,
+    COMMAND_M_SHORT_RELEASE,
     DEVICE_TYPE,
     ENDPOINTS,
     INPUT_CLUSTERS,
     MODELS_INFO,
     OUTPUT_CLUSTERS,
     PROFILE_ID,
+    TURN_OFF,
+    TURN_ON,
     VALUE,
     ZHA_SEND_EVENT,
 )
-from zhaquirks.sinope import (
+
+from . import (
     ATTRIBUTE_ACTION,
     LIGHT_DEVICE_TRIGGERS,
     SINOPE,
@@ -192,27 +198,63 @@ def handle_cluster_general_request(
             )
 
         value = attr.value.value
+
+        action = self._get_command_from_action(self.Action(value))
+        button = self._get_button_from_action(self.Action(value))
+        if not action or not button:
+            return
+
         event_args = {
             ATTRIBUTE_ID: 84,
             ATTRIBUTE_NAME: ATTRIBUTE_ACTION,
+            BUTTON: button,
             VALUE: value.value,
         }
-        action = self._get_command_from_action(self.Action(value))
-        if not action:
-            return
+
+        self.debug(
+            "SINOPE ZHA_SEND_EVENT action: '%s' event_args: %s",
+            self.Action(value),
+            event_args,
+        )
+
         self.listener_event(ZHA_SEND_EVENT, action, event_args)
 
     def _get_command_from_action(self, action: ButtonAction) -> str | None:
-        # const lookup = {2: 'up_single', 3: 'up_hold', 4: 'up_double',
-        #             18: 'down_single', 19: 'down_hold', 20: 'down_double'};
+        # const lookup = {1: 'up_single', 2: 'up_single_released', 3: 'up_hold', 4: 'up_double',
+        #             17: 'down_single, 18: 'down_single_released', 19: 'down_hold', 20: 'down_double'};
         match action:
             case self.Action.Single_off | self.Action.Single_on:
-                return None
+                return COMMAND_M_INITIAL_PRESS
+            case self.Action.Single_release_off | self.Action.Single_release_on:
+                return COMMAND_M_SHORT_RELEASE
             case self.Action.Double_off | self.Action.Double_on:
-                return COMMAND_BUTTON_DOUBLE
+                return COMMAND_M_MULTI_PRESS_COMPLETE
             case self.Action.Long_off | self.Action.Long_on:
-                return COMMAND_BUTTON_HOLD
+                return COMMAND_M_LONG_RELEASE
+            case _:
+                self.debug("SINOPE unhandled action: %s", action)
+                return None
+
+    def _get_button_from_action(self, action: ButtonAction) -> str | None:
+        # const lookup = {1: 'up_single', 2: 'up_single_released', 3: 'up_hold', 4: 'up_double',
+        #             17: 'down_single, 18: 'down_single_released', 19: 'down_hold', 20: 'down_double'};
+        match action:
+            case (
+                self.Action.Single_off
+                | self.Action.Single_release_off
+                | self.Action.Double_off
+                | self.Action.Long_off
+            ):
+                return TURN_OFF
+            case (
+                self.Action.Single_on
+                | self.Action.Single_release_on
+                | self.Action.Double_on
+                | self.Action.Long_on
+            ):
+                return TURN_ON
             case _:
+                self.debug("SINOPE unhandled action: %s", action)
                 return None
 
 
diff --git a/zhaquirks/sinope/sensor.py b/zhaquirks/sinope/sensor.py
@@ -30,7 +30,8 @@
     OUTPUT_CLUSTERS,
     PROFILE_ID,
 )
-from zhaquirks.sinope import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID
+
+from . import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID
 
 
 class LeakStatus(t.enum8):
diff --git a/zhaquirks/sinope/switch.py b/zhaquirks/sinope/switch.py
@@ -43,11 +43,8 @@
     OUTPUT_CLUSTERS,
     PROFILE_ID,
 )
-from zhaquirks.sinope import (
-    SINOPE,
-    SINOPE_MANUFACTURER_CLUSTER_ID,
-    CustomDeviceTemperatureCluster,
-)
+
+from . import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID, CustomDeviceTemperatureCluster
 
 
 class KeypadLock(t.enum8):
diff --git a/zhaquirks/sinope/thermostat.py b/zhaquirks/sinope/thermostat.py
@@ -33,7 +33,8 @@
     OUTPUT_CLUSTERS,
     PROFILE_ID,
 )
-from zhaquirks.sinope import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID
+
+from . import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID
 
 
 class KeypadLock(t.enum8):

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,8 @@`
`30`	`30`	`OUTPUT_CLUSTERS,`
`31`	`31`	`PROFILE_ID,`
`32`	`32`	`)`
`33`		`-from zhaquirks.sinope import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID`
	`33`	`+`
	`34`	`+from . import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID`
`34`	`35`
`35`	`36`
`36`	`37`	`class LeakStatus(t.enum8):`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,8 @@`
`33`	`33`	`OUTPUT_CLUSTERS,`
`34`	`34`	`PROFILE_ID,`
`35`	`35`	`)`
`36`		`-from zhaquirks.sinope import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID`
	`36`	`+`
	`37`	`+from . import SINOPE, SINOPE_MANUFACTURER_CLUSTER_ID`
`37`	`38`
`38`	`39`
`39`	`40`	`class KeypadLock(t.enum8):`