Reporting#

Callbacks for Reporting Component.

Callbacks#

emberAfPluginReportingConfiguredCallback(const EmberAfPluginReportingEntry *entry)

Configure a reporting entry.

bool

Get default reporting configuration values.

Callbacks Documentation#

emberAfPluginReportingConfiguredCallback#

EmberAfStatus emberAfPluginReportingConfiguredCallback (const EmberAfPluginReportingEntry * entry)

Configure a reporting entry.

Parameters
N/Aentry

Ver.: always

This callback is called by the Reporting plugin whenever a reporting entry is configured, including when entries are deleted or updated. The application can use this callback for scheduling readings or measurements based on the minimum and maximum reporting interval for the entry. The application should return EMBER_ZCL_STATUS_SUCCESS if it can support the configuration or an error status otherwise. Note: attribute reporting is required for many clusters and attributes, so rejecting a reporting configuration may violate ZigBee specifications.


Definition at line 162 of file app/framework/plugin/reporting/reporting.h

emberAfPluginReportingGetDefaultReportingConfigCallback#

bool emberAfPluginReportingGetDefaultReportingConfigCallback (EmberAfPluginReportingEntry * entry)

Get default reporting configuration values.

Parameters
N/Aentry

Ver.: always

This callback is called by the Reporting plugin to get the default reporting configuration values from the user if a default value is not available within AF-generated default reporting configuration table. The application needs to write to the minInterval, maxInterval, and reportable change in the passed I/O pointer in the argument while handling this callback. The application returns true if it has provided default values or false for reporting plugin for further handling.


Definition at line 176 of file app/framework/plugin/reporting/reporting.h