Digi XBee3 802.15.4 User Manual

I/O support Output sample data
Digi XBee3® 802.15.4 RF Module User Guide
56
Output sample data
If a device receives an I/O sample whose address matches that set byIA (I/O Input Address), it
triggers line passing. Line passing operates whether the receiving device is operating in API or
Transparent mode.
By default, if the receiver is configured for API mode, it outputs the I/O sample frame in addition to
affecting output pins. You can suppress the I/O sample frame output by settingIU commandto 0. This
only suppresses I/O samples that trigger line passing, a sample generated from a device whose
address does not match theIAaddress is sent regardless ofIU.
Output control
IO command controls the output levels of D0 command through D7 command that are configured as
output pins (either 4 or 5). These values override the configured output levels of the pins until they are
changed again (the pins do not automatically revert to their configured values after a timeout.)
You can use IO to trigger a sample on change detect.
I/O behavior during sleep
When the device sleeps (SM ! = 0) the I/O lines are optimized for a minimal sleep current.
Digital I/O lines
Digital I/O lines set as digital output high or low maintain those values during sleep. Disabled or input
pins continue to be controlled by the PR/PD settings. Peripheral pins (with the exception of CTS) are
set low during sleep and SPI pins are set high. Peripheral and SPI pins resume normal operation upon
wake.
Digital I/O lines that have been set using I/O line passing hold their values during sleep, however the
digital timeout timer (T0 through T9, and Q0 through Q2) are suspended during sleep and resume
upon wake.
Analog and PWM I/O Lines
Lines configured as analog inputs or PWM output are not affected during sleep. PWM lines are shut
down (set low) during sleep and resume normal operation upon wake.
PWM output pins set by analog line passing are shutdown during sleep and revert to their preset
values (M0 and M1) on wake. This happens regardless of whether the timeout has expired or not.

Digi XBee3 802.15.4 Specifications

General

Module Type	XBee3
Protocol	802.15.4
Frequency Band	2.4 GHz
Data Rate	Up to 250 kbps
Range (Line of Sight)	1200 m
Operating Temperature	-40° C to +85° C
Security	AES-128
I/O Interfaces	UART, SPI, I2C
Antenna Options	U.FL
Power Supply	2.1 to 3.6 VDC

Summary

Trademarks and Copyright

Disclaimers

Warranty

Customer Support

Applicable Firmware and Hardware

Firmware Support

Information on supported firmware versions for the module.

Hardware Support

Details on the compatible hardware versions for the module.

Get Started

Verify Kit Contents

Lists the components included in the XBee3 development kit.

Assemble the Hardware

Instructions for assembling and disassembling hardware components.

Configure the Device Using XCTU

Steps for configuring the device using the XBee Configuration and Test Utility.

Perform a Range Test

Procedure for testing RF range and link quality between two modules.

Configure the XBee3 802.15.4 RF Module

Over-the-Air (OTA) Firmware Update

Instructions for updating firmware remotely using XCTU.

Custom Defaults

How to set and manage custom default device configurations.

Modes

Transparent Operating Mode

Device behavior as a serial line replacement for RF transmission.

API Operating Mode

Structured interface for complex communication using packets.

Command Mode

State for interacting with the device via AT commands for configuration.

Serial Communication

Serial Interface

How the module interfaces with host devices via UART or SPI.

Flow Control

Mechanisms to manage data flow and prevent buffer overflow.

SPI Operation

SPI Communications

Details on SPI signals, directions, and functions in slave mode.

Low Power Operation

How sleep modes function with SPI and UART interfaces.

I/O Support

Digital I/O Support

Configuration of digital I/O lines for input, output, and sampling.

Analog I/O Support

Configuration of analog inputs for sampling and PWM outputs.

Periodic I/O Sampling

How to sample I/O pins at a periodic rate.

Digital I/O Change Detection

Triggering samples based on digital pin state changes.

Networking

MAC Mode Configuration

Settings for Digi header and MAC acknowledgments.

Addressing

How source and destination addresses are handled in RF packets.

Encryption

Enabling and controlling AES 128-bit encryption for RF transmissions.

Maximum Payload

Factors affecting the maximum data payload size in packets.

Sleep Support

Sleep Modes

Configurations for Pin Sleep, Cyclic Sleep, and Pin Wake-up modes.

Sleep Parameters

AT commands related to sleep mode configuration and timing.

Sleep Conditions

Factors that prevent the device from entering sleep mode.

AT Commands

Network and Security Commands

Commands for network channel, ID, security, and compatibility settings.

802.15.4 Addressing Commands

Commands for setting source, destination, and network addresses.

UART Interface Commands

Commands for configuring serial communication parameters.

I/O Settings Commands

Commands for configuring the module's digital and analog I/O pins.

I/O Sampling Commands

Commands for reading I/O pin states and generating sample data.

Operate in API Mode

API Mode Overview

Benefits and structure of API mode for device communication.

API Frame Format

Structure and fields of API frames for data exchange.

Frame Descriptions

TX Request: 64-bit Address Frame - 0x00

Frame for sending data to a specific 64-bit address.

AT Command Frame - 0x08

Frame for querying or setting local AT command parameters.

RX Packet: 64-bit Address Frame - 0x80

Frame indicating receipt of data via 64-bit addressing.

AT Command Response Frame - 0x88

Frame indicating the result of an AT Command request.

TX Status Frame - 0x89

Frame indicating the status of a transmitted packet.

OTA Firmware Upgrade Process for 802.15.4

OTA/OTB File

Structure and format of OTA firmware image files.

Create the Image Notify Request

Frame used to inform the client about an available firmware update.

Query Next Image Request

Client request for the next firmware image block.

Image Block Request

Client request for specific bytes of the OTA firmware image.

OTA Error Handling

Troubleshooting common errors during the OTA upgrade process.