Digi XBee 3 802.15.4 RF Module Manuals

Manuals and User Guides for Digi XBee 3 802.15.4 RF Module. We have 1 Digi XBee 3 802.15.4 RF Module manual available for free PDF download: User Manual

Digi XBee 3 802.15.4 User Manual

Digi XBee 3 802.15.4 User Manual (264 pages)

Radio Frequency (RF) Module

Brand: Digi | Category: Control Unit | Size: 9.76 MB

Table of Contents

Table of Contents
4
Digi Xbee® 3 802.15.4 RF Module User Guide

13
Get Started

16
- Verify Kit Contents
  16
- Assemble the Hardware
  16
  - Plug in the Xbee 3 802.15.4 RF Module
    17
  - Unplug an Xbee 3 802.15.4 RF Module
    18
- Configure the Device Using XCTU
  18
- Configure Remote Devices
  18
- Configure the Devices for a Range Test
  20
- Perform a Range Test
  21
- XBIB-C Micro Mount Reference
  25
- XBIB-C SMT Reference
  28
- XBIB-CU TH Reference
  30
- XBIB-C-GPS Reference
  32
- Interface with the XBIB-C-GPS Module
  34
  - I2C Communication
    35
  - UART Communication
    35
  - Run the Micropython GPS Demo
    35
Get Started with Micropython

38
Secure Access

53
File System

59
- Overview of the File System
  60
- Directory Structure
  60
- Paths
  60
- Limitations
  60
- XCTU Interface
  61
Get Started with BLE

62
BLE Reference

66
Configure the Xbee 3 802.15.4 RF Module

70
- Software Libraries
  70
- Firmware Over-The-Air (FOTA) Update
  70
- Custom Defaults
  70
  - Set Custom Defaults
    70
  - Restore Factory Defaults
    70
  - Limitations
    70
- Custom Configuration: Create a New Factory Default
  71
  - Set a Custom Configuration
    71
  - Clear All Custom Configuration on a Device
    71
- Xbee Bootloader
  71
- Send a Firmware Image
  72
- Xbee Network Assistant
  72
- Xbee Multi Programmer
  73
Modes

75
- Transparent Operating Mode
  75
  - Serial-To-RF Packetization
    75
- API Operating Mode
  75
- Command Mode
  75
  - Enter Command Mode
    76
  - Troubleshooting
    76
  - Send at Commands
    76
  - Response to at Commands
    77
  - Apply Command Changes
    77
  - Make Command Changes Permanent
    77
  - Exit Command Mode
    77
- Idle Mode
  78
- Transmit Mode
  78
- Receive Mode
  78
Serial Communication

79
- Serial Interface
  80
- Serial Receive Buffer
  80
- Serial Transmit Buffer
  80
- UART Data Flow
  80
  - Serial Data
    80
- Flow Control
  81
  - Clear-To-Send (CTS) Flow Control
    81
  - RTS Flow Control
    82
SPI Operation

83
- SPI Communications
  84
- Full Duplex Operation
  85
- Low Power Operation
  85
- Select the SPI Port
  86
- Force UART Operation
  87
I/O Support

88
- Legacy Support
  89
- Mixed Network Considerations
  90
- Digital I/O Support
  90
- Analog I/O Support
  91
- Monitor I/O Lines
  92
- I/O Sample Data Format
  93
  - Legacy Data Format
    93
  - Enhanced Data Format
    94
- API Frame Support
  95
- On-Demand Sampling
  96
- Periodic I/O Sampling
  98
  - Source
    98
  - Destination
    99
  - Multiple Samples Per Packet
    99
  - Example: Remote at Command in API Mode
    99
- Digital I/O Change Detection
  100
- I/O Line Passing
  101
- Digital Line Passing
  101
  - Example: Digital Line Passing
    102
  - Analog Line Passing
    102
  - Example: Analog Line Passing
    102
- Output Sample Data
  103
- Output Control
  103
- I/O Behavior During Sleep
  103
  - Digital I/O Lines
    103
  - Analog and PWM I/O Lines
    104
Networking

105
- Networking Terms
  106
- MAC Mode Configuration
  106
- Clear Channel Assessment (CCA)
  107
  - CCA Operations
    107
- Retries Configuration
  107
- Transmit Status Based on MAC Mode and Xbee Retries Configurations
  108
- Addressing
  109
  - Send Packets to a Specific Device in Transparent API Mode
    109
  - Addressing Modes
    109
- Peer-To-Peer Networks
  110
- Master/Slave Networks
  110
  - End Device Association
    110
  - Coordinator Association
    111
  - Association Indicators
    112
  - Modem Status Messages
    112
  - Association Indicator Status Codes
    113
- Direct and Indirect Transmission
  113
  - Configure an Indirect Messaging Coordinator
    114
  - Send Indirect Messages
    114
  - Receive Indirect Messages
    114
- Encryption
  115
- Maximum Payload
  116
  - Maximum Payload Rules
    116
  - Maximum Payload Summary Tables
    117
  - Work with Legacy Devices
    118
Network Commissioning and Diagnostics

119
- Remote Configuration Commands
  120
  - Send a Remote Command
    120
  - Apply Changes on Remote Devices
    120
  - Remote Command Responses
    120
- Node Discovery
  120
  - About Node Discovery
    121
  - Node Discovery in Compatibility Mode
    121
  - Directed Node Discovery
    121
  - Directed Node Discovery in Compatibility Mode
    122
  - Destination Node
    122
Sleep Support

124
- Sleep Modes
  124
- Sleep Parameters
  125
- Sleep Pins
  125
- Sleep Conditions
  126
AT Commands

127
- Network and Security Commands
  128
  - Operating Channel)
    128
  - ID (Extended PAN ID)
    128
  - C8 (Compatibility Options)
    128
  - NI (Node Identifier)
    130
  - ND (Network Discover)
    130
  - DN (Discover Node)
    131
  - NT (Node Discover Timeout)
    132
  - Node Discovery Options)
    132
  - MM (MAC Mode)
    132
  - NP (Maximum Packet Payload Bytes)
    133
- Coordinator/End Device Configuration Commands
  133
  - CE (Coordinator Enable)
    133
  - A1 (End Device Association)
    134
  - A2 (Coordinator Association)
    134
  - SC (Scan Channels)
    135
  - Force Disassociation)
    136
  - AI (Association Indication)
    136
- 802.15.4 Addressing Commands
  137
  - SH (Serial Number High)
    137
  - Serial Number Low)
    137
  - MY (16-Bit Source Address)
    137
  - DH (Destination Address High)
    138
  - DL (Destination Address Low)
    138
  - RR (Xbee Retries)
    138
  - TO (Transmit Options)
    139
- Security Commands
  139
  - EE (Encryption Enable)
    139
  - KY (AES Encryption Key)
    140
  - DM (Disable Features)
    140
- RF Interfacing Commands
  140
  - TX Power Level)
    140
  - PP (Output Power in Dbm)
    141
  - CA (CCA Threshold)
    141
  - RN (Random Delay Slots)
    142
  - DB (Last Packet RSSI)
    142
- MAC Diagnostics Commands
  142
  - AS (Active Scan)
    142
  - ED (Energy Detect)
    143
  - EA (ACK Failures)
    144
  - EC (CCA Failures)
    144
- Sleep Settings Commands
  144
  - SM (Sleep Mode)
    144
  - SP (Cyclic Sleep Period)
    145
  - ST (Time before Sleep)
    145
  - DP (Disassociated Cyclic Sleep Period)
    146
  - SO (Sleep Options)
    146
  - FP (Force Poll)
    147
- UART Interface Commands
  147
  - BD (Interface Data Rate)
    147
  - NB (Parity)
    148
  - SB (Stop Bits)
    148
  - FT (Flow Control Threshold)
    149
  - Packetization Timeout)
    149
  - AP (API Enable)
    149
  - AO (API Output Options)
    150
  - AZ (Extended API Options)
    150
- Command Mode Options
  151
  - CC (Command Character)
    151
  - CT (Command Mode Timeout)
    151
  - GT (Guard Times)
    151
  - CN (Exit Command Mode)
    151
- UART Pin Configuration Commands
  152
  - D6 (DIO6/RTS Configuration)
    152
  - D7 (DIO7/CTS Configuration)
    152
  - P3 (DIO13/UART_DOUT Configuration)
    153
  - P4 (DIO14/UART_DIN Configuration)
    153
- SPI Interface Commands
  154
- I/O Settings Commands
  156
  - D0 (Dio0/Adc0/Commissioning Configuration)
    156
  - CB (Commissioning Button)
    156
  - D1 (DIO1/ADC1/TH_SPI_ATTN Configuration)
    157
  - D2 (DIO2/ADC2/TH_SPI_CLK Configuration)
    157
  - D3 (DIO3/ADC3/TH_SPI_SSEL Configuration)
    158
  - D4 (DIO4/TH_SPI_MOSI Configuration)
    158
  - D5 (Dio5/Associate Configuration)
    159
  - D8 (Dio8/Dtr/Slp_Request Configuration)
    159
  - D9 (DIO9/ON_SLEEP Configuration)
    160
  - P0 (DIO10/RSSI/PWM0 Configuration)
    160
  - P1 (DIO11/PWM1 Configuration)
    161
  - P2 (DIO12/TH_SPI_MISO Configuration)
    161
  - PR (Pull-Up/Down Resistor Enable)
    162
  - PD (Pull Up/Down Direction)
    163
  - M0 (PWM0 Duty Cycle)
    163
  - M1 (PWM1 Duty Cycle)
    164
  - RP (RSSI PWM Timer)
    164
  - Associate LED Blink Time)
    164
- I/O Sampling Commands
  165
  - IS (I/O Sample)
    165
  - IR (Sample Rate)
    166
  - IC (DIO Change Detect)
    166
  - AV (Analog Voltage Reference)
    167
  - Samples before TX)
    167
  - IF (Sleep Sample Rate)
    168
  - IO (Digital Output Level)
    168
- I/O Line Passing Commands
  168
  - IA (I/O Input Address)
    168
  - IU (I/O Output Enable)
    168
  - T0 (D0 Timeout Timer)
    169
  - T1 (D1 Output Timeout Timer)
    169
  - T2 (D2 Output Timeout Timer)
    169
  - T3 (D3 Output Timeout Timer)
    169
  - T4 (D4 Output Timeout Timer)
    170
  - T5 (D5 Output Timeout Timer)
    170
  - T6 (D6 Output Timeout Timer)
    170
  - T7 (D7 Output Timeout Timer)
    170
  - T8 (D8 Output Timer)
    171
  - T9 (D9 Output Timer)
    171
  - Q0 (P0 Output Timer)
    171
  - Q1 (P1 Output Timer)
    171
  - Q2 (P2 Output Timer)
    171
  - PWM Output Timeout)
    172
- Location Commands
  172
  - LX (Location X)
    172
  - LY (Location Y)
    172
  - LZ (Location Z)
    172
- Diagnostic Commands - Firmware/Hardware Information
  173
  - VR (Firmware Version)
    173
  - VL (Version Long)
    173
  - VH (Bootloader Version)
    173
  - HV (Hardware Version)
    173
  - C (Hardware/Software Compatibility)
    173
  - P (Invoke Bootloader)
    174
  - Supply Voltage)
    174
  - TP (Module Temperature)
    174
  - DD (Device Type Identifier)
    174
  - CK (Configuration CRC)
    175
  - Software Reset)
    175
- Micropython Commands
  175
  - PS (Python Startup)
    175
  - PY (Micropython Command)
    175
- File System Commands
  176
  - FS (File System)
    176
  - FK (File System Public Key)
    178
- Memory Access Commands
  179
  - AC (Apply Changes)
    179
  - WR (Write)
    179
  - RE (Restore Defaults)
    179
- BLE Commands
  180
  - BL (Bluetooth MAC Address)
    180
  - BT (Bluetooth Enable)
    180
  - S (SRP Salt)
    180
  - V, $W, $X, $Y Commands (SRP Salt Verifier)
    181
- Custom Default Commands
  181
  - F (Set Custom Default)
    181
  - C (Clear Custom Defaults)
    181
  - R1 (Restore Factory Defaults)
    182
- Secure Session Commands
  182
  - S (Secure Session Salt)
    182
  - V, *W, *X, *Y (Secure Session Verifier)
    182
  - SA (Secure Access)
    182
Operate in API Mode

185
Frame Descriptions

190
- TX Request: 64-Bit Address Frame - 0X00
  190
- TX Request: 16-Bit Address - 0X01
  191
- AT Command Frame - 0X08
  192
- AT Command - Queue Parameter Value Frame - 0X09
  194
- Transmit Request Frame - 0X10
  194
- Explicit Addressing Command Frame - 0X11
  196
- Remote at Command Request Frame - 0X17
  200
- BLE Unlock API Frame - 0X2C
  201
  - Example Sequence to Perform at Command Xbee API Frames over BLE
    203
- User Data Relay Frame - 0X2D
  204
  - Example Use Cases
    205
  - Example
    205
- Secure Session Control Frame - 0X2E
  206
- RX Packet: 64-Bit Address Frame - 0X80
  210
- Receive Packet: 16-Bit Address Frame - 0X81
  211
- RX (Receive) Packet: 64-Bit Address IO Frame - 0X82
  212
- RX Packet: 16-Bit Address I/O Frame - 0X83
  214
- AT Command Response Frame - 0X88
  216
- TX Status Frame - 0X89
  218
- Modem Status Frame - 0X8A
  220
- Transmit Status Frame - 0X8B
  221
- Receive Packet Frame - 0X90
  223
- Explicit Rx Indicator Frame - 0X91
  225
- I/O Data Sample Rx Indicator Frame - 0X92
  227
- Remote Command Response Frame - 0X97
  229
- Extended Modem Status Frame - 0X98
  229
- BLE Unlock Response Frame - 0Xac
  231
- User Data Relay Output - 0Xad
  232
  - Description
    232
  - Format
    232
  - Example
    232
- Secure Session Response Frame - 0Xae
  233
Over-The-Air Firmware/Filesystem Upgrade Process for 802.15.4

236
- FOTA Upgrade Image File Formats
  236
  - OTA/OTB File
    236
  - Fs.ota File
    236
  - The OTA Header
    236
  - Hardware/Software Compatibility
    237
  - Parse the Image Blocks
    237
- Storage
  237
- ZCL OTA Messaging
  237
- ZCL Message Output
  238
- Image Notify
  238
- Create the Image Notify Request
  239
- Query Next Image Request
  240
- Query Next Image Response
  242
- Image Block Request
  244
- Image Block Response
  246
- Upgrade End Request
  249
- Upgrade End Response
  250
- OTA Error Handling
  253
  - Default Response Commands
    253
  - Upgrade End Request Error Statuses
    254
OTA File System Upgrades

256

Advertisement

Advertisement

Related Products

Digi Categories

Network Router

Network Router Control Unit Modem Gateway Server

More Digi Manuals