Separate find_default_endpoint for modular vs static setups

Move the else clause of common-utils/find_default_endpoint into
static/profiles/init.lua rather than having two paths for static vs
modular.

Author: nickolas-deboom

drivers/SmartThings/matter-switch/src/common-utils.lua

@@ -310,7 +310,7 @@ function common_utils.device_type_supports_button_switch_combination(device, end
   return false
 end
 
-local function get_first_non_zero_endpoint(endpoints)
+function common_utils.get_first_non_zero_endpoint(endpoints)
   table.sort(endpoints)
   for _,ep in ipairs(endpoints) do
     if ep ~= 0 then -- 0 is the matter RootNode endpoint
@@ -328,55 +328,18 @@ end
 --- Note that Water Valve is listed first because any additional switch
 --- endpoints would be added as child devices.
 function common_utils.find_default_endpoint(device)
-  if common_utils.supports_modular_profile(device) then
-    local valve_eps = device:get_endpoints(clusters.ValveConfigurationAndControl.ID)
-    if #valve_eps > 0 then
-      return get_first_non_zero_endpoint(valve_eps)
-    end
-
-    local switch_eps = device:get_endpoints(clusters.OnOff.ID)
-    if #switch_eps > 0 then
-      return get_first_non_zero_endpoint(switch_eps)
-    end
-
-    local button_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH})
-    if #button_eps > 0 then
-      return get_first_non_zero_endpoint(button_eps)
-    end
-  else
-    if device.manufacturer_info.vendor_id == common_utils.AQARA_MANUFACTURER_ID and
-      device.manufacturer_info.product_id == common_utils.AQARA_CLIMATE_SENSOR_W100_ID then
-      -- In case of Aqara Climate Sensor W100, in order to sequentially set the button name to button 1, 2, 3
-      return device.MATTER_DEFAULT_ENDPOINT
-    end
-
-    local switch_eps = device:get_endpoints(clusters.OnOff.ID)
-    local button_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH})
-
-    -- Return the first switch endpoint as the default endpoint if no button endpoints are present
-    if #button_eps == 0 and #switch_eps > 0 then
-      return get_first_non_zero_endpoint(switch_eps)
-    end
-
-    -- Return the first button endpoint as the default endpoint if no switch endpoints are present
-    if #switch_eps == 0 and #button_eps > 0 then
-      return get_first_non_zero_endpoint(button_eps)
-    end
-
-    -- If both switch and button endpoints are present, check the device type on the main switch
-    -- endpoint. If it is not a supported device type, return the first button endpoint as the
-    -- default endpoint.
-    if #switch_eps > 0 and #button_eps > 0 then
-      local main_endpoint = get_first_non_zero_endpoint(switch_eps)
-      if common_utils.supports_modular_profile(device) or common_utils.device_type_supports_button_switch_combination(device, main_endpoint) then
-        return get_first_non_zero_endpoint(switch_eps)
-      else
-        device.log.warn("The main switch endpoint does not contain a supported device type for a component configuration with buttons")
-        return get_first_non_zero_endpoint(button_eps)
-      end
-    end
+  local valve_eps = device:get_endpoints(clusters.ValveConfigurationAndControl.ID)
+  if #valve_eps > 0 then
+    return common_utils.get_first_non_zero_endpoint(valve_eps)
+  end
+  local switch_eps = device:get_endpoints(clusters.OnOff.ID)
+  if #switch_eps > 0 then
+    return common_utils.get_first_non_zero_endpoint(switch_eps)
+  end
+  local button_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH})
+  if #button_eps > 0 then
+    return common_utils.get_first_non_zero_endpoint(button_eps)
   end
-
   device.log.warn(string.format("Did not find default endpoint, will use endpoint %d instead", device.MATTER_DEFAULT_ENDPOINT))
   return device.MATTER_DEFAULT_ENDPOINT
 end

drivers/SmartThings/matter-switch/src/static-profiles/init.lua

@@ -23,6 +23,41 @@ local embedded_cluster_utils = require "embedded-cluster-utils"
 --   Used for environments that don't support modular profiles.
 -------------------------------------------------------------------------------------
 
+--- find_default_endpoint helper function to handle situations where the device
+--- does not have endpoint ids in sequential order from 1.
+local function find_default_endpoint(device)
+  if device.manufacturer_info.vendor_id == common_utils.AQARA_MANUFACTURER_ID and
+    device.manufacturer_info.product_id == common_utils.AQARA_CLIMATE_SENSOR_W100_ID then
+    -- In case of Aqara Climate Sensor W100, in order to sequentially set the button name to button 1, 2, 3
+    return device.MATTER_DEFAULT_ENDPOINT
+  end
+  local switch_eps = device:get_endpoints(clusters.OnOff.ID)
+  local button_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH})
+  -- Return the first switch endpoint as the default endpoint if no button endpoints are present
+  if #button_eps == 0 and #switch_eps > 0 then
+    return common_utils.get_first_non_zero_endpoint(switch_eps)
+  end
+  -- Return the first button endpoint as the default endpoint if no switch endpoints are present
+  if #switch_eps == 0 and #button_eps > 0 then
+    return common_utils.get_first_non_zero_endpoint(button_eps)
+  end
+  -- If both switch and button endpoints are present, check the device type on the main switch
+  -- endpoint. If it is not a supported device type, return the first button endpoint as the
+  -- default endpoint.
+  if #switch_eps > 0 and #button_eps > 0 then
+    local main_endpoint = common_utils.get_first_non_zero_endpoint(switch_eps)
+    if common_utils.supports_modular_profile(device) or common_utils.device_type_supports_button_switch_combination(device, main_endpoint) then
+      return common_utils.get_first_non_zero_endpoint(switch_eps)
+    else
+      device.log.warn("The main switch endpoint does not contain a supported device type for a component configuration with buttons")
+      return common_utils.get_first_non_zero_endpoint(button_eps)
+    end
+  end
+
+  device.log.warn(string.format("Did not find default endpoint, will use endpoint %d instead", device.MATTER_DEFAULT_ENDPOINT))
+  return device.MATTER_DEFAULT_ENDPOINT
+end
+
 local function handle_light_switch_with_onOff_server_clusters(device, main_endpoint)
   local cluster_id = 0
   for _, ep in ipairs(device.endpoints) do
@@ -67,7 +102,7 @@ local function initialize_buttons_and_switches(driver, device, main_endpoint)
 end
 
 local function match_profile(driver, device)
-  local main_endpoint = common_utils.find_default_endpoint(device)
+  local main_endpoint = find_default_endpoint(device)
   -- initialize the main device card with buttons if applicable, and create child devices as needed for multi-switch devices.
   local profile_found = initialize_buttons_and_switches(driver, device, main_endpoint)
   if device:get_field(common_utils.IS_PARENT_CHILD_DEVICE) then
@@ -114,7 +149,7 @@ local function device_init(driver, device)
     if device:get_field(common_utils.IS_PARENT_CHILD_DEVICE) then
       device:set_find_child(common_utils.find_child)
     end
-    local main_endpoint = common_utils.find_default_endpoint(device)
+    local main_endpoint = find_default_endpoint(device)
     -- ensure subscription to all endpoint attributes- including those mapped to child devices
     common_utils.add_subscribed_attributes_and_events(device, main_endpoint)
     device:subscribe()