Specifications
XBee®/XBee‐PRO®SERFModules
©2009DigiInternational,Inc. 108
Networking
Security
NetworkingCommands
AT
Command
Name and Description
Node
Type
1
Parameter Range Default
CH
Operating Channel. Read the channel number used for transmitting and receiving
between RF modules. Uses 802.15.4 channel numbers. A value of 0 means the device
has not joined a PAN and is not operating on any channel.
CRE
0, 0x0B - 0x1A (XBee)
0, 0x0B - 0x18 (XBee-
PRO)
[read-only]
ID
Extended PAN ID. Set/read the 64-bit extended PAN ID. If set to 0, the coordinator will
select a random extended PAN ID, and the router / end device will join any extended
PAN ID. Changes to ID should be written to non-volatile memory using the WR
command to preserve the ID setting if a power cycle occurs.
CRE
0 -
0xFFFFFFFFFFFFFFFF
0
OP
Operating Extended PAN ID. Read the 64-bit extended PAN ID. The OP value reflects
the operating extended PAN ID that the module is running on. If ID > 0, OP will equal ID.
CRE
0x01 -
0xFFFFFFFFFFFFFFFF
[read-only]
NH
Maximum Unicast Hops. Set / read the maximum hops limit. This limit sets the
maximum broadcast hops value (BH) and determines the unicast timeout. The timeout
is computed as (50 * NH) + 100 ms. The default unicast timeout of 1.6 seconds
(NH=0x1E) is enough time for data and the acknowledgment to traverse about 8 hops.
CRE 0 - 0xFF 0x1E
BH
Broadcast Hops. Set/Read the maximum number of hops for each broadcast data
transmission. Setting this to 0 will use the maximum number of hops.
CRE 0 - 0x1E 0
OI
Operating 16-bit PAN ID. Read the 16-bit PAN ID. The OI value reflects the actual 16-
bit PAN ID the module is running on. .
CRE 0 - 0xFFFF [read-only]
SC
Scan Channels. Set/Read the list of channels to scan.
Coordinator - Bit field list of channels to choose from prior to starting network.
Router/End Device - Bit field list of channels that will be scanned to find a Coordinator/
Router to join.
Changes to SC should be written using WR command to preserve the SC setting if a
power cycle occurs.
Bit (Channel): 0 (0x0B) 4 (0x0F) 8 (0x13) 12 (0x17)
1 (0x0C) 5 (0x10) 9 (0x14) 13 (0x18)
2 (0x0D) 6 (0x11) 10 (0x15) 14 (0x19)
3 (0x0E) 7 (0x12) 11 (0x16) 15 (0x1A)
CRE
XBee
1 - 0xFFFF [bitfield]
XBee-PRO
1 - 0x3FFF [bitfield]
(bits 14, 15 not allowed)
0x1FFE
SD
Scan Duration. Set/Read the scan duration exponent. Changes to SD should be
written using WR command.
Coordinator - Duration of the Active and Energy Scans (on each channel) that are
used to determine an acceptable channel and Pan ID for the Coordinator to startup on.
Router / End Device - Duration of Active Scan (on each channel) used to locate an
available Coordinator / Router to join during Association.
Scan Time is measured as:(# Channels to Scan) * (2 ^ SD) * 15.36ms - The number of
channels to scan is determined by the SC parameter. The XBee can scan up to 16
channels (SC = 0xFFFF).
Sample Scan Duration times (13 channel scan):
If SD = 0, time = 0.200 sec
SD = 2, time = 0.799 sec
SD = 4, time = 3.190 sec
SD = 6, time = 12.780 sec
Note: SD influences the time the MAC listens for beacons or runs an energy scan on a
given channel. The SD time is not a good estimate of the router/end device joining time
re
quirements. ZigBee joining adds additional overhead including beacon processing on
each channel, sending a join request, etc. that extend the actual joining time.
CRE 0 - 7 [exponent] 3
ZS
ZigBee Stack Profile. Read the ZigBee stack profile value. This must be set the same
on all devices that should join the same network.
CRE 2 2 [read-only]
NJ
Node Join Time. Set/Read the time that a Coordinator/Router allows nodes to join.
This value can be changed at run time without requiring a Coordinator or Router to
restart. The time starts once the Coordinator or Router has started. The timer is reset
when NJ changes.
CR
0 - 0xFE
[x 1 sec]
0xFE
(maximum of 254 s)
AR
Aggregate Routing Notification. Set/read time between consecutive aggregate route
broadcast messages. If used, AR should be set on only one device to enable many-to-
one routing to the device. Setting AR to 0 sends one broadcast. Setting AR to FF
disables the aggregate route broadcast.
CR 0 - 0xFF [seconds] 0xFF
SecurityCommands
AT
Command
Name and Description
Node
Type
1
Parameter Range Default
EO
Encryption Options. Configure options for encryption. Coordinator is read-only, with a
value of 2. Router and End Device is read-write and defaults to a value of 0. If set to 8,
then Authentication (key establishment) is enabled.
CRE 0 - 0xFF
C: 2
RE: 0
NK
Network Encryption Key. Set the 128-bit AES network encryption key. This command
is write-only; NK cannot be read. If set to 0 (default), the module will select a random
network key.
C128-bit value 0
KY Link Key. Set the 128-bit AES link key. This command is write only; KY cannot be read. CRE 128-bit value 0