Clean up Danfoss TRV custom attributes definitions and commands (#2150)

Danfoss thermostat: Fix attributes access, types, names and remove unsupported ones. split up proprietary clusters. add preheat_command (no usage yet). force read before bind of cluster. Add 2 thermostat models. Refactoring

---------

Co-authored-by: TheJulianJES <[email protected]>

Author: Caius-Bonus

tests/test_danfoss.py

@@ -0,0 +1,239 @@
+"""Tests the Danfoss quirk (all tests were written for the Popp eT093WRO)."""
+from unittest import mock
+
+from zigpy.quirks import CustomCluster
+from zigpy.zcl import foundation
+from zigpy.zcl.clusters.hvac import Thermostat
+from zigpy.zcl.foundation import WriteAttributesStatusRecord, ZCLAttributeDef
+
+import zhaquirks
+from zhaquirks.danfoss.thermostat import CustomizedStandardCluster
+
+zhaquirks.setup()
+
+
+def test_popp_signature(assert_signature_matches_quirk):
+    """Test the signature matching the Device Class."""
+    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=4678, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, 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)",
+        # SizePrefixedSimpleDescriptor(endpoint=1, profile=260, device_type=769, device_version=1, input_clusters=[0, 1, 3, 10, 32, 513, 516, 2821], output_clusters=[0, 25])
+        "endpoints": {
+            "1": {
+                "profile_id": 260,
+                "device_type": "0x0301",
+                "in_clusters": [
+                    "0x0000",
+                    "0x0001",
+                    "0x0003",
+                    "0x000a",
+                    "0x0020",
+                    "0x0201",
+                    "0x0204",
+                    "0x0b05",
+                ],
+                "out_clusters": ["0x0000", "0x0019"],
+            }
+        },
+        "manufacturer": "D5X84YU",
+        "model": "eT093WRO",
+        "class": "danfoss.thermostat.DanfossThermostat",
+    }
+
+    assert_signature_matches_quirk(
+        zhaquirks.danfoss.thermostat.DanfossThermostat, signature
+    )
+
+
+@mock.patch("zigpy.zcl.Cluster.bind", mock.AsyncMock())
+async def test_danfoss_time_bind(zigpy_device_from_quirk):
+    """Test the time being set when binding the Time cluster."""
+    device = zigpy_device_from_quirk(zhaquirks.danfoss.thermostat.DanfossThermostat)
+
+    danfoss_time_cluster = device.endpoints[1].time
+    danfoss_thermostat_cluster = device.endpoints[1].thermostat
+
+    def mock_write(attributes, manufacturer=None):
+        records = [
+            WriteAttributesStatusRecord(foundation.Status.SUCCESS)
+            for _ in attributes
+        ]
+        return [records, []]
+
+    patch_danfoss_trv_write = mock.patch.object(
+        danfoss_time_cluster,
+        "_write_attributes",
+        mock.AsyncMock(side_effect=mock_write),
+    )
+
+    with patch_danfoss_trv_write:
+        await danfoss_thermostat_cluster.bind()
+
+        assert 0x0000 in danfoss_time_cluster._attr_cache
+        assert 0x0001 in danfoss_time_cluster._attr_cache
+        assert 0x0002 in danfoss_time_cluster._attr_cache
+
+
+async def test_danfoss_thermostat_write_attributes(zigpy_device_from_quirk):
+    """Test the Thermostat writes behaving correctly, in particular regarding setpoint."""
+    device = zigpy_device_from_quirk(zhaquirks.danfoss.thermostat.DanfossThermostat)
+
+    danfoss_thermostat_cluster = device.endpoints[1].thermostat
+
+    def mock_write(attributes, manufacturer=None):
+        records = [
+            WriteAttributesStatusRecord(foundation.Status.SUCCESS)
+            for _ in attributes
+        ]
+        return [records, []]
+
+    setting = -100
+    operation = -0x01
+
+    def mock_setpoint(oper, sett, manufacturer=None):
+        nonlocal operation, setting
+        operation = oper
+        setting = sett
+
+    # data is written to trv
+    patch_danfoss_trv_write = mock.patch.object(
+        danfoss_thermostat_cluster,
+        "_write_attributes",
+        mock.AsyncMock(side_effect=mock_write),
+    )
+    patch_danfoss_setpoint = mock.patch.object(
+        danfoss_thermostat_cluster,
+        "setpoint_command",
+        mock.AsyncMock(side_effect=mock_setpoint),
+    )
+
+    with patch_danfoss_trv_write:
+        # data should be written to trv, but reach thermostat
+        success, fail = await danfoss_thermostat_cluster.write_attributes(
+            {"external_open_window_detected": False}
+        )
+        assert success
+        assert not fail
+        assert not danfoss_thermostat_cluster._attr_cache[0x4003]
+
+        with patch_danfoss_setpoint:
+            # data should be received from danfoss_trv
+            success, fail = await danfoss_thermostat_cluster.write_attributes(
+                {"occupied_heating_setpoint": 6}
+            )
+            assert success
+            assert not fail
+            assert danfoss_thermostat_cluster._attr_cache[0x0012] == 6
+            assert operation == 0x01
+            assert setting == 6
+
+            danfoss_thermostat_cluster._attr_cache[
+                0x0015
+            ] = 5  # min_limit is present normally
+
+            success, fail = await danfoss_thermostat_cluster.write_attributes(
+                {"system_mode": 0x00}
+            )
+            assert success
+            assert not fail
+            assert danfoss_thermostat_cluster._attr_cache[0x001C] == 0x04
+
+            # setpoint to min_limit, when system_mode to off
+            assert danfoss_thermostat_cluster._attr_cache[0x0012] == 5
+
+            assert operation == 0x01
+            assert setting == 5
+
+
+async def test_customized_standardcluster(zigpy_device_from_quirk):
+    """Test customized standard cluster class correctly separating zigbee operations.
+
+    This is regarding manufacturer specific attributes.
+    """
+    device = zigpy_device_from_quirk(zhaquirks.danfoss.thermostat.DanfossThermostat)
+
+    danfoss_thermostat_cluster = device.endpoints[1].in_clusters[Thermostat.cluster_id]
+
+    assert CustomizedStandardCluster.combine_results([[4545], [5433]], [[345]]) == [
+        [4545, 345],
+        [5433],
+    ]
+    assert CustomizedStandardCluster.combine_results(
+        [[4545], [5433]], [[345], [45355]]
+    ) == [[4545, 345], [5433, 45355]]
+
+    mock_attributes = {
+        656: ZCLAttributeDef(is_manufacturer_specific=True),
+        56454: ZCLAttributeDef(is_manufacturer_specific=False),
+    }
+
+    danfoss_thermostat_cluster.attributes = mock_attributes
+
+    reports = None
+
+    def mock_configure_reporting(reps, *args, **kwargs):
+        nonlocal reports
+        if mock_attributes[reps[0].attrid].is_manufacturer_specific:
+            reports = reps
+
+        return [[545], [4545]]
+
+    # data is written to trv
+    patch_danfoss_configure_reporting = mock.patch.object(
+        CustomCluster,
+        "_configure_reporting",
+        mock.AsyncMock(side_effect=mock_configure_reporting),
+    )
+
+    with patch_danfoss_configure_reporting:
+        one = foundation.AttributeReportingConfig()
+        one.direction = True
+        one.timeout = 4
+        one.attrid = 56454
+
+        two = foundation.AttributeReportingConfig()
+        two.direction = True
+        two.timeout = 4
+        two.attrid = 656
+        await danfoss_thermostat_cluster._configure_reporting([one, two])
+        assert reports == [two]
+
+    reports = None
+
+    def mock_read_attributes(attrs, *args, **kwargs):
+        nonlocal reports
+        if mock_attributes[attrs[0]].is_manufacturer_specific:
+            reports = attrs
+
+        return [[545]]
+
+    # data is written to trv
+    patch_danfoss_read_attributes = mock.patch.object(
+        CustomCluster,
+        "_read_attributes",
+        mock.AsyncMock(side_effect=mock_read_attributes),
+    )
+
+    with patch_danfoss_read_attributes:
+        result = await danfoss_thermostat_cluster._read_attributes([56454, 656])
+        assert result
+        assert reports == [656]
+
+    def mock_read_attributes_fail(attrs, *args, **kwargs):
+        nonlocal reports
+        if mock_attributes[attrs[0]].is_manufacturer_specific:
+            reports = attrs
+
+        return [[545], [4545]]
+
+    # data is written to trv
+    patch_danfoss_read_attributes_fail = mock.patch.object(
+        CustomCluster,
+        "_read_attributes",
+        mock.AsyncMock(side_effect=mock_read_attributes_fail),
+    )
+
+    with patch_danfoss_read_attributes_fail:
+        result, fail = await danfoss_thermostat_cluster._read_attributes([56454, 656])
+        assert result
+        assert fail
+        assert reports == [656]

zhaquirks/danfoss/__init__.py

@@ -1,3 +1 @@
 """Module for Danfoss quirks implementations."""
-DANFOSS = "Danfoss"
-D5X84YU = "D5X84YU"