Merge pull request #2577 from SmartThingsCommunity/zigbee-power-meter-lazy-load-subdrivers

CHAD-17041: zigbee-power-meter: lazy loading sub-drivers v2 changes

Author: aleclorimer

drivers/SmartThings/zigbee-power-meter/src/ezex/can_handle.lua

@@ -0,0 +1,15 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local is_ezex_power_meter = function(opts, driver, device)
+  local FINGERPRINTS = require("ezex.fingerprints")
+  for _, fingerprint in ipairs(FINGERPRINTS) do
+      if device:get_model() == fingerprint.model then
+          return true, require("ezex")
+      end
+  end
+
+  return false
+end
+
+return is_ezex_power_meter

drivers/SmartThings/zigbee-power-meter/src/ezex/fingerprints.lua

@@ -0,0 +1,8 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local ZIGBEE_POWER_METER_FINGERPRINTS = {
+  { model = "E240-KR080Z0-HA" }
+}
+
+return ZIGBEE_POWER_METER_FINGERPRINTS

drivers/SmartThings/zigbee-power-meter/src/ezex/init.lua

@@ -1,16 +1,6 @@
--- Copyright 2022 SmartThings
---
--- Licensed under the Apache License, Version 2.0 (the "License");
--- you may not use this file except in compliance with the License.
--- You may obtain a copy of the License at
---
---     http://www.apache.org/licenses/LICENSE-2.0
---
--- Unless required by applicable law or agreed to in writing, software
--- distributed under the License is distributed on an "AS IS" BASIS,
--- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
--- See the License for the specific language governing permissions and
--- limitations under the License.
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
 
 local capabilities = require "st.capabilities"
 local constants = require "st.zigbee.constants"
@@ -20,19 +10,7 @@ local ElectricalMeasurement = clusters.ElectricalMeasurement
 local energy_meter_defaults = require "st.zigbee.defaults.energyMeter_defaults"
 local configurations = require "configurations"
 
-local ZIGBEE_POWER_METER_FINGERPRINTS = {
-  { model = "E240-KR080Z0-HA" }
-}
 
-local is_ezex_power_meter = function(opts, driver, device)
-  for _, fingerprint in ipairs(ZIGBEE_POWER_METER_FINGERPRINTS) do
-      if device:get_model() == fingerprint.model then
-          return true
-      end
-  end
-
-  return false
-end
 
 local instantaneous_demand_configuration = {
   cluster = SimpleMetering.ID,
@@ -88,7 +66,7 @@ local ezex_power_meter_handler = {
     init = configurations.power_reconfig_wrapper(device_init),
     doConfigure = do_configure,
   },
-  can_handle = is_ezex_power_meter
+  can_handle = require("ezex.can_handle"),
 }
 
 return ezex_power_meter_handler

drivers/SmartThings/zigbee-power-meter/src/frient/can_handle.lua

@@ -0,0 +1,15 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local is_frient_power_meter = function(opts, driver, device)
+  local FINGERPRINTS = require("frient.fingerprints")
+  for _, fingerprint in ipairs(FINGERPRINTS) do
+    if device:get_model() == fingerprint.model then
+      return true, require("frient")
+    end
+  end
+
+  return false
+end
+
+return is_frient_power_meter

drivers/SmartThings/zigbee-power-meter/src/frient/fingerprints.lua

@@ -0,0 +1,9 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local ZIGBEE_POWER_METER_FINGERPRINTS = {
+  { model = "ZHEMI101" },
+  { model = "EMIZB-132" },
+}
+
+return ZIGBEE_POWER_METER_FINGERPRINTS

drivers/SmartThings/zigbee-power-meter/src/frient/init.lua

@@ -1,34 +1,11 @@
--- Copyright 2022 SmartThings
---
--- Licensed under the Apache License, Version 2.0 (the "License");
--- you may not use this file except in compliance with the License.
--- You may obtain a copy of the License at
---
---     http://www.apache.org/licenses/LICENSE-2.0
---
--- Unless required by applicable law or agreed to in writing, software
--- distributed under the License is distributed on an "AS IS" BASIS,
--- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
--- See the License for the specific language governing permissions and
--- limitations under the License.
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
 
 local constants = require "st.zigbee.constants"
 local configurations = require "configurations"
 
-local ZIGBEE_POWER_METER_FINGERPRINTS = {
-  { model = "ZHEMI101" },
-  { model = "EMIZB-132" },
-}
-
-local is_frient_power_meter = function(opts, driver, device)
-  for _, fingerprint in ipairs(ZIGBEE_POWER_METER_FINGERPRINTS) do
-    if device:get_model() == fingerprint.model then
-      return true
-    end
-  end
 
-  return false
-end
 
 local do_configure = function(self, device)
   device:refresh()
@@ -46,7 +23,7 @@ local frient_power_meter_handler = {
     init = configurations.power_reconfig_wrapper(device_init),
     doConfigure = do_configure,
   },
-  can_handle = is_frient_power_meter
+  can_handle = require("frient.can_handle"),
 }
 
 return frient_power_meter_handler

drivers/SmartThings/zigbee-power-meter/src/init.lua

@@ -1,16 +1,6 @@
--- Copyright 2022 SmartThings
---
--- Licensed under the Apache License, Version 2.0 (the "License");
--- you may not use this file except in compliance with the License.
--- You may obtain a copy of the License at
---
---     http://www.apache.org/licenses/LICENSE-2.0
---
--- Unless required by applicable law or agreed to in writing, software
--- distributed under the License is distributed on an "AS IS" BASIS,
--- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
--- See the License for the specific language governing permissions and
--- limitations under the License.
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
 
 local capabilities = require "st.capabilities"
 local ZigbeeDriver = require "st.zigbee"
@@ -63,11 +53,7 @@ local zigbee_power_meter_driver_template = {
     }
   },
   current_config_version = 1,
-  sub_drivers = {
-    require("ezex"),
-    require("frient"),
-    require("shinasystems"),
-  },
+  sub_drivers = require("sub_drivers"),
   lifecycle_handlers = {
     init = configurations.power_reconfig_wrapper(device_init),
     doConfigure = do_configure,

drivers/SmartThings/zigbee-power-meter/src/lazy_load_subdriver.lua

@@ -0,0 +1,15 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+return function(sub_driver_name)
+  -- gets the current lua libs api version
+  local version = require "version"
+  local ZigbeeDriver = require "st.zigbee"
+  if version.api >= 16 then
+    return ZigbeeDriver.lazy_load_sub_driver_v2(sub_driver_name)
+  elseif version.api >= 9 then
+    return ZigbeeDriver.lazy_load_sub_driver(require(sub_driver_name))
+  else
+    return require(sub_driver_name)
+  end
+end

drivers/SmartThings/zigbee-power-meter/src/shinasystems/can_handle.lua

@@ -0,0 +1,15 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local is_shinasystems_power_meter = function(opts, driver, device)
+  local FINGERPRINTS = require("shinasystems.fingerprints")
+  for _, fingerprint in ipairs(FINGERPRINTS) do
+    if device:get_model() == fingerprint.model then
+      return true, require("shinasystems")
+    end
+  end
+
+  return false
+end
+
+return is_shinasystems_power_meter

drivers/SmartThings/zigbee-power-meter/src/shinasystems/fingerprints.lua

@@ -0,0 +1,10 @@
+-- Copyright 2025 SmartThings, Inc.
+-- Licensed under the Apache License, Version 2.0
+
+local ZIGBEE_POWER_METER_FINGERPRINTS = {
+  { model = "PMM-300Z1" },
+  { model = "PMM-300Z2" },
+  { model = "PMM-300Z3" }
+}
+
+return ZIGBEE_POWER_METER_FINGERPRINTS