Modules#

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)

Configures the new reported attribute.

void

emberAfPluginReportingLoadReportingConfigDefaults(void)

Loads the default reporting configuration.

bool

emberAfPluginReportingGetReportingConfigDefaults(EmberAfPluginReportingEntry *defaultConfiguration)

Get the default reporting configuration.

Variables#

EmAfPluginReportVolatileData

emAfPluginReportVolatileData

Macros#

#define

NULL_INDEX 0xFFFF

#define

REPORTING_TABLE_MAX_RANGE 127

#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)

Configures the new reported attribute.

Parameters

Type	Direction	Argument Name	Description
const EmberAfPluginReportingEntry *	N/A	newEntry	Pointer to the struct containing the reporting configuration entry

Returns

EmberAfStatus Status code

emberAfPluginReportingLoadReportingConfigDefaults#

void emberAfPluginReportingLoadReportingConfigDefaults (void )

Loads the default reporting configuration.

Parameters

Type	Direction	Argument Name	Description
void	N/A

emberAfPluginReportingGetReportingConfigDefaults#

bool emberAfPluginReportingGetReportingConfigDefaults (EmberAfPluginReportingEntry * defaultConfiguration)

Get the default reporting configuration.

Parameters

Type	Direction	Argument Name	Description
EmberAfPluginReportingEntry *	N/A	defaultConfiguration	Pointer to the struct where default configuration will be stored

Returns

bool true if there is a default value

Variable Documentation#

emAfPluginReportVolatileData#

EmAfPluginReportVolatileData emAfPluginReportVolatileData[]