If (Sleep Sample Rate); Ir (I/O Sample Rate); Is (Force Sample) - Digi XBee-PRO S3 User Manual

AT commands

IF (Sleep Sample Rate)

Set or read the number of sleep cycles that must elapse between periodic I/O samples. This allows
the firmware to take I/O samples only during some wake cycles. During those cycles, the firmware
takes I/O samples at the rate specified by IR.
Parameter range
1 - 0xFF
Default
1

IR (I/O Sample Rate)

Set or read the I/O sample rate to enable periodic sampling.
If you set the I/O sample rate to greater than 0, the device samples and transmits all enabled digital
I/O and analog inputs every IR milliseconds. I/O Samples transmit to the address specified by DT.
To enable periodic sampling, set IR to a non-zero value, and enable the analog or digital I/O
functionality of at least one device pin. The sample rate is measured in milliseconds.
For more information, see the following commands:
D0 (DIO0/AD0)
n
P0 (DIO10/RSSI/PWM0 Configuration)
n
WARNING! If you set IR to 1 or 2, the device will not keep up and many samples will be lost.
Parameter range
0 - 0xFFFF (x 1 ms)
Default
0

IS (Force Sample)

Forces a read of all enabled digital and analog input lines. The data is returned through the UART or
SPI.
When operating in Transparent mode (AP = 0), the data is returned in the following format:
All bytes are converted to ASCII:
number of samples<CR>
channel mask<CR>
DIO data<CR> (If DIO lines are enabled)
ADC channel Data<CR> (This will repeat for every enabled ADC channel)
<CR> (end of data noted by extra <CR>)
When operating in API mode (AP = 1), the command immediately returns an OK response. The data
follows in the normal API format for DIO data.
Parameter range
N/A
XBee®-PRO 900HP/XSC RF Modules
through D9 (DIO9/ON_SLEEP).
through
I/O sampling commands
P4 (DIO14/DIN).
105