Plugin Commands: ZigBee Light Link (ZLL) Commissioning#
The ZigBee Light Link (ZLL) Commissioning Plugin contributes several commands to the application framework's CLI. These commands are used for forming and managing a ZLL network.
Macros#
plugin zll-commissioning abort
plugin zll-commissioning cancel-rx-on
plugin zll-commissioning channel [channel:1]
plugin zll-commissioning disable
plugin zll-commissioning enable
plugin zll-commissioning endpoints [destination:2] [sourceEndpoint:1] [destinationEndpoint:1] [startIndex:1]
plugin zll-commissioning form [channel:1] [power:1] [panId:2]
plugin zll-commissioning groups [destination:2] [sourceEndpoint:1] [destinationEndpoint:1] [startIndex:1]
plugin zll-commissioning identify [identifyDurationDs:2]
plugin zll-commissioning info [destination:2] [sourceEndpoint:1] [destinationEndpoint:1]
plugin zll-commissioning joinable
plugin zll-commissioning link
plugin zll-commissioning mask [index:1]
plugin zll-commissioning noreset-nfn
plugin zll-commissioning notouchlink-nfn
plugin zll-commissioning reset
plugin zll-commissioning rx-on-active
plugin zll-commissioning scan device
plugin zll-commissioning scan identify
plugin zll-commissioning scan reset
plugin zll-commissioning secondary-channel [channel:1]
plugin zll-commissioning set-rx-on [duration:4]
plugin zll-commissioning status
plugin zll-commissioning tokens
plugin zll-commissioning unused
Macro Definition Documentation#
EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_ABORT#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_ABORT
plugin zll-commissioning abort
Abort the touch link procedure.
7835 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_CANCEL_RX_ON#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_CANCEL_RX_ON
plugin zll-commissioning cancel-rx-on
Cancel Rx On When Idle.
7840 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_CHANNEL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_CHANNEL
plugin zll-commissioning channel [channel:1]
Set the scan channel used by the ZLL Commissioning plugin.
channel - INT8U - The primary channel to be used.
7846 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_DISABLE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_DISABLE
plugin zll-commissioning disable
Disable touchlinking. This will override the notouchlink-nfn and noreset-nfn commands.
7851 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_ENABLE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_ENABLE
plugin zll-commissioning enable
Enable touchlinking. This will override the notouchlink-nfn and noreset-nfn commands.
7856 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_ENDPOINTS#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_ENDPOINTS
plugin zll-commissioning endpoints [destination:2] [sourceEndpoint:1] [destinationEndpoint:1] [startIndex:1]
Send a GetEndpointListRequest to a server.
destination - INT16U - The network address of the device to which the request will be sent.
sourceEndpoint - INT8U - The source endpoint from which the request will be sent.
destinationEndpoint - INT8U - The destination endpoint to which the request will be sent.
startIndex - INT8U - The endpoint index at which to start retreiving data.
7865 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_FORM#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_FORM
plugin zll-commissioning form [channel:1] [power:1] [panId:2]
Form a ZLL network.
channel - INT8U - The channel on which to form the network.
power - INT8S - The power setting for network transmissions.
panId - INT16U - The PAN identifier for the network.
7873 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_GROUPS#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_GROUPS
plugin zll-commissioning groups [destination:2] [sourceEndpoint:1] [destinationEndpoint:1] [startIndex:1]
Send a GroupIdentifiersRequest to a server.
destination - INT16U - The network address of the device to which the request will be sent.
sourceEndpoint - INT8U - The source endpoint from which the request will be sent.
destinationEndpoint - INT8U - The destination endpoint to which the request will be sent.
startIndex - INT8U - The group table index at which to start retreiving data.
7882 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_IDENTIFY#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_IDENTIFY
plugin zll-commissioning identify [identifyDurationDs:2]
Set the duration that a target device should remain in identify mode during touch linking.
identifyDurationDs - INT16U - The duration (in tenths of a second) of identify mode or 0xFFFF to indicate that the target should use its own application-specific duration.
7888 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_INFO#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_INFO
plugin zll-commissioning info [destination:2] [sourceEndpoint:1] [destinationEndpoint:1]
Send an EndpointInformationRequest to a client.
destination - INT16U - The network address of the device to which the request will be sent.
sourceEndpoint - INT8U - The source endpoint from which the request will be sent.
destinationEndpoint - INT8U - The destination endpoint to which the request will be sent.
7896 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_JOINABLE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_JOINABLE
plugin zll-commissioning joinable
Scan for joinable networks and attempt to join if a network is found.
7901 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_LINK#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_LINK
plugin zll-commissioning link
Initiate the touch link procedure.
7906 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_MASK#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_MASK
plugin zll-commissioning mask [index:1]
Set the scan channel set used by the ZLL Commissioning plugin. An index of 0 sets the primary ZLL channel set, 1 is the +1 channel set, 2 is the +2 channel set, 3 is the +3 channel set, and 4 is all ZigBee channels.
index - INT8U - The index of the channel mask to be used.
7912 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_NORESET_NFN#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_NORESET_NFN
plugin zll-commissioning noreset-nfn
Disable reset for an NFN device on a centralized security network.
7917 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_NOTOUCHLINK_NFN#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_NOTOUCHLINK_NFN
plugin zll-commissioning notouchlink-nfn
Disable touchlinking (stealing) for an NFN device.
7922 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_RESET#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_RESET
plugin zll-commissioning reset
Reset the local device to factory new.
7927 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_RX_ON_ACTIVE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_RX_ON_ACTIVE
plugin zll-commissioning rx-on-active
Get Rx On When Idle status.
7932 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SCAN_DEVICE#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SCAN_DEVICE
plugin zll-commissioning scan device
Initiate a touch link for the purpose of retrieving information about a target device.
7937 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SCAN_IDENTIFY#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SCAN_IDENTIFY
plugin zll-commissioning scan identify
Initiate a touch link for the purpose of causing a target device to identify itself.
7942 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SCAN_RESET#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SCAN_RESET
plugin zll-commissioning scan reset
Initiate a touch link for the purpose of resetting a target device.
7947 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SECONDARY_CHANNEL#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SECONDARY_CHANNEL
plugin zll-commissioning secondary-channel [channel:1]
Set the scan channel used by the ZLL Commissioning plugin.
channel - INT8U - The secondary channel to be used.
7953 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SET_RX_ON#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_SET_RX_ON
plugin zll-commissioning set-rx-on [duration:4]
Set Rx On When Idle duration.
duration - INT32U - The duration for the Rx On period.
7959 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_STATUS#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_STATUS
plugin zll-commissioning status
Print the ZLL channel set and tokens.
7964 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_TOKENS#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_TOKENS
plugin zll-commissioning tokens
Print the ZLL tokens.
7969 of file ./app/framework/test/headers/cli.docEMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_UNUSED#
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_ZLL_COMMISSIONING_PLUGIN_ZLL_COMMISSIONING_UNUSED
plugin zll-commissioning unused
Scan for an unused PAN identifier and form a new ZLL network.
7974 of file ./app/framework/test/headers/cli.doc