re-profile device if a matter_version update occurs

Author: hcarter-775

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

@@ -66,11 +66,16 @@ end
 function SwitchLifecycleHandlers.info_changed(driver, device, event, args)
   if device.profile.id ~= args.old_st_store.profile.id then
     device:subscribe()
-    local button_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH})
-    if #button_eps > 0 and device.network_type == device_lib.NETWORK_TYPE_MATTER then
+    if device.network_type == device_lib.NETWORK_TYPE_MATTER then
       button_cfg.configure_buttons(device)
     end
   end
+
+  if device.matter_version.software ~= args.old_st_store.matter_version.software then
+    if device.network_type == device_lib.NETWORK_TYPE_MATTER and not switch_utils.detect_bridge(device) then
+      device_cfg.match_profile(driver, device)
+    end
+  end
 end
 
 function SwitchLifecycleHandlers.device_removed(driver, device)

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

@@ -25,6 +25,7 @@ local button_attr = capabilities.button.button
 local aqara_mock_device = test.mock_device.build_test_matter_device({
   profile = t_utils.get_profile_definition("3-button-battery-temperature-humidity.yml"),
   manufacturer_info = {vendor_id = 0x115F, product_id = 0x2004, product_name = "Aqara Climate Sensor W100"},
+  matter_version = {hardware = 1, software = 1},
   label = "Climate Sensor W100",
   device_id = "00000000-1111-2222-3333-000000000001",
   endpoints = {

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

@@ -27,6 +27,7 @@ local aqara_child2_ep = 2
 local aqara_mock_device = test.mock_device.build_test_matter_device({
   profile = t_utils.get_profile_definition("4-button.yml"),
   manufacturer_info = {vendor_id = 0x115F, product_id = 0x1009, product_name = "Aqara Light Switch H2"},
+  matter_version = {hardware = 1, software = 1},
   label = "Aqara Light Switch",
   device_id = "00000000-1111-2222-3333-000000000001",
   endpoints = {

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

@@ -12,6 +12,7 @@ local uint32 = require "st.matter.data_types.Uint32"
 local mock_device = test.mock_device.build_test_matter_device({
   profile = t_utils.get_profile_definition("button-battery.yml"),
   manufacturer_info = {vendor_id = 0x0000, product_id = 0x0000},
+  matter_version = {hardware = 1, software = 1},
   endpoints = {
     {
       endpoint_id = 0,

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

@@ -8,11 +8,11 @@ local clusters = require "st.matter.generated.zap_clusters"
 local button_attr = capabilities.button.button
 
 -- Mock a 5-button device using endpoints non-consecutive endpoints
-local mock_device = test.mock_device.build_test_matter_device(
-  {
-    profile = t_utils.get_profile_definition("5-button-battery.yml"), -- on a real device we would switch to this, rather than fingerprint to it
-    manufacturer_info = {vendor_id = 0x0000, product_id = 0x0000},
-    endpoints = {
+local mock_device = test.mock_device.build_test_matter_device({
+  profile = t_utils.get_profile_definition("5-button-battery.yml"), -- on a real device we would switch to this, rather than fingerprint to it
+  manufacturer_info = {vendor_id = 0x0000, product_id = 0x0000},
+  matter_version = {hardware = 1, software = 1},
+  endpoints = {
     {
       endpoint_id = 0,
       clusters = {},
@@ -87,8 +87,7 @@ local mock_device = test.mock_device.build_test_matter_device(
       }
     },
   },
-}
-)
+})
 
 -- add device for each mock device
 local CLUSTER_SUBSCRIBE_LIST ={

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

@@ -25,6 +25,7 @@ local mock_device = test.mock_device.build_test_matter_device({
     vendor_id = 0x0000,
     product_id = 0x0000,
   },
+  matter_version = {hardware = 1, software = 1},
   endpoints = {
     {
       endpoint_id = 0,
@@ -105,6 +106,7 @@ local mock_device_mcd_unsupported_switch_device_type = test.mock_device.build_te
     vendor_id = 0x0000,
     product_id = 0x0000,
   },
+  matter_version = {hardware = 1, software = 1},
   endpoints = {
     {
       endpoint_id = 0,
@@ -192,49 +194,35 @@ local function expect_configure_buttons()
   test.socket.capability:__expect_send(mock_device:generate_test_message("button3", button_attr.pushed({state_change = false})))
 end
 
--- All messages queued and expectations set are done before the driver is actually run
 local function test_init()
-  -- we dont want the integration test framework to generate init/doConfigure, we are doing that here
-  -- so we can set the proper expectations on those events.
   test.disable_startup_messages()
   test.mock_device.add_test_device(mock_device) -- make sure the cache is populated
   test.mock_device.add_test_device(mock_child)
 
-  -- added sets a bunch of fields on the device, and calls 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, "added" })
 
-  -- init results in subscription interaction
   test.socket.matter:__expect_send({mock_device.id, subscribe_request})
   test.socket.device_lifecycle:__queue_receive({ mock_device.id, "init" })
 
-  --doConfigure sets the provisioning state to provisioned
-  mock_device:expect_metadata_update({ profile = "light-level-3-button" })
-  mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "doConfigure" })
   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)
   })
+  mock_device:expect_metadata_update({ profile = "light-level-3-button" })
   expect_configure_buttons()
-  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "doConfigure" })
-
-  -- simulate the profile change update taking affect and the device info changing
-  local device_info_copy = utils.deep_copy(mock_device.raw_st_data)
-  device_info_copy.profile.id = "5-buttons-battery"
-  local device_info_json = dkjson.encode(device_info_copy)
-  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "infoChanged", device_info_json })
-  test.socket.matter:__expect_send({mock_device.id, subscribe_request})
-  expect_configure_buttons()
+  mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
 
-  test.socket.matter:__expect_send({mock_device.id, clusters.OnOff.attributes.OnOff:read(mock_device)})
   test.socket.device_lifecycle:__queue_receive({ mock_child.id, "added" })
+  test.socket.matter:__expect_send({mock_device.id, clusters.OnOff.attributes.OnOff:read(mock_device)})
   test.socket.device_lifecycle:__queue_receive({ mock_child.id, "init" })
   mock_child:expect_metadata_update({ provisioning_state = "PROVISIONED" })
   test.socket.device_lifecycle:__queue_receive({ mock_child.id, "doConfigure" })
@@ -452,18 +440,48 @@ 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
 )
 
+test.register_coroutine_test(
+  "Test info changed event with parent device profile update",
+  function()
+  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
+  local updated_device_profile = t_utils.get_profile_definition("light-level-3-button.yml")
+  updated_device_profile.id = "updated device profile id"
+  test.socket.device_lifecycle:__queue_receive(mock_device:generate_info_changed({ profile = updated_device_profile }))
+  test.socket.matter:__expect_send({mock_device.id, subscribe_request})
+  expect_configure_buttons()
+  end
+)
+
+test.register_coroutine_test(
+  "Test info changed event with matter_version update",
+  function()
+  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.device_lifecycle:__queue_receive(mock_device:generate_info_changed({ matter_version = { hardware = 1, software = 2 } })) -- bump to 2
+  mock_child:expect_metadata_update({ profile = "light-color-level" })
+  mock_device:expect_metadata_update({ profile = "light-level-3-button" })
+  expect_configure_buttons()
+  end
+)
+
+
 -- run the tests
 test.run_registered_tests()

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

@@ -24,6 +24,10 @@ local mock_device_onoff = test.mock_device.build_test_matter_device({
     vendor_id = 0x0000,
     product_id = 0x0000,
   },
+  matter_version = {
+    hardware = 1,
+    software = 1,
+  },
   endpoints = {
     {
       endpoint_id = 0,

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

@@ -34,6 +34,10 @@ local mock_device = test.mock_device.build_test_matter_device({
     vendor_id = 0x0000,
     product_id = 0x0000,
   },
+  matter_version = {
+    hardware = 1,
+    software = 1,
+  },
   endpoints = {
     {
       endpoint_id = 0,
@@ -689,4 +693,14 @@ test.register_coroutine_test(
   { test_init = test_init_parent_child_endpoints_non_sequential }
 )
 
+test.register_coroutine_test(
+  "Test info changed event with matter_version update",
+  function()
+    test.socket.device_lifecycle:__queue_receive(mock_device:generate_info_changed({ matter_version = { hardware = 1, software = 2 } })) -- bump to 2
+    mock_children[child1_ep]:expect_metadata_update({ profile = "light-level" })
+    mock_children[child2_ep]:expect_metadata_update({ profile = "light-color-level" })
+    mock_device:expect_metadata_update({ profile = "light-binary" })
+  end
+)
+
 test.run_registered_tests()

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

@@ -62,8 +62,8 @@ function SwitchDeviceConfiguration.assign_profile_for_onoff_ep(device, onoff_ep_
   return profile
 end
 
-function SwitchDeviceConfiguration.create_child_devices(driver, device, server_onoff_ep_ids, main_endpoint_id)
-  if #server_onoff_ep_ids == 1 and server_onoff_ep_ids[1] == main_endpoint_id then -- no children will be created
+function SwitchDeviceConfiguration.create_or_update_child_devices(driver, device, server_onoff_ep_ids, main_endpoint_id)
+  if #server_onoff_ep_ids == 1 and server_onoff_ep_ids[1] == main_endpoint_id then -- no children will exist
    return
   end
 
@@ -72,18 +72,23 @@ function SwitchDeviceConfiguration.create_child_devices(driver, device, server_o
   for idx, ep_id in ipairs(server_onoff_ep_ids) do
     device_num = device_num + 1
     if ep_id ~= main_endpoint_id then -- don't create a child device that maps to the main endpoint
-      local name = string.format("%s %d", device.label, device_num)
+      local child_device_name = string.format("%s %d", device.label, device_num)
       local child_profile = SwitchDeviceConfiguration.assign_profile_for_onoff_ep(device, ep_id, true)
-      driver:try_create_device(
-        {
+      local existing_child_device = device:get_field(fields.IS_PARENT_CHILD_DEVICE) and switch_utils.find_child(device, ep_id)
+      if not existing_child_device then
+        driver:try_create_device({
           type = "EDGE_CHILD",
-          label = name,
+          label = child_device_name,
           profile = child_profile,
           parent_device_id = device.id,
           parent_assigned_child_key = string.format("%d", ep_id),
-          vendor_provided_label = name
-        }
-      )
+          vendor_provided_label = child_device_name
+        })
+      else
+        existing_child_device:try_update_metadata({
+          profile = child_profile
+        })
+      end
       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_id, {persist = true})
@@ -133,7 +138,7 @@ function ButtonDeviceConfiguration.configure_buttons(device)
   local msl_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH_LONG_PRESS})
   local msm_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH_MULTI_PRESS})
 
-  for _, ep in ipairs(ms_eps) do
+  for _, ep in ipairs(ms_eps or {}) do
     if device.profile.components[switch_utils.endpoint_to_component(device, ep)] then
       device.log.info_with({hub_logs=true}, string.format("Configuring Supported Values for generic switch endpoint %d", ep))
       local supportedButtonValues_event
@@ -180,7 +185,7 @@ function DeviceConfiguration.match_profile(driver, device)
 
   local server_onoff_ep_ids = device:get_endpoints(clusters.OnOff.ID, { cluster_type = "SERVER" })
   if #server_onoff_ep_ids > 0 then
-    SwitchDeviceConfiguration.create_child_devices(driver, device, server_onoff_ep_ids, main_endpoint_id)
+    SwitchDeviceConfiguration.create_or_update_child_devices(driver, device, server_onoff_ep_ids, main_endpoint_id)
     updated_profile = SwitchDeviceConfiguration.assign_profile_for_onoff_ep(device, main_endpoint_id)
     local find_substr = function(s, p) return string.find(s or "", p, 1, true) end
 

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

@@ -221,12 +221,11 @@ 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
+  -- every profile except for matter-thing supports at least 2 capabilities (refresh, firmwareUpdate)
+  for i, _ in pairs(device.profile.components.main.capabilities) do
+    if i > 1 then return false end
   end
-  return device:supports_capability(capabilities.refresh)
+  return true
 end
 
 function utils.report_power_consumption_to_st_energy(device, latest_total_imported_energy_wh)