Digi XBee Gateway User Manual
XBee® Gateway
User Guide
Revision history—90001399-13
Revision Date Description
D July 2017 Updated the Certificate Management section to specify that this feature is
available only for Wi-Fi devices.
E September
2017
F January
2020
G February
2020
H October
2020
Reorganized and edited the document.
Added information about the unique password for the web interface.
Added link to data sheet specifications.
Updated information for XBee network OTA firmware updates.
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.
© 2020 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
techcomm@digi.com.
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
2
Contents
About Digi XBee Gateway
Regulatory information and certifications 9
RF exposure statement 9
FCC certifications and regulatory information (USA only) 9
Declaration of Conformity (DoC) 10
CE mark (Europe) 10
Industry Canada (IC) certifications 11
Korea Communications Commission (KCC) certifications 11
Safety statements 11
Warnings for Use of Wireless Devices 12
International EMC (Electromagnetic Emissions/Immunity/Safety) standards 13
Maximum power and frequency bands 13
XBee Gateway: Cellular 14
XBee Gateway: Ethernet 14
XBee Gateway: Wi-Fi 14
XBee Gateway Python application 14
XBee ZigBee Cloud Kit 14
Hardware interfaces 15
Configuration and management interfaces 15
XBee Gateway web interface 15
Remote Manager interface 15
RFGateway and Python remote device management solutions 16
Programming interface applications 16
Product differences from predecessor ConnectPort® X products 17
Where to find more information 18
Get started
Set up the XBee Gateway Cellular hardware 19
Verify your components 19
Connect the cellular hardware 21
Connect XBee Gateway to the network 22
Set up the XBee Gateway Wi-Fi hardware 22
Verify your components 23
Connect the Wi-Fi hardware 24
Connect XBee Gateway to the network 25
Set up your XBee Gateway
Set up XBee Gateway summary 27
XBee Gateway User Guide
3
Joining ZigBee networks 28
Join XBee Gateway to an existing ZigBee network 29
Configure XBee Gateway with a custom PAN ID 30
XBee Gateway and non-XBee ZigBee Devices 31
Administration and maintenance tasks
Logging in to the web interface 32
File management 32
File Management page in Remote Manager 32
File Management page in the XBee Gateway web interface 33
Certificate Management 34
Certificate Management page in the web interface 34
Back up or restore the configuration 35
Back up and restore files from Remote Manager 35
Back up and restore files from the XBee Gateway web interface 36
Update firmware 37
Update firmware from Remote Manager 37
Update firmware from the XBee Gateway web interface 39
About firmware files 40
Mobile device status 40
Display the mobile device status 41
Mobile Status page 41
Change the password for the web interface 49
Display the XBee Gateway End User License Agreement (EULA) 51
Restore XBee Gateway factory defaults 52
Reboot XBee Gateway 52
Display system information 52
Disconnect XBee Gateway from Remote Manager 52
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
4
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
Log in to XBee Gateway through the Digi ESP for Python command line interface 92
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
5
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
OTA firmware update troubleshooting 144
XBee Gateway network Python log file 145
XBee network troubleshooting resources 145
Learn more about XBee Gateway
Default startup and operation behaviors for XBee Gateway 146
Default behavior regarding NTP time server access 146
Default behavior regarding DNS 146
Firewalls and required open ports 147
Deploying devices over a network 147
Connect the XBee nodes to XBee Gateway 147
Configure XBee Gateway as a coordinator 147
Join nodes to the coordinator 148
Verify that XBee nodes are joined to the coordinator 149
Configure the ZigBee network addressing parameters for XBee nodes 150
XBee Gateway User Guide
6
Key addressing parameters 150
Configure the network addressing parameters 151
Explore serial I/O 151
Understand the process for configuring the serial I/O 151
Example serial I/O configuration 152
Configure the serial I/O 152
Explore digital and analog I/O 153
Understand the process for digital and analog I/O 153
Example digital or analog I/O configuration 154
Configure the digital or analog I/O 155
View your device data 157
View device data from Remote Manager 158
View device data and events in the Python log file for XBee Gateway 158
Hardware
Ethernet and Wi-Fi hardware 161
Cellular hardware 162
Antennas 163
XBee Gateway button 163
XBee Gateway LEDs descriptions 164
Power LED 164
XBee LED 165
Network LED 165
Signal strength LED (cellular models only) 166
Troubleshoot your XBee Gateway
XBee Gateway system log 168
XBee Gateway log files and contents 168
Display the system log 169
Cellular connection issues 170
Common provisioning issues 170
Troubleshooting XBee Gateway GSM devices 171
Troubleshooting XBee Gateway CDMA devices 172
Device Discovery troubleshooting tips 172
Rebooting XBee Gateway 173
Troubleshooting LEDs 173
Firewalls and required open ports 174
Cannot connect to NTP time server to get correct time 175
Cannot connect to DNS server to resolve the Remote Manager server address 175
Need more help? 175
XBee Gateway User Guide
7
About Digi XBee Gateway
Digi XBee® Gateway provides a low-cost, programmable solution to connect networks of XBeeenabled 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/WiFi/cellular networks for WAN connectivity to cloud-based software applications.
The XBee Gateway contains the XBeeZigBee 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 yourXBee Gateway. This guide is intended for a
developer or programmer. It covers the following information:
n Hardware
n Get started
n Set up your XBee Gateway
XBee Gateway User Guide
8
About Digi XBee Gateway Regulatory information and certifications
n Administration and maintenance tasks
n About programming
n Program XBee Gateway using Python
n Configure XBee Gateway
n Configure XBee network settings
n Learn more about XBee Gateway
n Troubleshoot 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:
n Reorient or relocate the receiving antenna.
n Increase the separation between the equipment and receiver.
n Connect the equipment into an outlet on a circuit different from that to which the receiver is
connected.
n Consult 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.
XBee Gateway User Guide
9
About Digi XBee Gateway Regulatory information and certifications
Declaration of Conformity (DoC)
Digi has issued Declarations of Conformity for the XBee Gateway concerning emissions, EMC, and
safety. For more information, see www.digi.com/resources/certifications.
Important note
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 Gateway is certified for use in several European countries. For information, visit
www.digi.com/resources/certifications.
If the XBee 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 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:
n If the CE marking is reduced or enlarged, the proportions given in the above graduated
drawing must be respected.
XBee Gateway User Guide
10
About Digi XBee Gateway Safety statements
n The CE marking must have a height of at least 5 mm except where this is not possible on
account of the nature of the apparatus.
n The 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
Communications.
This device complies with Industry Canada’s licence-exempt RSSs. Operation is subject to the
following two conditions:
(1) This device may not cause interference; and
(2) This device must accept any interference, including interference that may cause undesired
operation of the device.
Le présent appareil numerique n’emet pas de bruits radioelectriques depassant les limites applicables
aux appareils numeriques de la class B prescrites dans le Reglement sur le brouillage radioelectrique
edicte par le ministere des Communications du Canada.
Le présent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio exempts
de licence. L'exploitation est autorisée aux deux conditions suivantes:
(1) l'appareil ne doit pas produire de brouillage, et
(2) l'utilisateur de l'appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage
est susceptible d'en compromettre le fonctionnement.
Korea Communications Commission (KCC) certifications
We, Digi International, in agreement with Powermat gateway, as per The Radio Research Agency
(RRA), division of the Korea Communications Commission (KCC), consider this device Industrial Class A
Equipment (Industrial Broadcasting & Communication Equipment) and therefore electromagnetic
wave-suitable.
For Class A Equipment (Business Broadcasting and Communications Equipment)
The equipment is for business use (Class A), and has acquired electromagnetic conformity
registration, so sellers and users are required to take caution in this regard.
Safety statements
Important Safety Information
CAUTION! To avoid contact with electrical current, follow all safety items listed below.
XBee Gateway User Guide
11
About Digi XBee Gateway Safety statements
n Never install electrical wiring during an electrical storm.
n Never install an Ethernet connection in wet locations unless that connector is specifically
designed for wet locations.
n Use caution when installing or modifying lines.
n Use a screwdriver and other tools with insulated handles.
n Wear safety glasses or goggles.
n Do not place Ethernet wiring or connections in any conduit, outlet or junction box containing
electrical wiring.
n Installation of inside wire may bring you close to electrical wire, conduit, terminals and other
electrical facilities. Extreme caution must be used to avoid electrical shock from such facilities.
Avoid contact with all such facilities.
n Ethernet wiring must be at least 6 feet from bare power wiring or lightning rods and
associated wires, and at least 6 inches from other wire (antenna wires, doorbell wires, wires
from transformers to neon signs), steam or hot water pipes, and heating ducts.
n Do not place an Ethernet connection where it would allow a person to use an Ethernet device
while in a bathtub, shower, swimming pool, or similar hazardous location.
n Protectors and grounding wire placed by the service provider must not be connected to,
removed, or modified by the customer.
n Do not touch uninsulated Ethernet wiring if lightning is likely.
n External Wiring: Any external communications wiring installed needs to be constructed to all
relevant electrical codes. In the United States this is the National Electrical Code Article 800.
Contact a licensed electrician for details.
Warnings for Use of Wireless Devices
CAUTION! Observe all warning notices regarding use of wireless devices.
Potentially Hazardous Atmospheres
Observe restrictions on the use of radio devices in fuel depots, chemical plants, etc. and areas where
the air contains chemicals or particles, such as grain, dust, or metal powders, and any other area
where you would normally be advised to turn off your vehicle engine.
Safety in Aircraft
Switch off the wireless device when instructed to do so by airport or airline staff. If the device offers a
‘flight mode’ or similar feature, consult airline staff about its use in flight.
XBee Gateway User Guide
12
About Digi XBee Gateway Maximum power and frequency bands
Safety in Hospitals
Wireless devices transmit radio frequency energy and may affect medical electrical equipment. Switch
off wireless devices wherever requested to do so in hospitals, clinics, or health care facilities. These
requests are designed to prevent possible interference with sensitive medical equipment.
Pacemakers
Pacemaker manufacturers recommended that a minimum of 15 cm (6 inches) be maintained between
a handheld wireless device and a pacemaker to avoid potential interference with the pacemaker.
These recommendations are consistent with independent research and recommendations by Wireless
Technology Research.
Persons with Pacemakers
n Should ALWAYS keep the device more than 15 cm (6 inches) from their pacemaker when turned
ON.
n Should not carry the device in a breast pocket.
n If you have any reason to suspect that the interference is taking place, turn OFF your device.
International EMC (Electromagnetic Emissions/Immunity/Safety) standards
This product complies with the requirements of following Electromagnetic Emissions/Immunity/Safety
standards.
There are no user-serviceable parts inside the product. Contact your Digi representative for repair
information.
Emissions Immunity Safety
AS/NZS 4268:2008 (Amended by A1:2010) Class
B (Wi-Fi only)
AS/NZS CISPR 22:2009 Class B
EN 301 489-17 V2.1.1:2009 Class B (Wi-Fi only)
EN 55022:2010 Class B
EN 61000-3-2:2006
EN 61000-3-3:2008
FCC Part 15 Subpart B Class B
FCC Part 15 Subpart C (Wi-Fi only)
ICES-003:2004 Class B
RSS-Gen:2010 (Wi-Fi only)
RSS-210:2010 (Wi-Fi only)
EN 301 489-17 V2.1.1:2009
(Wi-Fi only)
EN 55024:2010
EN 301 489-24 V1.5.1 (Cellular
only)
Maximum power and frequency bands
This section contains the maximum power and frequency bands for the XBee Gateway.
IEC 60950-1:2005
EN 60950-1:2006
UL 60950-1
CSA C22.2 No.
60950-1
XBee Gateway User Guide
13
About Digi XBee Gateway XBee Gateway Python application
XBee Gateway: Cellular
Maximum power Associated frequencies
6.3 mW 5 MHz channel spacing, beginning at 2405 MHz and ending at
2480 MHz
2 W Cellular 850 and 900 MHz bands
1 W Cellular 1800 and 1900 MHz bands
XBee Gateway: Ethernet
Maximum power Associated frequencies
6.3 mW 5 MHz channel spacing, beginning at 2405 MHz and ending at
2480 MHz
XBee Gateway: Wi-Fi
Maximum power Associated frequencies
6.3 mW 5 MHz channel spacing, beginning at 2405 MHz and ending at
2480 MHz
88 mW 13 overlapping channels each 22 MHz wide and spaced at 5
MHz. Centered at 2.412 to 2.472 MHz.
XBee Gateway Python application
The XBee Gateway Python application resides on XBee Gateway. Its key functions include connecting
your XBee modules to Remote Manager, enabling uploads of data to Remote Manager, and receiving
remote text and commands. The XBee Gateway Python application is installed by default in your XBee
Gateway device and automatically starts when the gateway is initialized.
For more information on the XBee Gateway Python application, see XBee Gateway Python application
and Remote Manager.
XBee ZigBee Cloud Kit
Digi offers a development kit called the XBee ZigBee Cloud Kit.
The XBee ZigBee Cloud Kit is designed to make it easy to set up your XBee ZigBee hardware and
configure its sample web application. You can see sensor data from your development board on the
web, as well as send data and commands from the web to your device. The components in this kit
allow you to create highly customized solutions for connected devices.
To order this kit, go to the XBee Gateway product page for ordering information. For setup
instructions, see the XBeeZigBeeCloudKit Getting Started Guide.
XBee Gateway User Guide
14
About Digi XBee Gateway Hardware interfaces
Hardware interfaces
XBee Gateway hardware interfaces include a button for controlling various device operations, LEDs
that indicate device state and status of connections, and activity for Ethernet, Wi-Fi, cellular, and XBee
network connections. You can control some of these hardware features through programming.
For detailed information about hardware interfaces, see Hardware.
Configuration and management interfaces
To establish network connectivity with an XBee Gateway device, minimal configuration is required in
many environments. This means that you may not need to set or change configuration settings from
their factory defaults to begin developing with the device. There are several user interfaces for
interacting with XBee Gateway, for example to view or change configuration settings or perform
important administrative tasks such as updating firmware or rebooting the device. These include:
n XBee Gateway web interface: A web-based interface for configuring, monitoring, and
administering Digi devices.
n Remote Manager interface: A web-based, remote-management interface.
n RFGateway and Python remote device management solutions
n Programming interface applications
XBee Gateway web interface
The XBee Gateway web interface, available via a local network connection to XBee Gateway, provides
an easy way to configure device settings and perform administrative tasks. Device information
displayed varies by model.
You are required to log in to the web interface. The default user name and password are described
below:
n User name: python
n Password: The unique password printed on the device label. If the password is not on the
device label, the default password is dbps. If these defaults do not work, the password may
have been updated. Contact your system administrator for help.
For more information, see Configure settings from the XBee Gateway web interface.
Remote Manager interface
Remote Manager is a software-as-a-service that empowers IT, network operations and customer
support organizations to conquer the challenges of managing the vast array of equipment in their
device networks. As a network grows, the complexity of effectively managing the network assets
grows exponentially.
When XBee Gateway powers up, the device automatically connects to Remote Manager. Remote
Manager provides the capabilities you need to manage a dynamic device network, including:
n Centralized control over large numbers of devices
n Reducing service complexity
n Maintaining high levels of security
XBee Gateway User Guide
15
About Digi XBee Gateway Configuration and management interfaces
n Configuring and decommissioning of equipment
n Adding functionality to device networks
In addition, you can use the Remote Manager Web Services (API) to provide seamless integration from
Digi gateways into customer back-office applications. You can access these Web Services via the API
Explorer tab of the Documentation tab of the Remote Manager interface. See Digi Remote Manager
Programmer Guide for more information.
Some things to note about using Remote Manager:
n You must register devices on Remote Manager before you can access them from Remote
Manager.
n To minimize network traffic, Remote Manager uses caching. As a result, device settings can be
out-of-sync between the device and the settings viewed on the Remote Manager console.
n You can refresh device information on demand when the device is connected. The device
information refreshes automatically when a device connects.
For more information about configuring settings from Remote Manager, see Configure settings from
Remote Manager.
For more information on Remote Manager as a remote device network management solution, see
these resources:
n Digi Remote Manager User Guide
n Digi Remote Manager Programmer Guide
n Remote Manager tutorials and other documents available on the Digi Remote Manager
product page
Note To serve our customers most effectively, Digi International Inc. is consolidating its cloud
services, Digi Device Cloud and Digi Remote Manager®, under the Remote Manager name. This phased
process does not affect device functionality or the functionality of the web services and other
features. However, you will find instances of both Device Cloud and Digi Remote Manager in some
documentation, firmware, and user interfaces.
RFGateway and Python remote device management solutions
XBee Gateway includes Remote Manager functionality by default. This functionality allows you to see
your data in the cloud quickly and with minimal effort.
However, you can extend the system through the Python interpreter and customize the gateway to
connect directly to the environment of your choice. See the Digi XBee, RFGateway and Python
Resource page for more information.
Programming interface applications
XBee Gateway offers a variety of interfaces that produce and/or consume data. Developing software
programs for XBee Gateway products allows Digi customers to provide custom logic to control the
information to and from these interfaces.
For more information, see About programming.
XBee Gateway User Guide
16
About Digi XBee Gateway Product differences from predecessor ConnectPort® X products
Product differences from predecessor ConnectPort® X products
XBee Gateway differs from predecessor ConnectPort X products. These differences are important to
programmers and integrators who are familiar with the predecessor devices and need to develop
applications and install or manage the gateway. These differences include the following.
n Operating system: XBee Gateway is built on the industry-standard Linux operating system,
versus a Digi-proprietary embedded operating system.
n Memory: XBee Gateway has 64 MB of RAM and 128 MB of flash memory. Users have access to
up to 20 MB of RAM and up to 20 MB of flash memory. Predecessor devices had less RAM and
flash memory available for custom Python applications.
n System date and time: XBee Gateway, for reasons of improved security, has a greater
dependence on time synchronization than predecessor products. In so doing, XBee Gateway
uses standard Network Time Protocol (NTP) and requires connectivity with an external NTP
time server. Without NTP, the device cannot:
l Correctly validate security certificate
l Disable the ability to connect to Remote Manager
l Disable the ability to update the firmware
n Button: XBee Gateway features a programmable button. You can configure this button to
activate some Digi native features (such as returning a device to its factory defaults), and you
can also use this button for custom applications. For more information on the button, see XBee
Gateway button. This button behavior differs from the Reset button behavior on other gateway
products.
n User interfaces:
l XBee Gateway has a web user interface for both network configuration and access to the
log file for troubleshooting the initial connection to Remote Manager. For more information
on the web interface, see Configure XBee Gateway.
l Command-line interface differences: XBee Gateway allows access to the Linux shell
using SSH. For more information about the shell, see Linux command shell (command line
interface). Access to a command-line interface through Telnet is not supported for network
security reasons. Commands in the command-line interface for predecessor ConnectPort X
products are not supported. However, some ConnectPort X2 command-line interface
commands have equivalents in the Remote Command Interface (RCI).
n Firmware updates: Due to the complexity of the Linux-based system, you cannot use standard
firmware updates to downgrade a system.
n Logging: XBee Gateway supports continuous logging for troubleshooting. You can browse the
log files from the web interface or pull the log files from the device file system in Remote
Manager. They are stored in the Linux file system in the /WEB/logging directory and persist
across reboots and power cycles. For more information, see View the Python log file.
XBee Gateway User Guide
17
About Digi XBee Gateway Where to find more information
n Supported Python version: XBee Gateway uses Python interpreter version 2.7. Many
predecessor ConnectPort X products use Python 2.4.
Any custom-compiled Python code must be recompiled for Python interpreter 2.7. Custom
Python modules are not 100% compatible with XBee Gateway. Therefore, in addition to
recompiling, you may need to port.
Where to find more information
See the following topics in this guide for more information:
n Learn more about XBee Gateway
n About programming
The following documents are available on www.digi.com unless otherwise noted:
n For more information about features and operation of the XBee RF module mounted inside the
gateway, see XBee/XBee-PRO ZigBee RF Module User Guide.
n You can refer to the ConnectPort X2e section in the Digi Python Wiki Archive Reference Manual
for additional programming content for ConnectPort X2e products. Information in this section
also applies to XBee Gateway.
n DIA section in the Digi Python Reference Manual for Developers guide
n Digi Remote Manager User Guide
n Digi Remote Manager Programmer Guide
n Datasheets and other documents on the Digi Remote Manager product page
XBee Gateway User Guide
18
Get started
Based on the XBee Gateway model that you have, choose one of the following options:
n Set up the XBee Gateway Cellular hardware
n Set up the XBee Gateway Wi-Fi hardware
Set up the XBee Gateway Cellular hardware
This section walks you through the steps required to set up your XBee Gateway Cellular hardware and
provides additional reference information.
Verify your components
Included equipment
Equipment Description
XBee Gateway
(Cellular model)
XBee Gateway User Guide
19
Get started Set up the XBee Gateway Cellular hardware
Equipment Description
Ethernet cable
Power supply
Note A loose label sticker that includes the unique device password may be included in the box. Retain
this label sticker with your hardware records. This default password will be needed to log into the
device's web UI if the device is factory reset.
XBee Gateway User Guide
20
Get started Set up the XBee Gateway Cellular hardware
Connect the cellular hardware
1. Install a SIM card. See Set up and configure GSM-based devices for instructions.
2. Optional: If you are using an Ethernet connection in addition to the cellular, connect one end of
the Ethernet cable to your gateway and the other to a live Ethernet jack.
XBee Gateway User Guide
21
Get started Set up the XBee Gateway Wi-Fi hardware
3. Connect the power supply.
4. Startup Sequence - After power is applied:
a. The Power LEDturns solid green.
b. The XBee LEDturns blinking green when XBee Gateway
creates a ZigBee network.
c. The Network LEDgradually turns solid green when XBee
Gateway connects to Remote Manager.
d. For the Cellular model, the Signal Strength LEDturns
either yellow or green, depending on the cellular signal
strength.
Connect XBee Gateway to the network
Choose one of the following options:
Connect to an Ethernet network
Your XBee gateway automatically connects to the Ethernet network when a DHCP server is available
to assign an IP address to it and no firewalls block outgoing traffic to ports 3197 and 3199. If the
Ethernet network does not come up, see Cannot connect to DNS server to resolve the Remote
Manager server address.
Note XBee Gateway requires a DHCP server to assign its IP address. If you do not have a DHCP
server, see Ethernet IP network settings for information on configuring your IP parameters.
Connect to a Cellular network
Register the modem in the XBee Gateway cellular device and set it up in your mobile service provider's
network. Registration and setup differs among models. See Default behavior with the cellular network
for information on configuring the XBeeGateway cellular model (GSM or CDMA). Disconnect the
Ethernet cable when the configuration steps are complete.
Set up the XBee Gateway Wi-Fi hardware
This section walks you through the steps required to set up your XBee Gateway Wi-Fi hardware and
provides additional reference information.
XBee Gateway User Guide
22
Get started Set up the XBee Gateway Wi-Fi hardware
Verify your components
Included equipment
Equipment Description
XBee Gateway
(Wi-Fi model)
Ethernet cable
Power supply
Note A loose label sticker that includes the unique device password may be included in the box. Retain
this label sticker with your hardware records. This default password will be needed to log into the
device's web UI if the device is factory reset.
XBee Gateway User Guide
23
Get started Set up the XBee Gateway Wi-Fi hardware
Connect the Wi-Fi hardware
1. Optional: If using an Ethernet connection in addition to the Wi-Fi, connect one end of the
Ethernet cable to your gateway and the other to a live Ethernet jack.
XBee Gateway User Guide
24
Get started Set up the XBee Gateway Wi-Fi hardware
2. Connect the power supply.
3. Startup Sequence - After power is applied:
a. The Power LEDturns solid green.
b. The XBee LEDturns blinking green when XBee Gateway creates a
ZigBee network.
c. The Network LEDgradually turns solid green when XBee Gateway
connects to Remote Manager.
Note For more information on these LEDstates, see XBee Gateway LEDs descriptions.
Connect XBee Gateway to the network
Choose one of the following options:
Connect to a Wi-Fi network
1. Get the following Wi-Fi security information from your network administrator. You will need this
to connect to your Wi-Fi access point in step 6.
SSID: ____________________
Wi-Fi security mode: ____________________
Passphrase or key: ____________________
Other parameters: ____________________
2. Press the button on your XBee Gateway once to enable Access Point mode. This Access Point
mode is active for five minutes.
XBee Gateway User Guide
25
Get started Set up the XBee Gateway Wi-Fi hardware
3. From the list of Wi-Fi network connections on your computer, connect your computerto the Wi-
Fi network named xbgw-xx:xx:xx:xx:xx:xx, where xx:xx:xx:xx:xx:xx is the serial number of
the gateway.
4. Once you connect to the Wi-Fi network on your computer, open a web browser and type the
URL of XBee Gateway: http://192.168.100.1. This will open the XBee Gateway web interface.
5. Log in to the web interface.
n User name: The default user name is python. If that user name does not work, it may
have been changed by your system administrator. Contact your system administrator
for help.
n Password: The unique, default password is printed on the device label. If the password
is not on the device label, the default password is dbps. If these defaults do not work,
the password may have been updated. Contact your system administrator for help.
6. From the XBeeGateway web interface, go to Configuration > Wireless Network.
7. On the Wireless Network Configuration page, click Run Wizard under Interface Configuration
and follow the prompts to configure your device. See Wi-Fi network settings for more
information.
8. Restore the Wi-Fi network on your computer to its previous connection.
Connect to an Ethernet network
Your XBee gateway automatically connects to the Ethernet network, when a DHCP server is available
to assign an IP address to it and no firewalls block outgoing traffic to ports 3197 and 3199. If the
Ethernet network does not come up, see Cannot connect to DNS server to resolve the Remote
Manager server address.
Note XBee Gateway requires a DHCP server to assign its IP address. If you do not have a DHCP
server, see Ethernet IP network settings for information on configuring your IP parameters.
XBee Gateway User Guide
26
Set up your XBee Gateway
This section walks you through the steps required to set up your XBee Gateway and provides
additional reference information.
Set up XBee Gateway summary
These instructions give an overview of how to set up XBee Gateway.
1. Configure the network settings. These settings include IP networking parameters and Remote
Manager connectivity.For more information, see:
n Wireless (Wi-Fi) network settings
n Ethernet IP network settings
n Mobile connectivity settings
2. Connect the XBee nodes to XBee Gateway. This step involves configuring the parameters for
forming XBee networks on both XBee Gateway and XBee nodes. There are three substeps:
a. Configure XBee Gateway as a coordinator.
b. Join XBee nodes to the coordinator.
c. Verify that the XBee nodes are joined to the coordinator.
See Connect the XBee nodes to XBee Gateway for more information.
3. Configure XBee ZigBee network addressing settings. See Configure the ZigBee network
addressing parameters for XBee nodes for more information.
4. Explore configuring XBee nodes for input/output.
a. If using serial I/O, configure XBee nodes for serial I/O. See Explore serial I/O for
b. If using digital or analog I/O, configure the XBee nodes for digital or analog I/O. See
5. Look at your device data on Remote Manager. See View your device data for more information.
The following image shows the layout of a fully set up XBee Gateway.
XBee Gateway User Guide
more information.
Explore digital and analog I/O for more information.
27
Set up your XBee Gateway Joining ZigBee networks
Joining ZigBee networks
ZigBee networks are called Personal Area Networks or PANs. In the ZigBee protocol, the only node
that can start a new network is the coordinator. For that reason, each ZigBee network must have one
coordinator.
XBee Gateway includes a built-in XBee ZigBee node already configured as coordinator. Therefore, as
soon as you power on the XBee Gateway device, your ZigBee network is initialized.
To start a network, the coordinator must automatically choose a PAN identifier (PAN ID) and the
operating channel for that network. Once those parameters are established and the network is
XBee Gateway User Guide
28
Set up your XBee Gateway Joining ZigBee networks
initialized, the coordinator and routers can allow other devices (other routers or end devices) to join
the network and route data.
Each network is defined with a unique PAN identifier (PAN ID). This identifier is common among all
devices of the same network. That is, devices on the same ZigBee network must share the same PAN
ID in order to communicate with each other. When you power on a coordinator, it automatically
establishes the PAN ID or uses a pre-configured one when it creates the new network.
n If the PANID of the coordinator is 0, it performs a PAN scan to identify nearby ZigBee networks
and uses a random unused PAN ID to start the new network. By default, an XBee Gateway
coordinator is configured to generate a random PAN ID.
n If the PANID for a router or end device is 0, it performs a PAN scan and tries to join any
available ZigBee network it finds.
You can connect to an XBee ZigBee module that is configured as a router node to the network
initialized by XBee Gateway. By default, the PAN ID of this ZigBee module is configured to 0. Therefore,
if you power on the XBee ZigBee module and there is no other ZigBee network around, the module
joins the ZigBee network initialized by XBee Gateway automatically. The joining operation occurs
when the Association LED of the board on which the XBee ZigBee module is mounted starts blinking.
The 802.15.4 PHY (physical layer) protocol description defines 16 operating channels in the 2.4 GHz
frequency band. Before starting the network, the coordinator automatically performs a channel scan
to select a good channel to use for the network.
You can configure all the ZigBee nodes in a network with the channel or channels on which they
operate.
Join XBee Gateway to an existing ZigBee network
Although this is not a common task, you can configure your XBee Gateway device to operate as a
router and join an existing ZigBee network.
To join XBee Gateway to an existing ZigBee network:
1. Open a web browser and type the URL of XBee Gateway: http://192.168.100.1. The XBee
Gateway web interface appears.
2. Log in to the web interface:
n User name: The default user name is python. If that user name does not work, it may
have been changed by your system administrator. Contact your system administrator
for help.
n Password: The unique, default password is printed on the device label. If the password
is not on the device label, the default password is dbps. If these defaults do not work,
the password may have been updated. Contact your system administrator for help.
3. Click XBee Network in the left menu.
4. Select the XBee Gateway ZigBee local XBee device. The XBeeConfiguration page appears.
5. From the XBee Configuration page, click Network Settings.
XBee Gateway User Guide
29
Set up your XBee Gateway Joining ZigBee networks
6. Configure the Extended PAN ID (ID) option with the PAN ID of the network to which XBee
Gateway should join.
7. Clear the Coordinator Enable(CE) check box. This allows XBee Gateway to behave as a router
node within the ZigBee network.
8. Click Apply to save the changes to the device. After you apply the changes, XBee Gateway
behaves as a router node and tries to connect to the ZigBee network with the PAN ID that you
configured.
To join your XBee ZigBee module from the kit to an existing network, follow the steps described in
Configure XBee Gateway with a custom PAN ID.
Configure XBee Gateway with a custom PAN ID
In some cases, you want control of the PAN ID used to create your ZigBee network. Use a custom
PANIDand configure the coordinator, routers, and end devices to use it when there are other
networks around and you do not want your router or end device nodes to join them.
To configure XBee Gateway with a custom PANID:
1. Open a web browser and type the URL of XBee Gateway: http://192.168.100.1. The XBee
Gateway web interface appears.
XBee Gateway User Guide
30
Loading...