move consts to switch_utils

Author: wkhenon

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

@@ -4,27 +4,21 @@
 local capabilities = require "st.capabilities"
 local clusters = require "st.zigbee.zcl.clusters"
 local utils = require "st.utils"
-local KELVIN_MAX = "_max_kelvin"
-local KELVIN_MIN = "_min_kelvin"
-local MIREDS_CONVERSION_CONSTANT = 1000000
-local COLOR_TEMPERATURE_KELVIN_MAX = 15000
-local COLOR_TEMPERATURE_KELVIN_MIN = 1000
-local COLOR_TEMPERATURE_MIRED_MAX = utils.round(MIREDS_CONVERSION_CONSTANT/COLOR_TEMPERATURE_KELVIN_MIN) -- 1000
-local COLOR_TEMPERATURE_MIRED_MIN = utils.round(MIREDS_CONVERSION_CONSTANT/COLOR_TEMPERATURE_KELVIN_MAX) -- 67
+local switch_utils = require "switch_utils"
 
 local function color_temp_min_mireds_handler(driver, device, value, zb_rx)
   local temp_in_mired = value.value
   local endpoint = zb_rx.address_header.src_endpoint.value
   if temp_in_mired == nil then
     return
   end
-  if (temp_in_mired < COLOR_TEMPERATURE_MIRED_MIN or temp_in_mired > COLOR_TEMPERATURE_MIRED_MAX) then
-    device.log.warn_with({hub_logs = true}, string.format("Device reported a color temperature %d mired outside of sane range of %.2f-%.2f", temp_in_mired, COLOR_TEMPERATURE_MIRED_MIN, COLOR_TEMPERATURE_MIRED_MAX))
+  if (temp_in_mired < switch_utils.COLOR_TEMPERATURE_MIRED_MIN or temp_in_mired > switch_utils.COLOR_TEMPERATURE_MIRED_MAX) then
+    device.log.warn_with({hub_logs = true}, string.format("Device reported a color temperature %d mired outside of sane range of %.2f-%.2f", temp_in_mired, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX))
     return
   end
-  local temp_in_kelvin = utils.round(MIREDS_CONVERSION_CONSTANT / temp_in_mired)
-  device:set_field(KELVIN_MAX..endpoint, temp_in_kelvin)
-  local min = device:get_field(KELVIN_MIN..endpoint)
+  local temp_in_kelvin = utils.round(switch_utils.MIREDS_CONVERSION_CONSTANT / temp_in_mired)
+  device:set_field(switch_utils.KELVIN_MAX..endpoint, temp_in_kelvin)
+  local min = device:get_field(switch_utils.KELVIN_MIN..endpoint)
   if min ~= nil then
     if temp_in_kelvin > min then
       device:emit_event_for_endpoint(endpoint, capabilities.colorTemperature.colorTemperatureRange({ value = {minimum = min, maximum = temp_in_kelvin}}))
@@ -40,13 +34,13 @@ local function color_temp_max_mireds_handler(driver, device, value, zb_rx)
   if temp_in_mired == nil then
     return
   end
-  if (temp_in_mired < COLOR_TEMPERATURE_MIRED_MIN or temp_in_mired > COLOR_TEMPERATURE_MIRED_MAX) then
-    device.log.warn_with({hub_logs = true}, string.format("Device reported a color temperature %d mired outside of sane range of %.2f-%.2f", temp_in_mired, COLOR_TEMPERATURE_MIRED_MIN, COLOR_TEMPERATURE_MIRED_MAX))
+  if (temp_in_mired < switch_utils.COLOR_TEMPERATURE_MIRED_MIN or temp_in_mired > switch_utils.COLOR_TEMPERATURE_MIRED_MAX) then
+    device.log.warn_with({hub_logs = true}, string.format("Device reported a color temperature %d mired outside of sane range of %.2f-%.2f", temp_in_mired, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX))
     return
   end
-  local temp_in_kelvin = utils.round(MIREDS_CONVERSION_CONSTANT / temp_in_mired)
-  device:set_field(KELVIN_MIN..endpoint, temp_in_kelvin)
-  local max = device:get_field(KELVIN_MAX..endpoint)
+  local temp_in_kelvin = utils.round(switch_utils.MIREDS_CONVERSION_CONSTANT / temp_in_mired)
+  device:set_field(switch_utils.KELVIN_MIN..endpoint, temp_in_kelvin)
+  local max = device:get_field(switch_utils.KELVIN_MAX..endpoint)
   if max ~= nil then
     if temp_in_kelvin < max then
       device:emit_event_for_endpoint(endpoint, capabilities.colorTemperature.colorTemperatureRange({ value = {minimum = temp_in_kelvin, maximum = max}}))

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

@@ -4,14 +4,7 @@
 local capabilities = require "st.capabilities"
 local st_utils = require "st.utils"
 local clusters = require "st.zigbee.zcl.clusters"
-
-local KELVIN_MAX = "_max_kelvin"
-local KELVIN_MIN = "_min_kelvin"
-local MIREDS_CONVERSION_CONSTANT = 1000000
-local COLOR_TEMPERATURE_KELVIN_MAX = 15000
-local COLOR_TEMPERATURE_KELVIN_MIN = 1000
-local COLOR_TEMPERATURE_MIRED_MAX = st_utils.round(MIREDS_CONVERSION_CONSTANT/COLOR_TEMPERATURE_KELVIN_MIN) -- 1000
-local COLOR_TEMPERATURE_MIRED_MIN = st_utils.round(MIREDS_CONVERSION_CONSTANT/COLOR_TEMPERATURE_KELVIN_MAX) -- 67
+local switch_utils = require "switch_utils"
 
 -- Transition Time: The time that shall be taken to perform the step change, in units of 1/10ths of a second.
 local TRANSITION_TIME = 3 -- default: 0.3 seconds
@@ -23,6 +16,7 @@ local function step_color_temperature_by_percent_handler(driver, device, cmd)
     local step_percent_change = cmd.args and cmd.args.stepSize or 0
     if step_percent_change == 0 then return end
     local step_mode = step_percent_change > 0 and clusters.ColorControl.types.CcStepMode.DOWN or clusters.ColorControl.types.CcStepMode.UP
+
     local color_temp_range = device:get_latest_state("main", capabilities.colorTemperature.ID, capabilities.colorTemperature.colorTemperatureRange.NAME);
     local min_mireds = (color_temp_range and (device:get_field(KELVIN_MIN) or st_utils.round(MIREDS_CONVERSION_CONSTANT/color_temp_range.maximum))) or COLOR_TEMPERATURE_MIRED_MIN
     local max_mireds = (color_temp_range and (device:get_field(KELVIN_MAX) or st_utils.round(MIREDS_CONVERSION_CONSTANT/color_temp_range.minimum))) or COLOR_TEMPERATURE_MIRED_MAX

drivers/SmartThings/zigbee-switch/src/switch_utils.lua

@@ -1,8 +1,17 @@
 -- Copyright 2025 SmartThings, Inc.
 -- Licensed under the Apache License, Version 2.0
+local utils = require "st.utils"
 
 local switch_utils = {}
 
+switch_utils.KELVIN_MAX = "_max_kelvin"
+switch_utils.KELVIN_MIN = "_min_kelvin"
+switch_utils.MIREDS_CONVERSION_CONSTANT = 1000000
+switch_utils.COLOR_TEMPERATURE_KELVIN_MAX = 15000
+switch_utils.COLOR_TEMPERATURE_KELVIN_MIN = 1000
+switch_utils.COLOR_TEMPERATURE_MIRED_MAX = utils.round(switch_utils.MIREDS_CONVERSION_CONSTANT/switch_utils.COLOR_TEMPERATURE_KELVIN_MIN) -- 1000
+switch_utils.COLOR_TEMPERATURE_MIRED_MIN = utils.round(switch_utils.MIREDS_CONVERSION_CONSTANT/switch_utils.COLOR_TEMPERATURE_KELVIN_MAX) -- 67
+
 switch_utils.emit_event_if_latest_state_missing = function(device, component, capability, attribute_name, value)
   if device:get_latest_state(component, capability.ID, attribute_name) == nil then
     device:emit_event(value)

drivers/SmartThings/zigbee-switch/src/test/test_all_capability_zigbee_bulb.lua

@@ -14,6 +14,7 @@ local zigbee_test_utils = require "integration_test.zigbee_test_utils"
 local messages = require "st.zigbee.messages"
 local config_reporting_response = require "st.zigbee.zcl.global_commands.configure_reporting_response"
 local zb_const = require "st.zigbee.constants"
+local switch_utils = require "switch_utils"
 local zcl_messages = require "st.zigbee.zcl"
 local data_types = require "st.zigbee.data_types"
 local Status = require "st.zigbee.generated.types.ZclStatus"
@@ -312,7 +313,7 @@ test.register_message_test(
       direction = "send",
       message = {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 187, 3, zb_const.COLOR_TEMPERATURE_MIRED_MIN, zb_const.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 187, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       },
     },
     {
@@ -328,7 +329,7 @@ test.register_message_test(
       direction = "send",
       message = {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 840, 3, zb_const.COLOR_TEMPERATURE_MIRED_MIN, zb_const.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 840, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       },
     },
     {
@@ -344,7 +345,7 @@ test.register_message_test(
       direction = "send",
       message = {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.UP, 467, 3, zb_const.COLOR_TEMPERATURE_MIRED_MIN, zb_const.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.UP, 467, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       },
     }
   }

drivers/SmartThings/zigbee-switch/src/test/test_rgbw_bulb.lua

@@ -4,7 +4,7 @@
 local test = require "integration_test"
 local t_utils = require "integration_test.utils"
 local clusters = require "st.zigbee.zcl.clusters"
-local constants = require "st.zigbee.constants"
+local switch_utils = require "switch_utils"
 local zigbee_test_utils = require "integration_test.zigbee_test_utils"
 
 local OnOff = clusters.OnOff
@@ -341,7 +341,7 @@ test.register_message_test(
       direction = "send",
       message = {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 187, 3, constants.COLOR_TEMPERATURE_MIRED_MIN, constants.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 187, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       },
     },
     {
@@ -357,7 +357,7 @@ test.register_message_test(
       direction = "send",
       message = {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 840, 3, constants.COLOR_TEMPERATURE_MIRED_MIN, constants.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 840, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       },
     },
     {
@@ -373,7 +373,7 @@ test.register_message_test(
       direction = "send",
       message = {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.UP, 467, 3, constants.COLOR_TEMPERATURE_MIRED_MIN, constants.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.UP, 467, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       },
     }
   }

drivers/SmartThings/zigbee-switch/src/test/test_sengled_color_temp_bulb.lua

@@ -4,7 +4,7 @@
 local test = require "integration_test"
 local t_utils = require "integration_test.utils"
 local clusters = require "st.zigbee.zcl.clusters"
-local zb_const = require "st.zigbee.constants"
+local switch_utils = require "switch_utils"
 local zigbee_test_utils = require "integration_test.zigbee_test_utils"
 
 local OnOff = clusters.OnOff
@@ -191,7 +191,7 @@ test.register_coroutine_test(
     test.socket.zigbee:__expect_send(
       {
         mock_device.id,
-        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 187, 3, zb_const.COLOR_TEMPERATURE_MIRED_MIN, zb_const.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
+        ColorControl.server.commands.StepColorTemperature(mock_device, ColorControl.types.CcStepMode.DOWN, 187, 3, switch_utils.COLOR_TEMPERATURE_MIRED_MIN, switch_utils.COLOR_TEMPERATURE_MIRED_MAX, 0x01, 0x00)
       }
     )
     test.wait_for_events()