Don't include Off for supportedFanModes for thermostats by default (#2428)

Off is an optional enum value for SystemMode and setting fanMode to Off
may have no effect if the thermostat mode is set to heating or cooling.
This commit removes this value from supportedFanModes attribute unless
Off is reported by the SystemMode attribute at some point.

Author: nickolas-deboom

drivers/SmartThings/matter-thermostat/src/init.lua

@@ -1392,7 +1392,11 @@ local function system_mode_handler(driver, device, ib, response)
     return
   end
 
-  local supported_modes = device:get_latest_state(device:endpoint_to_component(ib.endpoint_id), capabilities.thermostatMode.ID, capabilities.thermostatMode.supportedThermostatModes.NAME) or {}
+  local supported_modes = device:get_latest_state(
+    device:endpoint_to_component(ib.endpoint_id),
+    capabilities.thermostatMode.ID,
+    capabilities.thermostatMode.supportedThermostatModes.NAME
+  ) or {}
   -- check that the given mode was in the supported modes list
   if tbl_contains(supported_modes, THERMOSTAT_MODE_MAP[ib.data.value].NAME) then
     device:emit_event_for_endpoint(ib.endpoint_id, THERMOSTAT_MODE_MAP[ib.data.value]())
@@ -1538,39 +1542,59 @@ local function fan_mode_handler(driver, device, ib, response)
 end
 
 local function fan_mode_sequence_handler(driver, device, ib, response)
-  local supportedFanModes, supported_fan_modes_attribute
+  local supported_fan_modes, supported_fan_modes_capability, supported_fan_modes_attribute
   if ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_MED_HIGH then
-    supportedFanModes = { "off", "low", "medium", "high" }
+    supported_fan_modes = { "off", "low", "medium", "high" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_HIGH then
-    supportedFanModes = { "off", "low", "high" }
+    supported_fan_modes = { "off", "low", "high" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_MED_HIGH_AUTO then
-    supportedFanModes = { "off", "low", "medium", "high", "auto" }
+    supported_fan_modes = { "off", "low", "medium", "high", "auto" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_HIGH_AUTO then
-    supportedFanModes = { "off", "low", "high", "auto" }
+    supported_fan_modes = { "off", "low", "high", "auto" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_HIGH_AUTO then
-    supportedFanModes = { "off", "high", "auto" }
+    supported_fan_modes = { "off", "high", "auto" }
   else
-    supportedFanModes = { "off", "high" }
+    supported_fan_modes = { "off", "high" }
   end
 
   if device:supports_capability_by_id(capabilities.airPurifierFanMode.ID) then
-    supported_fan_modes_attribute = capabilities.airPurifierFanMode.supportedAirPurifierFanModes
+    supported_fan_modes_capability = capabilities.airPurifierFanMode
+    supported_fan_modes_attribute = supported_fan_modes_capability.supportedAirPurifierFanModes
   elseif device:supports_capability_by_id(capabilities.airConditionerFanMode.ID) then
-    supported_fan_modes_attribute = capabilities.airConditionerFanMode.supportedAcFanModes
+    supported_fan_modes_capability = capabilities.airConditionerFanMode
+    supported_fan_modes_attribute = supported_fan_modes_capability.supportedAcFanModes
   elseif device:supports_capability_by_id(capabilities.thermostatFanMode.ID) then
+    supported_fan_modes_capability = capabilities.thermostatFanMode
     supported_fan_modes_attribute = capabilities.thermostatFanMode.supportedThermostatFanModes
     -- Our thermostat fan mode control is not granular enough to handle all of the supported modes
     if ib.data.value >= clusters.FanControl.attributes.FanModeSequence.OFF_LOW_MED_HIGH_AUTO and
       ib.data.value <= clusters.FanControl.attributes.FanModeSequence.OFF_ON_AUTO then
-      supportedFanModes = { "auto", "on" }
+      supported_fan_modes = { "auto", "on" }
     else
-      supportedFanModes = { "on" }
+      supported_fan_modes = { "on" }
     end
   else
-    supported_fan_modes_attribute = capabilities.fanMode.supportedFanModes
+    supported_fan_modes_capability = capabilities.fanMode
+    supported_fan_modes_attribute = supported_fan_modes_capability.supportedFanModes
+  end
+
+  -- remove 'off' as a supported fan mode for thermostat device types, unless the
+  -- device previously had 'off' as a supported fan mode to avoid breaking routines
+  if get_device_type(device) == THERMOSTAT_DEVICE_TYPE_ID then
+    local prev_supported_fan_modes = device:get_latest_state(
+      device:endpoint_to_component(ib.endpoint_id),
+      supported_fan_modes_capability.ID,
+      supported_fan_modes_attribute.NAME
+    ) or {}
+    if not tbl_contains(prev_supported_fan_modes, "off") then
+      local _, off_idx = tbl_contains(supported_fan_modes, "off")
+      if off_idx then
+        table.remove(supported_fan_modes, off_idx)
+      end
+    end
   end
 
-  local event = supported_fan_modes_attribute(supportedFanModes, {visibility = {displayed = false}})
+  local event = supported_fan_modes_attribute(supported_fan_modes, {visibility = {displayed = false}})
   device:emit_event_for_endpoint(ib.endpoint_id, event)
 end