Digi Connectport X5 User Manual
ConnectPort® X5 Family
User’s Guide
ConnectPort X5 R
ConnectPort X5 Kit
ConnectPort X5 R CDMA
ConnectPort X5 R CDMA Kit
ConnectPort X5 R Iridium
ConnectPort X5 R Iridium Kit
ConnectPort X5 Fleet
®
90001100_H
©Digi International Inc. 2013. All Rights Reserved.
The Digi logo, Digi Connect, Device Cloud, ConnectPort, Digi SureLink, Digi Dialserv, Etherios,
the Etherios logo, the Etherios website, Device Cloud by Etherios, Dev ice Manager, DIA,
RealPort, and XBee are trademarks or registered trademarks of Digi International, Inc.
All other trademarks mentioned in this document are the property of their respective owners.
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. Digi may make improvements and/or changes in this manual or in the product(s) and/or
the program(s) described in this manual at any time.
This product could include technical inaccuracies or typographical errors. Changes are periodically
made to the information herein; these changes may be incorporated in new editions of the
publication.
2
Contents
Contents
Contents..............................................................................................................................................................................3
About this guide.................................................................................................................................................................7
Purpose.......................................................................................................................................................................7
Audience.....................................................................................................................................................................7
Scope..........................................................................................................................................................................7
Where to find more information.................................................................................................................................7
Digi contact information ............................................................................................................................................8
Chapter 1: Introduction...........................................................................................................................................................9
Important Safety Information . ....................................................................................................................................9
ConnectPort® X5 Family products..........................................................................................................................10
Features ....................................................................................................................................................................12
User interfaces................................................................................................................................................12
Configurable network services.......................................................................................................................12
IP protocol support .........................................................................................................................................13
Mobile/Cellular features and protocol support...............................................................................................17
RealPort software............................................................................................................................................18
Alarms.............................................................................................................................................................19
Modem emulation...........................................................................................................................................19
Security features in Digi devices....................................................................................................................20
Configuration management .......................................................................... ..................................................21
Customization capabilities..............................................................................................................................21
Supported connections and data paths in Digi devices............................................................................................22
Network services ............................................................................................................................................22
Network/serial clients........................ .... ............................................... .... .... ..................................................24
Interfaces for configuring, monitoring, and administering Digi devices.................................................................25
Configuration capabilities...............................................................................................................................25
Configuration interfaces ............................................................... .... ..............................................................26
Device Manager™ interface...........................................................................................................................28
Monitoring capabilities and interfaces............................................................................................................34
Device administration.....................................................................................................................................35
Chapter 2: Hardware .............................................................................................................................................................36
ConnectPort X5 R and ConnectPort X5 Kit hardware summary.............................................................................37
ConnectPort X5 R models............................................ .... ............................................... ...............................38
ConnectPort X5 development kit models.......................................................................................................38
ConnectPort X5 Fleet hardware summary...............................................................................................................39
3
Contents
Interfaces and Wiring Harness guidelines................................................................................................................40
ConnectPort X5 Wiring Harness Connector................................................. ..................................................41
Available interfaces on the Wiring Harness...................................................................................................44
Antennas...................................................................................................................................................................47
ConnectPort X5 R antennas..................................................................................... .......................................47
ConnectPort X5 R CDMA antennas...............................................................................................................48
ConnectPort X5 Iridium antennas ..................................................................................................................49
ConnectPort X5 Fleet antennas ......................................................................................................................49
Certified antennas and specifications.............................................................................................................50
SIM card installation................................................................................................................................................53
Mounting the ConnectPort X5 to a vehicle..............................................................................................................54
ConnectPort X5 R and X5 Iridium.................................................................................................................54
ConnectPort X5 Fleet .....................................................................................................................................55
Satellite setup ...........................................................................................................................................................56
ConnectPort X5 R Iridium..............................................................................................................................56
ConnectPort X5 ORBCOMM-equipped models............................................................................................56
Chapter 3: Configuration.......................................................................................................................................................57
IP address assignment ..............................................................................................................................................58
Default IP address and DHCP settings...........................................................................................................58
Alternative methods of assigning IP addresses ..............................................................................................58
Configure an IP address using DHCP ............................................................................................................58
Configure an IP address using Auto-IP..........................................................................................................59
Test the IP address configuration ...................................................................................................................59
Configuration through Device Manager ........................................................................... .... .... ...............................60
Device Cloud device management through Short Message Service (SMS) commands................................60
Configuration through the web interface .................................................................................................................61
Open the web interface...................................................................................................................................61
Organization of the web interface...................................................................................................................63
Change the IP address from the web interface, as needed..............................................................................65
Network configuration settings.......................................................................................................................66
Mobile (cellular) settings..............................................................................................................................112
XBee network settings..................................................................................................................................137
Serial port settings ........................................................................................................................................151
Alarms...........................................................................................................................................................160
System settings .............................................................................................................................................164
Device Cloud settings...................................................................................................................................172
Users settings................................................................................................................................................181
Position - GPS support.................................................. .... ............................................... .... .........................189
Applications..................................................................................................................................................191
Configuration through the command line..............................................................................................................197
4
Contents
Access the command line .............................................................................................................................197
Verify device support of commands.............................................................................................................197
Examples of configuration commands .........................................................................................................198
Configuration through Simple Network Management Protocol (SNMP)................................................. .... ... ......200
Batch capabilities for configuring multiple devices...............................................................................................200
Chapter 4: Monitoring and management...........................................................................................................................201
Monitoring capabilities from Device Manager.................. ............................................... .....................................202
Monitoring capabilities in the web interface..........................................................................................................203
Display system information..........................................................................................................................203
Manage connections and services.................................................................................................................221
Monitoring capabilities from the command line....................................................................................................225
Commands for displaying device information and statistics........................................................................225
Commands for managing connections and sessions.....................................................................................227
Commands for managing XBee networks and nodes...................................................................................228
Monitoring Capabilities from SNMP.....................................................................................................................229
Chapter 5: Device administration.......................................................................................................................................230
Administration from the web interface ..................................................................................................................230
File management...........................................................................................................................................231
X.509 Certificate/Key Management.............................................................................................................232
Backup/restore device configurations...........................................................................................................244
Update firmware and Boot/POST Code.......................................................................................................245
Restore a device configuration to factory defaults.......................................................................................246
Display system information..........................................................................................................................247
Reboot the Digi device .................................................................................................................................247
Enable/disable access to network services ...................................................................................................247
Administration from the command-line interface..................................................................................................248
Chapter 6: Programming.....................................................................................................................................................249
General programming tools and resources .............................................................................................................250
Digi Developer Community Wiki ................................................................................................................250
Digi Python Custom Development Environment page ................................................................................250
Digi Python Programmer’s Guide................................................................................................................250
Python Support Forum on digi.com.............................................. .... .... ........................................................250
DIA...............................................................................................................................................................251
Device Manager............................................................................................................................................251
The Digi API for vehicle bus programming...........................................................................................................252
Vehicle bus protocol specifications..............................................................................................................252
Vehicle bus protocols supported in the Digi API..................................... .... ................................................253
Digi built-in modules for vehicle bus programming ....................................................................................254
5
Contents
The SAE J1708 bus protocol API.................................................................................................................255
The SAE J1587 bus protocol API.................................................................................................................258
The CAN bus protocol..................................................................................................................................261
The SAE J1939 bus protocol........................................................................................................................265
Additional programming samples and demos ..............................................................................................267
The Digi API for satellite communication via the Iridium® network...................................................................268
Working with the Iridium network: general notes........................................................................................268
Digi built-in modules for Iridium programming ..........................................................................................268
The Iridium network: SBD transmission......................................................................................................269
The Iridium network: SBD reception...........................................................................................................270
Example Python program.............................................................................................................................272
Additional programming examples and information....................................................................................274
Internal sensor programming .................................................................................................................................274
Power consumption and management ...................................................................................................................275
External power control device......................................................................................................................275
Sleep mode and waking................................................................................................................................275
Power control for satellite modems..............................................................................................................276
Reading data from XBee Drop-in Networking Accessories..................................................................................276
Chapter 7: Specifications and certifications.......................................................................................................................277
Hardware specifications.............................. .... .... ............................................... .... ... .............................................277
ConnectPort X5 R and ConnectPort X5 Kit specifications..........................................................................278
ConnectPort X5 Fleet specifications ............................................................................................................279
Wireless networking features.................................................................................................................................280
Regulatory information and certifications..............................................................................................................282
RF exposure statement..................................................................................................................................282
FCC certifications and regulatory information (USA only).........................................................................282
Industry Canada (IC) certifications ..............................................................................................................284
Safety statements..........................................................................................................................................285
International EMC (Electromagnetic Emissions/Immunity/Safety) standards.............................................286
Environmental requirements for ConnectPort X5 Family products.............................................................287
Chapter 8: Troubleshooting.................................................................................................................................................288
Troubleshooting Resources....................................................................................... .............................................288
System status LEDs................................................................................................................................................289
ConnectPort X5 R LEDs ................................................................................. .... .........................................289
ConnectPort X5 R Iridium LEDs .................................................................................................................289
6
Purpose
About this guide
Purpose
This guide describes and shows how to install, provision, configure, monitor, and administer Digi devices.
Audience
This guide is intended for those responsible for setting up Digi devices. It assumes some familiarity with networking
concepts and protocols.
Scope
This guide focuses on configuration, monitoring, and administration of Digi devices. It does not cover hardware details
beyond a certain level, application development, or customization of Digi devices.
Where to find more information
In addition to this guide, find additional product and feature information in the these documents:
Online help and tutorials in the web interface for the Digi device
Quick Start Guides
RealPort
Cellular 101 Tutorial
Digi Connect Family Customization and Integration Guide
Device Cloud
Release Notes
Cabling Guides
Product information available on the Digi website, www.digi.com, and Digi's support site at www.digi.com/
support, including, Support Forums, Knowledge Base, Data sheet s /product briefs, application/solution
guides, and carrier-specific documents
®
Installation Guide
®
tutorials and user’s guides
Digi Wiki for Developers
7
Digi contact information
Digi contact information
For more information about Digi products, or for customer service and technical support, contact Digi International.
To Contact Digi International by: Use:
Mail Digi International
11001 Bren Road East
Minnetonka, MN 55343
U.S.A.
World Wide Web: http://www.digi.com/support/
email Look for the link Contact Digi Support at this address:
http://www.digi.com/support/
Telephone (U.S.) (952) 912-3444 or (877) 912-3444
Telephone (other locations) +1 (952) 912-3444 or (877) 912-3444
8
Introduction
CHAPTER 1
This chapter introduces Digi devices and their product families, types of connections and data
paths in which Digi devices can be used, and the interface options available for configuring,
monitoring, and administering Digi devices.
Important Safety Information
To avoid contact with electrical current:
Important Safety Information
Never install electrical wiring during an electrical storm.
Never install an Ethernet connection in wet locations unless that connec to r is
specifically designed for wet locations.
Use caution when installing or modifying lines.
Use a screwdriver and other tools with insulated handles.
Wear safety glasses or goggles.
Do not place Ethernet wiring or connections in any conduit, outlet or junction box
containing electrical wiring.
Installation of inside wire may bring you close to electrical wire, conduit, terminals and
other electrical facilities. Extreme caution must be used to avoid electrical shock from
such facilities. Avoid contact with all such facilities.
Ethernet wiring must be at least 6 feet from bare power wiring or lightning rods and
associated wires, and at least 6 inches from other wire (antenna wires, doorbell wires,
wires from transformers to neon signs), steam or hot water pipes, and heating ducts.
Do not place an Ethernet connection where it would allow a person to use an Ethernet
device while in a bathtub, shower, swimming pool, or similar hazardous location.
Protectors and grounding wire placed by the service provider must not be connected to,
removed, or modified by the customer.
Do not touch uninsulated Ethernet wiring if lightning is likely!
External W iri ng : Any external communications wiring installed n eeds to b e constructe d
to all relevant electrical codes. In the United States this is the National Electrical Code
Article 800. Contact a licensed electrician for details.
9
ConnectPort® X5 Family products
ConnectPort® X5 Family products
The ConnectPort X5 Family offers compact, ruggedized telematics gateways for cost-effective
fleet management and asset tracking solutions. These gateways provide remote connectivity to
mobile assets to monitor operating health, performance, location and driver/operator behavior, as
well as to enable automated event reporting. They aggregate wireless vehicle Personal Area
Network (VPAN) traf fic, such a s ZigBee and 802.15.4 p oint-to-multipoint, fo r IP connectivity over
a secure cellular, Wi-Fi, or satellite connection in harsh environments.
Gateways in the ConnectPort X5 family include the ConnectPort X5 R, ConnectPort X5 Kit, and
ConnectPort X5 Fleet. The ConnectPort X5 Kit was designed as a development kit to be used for
testing and evaluation prior to deployment of the ConnectPort X5 R or ConnectPort X5 Fleet. The
ConnectPort X5 Kit comes with a development cable, antennas, and, for GSM versions, has an
opening in the enclosure to allow users to insert their own SIM card. As such, the
ConnectPort X5 Kit should be used for testing and evaluation only. Customers will be responsible
for procuring antennas and cabling for their specific ConnectPort X5 R and ConnectPort X5 Fleet
installations.
10
ConnectPort® X5 Family products
These gateways support vehicle personal area networks with Digi’s industry-leading XBee radio
technology. Vehicle personal area networks (VPANs) allow users to deploy low-power sensor
networks within and around the vehicle or mobile asset to monitor additio nal asset points, for
example, tires, reefer units, door latch, temperature sensors, cargo sensors, RFID readers, etc.
The ConnectPort X5 family provides flexible wide-area networking connectivity supporting
cellular, Wi-Fi, and satellite communications. Cellular connectivity provides instant, always-on
communications, while Wi-Fi provides a cost-effective way to transfer lar ge files, firmware, or logs
across low-cost private Wi-Fi networks. The ConnectPort X5 Wi-Fi feature can also be used to
network in-vehicle or near-vehicle Wi-Fi-enabled devices, such as vehicle displays and handheld
mobile devices.
Features and benefits of the ConnectPort X5 gateway family include:
For units without external SIM card access, factory-sealed IP67 enclosure, ensuring
protection from dust and total water immersion to 1 meter
For units with external SIM card access, factory-sealed IP67 enclosure, ensuring
protection from dust and immersion.
J1708 protocol support, offering serial connectivity to a large installed base of heavy
duty vehicle fleets
Controller Area Network (CAN) interface support for connection to J1939 or
proprietary vehicle bus
Internal temperature sensor and accelerometer
Advanced power management, including sensitivity to ignition status
Location tracking and geofencing with on-board GPS
Global cellular coverage over GSM/GPRS or CDMA networks
Optional satellite on selected ConnectPort X5 R and ConnectPort X5 Fleet models
Programmable for application development through the Python
®
programming
language, Device Cloud Device Integration Application (DIA) framework and the
Device Cloud services platform
Automated event reporting: the gateway can continuou sly transmit v ehicle statu s at user -
defined intervals
Device Manager™ for management and monitoring
11
Features
User interfaces
Features
This is an overview of key features in Digi devices. Firmware features are covered in more detail in
the next three chapters. Hardware specifications are covered in Chapter 7, "Specifications and
certifications"
There are several user interfaces for configuring and monitoring Digi devices, including the
following.
Device Manager™
A web-based interface for configuring, monitoring, and administer ing Digi devices.
Plugging the ConnectPort X5 device into a switch or network to which a laptop
computer is connected all o ws direct access to the web interface for configuration.
A command-line interface available via local serial port, telnet or SSH.
Simple Network Management Protocol (SNMP).
Configurable network services
Access to network services can be enabled and di sabled. This mea ns that a dev ice’s use of network
services can be restricted to those strictly needed by the device. To improve device security, nonsecure services can be disabled. Network services that can be enabled or disabled include:
Advanced Digi Discovery Protocol (ADDP): can enable or disable ADDP, but cannot
change its network port number.
RealPort
Encrypted RealPort
HTTP/HTTPS
Remote Login (rlogin)
Remote Shell (rsh)
Simple Network Management Protocol (SNMP)
Telnet
In the web interface, access to network services is enabled and disabled on the Network Services
page of Network Configuration. For more informati on, see "Network services settin gs" on page 78.
In the command-line interface, network services are enabled and disabled through the set service
command. See the Digi Connect Family Command Reference for the set service command
description.
12
IP protocol support
All Digi devices include a Robust on-board TCP/IP stack with a built-in web server. Supported
protocols include, unless otherwise noted:
Transmission Control Protocol (TCP)
User Datagram Protocol (UDP)
Dynamic Host Configuration Protocol (DHCP)
Simple Network Management Protocol (SNMP)
Secure Sockets Layer (SSL)/Transport Layer Security (TLS)
Telnet Com Port Control Option (Telnet) including support of RFC 2217 (ability to
Remote Login (rlogin)
Line Printer Daemon (LPD)
HyperText Transfer Protocol (HTTP)/HyperText Transfer Protocol over Secure Socket
Features
control serial port through Telnet). See "Serial data communication over TCP and UDP"
on page 14 for additional information.
Layer (HTTPS)
Simple Mail Transfer Protocol (SMTP)
Internet Control Message Protocol (ICMP)
Internet Group Management Protocol (IGMP)
Address Resolution Protocol (ARP)
Advanced Digi Discovery Protocol (ADDP)
Point to Point Protocol (PPP)
Network Address Translation (NAT)/Port Forwarding
Secure Shell (SSHv2)
Generic Routing Encapsulation (GRE) Passthrough
IPSec Encapsulating Security Payload (ESP) on most models
ESP Passthrough
Following is an overview of some of the services provided by these protocols.
13
Serial data communication over TCP and UDP
Digi devices support serial data communication over TCP and UDP. Key features include:
Serial data communication over TCP, also known as autoconnect and tcpserial can
automatically perform the following functions:
– Establish bidirectional TCP connections, known as autoconnections, between the serial
device and a server or other network device. Autoconnections can be made based on
data and or serial hardware signals.
– Control forwarding characteristics based on size, time, and pattern
– Allow incoming raw, Telnet, and SSL/TLS (secure-socket) connections
– Support RFC 2217, an extension of the Telnet protocol
Serial data communication over UDP, also known as udpserial, can automatically
perform the following functions:
– Digi Connect products can automatically send serial data to one or more devices or
systems on the network using UDP sockets. Options for sending data include whether
specific data is on the serial line, a specific t ime period has elapsed, or after the specified
number of bytes has been received on the serial port.
– Control forwarding characteristics based on size, time, and patterns.
Features
– Support incoming datagrams from multiple destinations.
– Support outgoing datagrams sent to multiple dest inations.
TCP/UDP forwarding characteristics.
Extended communication control on TCP/UDP data paths.
–Timeout
–Hangup
– User-configurable Socket ID string (text string identifier on autoconnect only)
Dynamic Host Configuration Protocol (DHCP)
Dynamic Host Configuration Protocol (DHCP) can be used to automatically assign IP addresses,
deliver TCP/IP stack configuration parameters such as the subnet mask and default router, and
provide other configuration information. For further details, see "Configure an IP address using
DHCP" on page 58.
Auto-IP
Auto-IP is a protocol that will automatically assign an IP address from a reserved pool of standard
Auto-IP addresses to the computer on which it is installed. For Digi devices are set to obtain its IP
address automatically from a DHCP server and the DHCP server is unavailable or nonexistent,
Auto-IP will assign the device an IP address. For further details, see "Configure an IP address using
Auto-IP" on page 59.
14
Simple Network Management Protocol (SNMP)
Simple Network Management Protocol (SNMP) is a protocol for managing and monitoring
network devices. SNMP architecture enables a network administrator to manage nodes--servers,
workstations, routers, switches, hubs, etc.--on an IP network; manage network performance, find
and solve network problems, and plan for network growth. Digi devices support SNMP Versions 1
and 2. For more information on SNMP as a device-management interface, see "Simple Network
Management Protocol (SNMP)" on page 33. For a list SNMP-related of supp orted Request for
Comments (RFCs) and Management Information Bases (MIBs), see page 168.
Secure Sockets Layer (SSL)/Transport Layer Security (TLS)
Secure Sockets Layer (SSL)/Transport Layer Security (TLS) are used to provide authentication and
encryption for Digi devices. For more information, see "Security features in Digi dev ice s" on page
20.
Telnet
Digi devices support the following types of Telnet connections:
Features
Telnet Client
Telnet Server
Reverse Telnet, often used for console management or device management
Telnet Autoconnect
RFC 2217, Telnet Com Port Control Option, an extension of the Telnet protocol
For more information on these connections, see "Supported connections and data paths in Digi
devices" on page 22. Access to Telnet network services can be enabled or disabled.
Remote Login (rlogin)
Users can perform logins to remote systems (rlogin). Access to rlogin service can be enabled or
disabled.
HyperText Transfer Protocol (HTTP) HyperText Transfer Protocol over Secure Socket Layer (HTTPS)
Digi devices provide web pages for configuration that can be secured by requiring a user login.
Internet Control Message Protocol (ICMP)
ICMP statistics can be displayed, including the number of messages received, bad messages
received, and destination unreachable messages received.
15
Point-to-Point Protocol (PPP)
The Point-to-Point Protocol (PPP) transports multi-protocol packets over point-to-point links. PPP
encapsulates the data packet, allows the server to inform the dial-up client of its IP address (or
client to request the IP address), authenticates the exchange, negotiates multiple protocols, and
reassembles the data packet for network communication. ConnectPort X5 Family devices support
PPP as the connection protocol from the Digi device to th e cellular IP network with NAT (Network
Address Technology).
Network Address Translation (NAT)/Port Forwarding
Network Address Translation (NAT) reduces the need for a large amount of publicly known IP
addresses by creating a separation between publicly known and privately known IP addresses.
Advanced Digi Discovery Protocol (ADDP)
The Advanced Digi Discovery Protocol (ADDP) runs on any operating system capable of sending
multicast IP packets on a network. ADDP allows the system to identify all ADDP-enabled Digi
devices attached to a network by sending out a multicast packet. The Digi devices respond to the
multicast packet and identify themselves to the client sending the multicast.
Features
ADDP communicates with the TCP/IP stack using UDP. The TCP/IP stack should be able to
receive multicast packets and transmit datagrams on a network.
Not all Digi devices support ADDP. Access to ADDP service can be enabled or disabled, but the
network port number for ADDP cannot be changed from its default.
Generic Routing Encapsulation (GRE) Passthrough Encapsulating Security Payload (ESP) ESP Passthrough
Generic Routing Encapsulation (GRE) and Encapsulating Security Payload (ESP) are routing
protocols that are used to route (tunnel) various types of informat ion between networks.
GRE applies to the encapsulation of IP datagrams t unnelled through the interne t. The encapsulation
includes security , typically in the form of IPSec (IP security), and is most commonly fo und in VPN
(Virtual Private Network) implementation. RFC (Request For Comment) 1701 and 1702 define
these standards.Similarly, ESP is used in conjunction with IPsec as a possible way of carrying IP
packets for a Virtual Private Network (VPN) setup. ESP is defined in RFC 2406.
In ESP Passthrough and GRE Passthrough, inbound IPsec ESP or GSP prot ocol traffic is
forwarded from to a VPN device connected to the Digi device’s Ethernet port.
Note: If an Auto-key Internet Key Exchange (IKE)-based VPN is used, UDP port 500 must also be
forwarded.
16
Mobile/Cellular features and protocol support
Key cellular features in cellular-enabled Digi devices include:
GSM: GPRS, EDGE, SMS
CDMA: 1xRTT, Ev -DO (Revs 0 and A)
IPSec ESP / IKE
IP Pass-through, also known as bridge mode
3-5 Volt SIM card
Signal-strength LEDs
Provisioning wizard
For Digi devices equipped with a Code-Divisi on Multipl e Access (CDMA)-based cellular mode m,
the Mobile Device Provisioning Wizard is available in the web interface to properly configure the
Digi device with the required configuration used to access the mobile network. The wizard allows
for both automatic and manual provisioning for a variety of mobile service providers.
Features
Digi SureLink™
Digi Connect Family, Digi Cellular Family, and ConnectPort X Family products support the Digi
SureLink™ feature. Digi SureLink provides an “always-on” mobile network connect io n t o ensure
that a Digi device is in a state where it can connect to the network. It does this through hardware
reset thresholds and periodic tests of the connection.
Mobile/Cellular protocols
Mobile/cellular protocols supported include, unless otherwise noted:
Global System for Mobile communication (GSM)
General Packet Radio Service (GPRS)
Enhanced Data Rates for GSM Evolution (EDGE)
Universal Mobile Telecommunications Service (UMTS)
High Speed Packet Access (HSPA)
Code-Division Multiple Access (CDMA)
Evolution-Data Optimized (EV-DO, EVDO, or 1xEV-DO)
Short Message Service (SMS), currently for GSM cellular products only. Digi cellular
gateways implement an SMS-based protocol that allows managing devices by sending
SMS commands from anywhere SMS messages can be sent. See "Short Message
Service (SMS) settings" on page 126.
Wi-MAX
17
RealPort software
Digi devices use the patented RealPort COM/TTY port redirection for Microso ft Windows.
RealPort software provides a virtual connection to serial devices, no matter where they reside on
the network. The software is installed directly on the host PC and allows applications to talk to
devices across a network as though the devices were directly attached to the host. Actually, the
devices are connected to a Digi device somewhere on the network. RealPort is un ique among COM
port re-directors because it is the only implementation that allo ws multiple co nnectio ns to multiple
ports over a single TCP/IP connection. Other implementations require a separate TCP/IP
connection for each serial port. Unique features also include full hardware and software flow
control, as well as tunable latency and throughput. Access to RealPort services can be enabled or
disabled.
Encrypted RealPort
Digi devices also support RealPort software with encryption. Encrypted RealPort offers a secure
Ethernet connection between the COM or TTY port and a device server or terminal server.
Encryption prevents internal and external snooping of data across the network by encapsulating the
TCP/IP packets in a Secure Sockets Layer (SSL) connection and encrypting the data using
Advanced Encryption Standard (AES), one of the latest, most efficient security algorithms. Access
to Encrypted RealPort services can be enabled or disabled. Digi’s RealPort with encryption driver
has earned Microsoft’s Windows Hardware Quality Lab (WHQL) certification. Drivers are
available for a wide range of operating systems, including Microsoft Windows Server 2003,
Windows XP, Windows 2000, Windows NT, Windows 98, Windows ME; SCO Open Server;
Linux; AIX; Sun Solaris SPARC; Intel; and HP-UX. It is ideal for financial, retail/point-of-sale,
government or any application requiring enhanced security to protect sensitive information.
Features
18
Alarms
Digi devices can be configured to issue alarms, in the form of email message or SNMP traps, when
certain device events occur. These events include changes in GPIO signals, certain data patterns
being detected in the data stream, and cellular alarms for signal strength and amount of cellular
traffic for a given period of time. Receiving alarms about these conditions provides the advantage
of notifications being issued when events occur, rather than having to monitor the device on an
ongoing basis to determine whether these events have occurred. Alarms can also be forwarded to
Device Manager for display and management in that platform. For more information on
configuring alarms, see "Alarms" on page 160.
Modem emulation
Digi devices include a configuration profile that allows the device to emulate a modem. Modem
emulation sends and receives modem responses to a serial de vic e o ver TCP/IP (in clu di ng Eth erne t
and Cellular) instead of Public Switched Telephone Network (PSTN). The modem emulation
profile allows maintaining a current software application but using it over the less expensive
Ethernet network. In addition, Telnet processing can be enabled or disabled on the incoming and
outgoing modem-emulation connections.The modem-emulation commands supported in Digi
devices are documented in the Digi Connect Family Command Reference.
Features
19
Security features in Digi devices
Secure access and authentication
One password, one permission level.
Passwords can be issued to device users.
Selective enabling/disabling network services such as ADDP, RealPort, Encrypted
RealPort, HTTP/HTTPS, LPD, Remote Login, Remote Shell, SNMP, and Telnet.
Can control access to inbound ports.
Can control access to specific devices, IP addresses, or networks through IP filtering.
Secure sites for configuration: HTML pages for configuration have appropriate security.
Encryption
Encrypted RealPort offers encryption for the Ethernet connection between the COM/
TTY port and the Digi device. Encryption prevents internal and external snooping of
data across the network by encapsulating the TCP/IP packets in a Secure Sockets Layer
(SSL) connection and encrypting the data using the Advanced Encryption Standard
(AES) security algorithm.
Features
Strong Secure Sockets Layer (SSL) V3.0/ Transport Layer Security (TLS) V1.0-based
encryption: DES (64-bit), 3DES (192-bit), AES (128-/192-/256-bit), IPsec ESP: DES,
3DES, AES.
Wireless Digi Connect products provide Wi-Fi Protected Access (WPA/WPA2/802.11i)
and Wired Equivalent Privacy (WEP) encryption (64-/128-bit). Supported WPA/WPA2/
802.11i authentication methods are:
Supported WPA authentication methods
EAP-TLS PEAP EAP/TTLS
LEAP
(WEP only)
EAP-PEAP/MSCHAPv2 (both PEAPv0 and
PEAPv1)
EAP-PEAP/TLS (both PEAPv0 and PEAPv1)
EAP-PEAP/GTC (both PEAPv0 and PEAPv1)
EAP-PEAP/OTP (both PEAPv0 and PEAPv1)
EAP-PEAP/MD5-Challenge (both PEAPv0 and
PEAPv1)
EAP-TTLS/EAP-MD5-Challenge
EAP-TTLS/EAP-GTC
EAP-TTLS/EAP-OTP
EAP-TTLS/EAP-MSCHAPv2
EAP-TTLS/EAP-TLS
EAP-TTLS/MSCHAPv2
EAP-TTLS/MSCHAP
EAP-TTLS/PAP
20
EAP-TTLS/CHAP
SNMP security
SNMP “set” commands can be disabled to make use of SNMP read-only. Changing public and
private community names is recommended to prevent unauthorized access to the device.
Configuration management
Once a Digi device is configured and running, configuration-management tasks need to be
periodically performed, such as:
Upgrading firmware
Copying configurations to and from a remote host
Software and factory resets
Rebooting the device
Memory management
File management
For more information on these configuration-management tasks, see Chapter 5, "Device
administration".
Features
Customization capabilities
Several aspects of using Digi devices can be customized. For example:
The look-and-feel of the device interface can be customized , to use a different company
logo or screen colors.
Custom applications written in Python can be executed.
Custom factory defaults to which devices can be reverted can be defined.
The Digi Connect Family Customization and Integration Guide (Part Number 90000734; available
with the Digi Connect Integration Kit) describes customization and integration tools and processes.
Contact Digi International for more informatio n on the Digi Con nect Integratio n Kit customizatio n
tools and resources and for assistance with customization efforts.
21
Supported connections and data paths in Digi devices
Supported connections and data paths in Digi devices
Digi devices allow for several kinds of connections and paths for data flow between the Digi device
and other entities. These connections can be grouped into two main categories:
Network services, in which a remote entity initiates a connection to a Digi device.
Network/serial clients, in which a Digi device initiates a network connect ion or opens a
serial port for communication.
This discussion of connections and data paths may be helpful in understanding the effects of
enabling certain features and choosing certain settings when configuring Digi products.
Network services
A network service connection is one in which a remote entity initiates a connection to a Digi
device. There are several categories of network services:
Network services associated with specific serial ports
Network services associated with serial ports in general
Network services associated with the command-line interface (CLI)
Network services associated with specific serial ports
Reverse Telnet: A telnet connection is made to a Digi device, in which data is passed
transparently between the telnet connection and a named serial port.
Reverse raw socket: A raw TCP socket connection is made to a Digi device, in which
data is passed transparently between the socket and a named serial port.
Reverse TLS socket: An encrypted raw TCP socket is made to a Digi device, in which
data is passed transparently to and from a named serial port.
Modem emulation, also known as Pseudo-modem (pmodem): A TCP connection is
made to a named serial port, and the connection will be “interpreted” as an incoming call
to the pseudo-modem.
22
Supported connections and data paths in Digi devices
Network services associated with serial ports in general
RealPort: A single TCP connection manages (potentially) multiple serial ports.
Modem emulation, also known as pseudo-modem (pool): A TCP connection to the
“pool” port is interpreted as an incoming call to an available pseudo-modem in the
“pool” of available port numbers.
rsh: Digi devices support a limited imp lementation of t he Remote shell (rsh) protocol, in
that a single service listens to connections and allows a command to be executed. Only
one class of commands is allowed: a single integer that specifies which serial port to
connect to. Otherwise, the resultin g connection is somewhat simi lar to a reverse telne t or
reverse socket connection.
DialServ: Connecting a DialServ device to the serial port. DialServ simulates a public
switched telephone network (PSTN) to a modem and forwards the data to the serial port.
The Digi device sends and receives the data over an IP network.
Network services associated with the command-line interface
Telnet: A user can Telnet directly to a Digi device’s command-line interface.
rlogin: A user can perform a remote login (rlogin) to a Digi device’s command-line
interface.
23
Supported connections and data paths in Digi devices
Network/serial clients
A network/serial client connection is one in which a Digi device initiates a network connection or
opens a serial port for communication. There are several cat egories of network/serial client
connections:
Autoconnect behavior client connections
Command-line interface (CLI)-based clients
Modem emulation (pseudo-modem) client connections
Autoconnect behavior client connections
In client connections that involve autoconnect behaviors, a Digi device initiates a network
connection based on timing, serial activity, or serial modem signals. Autoconnect-related client
connections include:
Raw TCP connection: The Digi device initiates a raw TCP socket connection to a
remote entity.
T elnet connection: The Digi device init iates a TCP connecti on using the Telnet protocol
to a remote entity.
Raw TLS encrypted connection: The Digi device initiates an encrypted raw TCP
socket connection to a remote entity.
Rlogin connection: The Digi device initiates a TCP connection using the rlogin
protocol to a remote entity.
Command-line interface (CLI)-based client connections
Command-line interface based client connectio ns are available for use once a user has established a
session with the Digi device’s CLI. CLI-based client connections include:
telnet: A connection is made to a remote entity using the Telnet protocol.
rlogin: A connection is made to a remote entity using the Rlogin protocol.
connect: Begin communicating with a local serial port.
Modem emulation (pseudo-modem) client connections
When a port is in the modem-emulation or pseudo-modem mode, it can initiate network
connections based on AT command strings received on the serial port.The AT commands for
modem emulation are documented in the Digi Connect Family Command Reference.
24
Interfaces for configuring, monitoring, and administering Digi devices
Interfaces for configuring, monitoring, and administering Digi devices
There are several interfaces for configuring, monitoring, and administering Digi devices. These
interfaces are covered in more detail later in this guide.
Configuration capabilities
Device configuration involves setting values and enabling features for such areas as:
Network configuration: Specifying the device’s IP address settings, network-service
settings, and advanced network settings.
Mobile (cellular) configuration: Specifying the mobile service provider and mobile
connection settings for the device.
Alarms: Defining whether alarms should be issued, the conditions that trigger alarms,
and how the alarms should be delivered.
Security/Users configuration: Configuring security features, such as whether password
authentication is required for device users.
System configuration: Specifying system-identifying information, such as a device
description, contact person, and physical location.
25
Interfaces for configuring, monitoring, and administering Digi devices
Configuration interfaces
Several interfaces are available for configuring Digi devices, including:
The Digi Device Discovery Utility, which locates Digi devices on a network, and allows
opening the web interface for the devices.
Device Manager, a configuration interface to fine-tune or monitor devices. Device
Manager cannot assign an IP address but it can change one.
A web-based interface embedded with the product, providing device configuration
profiles for quick serial-port configuration and other settings.
A command-line interface (CLI).
Remote Command-line Interface (RCI) protocol
Simple Network Management Protocol (SNMP).
26
Interfaces for configuring, monitoring, and administering Digi devices
Digi Device Discovery utility
The Digi Device Discovery utility locates Digi devices on a network and allows for opening the
web interface for discovered devices, configuring network settings, and rebooting the device. 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, for example:
Digi Device Discovery quickly locates Digi devices and basic device information, such as the
device’s address, firmware revision, and whether it has been configured. It runs on any operating
system that can send multicast IP packets to a network. It sends out a User Datagram Protocol
(UDP) multicast packet to all devices on the network. Devic es supporting ADDP reply to this UDP
multicast with their configuration information. Even devices that do not yet have an IP address
assigned or are misconfigured for the subnet can reply to the UDP multicast packet and be
displayed in device discovery results.
Not all Digi devices support ADDP. Note that Device discovery responses can be blocked by
personal firewalls, Virtual Private Network (VPN) software, and certain network equipment.
Firewalls will block UDP ports 2362 and 2363 that ADDP uses to discover devices.
Digi Device Discovery is available for downloading from the Digi Support site. After installation,
it is available from the Start menu. Access to the ADDP service can be enabled or disabled, but the
network port number for ADDP cannot be changed from its default. For more information on the
Digi Device Discovery utility, see page 61.
27
Interfaces for configuring, monitoring, and administering Digi devices
Device Manager™ interface
Device Manager is a software-as-a-service, delivering capabilities that empower IT, network
operations and customer support organizations to conquer the challenges of managing the vast
array of equipment in their device networks. As a network grows, the complexity of effectively
managing the network assets grows exponentially. Hosted on the Device Cloud by Etherios™,
Device Manager directly tackles and conquers the universal problems of a dynamic device
network:
Centralized control over large numbers of devices
Reducing service complexity
Maintaining high levels of security
Provisioning and decommissioning of equipment
Adding functionality to device net wo rk s
A feature of all Digi gateways, routers, devices and components, Device Manager provides a
robust suite of network management tool s with cent ra lized cont rol via t he De vice Man ager serv ice
module.
From the Device Manager interface, you can configure devices, remotely update device firmware,
upload and manage Python/DIA files, remotely reboot devices, reset devices to factory defaults,
backup/restore device configuration properties, import or export the device configuration
properties, track devices, monitor devices and connections.
With Device Manager, management of large populations of devices is made easy. Devices can be
tagged and grouped together enabling management tasks to groups of devices within a network
simultaneously . Furthermore, the Scheduled Operat ions feature allows device management tasks to
28
Interfaces for configuring, monitoring, and administering Digi devices
be automated and scheduled to run either on a one -time or a recurring ba sis, against a singl e device
or multiple devices. The Alarms capability of Device Manager facilitates monitoring the health of a
device network. For instance, should a device disconnect or stay connected for longer than a
specified period, an alarm fires and notification of the alarm can be sent via email in real-time.
Some things to note about using Device Manager:
Devices must be registered on Device Manager before they can be accessed via the
Device Cloud platform.
To minimize network traffic, Device Manager uses caching. As a result, device settings
can be out-of-sync between the device and the settings viewed on the Device Manager
console.
Device information can be refreshed on demand when the device is connected, and is
refreshed automatically when a device connects.
For more information on Device Manager as a remote device network management solution, see
these resources:
Device Cloud User’s Guide
Device Cloud Programming Guide
Device Cloud tutorials and other documents available on www.etherios.com/
devicecloud
29
We b i n terface
Interfaces for configuring, monitoring, and administering Digi devices
A web interface is provided as an easy way to configure and monitor Digi devices. Configurable
features are grouped into several categories. These categories vary by product ; examples include
Network, Serial Port, Alarms, and System. Most of the configurable features are arranged by most
basic settings on a page, with associated and advanced settings accessi ble from that page . Serial-port
configurations are classified into port profiles, or configuration scenarios that best represents the
environment in which the Digi device will be used. Selecting a particular port profile con figures the
serial port parameters that are needed. To access the web interface, enter the Digi device’s IP
address or host name in a browser’s URL window. The main menu of the web interface is
displayed. For more information, see "Configuration through the web interface" on page 61. The
web interface has a tutorial, accessed from the Home page, and on line help, accessed from the Help
link on each page. Not all settings provided by the command-line interface are displayed in the web
interface. However, the configuration settings in the web interface should be sufficient for most
users. If necessary, settings can be modified later from the command line.
30
Loading...