philips-hue: Scan for groups on light added lifecycle events

Author: NoahCornell

drivers/SmartThings/philips-hue/src/fields.lua

@@ -20,6 +20,7 @@ local Fields = {
   EVENT_SOURCE = "eventsource",
   GAMUT = "gamut",
   GROUPS = "groups",
+  GROUPS_SCAN_QUEUE = "groups_scan_queue",
   HUE_DEVICE_ID = "hue_device_id",
   IPV4 = "ipv4",
   IS_ONLINE = "is_online",

drivers/SmartThings/philips-hue/src/handlers/lifecycle_handlers/light.lua

@@ -13,6 +13,7 @@ local HueDeviceTypes = require "hue_device_types"
 local StrayDeviceHelper = require "stray_device_helper"
 
 local utils = require "utils"
+local grouped_utils = require "utils.grouped_utils"
 
 ---@class LightLifecycleHandlers
 local LightLifecycleHandlers = {}
@@ -197,6 +198,13 @@ function LightLifecycleHandlers.added(driver, device, parent_device_id, resource
     command = capabilities.refresh.commands.refresh.NAME,
     args = {}
   })
+
+  local bridge_device = utils.get_hue_bridge_for_device(driver, device, parent_device_id)
+  if bridge_device then
+    grouped_utils.queue_group_scan(driver, bridge_device)
+  else
+    log.warn("Unable to queue group scan on device added, missing bridge device")
+  end
 end
 
 ---@param driver HueDriver

drivers/SmartThings/philips-hue/src/utils/grouped_utils.lua

@@ -1,5 +1,6 @@
 local log = require "log"
 local Fields = require "fields"
+local cosock = require "cosock"
 
 --- Room or zone with the children translated from their hue device id or light resource id to
 --- their SmartThings represented device object. The grouped light resource id is also moved into
@@ -271,4 +272,46 @@ function grouped_utils.set_field_on_group_devices(group, field, v)
 end
 
 
+function grouped_utils.queue_group_scan(driver, bridge_device)
+  local queue = bridge_device:get_field(Fields.GROUPS_SCAN_QUEUE)
+  if queue == nil then
+    local tx, rx = cosock.channel.new()
+    -- Set timeout to 30 seconds to allow for other queued scans to come in.
+    rx:settimeout(30)
+    cosock.spawn(function()
+      while true do
+        -- The goal here is to timeout on the receive. If we receive a message then another request
+        -- to scan came in. This queuing is to prevent a bunch of added devices from causing to have
+        -- to keep scanning over and over.
+        local _, err = rx:receive()
+        if err then
+          -- err is most likely a timeout but break for all errs
+          break
+        end
+      end
+
+      -- Finally do the scan
+      local hue_device_table = build_hue_id_to_device_map(bridge_device)
+      local api = bridge_device:get_field(Fields.BRIDGE_API)
+
+      if api == nil then
+        log.warn("Bridge api is nil, unable to do group scan")
+        -- Clear out tx for the next request
+        bridge_device:set_field(Fields.GROUPS_SCAN_QUEUE, nil)
+        return
+      end
+
+      grouped_utils.scan_groups(driver, bridge_device, api, hue_device_table)
+
+      -- Clear out tx for the next request
+      bridge_device:set_field(Fields.GROUPS_SCAN_QUEUE, nil)
+    end)
+    -- Set the queue to the tx
+    bridge_device:set_field(Fields.GROUPS_SCAN_QUEUE, tx)
+  else
+    -- Send on the tx that another request has come in.
+    queue:send(nil)
+  end
+end
+
 return grouped_utils

drivers/SmartThings/philips-hue/src/utils/hue_bridge_utils.lua

@@ -126,7 +126,7 @@ function hue_bridge_utils.do_bridge_network_init(driver, bridge_device, bridge_u
 
           ::continue::
         end
-        grouped_utils.scan_groups(driver, bridge_device, bridge_api, child_device_map)
+        grouped_utils.queue_group_scan(driver, bridge_device)
       end, string.format("Hue Bridge %s On Connect Task", bridge_device.label))
     end