Reporting consumption to SmartThings Energy and possible issues

mocelet · July 1, 2025, 2:06pm

I’ve seen two strategies in stock drivers to report to ST Energy, which apparently mandates the reports must be spaced at least 15 minutes.

First strategy (no polling, no start-end info): assume you’re subscribed to the energy reports of the device so no need for polling, keep the time of the last time you reported to ST Energy and if it’s been more than 15 minutes, calculate the delta and emit the event.

github.com/SmartThingsCommunity/SmartThingsEdgeDrivers

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

7c438118f


      
          -- report interval
          local current_time = os.time()
          local last_time = device:get_field(LAST_REPORT_TIME) or 0
          local next_time = last_time + 60 * 15 -- 15 mins, the minimum interval allowed between reports
          if current_time < next_time then
            return
          end
          device:set_field(LAST_REPORT_TIME, current_time, { persist = true })
          
          -- power consumption report
          local delta_energy = 0.0
          local current_power_consumption = device:get_latest_state("main", capabilities.powerConsumptionReport.ID,
            capabilities.powerConsumptionReport.powerConsumption.NAME)
          if current_power_consumption ~= nil then
            delta_energy = math.max(raw_value - current_power_consumption.energy, 0.0)
          end
          device:emit_event(capabilities.powerConsumptionReport.powerConsumption({ energy = raw_value, deltaEnergy = delta_energy })) -- the unit of these values should be 'Wh'

Second strategy (polling, start-end): use polling every 15 minutes, keep the time of the last time you reported to ST Energy, calculate the delta and emit the event including a start and end time.

github.com/SmartThingsCommunity/SmartThingsEdgeDrivers

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

7c438118f


      
          local function send_import_poll_report(device, latest_total_imported_energy_wh)
            local current_time = os.time()
            local last_time = device:get_field(LAST_IMPORTED_REPORT_TIMESTAMP) or 0
            device:set_field(LAST_IMPORTED_REPORT_TIMESTAMP, current_time, { persist = true })
          
            -- Calculate the energy delta between reports
            local energy_delta_wh = 0.0
            local previous_imported_report = device:get_latest_state("main", capabilities.powerConsumptionReport.ID,
              capabilities.powerConsumptionReport.powerConsumption.NAME)
            if previous_imported_report and previous_imported_report.energy then
              energy_delta_wh = math.max(latest_total_imported_energy_wh - previous_imported_report.energy, 0.0)
            end
          
            -- Report the energy consumed during the time interval. The unit of these values should be 'Wh'
            if not device:get_field(ENERGY_MANAGEMENT_ENDPOINT) then
              device:emit_event(capabilities.powerConsumptionReport.powerConsumption({
                start = iso8061Timestamp(last_time),
                ["end"] = iso8061Timestamp(current_time - 1),
                deltaEnergy = energy_delta_wh,
                energy = latest_total_imported_energy_wh

This file has been truncated. show original

I find the first approach better since there’s no polling involved and no need to manage timers.

Also, the start and end attributes in the powerConsumptionReport events are prone to errors, especially if you have a custom driver and switch back to stock driver. In that case, the deltaEnergy will be correct since it’s calculated from the most recent value cached, but the start will be incorrect since it will be the last time the stock driver sent the report, not the last time a report was sent (by the custom driver).

The questions:

Are those two approaches equally good?
Are the start and end attributes actually needed?

nayelyz · July 1, 2025, 2:46pm

Hi, @mocelet

Are you looking to certify a device and to be supported in SmartThings energy? Getting a device to appear there requires it to go through a special process during WWST certification.

mocelet · July 1, 2025, 3:20pm

Hi @nayelyz , it’s to create a custom driver for a device that is already supported in SmartThings Energy.

nayelyz · July 1, 2025, 8:09pm

Hi, @mocelet

I checked with the engineering team, and both approaches currently work in ST Energy.
However, we encourage Partners to send a value in “end” and “start” for future reference and troubleshooting purposes.
Also, implementing the capability does not ensure the device will function with ST Energy. Only certified devices that have gone through the special process I mentioned earlier will work for certain.

mocelet · July 1, 2025, 8:14pm

Perfect, thanks as always @nayelyz

Topic		Replies	Views
Smart Power Outlet, configure/disable energy reporting? Community Created Device Types	38	11345	December 12, 2019
Reported events from device being ignored/ not logged by ST API / not being logged? Writing Edge Drivers	12	265	June 11, 2024
Smartthings Outlet Sends Notification Every Minute Or Two While On? Devices & Integrations	11	2328	November 14, 2016
Aeon Micro Smart Energy Switch--how to change parameters? Devices & Integrations	8	2651	April 14, 2015
Is there a way to reduce polling and notifications? General Discussion	2	701	February 20, 2018

Reporting consumption to SmartThings Energy and possible issues

Related topics