Digi XGI-20CZ7-E00-W0 User manual

Digi XBee® Industrial Gateway
User Guide

Revision history—90001542
Revision Date Description
A August 2017 Baseline release of this document.
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.
© 2017 Digi International Inc. All rights reserved.
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
[e-mail].
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.
Digi XBee Industrial Gateway 2

Contents
About Digi XBee Industrial Gateway
Regulatory information and certifications 9
RF exposure statement 9
FCC certifications and regulatory information (USA only) 9
Declaration of Conformity (DoC) 9
CE mark (Europe) 10
Industry Canada (IC) certifications 10
Safety statements 11
Warnings for Use of Wireless Devices 12
International EMC (Electromagnetic Emissions/Immunity/Safety) standards 12
Maximum power and frequency bands 13
XBee Industrial Gateway: Cellular 13
XBee Industrial Gateway: Ethernet 13
XBee Industrial Gateway Python application 13
XBee ZigBee Cloud Kit 13
Hardware interfaces 14
Configuration and management interfaces 14
XBee Industrial Gateway web interface 14
Remote Manager interface 14
RFGateway and Python remote device management solutions 15
Programming interface applications 15
Where to find more information 15
XBee Industrial Gateway hardware
Ethernet model 17
Ethernet model hardware specifications 18
Cellular model 20
Cellular model hardware specifications 21
XBee Industrial Gateway antennas 22
XBee Industrial Gateway LED descriptions 22
Signal strength LED (cellular models only) 23
Network LED 24
XBee LED 24
Power LED 25
Set up XBee Industrial Gateway
Setting up the XBee Industrial Gateway Cellular hardware 26
Verify your XBee Industrial Gateway Cellular components 26
Digi XBee Industrial Gateway 3

Digi XBee Industrial Gateway 4
Connect the hardware 28
Connect XBee Industrial Gateway to the cellular network 28
Setting up the XBee Industrial Gateway Ethernet hardware 29
Verify your XBee Industrial Gateway Ethernet components 29
Connect the hardware 30
Connect XBee Industrial Gateway to the Ethernet network 31
Getting started with XBee Industrial Gateway
Set up XBee Industrial Gateway summary 32
Joining ZigBee networks 33
Joining XBee Industrial Gateway to an existing ZigBee network 34
Configuring XBee Industrial Gateway with a custom PAN ID 35
XBee Industrial Gateway and non-XBee ZigBee Devices 36
Administration and maintenance tasks
File management 37
File Management page in Remote Manager 37
File Management page in the XBee Industrial Gateway web interface 38
Back up or restore the configuration 39
Back up and restore files from Remote Manager 39
Back up and restore files from the XBee Industrial Gateway web interface 39
Update firmware 41
Update firmware from Remote Manager 41
Update firmware from the XBee Industrial Gateway web interface 42
About firmware files 44
Mobile device status 44
Displaying the mobile device status 44
Mobile Status page 45
Displaying the XBee Industrial Gateway End User License Agreement (EULA) 49
Rebooting XBee Industrial Gateway 50
Displaying system information 50
Disconnecting XBee Industrial Gateway from Remote Manager 50
About programming
Python 51
XBee ZigBee Cloud Kit web application source code 52
Programming calls through Server Command Interface (SCI) and Remote Command Interface
(RCI) 52
XBee Industrial Gateway file system 52
Important directories 52
Load applications onto XBee Industrial Gateway 53
Program XBee Industrial Gateway using Python
Find Python learning resources 55
Digi Python Programmer's Guide 55
Python support forum 55
Digi Wiki for Developers 55
Digi-specific Python modules for programming 55
Sample programs 55

Digi XBee Industrial Gateway 5
LED control 56
Watchdog 56
RCI callback 57
XBee functions 58
XBee Industrial Gateway Python application and Remote Manager 58
How does the XBee Industrial Gateway Python application work? 59
Key features and operations of the XBee Industrial Gateway Python application 59
XBee Industrial Gateway Python application requirements 60
Store status data for XBee lines in Remote Manager 60
Receive serial data from Remote Manager 64
Store serial data in Remote Manager 71
Manage XBee DIO lines though Remote Manager 74
XBee Industrial Gateway Python application configuration file 81
XBee Industrial Gateway Python application command errors 82
Configuring a Python application in the web interface 83
Digi ESP for Python 83
Access the program samples in Digi ESP 83
Install the Digi ESP for Python Development Environment 84
DIA software 87
Linux command shell (command-line interface) 87
User name and password for the Linux command shell 87
XBee Industrial Gateway ash shell reference documentation 87
Connect and log in to the XBee Industrial Gateway device 87
Log in to XBee Industrial Gateway through the Digi ESP for Python command-line interface 88
Configure XBee Industrial Gateway
Configure settings from Remote Manager 91
Basic configuration settings 91
Advanced configuration settings 91
Configure settings from the XBee Industrial Gateway web interface 92
Access the XBee Industrial Gateway web interface 92
Home page 92
Ethernet IP network settings 93
Default Ethernet settings 94
Configuring Ethernet Settings 94
Ethernet Configuration page 94
Ethernet Network Configuration page 95
Mobile Connectivity settings 97
Default behavior with the cellular network 97
Set up and configure a cellular device 97
Configure mobile settings 99
Mobile Configuration page 99
Mobile Connectivity Configuration page 100
Digi Mobile SureLink™ settings 101
Configuring Mobile SureLink settings 101
Mobile SureLink integrity monitoring settings 102
Link integrity test options 103
DNS settings 104
Configure Domain Name Server (DNS) 104
Domain Name Server (DNS) Configuration page 104
Mobile firewall settings 105
Configure mobile firewall settings 105
Enable or Disable Mobile firewall settings 105
Autostart settings for the Python Program 105

Digi XBee Industrial Gateway 6
Configure Python settings 106
Python settings 106
Configure Remote Manager connectivity settings 106
Configuring connectivity settings 107
Device Cloud Configuration page 108
Device Cloud client initiated connection page 109
Device Cloud network type page 109
Basic connectivity settings 110
Advanced connectivity settings for the web interface 111
Connect to a different instance of Remote Manager 113
Configure a proxy server 113
Ethernet SureLink™ settings 113
Configuring Ethernet SureLink settings 114
Ethernet SureLink settings 114
GPS static position settings 115
Configuring GPS Static Position settings 115
GPS Static Position page 115
Network Failover settings 116
Configure network failover on the XBee Industrial Gateway web interface 116
Configure network failover in Remote Manager 116
Link integrity test options and failover 117
Time settings 118
Configure time settings 118
Time Server Configuration page 119
Time Zone Configuration page 119
Time Configuration page 119
Configure XBee network settings
Configure XBee Networks page in Remote Manager 121
Configure XBee network settings in the web interface 122
XBee Configuration page 122
Device Details page 123
XBee network OTA firmware updates 125
Update the XBee network node firmware (OTA updates) from Remote Manager 125
Update the XBee node firmware (OTA updates) from the web interface 127
XBee Industrial Gateway network Python log file 128
XBee network troubleshooting resources 128
Learn more about XBee Industrial Gateway
Default startup and operation behaviors for XBee Industrial Gateway 129
Default behavior regarding NTP time server access 129
Default behavior regarding DNS 130
Firewalls and required open ports 130
Deploying devices over a network 130
Connect the XBee nodes to XBee Industrial Gateway 130
Configure XBee Industrial Gateway as a coordinator 130
Join nodes to the coordinator 131
Verify that XBee nodes are joined to the coordinator 132
Configure the ZigBee network addressing parameters for XBee nodes 133
Key addressing parameters 133
Configure the network addressing parameters 134
Explore serial I/O 134

Digi XBee Industrial Gateway 7
Understanding the process for configuring the serial I/O 134
Example serial I/O configuration 134
Configuring the serial I/O 135
Explore digital and analog I/O 135
Understanding the process for digital and analog I/O 136
Example digital or analog I/O configuration 138
Configuring the digital or analog I/O 138
View your device data 140
View device data from Remote Manager 141
View device data and events in the Python log file for XBee Industrial Gateway 141
Troubleshoot your XBee Industrial Gateway
XBee Industrial Gateway system log 146
XBee Industrial Gateway log files and contents 146
Displaying the system log 147
Cellular connection issues 148
Common configuring issues 148
Troubleshooting XBee Industrial Gateway GSM and LTE devices 149
Device Discovery troubleshooting tips 150
Rebooting XBee Industrial Gateway 150
Troubleshooting LEDs 150
Firewalls and required open ports 152
Cannot connect to NTP time server to get correct time 152
Cannot connect to DNS server to resolve the Remote Manager server address 153
Need more help? 153

About Digi XBee Industrial Gateway
Digi XBee® Industrial Gateway provides a rugged, programmable gateway solution to connect
networks of XBee-enabled devices to IP networks in industrial environments, which potentially have
more extreme conditions, such as wide temperature and humidity variations.
With a simple, open-source Python™ development environment, this gateway enables custom
applications to run locally while interfacing across existing Ethernet and cellular networks for WAN
connectivity to cloud-based software applications. Automatic WANfailover functionality ensures
mission-critical data always reaches its destination. XBee Industrial Gateway Ethernet and Cellular
(GSM\LTE) models are available.
The XBee Industrial Gateway contains the XBeeZigBee product.
You can manage XBee Industrial 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.
XBee Industrial Gateway Cellular model XBee Industrial Gateway Ethernet
model
This guide describes how to get started with yourXBee Industrial Gateway. This guide is intended for
a developer or programmer. It covers the following information:
nXBee Industrial Gateway hardware
nSet up XBee Industrial Gateway
nGetting started with XBee Industrial Gateway
nAdministration and maintenance tasks
nAbout programming
nProgram XBee Industrial Gateway using Python
Digi XBee Industrial Gateway 8

About Digi XBee Industrial Gateway Regulatory information and certifications
Digi XBee Industrial Gateway 9
nConfigure XBee Industrial Gateway
nConfigure XBee network settings
nLearn more about XBee Industrial Gateway
nTroubleshoot your XBee Industrial 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.
Declaration of Conformity (DoC)
Digi has issued Declarations of Conformity for the XBee Industrial Gateway concerning emissions,
EMC, and safety. For more information, see www.digi.com/resources/certifications.
Important note

About Digi XBee Industrial Gateway Regulatory information and certifications
Digi XBee Industrial Gateway 10
Digi customers assume full responsibility for learning and meeting the required guidelines for each
country in their distribution market. Refer to the radio regulatory agency in the desired countries of
operation for more information.
CE mark (Europe)
The XBee Industrial Gateway is certified for use in several European countries. For information, visit
www.digi.com/resources/certifications.
If the XBee Industrial Gateway is incorporated into a product, the manufacturer must ensure
compliance of the final product with articles 3.1a and 3.1b of the RE Directive (Radio Equipment
Directive). A Declaration of Conformity must be issued for each of these standards and kept on file as
described in the RE Directive.
Furthermore, the manufacturer must maintain a copy of the XBee Industrial Gateway user manual
documentation and ensure the final product does not exceed the specified power ratings, antenna
specifications, and/or installation requirements as specified in the user manual. If any of these
specifications are exceeded in the final product, a submission must be made to a notified body for
compliance testing to all required standards.
OEM labeling requirements
The CE marking must be affixed to a visible location on the OEM product.
CE labeling requirements
The CE mark shall consist of the initials “CE” taking the following form:
nIf the CE marking is reduced or enlarged, the proportions given in the above graduated
drawing must be respected.
nThe CE marking must have a height of at least 5mm except where this is not possible on
account of the nature of the apparatus.
nThe CE marking must be affixed visibly, legibly, and indelibly.
Industry Canada (IC) certifications
This digital apparatus does not exceed the Class B limits for radio noise emissions from digital
apparatus set out in the Radio Interference Regulations of the Canadian Department of