Digi XBee3 802.15.4 User Manual

I/O support On-demand sampling
Digi XBee3® 802.15.4 RF Module User Guide
48
the receiver must be operating in API mode (AP = 1 or 2). The sample data is represented as an I/O
sample API frame.
There are three types of I/O sample frames that are supported by the XBee3 802.15.4 RF Module:
n 0x92 - Enhanced I/O sample frame
n 0x82 - Legacy 64-bit I/O sample frame
n 0x83 - Legacy 16-bit I/O sample frame
IfAO= 0 or 1 on both the source and destination node, then a 0x92 frame is generated on the
destination.
SeeI/O Data Sample Rx Indicator frame - 0x92 for more information on the frame's format and an
example.
For all other cases, the destination node generates either a 0x82 or 0x83 frame depending on
whether the source node is operating in a 16-bit or 64-bit configuration. See Addressing modes for
more information.
See Legacy support for more information on what configuration options generate the various I/O
frames.
On-demand sampling
You can useIS command to query the current state of all digital I/O and ADC lines on thedevice and
return the sample data as an AT command response.If no inputs or outputs are defined, the
command returns an ERROR.
On-demand sampling can be useful when performing initial deployment, as you can send IS locally to
verify that the device and connected sensors are correctly configured. The format of the sample data
matches what is periodically sent using other sampling methods. You can also send IS remotely using
a remote AT command. When sent remotely from a gateway or server to each sensor node on the
network, on-demand sampling can improve battery life and network performance as the remote node
transmits sample data only when requested instead of continuously.
If you send IS usingCommand mode, then the device returns a carriage return delimitedlist
containing the I/O sample data.If IS is sent either locally or remotely via an API frame, the I/O sample
data is presented as the parameter value in the AT command response frame (AT Command
Response frame - 0x88 or Remote Command Response frame - 0x97).
Example: Command mode
An IScommand sent in Command mode returns the following sample data:
This example uses the enhanced I/O data format, if you use the legacy format (AO= 2 or data is
received from an S1 or S2C device) then refer to the Legacy data format for information on how this
data is structured.
Output Description
01 One sample set
0C0C Digital channel mask, indicates which digital lines are sampled
(0x0C0C = 00001100 00001100b = DIO2, 3, 10, 11)

Digi XBee3 802.15.4 Specifications

General

Brand	Digi
Model	XBee3 802.15.4
Category	Control Unit
Language	English