Plugin Commands: Reporting
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_ADD
plugin reporting add [endpoint:1] [clusterId:2] [attributeId:2] [mask:1] [minInterval:2] [maxInterval:2] [reportableChange:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_CLEAR
plugin reporting clear
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_CLEAR_LAST_REPORT_TIME
plugin reporting clear-last-report-time
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_PRINT
plugin reporting print
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_REMOVE
plugin reporting remove [index:1]

Detailed Description

The reporting plugin contributes several CLI commands to the application framework to be used in creating and managing reporting table entries directly on the device.

Macro Definition Documentation

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_ADD

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_ADD

plugin reporting add [endpoint:1] [clusterId:2] [attributeId:2] [mask:1] [minInterval:2] [maxInterval:2] [reportableChange:4]

  • Add a new entry to the report table.
    • endpoint - INT8U - The local endpoint from which the attribute is reported.
    • clusterId - INT16U - The cluster where the attribute is located.
    • attributeId - INT16U - The id of the attribute being reported.
    • mask - INT8U - 0 for client-side attributes or 1 for server-side attributes.
    • minInterval - INT16U - The minimum reporting interval, measured in seconds.
    • maxInterval - INT16U - The maximum reporting interval, measured in seconds.
    • reportableChange - INT32U - The minimum change to the attribute that will result in a report being sent.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_CLEAR

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_CLEAR

plugin reporting clear

  • Clear all entries from the report table.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_CLEAR_LAST_REPORT_TIME

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_CLEAR_LAST_REPORT_TIME

plugin reporting clear-last-report-time

  • Clear last report time of attributes.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_PRINT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_PRINT

plugin reporting print

  • Print the report table.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_REMOVE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_REMOVE

plugin reporting remove [index:1]

  • Remove an entry from the report table.
    • index - INT8U - The index of the report to be removed.