Plugin Commands: Tunneling Client
Application Framework CLI Command Reference

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_CLOSE
 plugin tunneling-client close [tunnelIndex:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_PRINT
 plugin tunneling-client print
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_REQUEST
 plugin tunneling-client request [server:2] [clientEndpoint:1] [serverEndpoint:1] [protocolId:1] [manufacturerCode:2] [flowControlSupport:1]
 
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_TRANSFER
 plugin tunneling-client transfer [tunnelIndex:1] [data:-1]

Detailed Description

The Tunneling Client Plugin contributes several commands to the application framework's CLI. These commands may be used to create messages related to opening and closing a tunnel between two devices.

Macro Definition Documentation

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_CLOSE

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_CLOSE

plugin tunneling-client close [tunnelIndex:1]

  • Close a Tunneling cluster tunnel.
    • tunnelIndex - INT8U - The index of the tunnel to close.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_PRINT

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_PRINT

plugin tunneling-client print

  • Print out the status of active tunnels.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_REQUEST

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_REQUEST

plugin tunneling-client request [server:2] [clientEndpoint:1] [serverEndpoint:1] [protocolId:1] [manufacturerCode:2] [flowControlSupport:1]

  • Request a Tunneling cluster tunnel with a server.
    • server - INT16U - The network address of the server to which the request will be sent.
    • clientEndpoint - INT8U - The local endpoint from which the request will be sent.
    • serverEndpoint - INT8U - The remote endpoint to which the request will be sent.
    • protocolId - INT8U - The protocol id of the requested tunnel.
    • manufacturerCode - INT16U - The manufacturer code of the requested tunnel.
    • flowControlSupport - BOOLEAN - 1 if flow control support is requested or 0 if not.

◆ EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_TRANSFER

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_TUNNELING_CLIENT_PLUGIN_TUNNELING_CLIENT_TRANSFER

plugin tunneling-client transfer [tunnelIndex:1] [data:-1]

  • Transfer data to a server through a Tunneling cluster tunnel.
    • tunnelIndex - INT8U - The index of the tunnel through which to send the data.
    • data - OCTET_STRING - The data to send through the tunnel.