Digi XBee Manuel utilisateur

XBee® Gateway

User Guide

Revision history—90001399-13

Revision Date Description

C June 2017 nRebranded the graphics.

nAdded Digi ESPfor Python installation instructions.

nModified regulatory and certification information as required by RED

(Radio Equipment Directive).

D July 2017 Updated the Certificate Management section to specify that this feature is

available only for Wi-Fi devices.

E September

2017

Reorganized and edited the document.

F January

2020

Added information about the unique password for the web interface.

G February

2020

Added link to data sheet specifications.

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

Send comments

Documentation feedback: To provide feedback on this document, send your comments to

techcomm@digi.com.

XBee Gateway User Guide 2

Customer support

Digi Technical Support: Digi offers multiple technical support plans and service packages to help our

customers get the most out of their Digi product. For information on Technical Support plans and

pricing, contact us at +1 952.912.3444 or visit us at www.digi.com/support.

XBee Gateway User Guide 3

Contents

About Digi XBee Gateway

Regulatory information and certifications 10

RF exposure statement 10

FCC certifications and regulatory information (USA only) 10

Declaration of Conformity (DoC) 11

CE mark (Europe) 11

Industry Canada (IC) certifications 12

Korea Communications Commission (KCC) certifications 12

Safety statements 12

Warnings for Use of Wireless Devices 13

International EMC (Electromagnetic Emissions/Immunity/Safety) standards 14

Maximum power and frequency bands 14

XBee Gateway: Cellular 15

XBee Gateway: Ethernet 15

XBee Gateway: Wi-Fi 15

XBee Gateway Python application 15

XBee ZigBee Cloud Kit 15

Hardware interfaces 16

Configuration and management interfaces 16

XBee Gateway web interface 16

Remote Manager interface 16

RFGateway and Python remote device management solutions 17

Programming interface applications 17

Product differences from predecessor ConnectPort® X products 18

Where to find more information 19

Get started

Set up the XBee Gateway Cellular hardware 20

Verify your components 20

Connect the cellular hardware 22

Connect XBee Gateway to the network 23

Set up the XBee Gateway Wi-Fi hardware 23

Verify your components 24

Connect the Wi-Fi hardware 25

Connect XBee Gateway to the network 26

Set up your XBee Gateway

Set up XBee Gateway summary 28

XBee Gateway User Guide 4

XBee Gateway User Guide 5

Joining ZigBee networks 29

Join XBee Gateway to an existing ZigBee network 30

Configure XBee Gateway with a custom PAN ID 31

XBee Gateway and non-XBee ZigBee Devices 32

Administration and maintenance tasks

Logging in to the web interface 33

File management 33

File Management page in Remote Manager 33

File Management page in the XBee Gateway web interface 34

Certificate Management 35

Certificate Management page in the web interface 35

Back up or restore the configuration 36

Back up and restore files from Remote Manager 36

Back up and restore files from the XBee Gateway web interface 37

Update firmware 38

Update firmware from Remote Manager 38

Update firmware from the XBee Gateway web interface 40

About firmware files 41

Mobile device status 41

Display the mobile device status 42

Mobile Status page 42

Change the password for the web interface 50

Display the XBee Gateway End User License Agreement (EULA) 52

Restore XBee Gateway factory defaults 53

Reboot XBee Gateway 53

Display system information 53

Disconnect XBee Gateway from Remote Manager 53

About programming

Python 54

XBee ZigBee Cloud Kit web application source code 55

Programming calls through Server Command Interface (SCI) and Remote Command Interface

(RCI) 55

XBee Gateway file system 55

Important directories 55

Load applications onto XBee Gateway 56

Program XBee Gateway using Python

Find Python learning resources 58

Python support forum 58

Digi Python Wiki Archive Reference Manual 58

Digi-specific Python modules for programming 58

Sample programs 58

Button handling 59

LED control 59

Watchdog 60

RCI callback 61

XBee functions 62

XBee Gateway Python application and Remote Manager 62

XBee Gateway User Guide 6

How does the XBee Gateway Python application work? 62

XBee Gateway Python application requirements 63

Key features and operations of the XBee Gateway Python application 64

Store status data for XBee lines in Remote Manager 64

Receive serial data from Remote Manager 68

Store serial data in Remote Manager 75

Manage XBee DIO lines though Remote Manager 78

XBee Gateway Python application configuration file 85

XBee Gateway Python application command errors 86

Configure a Python application in the web interface 86

Digi ESP for Python 87

Access the program samples in Digi ESP 87

Install the Digi ESP for Python Development Environment 88

DIA software 91

Linux command shell (command line interface) 91

User name and password for the Linux command shell 91

Connect and log in to the XBee Gateway device 91

Configure XBee Gateway

Configure settings from Remote Manager 95

Basic configuration settings 95

Advanced configuration settings 95

Configure settings from the XBee Gateway web interface 96

Access the XBee Gateway web interface 96

Home page 97

Ethernet IP network settings 98

Default Ethernet settings 98

Configure Ethernet Settings 99

Ethernet Network Configuration page 99

Wireless (Wi-Fi) network settings 101

Default wireless (Wi-Fi) settings 101

Configure wireless settings 101

Wi-Fi network settings 101

Mobile connectivity settings 104

Default behavior with the cellular network 104

Set up and configure GSM-based devices 105

Provision a CDMA-based device 106

Configure mobile settings 107

Mobile Connectivity Configuration page 108

Short Message Service (SMS) 109

Digi Mobile SureLink™ settings 112

Configure Mobile SureLink settings 112

Mobile SureLink integrity monitoring settings 112

Link integrity test options 114

DNS settings 115

Configure Domain Name Server (DNS) 115

Domain Name Server (DNS) Configuration page 115

Mobile firewall settings 116

Configure mobile firewall settings 116

Enable or Disable Mobile firewall settings 116

Autostart settings for the Python Program 116

Configure Python settings 117

Python settings 117

XBee Gateway User Guide 7

Button service assignments settings 117

Configure button service assignments 117

Button service assignments page 118

Restore XBee Gateway factory defaults 118

Use discovery tools to enable configuration changes 118

Use the button to enable special-purpose Wi-Fi configuration mode 119

Use the button to enable the web interface 120

Configure Remote Manager connectivity settings 120

Configure connectivity settings 121

Basic connectivity settings 121

Advanced connectivity settings 122

Advanced connectivity settings for the web interface 124

Device Cloud client initiated connection page 127

Device Cloud Configuration page 128

Device Cloud network type page 129

Connect to a different instance of Remote Manager 130

Configure a proxy server 130

Network services settings 131

Configure network services settings 131

Network Services Configuration page 131

GPS static position settings 133

Configure GPS Static Position settings 133

GPS Static Position page 134

Time settings 134

Configure time settings 134

Time Server Configuration page 135

Time Zone Configuration page 135

Time Configuration page 135

Configure XBee network settings

Configure XBee Networks page in Remote Manager 137

Configure XBee network settings in the web interface 138

XBee Configuration page 138

Device Details page 139

XBee network OTA firmware updates 141

Update the XBee network node firmware (OTA updates) from Remote Manager 141

Update the XBee node firmware (OTA updates) from the web interface 142

XBee Gateway network Python log file 144

XBee network troubleshooting resources 144

Learn more about XBee Gateway

Default startup and operation behaviors for XBee Gateway 145

Default behavior regarding NTP time server access 145

Default behavior regarding DNS 145

Firewalls and required open ports 146

Deploying devices over a network 146

Connect the XBee nodes to XBee Gateway 146

Configure XBee Gateway as a coordinator 146

Join nodes to the coordinator 147

Verify that XBee nodes are joined to the coordinator 148

Configure the ZigBee network addressing parameters for XBee nodes 149

Key addressing parameters 149

XBee Gateway User Guide 8

Configure the network addressing parameters 150

Explore serial I/O 150

Understand the process for configuring the serial I/O 150

Example serial I/O configuration 151

Configure the serial I/O 151

Explore digital and analog I/O 152

Understand the process for digital and analog I/O 152

Example digital or analog I/O configuration 153

Configure the digital or analog I/O 154

View your device data 156

View device data from Remote Manager 157

View device data and events in the Python log file for XBee Gateway 157

Hardware

Ethernet and Wi-Fi hardware 162

Cellular hardware 163

Antennas 164

XBee Gateway button 164

XBee Gateway LEDs descriptions 165

Power LED 165

XBee LED 166

Network LED 166

Signal strength LED (cellular models only) 167

Troubleshoot your XBee Gateway

XBee Gateway system log 169

XBee Gateway log files and contents 169

Display the system log 170

Cellular connection issues 171

Common provisioning issues 171

Troubleshooting XBee Gateway GSM devices 172

Troubleshooting XBee Gateway CDMA devices 173

Device Discovery troubleshooting tips 173

Rebooting XBee Gateway 174

Troubleshooting LEDs 174

Firewalls and required open ports 175

Cannot connect to NTP time server to get correct time 176

Cannot connect to DNS server to resolve the Remote Manager server address 176

Need more help? 176

About Digi XBee Gateway

Digi XBee® Gateway provides a low-cost, programmable solution to connect networks of XBee-

enabled devices to IP networks. With a simple, open-source Python™ development environment, this

gateway enables custom applications to run locally while interfacing across existing Ethernet/Wi-

Fi/cellular networks for WAN connectivity to cloud-based software applications.

The XBee Gateway contains the XBeeZigBee product.

You can manage XBee Gateway products remotely via Digi Remote Manager®. Remote Manager

allows users to remotely manage thousands of deployed devices, supporting features like remote

firmware upgrades and event alarms.

This guide describes how to get started with yourXBee Gateway. This guide is intended for a

developer or programmer. It covers the following information:

nHardware

nGet started

nSet up your XBee Gateway

XBee Gateway User Guide 9

About Digi XBee Gateway Regulatory information and certifications

XBee Gateway User Guide 10

nAdministration and maintenance tasks

nAbout programming

nProgram XBee Gateway using Python

nConfigure XBee Gateway

nConfigure XBee network settings

nLearn more about XBee Gateway

nTroubleshoot your XBee Gateway

Regulatory information and certifications

RF exposure statement

In order to comply with RF exposure limits established in the ANSI C95.1 standards, the distance

between the antenna or antennas and the user should not be less than 20 cm.

FCC certifications and regulatory information (USA only)

FCC Part 15 Class B

Radio Frequency Interface (RFI) (FCC 15.105)

This device has been tested and found to comply with the limits for Class B digital devices pursuant to

Part 15 Subpart B, of the FCC rules. These limits are designed to provide reasonable protection

against harmful interference in a residential environment. This equipment generates, uses, and can

radiate radio frequency energy, and if not installed and used in accordance with the instruction

manual, may cause harmful interference to radio communications. However, there is no guarantee

that interference will not occur in a particular installation. If this equipment does cause harmful

interference to radio or television reception, which can be determined by turning the equipment off

and on, the user is encouraged to try and correct the interference by one or more of the following

measures:

nReorient or relocate the receiving antenna.

nIncrease the separation between the equipment and receiver.

nConnect the equipment into an outlet on a circuit different from that to which the receiver is

connected.

nConsult the dealer or an experienced radio/TV technician for help.

Labeling Requirements (FCC 15.19)

This device complies with Part 15 of FCC rules. Operation is subject to the following two conditions: (1)

this device may not cause harmful interference, and (2) this device must accept any interference

received, including interference that may cause undesired operation.

If the FCC ID is not visible when installed inside another device, then the outside of the device into

which the module is installed must also display a label referring to the enclosed module FCC ID.

Modifications (FCC 15.21)

Changes or modifications to this equipment not expressly approved by Digi may void the user’s

authority to operate this equipment.

Autres manuels pour XBee

Table des matières

Autres manuels Digi Porte

Digi

Digi ConnectPort X4 H Manuel utilisateur

Digi

Digi ConnectPort X2e ZB Manuel utilisateur

Digi

Digi ConnectPort X4 IA Manuel utilisateur

Digi

Digi ConnectPort X2e ZB Manuel utilisateur

Digi

Digi Xbee Gateway ZB Manuel utilisateur

Digi

Digi Connect Sensor Manuel d'utilisation et d'entretien

Digi

Digi IX15 Manuel utilisateur

Digi

Digi ConnectPort X2e Manuel

Digi

Digi Connectware RealPort Manuel utilisateur

Digi

Digi XGI-20CZ7-E00-W0 Manuel utilisateur

Digi

Digi ConnectPort X4 Series Manuel utilisateur

Digi

Digi Connect Sensor Instructions générales

Digi

Digi ConnectPort X4 Manuel utilisateur

Digi

Digi 90001268 B Manuel utilisateur

Digi

Digi SmartSense Z Manuel utilisateur

Digi

Digi ConnectPort X2e Manuel utilisateur

Digi

Digi ConnectPort X4 Manuel utilisateur

Digi

Digi ConnectPort X2e Wi-Fi SmartEnergy Manuel utilisateur

Digi

Digi XBee ZigBee Manuel utilisateur

Digi

Digi M2M Manuel utilisateur

Digi

Digi ConnectPort X4 Manuel utilisateur

Digi

Digi ConnectPort X2e Smart Energy Manuel utilisateur

Digi

Digi Connect Sensor Manuel utilisateur

Digi

Digi Wi-Point 3G Guide de l'utilisateur

Manuels Porte populaires d'autres marques

LST

LST M500RFE-AS Manuel utilisateur

Kinnex

Kinnex Media Gateway Manuel utilisateur

2N Telekomunikace

2N Telekomunikace 2N StarGate Manuel utilisateur

Mitsubishi Heavy Industries

Mitsubishi Heavy Industries Superlink SC-WBGW256 Manuel utilisateur

ZyXEL Communications

ZyXEL Communications ZYWALL2 ET 2WE Manuel utilisateur

Telsey

Telsey CPVA 500 - SIP Manuel utilisateur

RTA

RTA 460A-NNA4 Fiche technique

Shaw

Shaw Gateway HDPVR Manuel utilisateur

ABB

ABB VSN900 Guide de démarrage rapide

Commander

Commander Pulse Manuel utilisateur

2N Telekomunikace

2N Telekomunikace ATEUS EasyGate 501309E Manuel utilisateur

NETGEAR

NETGEAR C6300BD Manuel utilisateur

Amit

Amit CDW531AM Manuel utilisateur

HMS

HMS Netbiter EasyConnect EC150 Manuel utilisateur

Huawei

Huawei EchoLife HG620 Manuel utilisateur

AT&T

AT&T U-verse 3801 Manuel d'utilisation et d'entretien

Logic IO

Logic IO RTCU MX2 turbo Manuel utilisateur

Suttle

Suttle MediaMAX MXM-521 Manuel utilisateur