1. Manuals
  2. Brands
  3. Digi Manuals
  4. Gateway
  5. ConnectPort X2e ZB
  6. User manual

Digi ConnectPort X2e ZB User Manual

Hide thumbs Also See for ConnectPort X2e ZB:
Table of Contents

Advertisement

Quick Links

ConnectPort X2e ZB
User's Guide
ConnectPort X2e ZB Ethernet
ConnectPort X2e ZB Wi-Fi
90001298_A

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the ConnectPort X2e ZB and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Digi ConnectPort X2e ZB

Summary of Contents for Digi ConnectPort X2e ZB

  • Page 1 ConnectPort X2e ZB User’s Guide ConnectPort X2e ZB Ethernet ConnectPort X2e ZB Wi-Fi 90001298_A...
  • 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, either expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.

  • Page 3: Table Of Contents

    C o n t e n t s Contents Contents ....................................3 Chapter 1: Introduction ................................6 About this guide .................................6 Digi contact information ............................6 ConnectPort X2e ZB ..............................7 Hardware interfaces..............................8 Configuration and management interfaces.........................8 Web interface..............................9 iDigi Manager Pro™ interface ........................10 Programming interfaces and capabilities .........................11 Python development independent of the target device ...................11...
  • Page 4 C o n t e n t s Chapter 3: Configuration............................... 27 Important configurable settings..........................28 Ethernet IP network settings...........................28 Wi-Fi settings..............................29 NTP server settings............................30 iDigi remote device management ........................30 Additional device configuration settings........................31 Python ................................31 XBee settings ..............................31 Configuration from the Web interface ........................32 Open the web interface ...........................32 The Home page...............................35 Configuration settings pages...........................37...
  • Page 5 Button handling ..............................61 LED control ..............................62 Watchdog................................63 RCI callback ..............................64 XBee functions ...............................66 The ConnectPort X2e ZB filesystem ........................67 Differences between Windows and Linux filesystems...................67 Important directories............................67 Access/browse the filesystem from device interfaces ..................67 Common operations for directories and files....................67 The Linux command shell (command-line interface) ....................68...

  • Page 6: Chapter 1: Introduction

    Introduction About this guide This guide introduces the hardware, firmware, and software features of the ConnectPort X2e ZB. It describes how to perform configuration and administrative tasks, and how to develop and run applications on the device. Programming focuses on basic programming concepts and teaching through examples.

  • Page 7: Connectport X2E Zb

    The ConnectPort X2e ZB features an end-to-end development environment, Digi ESP Python, that allows for rapid M2M-specific application development on the industry standard Python scripting engine. The Digi ESP for Python environment is an IDE featuring device detection, debugging, compiling, and downloading of code to Digi gateways.

  • Page 8: Hardware Interfaces

    Hardware interfaces are covered in "Hardware" on page 14. Configuration and management interfaces To establish network connectivity with a ConnectPort X2e ZB device, minimal configuration is required in many environments. This means that you may not need to set or change configuration settings from their factory defaults to begin developing with the device.

  • Page 9: Web Interface

    C o n f i g u r a t i o n a n d m a n a g e m e n t i n t e r f a c e s Web interface A web interface is provided as an easy way to configure basic device settings and perform administrative tasks.

  • Page 10: Idigi Manager Pro™ Interface

    C o n f i g u r a t i o n a n d m a n a g e m e n t i n t e r f a c e s ™ iDigi Manager Pro interface The default behavior of Connectport X2e ZB is to power up and connect to the ® ™ iDigi Device Cloud .

  • Page 11: Programming Interfaces And Capabilities

    Python interpreter interactively, create scripts, launch scripts, and control their operation. Digi ESP for Python The ConnectPort X2e ZB is supported by the Digi ESP for Python, an IDE featuring device detection, debugging, compiling and downloading of iDigi Dia/Python code to Digi gateways.

  • Page 12: Linux Command Shell

    P r o d u c t d i f f e r e n c e s f r o m p r e d e c e s s o r C o n n e c t P o r t X p r o d u c t s Linux command shell Note: The ConnectPort X2e ZB also has a Linux shell command-line interface. While Digi ESP for Python is intended as the main programming interface, this interface may be used for some programming and device management tasks.

  • Page 13: Where To Find More Information

     – The ConnectPort X2e ZB has a web user interface for both network configuration and access to the log file for troubleshooting the initial connection to iDigi. For more information on the web interface, see "Configuration" on page 27.

  • Page 14: Chapter 2: Hardware

    Hardware This section provides hardware specifications, reviews key hardware features, and lists regulatory statements and certifications of the ConnectPort X2e ZB. Hardware feature summary Power requirements. See page 15. LED status indicators. See page 17. Button. See page 20. Ethernet features. See page 15.

  • Page 15: Hardware Specifications

    H a r d w a r e s p e c i f i c a t i o n s Hardware specifications Specification Value Environmental Operating 32° F to 104° F (0° C to 40° C) temperature Relative humidity 5% to 95% (non-condensing) Storage and -40 to 185F (-40 to 85C)
  • Page 16 H a r d w a r e s p e c i f i c a t i o n s Specification Value 802.11 b/g/n Wi-Fi (2.4GHz only) Data Rate Up to 72.2 Mbps Transmit Power 18 dBm typical (varies by mode and channel) Receiver Sensitivity -87 dBm @ 11 Mbps Modes...

  • Page 17: Leds

    L E D s LEDs The ConnectPort X2e ZB has several LEDs. All LEDs have default behaviors, described in this section. Some LEDs can also be controlled programmatically, as discussed in "LED control" on page 62. Power XBee Network Power LED...

  • Page 18: Xbee Led

    X2e ZB to an XBee wireless network. The behavior of the XBee LED varies depending on whether the ConnectPort X2e ZB acts as a coordinator or a router. For information on changing the ConnectPort X2e ZB from a coordinator to a router, see the XBee/XBee-PRO ZB SMT RF Modules Product Manual.

  • Page 19: Network Led

    L E D s Network LED The Network LED indicates the status of the connection of the ConnectPort X2e ZB to both a communications network and an iDigi server. The LED can be user-controlled; see page 62 for details. Ethernet or Wi-Fi network communication...

  • Page 20: Button

    B u t t o n Button The button on the ConnectPort X2e ZB is capable of performing a number of Digi-defined actions, including: Reset the device configuration settings to their factory defaults  Enable configuration changes via the device discovery tools within a five-minute ...

  • Page 21: Factory Reset

    A n t e n n a s Factory reset Pressing the button for over 10 seconds after the ConnectPort X2e ZB is running resets the device to its factory default configuration. This action clears any configuration settings you may have entered through the supported device interfaces.

  • Page 22: 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 23: European Community - Ce Mark Declaration Of Conformity (Doc)

    Eden Prairie MN 55344 Declare under our sole responsibility that the product: Product Name Model Number ConnectPort X2e ZB 50X2E-Z3C-XXX-XX to which this declaration relates are in conformity with the essential requirements and other relevant requirements of Directive 1999/5/EC (R&TTE): ...

  • Page 24: Safety Statements

    R e g u l a t o r y i n f o r m a t i o n a n d c e r t i f i c a t i o n s Safety statements Important Safety Information To avoid contact with electrical current: Never install electrical wiring during an electrical storm.
  • Page 25 R e g u l a t o r y i n f o r m a t i o n a n d c e r t i f i c a t i o n s 5.10 Ignition of Flammable Atmospheres Warnings for Use of Wireless Devices Observe all warning notices regarding use of wireless devices.

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

    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 through "Digi contact information" on page 8 for repair information. Emissions...

  • Page 27: Chapter 3: Configuration

    Configuration While the ConnectPort X2e ZB is designed to allow network communication with minimal configuration, there are several configuration settings that can be adjusted. This section covers those configuration settings and configuration of these settings from the web interface, and from iDigi Manager Pro.

  • Page 28: Important Configurable Settings

    Domain Name System (DNS) servers. DHCP The ConnectPort X2e ZB 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 29: Wi-Fi Settings

    Name resolution is important when connecting to iDigi, as the Digi servers are provided as fully-qualified domain names. ConnectPort X2e ZB 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 30: Ntp Server Settings

    If already connected to iDigi, it is also possible to adjust the time server configuration. iDigi remote device management The ConnectPort X2e ZB, as with many of its predecessors, is compatible with the iDigi device and data management platform. iDigi provides a mechanism to do more advanced device configuration than is generally possible in the web interface Once the device has established network connectivity to the iDigi server, it will be manageable remotely using the iDigi interface.

  • Page 31: Additional Device Configuration Settings

    XBee settings The ConnectPort X2e ZB provides a gateway between an Internet Protocol (IP) network wired or wireless devices and a network of various wireless devices containing XBee or ZigBee wireless RF modules. Typically, these wireless devices are small sensors and controllers. Remote nodes in an XBee network can be other Digi ZB or SE nodes, or 3rd-party nodes.

  • Page 32: Configuration From The Web Interface

    Open the web interface To open the web interface, use the Digi Device Discovery utility in Digi ESP for Python to get the IP address for the device. The Digi Device Discovery utility locates Digi devices on a network. It uses a Digi International-proprietary protocol, Advanced Digi Discovery Protocol (ADDP), to discover the Digi devices on a network, and displays the discovered devices in a list.
  • Page 33 A dialog is displayed for asking where to look for connected devices. Make sure the option Local Area Network is selected and click OK. The Digi Device Discovery dialog is displayed, listing the devices found. The IP Address column displays the IP address of every device. Locate the device in the list of devices.
  • Page 34 For example: http://10.101.1.178 Note: Use of Digi Device Discovery within Digi ESP is covered further in the Digi ESP help topic Help > Help Contents > Digi ESP for Python > 3. Working with the IDE > 3.3. Configuring Devices > 3.3.2. Automatic Configuration.

  • Page 35: The Home Page

    The Network Connectivity Status LED and information displayed indicates the readiness of the ConnectPort X2e ZB to communicate in a network and with the iDigi server. See the description of the status LEDs beginning on page 17 and "Troubleshooting" on page 69 for information on the LED and the various network connectivity status conditions listed.
  • Page 36 The web interface runs locally on the device, which means that the interface always maintains and displays the latest settings in the Digi device. On each screen, the Apply button is used to save any changes to the configuration settings to the Digi device.

  • Page 37: Configuration Settings Pages

    DHCP or by entering a static IP address. Wireless Wizard The Wireless Wizard link launches a wizard that is used to “teach” a Wi-Fi ConnectPort X2e ZB device the wireless parameters needed to further configure wireless settings and operation.The wizard provides a place to copy in the information required for the to connect to your local WiFi network.
  • Page 38 The Python Autostart Configuration page configures the automatic starting of Python programs that are loaded on the ConnectPort X2e ZB device. See "File management" on page 48 for details on loading files. These programs are executed through the specified “python” commands.

  • Page 39: Network Services

    The Time Configuration page configures the various Network Time Protocol (NTP) servers that the ConnectPort X2e ZB uses to obtain current date and time, and the time zone for the NTP server. The default settings for this feature are likely to be sufficient for many users.
  • Page 40 Connectivity The iDigi Connectivity page enables/disables the connection to the iDigi server used for managing the ConnectPort X2e ZB device, configures the iDigi server, and configures the proxy server, if used. iDigi Connectivity: Enables or disables the connection to the iDigi server.
  • Page 41 C o n f i g u r a t i o n f r o m t h e W e b i n t e r f a c e XBee Network The ConnectPort X2e ZB provides a gateway between an Internet Protocol (IP) network and a network of various wireless devices containing XBee RF modules. Typically, these XBee devices are small sensors and controllers.

  • Page 42: Configuration From Idigi Manager Pro

    The iDigi User’s Guide describes how to set up an iDigi account and add devices to the iDigi Manager Pro device list. Once your ConnectPort X2e ZB is added to the device list, you can view the device in the device list and access its configuration settings.

  • Page 43: Basic Configuration Settings

    C o n f i g u r a t i o n f r o m i D i g i M a n a g e r P r o Basic configuration settings In the iDigi Manager Pro interface, basic configuration settings for the ConnectPort X2e ZB are accessed by right-clicking the device in the device list and selecting Properties. The basic...

  • Page 44: Xbee Networks Page

    C o n f i g u r a t i o n f r o m i D i g i M a n a g e r P r o XBee Networks page Clicking the XBee Networks menu within the iDigi Manager Pro tab opens the XBee Networks page.

  • Page 45: Xbee Rf Module Settings

    C o n f i g u r a t i o n f r o m i D i g i M a n a g e r P r o XBee RF module settings The configuration information for an XBee node is displayed by opening its Properties page. To do this, either double-click on the node in the XBee Networks page, or right-click the node and select Properties or click the Properties toolbar button.

  • Page 46: Chapter 4: Administration/Maintenance

    Gateway operating system firmware update s Gateway operating system firmware updates for the ConnectPort X2e ZB can be downloaded from the Digi Support site. They can then be loaded through the web interface or iDigi Device Manager Pro. The gateway operating system can only be upgraded, not downgraded, through the web interface or iDigi Manager Pro.
  • Page 47 (OTA) firmware update. Download firmware update files from Digi There is only one firmware file for the XBee RF module in ConnectPort X2e ZB products. It is named XBP24-S2C_40XX.ebl, where XX is the firmware version.

  • Page 48: File Management

    C o m m o n a d m i n i s t r a t i v e t a s k s File management A file management feature is provided to manage custom applications, their associated data files, and other files.

  • Page 49: Administration From The Web Interface

    Browse button to choose the file on your PC that is the firmware update image. Then use the Upload file button to upload the XBee firmware file to the /userfs/WEB/mesh directory in ConnectPort X2e ZB filesystem. Select the appropriate firmware file from the File List, and then click the ...

  • Page 50: File Management

    Upload to Current Directory: Uploads files to the current directory. Use the Browse  button to find a file on your PC to be uploaded to the ConnectPort X2e ZB. Click Update file to begin the file upload process. File List: A listing of the “current directory” (as noted in the Volume Information ...

  • Page 51: Administration From Idigi Manager Pro

    Administration from iDigi Manager Pro In iDigi Manager Pro, administration tasks are organized in the right-click menu for the ConnectPort X2e ZB, under Administration and Firmware. The File Management task is launched from a link in the device Properties page.

  • Page 52: Restore Factory Defaults

    Firmware > Update Gateway XBee Radio Firmware updates the firmware on the XBee RF module on the ConnectPort X2e ZB. In the dialog, select an XBee radio firmware file to upload to the selected device or devices. Once the XBee radio firmware file is downloaded to the device, the device will be rebooted automatically.

  • Page 53: File Management

    ConnectPort X2e ZB and displays current information about loaded files. This page can also be used to download system log files from the ConnectPort X2e ZB to view for troubleshooting or other purposes. These log files are in the /WEB/logging folder. For a description of the ConnectPort filesystem layout, see page 67.

  • Page 54: System Log

    There is no browser interface for system logs in the iDigi interface. Instead, to view logs, use the File Management page to navigate to the directory WEB/logging in the ConnectPort X2e ZB filesystem, and access the log files digi.log, xbee.log, and python.log using the Download file...

  • Page 55: Chapter 5: Programming

    Programming The ConnectPort X2e ZB offers a variety of interfaces that produce and/or consume data. Developing software programs for ConnectPort X2e ZB products allows Digi customers to provide custom logic to control the flow information to and from these interfaces. This chapter introduces the Digi programming tools and resources available to you, and, using annotated example programs, introduces programming elements and operations available for the ConnectPort X2e ZB.

  • Page 56: Programming Resources

    ConnectPort X2e ZB, plus extensive documentation, tutorials, and code samples to help you get started developing custom applications for your product. Digi ESP for Python is built on Eclipse, an open, extensible IDE, and the Python Development Environment (Pydev) plug-in.
  • Page 57 P r o g r a m m i n g r e s o u r c e s Program samples in Digi ESP Digi ESP for Python provides samples to use as a base for programming the ConnectPort X2e ZB, including specific examples for exercising specific interfaces available on the ConnectPort X2e ZB.

  • Page 58: Programming Calls Through Server Command Interface (Sci) And Remote Command Interface (Rci)

    It collects data from any device that can communicate with a Digi gateway, and is supported over any gateway physical interface. iDigi Dia presents this data to upstream applications in fully customizable formats, significantly reducing a customer’s time to market.

  • Page 59: Digi Python Programmer's Guide

    Digi-specific behavior, and describes how to load and run Python programs onto Digi devices, and run sample Python programs. This guide is on the Digi Python Wiki; in the Start Here section, click the link titled Digi Python Programmer's Guide http://www.digi.com/wiki/developer/index.php/Digi_Python_Programmer%27s_Guide...

  • Page 60: Digi-Specific Python Modules For Programming

    D i g i - s p e c i f i c P y t h o n m o d u l e s f o r p r o g r a m m i n g Digi-specific Python modules for programming Several Digi-provided built-in modules apply to functionality in the ConnectPort X2e ZB. To learn more about these built-in modules, go to: http://www.digi.com/wiki/developer/index.php/ConnectPort_X2e...

  • Page 61: Sample Programs

    These simple annotated samples introduce several programmable features for the ConnectPort X2e ZB, including button handling, LED control, watchdog, RCI callback, and XBee functions. Button handling The following sample program demonstrates functions for handling the button on the ConnectPort X2e ZB. import select fd=open('/var/run/reset_button') p=select.poll() p.register(fd, select.POLLPRI)

  • Page 62: Led Control

    S a m p l e p r o g r a m s LED control Controlling the LEDs on the ConnectPort X2e ZB 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 63: Watchdog

    S a m p l e p r o g r a m s Watchdog The watchdog feature, provided through the watchdog module, exists as a safeguard. If there are critical operations that “must” happen periodically, or else the system will be irretrievably broken, an application can request that a “watchdog”...

  • Page 64: Rci Callback

    S a m p l e p r o g r a m s RCI callback An RCI callback involves two types of actions, demonstrated in the following programs: Making RCI requests from Python applications  Extending RCI to allow iDigi to make requests of Python applications. This is known as ...
  • Page 65 S a m p l e p r o g r a m s Make an RCI request-example program Following is a simple RCI callback example: import rci def cb(req): print "Received request: " + req r=rci.RciCallback() r.register_callback('test', cb) rci.process_request('<rci_request version="1.1"><do_command target="test"><customxml/></do_command></rci_request>') Program notes The rci module includes the RciCallback class needed by the program.

  • Page 66: Xbee Functions

    S a m p l e p r o g r a m s XBee functions For a description of the xbee module and program samples, see this Wiki page: http://www.digi.com/wiki/developer/index.php/Module:zigbee...

  • Page 67: The Connectport X2E Zb Filesystem

    T h e C o n n e c t P o r t X 2 e Z B f i l e s y s t e m The ConnectPort X2e ZB filesystem The ConnectPort X2e ZB has a Linux-based filesystem. This section gives an overview of the key directories of the filesystem and common operations performed on directories and files.

  • Page 68: The Linux Command Shell (Command-Line Interface)

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

  • Page 69: Chapter 6: Troubleshooting

    ConnectPort X2e ZB product. System logs The ConnectPort X2e ZB supports continuous logging to enable debugging. The log files are available for upload through the web interface or by pulling the files from the iDigi interface. They are stored in the Linux filesystem in the /WEB/logging directory. Log files in this directory include: digi.log...

  • Page 70: Troubleshooting Chart

    Network LED is flashing yellow DHCP server not responding. If no DHCP server is present on the faster than twice per second. network, use a tool with integrated Digi Device Discovery to assign a static IP address. Device may not have network connectivity to the DHCP server, despite having link to a hub or switch.
  • Page 71 T r o u b l e s h o o t i n g c h a r t Symptom Potential Cause Resolution Network LED alternates between Unable to resolve iDigi server Verify DNS server settings with network yellow and green name.

  • Page 72: Cannot Connect To Dns Server To Resolve The Idigi Server Address

    Cannot connect to NTP time server to get correct time The ConnectPort X2e ZB requires access to an NTP server to set its date and time. Normally the device receives the date and time automatically from the iDigi server.

Table of Contents