allow child devices to be re-profiled, clean up device profile names

Author: hcarter-775

drivers/SmartThings/matter-switch/src/test/test_matter_multi_button_switch_mcd.lua

@@ -460,16 +460,16 @@ test.register_coroutine_test(
 test.register_coroutine_test(
   "Test driver switched event",
   function()
+    test.socket.device_lifecycle:__queue_receive({ mock_device.id, "init" })
+    local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(mock_device)
+    for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST) do
+      if i > 1 then subscribe_request:merge(clus:subscribe(mock_device)) end
+    end
+    test.socket.matter:__expect_send({mock_device.id, subscribe_request})
     test.socket.device_lifecycle:__queue_receive({ mock_device.id, "driverSwitched" })
+    mock_child:expect_metadata_update({ profile = "light-color-level" })
     mock_device:expect_metadata_update({ profile = "light-level-3-button" })
     expect_configure_buttons()
-    mock_device:expect_device_create({
-      type = "EDGE_CHILD",
-      label = "Matter Switch 2",
-      profile = "light-color-level",
-      parent_device_id = mock_device.id,
-      parent_assigned_child_key = string.format("%d", mock_device_ep5)
-    })
   end
 )
 

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

@@ -70,17 +70,23 @@ function SwitchDeviceConfiguration.assign_child_profile(device, child_ep)
   return profile or "switch-binary"
 end
 
-function SwitchDeviceConfiguration.create_child_switch_devices(driver, device, main_endpoint)
-  local num_switch_server_eps = 0
+function SwitchDeviceConfiguration.create_child_switch_devices(driver, device, switch_eps, main_endpoint)
+  local switch_server_ep = 0
   local parent_child_device = false
-  local switch_eps = device:get_endpoints(clusters.OnOff.ID)
+
   table.sort(switch_eps)
   for idx, ep in ipairs(switch_eps) do
-    if device:supports_server_cluster(clusters.OnOff.ID, ep) then
-      num_switch_server_eps = num_switch_server_eps + 1
-      if ep ~= main_endpoint then -- don't create a child device that maps to the main endpoint
-        local name = string.format("%s %d", device.label, num_switch_server_eps)
-        local child_profile = SwitchDeviceConfiguration.assign_child_profile(device, ep)
+    switch_server_ep = switch_server_ep + 1
+    if ep ~= main_endpoint then -- don't create a child device that maps to the main endpoint
+      local name = string.format("%s %d", device.label, switch_server_ep)
+      local child_profile = SwitchDeviceConfiguration.assign_child_profile(device, ep)
+      local child_device = nil
+      if device:get_field(fields.IS_PARENT_CHILD_DEVICE) then
+        child_device = switch_utils.find_child(device, ep)
+      end
+      if child_device then
+        child_device:try_update_metadata({profile = child_profile })
+      else
         driver:try_create_device(
           {
             type = "EDGE_CHILD",
@@ -91,11 +97,11 @@ function SwitchDeviceConfiguration.create_child_switch_devices(driver, device, m
             vendor_provided_label = name
           }
         )
-        parent_child_device = true
-        if idx == 1 and string.find(child_profile, "energy") then
-          -- when energy management is defined in the root endpoint(0), replace it with the first switch endpoint and process it.
-          device:set_field(fields.ENERGY_MANAGEMENT_ENDPOINT, ep, {persist = true})
-        end
+      end
+      parent_child_device = true
+      if idx == 1 and string.find(child_profile, "energy") then
+        -- when energy management is defined in the root endpoint(0), replace it with the first switch endpoint and process it.
+        device:set_field(fields.ENERGY_MANAGEMENT_ENDPOINT, ep, {persist = true})
       end
     end
   end
@@ -105,29 +111,22 @@ function SwitchDeviceConfiguration.create_child_switch_devices(driver, device, m
     device:set_field(fields.IS_PARENT_CHILD_DEVICE, true, {persist = true})
     device:set_find_child(switch_utils.find_child)
   end
-
-  -- this is needed in initialize_buttons_and_switches
-  return num_switch_server_eps
 end
 
-function SwitchDeviceConfiguration.update_devices_with_onOff_server_clusters(device, main_endpoint)
+function SwitchDeviceConfiguration.match_light_switch_device_profile(device, main_endpoint)
   local cluster_id = 0
   for _, ep in ipairs(device.endpoints) do
     -- main_endpoint only supports server cluster by definition of get_endpoints()
     if main_endpoint == ep.endpoint_id then
       for _, dt in ipairs(ep.device_types) do
         -- no device type that is not in the switch subset should be considered.
-        if (fields.ON_OFF_SWITCH_ID <= dt.device_type_id and dt.device_type_id <= fields.ON_OFF_COLOR_DIMMER_SWITCH_ID) then
+        if (fields.ON_OFF_LIGHT_SWITCH_ID <= dt.device_type_id and dt.device_type_id <= fields.COLOR_DIMMER_SWITCH_ID) then
           cluster_id = math.max(cluster_id, dt.device_type_id)
         end
       end
-      break
+      return fields.device_type_profile_map[cluster_id]
     end
   end
-
-  if fields.device_type_profile_map[cluster_id] then
-    device:try_update_metadata({profile = fields.device_type_profile_map[cluster_id]})
-  end
 end
 
 function ButtonDeviceConfiguration.update_button_profile(device, main_endpoint, num_button_eps)
@@ -201,32 +200,25 @@ end
 
 function DeviceConfiguration.match_profile(driver, device)
   local main_endpoint = switch_utils.find_default_endpoint(device)
+  local profile_name = nil
+
+  local server_onoff_eps = device:get_endpoints(clusters.OnOff.ID, { cluster_type = "SERVER" })
+  if #server_onoff_eps > 0 then
+    SwitchDeviceConfiguration.create_child_switch_devices(driver, device, server_onoff_eps, main_endpoint)
+    -- workaround: finds a profile for devices of the Light Switch device type set that break spec and implement OnOff as 'server' instead of 'client'.
+    -- note: since the Light Switch device set isn't supported, these devices join as a matter-thing.
+    if switch_utils.detect_matter_thing(device) then
+      profile_name = SwitchDeviceConfiguration.match_light_switch_device_profile(device, main_endpoint)
+    end
+  end
 
   -- initialize the main device card with buttons if applicable
-  local profile_found = false
   local button_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH})
   if switch_utils.tbl_contains(fields.STATIC_BUTTON_PROFILE_SUPPORTED, #button_eps) then
     ButtonDeviceConfiguration.update_button_profile(device, main_endpoint, #button_eps)
     -- All button endpoints found will be added as additional components in the profile containing the main_endpoint.
-    -- The resulting endpoint to component map is saved in the COMPONENT_TO_ENDPOINT_MAP field
     ButtonDeviceConfiguration.update_button_component_map(device, main_endpoint, button_eps)
     ButtonDeviceConfiguration.configure_buttons(device)
-    profile_found = true
-  end
-
-  -- Without support for bindings, only clusters that are implemented as server are counted. This count is handled
-  -- while building switch child profiles
-  local num_switch_server_eps = SwitchDeviceConfiguration.create_child_switch_devices(driver, device, main_endpoint)
-
-  -- We do not support the Light Switch device types because they require OnOff to be implemented as 'client', which requires us to support bindings.
-  -- However, this workaround profiles devices that claim to be Light Switches, but that break spec and implement OnOff as 'server'.
-  -- Note: since their device type isn't supported, these devices join as a matter-thing.
-  if num_switch_server_eps > 0 and switch_utils.detect_matter_thing(device) then
-    SwitchDeviceConfiguration.update_devices_with_onOff_server_clusters(device, main_endpoint)
-    profile_found = true
-  end
-
-  if profile_found then
     return
   end
 
@@ -235,7 +227,6 @@ function DeviceConfiguration.match_profile(driver, device)
   local energy_eps = embedded_cluster_utils.get_endpoints(device, clusters.ElectricalEnergyMeasurement.ID)
   local power_eps = embedded_cluster_utils.get_endpoints(device, clusters.ElectricalPowerMeasurement.ID)
   local valve_eps = embedded_cluster_utils.get_endpoints(device, clusters.ValveConfigurationAndControl.ID)
-  local profile_name = nil
   local level_support = ""
   if #level_eps > 0 then
     level_support = "-level"

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

@@ -47,31 +47,31 @@ SwitchFields.CURRENT_HUESAT_ATTR_MAX = 254
 
 
 -- DEVICE TYPES
-SwitchFields.AGGREGATOR_DEVICE_TYPE_ID = 0x000E
-SwitchFields.ON_OFF_LIGHT_DEVICE_TYPE_ID = 0x0100
-SwitchFields.DIMMABLE_LIGHT_DEVICE_TYPE_ID = 0x0101
-SwitchFields.COLOR_TEMP_LIGHT_DEVICE_TYPE_ID = 0x010C
-SwitchFields.EXTENDED_COLOR_LIGHT_DEVICE_TYPE_ID = 0x010D
-SwitchFields.ON_OFF_PLUG_DEVICE_TYPE_ID = 0x010A
-SwitchFields.DIMMABLE_PLUG_DEVICE_TYPE_ID = 0x010B
-SwitchFields.ON_OFF_SWITCH_ID = 0x0103
-SwitchFields.ON_OFF_DIMMER_SWITCH_ID = 0x0104
-SwitchFields.ON_OFF_COLOR_DIMMER_SWITCH_ID = 0x0105
+SwitchFields.AGGREGATOR_ID = 0x000E
+SwitchFields.ON_OFF_LIGHT_ID = 0x0100
+SwitchFields.DIMMABLE_LIGHT_ID = 0x0101
+SwitchFields.COLOR_TEMPERATURE_LIGHT_ID = 0x010C
+SwitchFields.EXTENDED_COLOR_LIGHT_ID = 0x010D
+SwitchFields.ON_OFF_PLUG_IN_UNIT_ID = 0x010A
+SwitchFields.DIMMABLE_PLUG_IN_UNIT_ID = 0x010B
 SwitchFields.MOUNTED_ON_OFF_CONTROL_ID = 0x010F
 SwitchFields.MOUNTED_DIMMABLE_LOAD_CONTROL_ID = 0x0110
+SwitchFields.ON_OFF_LIGHT_SWITCH_ID = 0x0103
+SwitchFields.DIMMER_SWITCH_ID = 0x0104
+SwitchFields.COLOR_DIMMER_SWITCH_ID = 0x0105
 SwitchFields.GENERIC_SWITCH_ID = 0x000F
 SwitchFields.ELECTRICAL_SENSOR_ID = 0x0510
 
 SwitchFields.device_type_profile_map = {
-  [SwitchFields.ON_OFF_LIGHT_DEVICE_TYPE_ID] = "light-binary",
-  [SwitchFields.DIMMABLE_LIGHT_DEVICE_TYPE_ID] = "light-level",
-  [SwitchFields.COLOR_TEMP_LIGHT_DEVICE_TYPE_ID] = "light-level-colorTemperature",
-  [SwitchFields.EXTENDED_COLOR_LIGHT_DEVICE_TYPE_ID] = "light-color-level",
-  [SwitchFields.ON_OFF_PLUG_DEVICE_TYPE_ID] = "plug-binary",
-  [SwitchFields.DIMMABLE_PLUG_DEVICE_TYPE_ID] = "plug-level",
-  [SwitchFields.ON_OFF_SWITCH_ID] = "switch-binary",
-  [SwitchFields.ON_OFF_DIMMER_SWITCH_ID] = "switch-level",
-  [SwitchFields.ON_OFF_COLOR_DIMMER_SWITCH_ID] = "switch-color-level",
+  [SwitchFields.ON_OFF_LIGHT_ID] = "light-binary",
+  [SwitchFields.DIMMABLE_LIGHT_ID] = "light-level",
+  [SwitchFields.COLOR_TEMPERATURE_LIGHT_ID] = "light-level-colorTemperature",
+  [SwitchFields.EXTENDED_COLOR_LIGHT_ID] = "light-color-level",
+  [SwitchFields.ON_OFF_PLUG_IN_UNIT_ID] = "plug-binary",
+  [SwitchFields.DIMMABLE_PLUG_IN_UNIT_ID] = "plug-level",
+  [SwitchFields.ON_OFF_LIGHT_SWITCH_ID] = "switch-binary",
+  [SwitchFields.DIMMER_SWITCH_ID] = "switch-level",
+  [SwitchFields.COLOR_DIMMER_SWITCH_ID] = "switch-color-level",
   [SwitchFields.MOUNTED_ON_OFF_CONTROL_ID] = "switch-binary",
   [SwitchFields.MOUNTED_DIMMABLE_LOAD_CONTROL_ID] = "switch-level",
 }
@@ -182,16 +182,16 @@ SwitchFields.supported_capabilities = {
 }
 
 SwitchFields.device_type_attribute_map = {
-  [SwitchFields.ON_OFF_LIGHT_DEVICE_TYPE_ID] = {
+  [SwitchFields.ON_OFF_LIGHT_ID] = {
     clusters.OnOff.attributes.OnOff
   },
-  [SwitchFields.DIMMABLE_LIGHT_DEVICE_TYPE_ID] = {
+  [SwitchFields.DIMMABLE_LIGHT_ID] = {
     clusters.OnOff.attributes.OnOff,
     clusters.LevelControl.attributes.CurrentLevel,
     clusters.LevelControl.attributes.MaxLevel,
     clusters.LevelControl.attributes.MinLevel
   },
-  [SwitchFields.COLOR_TEMP_LIGHT_DEVICE_TYPE_ID] = {
+  [SwitchFields.COLOR_TEMPERATURE_LIGHT_ID] = {
     clusters.OnOff.attributes.OnOff,
     clusters.LevelControl.attributes.CurrentLevel,
     clusters.LevelControl.attributes.MaxLevel,
@@ -200,7 +200,7 @@ SwitchFields.device_type_attribute_map = {
     clusters.ColorControl.attributes.ColorTempPhysicalMaxMireds,
     clusters.ColorControl.attributes.ColorTempPhysicalMinMireds
   },
-  [SwitchFields.EXTENDED_COLOR_LIGHT_DEVICE_TYPE_ID] = {
+  [SwitchFields.EXTENDED_COLOR_LIGHT_ID] = {
     clusters.OnOff.attributes.OnOff,
     clusters.LevelControl.attributes.CurrentLevel,
     clusters.LevelControl.attributes.MaxLevel,
@@ -213,25 +213,25 @@ SwitchFields.device_type_attribute_map = {
     clusters.ColorControl.attributes.CurrentX,
     clusters.ColorControl.attributes.CurrentY
   },
-  [SwitchFields.ON_OFF_PLUG_DEVICE_TYPE_ID] = {
+  [SwitchFields.ON_OFF_PLUG_IN_UNIT_ID] = {
     clusters.OnOff.attributes.OnOff
   },
-  [SwitchFields.DIMMABLE_PLUG_DEVICE_TYPE_ID] = {
+  [SwitchFields.DIMMABLE_PLUG_IN_UNIT_ID] = {
     clusters.OnOff.attributes.OnOff,
     clusters.LevelControl.attributes.CurrentLevel,
     clusters.LevelControl.attributes.MaxLevel,
     clusters.LevelControl.attributes.MinLevel
   },
-  [SwitchFields.ON_OFF_SWITCH_ID] = {
+  [SwitchFields.ON_OFF_LIGHT_SWITCH_ID] = {
     clusters.OnOff.attributes.OnOff
   },
-  [SwitchFields.ON_OFF_DIMMER_SWITCH_ID] = {
+  [SwitchFields.DIMMER_SWITCH_ID] = {
     clusters.OnOff.attributes.OnOff,
     clusters.LevelControl.attributes.CurrentLevel,
     clusters.LevelControl.attributes.MaxLevel,
     clusters.LevelControl.attributes.MinLevel
   },
-  [SwitchFields.ON_OFF_COLOR_DIMMER_SWITCH_ID] = {
+  [SwitchFields.COLOR_DIMMER_SWITCH_ID] = {
     clusters.OnOff.attributes.OnOff,
     clusters.LevelControl.attributes.CurrentLevel,
     clusters.LevelControl.attributes.MaxLevel,

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

@@ -81,7 +81,7 @@ function utils.device_type_supports_button_switch_combination(device, endpoint_i
   for _, ep in ipairs(device.endpoints) do
     if ep.endpoint_id == endpoint_id then
       for _, dt in ipairs(ep.device_types) do
-        if dt.device_type_id == fields.DIMMABLE_LIGHT_DEVICE_TYPE_ID then
+        if dt.device_type_id == fields.DIMMABLE_LIGHT_ID then
           for _, fingerprint in ipairs(fields.child_device_profile_overrides_per_vendor_id[0x115F]) do
             if device.manufacturer_info.product_id == fingerprint.product_id then
               return false -- For Aqara Dimmer Switch with Button.
@@ -185,7 +185,7 @@ end
 function utils.detect_bridge(device)
   for _, ep in ipairs(device.endpoints) do
     for _, dt in ipairs(ep.device_types) do
-      if dt.device_type_id == fields.AGGREGATOR_DEVICE_TYPE_ID then
+      if dt.device_type_id == fields.AGGREGATOR_ID then
         return true
       end
     end
@@ -194,12 +194,8 @@ function utils.detect_bridge(device)
 end
 
 function utils.detect_matter_thing(device)
-  for _, capability in ipairs(fields.supported_capabilities) do
-    if device:supports_capability(capability) then
-      return false
-    end
-  end
-  return device:supports_capability(capabilities.refresh)
+  -- every profile except for matter-thing supports at least 2 capabilities (refresh, firmwareUpdate)
+  return #device.profile.components.main.capabilities == 1
 end
 
 function utils.report_power_consumption_to_st_energy(device, latest_total_imported_energy_wh)