Modules#

EmAfPluginReportVolatileData

Reporting

Reporting#

API and Callbacks for the Reporting Component.

Silicon Labs implementation of reporting. Reports are asynchronous messages sent out when an ZCL attribute has changed. This component supports both requesting reports from another device and sending out attribute reports when the device has been configured to do so. If the application receives reports from multiple sources, Silicon Labs recommends configuring it as a concentrator. Note: This component only supports the binding-based interpretation of reporting in which reports are sent to corresponding entries in the binding table. Either the node sending the reports, the node receiving the reports, or another third-party configuration device may create the binding table entry(s) on the reporting node. For more details, refer to the Application Framework Developers Guide for the current SDK version.

API#

EmberAfStatus
emberAfPluginReportingConfigureReportedAttribute(const EmberAfPluginReportingEntry *newEntry)

Configure the new reported attribute.

void
emberAfPluginReportingLoadReportingConfigDefaults(void)

Load the default reporting configuration.

bool
emberAfPluginReportingGetReportingConfigDefaults(EmberAfPluginReportingEntry *defaultConfiguration)

Get the default reporting configuration.

Variables#

Macros#

#define
NULL_INDEX 0xFFFF
#define
REPORTING_TABLE_PLUGIN_SIZE (EMBER_AF_PLUGIN_REPORTING_TABLE_SIZE)
#define
REPORT_TABLE_SIZE (REPORTING_TABLE_PLUGIN_SIZE)

API Documentation#

emberAfPluginReportingConfigureReportedAttribute#

EmberAfStatus emberAfPluginReportingConfigureReportedAttribute (const EmberAfPluginReportingEntry * newEntry)

Configure the new reported attribute.

Parameters
N/AnewEntry

Pointer to the struct containing the reporting configuration entry

Returns

  • EmberAfStatus Status code


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

emberAfPluginReportingLoadReportingConfigDefaults#

void emberAfPluginReportingLoadReportingConfigDefaults (void )

Load the default reporting configuration.

Parameters
N/A

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

emberAfPluginReportingGetReportingConfigDefaults#

bool emberAfPluginReportingGetReportingConfigDefaults (EmberAfPluginReportingEntry * defaultConfiguration)

Get the default reporting configuration.

Parameters
N/AdefaultConfiguration

Pointer to the struct where default configuration will be stored

Returns

  • bool true if there is a default value


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

Variable Documentation#

emAfPluginReportVolatileData#

EmAfPluginReportVolatileData emAfPluginReportVolatileData[]

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

Macro Definition Documentation#

NULL_INDEX#

#define NULL_INDEX
Value:
0xFFFF

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

REPORTING_TABLE_MAX_RANGE#

#define REPORTING_TABLE_MAX_RANGE
Value:
127

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

REPORTING_TABLE_PLUGIN_SIZE#

#define REPORTING_TABLE_PLUGIN_SIZE
Value:
(EMBER_AF_PLUGIN_REPORTING_TABLE_SIZE)

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

REPORT_TABLE_SIZE#

#define REPORT_TABLE_SIZE
Value:
(REPORTING_TABLE_PLUGIN_SIZE)

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