xbee

Purpose

Executes an XBee utility or displays the status of actions performed by the XBee utilities. The actions include displaying information about the XBee network setup, sending loopback data, displaying the status of XBee firmware, and scheduling, canceling, and viewing status of XBee firmware updates.

Some variants of the xbee command are available on certain XBee networks only.

• The following XBee utilities are only available on XBee ZB and XBee SE networks:
  • Display child table: Displays a list of end devices that are joined to a router node.
  • Display neighbor table: Displays a list of nodes one hop away from the specified node.
  • Display source route: Displays the source route received from a node when many-to-one routing is being used.
  • Display route: Displays the route between two nodes when ad-hoc on-demand routing is being used.  The default source node is the gateway.
• The following XBee utilities are available on all XBee networks except XBee 802.15.4 and XBee SE:
  • Display identify messages: Identify messages are used to determine the physical location of remote nodes. This XBee utility displays identify messages on the command line as they are received from remote nodes. A remote node may send this message when a user presses its commissioning button, or by some other means.
  • Send identify message: Sends an identify message to a remote node. This action may cause the remote node to blink its LED, or give some other indication it received the message.
  • Send loopback data: Tests communication with a remote node.This action sends a message that the node repeats back to the gateway.
• The following XBee utilities are only available on XBee ZB networks:
  • Schedule an XBee firmware update: Schedules XBee firmware updates for the XBee RF module on the gateway and on XBee network nodes.
  • Cancel an XBee firmware update: Cancels a previously scheduled XBee firmware update.
  • View the status of XBee firmware updates: Displays status of scheduled firmware updates for all nodes, both the gateway and remote nodes.

Syntax and options

Display child table

xbee child_table node

Where:

node

A node serving as a router in an XBee network, specified by its node ID, 16-bit network address, or extended address.

Display neighbor table

xbee neighbor_table node

Where:

node

A node serving as a router in an XBee network, specified by its node ID, 16-bit network address, or extended address.

Display source route

xbee source_route node

Where:

node

An XBee network node, specified by its node ID, 16-bit network address, or extended address.

Display route

xbee route destination [source] 

Where:

source

The source node to use as the start of the displayed route. The route to display starts at the source node and ends at the destination node. The default source node is the gateway.

Display or turn off identify messages

xbee identify {on|off} 

Send identify message

xbee identify node [seconds]

Where:

node

The node to which an identify message is sent, specified by its node ID, 16-bit network address, or extended address. Identify messages are used to determine the physical location of remote nodes

seconds

The duration of the identification; for example, the length of time an LED displays a blink pattern.

Send loopback data

xbee ping node [count] [size] [interval_ms] 

Where:

count

The number of messages to send. The default is 4 messages.

size

The number of bytes in each message. The default is 16 bytes.

interval_ms

The interval between messages, in milliseconds. The default is 1000 milliseconds.

Schedule an XBee firmware update

The syntax for scheduling an XBee firmware update is:

xbee fw_update target [updater] [file]

Where:

target

The node to update, specified either by its node ID or extended address.

updater

An optional nearby node to control the firmware update. The default is to choose a node automatically.

file

The file containing the XBee firmware update, ending in an .ebl extension. The default is to automatically select a file from the files that have been uploaded to the gateway, if possible. On gateways supporting XBee 3 OTA updates, files with the extensions .ota and .otb are allowed.

Cancel an XBee firmware update

xbee fw_update target cancel

target

Node for the firmware update is canceled, specified either by its node ID or extended address.

cancel

Indicates that the firmware update for the specified node should be canceled.

View the status of XBee firmware updates

xbee fw_update

This command shows a table of scheduled firmware updates for all nodes (both the gateway and remote nodes) and the status. Status fields that display are listed in the following table:

Field	Description
Node ID	The user-assigned identifier of the node.
Extended Address	The unique 64-bit MAC address of the node.
HW	The hardware type and version of the node. XBP indicates that the node is an XBee-PRO module. S2B indicates an XBee-PRO S2B node. S2C indicates an XBee S2C node. S2CP indicates an XBee PRO S2C node.
FW	The current firmware version of the node.
Status	The firmware update status of the node. It may be one of these values: Unknown: Current firmware version has not yet been read from the node, or cannot be read from the node. Up to date: The node is running the latest firmware version available on the Digi device server. Available: A newer version of firmware is available on the gateway. Schedule an update using the “xbee fw_update” command or the Configuration > XBee Network > OTA Firmware Update Status page of the web interface. Scheduled: A firmware update is scheduled to be performed on this node. Updating: A firmware update is now being performed on this node. Updated: A successful firmware update has been performed on this node. Complete: The node has rejoined the network after a successful firmware update. Cancelled: A firmware update for this node has been cancelled by a user. Error: A firmware update on this node has failed. Schedule an update using the “xbee fw_update” command or the Configuration > XBee Network > OTA Firmware Update Status page of the web interface
File	The firmware file used to update the node.

Examples

Ping a remote node:

#> xbee ping adapter

Update firmware on a node:

#> xbee fw_update adapter firmware_file.ebl

Display firmware update status:

#> xbee fw_update

See also

• display Xbee
• info xbee
• set xbee
• For more information about the XBee utilities executed by this command, see the XBee Product Manual for the XBee modules in your gateway and nodes on digi.com, and the ZigBee specification.