Digi XBee Gateway User Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Gateway
  5. XBee
  6. User manual

Digi XBee Gateway User Manual

Hide thumbs Also See for XBee Gateway:
Table of Contents

Advertisement

Quick Links

Download this manual See also: User Manual, Manual
XBee® Gateway
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee Gateway and is the answer not in the manual?

Questions and answers

Related Manuals for Digi XBee Gateway

Summary of Contents for Digi XBee Gateway

  • Page 1 XBee® Gateway User Guide...
  • Page 2 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.
  • Page 3 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.

  • Page 4: Table Of Contents

    Programming interface applications Product differences from predecessor ConnectPort® X products Where to find more information Get started Set up the XBee Gateway Cellular hardware Verify your components Connect the cellular hardware Connect XBee Gateway to the network Set up the XBee Gateway Wi-Fi hardware...
  • Page 5 Certificate Management page in the web interface Back up or restore the configuration Back up and restore files from Remote Manager Back up and restore files from the XBee Gateway web interface Update firmware Update firmware from Remote Manager Update firmware from the XBee Gateway web interface...
  • Page 6 User name and password for the Linux command shell Connect and log in to the XBee Gateway device Log in to XBee Gateway through the Digi ESP for Python command line interface Configure XBee Gateway Configure settings from Remote Manager...
  • Page 7 Update the XBee node firmware (OTA updates) from the web interface XBee Gateway network Python log file XBee network troubleshooting resources Learn more about XBee Gateway Default startup and operation behaviors for XBee Gateway Default behavior regarding NTP time server access Default behavior regarding DNS Firewalls and required open ports...
  • Page 8 Example digital or analog I/O configuration Configure the digital or analog I/O View your device data View device data from Remote Manager View device data and events in the Python log file for XBee Gateway Hardware Ethernet and Wi-Fi hardware Cellular hardware...

  • Page 9: About Digi Xbee Gateway

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

  • Page 10: Regulatory Information And Certifications

    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.

  • Page 11: Declaration Of Conformity (Doc)

    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.

  • Page 12: Industry Canada (Ic) Certifications

    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.

  • Page 13: Warnings For Use Of Wireless Devices

    About Digi XBee Gateway Safety statements Never install electrical wiring during an electrical storm. Never install an Ethernet connection in wet locations unless that connector is specifically designed for wet locations. Use caution when installing or modifying lines. Use a screwdriver and other tools with insulated handles.

  • Page 14: International Emc (Electromagnetic Emissions/Immunity/Safety) Standards

    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 EN 301 489-17 V2.1.1:2009...

  • Page 15: Xbee Gateway: Cellular

    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.

  • Page 16: Hardware Interfaces

    RF Gateway and Python remote device management solutions 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.

  • Page 17: Rf Gateway And Python Remote Device Management Solutions

    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.

  • Page 18: Product Differences From Predecessor Connectport® X Products

    Digi-proprietary embedded operating system. 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.

  • Page 19: Where To Find More Information

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

  • Page 20: Get Started

    Set up the XBee Gateway Cellular hardware 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...
  • Page 21 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.

  • Page 22: Connect The Cellular Hardware

    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.

  • Page 23: Connect Xbee Gateway To The Network

    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.

  • Page 24: Verify Your Components

    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.

  • Page 25: Connect The Wi-Fi Hardware

    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.

  • Page 26: Connect Xbee Gateway To The Network

    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...
  • Page 27 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.

  • Page 28: Set Up Your Xbee Gateway

    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.

  • Page 29: Joining Zigbee Networks

    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.

  • Page 30: Join Xbee Gateway To An Existing Zigbee Network

    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.

  • Page 31: Configure Xbee Gateway With A Custom Pan Id

    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.

  • Page 32: Xbee Gateway And Non-Xbee Zigbee Devices

    Contact your system administrator for help. 3. Under Configuration, click XBee Network. 4. Select the XBee Gateway local XBee device that you want to configure. The XBee Configuration page appears. 5. From the XBee Configuration page, click Network Settings.

  • Page 33: Administration And Maintenance Tasks

    XBee Gateway and display current information about loaded files. You can also use this page to download system log files from XBee Gateway to view for troubleshooting or other purposes. These log files are in the /WEB/logging folder. For a description of...

  • Page 34: File Management Page In The Xbee Gateway Web Interface

    File Management page in the XBee Gateway web interface You can use the File Management page to load files onto XBee Gateway and display current information about loaded files. For a description of the XBee Gateway file system layout, see...

  • Page 35: Certificate Management

    Volume Information section: Displays the current directory for loading files and free space remaining. Note Digi recommends using no more than 20 MB for custom applications, as XBee Gateway requires a portion of the same space to be capable of managing persistent system logs and firmware updates.

  • Page 36: Back Up Or Restore The Configuration

    Refresh button: Refreshes the list of certificates. Activate button: Activates the loaded certificates. Back up or restore the configuration After you configure XBee Gateway device, back up the configuration settings. You can back up the settings from the Remote Manager or the interface.

  • Page 37: Back Up And Restore Files From The Xbee Gateway Web Interface

    3. In the Volume Information section, review the amount of free space available. 4. If you want to save the configuration settings for the XBee RF module along with the device configuration settings, select the Include XBee gateway radio settings in the backup file option.

  • Page 38: Update Firmware

    XBee RF modules on your local network to be delivered Over the Air (OTA): As XBee networks can involve a large number of nodes, Digi provides a way to schedule automatic XBee Gateway firmware updates and manage firmware files. In the XBee Gateway web interface, OTA firmware updates are performed from a page linked from the XBee Configuration page.
  • Page 39 6. Type or browse to the .ebl filename containing the firmware update. 7. Click Update Firmware. The XBee Gateway firmware is updated. If the gateway is enabled, most XBee Gateway module settings will be preserved when the firmware update completes. Some settings, such as encryption keys, may not be preserved and must be entered again.

  • Page 40: Update Firmware From The Xbee Gateway Web Interface

    The web browser uploads the firmware file. b. The firmware update is applied to the XBee Gateway operating system. If the firmware update is successful, the message Firmware Upgrades Completed Successfully appears. If errors occur during the update, the message Completed with errors appears.

  • Page 41: About Firmware Files

    Firmware Updates option. You can select the product and then download the firmware. There is only one firmware file for the XBee RF module in XBee Gateway products. It is named XBP24- S2C_40XX.ebl, where XX is the firmware version.

  • Page 42: Display The Mobile Device Status

    1. Click the Device Management tab. 2. From the device list, double-click the device to display the device properties menu. 3. Select System Information > Mobile Information. The Mobile Information page appears. From the XBee Gateway web interface Access and log into the web interface.
  • Page 43 SIM PUK, SIM PIN2, SIM PUK2, and similar codes: The SIM is locked and cannot be unlocked by the XBee Gateway cellular device. It must be placed in another device or phone to be unlocked. Error: Either the SIM was not inserted or there was another SIM problem.
  • Page 44 0: No signal 1: Poor signal 2: Adequate signal 3: Good signal An indicator of the quality of the received cellular signal, Signal quality Both measured in dB. This value is also known as Ec/Io. XBee Gateway User Guide...
  • Page 45 The radio frequency band used by the modem. GSM can Band GSM 2G use one of the following bands: service only GSM 850 GSM 900 DCS 1800 PCS 1900 Future modems may have different values. XBee Gateway User Guide...
  • Page 46 Future cellular modems may have other values. Channel Both Radio channel being used by the cellular modem. The current set of mobile configuration settings used to Profile Both configure the cellular modem. XBee Gateway cellular products always use profile 0. XBee Gateway User Guide...
  • Page 47 (GSM only). No device found: The modem is not available or is malfunctioning. Connection duration Both Amount of time the current mobile data connection has been active. The format is N days HH:MM:SS. XBee Gateway User Guide...
  • Page 48 Connection timeout: Connection did not complete. Device reset error: The modem could not be reset. Device open error: The modem is malfunctioning. Device config error: The modem could not be configured. PPP error: Internal system error. XBee Gateway User Guide...
  • Page 49 This server resolves domain names to IP addresses. Default behavior regarding DNS for more information on how XBee Gateway uses the DNS primary and secondary address. DNS secondary address Both IP address of the backup DNS server assigned by the mobile carrier.

  • Page 50: Change The Password For The Web Interface

    Status field modem type Connection errors Both The number of unsuccessful mobile data connection attempts since the XBee Gateway cellular device was started. Carrier loss Both The number of times the connection was lost because of poor signal or being disconnected by the network.
  • Page 51 5. In the Confirm Password field, re-enter the new password. 6. Click Apply. RCI from the Linux command shell Connect and log in to the XBee Gateway device. 2. Type the following, replacing NEW_PASSWORD with the new password you wish to use and CURRENT_PASSWORD with your existing password: rci_request '<do_command target="set_...

  • Page 52: Display The Xbee Gateway End User License Agreement (Eula)

    CURRENT_PASSWORD is the existing password. 4. Click Send. Display the XBee Gateway End User License Agreement (EULA) You can access the End User License Agreement (EULA) for XBee Gateway from the web interface. Note The XBee Gateway EULA is not available through Remote Manager.

  • Page 53: Restore Xbee Gateway Factory Defaults

    This feature is assigned to the button by default. On the XBee Gateway device, press and hold the button for ten seconds to return the device settings to factory defaults.

  • Page 54: About Programming

    About programming 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. This section introduces the Digi programming tools and resources available to you. You can also see...

  • Page 55: Xbee Zigbee Cloud Kit Web Application Source Code

    For more information, see software. Linux command shell: The Linux command shell interface that is available on XBee Gateway is useful for some programming and device management tasks. With the Linux command shell, you can experiment with the Python interpreter interactively, create scripts, launch scripts, and control the script operation.

  • Page 56: Load Applications Onto Xbee Gateway

    About programming Load applications onto XBee Gateway Load applications onto XBee Gateway To load an application onto XBee Gateway, use the File Management function in Remote Manager or the XBee Gateway web interface. For instructions, see File management. XBee Gateway User Guide...

  • Page 57: Program Xbee Gateway Using Python

    Program XBee Gateway using Python XBee Gateway features a standard Python 2.7.1 distribution, allowing you to develop and test applications that are not dependent on Digi-proprietary interface modules. Python is a dynamic, object-oriented language for developing software applications, from simple programs to complex embedded applications.

  • Page 58: Find Python Learning Resources

    A collection of utility methods for programming the XBee RF module on XBee Gateway. It also includes the Python XBee socket interface support. digisms: For low-level, generic SMS message handling.

  • Page 59: Button Handling

    7. If the system reads a non-zero value, the button is currently pressed. LED control Controlling the LEDs on XBee Gateway is handled through the user_led_set function. This sample program controls the Network LED. Note that if native features are still assigned to the LED, those behaviors will mix with the behaviors in the sample program.

  • Page 60: Watchdog

    Program XBee Gateway using Python Sample programs import digihw import time while True:          digihw.user_led_set(True,1)          time.sleep(1.0)         digihw.user_led_set(False,1)         digihw.user_led_set(True, 2)         time.sleep(1.0)         digihw.user_led_set(False,2) Program notes 1. The digihw module includes the user_led_set function needed by the program. The user_led_ set has two are two parameters: value and led. The user controlled LED is made to match the logic state of the “value”...

  • Page 61: Rci Callback

    Program XBee Gateway using Python Sample programs 3. Loop five times (1-5). 4. Indicate our iteration... 5..sleeping less than the timeout on each iteration, but more time than the timeout in total. 6. Reset the watchdog timer to 20 seconds each iteration, allowing all of the loops to complete.

  • Page 62: Xbee Functions

    Manual. XBee Gateway Python application and Remote Manager The XBee Gateway Python application is an application that resides on XBee Gateway. It allows you to connect your XBee modules to Remote Manager, enabling them to upload data to Remote Manager and receive remote text and commands.

  • Page 63: Xbee Gateway Python Application Requirements

    Remote Manager account section in the Digi Remote Manager User Guide. 2. Your XBee Gateway device must be registered in your Remote Manager account. Follow the instructions in the register a device section in the Digi Remote Manager User Guide.

  • Page 64: Key Features And Operations Of The Xbee Gateway Python Application

    Using the XBee Gateway Python application, you can automatically upload those values to Remote Manager, store them there, and retrieve the values later for use by other user applications.
  • Page 65 (XBIB). You will use the User Button 3 (SW3) of the XBIB to change the status of DIO1 as it is directly connected to the DIO1 of the module. 2. From a web browser, go to the Home page of your XBee Gateway interface.
  • Page 66 DIO Change Detect (IC) setting to 0x2. These settings configure DIO1 as input. Each time the value of DIO1 changes, the XBee device sends an XBee packet to XBee Gateway with the new value of the DIO. In addition, the XBee Gateway Python application uploads the new value to Remote Manager.
  • Page 67 There you will find the streams generated by any XBee node from your network that reported any data. The data streams follow this pattern: [device_id]/[source]/[xbee_mac]{/[dio_number]} Where: [device_id] Is the ID of your XBee Gateway. [source] Is the source of the data. Legal values are: xbee.digitalIn xbee.analog xbee.serialIn...

  • Page 68: Receive Serial Data From Remote Manager

    XBee node to the microcontroller to which it is attached. The XBee Gateway Python application allows sending a serial data packet through Remote Manager, using the Web Services API, to a specific XBee module or all XBee modules in the network that will be transmitted through its serial interface.
  • Page 69 Program XBee Gateway using Python XBee Gateway Python application and Remote Manager send_serial command definition The send_serial command sends serial data to a specific XBee node in your network. To use this command, add it to an SCI request inside the RCI do_command element.
  • Page 70 The command body contains the data to be transmitted to the specified XBee node of the network. The command body content depends on the value of the encoding attribute: base64: The command body value must be encoded in base64. The XBee Gateway Python application will receive the encoded content but, prior to transmission to the corresponding XBee node, the application will decode the command body to its original content and that will be transmitted.
  • Page 71 XBee node of our network corresponding to the MAC address 00:11:22:33:44:55:65:77. Note The request is using a dummy device ID and XBee MAC address. You will need to use your own XBee Gateway device ID and XBee MAC address if you want to test this example. <sci_request version="1.0">   <send_message>...
  • Page 72                </responses>             </do_command>          </rci_reply>        </device>     </send_message> </sci_reply> The error element contains an id attribute indicating the error identifier. For more information regarding the possible XBee Gateway Python application error identifiers, see XBee Gateway Python application command errors. XBee Gateway User Guide...
  • Page 73 Program XBee Gateway using Python XBee Gateway Python application and Remote Manager The desc element displays the meaning of the error identifier, and the hint element provides an explanation of what caused the received error. Example: Sending text to an XBee node through Remote Manager The following example assumes the microcontroller attached to the XBee device is a computer.
  • Page 74                         encoding="base64">SGVsbG8sIFdvcmxkIQ== </send_serial>          </do_command>      </rci_request>   </send_message> </sci_request> Where: {device_id} is the ID of your XBee Gateway device. {xbee_mac} is the MAC address of the XBee node that you attached to your computer. For example: <sci_request version="1.0">     <send_message>         <targets>             <device id="00000000-00000000-00409dff-ff5c3BBd"/>        </targets>...

  • Page 75: Store Serial Data In Remote Manager

    End-user applications can retrieve the serial data from Remote Manager later to perform some tasks. Whenever an XBee module on the network sends any kind of serial data to XBee Gateway, the XBee Gateway Python application automatically processes the frame containing the serial data and uploads it to Remote Manager, thereby generating a data stream.
  • Page 76 Remote Manager at the moment. The XBee Gateway Python application has a configuration file containing the settings of the application. One of those settings is the encoding of the serial data prior to store it in Remote Manager.
  • Page 77 The following example assumes the microcontroller attached to the XBee device is a computer. To send a serial data package from an XBee node on your network to XBee Gateway and verify that it has been automatically uploaded to Remote Manager: 1.

  • Page 78: Manage Xbee Dio Lines Though Remote Manager

    Manage XBee DIO lines though Remote Manager The XBee Gateway Python application allows you to remotely manage the DIO lines of any of the XBee nodes on your network through Remote Manager. Use this application feature to turn on/off different actuators.
  • Page 79 Program XBee Gateway using Python XBee Gateway Python application and Remote Manager To set the value of a DIO pin of one XBee node on your network through Remote Manager, you need to use the Remote Manager Web Services API.
  • Page 80 Program XBee Gateway using Python XBee Gateway Python application and Remote Manager The set_digital_output command must follow this syntax: <set_digital_output addr=”address” index=”index”>value</set_digital_output> Command attributes addr Usage: Required. Description: This attribute indicates the destination address of the node to which the content indicated by the command body should be transmitted.
  • Page 81 <set_digital_output addr="00:13:a2:00:40:9f:6f:cb" index="4">1</set_digital_output>             </do_command>         </rci_request>     </send_message> </sci_request> Note This example request uses a dummy device ID and XBee MAC address. You must use your own XBee Gateway device ID and XBee MAC address to test this example. XBee Gateway User Guide...
  • Page 82                     </responses>                 </do_command>             </rci_reply>         </device>     </send_message> </sci_reply> The error element contains an id attribute indicating the error identifier. For more information regarding the possible XBee Gateway Python application error identifiers, see XBee Gateway Python application command errors. XBee Gateway User Guide...
  • Page 83 User LED 4 (DS4) of the board by modifying the value of the DIO4 of the XBee node because they are connected each other. 2. From a web browser, go to the Home page of your XBee Gateway interface.
  • Page 84 <set_digital_output addr="{xbee_mac}" name="DIO4">low</set_ digital_output>          </do_command>      </rci_request>   </send_message> </sci_request> Where: {device_id} is the ID of your XBee Gateway device. {xbee_mac} is the MAC address of the XBee node that you attached to your computer. For example: <sci_request version="1.0">     <send_message>         <targets>             <device id="00000000-00000000-00409dff-ff5c3BBd"/>...

  • Page 85: Xbee Gateway Python Application Configuration File

    XBee Gateway Python application configuration file You can configure some of the XBee Gateway Python application features using a configuration file. This configuration file is placed at the same level as the application itself within the file system and its content is written in JSON format.

  • Page 86: Xbee Gateway Python Application Command Errors

    Unexpected/unclassified error Configure a Python application in the web interface The web interface of the XBee Gateway device includes a section that allows you to configure and manage the Python processes or applications running in the device. XBee Gateway User Guide...

  • Page 87: Digi Esp For Python

    Python or DIA samples wizard. To access the program samples in Digi ESP: 1. From Digi ESP, go to File > New > Digi Python Application Sample Project or File > New > DIA Sample Project. The sample wizard for Python or DIA appears.

  • Page 88: Install The Digi Esp For Python Development Environment

    ESP for Python on a Windows operating system. If you are using a MAC operator system, click the Digi ESP for Python - MAC OS X (10.6) installer link. 4. Once the Digi ESP for Python framework has been downloaded, run the Digi ESP for Python framework installation wizard.
  • Page 89 Program XBee Gateway using Python Digi ESP for Python 6. The first time you run Digi ESP for Python, the Workbench displays. Before the Workbench displays, the Welcome page displays for just a moment, and then displays along the right side of the Workbench screen. Most of the time, the Welcome page is minimized.
  • Page 90 Select Help > Welcome from the main menu. The Welcome page appears. b. In the Welcome tab, click the Overview icon. The Overview page appears. c. On the overview page, click Getting Started. The Digi ESP for Python Getting Started Guide is displayed in the Help - Digi ESP for Python window.

  • Page 91: Dia Software

    A shell is a program that takes commands from the keyboard and gives them to the operating system to perform. On XBee Gateway, a program called ash acts as the shell program. You can use this shell in several useful instances, particularly in managing files, executing Python programs, and programming and executing commands to the XBee RF module in the gateway.

  • Page 92: Log In To Xbee Gateway Through The Digi Esp For Python Command Line Interface

    Log in to XBee Gateway through the Digi ESP for Python command line interface Within Digi ESP for Python, there is a separate login on the Device Manager LAN Connection tab in Digi ESP for Python. 1. Access Digi ESP for Python.
  • Page 93 Program XBee Gateway using Python Linux command shell (command line interface) XBee Gateway User Guide...

  • Page 94: Configure Xbee Gateway

    After you configure XBee Gateway device, back up the configuration settings. See Back up or restore the configuration for more information. XBee Gateway uses the following configurable settings to start up the XBee Gateway device and initiate communication. Configure settings from Remote Manager Configure settings from the XBee Gateway web interface...

  • Page 95: Configure Settings From Remote Manager

    File Management page in Remote Manager Advanced configuration settings You can access advanced configuration settings for XBee Gateway by double-clicking on a device in the device list to display the Properties page, and then selecting Advanced Configuration. The settings available in this menu vary by model. Some of the settings are:...

  • Page 96: Configure Settings From The Xbee Gateway Web Interface

    The XBee Gateway web interface allows you to configure critical network configuration settings and other features. If you already know the IP address for the XBee Gateway device, you can open a web browser and type the IP address in the address bar to open the XBee Gateway web interface. If you do not know the IP address for the XBee Gateway device, you can use the Digi Device Discovery utility...

  • Page 97: Home Page

    Configure XBee Gateway Configure settings from the XBee Gateway web interface 7. Double-click the device to open the XBee Gateway web interface, or select the device and click Open web interface under Device tasks in the Digi Device Discovery window.

  • Page 98: Ethernet Ip Network Settings

    If you disable DHCP, you must set all of these IP address settings yourself. In the absence of a DHCP server, you need to assign a static IP address using the Digi Device Discovery Utility and changing the network settings through the interface.

  • Page 99: Configure Ethernet Settings

    Subnet Mask: The subnet mask assigned to the device. The subnet mask is combined with the IP address to determine which network this Digi device is part of. Default Gateway: The IP address of the computer that enables this Digi device to access other networks, such as the Internet.
  • Page 100 IP address. You must enable either the DCHP or the Static IP option. DHCP: Select On to enable DHCP to assign an IP address to the gateway. XBee Gateway uses a DHCP server to obtain its IP address information, by default. A DHCP server needs to provide an IP address, subnet mask, default gateway, and Domain Name System (DNS) server for the device.

  • Page 101: Wireless (Wi-Fi) Network Settings

    Wi-Fi wizard to connect to a Wi-Fi network. If you want to connect to another Wi-Fi network than the one to which XBee Gateway is currently connected, you must run the Wi-Fi Wizard again.
  • Page 102 Subnet Mask: The subnet mask assigned to the device. The subnet mask is combined with the IP address to determine which network this Digi device is part of. Default Gateway: The IP address of the computer that enables this Digi device to access other networks, such as the Internet.
  • Page 103 The wizard provides a place to copy in the information required for to the connect to your local Wi-Fi network. In this instance, XBee Gateway is a Wi-Fi “client” connecting to an existing access point. Obtain the wireless network information that XBee Gateway will use from the network administrator and enter this information in the wizard.

  • Page 104: Mobile Connectivity Settings

    XBee Gateway is capable of using up to three DNS servers. Up to two of these slots may be filled with DNS servers from dynamic IP assignment sources, leaving at least one slot always available for static DNS server configuration.

  • Page 105: Set Up And Configure Gsm-Based Devices

    You must connect XBee Gateway to the cellular network. How you connect XBee Gateway to the cellular network depends on the type of cellular modem in the device. First-time activation of an XBee Gateway in a cellular network could take up to five minutes or longer.

  • Page 106: Provision A Cdma-Based Device

    Provision a CDMA-based device Provision your XBee Gateway cellular device with the required information used to access the cellular network. Typically, an automatic provisioning process is used to provision the device. For Verizon, that process is OTASP (Over the Air Service Programming). For Sprint, the process is OMA DM (Open Mobile Alliance Device Management.

  • Page 107: Configure Mobile Settings

    XBee Gateway cellular device. 2. Obtain an account with your cellular carrier and provide the carrier account representative the MEID of the device. The representative will create an account for the XBee Gateway cellular device based on the MEID.

  • Page 108: Mobile Connectivity Configuration Page

    Some values may be hidden, depending on your model. Complete the fields and click Save to save your changes. From the XBee Gateway web interface Access and log into the web interface. 2. Click Configuration > Mobile Connectivity. The Mobile Connectivity settings identify the service provider to use when connecting to the mobile network.

  • Page 109: Short Message Service (Sms)

    Enable cellular Short Message Service (SMS) services: Enables or disables SMS features on this Digi device. When this option is enabled, the you can configure the remaining SMS options. This option is enabled (on) by default. When you disable SMS services, all SMS-related menu...
  • Page 110 (or “text messages”) may have additional costs. Before using the SMS capabilities of your Digi device, verify with your mobile service provider that your agreement includes SMS as part of your service plan. Understand the costs of SMS before you enable the SMS features on this Digi device.
  • Page 111 SMS > SMS commands | Configure Properties > Advanced Configuration > Cellular SMS Enabled: This setting enables or disables all SMS features on this Digi device. When you enable this option, the remaining SMS options may be configured. This option is disabled (off) by default.

  • Page 112: Digi Mobile Surelink™ Settings

    2. From the device list, double-click the device to display the device properties menu. 3. Click SureLink. Complete the fields and then click Save to save your changes. From the XBee Gateway web interface Access and log into the web interface. 2. Click Configuration > SureLink.
  • Page 113 Link Failure Action The action to be performed when a link failure is detected: No action: No action is performed. Reset device: Reset the cellular modem in the XBee Gateway device. Reconnect interface: Reconnect the cellular interface. XBee Gateway User Guide...

  • Page 114: Link Integrity Test Options

    (or refuses) the TCP connection, the test fails. The primary and secondary addresses may be either IP addresses or fully qualified domain names. TCP Port: The TCP port number to connect to on the remote host. The default is 80. XBee Gateway User Guide...

  • Page 115: Dns Settings

    Primary DNS: The name of the primary DNS server. Secondary DNS: The second DNS server that is used if the primary DNS server fails to respond. Alternate DNS: A DNS server that is used if the primary or secondary DNS servers fail to respond. XBee Gateway User Guide...

  • Page 116: Mobile Firewall Settings

    Mobile firewall settings Mobile firewall settings You can configure a network firewall for the XBee Gateway mobile network interface in the firewall configuration page. This firewall reduces cellular traffic and cloaks the device, making it harder to find and reduces the risk of unauthorized access and attacks. While this firewall does not reduce the traffic sent to the device, it prevents the device from replying to it, because the firewall discards the packets sent to it, unless the packets are associated with an established communication (connection).

  • Page 117: Configure Python Settings

    Python settings The Python Configuration page displays the following Python settings: Enable: Enables or disables the associated Python command for this Digi device. When you select this check box, the associated Python program automatically starts on system startup. Command Line (with optional arguments): Type the name of the Python file, and any program arguments, required to start on system startup.

  • Page 118: Button Service Assignments Page

    This feature is assigned to the button by default. On the XBee Gateway device, press and hold the button for ten seconds to return the device settings to factory defaults.

  • Page 119: Use The Button To Enable Special-Purpose Wi-Fi Configuration Mode

    Each time you press the button, the time-limit window of access point mode operation is extended. If you do not assign this feature to the button on the XBee Gateway device, a Wi-Fi configuration access point mode will not be available.

  • Page 120: Use The Button To Enable The Web Interface

    You want to change the instance of Remote Manager to which XBee Gateway is connected. See Connect to a different instance of Remote Manager. XBee Gateway operates in a network with firewalls. In this case, you will need to configure a proxy server. See Configure a proxy server.

  • Page 121: Configure Connectivity Settings

    Let my XBee Gateway connect to Device Cloud (web interface): Enables or disables the connection from XBee Gateway to the Remote Manager server. Disable this feature if you have no use for Remote Manager, and want to eliminate any Remote Manager-related network traffic.

  • Page 122: Advanced Connectivity Settings

    The default settings for Remote Manager usually work for most situations. The Advanced settings configure the idle timeout for the connection between XBee Gateway and Remote Manager, and the keep-alive settings of the various interfaces (TCP and HTTP for mobile and Ethernet network connections).
  • Page 123 Keep-alives for the Remote Manager connection serve three basic purposes: 1. Keep the Remote Manager connection alive through network infrastructure such as routers, NATs and firewalls. 2. Inform the other (remote) side of the Remote Manager connection that its peer is still active. XBee Gateway User Guide...

  • Page 124: Advanced Connectivity Settings For The Web Interface

    The default settings for Remote Manager usually work for most situations. The Advanced settings configure the idle timeout for the connection between XBee Gateway and Remote Manager, and the keep-alive settings of the various interfaces (TCP and HTTP for mobile and Ethernet network connections).
  • Page 125 TCP keepalives are enabled and transferred needlessly between device and server. Enable protocol compression: Configures whether RCI command and response text is compressed, when both are passed between the Digi device and the Remote Manager server. This compression primarily affects the size of the data passed when settings or state information are formatted as RCI and conveyed between device and server.
  • Page 126 Enable TCP keep-alive: Enables or disables the ability to send TCP keep-alive packets over the client-initiated connection to the Remote Manager server, and whether the device waits before dropping the connection. The default is enabled. XBee Gateway User Guide...

  • Page 127: Device Cloud Client Initiated Connection Page

    Remote Manager. Device Cloud client initiated connection page You can use the settings on this page to enable Remote Manager and specify reconnect timeout settings. Connection enable XBee Gateway User Guide...

  • Page 128: Device Cloud Configuration Page

    The Proxy server address works in conjunction with the Proxy server TCP port field. These settings configure XBee Gateway to connect to Remote Manager using HTTP over proxy. You can create a path to a Remote Manager server through a local HTTP proxy, such as squid, provided that you use the server to simply remap the target IP address and port number, without extra authentication or other security measures.

  • Page 129: Device Cloud Network Type Page

    Keep-alives for the Remote Manager connection serve three basic purposes: 1. Keep the Remote Manager connection alive through network infrastructure such as routers, NATs and firewalls. 2. Inform the other (remote) side of the Remote Manager connection that its peer is still active. XBee Gateway User Guide...

  • Page 130: Connect To A Different Instance Of Remote Manager

    Connect to a different instance of Remote Manager To connect to a different instance of a Remote Manager: Access the XBee Gateway web interface. 2. Click Configuration > Device Cloud Connectivity. 3.  On the Remote Manager Configuration page, in the Device Cloud Server setting, select Other..

  • Page 131: Network Services Settings

    You can use the Network Services settings to enable or disable common network services that are available on XBee Gateway, and configure the network port on which the service is listening. You can also disable certain services so the device runs only those services specifically needed and to improve device security.
  • Page 132 Secure Shell Server (SSH) allows users secure access to sign in to Shell Server (SSH) the Digi device and access the command-line interface. Essentially, pulling content from the XBee Gateway web interface. Enable Web Server HyperText Transfer Protocol (HTTP), also known as Web Server, (HTTP) provides access to web pages for configuration and web services.

  • Page 133: Gps Static Position Settings

    Secondary DNS: The second DNS server to used if the primary DNS fails to respond. GPS static position settings You can use the settings in the GPS status position page to configure GPS support for XBee Gateway. Configure GPS Static Position settings To configure GPS Static Position settings, choose one of the following options:...

  • Page 134: Gps Static Position Page

    NTP server when accurate long-term time is required. Most users do not need to change the time server setting. If the Digi device is already connected to Remote Manager, you can adjust the time server configuration from Remote Manager.

  • Page 135: Time Server Configuration Page

    NTP Server 1|2|3|4: These settings configure the various Network Time Protocol (NTP) servers that XBee Gateway uses to obtain current date and time. For XBee Gateway Ethernet and Wi-Fi models, you can specify up to four NTP server settings to be used as upstream servers in synchronizing time.
  • Page 136 NTP Server 1|2|3|4: These settings configure the various Network Time Protocol (NTP) servers that XBee Gateway uses to obtain current date and time. For XBee Gateway Ethernet and Wi-Fi models, you can specify up to four NTP server settings to be used as upstream servers in synchronizing time.

  • Page 137: Configure Xbee Network Settings

    Configure XBee network settings XBee Gateway provides a gateway between Internet Protocol (IP) network devices and a network of ZigBee wireless devices (which includes Digi XBee modules). Typically, these wireless devices are small sensors and controllers. Remote nodes in an XBee network can include other XBee ZigBee nodes.

  • Page 138: Configure Xbee Network Settings In The Web Interface

    Configure XBee network settings in the web interface Configure XBee network settings in the web interface The XBee Configuration page in the XBee Gateway web interface allows you to configure each of the XBee devices joined to your network. Access and log into the web interface.

  • Page 139: Device Details Page

    Configure XBee network settings Configure XBee network settings in the web interface To display more information on the XBee RF module on XBee Gateway, click the Node ID, Network Address, or Extended Address field. The Device Details page appears. See Device Details page more information.
  • Page 140 The resulting backup file is a .pro file that is compatible with the XCTU configuration tool. This means that you can save or load backup files from the XBee RF module using XCTU as well as the gateway’s command line or web interfaces. XBee Gateway User Guide...

  • Page 141: Xbee Network Ota Firmware Updates

    XBee network OTA firmware updates The XBee Gateway firmware supports an OTA (Over the Air) firmware update in the XBee network nodes. As XBee networks can involve a large number of nodes, Digi provides a way to automatically schedule XBee Gateway firmware updates and manage firmware files.

  • Page 142: Update The Xbee Node Firmware (Ota Updates) From The Web Interface

    Note The XBee network cannot access a remote node while the remote node is updating its firmware. XBee Gateway cannot access the XBee module while the XBee module is updating its firmware. Note that you can also schedule and monitor updates of individual nodes on the OTA Firmware Update Status page.
  • Page 143 Upload Files section This section controls the upload XBee Gateway firmware files to the gateway. These files contain the firmware image used to update nodes on the XBee network. You can upload multiple files, where each contains a different firmware type and version. Firmware files must end with an .ebl extension. Click Browse to select a firmware file and then click Upload.

  • Page 144: Xbee Gateway Network Python Log File

    XBee Gateway network Python log file When you connect XBee node devices with your XBee Gateway using the XBee Gateway Python application, device data for your XBee network is captured in the form of events in one of the log files, python.log, for XBee Gateway.

  • Page 145: Learn More About Xbee Gateway

    This section walks you through the steps required to connect your XBee Gateway with XBee hardware other than that in the XBee ZigBee Cloud Kit. The steps show you how to configure XBee Gateway and XBee nodes, explore the use of data I/O in your network solution, and view data from nodes.

  • Page 146: Firewalls And Required Open Ports

    XBee Gateway is capable of using up to three DNS servers. Up to two of these slots may be filled with DNS servers from dynamic IP assignment sources, leaving at least one slot always available for static DNS server configuration.

  • Page 147: Join Nodes To The Coordinator

    Use XCTU to set PAN ID and encryption settings to match those on the coordinator (XBee Gateway). Next, configure your ZigBee nodes to connect to XBee Gateway. To do this, you will set the PAN ID for the ZigBee nodes to match the PAN ID you just set in XBee Gateway. Because the ZigBee are not yet joined to the network that your XBee Gateway (coordinator) initialized, you cannot configure them using the XBee Gateway web interface.

  • Page 148: Verify That Xbee Nodes Are Joined To The Coordinator

    To verify that your XBee ZigBee module has successfully joined the ZigBee network: 1. Make sure XBee Gateway is powered on. Make sure the XBee ZigBee node is mounted on the development board and that the development board is powered on.

  • Page 149: Configure The Zigbee Network Addressing Parameters For Xbee Nodes

    XBee RF modules have many parameters. In many cases, the default setting for a parameter is sufficient. For successful transmission of data from XBee nodes and use with the XBee Gateway Python application, there are several key addressing parameters that must be set on XBee nodes: Destination Address (DH/DL): These parameters set the high and low portions of the destination address for data.

  • Page 150: Configure The Network Addressing Parameters

    2. Understand what must be configured for the XBee module on the XBee nodes and attached hardware to work with the XBee Gateway Python application. XBee RF modules have many parameters. In many cases, the default setting for a parameter is sufficient.

  • Page 151: Example Serial I/O Configuration

    Learn more about XBee Gateway Explore serial I/O Example serial I/O configuration The following example demonstrates the serial I/O configuration process, between an XBee RF module and connected device. Serial data input uses pin 3 (DIN). serial data output uses pin 2 (DOUT).

  • Page 152: Explore Digital And Analog I/O

    ZigBee network to transmit digital or analog I/O. If you are unfamiliar with I/O configuration, the following resources will help you understand key concepts: Digi knowledge base article: Digital and analog sampling using XBee radios Building Wireless Sensor Networks by Rob Faludi...

  • Page 153: Example Digital Or Analog I/O Configuration

    2. Understand what must be configured for the XBee module on the XBee nodes and attached hardware to work with the XBee Gateway Python application. The XBee Gateway Python application resides on XBee Gateway. It allows you to connect your XBee modules to Remote Manager, enabling them to upload data to Remote Manager and receive remote text and commands.

  • Page 154: Configure The Digital Or Analog I/O

    Learn more about XBee Gateway Explore digital and analog I/O Digital I/O: The following pins are used for digital I/O: Digital data input from the connected device uses Pin 19 (AD1 / DIO1). This digital input uses the pullup resistor and change detection sampling.
  • Page 155 Learn more about XBee Gateway Explore digital and analog I/O 4. Click Input/Output Settings. The I/O Settings table displays the DIO settings for the pins on the XBee node. The fields in the I/O Settings table are as follows: DIO: Digital input/output.

  • Page 156: View Your Device Data

    Set this parameter to 0x2 to use. Each time the value of the specified DIO changes, the XBee module sends an XBee packet with the new value of the DIO to XBee Gateway. Another way to enable the IC parameter is to enable the Detect check box for a DIO set to digital input.

  • Page 157: View Device Data From Remote Manager

    XBee ZigBee will be similar to: 00000000-00000000-00409DFF-FF123456/xbee.digitalIn/ [00:13:A2:00:11:22:33:44]!/DIO4 2. Type the device ID for your XBee Gateway in the data stream search box in the upper-right side of the data stream view to locate the data streams for your XBee Gateway. For example: 00000000-00000000-00409DFF-FF123456 View device data and events in the Python log file for XBee Gateway The XBee Gateway Python application resides on XBee Gateway.
  • Page 158 Learn more about XBee Gateway View your device data System message Python log file example The following example shows a python.log file for an XBee Gateway with an XBee node configured for digital and analog I/O: In this log file excerpt: These lines show that the XBee Gateway Python application has started up successfully: 4 19:44:06 (none) local7.info pylog: 2014-08-04 19:44:06,804 INFO...
  • Page 159 Learn more about XBee Gateway View your device data These lines show that the XBee Gateway Python application received an analog I/O reading: 4 19:47:38 (none) local7.info pylog: 2014-08-04 19:47:38,610 DEBUG xbgw.xbee.manager: Processing IO sample from pin AD3 4 19:47:38 (none) local7.info pylog: 2014-08-04 19:47:38,620 DEBUG xbgw.xbee.manager: Analog data: 780...
  • Page 160 Learn more about XBee Gateway View your device data These lines show that data points, in this case, six data points, were uploaded to Remote Manager: 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,207 INFO xbgw.reporting.device_cloud: Uploading data to DataPoint/upload.csv 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,220 DEBUG xbgw.reporting.device_cloud: stream_id: xbee.analog/...
  • Page 161 Learn more about XBee Gateway View your device data xbgw.reporting.device_cloud: Upload contains 6 datapoints 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,526 INFO xbgw.reporting.device_cloud: Upload successful XBee Gateway User Guide...

  • Page 162: Hardware

    Hardware This section provides hardware information for XBee Gateway. For hardware specifications, refer to the XBee Gateway data sheet. Ethernet and Wi-Fi hardware Item Description More information Connect the power supply to the gateway. See Power supply Connect the Wi-Fi hardware.

  • Page 163: Cellular Hardware

    Ethernet cable to your gateway and the other to a live Ethernet jack. See Connect the cellular hardware. See Antennas. Antennas (internal) Set up and configure GSM-based devices. SIM card installation XBee Gateway User Guide...

  • Page 164: Antennas

    Digi device on the roof of the building, in an environmentally safe enclosure with proper moisture and lightning protection. XBee Gateway button You can configure the button on XBee Gateway to perform a number of actions. You can configure the button in Remote Manager. Restore XBee Gateway factory defaults...

  • Page 165: Xbee Gateway Leds Descriptions

    See Button handling program sample details. XBee Gateway LEDs descriptions XBee Gateway has several LEDs. See the sections below for a description of the LEDs and their default behavior. Power LED XBee LED...

  • Page 166: Xbee Led

    ZigBee wireless network. At startup, if you are not yet deploying your device in a ZigBee network, you can ignore this LED and its states. Once XBee Gateway is deployed in a ZigBee network, the XBee LED behavior varies depending on whether XBee Gateway acts as a coordinator or a router. For...

  • Page 167: Signal Strength Led (Cellular Models Only)

    Remote Manager connectivity-related reasons for this fast (1 blink per state are: second) 1. XBee Gateway cannot connect to a DNS server to resolve the Remote Manager server address. See Cannot connect to DNS server to resolve the Remote Manager server address troubleshooting information.
  • Page 168 Hardware XBee Gateway LEDs descriptions Color and blink pattern Description Solid yellow Adequate cellular signal. This signal strength works for most applications. Solid green Good cellular signal. XBee Gateway User Guide...

  • Page 169: Troubleshoot Your Xbee Gateway

    Digi for analysis by Technical Support and Engineers. The event log cannot be turned off, so that Digi receives an accurate view of all aspects of the operation of the device.

  • Page 170: Display The System Log

    2. Click /WEB and go to the WEB/logging directory on the XBee Gateway system. 3. Select the log files (for example, digi.log, xbee.log, python.log, and so on) and then click the Download button to download the logs to your computer.

  • Page 171: Cellular Connection Issues

    Cellular connection issues This information in this section covers common issues and troubleshooting information for your cellular connection. Common provisioning issues Some common causes for XBee Gateway failing to provision include: Probable cause Resolution Check signal strength in the Signal strength, Signal level, and Signal quality fields.

  • Page 172: Troubleshooting Xbee Gateway Gsm Devices

    Troubleshooting XBee Gateway GSM devices If provisioning fails and your device fails to connect to the cellular network, log in to the XBee Gateway interface, and click Administration > Mobile Status. From the Mobile Status page, you can examine the provisioning and connection status.

  • Page 173: Troubleshooting Xbee Gateway Cdma Devices

    DNS secondary address Troubleshooting XBee Gateway CDMA devices If provisioning fails and your device fails to connect to the cellular network, log in to the XBee Gateway interface, and click Administration > Mobile Status. From the Mobile Status page, you can examine the provisioning and connection status.

  • Page 174: Rebooting Xbee Gateway

    If more than one network adapter is enabled, the discovery process will fail. Change Digi device: If you have second Digi device, try discovering it instead to see if you have the same problem. Though it may not solve your original discovery problem, it should provide you with some additional troubleshooting clues.

  • Page 175: Firewalls And Required Open Ports

    Verify Remote Manager server name in settings. Firewalls and required open ports When you use a firewall to filter outbound traffic, XBee Gateway requires these network ports to be open for proper operation: UDP port 53, for DNS UDP port 123, for NTP...

  • Page 176: Cannot Connect To Ntp Time Server To Get Correct Time

    Cannot connect to NTP time server to get correct time Cannot connect to NTP time server to get correct time XBee Gateway requires access to an NTP server to set its date and time. Normally the device receives the date and time automatically from the Remote Manager server.
  • Page 177 Troubleshoot your XBee Gateway Need more help? Issue Type Information to send Screen captures of the device's Configuration > Mobile Connectivity and Cellular issues Administration > Mobile Status pages. Screen captures of the device's Administration > XBee Firmware Update XBee and Administration >...

Table of Contents