Update lifecycle events for Eve and Aqara subdrivers

With the changes from
#2041,
the matter-switch subdrivers should be updated to maintain consistency.
This involves:
* Moving the initialization code from device_init into do_configure
* Implement the driverSwitched lifecycle event
* Additionally, improve the lifecycle event testing for the Aqara
  subdriver, removing the `TEST_CONFIGURE` field and instead leveraging a
  technique used in other test files to set `device.profile.id` for a mock
  device.

Author: nickolas-deboom

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

@@ -20,14 +20,13 @@ local log = require "log"
 local cubeAction = capabilities["stse.cubeAction"]
 local cubeFace = capabilities["stse.cubeFace"]
 
-local COMPONENT_TO_ENDPOINT_MAP_BUTTON = "__component_to_endpoint_map_button"
-local DEFERRED_CONFIGURE = "__DEFERRED_CONFIGURE"
-
--- used in unit testing, since device.profile.id and args.old_st_store.profile.id are always the same
--- and this is to avoid the crash of the test case that occurs when try_update_metadata is performed in the device_init stage.
-local TEST_CONFIGURE = "__test_configure"
+local COMPONENT_TO_ENDPOINT_MAP = "__component_to_endpoint_map"
 local INITIAL_PRESS_ONLY = "__initial_press_only" -- for devices that support MS (MomentarySwitch), but not MSR (MomentarySwitchRelease)
 
+local updated_fields = {
+  { current_field_name = "__component_to_endpoint_map_button", updated_field_name = COMPONENT_TO_ENDPOINT_MAP }
+}
+
 -- after 3 seconds of cubeAction, to automatically change the action status of Plugin UI or Device Card to noAction
 local CUBEACTION_TIMER = "__cubeAction_timer"
 local CUBEACTION_TIME = 3
@@ -125,6 +124,17 @@ local function endpoint_to_component(device, endpoint)
   return "main"
 end
 
+local function check_field_name_updates(device)
+  for _, field in ipairs(updated_fields) do
+    if device:get_field(field.current_field_name) then
+      if field.updated_field_name ~= nil then
+        device:set_field(field.updated_field_name, device:get_field(field.current_field_name), {persist = true})
+      end
+      device:set_field(field.current_field_name, nil)
+    end
+  end
+end
+
 -- This is called either on add for parent/child devices, or after the device profile changes for components
 local function configure_buttons(device)
   if device.network_type ~= device_lib.NETWORK_TYPE_CHILD then
@@ -160,56 +170,50 @@ local function set_configure(driver, device)
     current_component_number = current_component_number + 1
   end
 
-  device:set_field(COMPONENT_TO_ENDPOINT_MAP_BUTTON, component_map, {persist = true})
+  device:set_field(COMPONENT_TO_ENDPOINT_MAP, component_map, {persist = true})
   device:try_update_metadata({profile = "cube-t1-pro"})
   configure_buttons(device)
 end
 
 local function device_init(driver, device)
   if device.network_type == device_lib.NETWORK_TYPE_MATTER then
+    check_field_name_updates(device)
     device:subscribe()
     device:set_endpoint_to_component_fn(endpoint_to_component)
-
-    -- when unit testing, call set_configure elsewhere
-    if not device:get_field(TEST_CONFIGURE) then
-      set_configure(driver, device)
-    end
   end
 end
 
 local function device_added(driver, device)
-  if device.network_type ~= device_lib.NETWORK_TYPE_CHILD then
-    device:set_field(DEFERRED_CONFIGURE, true)
+  if device.network_type == device_lib.NETWORK_TYPE_MATTER then
+    device_init(driver, device)
   end
 end
 
-local function info_changed(driver, device, event, args)
-  -- for unit testing
-  if device:get_field(TEST_CONFIGURE) then
+local function do_configure(driver, device)
+  -- when unit testing, call set_configure elsewhere
+  if device.network_type == device_lib.NETWORK_TYPE_MATTER then
     set_configure(driver, device)
   end
+end
 
-  if (device.profile.id ~= args.old_st_store.profile.id or device:get_field(TEST_CONFIGURE))
-    and device:get_field(DEFERRED_CONFIGURE)
-    and device.network_type ~= device_lib.NETWORK_TYPE_CHILD then
+local function driver_switched(driver, device)
+  if device.network_type == device_lib.NETWORK_TYPE_MATTER then
+    set_configure(driver, device)
+  end
+end
 
+local function info_changed(driver, device, event, args)
+  if device.profile.id ~= args.old_st_store.profile.id and
+     device.network_type == device_lib.NETWORK_TYPE_MATTER then
     reset_thread(device)
     device:emit_event(cubeAction.cubeAction("flipToSide1"))
     device:emit_event(cubeFace.cubeFace("face1Up"))
-
-    device:set_field(DEFERRED_CONFIGURE, nil)
   end
 end
 
--- override do_configure to prevent it running in the main driver
-local function do_configure(driver, device) end
-
--- override driver_switched to prevent it running in the main driver
-local function driver_switched(driver, device) end
-
 local function initial_press_event_handler(driver, device, ib, response)
   if get_field_for_endpoint(device, INITIAL_PRESS_ONLY, ib.endpoint_id) then
-    local map = device:get_field(COMPONENT_TO_ENDPOINT_MAP_BUTTON) or {}
+    local map = device:get_field(COMPONENT_TO_ENDPOINT_MAP) or {}
     local face = 1
     for component, ep in pairs(map) do
       if map[component] == ib.endpoint_id then
@@ -255,4 +259,3 @@ local aqara_cube_handler = {
 }
 
 return aqara_cube_handler
-

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

@@ -23,10 +23,13 @@ local utils = require "st.utils"
 local data_types = require "st.matter.data_types"
 local device_lib = require "st.device"
 
-local SWITCH_INITIALIZED = "__switch_intialized"
 local COMPONENT_TO_ENDPOINT_MAP = "__component_to_endpoint_map"
 local ON_OFF_STATES = "ON_OFF_STATES"
 
+local updated_fields = {
+  { current_field_name = "__switch_intialized", updated_field_name = nil }
+}
+
 local EVE_MANUFACTURER_ID = 0x130A
 local PRIVATE_CLUSTER_ID = 0x130AFC01
 
@@ -203,8 +206,6 @@ local function initialize_switch(driver, device)
       end
     end
   end
-
-  device:set_field(SWITCH_INITIALIZED, true)
 end
 
 local function component_to_endpoint(device, component)
@@ -245,18 +246,25 @@ local function set_on_off_state(device, endpoint, value)
   device:set_field(ON_OFF_STATES, map)
 end
 
+local function check_field_name_updates(device)
+  for _, field in ipairs(updated_fields) do
+    if device:get_field(field.current_field_name) then
+      if field.updated_field_name ~= nil then
+        device:set_field(field.updated_field_name, device:get_field(field.current_field_name), {persist = true})
+      end
+      device:set_field(field.current_field_name, nil)
+    end
+  end
+end
+
 
 -------------------------------------------------------------------------------------
 -- Device Management
 -------------------------------------------------------------------------------------
 
 local function device_init(driver, device)
   if device.network_type == device_lib.NETWORK_TYPE_MATTER then
-    if not device:get_field(COMPONENT_TO_ENDPOINT_MAP) and
-        not device:get_field(SWITCH_INITIALIZED) then
-      -- create child devices as needed for multi-switch devices
-      initialize_switch(driver, device)
-    end
+    check_field_name_updates(device)
     device:set_component_to_endpoint_fn(component_to_endpoint)
     device:set_endpoint_to_component_fn(endpoint_to_component)
     device:set_find_child(find_child)
@@ -277,11 +285,18 @@ local function device_removed(driver, device)
   delete_poll_schedule(device)
 end
 
--- override do_configure to prevent it running in the main driver
-local function do_configure(driver, device) end
+local function do_configure(driver, device)
+  if device.network_type == device_lib.NETWORK_TYPE_MATTER then
+    -- create child devices as needed for multi-switch devices
+    initialize_switch(driver, device)
+  end
+end
 
--- override driver_switched to prevent it running in the main driver
-local function driver_switched(driver, device) end
+local function driver_switched(driver, device)
+  if device.network_type == device_lib.NETWORK_TYPE_MATTER then
+    initialize_switch(driver, device)
+  end
+end
 
 local function handle_refresh(self, device)
   requestData(device)

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

@@ -1,16 +1,28 @@
+-- Copyright 2025 SmartThings
+--
+-- Licensed under the Apache License, Version 2.0 (the "License");
+-- you may not use this file except in compliance with the License.
+-- You may obtain a copy of the License at
+--
+--     http://www.apache.org/licenses/LICENSE-2.0
+--
+-- Unless required by applicable law or agreed to in writing, software
+-- distributed under the License is distributed on an "AS IS" BASIS,
+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+-- See the License for the specific language governing permissions and
+-- limitations under the License.
+
 local test = require "integration_test"
 test.add_package_capability("cubeAction.yml")
 test.add_package_capability("cubeFace.yml")
 local capabilities = require "st.capabilities"
 local cubeAction = capabilities["stse.cubeAction"]
 local cubeFace = capabilities["stse.cubeFace"]
 
-local t_utils = require "integration_test.utils"
 local clusters = require "st.matter.clusters"
-
--- used in unit testing, since device.profile.id and args.old_st_store.profile.id are always the same
--- and this is to avoid the crash of the test case that occurs when try_update_metadata is performed in the device_init stage.
-local TEST_CONFIGURE = "__test_configure"
+local dkjson = require "dkjson"
+local t_utils = require "integration_test.utils"
+local utils = require "st.utils"
 
 --mock the actual device1
 local mock_device = test.mock_device.build_test_matter_device(
@@ -146,16 +158,22 @@ local CLUSTER_SUBSCRIBE_LIST ={
 }
 
 local function test_init()
-  local opts = { persist = true }
-  mock_device:set_field(TEST_CONFIGURE, true, opts)
-
   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" })
+  test.socket.matter:__expect_send({mock_device.id, subscribe_request})
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "doConfigure" })
+  mock_device:expect_metadata_update({ profile = "cube-t1-pro" })
+  mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
+  local device_info_copy = utils.deep_copy(mock_device.raw_st_data)
+  device_info_copy.profile.id = "matter-thing"
+  local device_info_json = dkjson.encode(device_info_copy)
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "infoChanged", device_info_json })
   test.mock_device.add_test_device(mock_device)
   test.socket.capability:__expect_send(
     mock_device:generate_test_message("main", cubeAction.cubeAction({value = "flipToSide1"}))
@@ -168,16 +186,22 @@ end
 test.set_test_init_function(test_init)
 
 local function test_init_exhausted()
-  local opts = { persist = true }
-  mock_device_exhausted:set_field(TEST_CONFIGURE, true, opts)
-
   local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(mock_device_exhausted)
   for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST) do
     if i > 1 then
       subscribe_request:merge(clus:subscribe(mock_device_exhausted))
     end
   end
   test.socket.matter:__expect_send({mock_device_exhausted.id, subscribe_request})
+  test.socket.device_lifecycle:__queue_receive({ mock_device_exhausted.id, "added" })
+  test.socket.matter:__expect_send({mock_device_exhausted.id, subscribe_request})
+  test.socket.device_lifecycle:__queue_receive({ mock_device_exhausted.id, "doConfigure" })
+  mock_device_exhausted:expect_metadata_update({ profile = "cube-t1-pro" })
+  mock_device_exhausted:expect_metadata_update({ provisioning_state = "PROVISIONED" })
+  local device_info_copy = utils.deep_copy(mock_device_exhausted.raw_st_data)
+  device_info_copy.profile.id = "matter-thing"
+  local device_info_json = dkjson.encode(device_info_copy)
+  test.socket.device_lifecycle:__queue_receive({ mock_device_exhausted.id, "infoChanged", device_info_json })
   test.mock_device.add_test_device(mock_device_exhausted)
   test.socket.capability:__expect_send(
     mock_device_exhausted:generate_test_message("main", cubeAction.cubeAction({value = "flipToSide1"}))
@@ -188,22 +212,13 @@ local function test_init_exhausted()
 end
 
 test.register_coroutine_test(
-  "Handle single press sequence when changing the device_lifecycle",
+  "Handle single press sequence",
     function()
-      test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })
-      test.mock_devices_api._expected_device_updates[mock_device.device_id] = "00000000-1111-2222-3333-000000000001"
-      test.mock_devices_api._expected_device_updates[1] = {device_id = "00000000-1111-2222-3333-000000000001"}
-      test.mock_devices_api._expected_device_updates[1].metadata = {deviceId="00000000-1111-2222-3333-000000000001", profileReference="cube-t1-pro"}
-
-      test.socket.device_lifecycle:__queue_receive(mock_device:generate_info_changed({value = "face1Up"}))
-      -- let the driver run
-      test.wait_for_events()
-
       test.socket.matter:__queue_receive(
         {
           mock_device.id,
           clusters.Switch.events.InitialPress:build_test_event_report(
-            mock_device, 2, {new_position = 1}  --move to position 1?
+            mock_device, 2, {new_position = 1}
           )
         }
       )
@@ -236,20 +251,11 @@ test.register_coroutine_test(
 test.register_coroutine_test(
   "Handle single press sequence in case of exhausted endpoint",
     function()
-      test.socket.device_lifecycle:__queue_receive({ mock_device_exhausted.id, "added" })
-      test.mock_devices_api._expected_device_updates[mock_device_exhausted.device_id] = "00000000-1111-2222-3333-000000000003"
-      test.mock_devices_api._expected_device_updates[1] = {device_id = "00000000-1111-2222-3333-000000000003"}
-      test.mock_devices_api._expected_device_updates[1].metadata = {deviceId="00000000-1111-2222-3333-000000000003", profileReference="cube-t1-pro"}
-
-      test.socket.device_lifecycle:__queue_receive(mock_device_exhausted:generate_info_changed({value = "face1Up"}))
-      -- let the driver run
-      test.wait_for_events()
-
       test.socket.matter:__queue_receive(
         {
           mock_device_exhausted.id,
           clusters.Switch.events.InitialPress:build_test_event_report(
-            mock_device_exhausted, 250, {new_position = 1}  --move to position 1?
+            mock_device_exhausted, 250, {new_position = 1}
           )
         }
       )
@@ -265,6 +271,14 @@ test.register_coroutine_test(
     { test_init = test_init_exhausted }
 )
 
+test.register_coroutine_test(
+  "Test driver switched event",
+  function()
+    test.socket.device_lifecycle:__queue_receive({ mock_device.id, "driverSwitched" })
+    mock_device:expect_metadata_update({ profile = "cube-t1-pro" })
+  end
+)
+
 -- run the tests
 test.run_registered_tests()