integrate per/cum energyMeter handling, only emit powerConsumptionReport for single ep

Author: hcarter-775

drivers/SmartThings/matter-switch/src/generic_handlers/attribute_handlers.lua

@@ -277,7 +277,9 @@ end
 
 -- [[ ELECTRICAL ENERGY MEASUREMENT CLUSTER ATTRIBUTES ]] --
 
-local function report_power_consumption_to_st_energy(device, endpoint_id, latest_total_imported_energy_wh)
+local function report_power_consumption_to_st_energy(device, total_imported_energy_wh)
+  device:set_field(fields.TOTAL_IMPORTED_ENERGY, total_imported_energy_wh, { persist = true })
+
   local current_time = os.time()
   local last_time = device:get_field(fields.LAST_IMPORTED_REPORT_TIMESTAMP) or 0
 
@@ -287,54 +289,45 @@ local function report_power_consumption_to_st_energy(device, endpoint_id, latest
   end
   device:set_field(fields.LAST_IMPORTED_REPORT_TIMESTAMP, current_time, { persist = true })
 
-  local state_device = switch_utils.find_child(device, endpoint_id) or device
+  local state_device = switch_utils.find_child(device, device:get_field(fields.POWER_CONSUMPTION_REPORT_EP)) or device
   local previous_imported_report = state_device:get_latest_state("main", capabilities.powerConsumptionReport.ID,
-    capabilities.powerConsumptionReport.powerConsumption.NAME, { energy = latest_total_imported_energy_wh })
-  local energy_delta_wh = math.max(latest_total_imported_energy_wh - previous_imported_report.energy, 0.0) -- Calculate the energy delta between reports
+    capabilities.powerConsumptionReport.powerConsumption.NAME, { energy = total_imported_energy_wh }) -- default value if nil
+  local energy_delta_wh = total_imported_energy_wh - previous_imported_report.energy -- Calculate the energy delta between reports
 
   -- Report the energy consumed during the time interval. The unit of these values should be 'Wh'
   local epoch_to_iso8601 = function(time) return os.date("!%Y-%m-%dT%H:%M:%SZ", time) end -- Return an ISO-8061 timestamp from UTC
-  device:emit_event_for_endpoint(endpoint_id, capabilities.powerConsumptionReport.powerConsumption({
+  device:emit_event_for_endpoint(device:get_field(fields.POWER_CONSUMPTION_REPORT_EP), capabilities.powerConsumptionReport.powerConsumption({
     start = epoch_to_iso8601(last_time),
     ["end"] = epoch_to_iso8601(current_time - 1),
     deltaEnergy = energy_delta_wh,
-    energy = latest_total_imported_energy_wh
+    energy = total_imported_energy_wh
   }))
 end
 
-function AttributeHandlers.cumul_energy_imported_handler(driver, device, ib, response)
-  if ib.data.elements.energy then
-    local watt_hour_value = ib.data.elements.energy.value / fields.CONVERSION_CONST_MILLIWATT_TO_WATT
-    device:set_field(fields.TOTAL_IMPORTED_ENERGY, watt_hour_value, {persist = true})
-    device:emit_event_for_endpoint(ib.endpoint_id, capabilities.energyMeter.energy({ value = watt_hour_value, unit = "Wh" }))
-    report_power_consumption_to_st_energy(device, ib.endpoint_id, device:get_field(fields.TOTAL_IMPORTED_ENERGY))
-  end
-end
-
-function AttributeHandlers.per_energy_imported_handler(driver, device, ib, response)
-  if ib.data.elements.energy then
-    local watt_hour_value = ib.data.elements.energy.value / fields.CONVERSION_CONST_MILLIWATT_TO_WATT
-    local latest_energy_report = device:get_field(fields.TOTAL_IMPORTED_ENERGY) or 0
-    local summed_energy_report = latest_energy_report + watt_hour_value
-    device:set_field(fields.TOTAL_IMPORTED_ENERGY, summed_energy_report, {persist = true})
-    device:emit_event_for_endpoint(ib.endpoint_id, capabilities.energyMeter.energy({ value = summed_energy_report, unit = "Wh" }))
-    report_power_consumption_to_st_energy(device, ib.endpoint_id, device:get_field(fields.TOTAL_IMPORTED_ENERGY))
-  end
-end
-
-function AttributeHandlers.energy_imported_factory(is_cumulative_report)
+function AttributeHandlers.energy_imported_factory(is_periodic_report)
   return function(driver, device, ib, response)
     -- workaround: ignore devices supporting Eve's private energy cluster AND the ElectricalEnergyMeasurement cluster
     local EVE_MANUFACTURER_ID, EVE_PRIVATE_CLUSTER_ID = 0x130A, 0x130AFC01
     local eve_private_energy_eps = device:get_endpoints(EVE_PRIVATE_CLUSTER_ID)
     if device.manufacturer_info.vendor_id == EVE_MANUFACTURER_ID and #eve_private_energy_eps > 0 then
       return
     end
+    local state_device = switch_utils.find_child(device, ib.endpoint_id) or device
+    local energy_meter_latest_state = state_device:get_latest_state(
+      "main", capabilities.energyMeter.ID, capabilities.energyMeter.energy.NAME, 0 -- 0 as the default if state is nil
+    )
+    if ib.data.elements.energy then
+      local energy_imported_wh = ib.data.elements.energy.value / fields.CONVERSION_CONST_MILLIWATT_TO_WATT
+      if is_periodic_report then
+        -- handle this report only if cumulative reports are not supported
+        if device:get_field(fields.CUMULATIVE_REPORTS_SUPPORTED) then return end
+        energy_imported_wh = energy_imported_wh + energy_meter_latest_state
+      end
+      device:emit_event_for_endpoint(ib.endpoint_id, capabilities.energyMeter.energy({ value = energy_imported_wh, unit = "Wh" }))
 
-    if is_cumulative_report then
-      AttributeHandlers.cumul_energy_imported_handler(driver, device, ib, response)
-    elseif device:get_field(fields.CUMULATIVE_REPORTS_NOT_SUPPORTED) then
-      AttributeHandlers.per_energy_imported_handler(driver, device, ib, response)
+      local energy_wh_delta = energy_imported_wh - energy_meter_latest_state
+      local device_total_imported_energy_wh = (device:get_field(fields.TOTAL_IMPORTED_ENERGY) or 0) + energy_wh_delta
+      report_power_consumption_to_st_energy(device, device_total_imported_energy_wh)
     end
   end
 end

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

@@ -121,7 +121,7 @@ function SwitchLifecycleHandlers.device_init(driver, device)
         clusters.ElectricalEnergyMeasurement.ID,
         {feature_bitmap = clusters.ElectricalEnergyMeasurement.types.Feature.CUMULATIVE_ENERGY}
       )
-      if #cumulative_energy_eps == 0 then device:set_field(fields.CUMULATIVE_REPORTS_NOT_SUPPORTED, true, {persist = false}) end
+      if #cumulative_energy_eps > 0 then device:set_field(fields.CUMULATIVE_REPORTS_SUPPORTED, true, {persist = false}) end
     end
   end
 end
@@ -149,8 +149,8 @@ local matter_driver_template = {
         [clusters.ColorControl.attributes.CurrentY.ID] = attribute_handlers.current_y_handler,
       },
       [clusters.ElectricalEnergyMeasurement.ID] = {
-        [clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported.ID] = attribute_handlers.energy_imported_factory(true),
-        [clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyImported.ID] = attribute_handlers.energy_imported_factory(false),
+        [clusters.ElectricalEnergyMeasurement.attributes.CumulativeEnergyImported.ID] = attribute_handlers.energy_imported_factory(false),
+        [clusters.ElectricalEnergyMeasurement.attributes.PeriodicEnergyImported.ID] = attribute_handlers.energy_imported_factory(true),
       },
       [clusters.ElectricalPowerMeasurement.ID] = {
         [clusters.ElectricalPowerMeasurement.attributes.ActivePower.ID] = attribute_handlers.active_power_handler,

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

@@ -76,10 +76,6 @@ SwitchFields.device_type_profile_map = {
   [SwitchFields.MOUNTED_DIMMABLE_LOAD_CONTROL_ID] = "switch-level",
 }
 
-
-SwitchFields.CONVERSION_CONST_MILLIWATT_TO_WATT = 1000 -- A milliwatt is 1/1000th of a watt
-
-
 -- COMPONENT_TO_ENDPOINT_MAP is here to preserve the endpoint mapping for
 -- devices that were joined to this driver as MCD devices before the transition
 -- to join switch devices as parent-child. This value will exist in the device
@@ -102,10 +98,6 @@ SwitchFields.updated_fields = {
   { current_field_name = "__energy_management_endpoint", updated_field_name = nil }
 }
 
-SwitchFields.HUE_SAT_COLOR_MODE = clusters.ColorControl.types.ColorMode.CURRENT_HUE_AND_CURRENT_SATURATION
-SwitchFields.X_Y_COLOR_MODE = clusters.ColorControl.types.ColorMode.CURRENTX_AND_CURRENTY
-
-
 SwitchFields.SONOFF_MANUFACTURER_ID = 0x1321
 SwitchFields.AQARA_MANUFACTURER_ID = 0x115F
 SwitchFields.AQARA_CLIMATE_SENSOR_W100_ID = 0x2004
@@ -121,14 +113,16 @@ SwitchFields.device_overrides_per_vendor = {
   }
 }
 
+SwitchFields.CONVERSION_CONST_MILLIWATT_TO_WATT = 1000 -- A milliwatt is 1/1000th of a watt
+SwitchFields.POWER_CONSUMPTION_REPORT_EP = "__POWER_CONSUMPTION_REPORT_EP"
 SwitchFields.SET_TOPOLOGY_EPS = "__SET_TOPOLOGY_EPS"
 SwitchFields.PRIMARY_CHILD_EP = "__PRIMARY_CHILD_EP"
 SwitchFields.ELECTRICAL_TAGS = "__ELECTRICAL_TAGS"
 SwitchFields.profiling_data = {
   POWER_TOPOLOGY = "__POWER_TOPOLOGY",
 }
 
-SwitchFields.CUMULATIVE_REPORTS_NOT_SUPPORTED = "__cumulative_reports_not_supported"
+SwitchFields.CUMULATIVE_REPORTS_SUPPORTED = "__cumulative_reports_supported"
 SwitchFields.TOTAL_IMPORTED_ENERGY = "__total_imported_energy"
 SwitchFields.LAST_IMPORTED_REPORT_TIMESTAMP = "__last_imported_report_timestamp"
 SwitchFields.MINIMUM_ST_ENERGY_REPORT_INTERVAL = (15 * 60) -- 15 minutes, reported in seconds

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

@@ -221,6 +221,7 @@ function utils.collect_and_set_electrical_sensor_info(device)
   end
 
   local electrical_ep = electrical_sensor_eps[1] or {}
+  device:set_field(fields.POWER_CONSUMPTION_REPORT_EP, electrical_ep.endpoint_id, { persist = true })
   if electrical_ep[clusters.PowerTopology.ID] == clusters.PowerTopology.types.Feature.SET_TOPOLOGY then
     device:set_field(fields.SET_TOPOLOGY_EPS, electrical_sensor_eps) -- assume any other stored EPs also have a SET topology
     device:send(available_eps_req)