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.

Modules#

sli_zigbee_af_report_volatile_data_type

Reporting

API#

sl_zigbee_af_status_t
sl_zigbee_af_reporting_configure_reported_attribute(const sl_zigbee_af_plugin_reporting_entry_t *newEntry)

Configure the new reported attribute.

void
sl_zigbee_af_reporting_load_reporting_config_defaults(void)

Load the default reporting configuration.

bool
sl_zigbee_af_reporting_get_reporting_config_defaults(sl_zigbee_af_plugin_reporting_entry_t *defaultConfiguration)

Get the default reporting configuration.

Variables#

Macros#

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

API Documentation#

sl_zigbee_af_reporting_configure_reported_attribute#

sl_zigbee_af_status_t sl_zigbee_af_reporting_configure_reported_attribute (const sl_zigbee_af_plugin_reporting_entry_t * newEntry)

Configure the new reported attribute.

Parameters
N/AnewEntry

Pointer to the struct containing the reporting configuration entry

Returns

  • sl_zigbee_af_status_t Status code


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

sl_zigbee_af_reporting_load_reporting_config_defaults#

void sl_zigbee_af_reporting_load_reporting_config_defaults (void )

Load the default reporting configuration.

Parameters
N/A

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

sl_zigbee_af_reporting_get_reporting_config_defaults#

bool sl_zigbee_af_reporting_get_reporting_config_defaults (sl_zigbee_af_plugin_reporting_entry_t * 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 128 of file app/framework/plugin/reporting/reporting.h

Variable Documentation#

sli_zigbee_af_report_volatile_data#

sli_zigbee_af_report_volatile_data_type sli_zigbee_af_report_volatile_data[]

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

Macro Definition Documentation#

NULL_INDEX#

#define NULL_INDEX
Value:
0xFFFF

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

REPORTING_TABLE_MAX_RANGE#

#define REPORTING_TABLE_MAX_RANGE
Value:
127

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

REPORTING_TABLE_PLUGIN_SIZE#

#define REPORTING_TABLE_PLUGIN_SIZE
Value:
(SL_ZIGBEE_AF_PLUGIN_REPORTING_TABLE_SIZE)

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

REPORT_TABLE_SIZE#

#define REPORT_TABLE_SIZE
Value:
(REPORTING_TABLE_PLUGIN_SIZE)

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