version gate the init event on added

Author: hcarter-775

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

@@ -38,8 +38,11 @@ function SwitchLifecycleHandlers.device_added(driver, device)
     device:send(clusters.OnOff.attributes.OnOff:read(device))
   end
 
-  -- call device init in case init is not called after added due to device caching
-  SwitchLifecycleHandlers.device_init(driver, device)
+  -- The device init event is guaranteed in FW versions 58+, so this is only needed for older hubs
+  if version.rpc < 10 then
+    -- call device init in case init is not called after added due to device caching
+    SwitchLifecycleHandlers.device_init(driver, device)
+  end
 end
 
 function SwitchLifecycleHandlers.do_configure(driver, device)

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

@@ -130,7 +130,6 @@ local function test_init()
   end
 
   test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "added" })
-  test.socket.matter:__expect_send({aqara_mock_device.id, subscribe_request})
 
   test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "init" })
   test.socket.matter:__expect_send({aqara_mock_device.id, subscribe_request})

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

@@ -181,15 +181,12 @@ local function test_init()
 
   -- Test added -> doConfigure logic
   test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "added" })
-  test.socket.matter:__expect_send({aqara_mock_device.id, subscribe_request})
   test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "init" })
   test.socket.matter:__expect_send({aqara_mock_device.id, subscribe_request})
   test.socket.device_lifecycle:__queue_receive({ aqara_mock_device.id, "doConfigure" })
   configure_buttons()
   aqara_mock_device:expect_metadata_update({ profile = "4-button" })
   aqara_mock_device:expect_metadata_update({ provisioning_state = "PROVISIONED" })
-  -- to test powerConsumptionReport
-  test.timer.__create_and_queue_test_time_advance_timer(60 * 15, "interval", "create_poll_report_schedule")
 
   for _, child in pairs(aqara_mock_children) do
     test.mock_device.add_test_device(child)

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

@@ -181,8 +181,6 @@ local function test_init()
           subscribe_request:merge(cluster:subscribe(mock_device))
       end
   end
-  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })
-  test.socket.matter:__expect_send({ mock_device.id, subscribe_request })
   test.socket.matter:__expect_send({ mock_device.id, subscribe_request })
 end
 test.set_test_init_function(test_init)
@@ -195,79 +193,9 @@ local function test_init_periodic()
         subscribe_request:merge(cluster:subscribe(mock_device_periodic))
     end
   end
-  test.socket.device_lifecycle:__queue_receive({ mock_device_periodic.id, "added" })
-  test.socket.matter:__expect_send({ mock_device_periodic.id, subscribe_request })
-  test.socket.device_lifecycle:__queue_receive({ mock_device_periodic.id, "init" })
-  test.socket.matter:__expect_send({ mock_device_periodic.id, subscribe_request })
   test.socket.matter:__expect_send({ mock_device_periodic.id, subscribe_request })
 end
 
-test.register_message_test(
-	"On command should send the appropriate commands",
-  {
-		{
-			channel = "capability",
-			direction = "receive",
-			message = {
-				mock_device.id,
-				{ capability = "switch", component = "main", command = "on", args = { } }
-			}
-		},
-    {
-      channel = "devices",
-      direction = "send",
-      message = {
-        "register_native_capability_cmd_handler",
-        { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "on" }
-      }
-    },
-		{
-			channel = "matter",
-			direction = "send",
-			message = {
-				mock_device.id,
-				clusters.OnOff.server.commands.On(mock_device, 2)
-			}
-		}
-	},
-	{
-	   min_api_version = 17
-	}
-)
-
-test.register_message_test(
-  "Off command should send the appropriate commands",
-  {
-    {
-      channel = "capability",
-      direction = "receive",
-      message = {
-        mock_device.id,
-        { capability = "switch", component = "main", command = "off", args = { } }
-      }
-    },
-    {
-      channel = "devices",
-      direction = "send",
-      message = {
-        "register_native_capability_cmd_handler",
-        { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "off" }
-      }
-    },
-    {
-      channel = "matter",
-      direction = "send",
-      message = {
-        mock_device.id,
-        clusters.OnOff.server.commands.Off(mock_device, 2)
-      }
-    }
-  },
-  {
-     min_api_version = 17
-  }
-)
-
 test.register_message_test(
   "Active power measurement should generate correct messages",
   {

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

@@ -128,78 +128,10 @@ local function test_init()
           subscribe_request:merge(cluster:subscribe(mock_device))
       end
   end
-  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })
-  test.socket.matter:__expect_send({ mock_device.id, subscribe_request })
   test.socket.matter:__expect_send({ mock_device.id, subscribe_request })
 end
 test.set_test_init_function(test_init)
 
-test.register_message_test(
-	"On command should send the appropriate commands",
-  {
-		{
-			channel = "capability",
-			direction = "receive",
-			message = {
-				mock_device.id,
-				{ capability = "switch", component = "main", command = "on", args = { } }
-			}
-		},
-    {
-      channel = "devices",
-      direction = "send",
-      message = {
-        "register_native_capability_cmd_handler",
-        { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "on" }
-      }
-    },
-		{
-			channel = "matter",
-			direction = "send",
-			message = {
-				mock_device.id,
-				clusters.OnOff.server.commands.On(mock_device, 2)
-			}
-		}
-	},
-	{
-	   min_api_version = 17
-	}
-)
-
-test.register_message_test(
-  "Off command should send the appropriate commands",
-  {
-    {
-      channel = "capability",
-      direction = "receive",
-      message = {
-        mock_device.id,
-        { capability = "switch", component = "main", command = "off", args = { } }
-      }
-    },
-    {
-      channel = "devices",
-      direction = "send",
-      message = {
-        "register_native_capability_cmd_handler",
-        { device_uuid = mock_device.id, capability_id = "switch", capability_cmd_id = "off" }
-      }
-    },
-    {
-      channel = "matter",
-      direction = "send",
-      message = {
-        mock_device.id,
-        clusters.OnOff.server.commands.Off(mock_device, 2)
-      }
-    }
-  },
-  {
-     min_api_version = 17
-  }
-)
-
 test.register_message_test(
   "Active power measurement should generate correct messages",
   {

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

@@ -54,7 +54,7 @@ local mock_device = test.mock_device.build_test_matter_device({
   }
 })
 
-local mock_device_electrical_sensor = test.mock_device.build_test_matter_device({
+local mock_eve_device_using_electrical_sensor = test.mock_device.build_test_matter_device({
   profile = t_utils.get_profile_definition("plug-energy-powerConsumption.yml"),
   manufacturer_info = {
     vendor_id = 0x130A,
@@ -113,30 +113,6 @@ local mock_device_electrical_sensor = test.mock_device.build_test_matter_device(
   }
 })
 
-local function test_init_electrical_sensor()
-  test.disable_startup_messages()
-  test.mock_device.add_test_device(mock_device_electrical_sensor)
-  local cluster_subscribe_list = {
-    clusters.OnOff.attributes.OnOff,
-    clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported,
-    clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyImported,
-  }
-  local subscribe_request = cluster_subscribe_list[1]:subscribe(mock_device_electrical_sensor)
-  for i, clus in ipairs(cluster_subscribe_list) do
-    if i > 1 then subscribe_request:merge(clus:subscribe(mock_device_electrical_sensor)) end
-  end
-
-  test.socket.device_lifecycle:__queue_receive({ mock_device_electrical_sensor.id, "added" })
-  test.socket.matter:__expect_send({mock_device_electrical_sensor.id, subscribe_request})
-
-  test.socket.device_lifecycle:__queue_receive({ mock_device_electrical_sensor.id, "init" })
-  test.socket.matter:__expect_send({mock_device_electrical_sensor.id, subscribe_request})
-
-  test.socket.device_lifecycle:__queue_receive({ mock_device_electrical_sensor.id, "doConfigure" })
-  mock_device_electrical_sensor:expect_metadata_update({ profile = "plug-energy-powerConsumption" })
-  mock_device_electrical_sensor:expect_metadata_update({ provisioning_state = "PROVISIONED" })
-end
-
 local function test_init()
   local cluster_subscribe_list = {
     clusters.OnOff.attributes.OnOff,
@@ -523,7 +499,7 @@ local cumulative_report_val_39 = {
 test.register_coroutine_test(
   "Cumulative Energy measurement should generate correct messages",
     function()
-      local mock_device = mock_device_electrical_sensor
+      mock_device = mock_eve_device_using_electrical_sensor
 
       test.mock_time.advance_time(901) -- move time 15 minutes past 0 (this can be assumed to be true in practice in all cases)
       test.socket.matter:__queue_receive(
@@ -579,7 +555,10 @@ test.register_coroutine_test(
       )
     end,
     {
-      test_init = test_init_electrical_sensor,
+      test_init = function()
+        test.disable_startup_messages()
+        test.mock_device.add_test_device(mock_eve_device_using_electrical_sensor)
+      end,
       min_api_version = 17
     }
 )