Plugin Commands: Network Steering
Zigbee Application Framework Command Line Interface (CLI)

Macros

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_MASK_ADD
plugin network-steering mask add [whichMask:1] [channel:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_MASK_SET
plugin network-steering mask set [whichMask:1] [mask:4]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_MASK_SUBTRACT
plugin network-steering mask subtract [whichMask:1] [channel:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_PRE_CONFIGURED_KEY_SET
plugin network-steering pre-configured-key-set [preconfiguredkey:-1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_START
plugin network-steering start [options:1]
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_STATUS
plugin network-steering status
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_STOP
plugin network-steering stop

Detailed Description

The Network Steering plugin commands are currently being used for the Profile Interop event.

Macro Definition Documentation

#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_MASK_ADD

plugin network-steering mask add [whichMask:1] [channel:1]

  • Adds a channel to either the primary or secondary channel mask of the network-steering plugin.
    • whichMask - INT8U - The channel mask to add a channel to.
    • channel - INT8U - The channel to add to the mask.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_MASK_SET

plugin network-steering mask set [whichMask:1] [mask:4]

  • Set either the primary or secondary channel mask.
    • whichMask - INT8U - The channel mask to subtract the channel from.
    • mask - INT32U - The value to set the channel mask to.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_MASK_SUBTRACT

plugin network-steering mask subtract [whichMask:1] [channel:1]

  • Subtracts a channel from either the primary or secondary channel mask of the network-steering plugin.
    • whichMask - INT8U - The channel mask to subtract the channel from.
    • channel - INT8U - The channel to subtract the mask from.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_PRE_CONFIGURED_KEY_SET

plugin network-steering pre-configured-key-set [preconfiguredkey:-1]

  • Set the pre-configured key
    • preconfiguredkey - OCTET_STRING - Set the preconfigured key so that the joining device can enter the network.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_START

plugin network-steering start [options:1]

  • Starts the network steering process.
    • options - INT8U - A mask of options for indicating specific behavior within the network-steering process.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_STATUS

plugin network-steering status

  • Displays the current status of the network steering process.
#define EMBER_AF_DOXYGEN_CLI_COMMAND_PLUGIN_NETWORK_STEERING_PLUGIN_NETWORK_STEERING_STOP

plugin network-steering stop

  • Stops the network steering process.