Plugin Commands: GBCS Device Log
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_CLEAR
plugin gbcs-device-log clear
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_COUNT
plugin gbcs-device-log count
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_EXISTS
plugin gbcs-device-log exists [deviceId:8] [deviceType:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_FILL
plugin gbcs-device-log fill
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_GET
plugin gbcs-device-log get [deviceId:8]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_IS_SLEEPY
plugin gbcs-device-log is-sleepy [deviceType:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_PRINT
plugin gbcs-device-log print
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_REMOVE
plugin gbcs-device-log remove [deviceId:8]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_RESET
plugin gbcs-device-log reset
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_STORE
plugin gbcs-device-log store [deviceId:8] [deviceType:1]

Detailed Description

The gbcs-device-log plugin contributes several CLI commands to the application framework to be used in configuring and managing the GBCS Device Log.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_CLEAR

plugin gbcs-device-log clear

  • Clear all entries from the GBCS Device Log.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_COUNT

plugin gbcs-device-log count

  • Get the number of entries in the GBCS Device Log.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_EXISTS

plugin gbcs-device-log exists [deviceId:8] [deviceType:1]

  • Check to see if a device exists in the GBCS Device Log.
    • deviceId - IEEE_ADDRESS - The EUI64 of the device in question
    • deviceType - INT8U - The GBCS device type of the device in question
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_FILL

plugin gbcs-device-log fill

  • Helper command to fill the GBCS Device Log with random info.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_GET

plugin gbcs-device-log get [deviceId:8]

  • Get device info about an entry in the GBCS Device Log
    • deviceId - IEEE_ADDRESS - The EUI64 of the device for which information is requested
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_IS_SLEEPY

plugin gbcs-device-log is-sleepy [deviceType:1]

  • Is the given device type a sleepy device.
    • deviceType - INT8U - The GBCS device type to be checked
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_PRINT

plugin gbcs-device-log print

  • Print all entries in the GBCS Device log.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_REMOVE

plugin gbcs-device-log remove [deviceId:8]

  • Remove an entry from the GBCS Device Log.
    • deviceId - IEEE_ADDRESS - The EUI64 of the device to be removed
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_RESET

plugin gbcs-device-log reset

  • Reset the GBCS Device Log to include just those entries configured with the plugin.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_STORE

plugin gbcs-device-log store [deviceId:8] [deviceType:1]

  • Add or update an entry within the GBCS Device Log.
    • deviceId - IEEE_ADDRESS - The EUI64 of the device to be added or updated
    • deviceType - INT8U - The GBCS device type of the device to be added or updated