Digi XBee3 802.15.4 User Manual

AT commands Security commands
Digi XBee3® 802.15.4 RF Module User Guide
91
Security commands
The following commands enable and control the encryption used for RF transmissions.
EE command
Enables or disables 128-bit Advanced Encryption Standard (AES) encryption of RD data transmissions.
The firmware uses the 802.15.4 Default Security protocol and uses AES encryption with a 128-bit key.
AES encryption dictates that all devices in the network use the same key, and that the maximum RF
packet size is 95 bytes if Tx compatibility is enabled (you set bit 0 of C8). If C8, bit 0 is not set, see
Maximum payload.
When encryption is enabled, the device always uses its 64-bit long address as the source address for
RF packets. This does not affect how the MY (Source Address), DH (Destination Address High) and DL
(Destination Address Low) parameters work.
If MM (MAC Mode) is set to 1 or 2 and AP (API Enable) parameter > 0:
With encryption enabled and a 16-bit short address set, receiving devices can only issue RX
(Receive) 64-bit indicators. This is not an issue when MM = 0 or 3.
If a device with a non-matching key detects RF data, but has an incorrect key:
When encryption is enabled, non-encrypted RF packets received are rejected and are not sent
out the UART.
Parameter range
0 - 1
Parameter Description
0 Encryption Disabled
1 Encryption Enabled
Default
0
KY command
Sets the 128-bit network security key value that the device uses for encryption and decryption.
This command is write-only and cannot be read. If you attempt to read KY, the device returns an OK
status.
Set this command parameter the same on all devices in a network.
The entire payload of the packet is encrypted using the key and the CRC is computed across the
ciphertext.
Parameter range
128-bit value (up to 16 bytes)
Default
0

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.