Cluster Commands: Tunneling
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_RANDOM_TO_CLIENT
zcl tunneling random-to-client [tunnel-id:2] [length:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_RANDOM_TO_SERVER
zcl tunneling random-to-server [tunnel-id:2] [length:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_TRANSFER_TO_CLIENT
zcl tunneling transfer-to-client [tunnel-id:2] [data:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_TRANSFER_TO_SERVER
zcl tunneling transfer-to-server [tunnel-id:2] [data:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_REQUEST
zcl tunneling request [protocolId:1] [manufacturerCode:2] [flowControlSupport:1] [maximumIncomingTransferSize:2]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_CLOSE
zcl tunneling close [tunnelId:2]

Detailed Description

This group describes the CLI commands for the Tunneling cluster. Listed below is a description of the cluster:

The tunneling cluster provides an interface for tunneling protocols.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_CLOSE

zcl tunneling close [tunnelId:2]

  • Client command used to close the tunnel with the server. The parameter in the payload specifies the tunnel identifier of the tunnel that has to be closed. The server leaves the tunnel open and the assigned resources allocated until the client sends the CloseTunnel command or the CloseTunnelTimeout fires.
    • tunnelId - INT16U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_REQUEST

zcl tunneling request [protocolId:1] [manufacturerCode:2] [flowControlSupport:1] [maximumIncomingTransferSize:2]

  • RequestTunnel is the client command used to setup a tunnel association with the server. The request payload specifies the protocol identifier for the requested tunnel, a manufacturer code in case of proprietary protocols and the use of flow control for streaming protocols.
    • protocolId - INT8U
    • manufacturerCode - INT16U
    • flowControlSupport - BOOLEAN
    • maximumIncomingTransferSize - INT16U
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_RANDOM_TO_CLIENT

zcl tunneling random-to-client [tunnel-id:2] [length:2]

  • Send a random amount of data through a tunnel to the server (used for testing)
    • tunnel-id - INT16U - The two byte tunnel id
    • length - INT16U - the length of random data to send to the client
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_RANDOM_TO_SERVER

zcl tunneling random-to-server [tunnel-id:2] [length:2]

  • Send a random amount of data through a tunnel to the server (used for testing)
    • tunnel-id - INT16U - The two byte tunnel id
    • length - INT16U - The two byte length of the random data to send
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_TRANSFER_TO_CLIENT

zcl tunneling transfer-to-client [tunnel-id:2] [data:-1]

  • Transfer data through a tunnel to the client (used for testing)
    • tunnel-id - INT16U - The two byte tunnel id
    • data - OCTET_STRING - data to transfer to the client
#define EMBER_AF_DOXYGEN_CLI_COMMAND_TUNNELING_ZCL_TUNNELING_TRANSFER_TO_SERVER

zcl tunneling transfer-to-server [tunnel-id:2] [data:-1]

  • Transfer data through a tunnel to the server.
    • tunnel-id - INT16U - The two byte tunnel id
    • data - OCTET_STRING - data to transfer to the client