Fix thermostat fan modes to respect fanModeSequence

tests/data/devices/atlantic-group-adapter-zigbee-fujitsu.json

@@ -435,15 +435,18 @@
           "min_temp": 16.0,
           "supported_features": 395,
           "fan_modes": [
-            "auto",
-            "on"
+            "low",
+            "medium",
+            "high",
+            "auto"
           ],
           "preset_modes": [],
           "hvac_modes": [
             "off",
             "heat_cool",
             "cool",
-            "heat"
+            "heat",
+            "fan_only"
           ]
         },
         "state": {
@@ -457,7 +460,7 @@
           "hvac_action": null,
           "hvac_mode": "off",
           "preset_mode": "none",
-          "fan_mode": "auto",
+          "fan_mode": "on",
           "system_mode": "[0]/off",
           "occupancy": null,
           "occupied_cooling_setpoint": 2600,

tests/data/devices/centralite-systems-3156105.json

@@ -496,14 +496,15 @@
           "min_temp": 7.0,
           "supported_features": 393,
           "fan_modes": [
-            "auto",
-            "on"
+            "on",
+            "auto"
           ],
           "preset_modes": [],
           "hvac_modes": [
             "cool",
             "heat",
-            "off"
+            "off",
+            "fan_only"
           ]
         },
         "state": {

tests/data/devices/enktro-acmidea.json

@@ -367,15 +367,18 @@
           "min_temp": 17.0,
           "supported_features": 395,
           "fan_modes": [
-            "auto",
-            "on"
+            "low",
+            "medium",
+            "high",
+            "auto"
           ],
           "preset_modes": [],
           "hvac_modes": [
             "off",
             "heat_cool",
             "cool",
-            "heat"
+            "heat",
+            "fan_only"
           ]
         },
         "state": {

tests/data/devices/zen-within-zen-01.json

@@ -461,15 +461,16 @@
           "min_temp": 4.0,
           "supported_features": 395,
           "fan_modes": [
-            "auto",
-            "on"
+            "on",
+            "auto"
           ],
           "preset_modes": [],
           "hvac_modes": [
             "off",
             "heat_cool",
             "cool",
-            "heat"
+            "heat",
+            "fan_only"
           ]
         },
         "state": {

tests/test_climate.py

@@ -1298,6 +1298,23 @@ async def test_set_fan_mode_not_supported(
     assert fan_cluster.write_attributes.await_count == 0
 
 
+async def test_set_fan_mode_no_zcl_mapping(
+    zha_gateway: Gateway,
+):
+    """Test fan mode with no ZCL mapping is rejected."""
+    device_climate_fan = await device_climate_mock(zha_gateway, CLIMATE_FAN)
+    fan_cluster = device_climate_fan.device.endpoints[1].fan
+    entity: ThermostatEntity = get_entity(
+        device_climate_fan, platform=Platform.CLIMATE, entity_type=ThermostatEntity
+    )
+
+    entity.__dict__["fan_modes"] = ["bogus"]
+
+    await entity.async_set_fan_mode("bogus")
+    await zha_gateway.async_block_till_done()
+    assert fan_cluster.write_attributes.await_count == 0
+
+
 async def test_set_fan_mode(
     zha_gateway: Gateway,
 ):

zha/application/platforms/climate/__init__.py

@@ -11,7 +11,6 @@
 
 from zigpy.profiles import zha
 from zigpy.zcl.clusters.hvac import (
-    FanMode,
     RunningState,
     SystemMode,
     Thermostat as ThermostatCluster,
@@ -35,12 +34,15 @@
     ATTR_UNOCCP_COOL_SETPT,
     ATTR_UNOCCP_HEAT_SETPT,
     FAN_AUTO,
+    FAN_MODE_TO_ZCL,
     FAN_ON,
     HVAC_MODE_2_SYSTEM,
     PRECISION_TENTHS,
+    SEQ_FAN_MODES,
     SEQ_OF_OPERATION,
     SYSTEM_MODE_2_HVAC,
     ZCL_TEMP,
+    ZCL_TO_FAN_MODE,
     ClimateEntityFeature,
     HVACAction,
     HVACMode,
@@ -332,9 +334,12 @@ def outdoor_temperature(self):
     @property
     def fan_mode(self) -> str | None:
         """Return current FAN mode."""
+        if self._fan_cluster_handler is not None:
+            current = self._fan_cluster_handler.fan_mode
+            if current is not None:
+                return ZCL_TO_FAN_MODE.get(current, FAN_AUTO)
         if self._thermostat_cluster_handler.running_state is None:
             return FAN_AUTO
-
         if self._thermostat_cluster_handler.running_state & (
             RunningState.Fan_State_On
             | RunningState.Fan_2nd_Stage_On
@@ -348,7 +353,8 @@ def fan_modes(self) -> list[str] | None:
         """Return supported FAN modes."""
         if not self._fan_cluster_handler:
             return None
-        return [FAN_AUTO, FAN_ON]
+        seq = self._fan_cluster_handler.fan_mode_sequence
+        return SEQ_FAN_MODES.get(seq, [FAN_ON, FAN_AUTO])
 
     @property
     def hvac_action(self) -> HVACAction | None:
@@ -409,9 +415,12 @@ def hvac_mode(self) -> HVACMode | None:
     @property
     def hvac_modes(self) -> list[HVACMode]:
         """Return the list of available HVAC operation modes."""
-        return SEQ_OF_OPERATION.get(
+        modes = SEQ_OF_OPERATION.get(
             self._thermostat_cluster_handler.ctrl_sequence_of_oper, [HVACMode.OFF]
         )
+        if self._fan_cluster_handler is not None and HVACMode.FAN_ONLY not in modes:
+            modes = [*modes, HVACMode.FAN_ONLY]
+        return modes
 
     @property
     def preset_mode(self) -> str:
@@ -538,9 +547,12 @@ async def async_set_fan_mode(self, fan_mode: str) -> None:
             self.warning("Unsupported '%s' fan mode", fan_mode)
             return
 
-        mode = FanMode.On if fan_mode == FAN_ON else FanMode.Auto
+        zcl_mode = FAN_MODE_TO_ZCL.get(fan_mode)
+        if zcl_mode is None:
+            self.warning("No ZCL mapping for fan mode '%s'", fan_mode)
+            return
 
-        await self._fan_cluster_handler.async_set_speed(mode)
+        await self._fan_cluster_handler.async_set_speed(zcl_mode)
 
     async def async_set_hvac_mode(self, hvac_mode: HVACMode) -> None:
         """Set new target operation mode."""

zha/application/platforms/climate/const.py

@@ -3,7 +3,13 @@
 from enum import IntFlag, StrEnum
 from typing import Final
 
-from zigpy.zcl.clusters.hvac import ControlSequenceOfOperation, RunningMode, SystemMode
+from zigpy.zcl.clusters.hvac import (
+    ControlSequenceOfOperation,
+    FanMode,
+    FanModeSequence,
+    RunningMode,
+    SystemMode,
+)
 
 ATTR_SYS_MODE: Final[str] = "system_mode"
 ATTR_FAN_MODE: Final[str] = "fan_mode"
@@ -141,6 +147,24 @@ class HVACAction(StrEnum):
     PREHEATING = "preheating"
 
 
+SEQ_FAN_MODES: dict[int, list[str]] = {
+    FanModeSequence.Low_Med_High: [FAN_LOW, FAN_MEDIUM, FAN_HIGH],
+    FanModeSequence.Low_High: [FAN_LOW, FAN_HIGH],
+    FanModeSequence.Low_Med_High_Auto: [FAN_LOW, FAN_MEDIUM, FAN_HIGH, FAN_AUTO],
+    FanModeSequence.Low_High_Auto: [FAN_LOW, FAN_HIGH, FAN_AUTO],
+    FanModeSequence.On_Auto: [FAN_ON, FAN_AUTO],
+}
+
+FAN_MODE_TO_ZCL: dict[str, FanMode] = {
+    FAN_LOW: FanMode.Low,
+    FAN_MEDIUM: FanMode.Medium,
+    FAN_HIGH: FanMode.High,
+    FAN_ON: FanMode.On,
+    FAN_AUTO: FanMode.Auto,
+}
+
+ZCL_TO_FAN_MODE: dict[int, str] = {v: k for k, v in FAN_MODE_TO_ZCL.items()}
+
 RUNNING_MODE = {
     RunningMode.Off: HVACMode.OFF,
     RunningMode.Cool: HVACMode.COOL,