Change get/set_field to get/set_field_for_endpoint

Signed-off-by: Hunsup Jung <hunsup.jung@samsung.com>

Author: HunsupJung

drivers/SmartThings/matter-window-covering/src/init.lua

@@ -41,6 +41,22 @@ local TARGET_TILT_PERCENT = {
 
 local TARGET_REACH_TOLERANCE = 0.5
 
+local function get_field_for_endpoint(device, field, endpoint)
+  local field_device = device
+  if device:get_field(IS_PARENT_CHILD_DEVICE) ~= true then
+    field_device = device:get_parent_device()
+  end
+  return field_device:get_field(string.format("%s_%d", field, endpoint))
+end
+
+local function set_field_for_endpoint(device, field, endpoint, value, additional_params)
+  local field_device = device
+  if device:get_field(IS_PARENT_CHILD_DEVICE) ~= true then
+    field_device = device:get_parent_device()
+  end
+  field_device:set_field(string.format("%s_%d", field, endpoint), value, additional_params)
+end
+
 local function find_child(parent_device, ep_id)
   local assigned_key = parent_device:get_field(string.format("%s_%d", ASSIGNED_CHILD_KEY, ep_id)) or ep_id
   return parent_device:get_child_by_parent_assigned_key(string.format("%d", assigned_key))
@@ -102,22 +118,22 @@ end
 --- Clears the cached target percentage and cancels any associated timeout.
 --- @param device any a Matter device object
 --- @param op_fields table a table containing operational field constants used for caching target percentages and timeouts.
-local function clear_cached_data(device, op_fields)
-  local current_timer = device:get_field(op_fields.TIMEOUT)
+local function clear_cached_data(device, op_fields, ep)
+  local current_timer = get_field_for_endpoint(device, op_fields.TIMEOUT, ep)
   if current_timer then
     device.thread:cancel_timer(current_timer)
   end
-  device:set_field(op_fields.STATE, nil)
-  device:set_field(op_fields.TIMEOUT, nil)
+  set_field_for_endpoint(device, op_fields.STATE, ep, nil)
+  set_field_for_endpoint(device, op_fields.TIMEOUT, ep, nil)
 end
 
 --- Tries to emit the idle window shade status if no target percentages are set.
 --- @param device any a Matter device object
 local function try_emit_idle_window_shade_status(device, ep)
-  if not device:get_field(TARGET_LIFT_PERCENT.STATE) and
-   not device:get_field(TARGET_TILT_PERCENT.STATE) then
+  if not get_field_for_endpoint(device, TARGET_LIFT_PERCENT.STATE, ep) and
+   not get_field_for_endpoint(device, TARGET_TILT_PERCENT.STATE, ep) then
     --- gets child device if one exists for this endpoint
-    local status_device = ep and find_child(device, ep) or device
+    local status_device = find_child(device, ep) or device
     status_device:emit_event(get_idle_window_shade_status(status_device))
   end
 end
@@ -126,18 +142,18 @@ end
 --- @param device any a Matter device object
 --- @param data number the target percentage to cache
 --- @param op_fields table a table containing operational field constants used for caching target percentages and timeouts.
-local function cache_data_with_timeout(device, data, op_fields)
-  device:set_field(op_fields.STATE, data)
-  local previous_timer = device:get_field(op_fields.TIMEOUT)
+local function cache_data_with_timeout(device, data, op_fields, ep)
+  set_field_for_endpoint(device, op_fields.STATE, ep, data)
+  local previous_timer = get_field_for_endpoint(device, op_fields.TIMEOUT, ep)
   if previous_timer then
     device.thread:cancel_timer(previous_timer)
   end
   local new_timer = device.thread:call_with_delay(op_fields.TIMEOUT_DELAY_S, function()
-    device:set_field(op_fields.STATE, nil)
-    device:set_field(op_fields.TIMEOUT, nil)
-    try_emit_idle_window_shade_status(device, nil)
+    set_field_for_endpoint(device, op_fields.STATE, ep, nil)
+    set_field_for_endpoint(device, op_fields.TIMEOUT, ep, nil)
+    try_emit_idle_window_shade_status(device, ep)
   end)
-  device:set_field(op_fields.TIMEOUT, new_timer)
+  set_field_for_endpoint(device, op_fields.TIMEOUT, ep, new_timer)
 end
 
 local function is_target_value_reached(current_value, target_value)
@@ -266,15 +282,15 @@ end
 
 -- capability handlers
 local function handle_preset(driver, device, cmd)
+  local endpoint_id = device:component_to_endpoint(cmd.component)
   local preset_target_percent = device:get_latest_state(
     "main",
     capabilities.windowShadePreset.ID,
     capabilities.windowShadePreset.position.NAME,
     DEFAULT_PRESET_LEVEL
   )
-  cache_data_with_timeout(device, preset_target_percent, TARGET_LIFT_PERCENT)
+  cache_data_with_timeout(device, preset_target_percent, TARGET_LIFT_PERCENT, endpoint_id)
   local hundredths_lift_percent = (100 - preset_target_percent) * 100
-  local endpoint_id = device:component_to_endpoint(cmd.component)
   device:send(clusters.WindowCovering.server.commands.GoToLiftPercentage(
     device, endpoint_id, hundredths_lift_percent
   ))
@@ -288,10 +304,10 @@ end
 local function handle_close(driver, device, cmd)
   local endpoint_id = device:component_to_endpoint(cmd.component)
   if #device:get_endpoints(clusters.WindowCovering.ID, {feature_bitmap = clusters.WindowCovering.types.Feature.LIFT}) > 0 then
-    cache_data_with_timeout(device, device.preferences.reverse and 100 or 0, TARGET_LIFT_PERCENT)
+    cache_data_with_timeout(device, device.preferences.reverse and 100 or 0, TARGET_LIFT_PERCENT, endpoint_id)
   end
   if #device:get_endpoints(clusters.WindowCovering.ID, {feature_bitmap = clusters.WindowCovering.types.Feature.TILT}) > 0 then
-    cache_data_with_timeout(device, device.preferences.reverse and 100 or 0, TARGET_TILT_PERCENT)
+    cache_data_with_timeout(device, device.preferences.reverse and 100 or 0, TARGET_TILT_PERCENT, endpoint_id)
   end
   device:send(device.preferences.reverse and
     clusters.WindowCovering.server.commands.UpOrOpen(device, endpoint_id) or
@@ -302,10 +318,10 @@ end
 local function handle_open(driver, device, cmd)
   local endpoint_id = device:component_to_endpoint(cmd.component)
   if #device:get_endpoints(clusters.WindowCovering.ID, {feature_bitmap = clusters.WindowCovering.types.Feature.LIFT}) > 0 then
-    cache_data_with_timeout(device, device.preferences.reverse and 0 or 100, TARGET_LIFT_PERCENT)
+    cache_data_with_timeout(device, device.preferences.reverse and 0 or 100, TARGET_LIFT_PERCENT, endpoint_id)
   end
   if #device:get_endpoints(clusters.WindowCovering.ID, {feature_bitmap = clusters.WindowCovering.types.Feature.TILT}) > 0 then
-    cache_data_with_timeout(device, device.preferences.reverse and 0 or 100, TARGET_TILT_PERCENT)
+    cache_data_with_timeout(device, device.preferences.reverse and 0 or 100, TARGET_TILT_PERCENT, endpoint_id)
   end
   device:send(device.preferences.reverse and
     clusters.WindowCovering.server.commands.DownOrClose(device, endpoint_id) or
@@ -322,23 +338,24 @@ end
 local function handle_shade_level(driver, device, cmd)
   local endpoint_id = device:component_to_endpoint(cmd.component)
   local hundredths_lift_percentage = (100 - cmd.args.shadeLevel) * 100
-  cache_data_with_timeout(device, cmd.args.shadeLevel, TARGET_LIFT_PERCENT)
+  cache_data_with_timeout(device, cmd.args.shadeLevel, TARGET_LIFT_PERCENT, endpoint_id)
   device:send(clusters.WindowCovering.server.commands.GoToLiftPercentage(
     device, endpoint_id, hundredths_lift_percentage
   ))
 end
 
 local function handle_step_shade_level(driver, device, cmd)
+  local endpoint_id = device:component_to_endpoint(cmd.component)
   local step = cmd.args.stepSize
   local latest_lift_percentage = device:get_latest_state(
     "main",
     capabilities.windowShadeLevel.ID,
     capabilities.windowShadeLevel.shadeLevel.NAME,
     0
   )
-  local target_lift_percent = device:get_field(TARGET_LIFT_PERCENT.STATE) or latest_lift_percentage
+  local target_lift_percent = get_field_for_endpoint(device, TARGET_LIFT_PERCENT.STATE, endpoint_id) or latest_lift_percentage
   local updated_target_lift = utils.clamp_value(target_lift_percent + step, 0, 100)
-  cache_data_with_timeout(device, updated_target_lift, TARGET_LIFT_PERCENT)
+  cache_data_with_timeout(device, updated_target_lift, TARGET_LIFT_PERCENT, endpoint_id)
   driver:inject_capability_command(device, {
     capability = capabilities.windowShadeLevel.ID,
     component = cmd.component,
@@ -351,7 +368,7 @@ end
 local function handle_shade_tilt_level(driver, device, cmd)
   local endpoint_id = device:component_to_endpoint(cmd.component)
   local hundredths_tilt_percentage = (100 - cmd.args.level) * 100
-  cache_data_with_timeout(device, cmd.args.level, TARGET_TILT_PERCENT)
+  cache_data_with_timeout(device, cmd.args.level, TARGET_TILT_PERCENT, endpoint_id)
   device:send(clusters.WindowCovering.server.commands.GoToTiltPercentage(
     device, endpoint_id, hundredths_tilt_percentage
   ))
@@ -362,9 +379,8 @@ local function current_position_lift_percent_100ths_handler(driver, device, ib,
   if not ib.data.value then return end
   local lift_percent = 100 - math.floor(ib.data.value / 100)
   device:emit_event_for_endpoint(ib.endpoint_id, capabilities.windowShadeLevel.shadeLevel(lift_percent))
-
-  if is_target_value_reached(lift_percent, device:get_field(TARGET_LIFT_PERCENT.STATE)) then
-    clear_cached_data(device, TARGET_LIFT_PERCENT)
+  if is_target_value_reached(lift_percent, get_field_for_endpoint(device, TARGET_LIFT_PERCENT.STATE, ib.endpoint_id)) then
+    clear_cached_data(device, TARGET_LIFT_PERCENT, ib.endpoint_id)
     try_emit_idle_window_shade_status(device, ib.endpoint_id)
   end
 end
@@ -373,9 +389,8 @@ local function current_position_tilt_percent_100ths_handler(driver, device, ib,
   if not ib.data.value then return end
   local tilt_percent = 100 - math.floor(ib.data.value / 100)
   device:emit_event_for_endpoint(ib.endpoint_id, capabilities.windowShadeTiltLevel.shadeTiltLevel(tilt_percent))
-
-  if is_target_value_reached(tilt_percent, device:get_field(TARGET_TILT_PERCENT.STATE)) then
-    clear_cached_data(device, TARGET_TILT_PERCENT)
+  if is_target_value_reached(tilt_percent, get_field_for_endpoint(device, TARGET_TILT_PERCENT.STATE, ib.endpoint_id)) then
+    clear_cached_data(device, TARGET_TILT_PERCENT, ib.endpoint_id)
     try_emit_idle_window_shade_status(device, ib.endpoint_id)
   end
 end
@@ -389,10 +404,10 @@ local function target_position_lift_percent_100ths_handler(driver, device, ib, r
       capabilities.windowShadeLevel.shadeLevel.NAME
     )
     if latest_lift_percentage and is_target_value_reached(latest_lift_percentage, target_lift_percent) then
-      clear_cached_data(device, TARGET_LIFT_PERCENT)
+      clear_cached_data(device, TARGET_LIFT_PERCENT, ib.endpoint_id)
       try_emit_idle_window_shade_status(device, ib.endpoint_id)
     else
-      cache_data_with_timeout(device, target_lift_percent, TARGET_LIFT_PERCENT)
+      cache_data_with_timeout(device, target_lift_percent, TARGET_LIFT_PERCENT, ib.endpoint_id)
     end
   end
 end
@@ -406,10 +421,10 @@ local function target_position_tilt_percent_100ths_handler(driver, device, ib, r
       capabilities.windowShadeTiltLevel.shadeTiltLevel.NAME
     )
     if latest_tilt_percent and is_target_value_reached(latest_tilt_percent, target_tilt_percent) then
-      clear_cached_data(device, TARGET_TILT_PERCENT)
+      clear_cached_data(device, TARGET_TILT_PERCENT, ib.endpoint_id)
       try_emit_idle_window_shade_status(device, ib.endpoint_id)
     else
-      cache_data_with_timeout(device, target_tilt_percent, TARGET_TILT_PERCENT)
+      cache_data_with_timeout(device, target_tilt_percent, TARGET_TILT_PERCENT, ib.endpoint_id)
     end
   end
 end

drivers/SmartThings/matter-window-covering/src/test/test_matter_multi_window_covering.lua

@@ -568,48 +568,6 @@ test.register_coroutine_test(
   }
 )
 
-test.register_coroutine_test(
-  "WindowCovering TargetPositionLiftPercent100ths sets field appropriately",
-  function()
-    for i = 1, #mock_child_device do
-      test.socket.matter:__queue_receive(
-        {
-          mock_child_device[i].id,
-          WindowCovering.attributes.TargetPositionLiftPercent100ths:build_test_report_data(
-            mock_child_device[i], CHILD_DEVICE_MAP[i].ep, 5000
-          ),
-        }
-      )
-      test.wait_for_events()
-      assert(mock_child_device[i]:get_field("__target_lift_percent") == 50)
-    end
-  end,
-  {
-     min_api_version = 17
-  }
-)
-
-test.register_coroutine_test(
-  "WindowCovering TargetPositionTiltPercent100ths sets field appropriately",
-  function()
-    for i = 1, #mock_child_device do
-      test.socket.matter:__queue_receive(
-        {
-          mock_child_device[i].id,
-          WindowCovering.attributes.TargetPositionTiltPercent100ths:build_test_report_data(
-            mock_child_device[i], CHILD_DEVICE_MAP[i].ep, 5000
-          ),
-        }
-      )
-      test.wait_for_events()
-      assert(mock_child_device[i]:get_field("__target_tilt_percent") == 50)
-    end
-  end,
-  {
-     min_api_version = 17
-  }
-)
-
 test.register_coroutine_test(
   "WindowCovering TargetPositionLiftPercent100ths triggers operational status update when appropriate",
   function()