Don't include Off for supportedFanModes for thermostats by default

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

@@ -48,6 +48,7 @@ end
 local SAVED_SYSTEM_MODE_IB = "__saved_system_mode_ib"
 local DISALLOWED_THERMOSTAT_MODES = "__DISALLOWED_CONTROL_OPERATIONS"
 local OPTIONAL_THERMOSTAT_MODES_SEEN = "__OPTIONAL_THERMOSTAT_MODES_SEEN"
+local SEQUENCE_OF_OPERATIONS_PROCESSED = "__SEQUENCE_OF_OPERATIONS_PROCESSED"
 
 if version.api < 11 then
   clusters.ElectricalEnergyMeasurement = require "ElectricalEnergyMeasurement"
@@ -1422,13 +1423,37 @@ local function humidity_attr_handler(driver, device, ib, response)
 end
 
 local function system_mode_handler(driver, device, ib, response)
-  if device:get_field(OPTIONAL_THERMOSTAT_MODES_SEEN) == nil then -- this being nil means the sequence_of_operation_handler hasn't run.
+  if device:get_field(SEQUENCE_OF_OPERATIONS_PROCESSED) == nil then -- this being nil means the sequence_of_operation_handler hasn't run.
     device.log.info_with({hub_logs = true}, "In the SystemMode handler: ControlSequenceOfOperation has not run yet. Exiting early.")
     device:set_field(SAVED_SYSTEM_MODE_IB, ib)
     return
   end
 
-  local supported_modes = device:get_latest_state(device:endpoint_to_component(ib.endpoint_id), capabilities.thermostatMode.ID, capabilities.thermostatMode.supportedThermostatModes.NAME) or {}
+  if device:supports_capability_by_id(capabilities.fanMode.ID) and
+    ib.data.value == clusters.Thermostat.types.ThermostatSystemMode.OFF and
+    get_device_type(device) == THERMOSTAT_DEVICE_TYPE_ID then
+    local supported_fan_modes = device:get_latest_state(
+      device:endpoint_to_component(ib.endpoint_id),
+      capabilities.fanMode.ID,
+      capabilities.fanMode.supportedFanModes.NAME
+    ) or {}
+    if not tbl_contains(supported_fan_modes, "off") then
+      local new_supported_fan_modes = {"off"}
+      for _, fan_mode in ipairs(supported_fan_modes) do
+        table.insert(new_supported_fan_modes, fan_mode)
+      end
+      device:emit_event_for_endpoint(
+        ib.endpoint_id,
+        capabilities.fanMode.supportedFanModes(new_supported_fan_modes, {visibility = {displayed = false}})
+      )
+    end
+  end
+
+  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]())
@@ -1464,11 +1489,14 @@ end
 local function sequence_of_operation_handler(driver, device, ib, response)
   -- The ControlSequenceOfOperation attribute only directly specifies what can't be operated by the operating environment, not what can.
   -- However, we assert here that a Cooling enum value implies that SystemMode supports cooling, and the same for a Heating enum.
-  -- We also assert that Off is supported, though per spec this is optional.
+  -- We also assert that Off is supported for non-thermostat device types, though per spec this is optional.
   if device:get_field(OPTIONAL_THERMOSTAT_MODES_SEEN) == nil then
-    device:set_field(OPTIONAL_THERMOSTAT_MODES_SEEN, {capabilities.thermostatMode.thermostatMode.off.NAME}, {persist=true})
+    if get_device_type(device) ~= THERMOSTAT_DEVICE_TYPE_ID then
+      device:set_field(OPTIONAL_THERMOSTAT_MODES_SEEN, {capabilities.thermostatMode.thermostatMode.off.NAME}, {persist=true})
+    end
+    device:set_field(SEQUENCE_OF_OPERATIONS_PROCESSED, true)
   end
-  local supported_modes = utils.deep_copy(device:get_field(OPTIONAL_THERMOSTAT_MODES_SEEN))
+  local supported_modes = utils.deep_copy(device:get_field(OPTIONAL_THERMOSTAT_MODES_SEEN) or {})
   local disallowed_mode_operations = {}
 
   local modes_for_inclusion = {}
@@ -1576,17 +1604,20 @@ end
 local function fan_mode_sequence_handler(driver, device, ib, response)
   local supportedFanModes, supported_fan_modes_attribute
   if ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_MED_HIGH then
-    supportedFanModes = { "off", "low", "medium", "high" }
+    supportedFanModes = { "low", "medium", "high" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_HIGH then
-    supportedFanModes = { "off", "low", "high" }
+    supportedFanModes = { "low", "high" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_MED_HIGH_AUTO then
-    supportedFanModes = { "off", "low", "medium", "high", "auto" }
+    supportedFanModes = { "low", "medium", "high", "auto" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_LOW_HIGH_AUTO then
-    supportedFanModes = { "off", "low", "high", "auto" }
+    supportedFanModes = { "low", "high", "auto" }
   elseif ib.data.value == clusters.FanControl.attributes.FanModeSequence.OFF_HIGH_AUTO then
-    supportedFanModes = { "off", "high", "auto" }
+    supportedFanModes = { "high", "auto" }
   else
-    supportedFanModes = { "off", "high" }
+    supportedFanModes = { "high" }
+  end
+  if get_device_type(device) ~= THERMOSTAT_DEVICE_TYPE_ID then
+    table.insert(supportedFanModes, 1, "off")
   end
 
   if device:supports_capability_by_id(capabilities.airPurifierFanMode.ID) then

drivers/SmartThings/matter-thermostat/src/test/test_matter_heat_pump.lua

@@ -347,7 +347,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -360,7 +360,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -373,7 +373,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat", "emergency heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat", "emergency heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "capability",
@@ -411,7 +411,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -424,7 +424,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -437,7 +437,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -450,7 +450,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -463,7 +463,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -476,7 +476,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off", "cool"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"cool"}, {visibility={displayed=false}}))
     },
   }
 )
@@ -495,7 +495,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -508,7 +508,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -521,7 +521,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat", "emergency heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat", "emergency heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "capability",
@@ -539,7 +539,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat", "emergency heat"}, {visibility={displayed=false}}))
+      message = mock_device:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat", "emergency heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "capability",
@@ -563,7 +563,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat", "auto"}, {visibility={displayed=false}}))
+      message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat", "auto"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",
@@ -576,13 +576,31 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"off", "cool", "heat", "auto", "emergency heat"}, {visibility={displayed=false}}))
+      message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat", "auto", "emergency heat"}, {visibility={displayed=false}}))
     },
     {
       channel = "capability",
       direction = "send",
       message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.thermostatMode.emergency_heat())
     },
+    {
+      channel = "matter",
+      direction = "receive",
+      message = {
+        mock_device_with_auto.id,
+        clusters.Thermostat.server.attributes.SystemMode:build_test_report_data(mock_device_with_auto, THERMOSTAT_ONE_EP, 0)
+      }
+    },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.supportedThermostatModes({"cool", "heat", "auto", "emergency heat", "off"}, {visibility={displayed=false}}))
+    },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device_with_auto:generate_test_message("thermostatOne", capabilities.thermostatMode.thermostatMode.off())
+    },
     {
       channel = "matter",
       direction = "receive",
@@ -594,7 +612,7 @@ test.register_message_test(
     {
       channel = "capability",
       direction = "send",
-      message = mock_device_with_auto:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"off",  "emergency heat", "cool", "heat", "auto"}, {visibility={displayed=false}}))
+      message = mock_device_with_auto:generate_test_message("thermostatTwo", capabilities.thermostatMode.supportedThermostatModes({"emergency heat", "off", "cool", "heat", "auto"}, {visibility={displayed=false}}))
     },
     {
       channel = "matter",