Merge branch 'main' into Bosch_motion_sensor_support

Author: JanJakubiszyn

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

@@ -83,7 +83,13 @@ local function lock_state_handler(driver, device, ib, response)
   }
 
   if ib.data.value ~= nil then
-    device:emit_event(LOCK_STATE[ib.data.value])
+    local event = LOCK_STATE[ib.data.value]
+    if event ~= nil then
+      device:emit_event(event)
+    else
+      device.log.warn(string.format("Received unknown lock state value (%s), emitting unknown", ib.data.value))
+      device:emit_event(attr.unknown())
+    end
   else
     device:emit_event(LOCK_STATE[LockState.NOT_FULLY_LOCKED])
   end

drivers/SmartThings/matter-lock/src/new-matter-lock/fingerprints.lua

@@ -7,6 +7,10 @@ local NEW_MATTER_LOCK_PRODUCTS = {
   {0x115f, 0x2807}, -- AQARA, U200 Lite
   {0x115f, 0x2804}, -- AQARA, U400
   {0x115f, 0x286A}, -- AQARA, U200 US
+  {0x115f, 0x2805}, -- Aqara Smart Lock J200 Set
+  {0x115f, 0x280e}, -- AQARA Smart Gate Lock U500
+  {0x115f, 0x280f}, -- AQARA Smart Rim Lock U500
+  {0x115f, 0x2810}, -- AQARA Smart Glass Door Lock U500
   {0x147F, 0x0001}, -- U-tec
   {0x147F, 0x0007}, -- ULTRALOQ Bolt Pro Smart Matter Door Lock
   {0x147F, 0x0008}, -- Ultraloq, Bolt Smart Matter Door Lock

drivers/SmartThings/matter-lock/src/test/test_matter_lock.lua

@@ -191,6 +191,29 @@ test.register_message_test(
   }
 )
 
+test.register_message_test(
+  "Handle unknown LockState value from Matter device.", {
+    {
+      channel = "matter",
+      direction = "receive",
+      message = {
+        mock_device.id,
+        clusters.DoorLock.attributes.LockState:build_test_report_data(
+          mock_device, 10, 0xFF
+        ),
+      },
+    },
+    {
+      channel = "capability",
+      direction = "send",
+      message = mock_device:generate_test_message("main", capabilities.lock.lock.unknown()),
+    },
+  },
+  {
+     min_api_version = 17
+  }
+)
+
 test.register_message_test(
   "Handle received BatPercentRemaining from device.", {
     {

drivers/SmartThings/matter-switch/fingerprints.yml

@@ -185,7 +185,7 @@ matterManufacturer:
     deviceLabel: Linkind Smart Ceiling Light
     vendorId: 0x1396
     productId: 0x10B1
-    deviceProfileName: light-level-colorTemperature
+    deviceProfileName: light-color-level
   - id: "5014/4164"
     deviceLabel: Linkind Smart Light Bulb
     vendorId: 0x1396
@@ -2075,6 +2075,11 @@ matterManufacturer:
     vendorId: 0x1189
     productId: 0x0892
     deviceProfileName: switch-binary
+  - id: "4489/4097"
+    deviceLabel: OSRAM PLANON SLIM
+    vendorId: 0x1189
+    productId: 0x1001
+    deviceProfileName: light-color-level
 #Shelly
   - id: "5264/1"
     deviceLabel: Shelly Plug S MTR Gen3

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

@@ -3,28 +3,46 @@
 
 local camera_fields = require "sub_drivers.camera.camera_utils.fields"
 local capabilities = require "st.capabilities"
-local switch_utils = require "switch_utils.utils"
 
 local CameraEventHandlers = {}
 
+local function has_triggered_zone(triggered_zones, zone_id)
+  for _, zone in ipairs(triggered_zones or {}) do
+    if zone.zoneId == zone_id then
+      return true
+    end
+  end
+  return false
+end
+
 function CameraEventHandlers.zone_triggered_handler(driver, device, ib, response)
   local triggered_zones = device:get_field(camera_fields.TRIGGERED_ZONES) or {}
-  if not switch_utils.tbl_contains(triggered_zones, ib.data.elements.zone.value) then
-    table.insert(triggered_zones, {zoneId = ib.data.elements.zone.value})
+  local zone_id = ib.data.elements.zone.value
+  if not has_triggered_zone(triggered_zones, zone_id) then
+    table.insert(triggered_zones, { zoneId = zone_id })
     device:set_field(camera_fields.TRIGGERED_ZONES, triggered_zones)
     device:emit_event_for_endpoint(ib, capabilities.zoneManagement.triggeredZones(triggered_zones))
   end
 end
 
 function CameraEventHandlers.zone_stopped_handler(driver, device, ib, response)
   local triggered_zones = device:get_field(camera_fields.TRIGGERED_ZONES) or {}
-  for i, v in pairs(triggered_zones) do
-    if v.zoneId == ib.data.elements.zone.value then
-      table.remove(triggered_zones, i)
-      device:set_field(camera_fields.TRIGGERED_ZONES, triggered_zones)
-      device:emit_event_for_endpoint(ib, capabilities.zoneManagement.triggeredZones(triggered_zones))
+  local zone_id = ib.data.elements.zone.value
+  local updated_triggered_zones = {}
+  local zone_removed = false
+
+  for _, zone in ipairs(triggered_zones) do
+    if zone.zoneId ~= zone_id then
+      table.insert(updated_triggered_zones, zone)
+    else
+      zone_removed = true
     end
   end
+
+  if zone_removed then
+    device:set_field(camera_fields.TRIGGERED_ZONES, updated_triggered_zones)
+    device:emit_event_for_endpoint(ib, capabilities.zoneManagement.triggeredZones(updated_triggered_zones))
+  end
 end
 
 return CameraEventHandlers

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

@@ -1471,6 +1471,47 @@ test.register_coroutine_test(
   }
 )
 
+test.register_coroutine_test(
+  "Duplicate ZoneTriggered events should not duplicate triggeredZones state",
+  function()
+    update_device_profile()
+    test.wait_for_events()
+
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ZoneManagement.events.ZoneTriggered:build_test_event_report(mock_device, CAMERA_EP, {
+        zone = 2,
+        reason = clusters.ZoneManagement.types.ZoneEventTriggeredReasonEnum.MOTION
+      })
+    })
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.zoneManagement.triggeredZones({{zoneId = 2}}))
+    )
+
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ZoneManagement.events.ZoneTriggered:build_test_event_report(mock_device, CAMERA_EP, {
+        zone = 2,
+        reason = clusters.ZoneManagement.types.ZoneEventTriggeredReasonEnum.MOTION
+      })
+    })
+
+    test.socket.matter:__queue_receive({
+      mock_device.id,
+      clusters.ZoneManagement.events.ZoneStopped:build_test_event_report(mock_device, CAMERA_EP, {
+        zone = 2,
+        reason = clusters.ZoneManagement.types.ZoneEventStoppedReasonEnum.ACTION_STOPPED
+      })
+    })
+    test.socket.capability:__expect_send(
+      mock_device:generate_test_message("main", capabilities.zoneManagement.triggeredZones({}))
+    )
+  end,
+  {
+     min_api_version = 17
+  }
+)
+
 test.register_coroutine_test(
   "Button events should generate appropriate events",
   function()

drivers/SmartThings/samsung-audio/src/command.lua

@@ -34,6 +34,19 @@ local function is_empty(t)
   return not t or (type(t) == "table" and #t == 0)
 end
 
+local function get_uic_response(ret, command_name)
+  local root = ret and ret.handler_res and ret.handler_res.root
+  local uic = root and root.UIC
+  local response = uic and uic.response
+
+  if not uic then
+    log.warn(string.format("Missing UIC data in %s response", tostring(command_name)))
+    return nil, nil
+  end
+
+  return uic, response
+end
+
 local function tr(s,mappings)
   return string.gsub(s,
       "(.)",
@@ -94,8 +107,9 @@ function Command.volume(ip)
   if ip then
    local url = format_url(ip, "/UIC?cmd=<name>GetVolume</name>")
    local ret = handle_http_request(ip, url)
-   if ret then
-     response_map = { volume = ret.handler_res.root.UIC.response.volume, }
+   local _, response = get_uic_response(ret, "GetVolume")
+   if response and response.volume ~= nil then
+     response_map = { volume = response.volume, }
    end
   end
   return response_map
@@ -114,8 +128,9 @@ function Command.set_volume(ip, level)
    local encoded_str_vol = "/UIC?cmd=%3Cpwron%3Eon%3C/pwron%3E%3Cname%3ESetVolume%3C/name%3E%3Cp%20type=%22dec%22%20name=%22volume%22%20val=%22" .. level .. "%22%3E%3C/p%3E"
    local url = format_url(ip, encoded_str_vol)
    local ret = handle_http_request(ip, url)
-   if ret then
-     response_map = { volume = ret.handler_res.root.UIC.response.volume, }
+   local _, response = get_uic_response(ret, "SetVolume")
+   if response and response.volume ~= nil then
+     response_map = { volume = response.volume, }
    end
   end
   return response_map
@@ -326,8 +341,9 @@ function Command.getMute(ip)
   if ip then
    local url = format_url(ip, "/UIC?cmd=<name>GetMute</name>")
    local ret = handle_http_request(ip, url)
-   if ret then
-     response_map = { muted = ret.handler_res.root.UIC.response.mute,}
+   local _, response = get_uic_response(ret, "GetMute")
+   if response and response.mute ~= nil then
+     response_map = { muted = response.mute,}
    end
   end
   return response_map
@@ -342,8 +358,9 @@ function Command.getPlayStatus(ip)
   if ip then
    local url = format_url(ip, "/UIC?cmd=<name>GetPlayStatus</name>")
    local ret = handle_http_request(ip, url)
-   if ret then
-     response_map = { playstatus = ret.handler_res.root.UIC.response.playstatus,}
+   local _, response = get_uic_response(ret, "GetPlayStatus")
+   if response and response.playstatus ~= nil then
+     response_map = { playstatus = response.playstatus,}
    end
   end
   return response_map

drivers/SmartThings/samsung-audio/src/handlers.lua

@@ -137,7 +137,7 @@ end
 function CapabilityHandlers.handle_audio_notification(driver, device, cmd)
   local ip = device:get_field("ip")
   local mute_status = command.getMute(ip)
-  if mute_status.muted ~= "off" then
+  if mute_status and mute_status.muted ~= nil and mute_status.muted ~= "off" then
      --unmute before playig notification
      command.unmute(ip)
   end

drivers/SmartThings/samsung-audio/src/init.lua

@@ -94,14 +94,23 @@ local function emit_refresh_data_to_server(driver, device, cmd)
 
   -- get volume
   local vol = command.volume(device:get_field("ip"))
-  device:emit_event(capabilities.audioVolume.volume(tonumber(vol.volume)))
+  local current_volume = vol and tonumber(vol.volume)
+  if current_volume ~= nil then
+    device:emit_event(capabilities.audioVolume.volume(current_volume))
+  else
+    log.warn("Unable to read speaker volume from refresh response")
+  end
 
   -- get mute status
   local muteStatus = command.getMute(device:get_field("ip"))
-  if muteStatus.muted ~= "off" then
-    device:emit_event(capabilities.audioMute.mute.muted())
+  if muteStatus and muteStatus.muted ~= nil then
+    if muteStatus.muted ~= "off" then
+      device:emit_event(capabilities.audioMute.mute.muted())
+    else
+      device:emit_event(capabilities.audioMute.mute.unmuted())
+    end
   else
-    device:emit_event(capabilities.audioMute.mute.unmuted())
+    log.warn("Unable to read speaker mute state from refresh response")
   end
 end
 

drivers/SmartThings/zigbee-switch/src/stateless_handlers/init.lua

@@ -3,6 +3,7 @@
 
 local capabilities = require "st.capabilities"
 local st_utils = require "st.utils"
+local constants = require "st.zigbee.constants"
 local clusters = require "st.zigbee.zcl.clusters"
 local switch_utils = require "switch_utils"
 
@@ -11,19 +12,47 @@ local DEFAULT_MIRED_MAX_BOUND = 370 -- 2700 Kelvin (Mireds are the inverse of Ke
 local DEFAULT_MIRED_MIN_BOUND = 154 -- 6500 Kelvin (Mireds are the inverse of Kelvin)
 
 -- Transition Time: The time that shall be taken to perform the step change, in units of 1/10ths of a second.
+-- Specific fields can store custom transition times for stateless capabilities
+local SWITCH_LEVEL_STEP_TRANSITION_TIME = "__switch_level_step_transition_time"
+local COLOR_TEMP_STEP_TRANSITION_TIME = "__color_temp_step_transition_time"
 local DEFAULT_STEP_TRANSITION_TIME = 3 -- 0.3 seconds
 
 -- Options Mask & Override: Indicates which options are being overridden by the Level/ColorControl cluster commands
 local OPTIONS_MASK = 0x01 -- default: The `ExecuteIfOff` option is overriden
 local IGNORE_COMMAND_IF_OFF = 0x00 -- default: the command will not be executed if the device is off
 
+-- Indicates whether a delayed refresh for ZLL devices is in progress, to prevent multiple refreshes in a quick series of step commands
+local IS_REFRESH_CALLBACK_QUEUED = "__is_refresh_callback_queued"
+-- Stores a timer object, which is required to cancel a timer early
+local REFRESH_CALLBACK_TIMER = "__refresh_callback_timer"
+
+-- Note: These commands' native handlers do not match the driver's ZLL behavior 1-1.
+-- Instead, they will queue a 2s timer and read refresh for each command, in all cases.
+local function trigger_delayed_refresh_if_zll(device)
+  if device:get_profile_id() ~= constants.ZLL_PROFILE_ID then
+    return
+  end
+
+  -- If a refresh callback is already queued, cancel it and create a new one with the updated time
+  if device:get_field(IS_REFRESH_CALLBACK_QUEUED) then
+    device.thread:cancel_timer(device:get_field(REFRESH_CALLBACK_TIMER))
+  end
+  local delay_s = 2
+  local new_timer = device.thread:call_with_delay(delay_s, function()
+    device:refresh()
+    device:set_field(IS_REFRESH_CALLBACK_QUEUED, nil)
+  end)
+  device:set_field(REFRESH_CALLBACK_TIMER, new_timer)
+  device:set_field(IS_REFRESH_CALLBACK_QUEUED, true)
+end
+
 local function step_color_temperature_by_percent_handler(driver, device, cmd)
   if type(device.register_native_capability_cmd_handler) == "function" then
     device:register_native_capability_cmd_handler(cmd.capability, cmd.command)
   end
   local step_percent_change = cmd.args and cmd.args.stepSize or 0
   if step_percent_change == 0 then return end
-  local transition_time = device:get_field(switch_utils.COLOR_TEMP_STEP_TRANSITION_TIME) or DEFAULT_STEP_TRANSITION_TIME
+  local transition_time = device:get_field(COLOR_TEMP_STEP_TRANSITION_TIME) or DEFAULT_STEP_TRANSITION_TIME
   -- Reminder, stepSize > 0 == Kelvin UP == Mireds DOWN. stepSize < 0 == Kelvin DOWN == Mireds UP
   local step_mode = (step_percent_change > 0) and clusters.ColorControl.types.CcStepMode.DOWN or clusters.ColorControl.types.CcStepMode.UP
   -- note: the field containing the color temp bounds will be associated with a parent device
@@ -37,6 +66,7 @@ local function step_color_temperature_by_percent_handler(driver, device, cmd)
   end
   local step_size_in_mireds = st_utils.round((max_mireds - min_mireds) * (math.abs(step_percent_change)/100.0))
   device:send(clusters.ColorControl.server.commands.StepColorTemperature(device, step_mode, step_size_in_mireds, transition_time, min_mireds, max_mireds, OPTIONS_MASK, IGNORE_COMMAND_IF_OFF))
+  trigger_delayed_refresh_if_zll(device)
 end
 
 local function step_level_handler(driver, device, cmd)
@@ -45,9 +75,10 @@ local function step_level_handler(driver, device, cmd)
   end
   local step_size = st_utils.round((cmd.args and cmd.args.stepSize or 0)/100.0 * 254)
   if step_size == 0 then return end
-  local transition_time = device:get_field(switch_utils.SWITCH_LEVEL_STEP_TRANSITION_TIME) or DEFAULT_STEP_TRANSITION_TIME
+  local transition_time = device:get_field(SWITCH_LEVEL_STEP_TRANSITION_TIME) or DEFAULT_STEP_TRANSITION_TIME
   local step_mode = (step_size > 0) and clusters.Level.types.MoveStepMode.UP or clusters.Level.types.MoveStepMode.DOWN
   device:send(clusters.Level.server.commands.Step(device, step_mode, math.abs(step_size), transition_time, OPTIONS_MASK, IGNORE_COMMAND_IF_OFF))
+  trigger_delayed_refresh_if_zll(device)
 end
 
 local stateless_handlers = {