Digi XBee 3 ZigBee Manuel utilisateur

Digi XBee® 3 ZigBee®

RF Module

User Guide

Revision history—90001539

Revision Date Description

C March

2018

Added the Get started with MicroPython section.

D November

2018

Added Bluetooth (BLE)support, SPIsupport, and Custom Default

ATcommands.

E April 2019 Added sleep support, file system, OTA file system updates, and several

MicroPython features.

F September

2019

Adding/updating relay frames. Added %P.

Added statuses to the 0x8A frame. Added location AT commands. Added DM.

Added the I/O support section. Added %P,*S,*V,*W,*X,*Y,SA,AZ,

FSINFOFULL,and DM. Updated RR. Updates to Remote AT Command

Request frame. Added location and BLEcommands. Added statuses to the

0x8A frame. Added frames Ox2C, 0x2D, 0x2E, 0x89, 0x98, 0xAC, 0xAE, and

0xAD. Added Get started with BLE and BLE reference sections. Made

changes to the CCAoperations section. Added reserved endpoints to 0x11

frame.

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

Digi XBee® 3 Zigbee® RF Module 2

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.

Feedback

To provide feedback on this document, email your comments to

techcomm@digi.com

Include the document title and part number (Digi XBee® 3 Zigbee® RF Module, 90001539 F) in the

subject line of your email.

Digi XBee® 3 Zigbee® RF Module 3

Contents

Digi XBee® 3 Zigbee® RF Module

Applicable firmware and hardware 16

Change the firmware protocol 16

Regulatory information 16

Get started

Configure the XBee 3 Zigbee RF Module

Configure the device using XCTU

Custom defaults

Set custom defaults 19

Restore factory defaults 19

Limitations 19

Custom configuration: Create a new factory default 19

Set a custom configuration 20

Clear all custom configuration on a device 20

XBee bootloader 20

Send a firmware image 21

Software libraries 21

XBee Network Assistant 21

XBee Multi Programmer 22

Update the firmware over-the-air

Add the device to XCTU 24

Update to the latest firmware 24

Get started with MicroPython

About MicroPython 26

MicroPython on the XBee 3 Zigbee RF Module 26

Use XCTU to enter the MicroPython environment 26

Use the MicroPython Terminal in XCTU 27

MicroPython examples 27

Example: hello world 27

Example: enter MicroPython paste mode 27

Digi XBee® 3 Zigbee® RF Module 4

Digi XBee® 3 Zigbee® RF Module 5

Example:use the time module 28

Example: AT commands using MicroPython 28

MicroPython networking and communication examples 29

Zigbee networks with MicroPython 29

Example: forming and joining a Zigbee network using MicroPython 30

Example: network Discovery using MicroPython 31

Examples: transmitting data 32

Receiving data 33

Example: communication between two XBee 3 Zigbee modules 34

Exit MicroPython mode 37

Other terminal programs 37

Tera Term for Windows 37

Use picocom in Linux 38

Micropython help () 39

Secure access

Secure Sessions 42

Configure the secure session password for a device 42

Start a secure session 42

End a secure session 43

Secured remote AT commands 43

Secure a node against unauthorized remote configuration 43

Remotely configure a node that has been secured 44

Send data to a secured remote node 45

End a session from a server 45

Secure Session API frames 46

Secure transmission failures 47

Data Frames - 0x10 and 0x11 frames 47

Remote AT Commands- 0x17 frames 47

File system

Overview of the file system 49

Directory structure 49

Paths 49

Limitations 49

XCTU interface 50

Get started with BLE

Enable BLE on the XBee 3 Zigbee RF Module 52

Enable BLEand configure the BLEpassword 52

Get the Digi XBeeMobile phone application 53

Connect with BLEand configure your XBee 3 device 54

BLE reference

BLE advertising behavior and services 56

Device Information Service 56

XBee API BLEService 56

API Request characteristic 56

API Response characteristic 57

Digi XBee® 3 Zigbee® RF Module 6

Serial communication

Serial interface 59

UART data flow 59

Serial data 59

Serial buffers 60

Serial receive buffer 60

Serial transmit buffer 61

UART flow control 61

CTS flow control 61

RTS flow control 61

Break control 61

I2C 61

SPI operation

SPI communications 63

Full duplex operation 64

Low power operation 64

Select the SPI port 65

Force UART operation 66

Modes

Transparent operating mode 68

Serial-to-RF packetization 68

API operating mode 68

Command mode 68

Enter Command mode 69

Troubleshooting 69

Send AT commands 69

Response to AT commands 70

Apply command changes 70

Make command changes permanent 70

Exit Command mode 70

Idle mode 71

Transmit mode 71

Receive mode 72

Sleep mode 72

Zigbee networks

The Zigbee specification 74

Zigbee stack layers 74

Zigbee networking concepts 75

Device types 75

PAN ID 77

Operating channels 77

Zigbee application layers: in depth 78

Application Support Sublayer (APS) 78

Application profiles 78

Zigbee coordinator operation 80

Form a network 80

Digi XBee® 3 Zigbee® RF Module 7

Security policy 80

Channel selection 80

PAN ID selection 80

Persistent data 80

Coordinator startup 81

Permit joining 82

Reset the coordinator 82

Leave a network 83

Replace a coordinator (security disabled only) 83

Example: start a coordinator 84

Example: replace a coordinator (security disabled) 84

Router operation 85

Discover Zigbee networks 85

Join a network 85

Authentication 85

Persistent data 85

Router joining 86

Router network connectivity 87

End device operation 89

Discover Zigbee networks 89

Join a network 90

Parent child relationship 90

End device capacity 90

Authentication 90

Persistent data 91

Orphan scans 91

End device joining 91

Parent connectivity 92

Reset the end device 92

Channel scanning 92

Manage multiple Zigbee networks 93

Filter PAN ID 93

Configure security keys 93

Prevent unwanted devices from joining 93

Application messaging framework 94

Transmission, addressing, and routing

Addressing 96

64-bit device addresses 96

16-bit device addresses 96

Application layer addressing 96

Data transmission 96

Broadcast transmissions 97

Unicast transmissions 97

Address resolution 97

Address table 98

Group table 99

Binding transmissions 99

Multicast transmissions 99

Address resolution 99

Binding table 100

Fragmentation 100

Data transmission examples 100

Digi XBee® 3 Zigbee® RF Module 8

Send a packet in Transparent mode 100

Send data in API mode 101

API frame examples 102

RF packet routing 102

Link status transmission 103

AODV mesh routing 104

Many-to-One routing 107

High/Low RAM Concentrator mode 107

Source routing 107

Encrypted transmissions 112

Maximum RF payload size 112

Throughput 114

ZDO transmissions 114

Send a ZDO command 115

Receiving ZDO command and responses 115

Transmission timeouts 118

Unicast timeout 119

Extended timeout 119

Transmission examples 120

Zigbee security

Security overview 123

Network key 123

Link key 123

Preconfigured link key - moderate security 123

Well-known default link key - low security 124

Install code derived link key - high security 124

Join window 124

Key management 125

Centralized security 125

Distributed security 125

Device registration 125

Centralized trust center 126

Distributed trust center 126

Example: Form a secure network 126

Example: Join a secure network using a preconfigured link key 127

Example:Register a joining node without a preconfigured link key 128

Example: Register a joining node using an install code 129

Example:Deregister a previously registered device 129

Registration scenario 130

Network commissioning and diagnostics

Place devices 132

Test links in a network - loopback cluster 132

Transparent operating mode configuration (AP = 0) 132

RSSI indicators 132

Device discovery 133

Network discovery 133

ZDO discovery 133

Joining Announce 133

Commissioning pushbutton and associate LED 133

XBee 3 SMT 134

Digi XBee® 3 Zigbee® RF Module 9

XBee 3 Micro 134

XBee 3 Through-hole 135

Commissioning pushbutton 135

Associate LED 136

Binding 137

End_Device_Bind_req 137

Example of a End_Device_Bind_req 139

Group Table API 140

Add Group command 140

View group 141

Get Group Membership (1 of 2) 142

Get Group Membership (2 of 2) 144

Remove Group 145

Remove All Groups 146

Default responses 147

Common status codes 147

Manage End Devices

End device operation 150

Parent operation 150

End Device poll timeouts 151

End Device child table 151

Packet buffer usage 151

Non-Parent device operation 152

End Device configuration 152

Pin sleep 153

Cyclic sleep 155

Recommended sleep current measurements 161

Achieve the lowest sleep current 161

Compensate for switching time 161

Internal pin pull-ups 161

Transmit RF data 162

Receiving RF data 162

I/O sampling 162

Wake end devices with the Commissioning Pushbutton 162

Parent verification 162

Rejoining 163

Router/Coordinator configuration 163

RF packet buffering timeout 163

Child poll timeout 164

Adaptive polling 164

Transmission timeout 164

Short sleep periods 164

Extended sleep periods 164

Sleep examples 165

Example 1: Configure a device to sleep for 20 seconds, but set SN such that the On/sleep

line will remain de-asserted for up to 1 minute. 165

Example 2: Configure an end device to sleep for 20 seconds, send 4 I/O samples in 2

seconds, and return to sleep. 165

Example 3: configure a device for extended sleep: to sleep for 4 minutes. 166

Digi XBee® 3 Zigbee® RF Module 10

I/O support

Digital I/O support 168

Analog I/O support 168

Monitor I/O lines 169

I/O sample data format 170

API frame support 171

On-demand sampling 171

Example: Command mode 171

Example: Local AT command in API mode 172

Example: Remote AT command in API mode 173

Periodic I/O sampling 174

Source 174

Destination 174

Digital I/O change detection 174

I/O behavior during sleep 175

Digital I/O lines 175

Analog and PWM I/O Lines 175

AT commands

Networking commands 177

CE (Device Role) 177

ID (Extended PAN ID) 177

II (Initial 16-bit PAN ID) 177

ZS (Zigbee Stack Profile) 178

CR (Conflict Report) 178

NJ (Node Join Time) 178

DJ (Disable Joining) 179

NW(Network Watchdog Timeout) 180

JV (Coordinator Join Verification) 180

JN (Join Notification) 180

DO (Miscellaneous Device Options) 181

DC (Joining Device Controls) 181

C8 (Compatibility Options) 182

CB (Commissioning Pushbutton) 183

NR (Network Reset) 183

Operational Network Parameters commands 183

AI (Association Indication) 184

OP (Operating Extended PAN ID) 184

OI (Operating 16-bit PAN ID) 185

CH (Operating Channel) 185

NC (Number of Remaining Children) 185

Security commands 185

EE (Encryption Enable) 185

EO (Encryption Options) 186

DM (Disable Features) 186

KY (Link Key) 187

NK (Trust Center Network Key) 187

KT (Trust Center Link Key Registration Timeout) 188

I? (Install Code) 188

SA (Secure Access) 188

Zigbee Addressing commands 189

SH (Serial Number High) 189

Table des matières

Autres manuels Digi Unité de contrôle

Digi

Digi XBP09-XC... Manuel utilisateur

Digi

Digi ConnectCore 8X Guide rapide de l'utilisateur

Digi

Digi XTend vB DigiMesh Manuel utilisateur

Digi

Digi XTend vB DigiMesh XTP9B-DPM-001 Manuel utilisateur

Digi

Digi XBee Manuel utilisateur

Digi

Digi XBee ZigBee S2C Manuel utilisateur

Digi

Digi Connect ME Guide d'application

Digi

Digi XBee Manuel utilisateur

Digi

Digi ConnectCore Wi-9P 9215 Guide d'application

Digi

Digi ConnectCore 8X Guide rapide de l'utilisateur

Digi

Digi ConnectCore 8X Guide rapide de l'utilisateur

Digi

Digi 5400-RM Manuel utilisateur

Digi

Digi XBee XTC Manuel utilisateur

Digi

Digi XLR PRO Manuel utilisateur

Digi

Digi XLR PRO Manuel utilisateur

Digi

Digi Connect Series Guide de l'utilisateur

Digi

Digi XBee3-PRO Micro Guide rapide de l'utilisateur

Digi

Digi Digi Connect EM DC-EM02T-JT Guide d'application

Digi

Digi Connect ME Guide d'application

Digi

Digi XBee DigiMesh 2.4 Manuel utilisateur

Digi

Digi XBee XTC Manuel utilisateur

Digi

Digi ConnectCore 6UL Guide rapide de l'utilisateur

Digi

Digi XBee Manuel utilisateur

Digi

Digi XBee3 802.15.4 Manuel utilisateur

Manuels Unité de contrôle populaires d'autres marques

Festo

Festo Compact Performance CP-FB6-E Manuel de la liste des pièces

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Manuel utilisateur

JS Automation

JS Automation MPC3034A Manuel utilisateur

JAUDT

JAUDT SW GII 6406 Series Guide rapide

Spektrum

Spektrum Air Module System Manuel utilisateur

BOC Edwards

BOC Edwards Q Series Manuel utilisateur

KHADAS

KHADAS BT Magic Manuel utilisateur

Etherma

Etherma eNEXHO-IL Manuel utilisateur

PMFoundations

PMFoundations Attenuverter Manuel utilisateur

GEA

GEA VARIVENT Manuel utilisateur

Walther Systemtechnik

Walther Systemtechnik VMS-05 Manuel utilisateur

Altronix

Altronix LINQ8PD Instructions de montage

Eaton

Eaton Powerware Series Manuel utilisateur

WAGO

WAGO 750-407/040-000 Manuel utilisateur

Sony

Sony CCU-590 Manuel utilisateur

Graco

Graco 25D614 Manuel utilisateur

Task Force Tips

Task Force Tips YE-RF-900 Manuel de programmation

Shini

Shini SPV-U Series Manuel utilisateur