Ember Application Framework Command Line Interface (CLI)

Modules

Attribute Management
 
Building and Sending Messages
 
Endpoint Manipulation
 
General
 
Global ZCL
 
Informational
 
Network
 
Security
 
Test Harness
 
ZigBee Device Object Commands (ZDO)
 
Cluster Commands: BACnet Protocol Tunnel
 
Cluster Commands: Barrier Control
 
Cluster Commands: Basic
 
Cluster Commands: Calendar
 
Cluster Commands: Color Control
 
Cluster Commands: Configuration Cluster
 
Cluster Commands: Demand Response and Load Control
 
Cluster Commands: Device Management
 
Cluster Commands: Door Lock
 
Cluster Commands: Events
 
Cluster Commands: Generic Tunnel
 
Cluster Commands: Groups
 
Cluster Commands: IAS ACE
 
Cluster Commands: IAS Zone
 
Cluster Commands: Identify
 
Cluster Commands: Level Control
 
Cluster Commands: MFGLIB Cluster
 
Cluster Commands: Messaging
 
Cluster Commands: On/off
 
Cluster Commands: Poll Control
 
Cluster Commands: Power Profile
 
Cluster Commands: Prepayment
 
Cluster Commands: Price
 
Cluster Commands: SL Works With All Hubs
 
Cluster Commands: Scenes
 
Cluster Commands: Simple Metering
 
Cluster Commands: Thermostat
 
Cluster Commands: Tunneling
 
Cluster Commands: Window Covering
 
Plugin Commands for Bulb Pwm Driver
 
Plugin Commands: APS Link Key Authorization
 
Plugin Commands: Address Table
 
Plugin Commands: BLE
 
Plugin Commands: Barrier Control Server Cluster
 
Plugin Commands: Button Joining
 
Plugin Commands: Calendar Client
 
Plugin Commands: Calendar Common
 
Plugin Commands: Calendar Server
 
Plugin Commands: Command Relay
 
Plugin Commands: Comms Hub Function
 
Plugin Commands: Comms Hub Function (SubGhz)
 
Plugin Commands: Compact Logger
 
Plugin Commands: Concentrator
 
Plugin Commands: Connection Manager
 
Plugin Commands: Counters
 
critical-message-queue Plugin Commands: Critical Message Queue
 
Plugin Commands: Demand Response and Load Control
 
Plugin Commands: Demand Response and Load Control Server
 
Plugin Commands: Device Database
 
Plugin Commands: Device Management Client
 
Plugin Commands: Device Management Server
 
Plugin Commands: Device Query Service
 
Plugin Commands: Device Table
 
Plugin Commands: Door Lock Server Cluster
 
Plugin Commands: EEPROM
 
Plugin Commands: EZ-Mode Commissioning
 
Plugin Commands: Electrical Measurement Server commands
 
Plugin Commands: End Device Support
 
Plugin Commands: Events Server
 
Plugin Commands: Find and Bind Initiator
 
Plugin Commands: Find and Bind Target
 
Plugin Commands: Fragmentation
 
Plugin Commands: GBCS Device Log
 
Plugin Commands: GBCS Gas Meter
 
Plugin Commands: Gas Proxy Function
 
Plugin Commands: Green Power Client
 
Plugin Commands: Green Power Server
 
Plugin Commands: Green Power Test Device
 
Plugin Commands: Groups Server
 
Plugin Commands: IAS Zone Client
 
Plugin Commands: IAS Zone Server
 
Plugin Commands: Identify
 
Plugin Commands: Idle/Sleep
 
Plugin Commands: Illuminance Measurement Server commands
 
Plugin Commands: Interpan
 
Plugin Commands: Key Establishment
 
Plugin Commands: Low Voltage Shutdown
 
Plugin Commands: MPSI
 
Plugin Commands: Mac address filtering
 
Plugin Commands: Manufacturing Library
 
Plugin Commands: Manufacturing Library CLI
 
Plugin Commands: Messaging Client
 
Plugin Commands: Messaging Server
 
Plugin Commands: Meter Mirror
 
Plugin Commands: Meter Snapshot Server
 
Plugin Commands: Multi-Network Price Passthrough
 
Plugin Commands: Network Creator
 
Plugin Commands: Network Creator Security
 
Plugin Commands: Network Find
 
Plugin Commands: Network Steering
 
Plugin Commands: OTA Bootload
 
Plugin Commands: OTA Client
 
Plugin Commands: OTA Server
 
Plugin Commands: OTA Simple Storage EEPROM
 
Plugin Commands: OTA Storage Common
 
Plugin Commands: PS Store
 
Plugin Commands: PYD-1698 Occupancy Sensor CLI
 
Plugin Commands: Partner Link Key Exchange
 
Plugin Commands: Poll Control Client
 
Plugin Commands: Power Consumption Model CLI
 
Plugin Commands: Prepayment Server
 
Plugin Commands: Price Client
 
Plugin Commands: Price Common
 
Plugin Commands: Price Server
 
Plugin Commands: Relative Humidity Measurement Server commands
 
Plugin Commands: Relay Control Server
 
Plugin Commands: Reporting
 
Plugin Commands: SB1 Gesture Sensor
 
Plugin Commands: Scenes Server
 
Plugin Commands: Simple Metering Client
 
Plugin Commands: Simple Metering Server
 
Plugin Commands: Simple Metering Server
 
Plugin Commands: Sleepy Message Queue
 
Plugin Commands: Slot Manager
 
Plugin Commands: Smart Energy Registration
 
Plugin Commands: Stack Diagnostics
 
Plugin Commands: Standalone Bootloader Client
 
Plugin Commands: Standalone Bootloader Server
 
Plugin Commands: Sub-GHz Client
 
Plugin Commands: Sub-GHz Server
 
Plugin Commands: Temperature Measurement Server commands
 
Plugin Commands: Test Harness
 
Plugin Commands: Throughput
 
Plugin Commands: Throughput Legacy
 
Plugin Commands: Trust Center Backup
 
Plugin Commands: Tunneling Client
 
Plugin Commands: Tunneling Server
 
Plugin Commands: Update TC Link Key
 
Plugin Commands: Wwah Connectivity Manager
 
Plugin Commands: Wwah Server
 
Plugin Commands: ZigBee 3.0 Test Harness
 
Plugin Commands: ZigBee Light Link (ZLL) Commissioning
 
Plugin Commands: Zigbee Event Logger
 
Plugin Commands: em4

Macros

#define EMBER_AF_DOXYGEN_CLI__NETWORK_COMMANDS
 network form <channel> <power> <panid>
 
#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.
 
#define EMBER_AF_DOXYGEN_CLI__SECURITY_CBKE_COMMANDS
 Command used for key establishment.
 
#define EMBER_AF_DOXYGEN_CLI__ZCL_GLOBAL_COMMANDS
 Commands used to send global commands in the zcl.

Detailed Description

This header provides cli command function prototypes for the Application Framework's core ZigBee Cluster Library implementation.

Macro Definition Documentation

#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 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.

#define EMBER_AF_DOXYGEN_CLI__SECURITY_CBKE_COMMANDS

Command used for key establishment.

cbke start <new partner id> <destination endpoint>

  • new partner ID - uint16_t. The 2 byte node ID of the partner with whom to start cbke.

cbke interpan <pan id> <eui64>

  • 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)

cbke partner <node id> <endpoint>

  • 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.
#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.
#define EMBER_AF_DOXYGEN_CLI__ZCL_GLOBAL_COMMANDS

Commands used to send global commands in the zcl.

zcl global read <cluster> <attribute id>

  • 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

zcl global write <cluster> <attribute id> <data type> <data>

  • 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

zcl global uwrite <cluster> <attribute id> <data type> <data>

  • 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

zcl global nwrite <cluster> <attribute id> <data type> <data>

  • 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

zcl global discover <cluster> <attribute id> <max>

  • 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.

zcl global report-read <cluster> <attribute id> <direction>

  • 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.

zcl global send-me-a-report <cluster> <attribute id> <data type> <min report time> <max report time> <reportable change>

  • 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.

zcl global expect-report-from-me <cluster&gt <attribute id> <timeout>

  • 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.

zcl global direction <direction>

  • 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.

zcl global disc-com-gen <start command id> <max command ids>

  • 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.

zcl global disc-com-rec <start command id> <max command ids>

  • 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.