Matter Camera: Remove trigger before zone (#2816)

The server will return `INVALID_IN_STATE` if `RemoveZone` is issued
while there is an existing trigger for the given zone. The trigger
should be removed first before attempting to remove the zone.

Author: nickolas-deboom

drivers/SmartThings/matter-switch/src/sub_drivers/camera/camera_handlers/capability_handlers.lua

@@ -259,6 +259,15 @@ end
 
 function CameraCapabilityHandlers.handle_remove_zone(driver, device, cmd)
   local endpoint_id = device:component_to_endpoint(cmd.component)
+  local triggers = device:get_latest_state(
+    camera_fields.profile_components.main, capabilities.zoneManagement.ID, capabilities.zoneManagement.triggers.NAME
+  ) or {}
+  for _, v in pairs(triggers) do
+    if v.zoneId == cmd.args.zoneId then
+      device:send(clusters.ZoneManagement.server.commands.RemoveTrigger(device, endpoint_id, cmd.args.zoneId))
+      break
+    end
+  end
   device:send(clusters.ZoneManagement.server.commands.RemoveZone(device, endpoint_id, cmd.args.zoneId))
 end
 

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

@@ -1573,7 +1573,7 @@ test.register_coroutine_test(
       test.socket.capability:__queue_receive({
         mock_device.id,
         { capability = "zoneManagement", component = "main", command = "newZone", args = {
-          i .. " zone", {{value = {x = 0, y = 0}}, {value = {x = 1920, y = 1080}} }, i, "blue"
+          i .. " zone", {{value = {x = 0, y = 0}}, {value = {x = 1920, y = 1080}} }, i, "#FFFFFF"
         }}
       })
       test.socket.matter:__expect_send({
@@ -1586,7 +1586,7 @@ test.register_coroutine_test(
                 clusters.ZoneManagement.types.TwoDCartesianVertexStruct({x = 0, y = 0}),
                 clusters.ZoneManagement.types.TwoDCartesianVertexStruct({x = 1920, y = 1080})
               },
-              color = "blue"
+              color = "#FFFFFF"
             }
           )
         )
@@ -1773,6 +1773,95 @@ test.register_coroutine_test(
   end
 )
 
+test.register_coroutine_test(
+  "Removing a zone with an existing trigger should send RemoveTrigger followed by RemoveZone",
+  function()
+    update_device_profile()
+    test.wait_for_events()
+
+    -- Create a zone
+    test.socket.capability:__queue_receive({
+      mock_device.id,
+      { capability = "zoneManagement", component = "main", command = "newZone", args = {
+        "motion zone", {{value = {x = 0, y = 0}}, {value = {x = 1920, y = 1080}}}, "motion", "#FFFFFF"
+      }}
+    })
+    test.socket.matter:__expect_send({
+      mock_device.id, clusters.ZoneManagement.server.commands.CreateTwoDCartesianZone(mock_device, CAMERA_EP,
+        clusters.ZoneManagement.types.TwoDCartesianZoneStruct({
+          name = "motion zone",
+          use = clusters.ZoneManagement.types.ZoneUseEnum.MOTION,
+          vertices = {
+            clusters.ZoneManagement.types.TwoDCartesianVertexStruct({x = 0, y = 0}),
+            clusters.ZoneManagement.types.TwoDCartesianVertexStruct({x = 1920, y = 1080})
+          },
+          color = "#FFFFFF"
+        })
+      )
+    })
+
+    -- Create a trigger
+    test.socket.capability:__queue_receive({
+      mock_device.id,
+      { capability = "zoneManagement", component = "main", command = "createOrUpdateTrigger", args = {
+        1, 10, 3, 15, 3, 5
+      }}
+    })
+    test.socket.matter:__expect_send({
+      mock_device.id, clusters.ZoneManagement.server.commands.CreateOrUpdateTrigger(mock_device, CAMERA_EP, {
+        zone_id = 1,
+        initial_duration = 10,
+        augmentation_duration = 3,
+        max_duration = 15,
+        blind_duration = 3,
+        sensitivity = 5
+      })
+    })
+
+    -- Receive the Triggers attribute update from the device reflecting the new trigger
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ZoneManagement.attributes.Triggers:build_test_report_data(
+        mock_device, CAMERA_EP, {
+          clusters.ZoneManagement.types.ZoneTriggerControlStruct({
+            zone_id = 1, initial_duration = 10, augmentation_duration = 3,
+            max_duration = 15, blind_duration = 3, sensitivity = 5
+          })
+        }
+      )
+    })
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.zoneManagement.triggers({{
+        zoneId = 1, initialDuration = 10, augmentationDuration = 3,
+        maxDuration = 15, blindDuration = 3, sensitivity = 5
+      }}))
+    )
+    test.wait_for_events()
+
+    -- Receive removeZone command: since a trigger exists for zone 1, RemoveTrigger is sent first, then RemoveZone
+    test.socket.capability:__queue_receive({
+      mock_device.id,
+      { capability = "zoneManagement", component = "main", command = "removeZone", args = { 1 } }
+    })
+    test.socket.matter:__expect_send({
+      mock_device.id, clusters.ZoneManagement.server.commands.RemoveTrigger(mock_device, CAMERA_EP, 1)
+    })
+    test.socket.matter:__expect_send({
+      mock_device.id, clusters.ZoneManagement.server.commands.RemoveZone(mock_device, CAMERA_EP, 1)
+    })
+    test.wait_for_events()
+
+    -- Receive the updated Zones attribute from the device with the zone removed
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ZoneManagement.attributes.Zones:build_test_report_data(mock_device, CAMERA_EP, {})
+    })
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.zoneManagement.zones({value = {}}))
+    )
+  end
+)
+
 test.register_coroutine_test(
   "Stream management commands should send the appropriate commands",
   function()