Digi XBee 3 ZigBee User Manual

I/O support API frame support
Digi XBee® 3 Zigbee® RF Module
171
Bytes Name Description
1 Analog
channel
mask
Indicates which lines have analog inputs enabled for sampling. Each bit in the
analog channel mask corresponds to one analog input channel. If a bit is set,
then a corresponding 2-byte analog data set is included.
bit 0 = AD0/DIO0
bit 1 = AD1/DIO1
bit 2 = AD2/DIO2
bit 3 = AD3/DIO3
2 Digital
data set
Each bit in the digital data set corresponds to a bit in the digital channel mask
and indicates the digital state of the pin, whether high (1) or low (0).
If the digital channel mask is 0x0000, then these two bytes are omitted as no
digital I/O lines are enabled.
2 Analog
data set
(multiple)
Each enabled ADC line in the analog channel mask will have a separate 2-byte
value based on the number of ADC inputs on the originating device. The data
starts with AD0 and continues sequentially for each enabled analog input
channel up to AD3.
If the analog channel mask is 0x00, then no analog sample bytes is included.
API frame support
I/O samples generated using Periodic I/O sampling (IR) and Digital I/O change detection (IC) are
transmitted to the destination address specified byDHandDL. In order to display the sample data,
the receiver must be operating in API mode (AP = 1 or 2). The sample data is represented as an I/O
sample API frame.
SeeI/O Data Sample Rx Indicator frame - 0x92 for more information on the frame's format and an
example.
On-demand sampling
You can useIS (Force Sample) 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:

Digi XBee 3 ZigBee Specifications

General

Brand	Digi
Model	XBee 3 ZigBee
Category	Control Unit
Language	English