Plugin Commands: GBCS Device Log#

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

Macros#

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

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_STORE

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

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_CLEAR#

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


Definition at line 3173 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_COUNT#

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


Definition at line 3178 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_EXISTS#

#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


Definition at line 3185 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_FILL#

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


Definition at line 3190 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_GET#

#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


Definition at line 3196 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_IS_SLEEPY#

#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


Definition at line 3202 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_PRINT#

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


Definition at line 3207 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_REMOVE#

#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


Definition at line 3213 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_RESET#

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


Definition at line 3218 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_GBCS_DEVICE_LOG_PLUGIN_GBCS_DEVICE_LOG_STORE#

#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


Definition at line 3225 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/test/headers/cli.doc