XBee®/XBee‐PRO® ZB SMT RF Modules
Sleep Commands
Sleep Commands
AT
Name and Description
Command
Parameter Range
Default
Sleep Mode Sets the sleep mode on the RF module. When SM>0, the module operates
0-Sleep disabled (router)
1-Pin sleep enabled
4-Cyclic sleep enabled
5 - Cyclic sleep, pin wake
0 - Router
4 - End
Device
as an end device. However, CE must be 0 before SM can be set to a value greater than
0 to turn the module into an end device. Changing a device from a router to an end
device (or vice versa) forces the device to leave the network and attempt to join as the
new device type when changes are applied.
SM
SN
SP
ST
Number of Sleep Periods. Sets the number of sleep periods to not assert the On/Sleep
pin on wakeup if no RF data is waiting for the end device. This command allows a host 1 - 0xFFFF
application to sleep for an extended time if no RF data is present
1
Sleep Period. This value determines how long the end device will sleep at a time, up to
28 seconds. (The sleep time can effectively be extended past 28 seconds using the SN 0x20 - 0xAF0 x 10ms
command.) On the parent, this value determines how long the parent will buffer a
message for the sleeping end device. It should be set at least equal to the longest SP
time of any child end device.
(Quarter second
resolution)
0x20
Time Before Sleep Sets the time before sleep timer on an end device.The timer is reset
each time serial or RF data is received. Once the timer expires, an end device may enter 1 - 0xFFFE (x 1ms)
low power operation. Applicable for cyclic sleep end devices only.
0x1388 (5
seconds)
Sleep Options. Configure options for sleep. Unused option bits should be set to 0.
Sleep options include:
0x02 - Always wake for ST time
0x04 - Sleep entire SN * SP time
SO
Command
0 - 0xFF
0
Sleep options should not be used for most applications. See chapter 6 for more
information.
Wake Host. Set/Read the wake host timer value. If the wake host timer is set to a non-
zero value, this timer specifies a time (in millisecond units) that the device should allow
WH
0 - 0xFFFF (x 1ms)
after waking from sleep before sending data out the serial port or transmitting an I/O
sample. If serial characters are received, the WH timer is stopped immediately.
SI
Sleep Immediately. See Execution Commands table below..
Polling Rate. Set/Read the end device poll rate. Setting this to 0 (default) enables
polling at 100 ms (default rate). Adaptive polling may allow the end device to poll more 0 - 0x3E8
rapidly for a short time when receiving RF data.
0x00 (100
msec)
PO
Execution Commands
Where most AT commands set or query register values, execution commands cause an action to
be executed on the module. Execution commands are executed immediately and do not require
changes to be applied.
Execution Commands
AT
Command
Name and Description
Parameter Range Default
Apply Changes. Applies changes to all command registers causing queued command
register values to be applied. For example, changing the serial interface rate with the BD
command will not change the UART interface rate until changes are applied with the AC
command. The CN command and 0x08 API command frame also apply changes.
AC
-
Write. Write parameter values to non-volatile memory so that parameter modifications
persist through subsequent resets.
WR
--
--
Note: Once WR is issued, no additional characters should be sent to the module until
after the "OK\r" response is received. The WR command should be used sparingly. The
EM357 supports a limited number of write cycles.
RE
FR
Restore Defaults. Restore module parameters to factory defaults.
--
--
--
--
Software Reset. Reset module. Responds immediately with an OK status, and then
performs a software reset about 2 seconds later.
Network Reset. Reset network layer parameters on one or more modules within a PAN.
Responds immediately with an “OK” then causes a network restart. All network
configuration and routing information is consequently lost.
If NR = 0: Resets network layer parameters on the node issuing the command.
If NR = 1: Sends broadcast transmission to reset network layer parameters on all nodes
in the PAN.
NR
0 - 1
--
-
Sleep Immediately. Cause a cyclic sleep module to sleep immediately rather than wait
for the ST timer to expire.
SI
-
Commissioning Pushbutton. This command can be used to simulate commissioning
button presses in software. The parameter value should be set to the number of button
presses to be simulated. For example, sending the ATCB1 command will execute the
action associated with 1 commissioning button press.
CB
© 2010 Digi International, Inc.
135
DCD [ DIGITAL CORE DESIGN ]
