Digi XGI-20CZ7-E00-W0 User Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Gateway
  5. XGI-20CZ7-E00-W0
  6. User manual

Digi XGI-20CZ7-E00-W0 User Manual

Xbee industrial gateway cellular/ethernet model
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Digi XBee® Industrial Gateway
User Guide

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XGI-20CZ7-E00-W0 and is the answer not in the manual?

Questions and answers

Related Manuals for Digi XGI-20CZ7-E00-W0

Summary of Contents for Digi XGI-20CZ7-E00-W0

  • Page 1 Digi XBee® Industrial Gateway User Guide...

  • Page 2: Customer Support

    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: Table Of Contents

    Contents About Digi XBee Industrial Gateway Regulatory information and certifications RF exposure statement FCC certifications and regulatory information (USA only) Declaration of Conformity (DoC) CE mark (Europe) Industry Canada (IC) certifications Safety statements Warnings for Use of Wireless Devices International EMC (Electromagnetic Emissions/Immunity/Safety) standards...
  • Page 4 Important directories Load applications onto XBee Industrial Gateway Program XBee Industrial Gateway using Python Find Python learning resources Digi Python Programmer's Guide Python support forum Digi Wiki for Developers Digi-specific Python modules for programming Sample programs Digi XBee Industrial Gateway...
  • Page 5 XBee Industrial Gateway ash shell reference documentation Connect and log in to the XBee Industrial Gateway device Log in to XBee Industrial Gateway through the Digi ESP for Python command-line interface Configure XBee Industrial Gateway Configure settings from Remote Manager...
  • Page 6 Configure XBee Industrial Gateway as a coordinator Join nodes to the coordinator Verify that XBee nodes are joined to the coordinator Configure the ZigBee network addressing parameters for XBee nodes Key addressing parameters Configure the network addressing parameters Explore serial I/O Digi XBee Industrial Gateway...
  • Page 7 Rebooting XBee Industrial Gateway Troubleshooting LEDs Firewalls and required open ports Cannot connect to NTP time server to get correct time Cannot connect to DNS server to resolve the Remote Manager server address Need more help? Digi XBee Industrial Gateway...

  • Page 8: About Digi Xbee Industrial Gateway

    (GSM\LTE) models are available. The XBee Industrial Gateway contains the XBee ZigBee product. You can manage XBee Industrial Gateway products remotely via Digi Remote Manager®. Remote Manager allows users to remotely manage thousands of deployed devices, supporting features like remote firmware upgrades and event alarms.

  • Page 9: 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 10: Ce Mark (Europe)

    About Digi XBee Industrial Gateway Regulatory information and certifications 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.

  • Page 11: Safety Statements

    About Digi XBee Industrial Gateway Safety statements 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.

  • Page 12: Warnings For Use Of Wireless Devices

    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. Digi XBee Industrial Gateway...

  • Page 13: Maximum Power And Frequency Bands

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

  • Page 14: Hardware Interfaces

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

  • Page 15: 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 16 About Digi XBee Industrial Gateway Where to find more information ConnectPort X2e Wiki page for additional programming content for ConnectPort X2e products; information on this Wiki also applies to XBee Industrial Gateway. DIA library documentation Digi Remote Manager User Guide...

  • Page 17: Xbee Industrial Gateway Hardware

    This section provides hardware specifications for XBee Industrial Gateway. Ethernet model: Ethernet model Ethernet model hardware specifications Cellular model: Cellular model Cellular model hardware specifications Antennas: XBee Industrial Gateway antennas XBee Industrial Gateway LEDs: XBee Industrial Gateway LED descriptions Ethernet model Digi XBee Industrial Gateway...

  • Page 18: Ethernet Model Hardware Specifications

    10.16 cm (4 in) Depth 2.54 cm (1 in) Weight 0.5 kg (0.22 lb) Ethernet Ethernet 1 RJ-45 port Ports Physical 10/100 Base-T (Auto-MDIX) Layer Data Rate 10/100 Mbps (auto-sensing) Mode Full or half duplex (auto-sensing) Digi XBee Industrial Gateway...
  • Page 19 XBee/XBee-PRO ZigBee RF Module User Guide (available from XBee/XBee-PRO ZigBee Modules (S2C) page) for complete specifications and product information. Development Python 2.7.1 version 64 MB RAM, 128 MB Flash Memory 20 MB RAM 20 MB Flash available for Python applications Digi XBee Industrial Gateway...

  • Page 20: Cellular Model

    Power requirements. Power requirements Ethernet specifications. Ethernet features XBee Industrial Gateway antennas. XBee antenna Cellular specifications. Cellular features Set up and configure a cellular device. SIM card installation XBee Industrial Gateway LED descriptions. LED status indicators Digi XBee Industrial Gateway...

  • Page 21: Cellular Model Hardware Specifications

    Physical Layer 10/100 Base-T (Auto-MDIX) Data Rate 10/100 Mbps (auto-sensing) Mode Full or half duplex (auto-sensing) Operating 3G bands: Cellular GSM/GPRS/EDGE B5(850) B8(900) B2(1900) B1(2100) B4(AWS) Operating 4G bands (North America): (AT&T, T-Mobile) B12/B13(700), B5(850), B4(AWS1700), B2(1900) Digi XBee Industrial Gateway...

  • Page 22: Xbee Industrial Gateway Antennas

    The XBee Industrial Gateway does not have internal antennas. Ethernet model: Requires one external XBee antenna. For information about purchasing an XBee antenna, see the Digi XBee antenna product page. Cellular model: Requires one external XBee and, depending on the device variant, either one or two external Cellular antennas.

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

    Color and blink pattern Description OFF (dark) No (or very poor) cellular signal. Moving device to a better location is recommended. Solid yellow Adequate cellular signal. This signal strength works for most applications. Solid green Good cellular signal. Digi XBee Industrial Gateway...

  • Page 24: Network Led

    Gateway to a 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 Industrial Gateway is deployed in a ZigBee network, the XBee LED behavior varies depending on whether XBee Industrial Gateway acts as a Digi XBee Industrial Gateway...

  • Page 25: Power Led

    Power LED Color and blink pattern Description OFF (dark) No power. Solid green Device is powered. This state does not indicate that the device is fully operational. The Network LED and its states convey such information. Digi XBee Industrial Gateway...

  • Page 26: Set Up Xbee Industrial Gateway

    This section walks you through the steps required to set up your XBee Industrial Gateway Cellular hardware and provides additional reference information. Verify your XBee Industrial Gateway Cellular components XBee Industrial Gateway cellular model includes the following components: Component Description XBee Industrial Gateway Cellular model Digi XBee Industrial Gateway...
  • Page 27 Set up XBee Industrial Gateway Setting up the XBee Industrial Gateway Cellular hardware Component Description Ethernet cable Power supply Required additional equipment Component Description A computer connected to the Internet. Digi XBee Industrial Gateway...

  • Page 28: Connect The Hardware

    Description An XBee antenna must be connected. XBee antenna For information about purchasing an XBee antenna, see the Digi XBee antenna product page. Depending on the device variant, either one or two cellular Cellular antennas antennas must be connected to the device.

  • Page 29: Setting Up The Xbee Industrial Gateway Ethernet Hardware

    This section walks you through the steps required to set up your XBee Industrial Gateway Ethernet hardware and provides additional reference information. Verify your XBee Industrial Gateway Ethernet components XBee Industrial Gateway Ethernet model includes the following components: Component Description XBee Industrial Gateway Ethernet model Ethernet cable Power supply Digi XBee Industrial Gateway...

  • Page 30: Connect The Hardware

    4. Startup Sequence - After power is applied: The Power LED turns solid green. The XBee LED turns blinking green when XBee Industrial Gateway creates a ZigBee network. The Network LED gradually turns solid green when XBee Industrial Gateway connects to Remote Manager. Digi XBee Industrial Gateway...

  • Page 31: Connect Xbee Industrial Gateway To The Ethernet Network

    Remote Manager server address. Note XBee Industrial 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. Digi XBee Industrial Gateway...

  • Page 32: Getting Started With Xbee Industrial Gateway

    Explore digital and analog I/O for more information. 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 Industrial Gateway. Digi XBee Industrial Gateway...

  • Page 33: Joining Zigbee Networks

    Therefore, as soon as you power on the XBee Industrial 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 Digi XBee Industrial Gateway...

  • Page 34: Joining Xbee Industrial Gateway To An Existing Zigbee Network

    XBee Industrial Gateway web interface appears. 2. Click XBee Network in the left menu. 3. Select the XBee Industrial Gateway ZigBee local XBee device. The XBee Configuration page appears. 4. From the XBee Configuration page, click Network Settings. Digi XBee Industrial Gateway...

  • Page 35: Configuring Xbee Industrial Gateway With A Custom Pan Id

    XBee Industrial Gateway web interface appears. 2. Under Configuration, click XBee Network. 3. Select the XBee Industrial Gateway local XBee device that you want to configure. The XBee Configuration page appears. 4. From the XBee Configuration page, click Network Settings. Digi XBee Industrial Gateway...

  • Page 36: Xbee Industrial Gateway And Non-Xbee Zigbee Devices

    PAN IDs so they will join the new one. XBee Industrial Gateway and non-XBee ZigBee Devices You can refer to additional resources to learn about using XBee Industrial Gateway with non-XBee ZigBee devices. Digi provides support and resources for your use of the product. Resources include: Digi forum...

  • Page 37: Administration And Maintenance Tasks

    XBee Industrial Gateway file system. Note Digi recommends using no more than 20 MB for custom applications, as XBee Industrial Gateway requires a portion of the same space to be capable of managing persistent system logs and firmware updates. Access the File Management page Follow this process to access the File Management page in Remote Manager: 1.

  • Page 38: File Management Page In The Xbee Industrial Gateway Web Interface

    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 Industrial Gateway requires a portion of the same space to be capable of managing persistent system logs and firmware updates.

  • Page 39: Back Up Or Restore The Configuration

    Back up and restore files from the XBee Industrial Gateway web interface The Backup/Restore page allows you to back up and restore the following device configuration settings to a file: XBee Industrial Gateway (Optional) XBee RF module Digi XBee Industrial Gateway...
  • Page 40 Restore Configuration section: Restores configuration settings from a backup file on your computer or a server. Choose File: Opens a browse dialog for locating and selecting the appropriate configuration file. Restore: Click Restore to restore the configuration from the selected file. Digi XBee Industrial Gateway...

  • Page 41: 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 Industrial Gateway firmware updates and manage firmware files. In the XBee Industrial Gateway web interface, OTA firmware updates are performed from a page linked from the XBee Configuration page.

  • Page 42: Update Firmware From The Xbee Industrial Gateway Web Interface

    Some settings, such as encryption keys, may not be preserved and must be entered again. 8. If required, type your encryption keys. Schedule firmware updates You can schedule firmware updates from Remote Manager. See the Digi Remote Manager User Guide for more information on scheduling firmware updates. 1. Log in to Remote Manager.
  • Page 43 2. In the XBee Industrial Gateway web interface, click Firmware Update under Administration. The Firmware Update page appears. 3. Select the Upgrade local (gateway) XBee’s firmware check box. 4. Click Next. 5. Type or browse to the filename containing the firmware update. Digi XBee Industrial Gateway...

  • Page 44: About Firmware Files

    7. If required, type your encryption keys. About firmware files Firmware files for the operating system and XBee module on XBee Industrial Gateway are available through Digi Technical Support on the XBee Gateway Support page. Click the Firmware Updates link.

  • Page 45: Mobile Status Page

    Error: Either the SIM was not inserted or there was another SIM problem. This status only appears for products that support multiple SIMs. SIM slot index Indicates which SIM slot is currently in use by the device. 1 means the first slot. 2 means the second slot. Digi XBee Industrial Gateway...
  • Page 46 Mobile network code Identifies a mobile phone operator/carrier with which the cellular modem is registered. Operator name The name of the mobile operator with which the modem is registered. This corresponds to the mobile country and network codes. Digi XBee Industrial Gateway...
  • Page 47 Disabled: The mobile data connection is disabled in the configuration settings. PRL update: Updating the preferred roaming list (LTE only). Operator scan: Searching the modem for available mobile operators (GSM only). No device found: The modem is not available or is malfunctioning. Digi XBee Industrial Gateway...
  • Page 48 Device monitoring error: Error while monitoring the modem status. May indicate a malfunctioning modem. IP address Internet protocol address of the mobile data interface. You can contact the device at this IP address if permitted by the carrier. Digi XBee Industrial Gateway...

  • Page 49: Displaying The Xbee Industrial Gateway End User License Agreement (Eula)

    Displaying the XBee Industrial Gateway End User License Agreement (EULA) You can access the End User License Agreement (EULA) for XBee Industrial Gateway from the web interface. Note The XBee Industrial Gateway EULA is not available through Remote Manager. Digi XBee Industrial Gateway...

  • Page 50: Rebooting Xbee Industrial Gateway

    4. Select More > Disconnect. A confirmation dialog displays. 5. Click Yes to complete the disconnect process. If XBee Industrial Gateway is configured to automatically reconnect to Remote Manager, the device re-establishes the connection to Remote Manager after its reconnection timeout period has expired. Digi XBee Industrial Gateway...

  • Page 51: About Programming

    XBee Industrial 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 Program XBee Industrial Gateway using Python to learn about programming elements and operations available for XBee Industrial Gateway using annotated example programs.

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

    XBee ZigBee Cloud Kit web application source code DIA: Device Integration Application (DIA) is an application software platform for Digi gateways. DIA makes it easy to connect remote devices and sensors to Digi gateway products. For more information, see software.

  • Page 53: Load Applications Onto Xbee Industrial Gateway

    Industrial Gateway system log. Load applications onto XBee Industrial Gateway To load an application onto XBee Industrial Gateway, use the File Management function in Remote Manager or the XBee Industrial Gateway web interface. For instructions, see File management. Digi XBee Industrial Gateway...
  • Page 54 Program XBee Industrial Gateway using Python XBee Industrial 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 55: Program Xbee Industrial Gateway Using Python

    Digi Wiki for Developers introduces the Python programming language by showing how to create and run a simple Python program. It reviews Python modules, particularly those with Digi-specific behavior, and describes how to load and run Python programs onto Digi devices, and run sample Python programs.

  • Page 56: Led Control

    Appropriate error detection and handling with Python scripts is certainly recommended. The following sample program demonstrates the watchdog feature. Note The highlighted numbers in the sample code correspond to the items in the Program Notes, below. Digi XBee Industrial Gateway...

  • Page 57: Rci Callback

    The following example shows an RCI request. Note The highlighted numbers in the sample code correspond to the items in the Program Notes, below.   import rci   request_string=""" <rci_request version="1.1">   <query_state>     <interface_info name="eth0">       <ip/>     </interface_info>   </query_state> </rci_request> """ print rci.process_request(request_string) Program notes Digi XBee Industrial Gateway...

  • Page 58: Xbee Functions

    Python application is already installed in your XBee Industrial Gateway device and automatically starts when the gateway is initialized. For a complete explanation about Remote Manager, see the Remote Manager documentation. This documentation is available from the Documentation link within the Remote Manager platform. Digi XBee Industrial Gateway...

  • Page 59: How Does The Xbee Industrial Gateway Python Application Work

    The following figure illustrates the role of XBee Industrial Gateway and XBee Industrial Gateway Python application in such a scenario. Key features and operations of the XBee Industrial Gateway Python application The XBee Industrial Gateway Python application provides the following features: Digi XBee Industrial Gateway...

  • Page 60: Xbee Industrial Gateway Python Application Requirements

    Python application and Remote Manager capabilities: 1. A Remote Manager account. If you do not have a Remote Manager account, follow the instructions in the Digi Remote Manager User Guide create a Remote Manager account. 2. Your XBee Industrial Gateway device must be registered in your Remote Manager account.
  • Page 61 DIO1 of the module. 2. From a web browser, go to the Home page of your XBee Industrial Gateway web interface. 3. Under Configuration, click XBee Network. The XBee Configuration page appears. Digi XBee Industrial Gateway...
  • Page 62 8. On the XBIB, press the User Button 3 (SW3) several times. This action causes the XBee module report the status of DIO1. 9. From a web browser, log in to Remote Manager. 10. From Remote Manager, click Data Services. The Data Services page appears. Digi XBee Industrial Gateway...
  • Page 63 0 and 1. For example: Each stream contains a historical view of the values of the data channel it represents. To display the historical values, switch from the Table to Chart view. Digi XBee Industrial Gateway...

  • Page 64: Receive Serial Data From Remote Manager

    Remote Command Interface (RCI) do_command element, with xbgw as target attribute and the send_serial command as content. To learn more about SCI requests, the RCI protocol, and the Web Services API, see the Digi Remote Manager Programmer Guide. Digi XBee Industrial Gateway...
  • Page 65 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. Command syntax The send_serial command must follow this syntax: <send_serial addr=”{address|broadcast}” encoding={“base64”|”utf- 8”}”>value</send_serial> Command attributes Digi XBee Industrial Gateway...
  • Page 66 ASCII subset. Note Whitespace is not significant when the XBee Industrial Gateway Python application processes base64. However, whitespace in UTF-8 is significant, because it is impossible to determine whether Digi XBee Industrial Gateway...
  • Page 67 XBee Industrial Gateway device ID and XBee MAC address if you want to test this example. <sci_request version="1.0">   <send_message>     <targets>         <device id="00000000-00000000-001122FF-FF334455"/>     </targets> <rci_request version="1.1">     <do_command target="xbgw"> <send_serial addr="00:11:22:33:44:55:66:77"                     encoding="base64"> SGVsbG8sIFdvcmxkIQ== </send_serial>     </do_command>   </rci_request>  </send_message> </sci_request> Digi XBee Industrial Gateway...
  • Page 68          </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 Industrial Gateway Python application error identifiers, see XBee Industrial Gateway Python application command errors. Digi XBee Industrial Gateway...
  • Page 69 The Console log window appears and displays the XBee node’s serial console. 4. Connect the console. 5. From a web browser, log in to Remote Manager. 6. Click Documentation and then click API Explorer. The API console appears. Digi XBee Industrial Gateway...
  • Page 70       <rci_request version="1.1">          <do_command target="xbgw">              <send_serial addr="0013A2004031A8E1"                         encoding="base64">SGVsbG8sIFdvcmxkIQ==              </send_serial>          </do_command>      </rci_request>   </send_message> </sci_request> The content of the send_serial command is the text Hello, World! encoded in base64 as it is specified in the encoding attribute. 8. Click Send. Digi XBee Industrial Gateway...

  • Page 71: Store Serial Data In Remote Manager

    XBee Industrial Gateway Python application automatically processes the frame containing the serial data and uploads it to Remote Manager, thereby generating a data stream. To learn more about data streams, see the Digi Remote Manager User Guide Digi Remote Manager Programmer Guide.
  • Page 72 To change the setting to store the data in UTF-8 format: 1. Open /WEB/python/xbgw_settings.json in an editor. 2. Change "encode serial": true to "encode serial": false. XBee Industrial Gateway Python application configuration file for more information on the configuration file. Digi XBee Industrial Gateway...
  • Page 73 Edit frame using the Frames Generator tool button: c. After adding the frame to the list of frames, select the frame and click the Send selected frame button. 6. From a web browser, log in to Remote Manager. Digi XBee Industrial Gateway...

  • Page 74: Manage Xbee Dio Lines Though Remote Manager

    Remote Manager (using the Web Services API) and dispatch them to a specific XBee module in the network to set its corresponding pin high or low. The following figure demonstrates how this remote management mechanism works. Digi XBee Industrial Gateway...
  • Page 75 SCI requests and RCI protocol. set_digital_output command definition The set_digital_output command configures the value of a DIO of a specific XBee node in your network. Add this command to the SCI request inside the RCI do_command element. Command syntax Digi XBee Industrial Gateway...
  • Page 76 The body of the set_digital_output command indicates whether to set the digital output pin low or high. Legal values for the body to configure the pin are: high or true: Sets the pin high (ON). Other legal values include: 1, yes, y, on Digi XBee Industrial Gateway...
  • Page 77             </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 Industrial Gateway device ID and XBee MAC address to test this example. Digi XBee Industrial Gateway...
  • Page 78             </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 Industrial Gateway Python application error identifiers, see XBee Industrial Gateway Python application command errors. Digi XBee Industrial Gateway...
  • Page 79 7. Under I/O Pin Settings, configure I/O Pin 4 (AT setting D1) to Digital Output High (5). This way, the DIO4 is configured as output and its value is set to high turning the User LED 4 (DS4) OFF because the LED in the board is using an inverted logic. Digi XBee Industrial Gateway...
  • Page 80       <rci_request version="1.1">          <do_command target="xbgw">              <set_digital_output addr="0013A2004031A8E1"                         name="DIO4">low</set_digital_output>          </do_command>      </rci_request>   </send_message> </sci_request> The set_digital_output command sets the value of the DIO4 to low, which will turn ON the User LED 4 (DS4) of the board. 11. Click Send. Digi XBee Industrial Gateway...

  • Page 81: Xbee Industrial Gateway Python Application Configuration File

    The XBee Industrial Gateway Python application provides the following category, with one configurable setting: devicecloud encode serial: Type: Boolean Description: Indicates whether or not the serial data that is sent and stored in Remote Manager is encoded in base64. Default value: true Digi XBee Industrial Gateway...

  • Page 82: Xbee Industrial Gateway Python Application Command Errors

    Attribute value is incorrect missingattr Missing required command attribute toomanyattrs Too many attributes were given setfailed Remote node rejected set command txfailed Transmit operation failed txfull Too many outstanding transmits txstatus TX Status delivery failure unexpected Unexpected/unclassified error Digi XBee Industrial Gateway...

  • Page 83: Configuring A Python Application In The Web Interface

    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 84: 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 85 Program XBee Industrial 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 86 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 87: Dia Software

    Data management (channels) Data delivery (presentations) Written in the Python programming language for use on Digi devices, you can extend it to meet unique device connectivity requirements. When used with the Digi ESP for Python, DIA can shrink the development cycle for complex data gathering and transformation applications.

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

    Log in to XBee Industrial 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 89 Program XBee Industrial Gateway using Python Linux command shell (command-line interface) Digi XBee Industrial Gateway...

  • Page 90: Configure Xbee Industrial Gateway

    Configure settings from Remote Manager Configure settings from the XBee Industrial Gateway web interface Ethernet IP network settings Mobile Connectivity settings Digi Mobile SureLink™ settings DNS settings Mobile firewall settings Autostart settings for the Python Program Configure Remote Manager connectivity settings Ethernet SureLink™...

  • Page 91: Configure Settings From Remote Manager

    3. Add XBee Industrial Gateway devices to the Remote Manager device list. See Add devices to your inventory in the Digi Remote Manager User Guide for instructions. Remote Manager interface for more basic information about Remote Manager. Basic configuration settings In Remote Manager, you can access basic configuration settings for XBee Industrial Gateway by double-clicking on a device in the device list to display the Properties page.

  • Page 92: Configure Settings From The Xbee Industrial Gateway Web Interface

    The XBee Industrial Gateway web interface appears. If you do not know the XBee Industrial Gateway device's IP address If you already ran the Wireless Access Point wizard, you need the Digi Device Discovery Utility to rediscover the device and open its web interface.

  • Page 93: Ethernet Ip Network Settings

    The web interface runs locally on the device, which means that the interface always maintains and displays the latest settings in the Digi device. If you make changes, click Apply to apply the changes to the configuration settings to the Digi device.

  • Page 94: Default Ethernet Settings

    System (DNS) server for the device. 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 web interface. The default behavior regarding...

  • Page 95: Ethernet Network Configuration Page

    XBee Industrial Gateway automatically self-configures an IP address when an address is not available from other methods. For example, when the Digi device is configured for DHCP and a DHCP server is not currently available. For more information on AutoIP, see...
  • Page 96 (DNS) server for the device. If you disable DHCP, you must enable the Static IP option and configure these settings manually. In the absence of a DHCP server, you must assign a static IP address by accessing the Digi Device Discovery tool and changing the network settings through that interface.

  • Page 97: Mobile Connectivity Settings

    Configure XBee Industrial Gateway Mobile Connectivity settings Default Gateway: The IP address of the computer that enables this Digi device to access other networks, such as the Internet. Mobile Connectivity settings The mobile settings allow you to configure how to connect to mobile (cellular) networks using the mobile connection, including the service provider, service plan, and settings used in connecting to the mobile network.
  • Page 98 In the Access Point Name (APN) field, enter the APN. Note that an APN may not be required for Verizon. c. In the SIM PIN field, enter the SIM PIN, if provided. d. Click Apply to save the mobile connectivity information to XBee Industrial Gateway. Digi XBee Industrial Gateway...

  • Page 99: Configure Mobile Settings

    SIM card. The password is usually between four and eight digits. SIM PINs act like ATM PINs in that they require users to authenticate themselves as the true owner of the card before information is released. Depending on mobile service provider, this value may not be necessary. Digi XBee Industrial Gateway...

  • Page 100: Mobile Connectivity Configuration Page

    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 items in the web interface and Remote Manager are disabled.

  • Page 101: Digi Mobile Surelink™ Settings

    Configure XBee Industrial Gateway Digi Mobile SureLink™ settings Opt-in: : Enables or disables the Device Cloud SMS opt-in feature. By default, XBee Gateway cellular models are configured to automatically register with the Remote Manager Technical Support when you first power up your device. Activation with Remote Manager Technical Support is free.

  • Page 102: Mobile Surelink Integrity Monitoring Settings

    Configure XBee Industrial Gateway Digi Mobile SureLink™ settings Mobile SureLink integrity monitoring settings Enable Link Integrity Monitoring using the test method selected below Enables or disables the link integrity monitoring tests. If this setting is enabled, you can configure the other Link Integrity Monitoring settings and use these settings to verify the functional integrity of the mobile connection.

  • Page 103: Link Integrity Test Options

    Configure XBee Industrial Gateway Digi Mobile SureLink™ settings 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 Industrial Gateway device. Reconnect interface: Reconnect the cellular interface.

  • Page 104: Dns Settings

    An IP address of 0.0.0.0 indicates no server is specified. 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. Digi XBee Industrial Gateway...

  • Page 105: Mobile Firewall Settings

    Industrial Gateway to automatically start when the device starts. These programs are executed through the specified python commands. File management for details on loading files. Configuring a Python application in the web interface for more information on managing application files and their associated Python processes. Digi XBee Industrial Gateway...

  • Page 106: Configure Python Settings

    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 107: Configuring Connectivity Settings

    1. Select Configuration > Device Cloud Connectivity to access the connectivity settings. The Device Cloud Configuration page displays the basic settings. 2. Complete the fields under basic settings. See Basic connectivity settings. 3. Click Advanced Settings. The Advanced Settings section on the Device Cloud Configuration page appears. Digi XBee Industrial Gateway...

  • Page 108: Device Cloud Configuration Page

    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 109: Device Cloud Client Initiated Connection 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. Digi XBee Industrial Gateway...

  • Page 110: Basic Connectivity Settings

    The value for this setting is generally a Fully Qualified Domain Name (FQDN) pointing to one of the Remote Manager servers. Obtain this value from your Remote Manager server administrator. Typically this administrator is Digi. The default value is my.devicecloud.com. Device Cloud Server Port (Remote Manager) Server Port (web interface): The network port number for the Remote Manager server.

  • Page 111: Advanced Connectivity Settings For The Web Interface

    If you do not want to automatically reconnect to Remote Manager after a disconnect: From Remote Manager, choose Never reconnect. From the web interface, clear the Reconnection delay check box. Digi XBee Industrial Gateway...
  • Page 112 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 113: Connect To A Different Instance Of Remote Manager

    3. Select Use an HTTP proxy to connect to Remote Manager and complete the fields. Contact your network administrator for assistance in configuring a proxy server. Ethernet SureLink™ settings SureLink is an optional feature that monitors the integrity of an established Ethernet network connection. Digi XBee Industrial Gateway...

  • Page 114: Configuring Ethernet Surelink Settings

    “consecutive failures” counter resets to zero when the mobile connection is reestablished. If the mobile connection disconnects for any reason (including not as a result of a link integrity test failure), the consecutive failures count resets to zero when the mobile connection is reestablished. Host List Digi XBee Industrial Gateway...

  • Page 115: Gps Static Position Settings

    3. Click Apply to save your changes. GPS Static Position page The GPS Static Position page allows you to configure the position of a Digi device. Enable use of the static position: Enables or disables the position for a static XBee Industrial Gateway.

  • Page 116: Network Failover Settings

    Configure XBee Industrial Gateway Network Failover settings Latitude: Defines the latitude component of the Digi device, in degrees. The value can range from -90.0 to 90.0 degrees. Longitude: Defines the longitude component of the Digi device, in degrees. The value can range from -180.0 to 180.0 degrees.

  • Page 117: Link Integrity Test Options And Failover

    Click Save to save your changes. Link integrity test options and failover When you configure failover, you must select a test type option, which is used to verify link integrity for failover. Ping TCP Connection Digi XBee Industrial Gateway...

  • Page 118: Time Settings

    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 119: Time Server Configuration Page

    For XBee Industrial Gateway Ethernet models, you can specify up to four NTP server settings to be used as upstream servers in synchronizing time. The default settings for the four NTP server settings are as follows: NTP server 1: 0.time.digi.com NTP server 2: 1.time.pool.ntp.org NTP server 3: 1.idigi.pool.ntp.org NTP server 4: 2.idigi.pool.ntp.org...
  • Page 120 For XBee Industrial Gateway Ethernet models, you can specify up to four NTP server settings to be used as upstream servers in synchronizing time. The default settings for the four NTP server settings are as follows: NTP server 1: 0.time.digi.com NTP server 2: 1.time.pool.ntp.org NTP server 3: 1.idigi.pool.ntp.org NTP server 4: 2.idigi.pool.ntp.org...

  • Page 121: Configure Xbee Network Settings

    XBee Industrial 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 122: Configure Xbee Network Settings In The Web Interface

    Node ID: A descriptive, user-friendly name of your choice for the device. The Node ID is a 20- byte printable ASCII string that allows for referencing devices by names rather than their physical addresses. Network Address: The 16-bit network address for the device. Extended Address: A unique static 64-bit address for the device. Digi XBee Industrial Gateway...

  • Page 123: Device Details Page

    Network Settings allows you to configure the basic elements of a ZigBee network, including the Extended PAN ID used for starting or joining a network, and other parameters used for starting or joining a network. Digi XBee Industrial Gateway...
  • Page 124 CAUTION! The node may no longer be accessible from this gateway after a network reset. The Backup and Restore Configuration operation allows you to save a backup file of the XBee RF module configuration settings for nodes and restore the configuration settings if the need arises. Digi XBee Industrial Gateway...

  • Page 125: Xbee Network Ota Firmware Updates

    The XBee Industrial 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 Industrial Gateway firmware updates and manage firmware files.
  • Page 126 Click Browse to select a firmware file and then click Upload. Manage Files section This section lists the firmware files uploaded to the Digi device, along with their type and version number. You can remove these files from the gateway after all nodes have been updated. To delete firmware files, select the check box next to each firmware file that you want to delete and then click Delete.

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

    Update the XBee node firmware (OTA updates) from the web interface To perform OTA firmware updates from the web interface: 1. Download the appropriate firmware file from Digi. 2. Log in to the XBee Industrial Gateway web interface. 3. Under Configuration, click XBee Network. The XBee Configuration page appears.

  • Page 128: Xbee Industrial Gateway Network Python Log File

    XBee network troubleshooting resources For help troubleshooting issues with your XBee network, see the following resources: XBee ZigBee Cloud Kit Getting Started Guide Join your XBee node to your XBee Gateway section in the XBee ZigBee Cloud Kit Getting Started Guide Digi XBee Industrial Gateway...

  • Page 129: Learn More About Xbee Industrial Gateway

    XBee Industrial Gateway cellular models use the top NTP Server entry (NTP Server 1), and leave the others blank. XBee Industrial Gateway checks all NTP servers that are configured for time-drift. Having four NTP time servers configured for an XBee Industrial Gateway cellular device would result in excessive and unnecessary cellular usage. Digi XBee Industrial Gateway...

  • Page 130: Default Behavior Regarding Dns

    This section explains how to configure the parameters for forming XBee networks on both XBee Industrial Gateway and XBee nodes. To connect XBee nodes to XBee Industrial Gateway: 1. Before you begin, download XCTU from www.digi.com/xctu. XCTU allows you to configure XBee RF modules.

  • Page 131: Join Nodes To The Coordinator

    4. Under the Networking category, replace the current PAN ID with your custom PAN ID in the ID PAN ID field. 5. Once you have changed the setting, click the Write radio settings button to save the new PAN ID in the XBee module. Digi XBee Industrial Gateway...

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

    4. Below the Remote XBee Devices table, select the Clear list before discovery check box and click the Discover XBee Devices button. 5. After some seconds the Remote XBee Devices table displays your XBee ZigBee node. Digi XBee Industrial Gateway...

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

    Association Indicator shows the node’s current association status, which points to the reason the node is not connecting to the coordinator. There are several possible values for the Association Indicator, all described in the XBee/XBee-PRO ZigBee RF Modules User Guide (Digi part number 90000976). This document is available from the XBee/XBee-PRO S2C ZigBee...

  • Page 134: Configure The Network Addressing Parameters

    XBee serial port that you are configuring. 3. Configure XBee serial parameters. Example serial I/O configuration The following example demonstrates the serial I/O configuration process, between an XBee RF module and connected device. Digi XBee Industrial Gateway...

  • Page 135: Configuring The Serial I/O

    If your want your XBee nodes to transmit digital or analog data, you must configure the XBee nodes for your 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 XBee Industrial Gateway...

  • Page 136: Understanding The Process For Digital And Analog I/O

    Learn more about XBee Industrial Gateway Explore digital and analog I/O Digi knowledge base article: Digital and analog sampling using XBee radios Building Wireless Sensor Networks XBee/XBee-PRO ZB RF Modules User Guide About programming provides several examples of I/O configuration...
  • Page 137 5. Configure I/O settings for the pins of each node's XBee RF module. This step includes several substeps: a. Configure digital I/O. b. Configure analog I/O. c. Configure Parameters that set the I/O sampling rate. There are different parameters for digital and analog I/O. Digi XBee Industrial Gateway...

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

    To configure the digital or analog I/O: 1. On the XBee Configuration page in the XBee Industrial Gateway web interface, in the Remote XBee Devices list, click a node under Remote XBee Devices. The XBee Configuration settings page for the node appears. Digi XBee Industrial Gateway...
  • Page 139 Detect: Sets or clears the appropriate bit of the IC parameter, described below. 3. Set DIO1 to Digital Input. Check both the Pullup and Detect check boxes. More information on these options is in step 5. 4. Set DIO3 to Set DIO3 to Analog Input. Digi XBee Industrial Gateway...

  • Page 140: View Your Device Data

    After you configure the I/O for your XBee nodes, you can view the data from the nodes. The device data is available for viewing from the following locations: View device data from Remote Manager View device data and events in the Python log file for XBee Industrial Gateway Digi XBee Industrial Gateway...

  • Page 141: View Device Data From Remote Manager

    From Remote Manager, the system log is a file maintained in the file system of the device. To retrieve it, use the File Management capabilities in Remote Manager. See the Digi Remote Manager User Guide if you need help. Digi XBee Industrial Gateway...
  • Page 142 Initializing XBeeEventManager 4 19:44:06 (none) local7.info pylog: 2014-08-04 19:44:06,934 INFO xbgw.xbee.ddo_manager: Initializing DDOEventManager 4 19:44:07 (none) local7.info pylog: 2014-08-04 19:44:07,030 INFO xbgw.reporting.device_cloud: Initializing DeviceCloudReporter 4 19:44:07 (none) local7.info pylog: 2014-08-04 19:44:07,072 INFO xbgw.command.rci: RCICommandProcessor initialized Digi XBee Industrial Gateway...
  • Page 143 These lines show that the XBee Industrial 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 Digi XBee Industrial Gateway...
  • Page 144 [00:13:A2:00:40:9F:6F:CB]!/DIO0', True, {}) 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,332 DEBUG xbgw.reporting.device_cloud: stream_id: xbee.analog/ [00:13:A2:00:40:9F:6F:CB]!/AD2 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,337 DEBUG xbgw.reporting.device_cloud: data: ('xbee.analog/ [00:13:A2:00:40:9F:6F:CB]!/AD2', 780, {}) 4 19:47:44 (none) local7.info pylog: 2014-08-04 19:47:44,354 INFO Digi XBee Industrial Gateway...
  • Page 145 Learn more about XBee Industrial 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 Digi XBee Industrial Gateway...

  • Page 146: Troubleshoot Your Xbee Industrial 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 147: Displaying The System Log

    2. Click /WEB and go to the WEB/logging directory on the XBee Industrial 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 148: Cellular Connection Issues

    SIM is not properly installed. On the Administration > Mobile Status page: SIM not ready. On the Administration > System Log > Event Log, the message Connection error: SIM not ready. Ensure that a SIM is properly installed. Digi XBee Industrial Gateway...

  • Page 149: Troubleshooting Xbee Industrial Gateway Gsm And Lte Devices

    Following are some key fields on the Mobile Status page. For a description of all status fields, see Mobile Status page. SIM PIN status SIM slot index Signal strength Signal level Signal quality Registration status Mobile network code Mobile country code Connection state Connection error Disconnect reason IP address DNS primary address Digi XBee Industrial Gateway...

  • Page 150: Device Discovery Troubleshooting Tips

    Device Discovery troubleshooting tips Device Discovery troubleshooting tips If your device does not appear in the list of devices after using the Digi Device Discovery utility, consider the following tips. Firewalls: Verify that any software firewalls (common examples are Windows Firewall and most popular Anti-Virus software) are disabled.
  • Page 151 Hardware failure. In the unlikely case of hardware failure, first physically remove power and reconnect. If the LEDs remain dark, return the device to Digi for RMA. XBee LED is dark. If device is configured Return the device to Digi for RMA.

  • Page 152: Firewalls And Required Open Ports

    Contact your network administrator or ISP to find out if they have blocked access or have set up other NTP servers on their network. To change the NTP server through the web interface, go to Time settings. For NTP to operate correctly, UDP port 123 needs to be open. Digi XBee Industrial Gateway...

  • Page 153: Cannot Connect To Dns Server To Resolve The Remote Manager Server Address

    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.

This manual is also suitable for:

Xgi-20cz7-eu7-w0

Table of Contents