Add Danfoss Ally thermostat and derivatives to ZHA #86907 on core (#57)

Author: dmulcahey

tests/test_sensor.py

@@ -6,6 +6,7 @@
 from typing import Any, Optional
 
 import pytest
+from zhaquirks.danfoss import thermostat as danfoss_thermostat
 from zigpy.device import Device as ZigpyDevice
 import zigpy.profiles.zha
 from zigpy.quirks import CustomCluster, get_device
@@ -21,7 +22,7 @@
 from zha.application.const import ZHA_CLUSTER_HANDLER_READS_PER_REQ
 from zha.application.gateway import Gateway
 from zha.application.platforms import PlatformEntity, sensor
-from zha.application.platforms.sensor import UnitOfMass
+from zha.application.platforms.sensor import DanfossSoftwareErrorCode, UnitOfMass
 from zha.application.platforms.sensor.const import SensorDeviceClass
 from zha.units import PERCENTAGE, UnitOfEnergy, UnitOfPressure, UnitOfVolume
 from zha.zigbee.device import Device
@@ -330,7 +331,6 @@ async def async_test_powerconfiguration(
         "battery_voltage",
         "battery_quantity",
         "battery_size",
-        "battery_voltage",
     }
     await send_attributes_report(zha_gateway, cluster, {33: 98})
     assert_state(entity, 49, "%")
@@ -1229,3 +1229,68 @@ async def test_device_unavailable_skips_entity_polling(
         "00:0d:6f:00:0a:90:69:e7-1-0-rssi: skipping polling for updated state, "
         "available: False, allow polled requests: True" in caplog.text
     )
+
+
+@pytest.fixture
+async def zigpy_device_danfoss_thermostat(
+    zigpy_device_mock: Callable[..., ZigpyDevice],  # pylint: disable=redefined-outer-name
+    device_joined: Callable[[ZigpyDevice], Awaitable[Device]],
+) -> Device:
+    """Danfoss thermostat device."""
+
+    zigpy_device = zigpy_device_mock(
+        {
+            1: {
+                SIG_EP_INPUT: [
+                    general.Basic.cluster_id,
+                    general.PowerConfiguration.cluster_id,
+                    general.Identify.cluster_id,
+                    general.Time.cluster_id,
+                    general.PollControl.cluster_id,
+                    hvac.Thermostat.cluster_id,
+                    hvac.UserInterface.cluster_id,
+                    homeautomation.Diagnostic.cluster_id,
+                ],
+                SIG_EP_OUTPUT: [general.Basic.cluster_id, general.Ota.cluster_id],
+                SIG_EP_TYPE: zigpy.profiles.zha.DeviceType.THERMOSTAT,
+            }
+        },
+        manufacturer="Danfoss",
+        model="eTRV0100",
+        quirk=danfoss_thermostat.DanfossThermostat,
+    )
+
+    zha_device = await device_joined(zigpy_device)
+    return zha_device, zigpy_device
+
+
+async def test_danfoss_thermostat_sw_error(
+    zha_gateway: Gateway,
+    zigpy_device_danfoss_thermostat,  # pylint: disable=redefined-outer-name
+) -> None:
+    """Test quirks defined thermostat."""
+
+    zha_device, zigpy_device = zigpy_device_danfoss_thermostat
+
+    entity = get_entity(
+        zha_device,
+        platform=Platform.SENSOR,
+        exact_entity_type=DanfossSoftwareErrorCode,
+        qualifier="sw_error_code",
+    )
+    assert entity is not None
+
+    cluster = zigpy_device.endpoints[1].diagnostic
+
+    await send_attributes_report(
+        zha_gateway,
+        cluster,
+        {
+            danfoss_thermostat.DanfossDiagnosticCluster.AttributeDefs.sw_error_code.id: 0x0001
+        },
+    )
+
+    assert entity.state["state"] == "something"
+    assert entity.extra_state_attribute_names
+    assert "Top_pcb_sensor_error" in entity.extra_state_attribute_names
+    assert entity.state["Top_pcb_sensor_error"]

zha/application/platforms/binary_sensor/__init__.py

@@ -7,6 +7,7 @@
 import logging
 from typing import TYPE_CHECKING
 
+from zhaquirks.quirk_ids import DANFOSS_ALLY_THERMOSTAT
 from zigpy.quirks.v2 import BinarySensorMetadata
 
 from zha.application import Platform
@@ -25,6 +26,7 @@
     CLUSTER_HANDLER_HUE_OCCUPANCY,
     CLUSTER_HANDLER_OCCUPANCY,
     CLUSTER_HANDLER_ON_OFF,
+    CLUSTER_HANDLER_THERMOSTAT,
     CLUSTER_HANDLER_ZONE,
 )
 
@@ -358,3 +360,43 @@ class AqaraE1CurtainMotorOpenedByHandBinarySensor(BinarySensor):
     _attribute_name = "hand_open"
     _attr_translation_key = "hand_open"
     _attr_entity_category = EntityCategory.DIAGNOSTIC
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossMountingModeActive(BinarySensor):
+    """Danfoss TRV proprietary attribute exposing whether in mounting mode."""
+
+    _unique_id_suffix = "mounting_mode_active"
+    _attribute_name = "mounting_mode_active"
+    _attr_translation_key: str = "mounting_mode_active"
+    _attr_device_class: BinarySensorDeviceClass = BinarySensorDeviceClass.OPENING
+    _attr_entity_category = EntityCategory.DIAGNOSTIC
+
+
+@MULTI_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossHeatRequired(BinarySensor):
+    """Danfoss TRV proprietary attribute exposing whether heat is required."""
+
+    _unique_id_suffix = "heat_required"
+    _attribute_name = "heat_required"
+    _attr_translation_key: str = "heat_required"
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossPreheatStatus(BinarySensor):
+    """Danfoss TRV proprietary attribute exposing whether in pre-heating mode."""
+
+    _unique_id_suffix = "preheat_status"
+    _attribute_name = "preheat_status"
+    _attr_translation_key: str = "preheat_status"
+    _attr_entity_registry_enabled_default = False
+    _attr_entity_category = EntityCategory.DIAGNOSTIC

zha/application/platforms/number/__init__.py

@@ -7,6 +7,7 @@
 import logging
 from typing import TYPE_CHECKING, Any, Self
 
+from zhaquirks.quirk_ids import DANFOSS_ALLY_THERMOSTAT
 from zigpy.quirks.v2 import NumberMetadata
 from zigpy.zcl.clusters.hvac import Thermostat
 
@@ -21,7 +22,7 @@
     NumberMode,
 )
 from zha.application.registries import PLATFORM_ENTITIES
-from zha.units import UnitOfMass, UnitOfTemperature, validate_unit
+from zha.units import UnitOfMass, UnitOfTemperature, UnitOfTime, validate_unit
 from zha.zigbee.cluster_handlers import ClusterAttributeUpdatedEvent
 from zha.zigbee.cluster_handlers.const import (
     CLUSTER_HANDLER_ANALOG_OUTPUT,
@@ -144,6 +145,7 @@ def native_step(self) -> float | None:
     def name(self) -> str | None:
         """Return the name of the number entity."""
         description = self._analog_output_cluster_handler.description
+        # TODO what happened here?
         if description is not None and len(description) > 0:
             return f"{super().name} {description}"
         return super().name
@@ -899,3 +901,70 @@ class MinHeatSetpointLimit(ZCLHeatSetpointLimitEntity):
     _attr_entity_category = EntityCategory.CONFIG
 
     _max_source = Thermostat.AttributeDefs.max_heat_setpoint_limit.name
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossExerciseTriggerTime(NumberConfigurationEntity):
+    """Danfoss proprietary attribute to set the time to exercise the valve."""
+
+    _unique_id_suffix = "exercise_trigger_time"
+    _attribute_name: str = "exercise_trigger_time"
+    _attr_translation_key: str = "exercise_trigger_time"
+    _attr_native_min_value: int = 0
+    _attr_native_max_value: int = 1439
+    _attr_mode: NumberMode = NumberMode.BOX
+    _attr_native_unit_of_measurement: str = UnitOfTime.MINUTES
+    _attr_icon: str = "mdi:clock"
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossExternalMeasuredRoomSensor(ZCLTemperatureEntity):
+    """Danfoss proprietary attribute to communicate the value of the external temperature sensor."""
+
+    _unique_id_suffix = "external_measured_room_sensor"
+    _attribute_name: str = "external_measured_room_sensor"
+    _attr_translation_key: str = "external_temperature_sensor"
+    _attr_native_min_value: float = -80
+    _attr_native_max_value: float = 35
+    _attr_icon: str = "mdi:thermometer"
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossLoadRoomMean(NumberConfigurationEntity):
+    """Danfoss proprietary attribute to set a value for the load."""
+
+    _unique_id_suffix = "load_room_mean"
+    _attribute_name: str = "load_room_mean"
+    _attr_translation_key: str = "load_room_mean"
+    _attr_native_min_value: int = -8000
+    _attr_native_max_value: int = 2000
+    _attr_mode: NumberMode = NumberMode.BOX
+    _attr_icon: str = "mdi:scale-balance"
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossRegulationSetpointOffset(NumberConfigurationEntity):
+    """Danfoss proprietary attribute to set the regulation setpoint offset."""
+
+    _unique_id_suffix = "regulation_setpoint_offset"
+    _attribute_name: str = "regulation_setpoint_offset"
+    _attr_translation_key: str = "regulation_setpoint_offset"
+    _attr_mode: NumberMode = NumberMode.BOX
+    _attr_native_unit_of_measurement: str = UnitOfTemperature.CELSIUS
+    _attr_icon: str = "mdi:thermostat"
+    _attr_native_min_value: float = -2.5
+    _attr_native_max_value: float = 2.5
+    _attr_native_step: float = 0.1
+    _attr_multiplier = 1 / 10

zha/application/platforms/select.py

@@ -8,7 +8,12 @@
 import logging
 from typing import TYPE_CHECKING, Any, Self
 
-from zhaquirks.quirk_ids import TUYA_PLUG_MANUFACTURER, TUYA_PLUG_ONOFF
+from zhaquirks.danfoss import thermostat as danfoss_thermostat
+from zhaquirks.quirk_ids import (
+    DANFOSS_ALLY_THERMOSTAT,
+    TUYA_PLUG_MANUFACTURER,
+    TUYA_PLUG_ONOFF,
+)
 from zhaquirks.xiaomi.aqara.magnet_ac01 import OppleCluster as MagnetAC01OppleCluster
 from zhaquirks.xiaomi.aqara.switch_acn047 import OppleCluster as T2RelayOppleCluster
 from zigpy import types
@@ -28,6 +33,7 @@
     CLUSTER_HANDLER_INOVELLI,
     CLUSTER_HANDLER_OCCUPANCY,
     CLUSTER_HANDLER_ON_OFF,
+    CLUSTER_HANDLER_THERMOSTAT,
 )
 
 if TYPE_CHECKING:
@@ -695,3 +701,105 @@ class KeypadLockout(ZCLEnumSelectEntity):
     _attribute_name: str = "keypad_lockout"
     _enum = KeypadLockoutEnum
     _attr_translation_key: str = "keypad_lockout"
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossExerciseDayOfTheWeek(ZCLEnumSelectEntity):
+    """Danfoss proprietary attribute for setting the day of the week for exercising."""
+
+    _unique_id_suffix = "exercise_day_of_week"
+    _attribute_name = "exercise_day_of_week"
+    _attr_translation_key: str = "exercise_day_of_week"
+    _enum = danfoss_thermostat.DanfossExerciseDayOfTheWeekEnum
+    _attr_icon: str = "mdi:wrench-clock"
+
+
+class DanfossOrientationEnum(types.enum8):
+    """Vertical or Horizontal."""
+
+    Horizontal = 0x00
+    Vertical = 0x01
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossOrientation(ZCLEnumSelectEntity):
+    """Danfoss proprietary attribute for setting the orientation of the valve.
+
+    Needed for biasing the internal temperature sensor.
+    This is implemented as an enum here, but is a boolean on the device.
+    """
+
+    _unique_id_suffix = "orientation"
+    _attribute_name = "orientation"
+    _attr_translation_key: str = "valve_orientation"
+    _enum = DanfossOrientationEnum
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossAdaptationRunControl(ZCLEnumSelectEntity):
+    """Danfoss proprietary attribute for controlling the current adaptation run."""
+
+    _unique_id_suffix = "adaptation_run_control"
+    _attribute_name = "adaptation_run_control"
+    _attr_translation_key: str = "adaptation_run_command"
+    _enum = danfoss_thermostat.DanfossAdaptationRunControlEnum
+
+
+class DanfossControlAlgorithmScaleFactorEnum(types.enum8):
+    """The time scale factor for changing the opening of the valve.
+
+    Not all values are given, therefore there are some extrapolated values with a margin of error of about 5 minutes.
+    This is implemented as an enum here, but is a number on the device.
+    """
+
+    quick_5min = 0x01
+
+    quick_10min = 0x02  # extrapolated
+    quick_15min = 0x03  # extrapolated
+    quick_25min = 0x04  # extrapolated
+
+    moderate_30min = 0x05
+
+    moderate_40min = 0x06  # extrapolated
+    moderate_50min = 0x07  # extrapolated
+    moderate_60min = 0x08  # extrapolated
+    moderate_70min = 0x09  # extrapolated
+
+    slow_80min = 0x0A
+
+    quick_open_disabled = 0x11  # not sure what it does; also requires lower 4 bits to be in [1, 10] I assume
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names=CLUSTER_HANDLER_THERMOSTAT,
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossControlAlgorithmScaleFactor(ZCLEnumSelectEntity):
+    """Danfoss proprietary attribute for setting the scale factor of the setpoint filter time constant."""
+
+    _unique_id_suffix = "control_algorithm_scale_factor"
+    _attribute_name = "control_algorithm_scale_factor"
+    _attr_translation_key: str = "setpoint_response_time"
+    _enum = DanfossControlAlgorithmScaleFactorEnum
+
+
+@CONFIG_DIAGNOSTIC_MATCH(
+    cluster_handler_names="thermostat_ui",
+    quirk_ids={DANFOSS_ALLY_THERMOSTAT},
+)
+class DanfossViewingDirection(ZCLEnumSelectEntity):
+    """Danfoss proprietary attribute for setting the viewing direction of the screen."""
+
+    _unique_id_suffix = "viewing_direction"
+    _attribute_name = "viewing_direction"
+    _attr_translation_key: str = "viewing_direction"
+    _enum = danfoss_thermostat.DanfossViewingDirectionEnum