Add Tuya vibration door sensor _TZE200_kzm5w4iz

tests/test_tuya.py

@@ -5,11 +5,13 @@
 from unittest import mock
 
 import pytest
+from zigpy.device import Device
 from zigpy.profiles import zha
 from zigpy.quirks import CustomDevice, get_device
 import zigpy.types as t
 from zigpy.zcl import foundation
 from zigpy.zcl.clusters.general import PowerConfiguration
+from zigpy.zcl.clusters.security import IasZone, ZoneStatus
 
 from tests.common import ClusterListener, MockDatetime, wait_for_zigpy_tasks
 import zhaquirks
@@ -37,6 +39,7 @@
 import zhaquirks.tuya.ts0601_siren
 import zhaquirks.tuya.ts0601_trv
 import zhaquirks.tuya.ts0601_valve
+import zhaquirks.tuya.ts601_door
 
 zhaquirks.setup()
 
@@ -1657,3 +1660,96 @@ async def test_power_config_no_bind(zigpy_device_from_quirk, quirk):
 
         assert len(request_mock.mock_calls) == 0
         assert len(bind_mock.mock_calls) == 0
+
+
+def test_ts601_door_sensor_signature(assert_signature_matches_quirk):
+    """Test TS601 Vibration Door Sensor signature against quirk."""
+    signature = {
+        "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.EndDevice: 2>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress: 128>, manufacturer_code=4417, maximum_buffer_size=66, maximum_incoming_transfer_size=66, server_mask=10752, maximum_outgoing_transfer_size=66, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False)",
+        "endpoints": {
+            "1": {
+                "profile_id": 260,
+                "device_type": "0x0051",
+                "in_clusters": ["0x0000", "0x0004", "0x0005", "0xef00"],
+                "out_clusters": ["0x000a", "0x0019"],
+            }
+        },
+        "manufacturer": "_TZE200_kzm5w4iz",
+        "model": "TS0601",
+        "class": "zigpy.device.Device",
+    }
+    assert_signature_matches_quirk(zhaquirks.tuya.ts601_door.TS0601Door, signature)
+
+
+@pytest.mark.parametrize(
+    ("data", "endpoint_id", "ep_attr", "attribute", "expected_value"),
+    [
+        (
+            b"\t\xfc\x02\x007\x01\x01\x00\x01\x01",
+            zhaquirks.tuya.ts601_door.DOOR_HANDLE_EP_ID,
+            IasZone.ep_attribute,
+            IasZone.AttributeDefs.zone_status.id,
+            ZoneStatus.Alarm_1,
+        ),
+        (
+            b"\t\xfc\x02\x007\x01\x01\x00\x01\x00",
+            zhaquirks.tuya.ts601_door.DOOR_HANDLE_EP_ID,
+            IasZone.ep_attribute,
+            IasZone.AttributeDefs.zone_status.id,
+            0x0000,
+        ),
+        (
+            b"\t\xfc\x02\x007\n\x04\x00\x01\x01",
+            zhaquirks.tuya.ts601_door.VIBRATION_EP_ID,
+            IasZone.ep_attribute,
+            IasZone.AttributeDefs.zone_status.id,
+            ZoneStatus.Alarm_1,
+        ),
+        (
+            b"\t\xfc\x02\x007\n\x04\x00\x01\x00",
+            zhaquirks.tuya.ts601_door.VIBRATION_EP_ID,
+            IasZone.ep_attribute,
+            IasZone.AttributeDefs.zone_status.id,
+            0x0000,
+        ),
+        (
+            b"\to\x02\x00P\x03\x02\x00\x04\x00\x00\x00T",
+            zhaquirks.tuya.ts601_door.DP_HANDLER_EP_ID,
+            PowerConfiguration.ep_attribute,
+            PowerConfiguration.AttributeDefs.battery_percentage_remaining.id,
+            84 * 2,
+        ),
+    ],
+)
+async def test_ts601_door_sensor(
+    zigpy_device_from_quirk, data, endpoint_id, ep_attr, attribute, expected_value
+):
+    """Test TS601 Vibration Door Sensor quirk.
+
+    The quirk is tested for:
+        - Open/Closed door
+        - Vibration On/Off
+        - Remaining battery percentage
+    """
+    device: Device = zigpy_device_from_quirk(zhaquirks.tuya.ts601_door.TS0601Door)
+    device._packet_debouncer.filter = mock.MagicMock(return_value=False)
+
+    dp_processor_ep = zhaquirks.tuya.ts601_door.DP_HANDLER_EP_ID
+    cluster = device.endpoints[dp_processor_ep].in_clusters[
+        TuyaNewManufCluster.cluster_id
+    ]
+
+    with mock.patch.object(cluster, "send_default_rsp"):
+        device.packet_received(
+            t.ZigbeePacket(
+                profile_id=zha.PROFILE_ID,
+                src_ep=dp_processor_ep,
+                cluster_id=TuyaNewManufCluster.cluster_id,
+                data=t.SerializableBytes(data),
+            )
+        )
+
+    cluster = getattr(device.endpoints[endpoint_id], ep_attr)
+    attrs = await cluster.read_attributes(attributes=[attribute])
+
+    assert attrs[0].get(attribute) == expected_value

zhaquirks/tuya/ts601_door.py

@@ -0,0 +1,230 @@
+"""Device handler for Tuya Zigbee Vibration Door Sensor.
+
+The device reports:
+- Vibration
+- Open/Closed door/window
+- Remaining battery percentage
+
+Extra details: https://www.aliexpress.com/item/1005004443361928.html?spm=a2g0o.order_list.order_list_main.53.35a81802wiZASs
+"""
+
+from zigpy.endpoint import Endpoint
+from zigpy.profiles import zha
+from zigpy.quirks import CustomCluster, CustomDevice
+from zigpy.zcl.clusters.general import (
+    Basic,
+    Groups,
+    Ota,
+    PowerConfiguration,
+    Scenes,
+    Time,
+)
+from zigpy.zcl.clusters.security import IasZone, ZoneStatus, ZoneType
+
+from zhaquirks.const import (
+    DEVICE_TYPE,
+    ENDPOINTS,
+    INPUT_CLUSTERS,
+    MODELS_INFO,
+    OUTPUT_CLUSTERS,
+    PROFILE_ID,
+    ZONE_STATE,
+)
+from zhaquirks.tuya import (
+    TUYA_CLUSTER_ID,
+    DPToAttributeMapping,
+    TuyaLocalCluster,
+    TuyaNewManufCluster,
+)
+
+DOOR_HANDLE_DP_ID = 1
+BATTERY_STATE_DP_ID = 3
+VIBRATION_DP_ID = 10
+
+DP_HANDLER_EP_ID = 1
+DOOR_HANDLE_EP_ID = 2
+VIBRATION_EP_ID = 3
+
+
+class CustomBasicCluster(CustomCluster, Basic):
+    """Custom Basic cluster to report power source."""
+
+    _CONSTANT_ATTRIBUTES = {
+        Basic.AttributeDefs.power_source.id: Basic.PowerSource.Battery
+    }
+
+
+class CustomTuyaPowerConfigurationCluster(TuyaLocalCluster, PowerConfiguration):
+    """Custom Power Configuration cluster that represents battery reports."""
+
+    _CONSTANT_ATTRIBUTES = {
+        PowerConfiguration.AttributeDefs.battery_size.id: PowerConfiguration.BatterySize.AAA,
+        PowerConfiguration.AttributeDefs.battery_quantity.id: 2,
+    }
+
+    def __init__(self, endpoint: Endpoint, is_server: bool = True):
+        """Init constructor that initializes battery attributes."""
+        super().__init__(endpoint=endpoint, is_server=is_server)
+
+        # Initialize remaining battery to 100% until a proper measurement arrives.
+        # Device measures battery in 1% steps, while the ZCL specifies it in 0.5% steps.
+        self.update_attribute(
+            attr_name=PowerConfiguration.AttributeDefs.battery_percentage_remaining.name,
+            value=100 * 2,
+        )
+
+
+class CustomTuyaContactSwitchCluster(TuyaLocalCluster, IasZone):
+    """Custom IasZone cluster that represents the Open/Closed sensor."""
+
+    _CONSTANT_ATTRIBUTES = {
+        IasZone.AttributeDefs.zone_state.id: ZONE_STATE,
+        IasZone.AttributeDefs.zone_type.id: ZoneType.Contact_Switch,
+    }
+
+    def __init__(self, endpoint: Endpoint, is_server: bool = True):
+        """Init constructor that initializes the major IasZone attributes."""
+        super().__init__(endpoint=endpoint, is_server=is_server)
+
+        # Initialize zone status until a proper update comes.
+        self.update_attribute(
+            attr_name=IasZone.AttributeDefs.zone_status.name,
+            value=0x0000,
+        )
+
+
+class CustomTuyaVibrationCluster(TuyaLocalCluster, IasZone):
+    """Custom IasZone cluster that represents the vibration sensor."""
+
+    _CONSTANT_ATTRIBUTES = {
+        IasZone.AttributeDefs.zone_state.id: ZONE_STATE,
+        IasZone.AttributeDefs.zone_type.id: ZoneType.Vibration_Movement_Sensor,
+    }
+
+    def __init__(self, endpoint: Endpoint, is_server: bool = True):
+        """Init constructor that initializes the major IasZone attributes."""
+        super().__init__(endpoint=endpoint, is_server=is_server)
+
+        # Initialize zone status until a proper update comes.
+        self.update_attribute(
+            attr_name=IasZone.AttributeDefs.zone_status.name,
+            value=0x0000,
+        )
+
+
+class CustomTuyaDPProcessor(TuyaNewManufCluster):
+    """Custom cluster that translates Tuya's data point reporting.
+
+    Tuya data points are parsed and their values are used to update the
+    specified endpoint's (endpoint_id) cluster's (ep_attribute)
+    attribute (attribute_name).
+    """
+
+    dp_to_attribute: dict[int, DPToAttributeMapping] = {
+        DOOR_HANDLE_DP_ID: DPToAttributeMapping(
+            endpoint_id=DOOR_HANDLE_EP_ID,
+            ep_attribute=IasZone.ep_attribute,
+            attribute_name=IasZone.AttributeDefs.zone_status.name,
+            converter=lambda x: ZoneStatus.Alarm_1 & x,
+        ),
+        VIBRATION_DP_ID: DPToAttributeMapping(
+            endpoint_id=VIBRATION_EP_ID,
+            ep_attribute=IasZone.ep_attribute,
+            attribute_name=IasZone.AttributeDefs.zone_status.name,
+            converter=lambda x: ZoneStatus.Alarm_1 & x,
+        ),
+        BATTERY_STATE_DP_ID: DPToAttributeMapping(
+            endpoint_id=DP_HANDLER_EP_ID,
+            ep_attribute=PowerConfiguration.ep_attribute,
+            attribute_name=PowerConfiguration.AttributeDefs.battery_percentage_remaining.name,
+            converter=lambda x: 2 * x,
+            # Device measures battery in 1% steps, while the ZCL specifies it in 0.5% steps
+        ),
+    }
+
+    data_point_handlers = {
+        DOOR_HANDLE_DP_ID: "_dp_2_attr_update",
+        VIBRATION_DP_ID: "_dp_2_attr_update",
+        BATTERY_STATE_DP_ID: "_dp_2_attr_update",
+    }
+
+
+class TS0601Door(CustomDevice):
+    """Quirk for Tuya Zigbee Vibration Door Sensor.
+
+    The device reports:
+    - Vibration
+    - Open/closed door/window
+    - Remaining battery percentage
+
+    The original device has a single endpoint that corresponds to the Tuya
+    manufacturer specific cluster. The replacement has 3 endpoints, where
+        - the first is responsible for handling the Tuya data point reports,
+        - the second represents the open/closed sensor,
+        - and the third represents the vibration sensor.
+    The latter two are both IasZone cluster extensions, that's why they had to
+    be put into different endpoints (otherwise we would have two of the same
+    cluster for an endpoint, which is prohibited by the Zigbee standard).
+
+    Extra details about the physical device: https://www.aliexpress.com/item/1005004443361928.html?spm=a2g0o.order_list.order_list_main.53.35a81802wiZASs
+    """
+
+    signature = {
+        # <SimpleDescriptor endpoint=1 profile=260 device_type=81
+        # device_version=1
+        # input_clusters=[4, 5, 61184, 0]
+        # output_clusters=[25, 10]>
+        MODELS_INFO: [("_TZE200_kzm5w4iz", "TS0601")],
+        ENDPOINTS: {
+            1: {
+                PROFILE_ID: zha.PROFILE_ID,
+                DEVICE_TYPE: zha.DeviceType.SMART_PLUG,
+                INPUT_CLUSTERS: [
+                    Basic.cluster_id,
+                    Groups.cluster_id,
+                    Scenes.cluster_id,
+                    TUYA_CLUSTER_ID,
+                ],
+                OUTPUT_CLUSTERS: [Time.cluster_id, Ota.cluster_id],
+            },
+        },
+    }
+
+    replacement = {
+        ENDPOINTS: {
+            DP_HANDLER_EP_ID: {
+                PROFILE_ID: zha.PROFILE_ID,
+                DEVICE_TYPE: zha.DeviceType.SMART_PLUG,
+                INPUT_CLUSTERS: [
+                    CustomBasicCluster,
+                    Groups.cluster_id,
+                    Scenes.cluster_id,
+                    CustomTuyaPowerConfigurationCluster,
+                    CustomTuyaDPProcessor,
+                ],
+                OUTPUT_CLUSTERS: [Time.cluster_id, Ota.cluster_id],
+            },
+            DOOR_HANDLE_EP_ID: {
+                PROFILE_ID: zha.PROFILE_ID,
+                DEVICE_TYPE: zha.DeviceType.IAS_ZONE,
+                INPUT_CLUSTERS: [
+                    CustomBasicCluster,
+                    Groups.cluster_id,
+                    Scenes.cluster_id,
+                    CustomTuyaContactSwitchCluster,
+                ],
+                OUTPUT_CLUSTERS: [Time.cluster_id],
+            },
+            VIBRATION_EP_ID: {
+                PROFILE_ID: zha.PROFILE_ID,
+                DEVICE_TYPE: zha.DeviceType.IAS_ZONE,
+                INPUT_CLUSTERS: [
+                    CustomBasicCluster,
+                    Groups.cluster_id,
+                    Scenes.cluster_id,
+                    CustomTuyaVibrationCluster,
+                ],
+                OUTPUT_CLUSTERS: [Time.cluster_id],
+            },
+        },
+    }