general cleanup

Author: nickolas-deboom

drivers/SmartThings/matter-switch/src/button-utils.lua

@@ -13,8 +13,8 @@
 -- limitations under the License.
 
 local capabilities = require "st.capabilities"
-local common_utils = require "common-utils"
 local clusters = require "st.matter.clusters"
+local common_utils = require "common-utils"
 local log = require "log"
 local lua_socket = require "socket"
 
@@ -39,7 +39,7 @@ button_utils.STATIC_BUTTON_PROFILE_SUPPORTED = {1, 2, 3, 4, 5, 6, 7, 8}
 local function create_multi_press_values_list(size, supportsHeld)
   local list = {"pushed", "double"}
   if supportsHeld then table.insert(list, "held") end
-  -- add multi press values of 3 or greater to the list
+  -- Add multi press values of 3 or greater to the list
   for i = 3, size do
     table.insert(list, string.format("pushed_%dx", i))
   end
@@ -72,7 +72,7 @@ function button_utils.configure_buttons(device)
     if device.profile.components[common_utils.endpoint_to_component(device, ep)] then
       device.log.info_with({hub_logs=true}, string.format("Configuring Supported Values for generic switch endpoint %d", ep))
       local supportedButtonValues_event
-      -- this ordering is important, since MSM & MSL devices must also support MSR
+      -- This ordering is important, since MSM & MSL devices must also support MSR
       if common_utils.tbl_contains(msm_eps, ep) then
         supportedButtonValues_event = nil -- deferred to the max press handler
         device:send(clusters.Switch.attributes.MultiPressMax:read(device, ep))
@@ -97,7 +97,7 @@ function button_utils.configure_buttons(device)
 end
 
 function button_utils.build_button_component_map(device, main_endpoint, button_eps)
-  -- create component mapping on the main profile button endpoints
+  -- Create component mapping on the main profile button endpoints
   table.sort(button_eps)
   local component_map = {}
   component_map["main"] = main_endpoint
@@ -133,13 +133,13 @@ function button_utils.initial_press_event_handler(driver, device, ib, response)
   elseif common_utils.get_field_for_endpoint(device, INITIAL_PRESS_ONLY, ib.endpoint_id) then
     device:emit_event_for_endpoint(ib.endpoint_id, capabilities.button.button.pushed({state_change = true}))
   elseif common_utils.get_field_for_endpoint(device, EMULATE_HELD, ib.endpoint_id) then
-    -- if our button doesn't differentiate between short and long holds, do it in code by keeping track of the press down time
+    -- If our button doesn't differentiate between short and long holds, do it in code by keeping track of the press down time
     init_press(device, ib.endpoint_id)
   end
 end
 
--- if the device distinguishes a long press event, it will always be a "held"
--- there's also a "long release" event, but this event is required to come first
+-- If the device distinguishes a long press event, it will always be a "held".
+-- There's also a "long release" event, but this event is required to come first.
 function button_utils.long_press_event_handler(driver, device, ib, response)
   device:emit_event_for_endpoint(ib.endpoint_id, capabilities.button.button.held({state_change = true}))
   if common_utils.get_field_for_endpoint(device, SUPPORTS_MULTI_PRESS, ib.endpoint_id) then
@@ -159,12 +159,9 @@ function button_utils.short_release_event_handler(driver, device, ib, response)
 end
 
 function button_utils.multi_press_complete_event_handler(driver, device, ib, response)
-  -- in the case of multiple button presses
-  -- emit number of times, multiple presses have been completed
   if ib.data and not common_utils.get_field_for_endpoint(device, IGNORE_NEXT_MPC, ib.endpoint_id) then
     local press_value = ib.data.elements.total_number_of_presses_counted.value
-    --capability only supports up to 6 presses
-    if press_value < 7 then
+    if press_value < 7 then -- button capability only supports up to 6 presses
       local button_event = capabilities.button.button.pushed({state_change = true})
       if press_value == 2 then
         button_event = capabilities.button.button.double({state_change = true})
@@ -180,15 +177,13 @@ function button_utils.multi_press_complete_event_handler(driver, device, ib, res
 end
 
 function button_utils.max_press_handler(driver, device, ib, response)
-  local max = ib.data.value or 1 -- get max number of presses
-  device.log.debug("Device supports "..max.." presses")
-  -- capability only supports up to 6 presses
-  if max > 6 then
+  local max = ib.data.value or 1
+  if max > 6 then -- button capability only supports up to 6 presses
     log.info("Device supports more than 6 presses")
     max = 6
   end
-  local MSL = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH_LONG_PRESS})
-  local supportsHeld = common_utils.tbl_contains(MSL, ib.endpoint_id)
+  local msl_eps = device:get_endpoints(clusters.Switch.ID, {feature_bitmap=clusters.Switch.types.SwitchFeature.MOMENTARY_SWITCH_LONG_PRESS})
+  local supportsHeld = common_utils.tbl_contains(msl_eps, ib.endpoint_id)
   local values = create_multi_press_values_list(max, supportsHeld)
   device:emit_event_for_endpoint(ib.endpoint_id, capabilities.button.supportedButtonValues(values, {visibility = {displayed = false}}))
 end

drivers/SmartThings/matter-switch/src/common-utils.lua

@@ -203,7 +203,7 @@ end
 function common_utils.is_eve_energy_products(opts, driver, device)
   -- this sub driver does not support child devices
   if device.network_type == device_lib.NETWORK_TYPE_MATTER and
-     device.manufacturer_info.vendor_id == EVE_MANUFACTURER_ID then
+    device.manufacturer_info.vendor_id == EVE_MANUFACTURER_ID then
     return true
   end
   log.info("Using Eve Energy sub driver")
@@ -212,8 +212,8 @@ end
 
 function common_utils.is_third_reality_mk1(opts, driver, device)
   if device.network_type == device_lib.NETWORK_TYPE_MATTER and
-     device.manufacturer_info.vendor_id == THIRD_REALITY_MK1_FINGERPRINT.vendor_id and
-     device.manufacturer_info.product_id == THIRD_REALITY_MK1_FINGERPRINT.product_id then
+    device.manufacturer_info.vendor_id == THIRD_REALITY_MK1_FINGERPRINT.vendor_id and
+    device.manufacturer_info.product_id == THIRD_REALITY_MK1_FINGERPRINT.product_id then
     log.info("Using Third Reality MK1 sub driver")
     return true
   end
@@ -222,9 +222,9 @@ end
 
 function common_utils.is_static_profile_device(opts, driver, device)
   if not common_utils.is_aqara_cube(opts, driver, device) and
-     not common_utils.is_eve_energy_products(opts, driver, device) and
-     not common_utils.is_third_reality_mk1(opts, driver, device) and
-     not common_utils.supports_modular_profile(device) then
+    not common_utils.is_eve_energy_products(opts, driver, device) and
+    not common_utils.is_third_reality_mk1(opts, driver, device) and
+    not common_utils.supports_modular_profile(device) then
     log.info("Using Static Profile sub driver")
     return true
   end
@@ -384,7 +384,6 @@ end
 
 local function assign_child_profile(device, child_ep)
   local profile
-
   for _, ep in ipairs(device.endpoints) do
     if ep.endpoint_id == child_ep then
       -- Some devices report multiple device types which are a subset of
@@ -400,7 +399,6 @@ local function assign_child_profile(device, child_ep)
       break
     end
   end
-
   -- Check if device has an overridden child profile that differs from the profile that would match
   -- the child's device type for the following two cases:
   --   1. To add Electrical Sensor only to the first EDGE_CHILD (light-power-energy-powerConsumption)
@@ -416,8 +414,7 @@ local function assign_child_profile(device, child_ep)
       end
     end
   end
-
-  -- default to "switch-binary" if no profile is found
+  -- Default to "switch-binary" if no profile is found
   return profile or "switch-binary"
 end
 
@@ -444,20 +441,18 @@ function common_utils.build_child_switch_profiles(driver, device, main_endpoint)
         )
         parent_child_device = true
         if _ == 1 and string.find(child_profile, "energy") then
-          -- when energy management is defined in the root endpoint(0), replace it with the first switch endpoint and process it.
+          -- When energy management is defined in the root endpoint(0), replace it with
+          -- the first switch endpoint and process it.
           device:set_field(common_utils.ENERGY_MANAGEMENT_ENDPOINT, ep, {persist = true})
         end
       end
     end
   end
-
-  -- If the device is a parent child device, set the find_child function on init. This is persisted because initialize_buttons_and_switches
-  -- is only run once, but find_child function should be set on each driver init.
+  -- If the device is a parent child device, set the field and persist because the
+  -- find_child function should be set on each driver init.
   if parent_child_device then
     device:set_field(common_utils.IS_PARENT_CHILD_DEVICE, true, {persist = true})
   end
-
-  -- this is needed in initialize_buttons_and_switches
   return num_switch_server_eps
 end
 

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

@@ -14,16 +14,16 @@
 
 local button_utils = require "button-utils"
 local capabilities = require "st.capabilities"
+local clusters = require "st.matter.clusters"
 local color_utils = require "color-utils"
 local common_utils = require "common-utils"
-local log = require "log"
-local clusters = require "st.matter.clusters"
+local device_lib = require "st.device"
+local embedded_cluster_utils = require "embedded-cluster-utils"
 local im = require "st.matter.interaction_model"
+local log = require "log"
 local MatterDriver = require "st.matter.driver"
 local modular_profiles_utils = require "modular-profiles-utils"
 local utils = require "st.utils"
-local device_lib = require "st.device"
-local embedded_cluster_utils = require "embedded-cluster-utils"
 local version = require "version"
 
 -- Include driver-side definitions when lua libs api version is < 11
@@ -55,6 +55,9 @@ local LEVEL_BOUND_RECEIVED = "__level_bound_received"
 local LEVEL_MIN = "__level_min"
 local LEVEL_MAX = "__level_max"
 local COLOR_MODE = "__color_mode"
+local TEMP_BOUND_RECEIVED = "__temp_bound_received"
+local TEMP_MIN = "__temp_min"
+local TEMP_MAX = "__temp_max"
 
 local HUE_SAT_COLOR_MODE = clusters.ColorControl.types.ColorMode.CURRENT_HUE_AND_CURRENT_SATURATION
 local X_Y_COLOR_MODE = clusters.ColorControl.types.ColorMode.CURRENTX_AND_CURRENTY
@@ -127,7 +130,7 @@ end
 local function set_poll_report_timer_and_schedule(device, is_cumulative_report)
   local cumul_eps = embedded_cluster_utils.get_endpoints(device,
     clusters.ElectricalEnergyMeasurement.ID,
-    {feature_bitmap = clusters.ElectricalEnergyMeasurement.types.Feature.CUMULATIVE_ENERGY })
+    {feature_bitmap = clusters.ElectricalEnergyMeasurement.types.Feature.CUMULATIVE_ENERGY})
   if #cumul_eps == 0 then
     device:set_field(CUMULATIVE_REPORTS_NOT_SUPPORTED, true, {persist = true})
   end
@@ -152,10 +155,6 @@ local function set_poll_report_timer_and_schedule(device, is_cumulative_report)
   end
 end
 
-local TEMP_BOUND_RECEIVED = "__temp_bound_received"
-local TEMP_MIN = "__temp_min"
-local TEMP_MAX = "__temp_max"
-
 local function convert_huesat_st_to_matter(val)
   return utils.clamp_value(math.floor((val * 0xFE) / 100.0 + 0.5), CURRENT_HUESAT_ATTR_MIN, CURRENT_HUESAT_ATTR_MAX)
 end
@@ -385,15 +384,15 @@ local function level_attr_handler(driver, device, ib, response)
 end
 
 local function hue_attr_handler(driver, device, ib, response)
-  if device:get_field(COLOR_MODE) == X_Y_COLOR_MODE  or ib.data.value == nil then
+  if device:get_field(COLOR_MODE) == X_Y_COLOR_MODE or ib.data.value == nil then
     return
   end
   local hue = math.floor((ib.data.value / 0xFE * 100) + 0.5)
   device:emit_event_for_endpoint(ib.endpoint_id, capabilities.colorControl.hue(hue))
 end
 
 local function sat_attr_handler(driver, device, ib, response)
-  if device:get_field(COLOR_MODE) == X_Y_COLOR_MODE  or ib.data.value == nil then
+  if device:get_field(COLOR_MODE) == X_Y_COLOR_MODE or ib.data.value == nil then
     return
   end
   local sat = math.floor((ib.data.value / 0xFE * 100) + 0.5)

drivers/SmartThings/matter-switch/src/modular-profiles-utils.lua

@@ -14,8 +14,8 @@
 
 local button_utils = require "button-utils"
 local capabilities = require "st.capabilities"
-local common_utils = require "common-utils"
 local clusters = require "st.matter.clusters"
+local common_utils = require "common-utils"
 
 local modular_profiles_utils = {}
 
@@ -104,19 +104,6 @@ local function supports_capability_by_id_modular(device, capability, component)
   return false
 end
 
-local function add_energy_and_power_capabilities(component_capabilities, num_energy_eps, num_power_eps)
-  if num_energy_eps > 0 and num_power_eps > 0 then
-    table.insert(component_capabilities, capabilities.powerMeter.ID)
-    table.insert(component_capabilities, capabilities.energyMeter.ID)
-    table.insert(component_capabilities, capabilities.powerConsumptionReport.ID)
-  elseif num_energy_eps > 0 then
-    table.insert(component_capabilities, capabilities.energyMeter.ID)
-    table.insert(component_capabilities, capabilities.powerConsumptionReport.ID)
-  elseif num_power_eps > 0 then
-    table.insert(component_capabilities, capabilities.powerMeter.ID)
-  end
-end
-
 local function add_battery_capability(component_capabilities, battery_attr_support)
   if battery_attr_support == common_utils.battery_support.BATTERY_PERCENTAGE then
     table.insert(component_capabilities, capabilities.battery.ID)
@@ -198,14 +185,14 @@ end
 local function match_modular_profile(driver, device, battery_attr_support)
   local main_endpoint = common_utils.find_default_endpoint(device)
   local color_hs_eps = device:get_endpoints(clusters.ColorControl.ID, {feature_bitmap = clusters.ColorControl.types.Feature.HS})
-  local color_temp_eps = device:get_endpoints(clusters.ColorControl.ID, {feature_bitmap = clusters.ColorControl.types.Feature.CT})
   local color_xy_eps = device:get_endpoints(clusters.ColorControl.ID, {feature_bitmap = clusters.ColorControl.types.Feature.XY})
-  local energy_eps = device:get_endpoints(clusters.ElectricalEnergyMeasurement.ID)
-  local fan_eps = device:get_endpoints(clusters.FanControl.ID)
-  local humidity_eps = device:get_endpoints(clusters.RelativeHumidityMeasurement.ID)
+  local color_temp_eps = device:get_endpoints(clusters.ColorControl.ID, {feature_bitmap = clusters.ColorControl.types.Feature.CT})
   local level_eps = device:get_endpoints(clusters.LevelControl.ID)
   local power_eps = device:get_endpoints(clusters.ElectricalPowerMeasurement.ID)
+  local energy_eps = device:get_endpoints(clusters.ElectricalEnergyMeasurement.ID)
   local switch_eps = device:get_endpoints(clusters.OnOff.ID)
+  local fan_eps = device:get_endpoints(clusters.FanControl.ID)
+  local humidity_eps = device:get_endpoints(clusters.RelativeHumidityMeasurement.ID)
   local temperature_eps = device:get_endpoints(clusters.TemperatureMeasurement.ID)
   local valve_eps = device:get_endpoints(clusters.ValveConfigurationAndControl.ID)
 
@@ -215,8 +202,7 @@ local function match_modular_profile(driver, device, battery_attr_support)
   local main_component_capabilities = {}
   local extra_component_capabilities = {}
 
-  local MAIN_COMPONENT_IDX = 1
-  local CAPABILITIES_LIST_IDX = 2
+  local MAIN_COMPONENT_IDX, CAPABILITIES_LIST_IDX = 1, 2
 
   add_button_capabilities(device, category, main_endpoint, main_component_capabilities, extra_component_capabilities, battery_attr_support)
 
@@ -234,17 +220,15 @@ local function match_modular_profile(driver, device, battery_attr_support)
     table.insert(main_component_capabilities, capabilities.switchLevel.ID)
   end
 
-  if #fan_eps > 0 then
-    table.insert(main_component_capabilities, capabilities.fanMode.ID)
-    table.insert(main_component_capabilities, capabilities.fanSpeedPercent.ID)
+  if #power_eps > 0 then
+    table.insert(main_component_capabilities, capabilities.powerMeter.ID)
   end
 
-  if #humidity_eps > 0 then
-    table.insert(main_component_capabilities, capabilities.relativeHumidityMeasurement.ID)
+  if #energy_eps > 0 then
+    table.insert(main_component_capabilities, capabilities.energyMeter.ID)
+    table.insert(main_component_capabilities, capabilities.powerConsumptionReport.ID)
   end
 
-  add_energy_and_power_capabilities(main_component_capabilities, #energy_eps, #power_eps)
-
   if #switch_eps > 0 then
     -- If the device is a Button or Water Valve, add the switch capability since
     -- it is not a mandatory capability for these device types.
@@ -261,6 +245,15 @@ local function match_modular_profile(driver, device, battery_attr_support)
     end
   end
 
+  if #fan_eps > 0 then
+    table.insert(main_component_capabilities, capabilities.fanMode.ID)
+    table.insert(main_component_capabilities, capabilities.fanSpeedPercent.ID)
+  end
+
+  if #humidity_eps > 0 then
+    table.insert(main_component_capabilities, capabilities.relativeHumidityMeasurement.ID)
+  end
+
   if #temperature_eps > 0 then
     table.insert(main_component_capabilities, capabilities.temperatureMeasurement.ID)
   end
@@ -278,19 +271,18 @@ local function match_modular_profile(driver, device, battery_attr_support)
     table.insert(optional_supported_component_capabilities, component_capability)
   end
 
-  local total_supported_capabilities = optional_supported_component_capabilities
-
   device:try_update_metadata({profile = profile_name_and_mandatory_capability_per_device_category[category].profile_name,
                               optional_component_capabilities = optional_supported_component_capabilities})
 
-  -- add mandatory capabilities for subscription
+  local total_supported_capabilities = optional_supported_component_capabilities
+  -- Add mandatory capabilities for subscription
   table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX],
     profile_name_and_mandatory_capability_per_device_category[category].mandatory_capability)
   table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.refresh.ID)
   table.insert(total_supported_capabilities[MAIN_COMPONENT_IDX][CAPABILITIES_LIST_IDX], capabilities.firmwareUpdate.ID)
 
   device:set_field(modular_profiles_utils.SUPPORTED_COMPONENT_CAPABILITIES, total_supported_capabilities, {persist = true})
-  -- re-up subscription with new capabilities using the modular supports_capability override
+  -- Re-up subscription with new capabilities using the modular supports_capability override
   device:extend_device("supports_capability_by_id", supports_capability_by_id_modular)
 end