Digi XBee3 802.15.4 Manuale utente

Digi XBee3® 802.15.4

Radio Frequency (RF) Module

User Guide

Revision history—90002273

Revision Date Description

A April 2018 Initial release.

B September 2018 S2C parity release.

Trademarks and copyright

Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United

States and other countries worldwide. All other trademarks mentioned in this document are the

property of their respective owners.

Disclaimers

Information in this document is subject to change without notice and does not represent a

commitment on the part of Digi International. Digi provides this document “as is,” without warranty of

any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or

merchantability for a particular purpose. Digi may make improvements and/or changes in this manual

or in the product(s) and/or the program(s) described in this manual at any time.

Warranty

To view product warranty information, go to the following website:

www.digi.com/howtobuy/terms

Customer support

Gather support information: Before contacting Digi technical support for help, gather the following

information:

Product name and model

Product serial number (s)

Firmware version

Operating system/browser (if applicable)

Logs (from time of reported issue)

Trace (if possible)

Description of issue

Steps to reproduce

Contact Digi technical support: Digi offers multiple technical support plans and service packages.

Digi XBee3® 802.15.4 RF Module User Guide 2

Feedback

To provide feedback on this document, email your comments to

techcomm@digi.com

Include the document title and part number (Digi XBee3® 802.15.4 RF Module User Guide, 90002273 B)

in the subject line of your email.

Digi XBee3® 802.15.4 RF Module User Guide 3

Contents

Digi XBee3® 802.15.4 RF Module User Guide

Applicable firmware and hardware 12

Change the firmware protocol 12

Regulatory information 12

Get started

Verify kit contents 14

Assemble the hardware 14

Plug in the XBee3 802.15.4 RF Module 15

Unplug an XBee3 802.15.4 RF Module 16

Configure the device using XCTU 16

Configure remote devices 16

Configure the devices for a range test 18

Perform a range test 18

Configure the XBee3 802.15.4 RF Module

Software libraries 25

Over-the-air (OTA) firmware update 25

Custom defaults 25

Set custom defaults 25

Restore factory defaults 25

Limitations 25

XBee Network Assistant 26

Modes

Transparent operating mode 28

Serial-to-RF packetization 28

API operating mode 28

Command mode 28

Enter Command mode 29

Troubleshooting 29

Send AT commands 29

Response to AT commands 30

Apply command changes 30

Make command changes permanent 30

Exit Command mode 30

Digi XBee3® 802.15.4 RF Module User Guide 4

Digi XBee3® 802.15.4 RF Module User Guide 5

Idle mode 31

Transmit mode 31

Receive mode 31

Serial communication

Serial interface 33

Serial receive buffer 33

Serial transmit buffer 33

UART data flow 33

Serial data 33

Flow control 34

Clear-to-send (CTS) flow control 34

RTS flow control 35

SPI operation

SPI communications 37

Full duplex operation 38

Low power operation 38

Select the SPI port 39

Force UART operation 39

I/O support

Legacy support 42

Mixed network considerations 43

Digital I/O support 43

Analog I/O support 44

Monitor I/O lines 45

I/O sample data format 45

Legacy data format 45

Enhanced data format 47

API frame support 47

On-demand sampling 48

Example: Command mode 48

Example: Local AT command in API mode 49

Example: Remote AT command in API mode 50

Periodic I/O sampling 51

Source 51

Destination 51

Multiple samples per packet 51

Example: Remote AT command in API mode 52

Digital I/O change detection 53

I/O line passing 54

Digital line passing 54

Example:Digital line passing 54

Analog line passing 55

Example:Analog line passing 55

Output sample data 56

Output control 56

I/O behavior during sleep 56

Digital I/O lines 56

Digi XBee3® 802.15.4 RF Module User Guide 6

Analog and PWM I/O Lines 56

Networking

Networking terms 58

MAC Mode configuration 58

Clear Channel Assessment (CCA) 59

CCA operations 59

Retries configuration 59

Transmit status based on MAC mode and XBee retries configurations 60

Addressing 61

Send packets to a specific device in Transparent APImode 61

Addressing modes 61

Peer-to-peer networks 62

Master/slave networks 62

End device association 62

Coordinator association 63

Association indicators 64

Modem status messages 64

Association indicator status codes 65

Direct and indirect transmission 65

Configure an indirect messaging coordinator 66

Send indirect messages 66

Receive indirect messages 66

Encryption 67

Maximum payload 68

Maximum payload rules 68

Maximum payload summary tables 69

Working with Legacy devices 69

Network commissioning and diagnostics

Remote configuration commands 72

Send a remote command 72

Apply changes on remote devices 72

Remote command responses 72

Node discovery 72

About node discovery 73

Node discovery in compatibility mode 73

Directed node discovery 73

Directed node discovery in compatibility mode 73

Destination Node 74

Sleep support

Sleep modes 76

Pin Sleep mode (SM = 1) 76

Cyclic Sleep mode (SM = 4) 76

Cyclic Sleep with Pin Wake-up mode (SM = 5) 77

Sleep parameters 77

Sleep current 77

Sleep pins 77

Sleep conditions 78

Digi XBee3® 802.15.4 RF Module User Guide 7

AT commands

Network and security commands 80

CH command 80

ID command 80

C8 command 80

NI command 82

ND command 82

DN command 83

NT command 83

NO command 84

MM (MAC Mode) 84

NP command 85

Coordinator/End Device configuration commands 85

CE command 85

A1 (End Device Association) 85

A2 (Coordinator Association) 86

SC command 87

DA (Force Disassociation) 88

AI command 88

802.15.4 Addressing commands 88

SH command 88

SL command 89

MY command 89

DH command 89

DL command 90

RR command 90

TO command 90

Security commands 91

EE command 91

KY command 91

RF interfacing commands 92

PL command 92

PP command 92

CA (CCA Threshold) 92

RN command 93

DB command 93

MAC diagnostics commands 93

AS command 94

ED command 94

EA command 95

EC (CCA Failures) 95

Sleep settings commands 95

SM command 95

SP command 96

ST command 96

DP (Disassociated Cyclic Sleep Period) 97

SO command 97

FP (Force Poll) 98

UART interface commands 98

BD command 98

NB command 99

SB command 99

FT command 100

RO command 100

Digi XBee3® 802.15.4 RF Module User Guide 8

APcommand 100

AO command 101

AZ (Extended API Options) 101

Command mode options 102

CC command 102

CT command 102

GT command 102

CN command 102

UART pin configuration commands 103

D6 command 103

D7 command 103

P3 command 104

P4 command 104

SPI interface commands 104

P5 command 105

P6 command 105

P7 command 105

P8 command 106

P9 command 106

I/O settings commands 107

D0 command 107

CB command 107

D1 command 108

D2 command 108

D3 command 109

D4 command 109

D5 command 110

D8 command 110

D9 command 111

P0 command 111

P1 command 112

P2 command 112

PR command 113

PD command 114

M0 command 114

M1 command 115

RP command 115

LT command 115

I/O sampling commands 116

IS command 116

IR command 117

IC command 117

AV (Analog Voltage Reference) 118

IT (Samples before TX) 118

IF command 118

IO command 119

I/O line passing commands 119

IA (I/O Input Address) 119

IU command 119

T0 command 120

T1 command 120

T2 command 120

T3 command 120

T4 command 120

T5 command 121

Digi XBee3® 802.15.4 RF Module User Guide 9

T6 command 121

T7 command 121

T8 command 121

T9 command 122

Q0 command 122

Q1 command 122

Q2 command 122

PT (PWM Output Timeout) 122

Diagnostic commands - firmware/hardware information 123

VR command 123

VL command 123

VH command 123

HV command 123

%C (Hardware/Software Compatibility) 124

%V command 124

TP command 124

DD command 124

CK command 124

FR command 125

Memory access commands 125

AC (Apply Changes) 125

WR command 125

RE command 126

Custom default commands 126

%F (Set Custom Default) 126

!C (Clear Custom Defaults) 126

R1 (Restore Factory Defaults) 127

Operate in API mode

API mode overview 129

Use the AP command to set the operation mode 129

API frame format 129

API operation (AP parameter = 1) 129

API operation with escaped characters (AP parameter = 2) 130

Frame descriptions

TX Request: 64-bit address frame - 0x00 134

TX Request: 16-bit address - 0x01 135

AT Command Frame - 0x08 136

AT Command - Queue Parameter Value frame - 0x09 138

Transmit Request frame - 0x10 138

Explicit Addressing Command frame - 0x11 140

Remote AT Command Request frame - 0x17 144

RX Packet: 64-bit Address frame - 0x80 145

Receive Packet: 16-bit address frame - 0x81 146

RX (Receive) Packet: 64-bit address IO frame - 0x82 147

RX Packet: 16-bit address I/O frame - 0x83 149

AT Command Response frame - 0x88 151

TX Status frame - 0x89 153

Modem Status frame - 0x8A 155

Transmit Status frame - 0x8B 156

Receive Packet frame - 0x90 158

Digi XBee3® 802.15.4 RF Module User Guide 10

Explicit Rx Indicator frame - 0x91 160

I/O Data Sample Rx Indicator frame - 0x92 162

Remote Command Response frame - 0x97 164

OTA firmware upgrade process for 802.15.4

OTA/OTB file 166

The OTA header 166

Hardware/software compatibility 167

Parse the image blocks 167

Storage 167

ZCL OTA messaging 167

ZCL message output 168

Image Notify 168

Create the Image Notify request 169

Query Next Image request 170

Query Next Image response 172

Image Block request 174

Image Block response 176

Upgrade End request 179

Upgrade End response 180

OTA error handling 183

Default response commands 183

Upgrade End Request error statuses 184

Altri manuali per XBee3 802.15.4

Indice

Altri manuali Digi Unità di controllo

Digi

Digi Digi One EM Guida all'applicazione

Digi

Digi INFOTAG 2.13 Manuale utente

Digi

Digi Connect Wi-ME 9210 Manuale utente

Digi

Digi ConnectCore 8X Guida rapida per l'utente

Digi

Digi XBee Manuale utente

Digi

Digi XBee XTC Manuale utente

Digi

Digi ConnectCore 6 Plus Guida rapida per l'utente

Digi

Digi XBee3 802.15.4 Manuale utente

Digi

Digi Connect ME Guida all'applicazione

Digi

Digi XBee-PRO 900HP Manuale utente

Digi

Digi XBee ZigBee S2C Manuale utente

Digi

Digi RabbitCore RCM4000 Manuale utente

Digi

Digi XBee 868LP Manuale utente

Digi

Digi XTend vB DigiMesh Manuale utente

Digi

Digi XBee ZigBee S2C Manuale utente

Digi

Digi XBee 3 ZigBee Manuale utente

Digi

Digi XBee3-PRO Micro Guida rapida per l'utente

Digi

Digi Connect Series Guida utente

Digi

Digi XBee DigiMesh 2.4 Manuale utente

Digi

Digi Digi Connect EM DC-EM02T-JT Guida all'applicazione

Digi

Digi ConnectCore 9P 9215 Guida all'applicazione

Digi

Digi XBee SX 868 Manuale utente

Digi

Digi XBee XTC Manuale utente

Digi

Digi ConnectCore 6UL Guida rapida per l'utente

Manuali Unità di controllo popolari di altre marche

Festo

Festo Compact Performance CP-FB6-E Manuale elenco delle parti

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Manuale utente

JS Automation

JS Automation MPC3034A Manuale utente

JAUDT

JAUDT SW GII 6406 Series Guida rapida

Spektrum

Spektrum Air Module System Manuale utente

BOC Edwards

BOC Edwards Q Series Manuale utente

KHADAS

KHADAS BT Magic Manuale utente

Etherma

Etherma eNEXHO-IL Manuale utente

PMFoundations

PMFoundations Attenuverter Manuale utente

GEA

GEA VARIVENT Manuale utente

Walther Systemtechnik

Walther Systemtechnik VMS-05 Manuale utente

Altronix

Altronix LINQ8PD Istruzioni per il montaggio

Eaton

Eaton Powerware Series Manuale utente

WAGO

WAGO 750-407/040-000 Manuale utente

Sony

Sony CCU-590 Manuale utente

Graco

Graco 25D614 Manuale utente

Task Force Tips

Task Force Tips YE-RF-900 Manuale di programmazione

Shini

Shini SPV-U Series Manuale utente