Plugin Commands: Reporting#

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.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_ADD undefined

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_LAST_REPORT_TIME undefined

plugin reporting clear-last-report-time

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_REMOVE undefined

plugin reporting remove [index:1]

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.


Definition at line 5948 of file ./app/framework/test/headers/cli.doc

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.


Definition at line 5953 of file ./app/framework/test/headers/cli.doc

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.


Definition at line 5958 of file ./app/framework/test/headers/cli.doc

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.


Definition at line 5963 of file ./app/framework/test/headers/cli.doc

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.


Definition at line 5969 of file ./app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_TEST_TIMING#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_REPORTING_PLUGIN_REPORTING_TEST_TIMING

plugin reporting test-timing

  • FOR TESTING PURPOSES - gather timing metrics for reporting table operations


Definition at line 5974 of file ./app/framework/test/headers/cli.doc