Application Framework CLI Command Reference#

EMBER_AF_DOXYGEN_CLI__NETWORK_COMMANDS#

#define EMBER_AF_DOXYGEN_CLI__NETWORK_COMMANDS

network form <channel> <power> <panid>

• Form a network on a given channel, with a given TX Power and PAN ID.

  • channel - uint8_t. The channel on which to form the network.

  • power - int8_t. One byte signed value indicating the TX Power that the radio should be set to.

  • panId - uint16_t. The PAN ID on which to form the network.

network join <channel> <power> <panid>

• Join a network on a given channel, with a given TX Power and PAN ID.

  • channel - uint8_t. The channel on which to join the network.

  • power - int8_t. One byte signed value indicating the TX Power that the radio should be set to.

  • panId - uint16_t. The PAN ID on which to join the network.

network rejoin <encrypted>

• Find and rejoin the previous network the device was connected to.

  • encrypted - uint8_t. A single byte boolean 0 or 1 indicating whether or not the rejoin should be done with encryption.

network leave

• Leave the current network that the device is connected to.

network pjoin <seconds>

• Turn permit joining on for the amount of time indicated.

  • seconds - uint8_t. A single byte indicating how long the device should have permit joining turn on for. A value of 0xff turns permit join indefinitely.

network broad-pjoin <seconds>

• Turn permit joining on for the amount of time indicated AND broadcast a ZDO Mgmt Permit Joining request to all routers.

  • seconds - uint8_t. A single byte indicating how long the device should have permit joining turn on for. A value of 0xff turns permit join indefinitely.

network isopen

• Check if the network has permit joining on and if yes report the remaining time for which the network will be open.

  • seconds - uint8_t. A single byte indicating how long the device will have permit joining turn on for.

network extpanid <bytes>

• Write the extended PAN ID of the device.

  • bytes - byte array. An array of bytes which represents the extended PAN ID for the device.

network find unused

• Begins a search for an unused Channel and PAN ID. Will automatically form a network on the first unused Channel and PAN ID it finds.

network find joinable

• Begins a search for a joinable network. Will automatically attempt to join the first network it finds.

EMBER_AF_DOXYGEN_CLI__SECURITY_CHANGEKEY_COMMANDS#

#define EMBER_AF_DOXYGEN_CLI__SECURITY_CHANGEKEY_COMMANDS

Commands used to change the default link or network key that will be used when forming or joining a network.

changekey link <key>

• key - 16 byte array. The Link Key provided as a 16 byte array.

changekey network <key>

• key - 16 byte array. The Network Key provided as a 16 byte array.

EMBER_AF_DOXYGEN_CLI__SECURITY_CBKE_COMMANDS#

#define EMBER_AF_DOXYGEN_CLI__SECURITY_CBKE_COMMANDS

Command used for key establishment.

   <b>cbke start &lt;new partner id&gt; &lt;destination endpoint&gt;</b>
   - new partner ID - uint16_t. The 2 byte node ID of the partner
     with whom to start cbke.

   <b>cbke interpan &lt;pan id&gt; &lt;eui64&gt;</b>
   - PAN ID - uint16_t. The 2 byte PAN ID that the target is located on.
   - eui64 - EmberEUI64. The 8 byte EUI64 of the target (big endian)

   <b>cbke partner &lt;node id&gt; &lt;endpoint&gt;</b>
   - node ID - uint16_t. The two byte node ID of the device
     with whom to initiate key establishment.
   - endpoint - uint8_t. The endpoint on which to begin
     key establishment.

EMBER_AF_DOXYGEN_CLI__ZCL_GLOBAL_COMMANDS#

#define EMBER_AF_DOXYGEN_CLI__ZCL_GLOBAL_COMMANDS

Commands used to send global commands in the zcl.

   <b>zcl global read &lt;cluster&gt; &lt;attribute id&gt; </b>
   - <i> Creates a global read command message to read from
         the cluster and attribute specified.
     - cluster - uint16_t. The cluster id to read from.
     - attribute id - uint16_t. The attribute id to read from</i>

   <b>zcl global write &lt;cluster&gt; &lt;attribute id&gt; &lt;data type&gt; &lt;data&gt;</b>
   - <i> Creates a global write  command message to write to
         the cluster and attribute specified.
     - cluster - uint16_t. The cluster id to read from.
     - attribute id - uint16_t. The attribute id to read from
     - data type - uint8_t. The two byte zigbee type value
     - data - byte array. The data to write</i>

   <b>zcl global uwrite &lt;cluster&gt; &lt;attribute id&gt; &lt;data type&gt; &lt;data&gt;</b>
   - <i> Creates a global write command message to write to the
         cluster and attribute specified.
     - cluster - uint16_t. The cluster id to read from.
     - attribute id - uint16_t. The attribute id to read from
     - data type - uint8_t. The two byte zigbee type value
     - data - byte array. The data to write</i>

   <b>zcl global nwrite &lt;cluster&gt; &lt;attribute id&gt; &lt;data type&gt; &lt;data&gt;</b>
   - <i> Creates a global write command message to write to the
         cluster and attribute specified.
     - cluster - uint16_t. The cluster id to read from.
     - attribute id - uint16_t. The attribute id to read from
     - data type - uint8_t. The two byte zigbee type value
     - data - byte array. The data to write</i>

   <b>zcl global discover &lt;cluster&gt; &lt;attribute id&gt; &lt;max&gt;</b>
   - <i> Creates discovery message for devices with the associated
         cluster and attribute
     - cluster - uint16_t. The cluster id to read from.
     - attribute id - uint16_t. The attribute id to read from
     - max - uint8_t. Max number of discovery responses.</i>

   <b>zcl global report-read &lt;cluster&gt; &lt;attribute id&gt; &lt;direction&gt;</b>
   - <i> Creates a global read reporting command for the associated
         cluster, attribute and server/client direction.
     - cluster - uint16_t. The cluster id to read from.
     - attribute id - uint16_t. The attribute id to read from
     - direction - uint8_t. 0 for client-to-server, 1 for server-to-client.</i>

   <b>zcl global send-me-a-report &lt;cluster&gt; &lt;attribute id&gt; &lt;data type&gt;
      &lt;min report time&gt; &lt;max report time&gt; &lt;reportable change&gt;</b>
   - <i> Creates a global send me a report command for the associated values.
     - cluster - uint16_t. The cluster id for requested report.
     - attribute id - uint16_t. The attribute for requested report.
     - data type - uint8_t. The two byte zigbee type value for the requested report
     - min report time - uint16_t. Minimum number of seconds between reports.
     - max report time - uint16_t. Maximum number of seconds between reports.
     - reportable change - byte array. Amount of change to trigger a report.

   <b>zcl global expect-report-from-me &lt;cluster&gt &lt;attribute id&gt; &lt;timeout&gt;</b>
   - <i> Create a expect-report-from-me message with associated values.
     - cluster - uint16_t. The cluster id for requested report.
     - attribute id - uint16_t. The attribute for requested report.
     - timeout - uint16_t. The maximum amount of time between reports.

   <b>zcl global direction &lt;direction&gt;</b>
   - <i> Sets the direction for global commands, either client to server
         or server to client.
     - direction - uint8_t. The direction for global commands.
       client-to-server == 0, server-to-client == 1.</i>

   <b>zcl global disc-com-gen &lt;start command id&gt; &lt;max command ids&gt;</b>
   - <i> Sends a global Discover Commands Generated command.
     - start command id - uint8_t. The command id to start discovery at.
     - max command ids - uint8_t. The maximum number of command ids to return.

   <b>zcl global disc-com-rec &lt;start command id&gt; &lt;max command ids&gt;</b>
   - <i> Sends a global Discover Commands Received command.
     - start command id - uint8_t. The command id to start discovery at.
     - max command ids - uint8_t. The maximum number of command ids to return.