Add reconfiguration for zigbee power meter to reduce reporting

This will check devices on init to see if they support the clusters for power
reporting and if so schedules a 5 minute timer to check all devices in the
driver, and attempt to configure them to a lower reporting frequency.  It will
then mark the configuration version on the device to avoid it happening again.

Author: varzac

drivers/SmartThings/zigbee-switch/src/aqara/multi-switch/init.lua

@@ -2,6 +2,7 @@ local device_lib = require "st.device"
 local capabilities = require "st.capabilities"
 local cluster_base = require "st.zigbee.cluster_base"
 local data_types = require "st.zigbee.data_types"
+local configurations = require "configurations"
 
 local PRIVATE_CLUSTER_ID = 0xFCC0
 local PRIVATE_ATTRIBUTE_ID = 0x0009
@@ -100,7 +101,7 @@ end
 local aqara_multi_switch_handler = {
   NAME = "Aqara Multi Switch Handler",
   lifecycle_handlers = {
-    init = device_init,
+    init = configurations.power_reconfig_wrapper(device_init),
     added = device_added
   },
   can_handle = is_aqara_products

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

@@ -14,9 +14,15 @@
 
 local clusters = require "st.zigbee.zcl.clusters"
 local constants = require "st.zigbee.constants"
+local capabilities = require "st.capabilities"
+local device_def = require "st.device"
 
 local ColorControl = clusters.ColorControl
 local IASZone = clusters.IASZone
+local Status = require "st.zigbee.generated.types.ZclStatus"
+
+local CONFIGURATION_VERSION_KEY = "_configuration_version"
+local CONFIGURATION_ATTEMPTED = "_reconfiguration_attempted"
 
 local devices = {
   IKEA_RGB_BULB = {
@@ -60,8 +66,94 @@ local devices = {
   }
 }
 
+
 local configurations = {}
 
+local active_power_configuration = {
+  cluster = clusters.ElectricalMeasurement.ID,
+  attribute = clusters.ElectricalMeasurement.attributes.ActivePower.ID,
+  minimum_interval = 5,
+  maximum_interval = 3600,
+  data_type = clusters.ElectricalMeasurement.attributes.ActivePower.base_type,
+  reportable_change = 5
+}
+
+local instantaneous_demand_configuration = {
+  cluster = clusters.SimpleMetering.ID,
+  attribute = clusters.SimpleMetering.attributes.InstantaneousDemand.ID,
+  minimum_interval = 5,
+  maximum_interval = 3600,
+  data_type = clusters.SimpleMetering.attributes.InstantaneousDemand.base_type,
+  reportable_change = 5
+}
+
+configurations.check_and_reconfig_devices = function(driver)
+  for device_id, device in pairs(driver.device_cache) do
+    local config_version = device:get_field(CONFIGURATION_VERSION_KEY)
+    if config_version == nil or config_version < driver.current_config_version then
+      if device:supports_capability(capabilities.powerMeter) then
+        if device:supports_server_cluster(clusters.ElectricalMeasurement.ID) then
+          -- Increase minimum reporting interval to 5 seconds
+          device:send(clusters.ElectricalMeasurement.attributes.ActivePower:configure_reporting(device, 5, 600, 5))
+          device:add_configured_attribute(active_power_configuration)
+        end
+        if device:supports_server_cluster(clusters.SimpleMetering.ID) then
+          -- Increase minimum reporting interval to 5 seconds
+          device:send(clusters.SimpleMetering.attributes.InstantaneousDemand:configure_reporting(device, 5, 600, 5))
+          device:add_configured_attribute(instantaneous_demand_configuration)
+        end
+      end
+      device:set_field(CONFIGURATION_ATTEMPTED, true, {persist = true})
+    end
+  end
+  driver._reconfig_timer = nil
+end
+
+configurations.handle_reporting_config_response = function(driver, device, zb_mess)
+  local dev = device
+  local find_child_fn = device:get_field(device_def.FIND_CHILD_KEY)
+  if find_child_fn ~= nil then
+    local child = find_child_fn(device, zb_mess.address_header.src_endpoint.value)
+    if child ~= nil then
+      dev = child
+    end
+  end
+  if dev:get_field(CONFIGURATION_ATTEMPTED) == true then
+    if zb_mess.body.zcl_body.global_status ~= nil and zb_mess.body.zcl_body.global_status.value == Status.SUCCESS then
+      dev:set_field(CONFIGURATION_VERSION_KEY, driver.current_config_version, {persist = true})
+    elseif zb_mess.body.zcl_body.config_records ~= nil then
+      local config_records = zb_mess.body.zcl_body.config_records
+      for _, record in ipairs(config_records) do
+        if zb_mess.address_header.cluster.value == clusters.SimpleMetering.ID then
+          if record.attr_id.value == clusters.SimpleMetering.attributes.InstantaneousDemand.ID
+            and record.status.value == Status.SUCCESS then
+            dev:set_field(CONFIGURATION_VERSION_KEY, driver.current_config_version, {persist = true})
+          end
+        elseif zb_mess.address_header.cluster.value == clusters.ElectricalMeasurement.ID then
+          if record.attr_id.value == clusters.ElectricalMeasurement.attributes.ActivePower.ID
+            and record.status.value == Status.SUCCESS then
+            dev:set_field(CONFIGURATION_VERSION_KEY, driver.current_config_version, {persist = true})
+          end
+        end
+
+      end
+    end
+  end
+end
+
+configurations.power_reconfig_wrapper = function(orig_function)
+  local new_init = function(driver, device)
+    local config_version = device:get_field(CONFIGURATION_VERSION_KEY)
+    if config_version == nil or config_version < driver.current_config_version then
+      if driver._reconfig_timer == nil then
+        driver._reconfig_timer = driver:call_with_delay(5*60, configurations.check_and_reconfig_devices, "reconfig_power_devices")
+      end
+    end
+    orig_function(driver, device)
+  end
+  return new_init
+end
+
 configurations.get_device_configuration = function(zigbee_device)
   for _, device in pairs(devices) do
     for _, fingerprint in pairs(device.FINGERPRINTS) do

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

@@ -13,6 +13,7 @@
 -- limitations under the License.
 
 local zigbee_constants = require "st.zigbee.constants"
+local configurations = require "configurations"
 
 local ZIGBEE_METERING_SWITCH_FINGERPRINTS = {
   { model = "E240-KR116Z-HA" }
@@ -37,7 +38,7 @@ end
 local ezex_switch_handler = {
   NAME = "ezex switch handler",
   lifecycle_handlers = {
-    init = do_init
+    init = configurations.power_reconfig_wrapper(do_init)
   },
   can_handle = is_zigbee_ezex_switch
 }

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

@@ -13,6 +13,7 @@
 -- limitations under the License.
 
 local stDevice = require "st.device"
+local configurations = require "configurations"
 
 local FINGERPRINTS = {
   { mfr = "Winners", model = "LSS1-101", children = 0 },
@@ -78,7 +79,7 @@ local HanssemSwitch = {
   NAME = "Zigbee Hanssem Switch",
   lifecycle_handlers = {
     added = device_added,
-    init = device_init
+    init = configurations.power_reconfig_wrapper(device_init)
   },
   can_handle = can_handle_hanssem_switch
 }

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

@@ -17,7 +17,9 @@ local ZigbeeDriver = require "st.zigbee"
 local defaults = require "st.zigbee.defaults"
 local clusters = require "st.zigbee.zcl.clusters"
 local configurationMap = require "configurations"
+local zcl_global_commands = require "st.zigbee.zcl.global_commands"
 local SimpleMetering = clusters.SimpleMetering
+local ElectricalMeasurement = clusters.ElectricalMeasurement
 local preferences = require "preferences"
 local device_lib = require "st.device"
 
@@ -127,6 +129,7 @@ local function device_added(driver, device, event)
   end
 end
 
+
 local zigbee_switch_driver_template = {
   supported_capabilities = {
     capabilities.switch,
@@ -164,8 +167,19 @@ local zigbee_switch_driver_template = {
     lazy_load_if_possible("laisiao"),
     lazy_load_if_possible("tuya-multi")
   },
+  zigbee_handlers = {
+    global = {
+      [SimpleMetering.ID] = {
+        [zcl_global_commands.CONFIGURE_REPORTING_RESPONSE_ID] = configurationMap.handle_reporting_config_response
+      },
+     [ElectricalMeasurement.ID] = {
+        [zcl_global_commands.CONFIGURE_REPORTING_RESPONSE_ID] = configurationMap.handle_reporting_config_response
+      }
+    }
+  },
+  current_config_version = 1,
   lifecycle_handlers = {
-    init = device_init,
+    init = configurationMap.power_reconfig_wrapper(device_init),
     added = device_added,
     infoChanged = info_changed,
     doConfigure = do_configure

drivers/SmartThings/zigbee-switch/src/inovelli-vzm31-sn/init.lua

@@ -19,6 +19,7 @@ local st_device = require "st.device"
 local data_types = require "st.zigbee.data_types"
 local capabilities = require "st.capabilities"
 local device_management = require "st.zigbee.device_management"
+local configurations = require "configurations"
 
 local LATEST_CLOCK_SET_TIMESTAMP = "latest_clock_set_timestamp"
 
@@ -358,7 +359,7 @@ local inovelli_vzm31_sn = {
   NAME = "inovelli vzm31-sn handler",
   lifecycle_handlers = {
     doConfigure = do_configure,
-    init = device_init,
+    init = configurations.power_reconfig_wrapper(device_init),
     infoChanged = info_changed
   },
   zigbee_handlers = {

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

@@ -14,6 +14,7 @@
 
 local capabilities = require "st.capabilities"
 local zcl_clusters = require "st.zigbee.zcl.clusters"
+local configurations = require "configurations"
 
 local FINGERPRINTS = {
   { mfr = "LAISIAO", model = "yuba" },
@@ -70,7 +71,7 @@ local laisiao_bath_heater = {
     capabilities.switch,
   },
   lifecycle_handlers = {
-    init = device_init,
+    init = configurations.power_reconfig_wrapper(device_init),
   },
   capability_handlers = {
     [capabilities.switch.ID] = {

drivers/SmartThings/zigbee-switch/src/multi-switch-no-master/init.lua

@@ -13,6 +13,7 @@
 -- limitations under the License.
 local st_device = require "st.device"
 local utils = require "st.utils"
+local configurations = require "configurations"
 
 local MULTI_SWITCH_NO_MASTER_FINGERPRINTS = {
   { mfr = "DAWON_DNS", model = "PM-S240-ZB", children = 1 },
@@ -113,7 +114,7 @@ end
 local multi_switch_no_master = {
   NAME = "multi switch no master",
   lifecycle_handlers = {
-    init = device_init,
+    init = configurations.power_reconfig_wrapper(device_init),
     added = device_added
   },
   can_handle = is_multi_switch_no_master

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

@@ -15,6 +15,7 @@
 local constants = require "st.zigbee.constants"
 local zcl_clusters = require "st.zigbee.zcl.clusters"
 local capabilities = require "st.capabilities"
+local configurations = require "configurations"
 local SimpleMetering = zcl_clusters.SimpleMetering
 
 local ROBB_DIMMER_FINGERPRINTS = {
@@ -57,7 +58,7 @@ local robb_dimmer_handler = {
     }
   },
   lifecycle_handlers = {
-    init = do_init
+    init = configurations.power_reconfig_wrapper(do_init)
   },
   can_handle = is_robb_dimmer
 }