Digi XBee3 802.15.4 User Manual

Network commissioning and diagnostics Node discovery
Digi XBee3® 802.15.4 RF Module User Guide
73
Commands Syntax Description
ND
command
ND
Seeks to discover all nodes in the network (on the current PAN ID).
ND
command
ND<NI
String>
Seeks to discover if a particular node named <NI String> is found in the
network.
DN
command
DN<NI
String>
Sets DH/DL to point to the address (64-bit or 16-bit depending on the MY
value of the matching node) of the node whose <NI String> matches.
The node discovery command (without an NI string designated) sends out a broadcast to every node
in the PAN ID. Each node in the PAN sends a response back to the requesting node after a jittered
time delay to ensure reliable delivery.
About node discovery
The node discovery command (without an NI string designated) sends out a broadcast to every node
in the PAN ID. Each node in the PAN sends a response back to the requesting node.
When the node discovery command is issued in AT command mode, all other AT commands are
inhibited until the node discovery command times out, as specified by the NT parameter. After the
timeout, an extra CRLF is output to the terminal window, indicating that new AT commands can be
entered. This is the behavior whether or not there were any nodes that responded to the broadcast.
When the node discovery command is issued in API mode, the behavior is the same except that the
response is output in API mode. If no nodes respond, there will be no responses at all to the node
discover command. The requesting node is not able to process a new AT command until NT times out.
Node discovery in compatibility mode
Node discovery (without an NI string parameter) in compatibility mode operates the same in
compatibility mode as it does outside of compatibility mode with one minor exception:
If C8 bit 1 is set and if requesting node is operating in API mode and if no responses are received by
the time NT times out, then an API AT command response of OK (API frame type 0x88) is sent out the
serial port rather than giving no response at all, which would happen if C8 bit 1 is not set.
Directed node discovery
The directed node discovery command (ND with an NI string parameter) sends out a broadcast to find
a node in the network with a matching NI string. If such a node exists, it sends a response with its
information back to the requesting node.
In Transparent mode, the requesting node will output an extra CRLF following the response from the
designated node and the command will terminate, being ready to accept a new AT command. In the
event that the requested node does not exist or is too slow to respond, the requesting node outputs
an ERROR response after NT expires.
In API mode, the response from the requesting node will be output in API mode and the command will
terminate immediately. If no response comes from the requested node, the requesting node outputs
an error response in API mode after NT expires.
Directed node discovery in compatibility mode
The behavior of the Legacy 802.15.4 module (S1 hardware) varies with the default behavior described
above for the directed node discovery command. The Legacy module does not complete the command

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.