display Xbee
Purpose
Displays a list of devices in an XBee network and information about the devices. You can a use this command to display information about a single specified device in an XBee network. Information displayed includes the node address and ID list, as well as individual node status. Options allow for refreshing, clearing, and sorting the list of displayed devices.
The settings returned by this command vary by XBee RF module and the XBee RF protocol running on the module. For complete descriptions of these settings, see the product manual for the XBee RF module.
Required permissions
For Digi products with two or more users, set permissions to set permissions display=execute to use this command. See set permissions for details on setting user permissions for commands.
Syntax
Display a list of devices in an XBee network
display xbee [refresh] [zigbee]
[clear]
[sort={id|network|extended|node|product}]
Display information for a specific device in an XBee network
display xbee [address={id|address}]
Options
refresh
Discover XBee devices using a Digi-specific method, the XBee ND command.
zigbee
Discover XBee devices using a ZigBee standard method known as ZDO requests.
clear
Clear list and discover devices again.
Note If no discover option (refresh, zigbee, or clear,) is specified on a display xbee command, the current list of XBee devices is displayed. New nodes are added to the list as they join the network.
sort={id|network|extended|node|product}]
Sort the displayed device list by the specified field.
id
Sort the device list by node ID. The node ID is a text label that can be set by the command set xbee address=node_id.
network
Sort the device list by network address.
extended
Sort the device list by extended address.
node
Sort the device list by node ID.
product
Sort the device list by product type.
address={id|address}
The address of the node, specified by its node ID, 16-bit network address, or extended address. To display the node list, issue a display xbee command without options, or go to this page in the web interface: Configuration > XBee Network. If the address is not specified, the device settings for the local XBee module on the gateway are displayed.
id
PAN ID.
address
Extended address.
Examples
Display XBee network information
#> display xbee
XBee network device list
PAN ID: 0x1c1f - 0x460a9fcc95a2dc14
Channel: 0x13 (2445 MHz)
Gateway address: 00:13:a2:00:40:2d:c6:74!
Gateway firmware: 0x2141
Node ID Network Extended address Node type Product type
--------------- ------- ------------------------ ----------- ------------
[0000]! 00:13:a2:00:40:2d:c6:74! coordinator ConnectPort X5
1 coordinator
To display device details:
display xbee address=(id|address)
#> display xbee
XBee network device list
PAN ID: 0x77e5 - 0x0000000000000072
Channel: 0x0e (2420 MHz)
Gateway address: 00:13:a2:00:40:31:8a:f3!
Gateway firmware: 0x2170
Node ID Network Extended address Node type Product type
--------------- ------- ------------------------ ----------- ------------
[0000]! 00:13:a2:00:40:31:8a:f3! coordinator X4 Gateway
[f63f]! 00:13:a2:00:40:3c:54:a1! router Digital IO Adapter
1 coordinator, 1 router
Display device details
#> display xbee address=00:13:a2:00:40:66:a1:b2!
Status of device: 00:13:a2:00:40:66:a1:b2!
pan_id (OI): 0xd367
ext_pan_id (OP): 0xf837cf1a74422f40
channel (CH): 0xe
net_addr (MY): 0x0
association (AI): 0x0
firmware_version (VR): 0x2170
hardware_version (HV): 0x1e42
device_type (DD): 0x30002
children (NC): 10
max_payload (NP): 255 (bytes)
supply_voltage (%V): 3326 (mvolts)
temperature (TP): 41 (degrees C)
rssi (DB): 13 (-dBm)
tx_power (PP): 18 (dBm)
ack_failures (EA): 0
PDF
