Plugin Commands: Comms Hub Function#

The comms-hub-function plugin contributes several CLI commands to the application framework to be used in configuring and managing the CHF.

Macros#

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_CLOSE_TUNNEL undefined

plugin comms-hub-function close-tunnel [dstEUI64:8]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_CREATE_TUNNEL undefined

plugin comms-hub-function create-tunnel [dstEUI64:8] [endpoint:1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_GET_TUNNEL_ENDPOINT undefined

plugin comms-hub-function get-tunnel-endpoint [nodeId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_SEND undefined

plugin comms-hub-function send [dstEUI64:8] [payload:-1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_SIMULATE_GBZ_MSG undefined

plugin comms-hub-function simulate-gbz-msg [dstEUI64:8] [useCase:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_TIMEOUT undefined

plugin comms-hub-function timeout [timeout:4]

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_CLOSE_TUNNEL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_CLOSE_TUNNEL

plugin comms-hub-function close-tunnel [dstEUI64:8]

  • Remove the tunnel for a given device.

    • dstEUI64 - IEEE_ADDRESS


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_CREATE_TUNNEL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_CREATE_TUNNEL

plugin comms-hub-function create-tunnel [dstEUI64:8] [endpoint:1]

  • Create tunnel for the given device and endpoint.

    • dstEUI64 - IEEE_ADDRESS

    • endpoint - INT8U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_GET_TUNNEL_ENDPOINT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_GET_TUNNEL_ENDPOINT

plugin comms-hub-function get-tunnel-endpoint [nodeId:2]

  • Retrieve the tunneling endpoint for a given nodeId.

    • nodeId - INT16U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_PRINT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_PRINT

plugin comms-hub-function print

  • Prints the comms hub tunnel table.


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_PRINT_SUPPORTED_USE_CASES#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_PRINT_SUPPORTED_USE_CASES

plugin comms-hub-function print-supported-use-cases

  • Print the list of supported use cases. The message code printed should be used with the simulate-gbz-msg command.


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_SEND#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_SEND

plugin comms-hub-function send [dstEUI64:8] [payload:-1]

  • Send a message.

    • dstEUI64 - IEEE_ADDRESS

    • payload - OCTET_STRING


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_SIMULATE_GBZ_MSG#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_SIMULATE_GBZ_MSG

plugin comms-hub-function simulate-gbz-msg [dstEUI64:8] [useCase:2]

  • Simulate transmission of a GBZ message to the Comms Hub Function.

    • dstEUI64 - IEEE_ADDRESS

    • useCase - INT16U


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

EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_TIMEOUT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_COMMS_HUB_FUNCTION_PLUGIN_COMMS_HUB_FUNCTION_TIMEOUT

plugin comms-hub-function timeout [timeout:4]

  • Set the default sleepy message timeout.

    • timeout - INT32U


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