Digi XBee-PRO S3 Manual

XBee‐PRO®900HP/XBee‐PRO®XSCRFModules
©2014DigiInternationalInc. 56
Sleep Diagnostics
SN
Number of Sleep Periods. The number of sleep periods value. This command controls
the number of sleep periods that must elapse between assertions of the ON_SLEEP
line during the wake time of asynchronous cyclic sleep. During cycles when the
ON_SLEEP line is not asserted, the module will wake up and check for any serial or RF
data. If any such data is received, then the ON_SLEEP line will be asserted and the
module will fully wake up. Otherwise, the module will return to sleep after checking. This
command does not work with synchronous sleep.
1 - 0xFFFF 1
SP
Sleep Period. The sleep period of the module. This command defines the amount of
time the module will sleep per cycle.For a node operating as an Indirect Messaging
Coordinator, this command defines the amount of time that it will hold an indirect
message for an Indirect Messaging Poller. The coordinator will hold the message for
(2.5*SP).
1 - 1440000 (x 10 ms) 2 seconds
ST
Wake Time. The wake period of the module.
For asynchronous sleep modules, this command defines the amount of time that the
module will stay awake after receiving RF or serial data.
For synchronous sleep modules, this command defines the amount of time that the
module will stay awake when operating in cyclic sleep mode. This value will be adjusted
upwards automatically if it is too small to function properly based on other settings.
0x45-0x36EE80 0x7D0 (2 seconds)
WH
Wake Host. 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 after waking from sleep before sending
data out the UART or transmitting an I/O sample. If serial characters are received, the
WH timer is stopped immediately.
When in synchronous sleep, the device will shorten its sleep period by the value
specified by the WH command to ensure that it is prepared to communicate when the
network wakes up. When in this this sleep mode, the device will always stay awake for
the WH time plus the amount of time it takes to transmit a one-hop unicast to another
node.
0-0xFFFF (x 1ms) 0
Table5‐011. Diagnostics‐SleepStatusTiming
AT
Command
Name and Description Parameter Range Default
SS
Sleep Status. The SS command can be used to query a number of Boolean values
describing the status of the module.
Bit 0: This bit will be true when the network is in its wake state.
Bit 1: This bit will be true if the node is currently acting as a network sleep
coordinator.
Bit 2: This bit will be true if the node has ever received a valid sync message since
the time it was powered on.
Bit 3: This bit will be true if the node has received a sync message in the current
wake cycle.
Bit 4: This bit will be true if the user has altered the sleep settings on the module so
that the node will nominate itself and send a sync message with the new settings
at the beginning of the next wake cycle.
Bit 5: This bit will be true if the user has requested that the node nominate itself as
the sleep coordinator (using the commissioning button or the CB2 command).
Bit 6 = This bit will be true if the node is currently in deployment mode.
All other bits: Reserved - All non-documented bits can be any value and should be
ignored.
[read-only] 0x40
OS
Operational Sleep Period. The sleep period that the node is currently using. This
number will oftentimes be different from the SP parameter if the node has synchronized
with a sleeping router network.
Units of 10mSec
[read-only] 0x12C
OW
Operational Wake Period. The wake time that the node is currently using. This number
will oftentimes be different from the ST parameter if the node has synchronized with a
sleeping router network.
Units of 1 ms
[read-only] 0xBB8
MS
Number of Missed Syncs. The number of wake cycles that have elapsed since the last
sync message was received. Supported in the mesh firmware variant only.
[read-only] 0
SQ
Missed Sync Count. Count of the number of syncs that have been missed. This value
can be reset by setting ATSQ to 0. When the value reaches 0xFFFF it will not be
incremented anymore.
0-0xFFFF 0
AT
Command
Name and Description Parameter Range Default

Digi XBee-PRO S3 Specifications

General

Brand	Digi
Model	XBee-PRO S3
Category	Control Unit
Language	English