Sierra Raven XE User Manual

Raven XE for Sprint

User Guide

20080616

Rev 4.0

Preface

Important
Notice

Safety and
Hazards

Due to the nature of wireless communications, the transmission and reception of
data can never be guaranteed. Data may be delayed, corrupted (i.e., have errors)
or totally lost. Although significant delays or losses of data are rare when wireless
devices such as the Sierra Wireless AirLink Raven XE are used in a normal
manner with a well-constructed network, the Sierra Wireless AirLink Raven XE
should not be used in situations where failure to transmit or receive data could
result in personal hazard or risk to the user or any other party, including but not
limited to personal injury, death, or loss of property. Sierra Wireless accepts no
responsibility for damages of any kind resulting from delays or errors in data
transmitted or received using the Sierra Wireless AirLink Raven XE, or for failure
of the Sierra Wireless AirLink Raven XE to transmit or receive such data.

Do not operate the Sierra Wireless AirLink Raven XE in areas where blasting is in
progress, near medical or life support equipment, or near any equipment which
may be susceptible to any form of radio interference. In such areas, the Sierra
Wireless AirLink Raven XE MUST BE POWERED OFF. The Sierra Wireless
AirLink Raven XE can transmit signals that could interfere with this equipment.

Do not operate the Sierra Wireless AirLink Raven XE in any aircraft, whether the
aircraft is on the ground or in flight. In aircraft, the Sierra Wireless AirLink Raven
XE MUST BE POWERED OFF. When operating, the Sierra Wireless AirLink
Raven XE can transmit signals that could interfere with various onboard systems.

Note: Some airlines may permit the use of cellular phones while the aircraft is on the
ground and the door is open. Sierra Wireless AirLink Raven XE may be used at this time.

Limitation of
Liability

The driver or operator of any vehicle should not operate the Sierra Wireless
AirLink Raven XE while in control of a vehicle. Doing so will detract from the driver
or operator's control and operation of that vehicle. In some states and provinces,
operating such communications devices while in control of a vehicle is an offense.

The information in this manual is subject to change without notice and does not
represent a commitment on the part of Sierra Wireless. SIERRA WIRELESS AND
ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL
DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL,
PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO,
LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR REVENUE
ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS
PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE
FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.

Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its
affiliates aggregate liability arising under or in connection with the Sierra Wireless
product, regardless of the number of events, occurrences, or claims giving rise to
liability, in excess of the price paid by the purchaser for the Sierra Wireless
product.

Rev 4.0 Mar.12 3

Raven XE for Sprint User Guide

Patents This product may contain technology developed by or for Sierra Wireless Inc. This

product includes technology licensed from QUALCOMM
manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more
patents licensed from InterDigital Group.

®

. This product is

Copyright © 2012 Sierra Wireless. All rights reserved.

Trademarks AirCard

Sierra Wireless. Watcher
European Community. AirLink™ and AceWare™ are trademarks of Sierra
Wireless.
Sierra Wireless, the Sierra Wireless logo, the red wave design, and the red-tipped
antenna are trademarks of Sierra Wireless.

Windows

Other trademarks are the property of the respective owners.

®

and “Heart of the Wireless Machine®” are registered trademarks of

®

is a registered trademark of Microsoft Corporation.

®

is a trademark of Sierra Wireless, registered in the

Contact
Information

Support Desk: Phone: [phone]

Hours: 5:00 AM to 5:00 PM Pacific Time,

Monday to Friday, except US Holidays

E-mail: [e-mail]

Sales Desk: Phone: [phone]

1-604-232-1488

Hours: 8:00

E-mail: [e-mail]

Mail: Sierra Wireless America

39677 Eureka Drive
Newark, CA 94560
USA

Sierra Wireless
13811 Wireless Way
Richmond, BC V6V 3A4
Canada

Fax: [phone]

1-604-231-1109

Website: www.sierrawireless.com

AM to 5:00 PM Pacific Time

Consult our website for up-to-date product descriptions, documentation,
application notes, firmware upgrades, troubleshooting tips, and press releases at:

www.sierrawireless.com

4 20080616

Revision
History

Preface

Revision
number

1.x Q2:2009 Raven XE documentation created and revised.

2.x Q1:2010 Raven XE documentation revised and updated with new features and

3.0 June 2011 Raven XE documentation revised with updated Preface section and minor

4.0 March 2012 Raven XE documentation revised. Updated two figures and a table in the

Release
date

Changes

enhancements. ALEOS User Guide, which covers the configuration of the
device information, is now a seperate guide.

content and document format corrections. Raven XE module refreshed from
MC5727 to MC5728.

Inputs, Relay Outputs, and Power Status chapter.

Rev 4.0 Mar.12 5

Raven XE for Sprint User Guide

6 20080616

Contents

Introduction to the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

ACEware™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

ACEview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Modem Doctor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14

Connecting to Sprint. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Dynamic vs. Static IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

EV-DO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Connection Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

USB Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Virtual Serial Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

IPsec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

GRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Events Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Tools and Reference Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Rev 4.0 Mar.12 7

Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Features and Benefits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Technology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Bands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Environmental . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Power Consumption: (@12V DC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Standards/Approvals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Host Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Physical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Application Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

LED Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22

Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

Power Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Activating the Raven XE on Sprint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25

Contents

OMA-DM. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Hands Free Activation (HFA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Activating the Raven XE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Updating Raven XE Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Verifying USB Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Confirming IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Configuring through ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Installation of the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Connecting to Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Connecting to a Computer or Other Device . . . . . . . . . . . . . . . . . . . . . . . . . 33

Indicator Lights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Mounting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Inputs, Relay Outputs, and Power Status . . . . . . . . . . . . . . . . . . . . . . . . . . .39

Capturing External Events Using Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Connecting Devices to the I/O Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Monitoring the Input and Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Rev 4.0 Mar.12 8

Contents

Connecting the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43

ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Using a Terminal Application with AT Commands . . . . . . . . . . . . . . . . . . . . 43

AT Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Regulatory Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

Federal Communications Commission (FCC) Notice - United States . . .49

Industry Canada . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49

RF Exposure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50

EU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Rev 4.0 Mar.12 9

Raven XE for Sprint User Guide

10 20080616

1: Introduction to the Raven XE

•ACEware™

• Connecting to Sprint

• EV-DO

• Connection
Methods

• Networking

• Applications

• Software

• Documentation

The Raven XE is an intelligent wireless gateway, powered by
ALEOS™ embedded intelligence, and optimal for providing primary
or backup network connectivity for any high-reliability/ high-availability
applications.

The Raven XE is the perfect solution for any device with an Ethernet
connection that requires pervasive connectivity including PCs,
routers, network equipment and POS/ATMs as well as commercial
automation equipment.

Raven XE modems are designed to maintain a reliable, consistent
network connection.Class I Division 2 certified as nonincendive
equipment, the Raven Series is ideally suited for use in hazardous
environments.

Key applications include utilities, manufacturing, automation, oil and
gas, Ethernet-based SCADA, telemetry, Homeland Security, and
asset monitoring.

1

Rev 4.0 Mar.12 11

Figure 1-1: Raven XE

ALEOS, the embedded core technology of Sierra Wireless AirLink
products, simplifies the installation, operation, and maintenance of
any deployment. In addition, it provides an always-on, always-aware
intelligent connection for mission-critical applications.

Raven XE for Sprint User Guide

ALEOS features:

• Persistent Network Connectivity

• Over-The-Air (OTA) Upgrades

• Wireless Optimized TCP/IP

• Real-Time Notification

• Packet Level Diagnostics

• Device Management & Control

• Protocol Spoofing.

Figure 1-2: Powered by ALEOS

ACEware™

A wireless solution is not complete until you have software tools to manage the
devices monitoring your valuable equipment. Using the AirLink Control
Environment (ACE), ACEware is the device management and monitoring
application suite for Sierra Wireless AirLink devices powered by ALEOS.

Figure 1-3: ACEware Logo

The ACEware suite encompasses an application internal to the firmware
(ACEmanager) and the Windows-based applications ACEview, Modem Doctor,
ACEnet, and AirLink Management Services (AMS). You can download the
ACEview and Modem Doctor applications, and the ACEmanager, ACEnet,
ACEview, and ALEOS user guides, from the Sierra Wireless AirLink Solutions
website (http://www.sierrawireless.com/support). Contact your dealer or Sierra
Wireless representative for any further information.

Note: ACEview requires the Microsoft .NET Framework v. 2.0 and Microsoft Windows 98,
Windows 2000, Windows XP, or later. You can obtain the Microsoft .NET Framework from
Microsoft at: http://www.microsoft.com/.

12 20080616

Introduction to the Raven XE

ACEmanager

ACEmanager, the ACEware remote configuration and monitoring tool, simplifies
deployment and provides extensive monitoring, control, and management
capabilities. ACEmanager gives you the power to manage your Sierra Wireless
AirLink communications platforms in real-time.

Figure 1-4: ACEmanager Home Screen

Simplified Deployment

ACEmanager provides the ability to remotely set up and configure your Sierra
Wireless AirLink products. Remote device setup and configuration reduces the
deployment timeline of your wireless solution and provides a quicker path to ROI.

Templates allow you to easily configure devices in your fleet with identical
settings, ensuring a simple, accurate deployment.

Monitor and Control

ACEmanager allows an administrator to remotely monitor a modem’s status,
health and configuration settings. The user interface displays signal strength, cell
site information, byte counters and error conditions, enabling you to pinpoint any
issues and troubleshoot immediately.

ACEmanager enables remote configuration and parameter settings to be
changed or reset instantly over the air, change a device’s port configuration, IP
address settings, GPS settings, and much more. After configuring one modem,
use the template feature to copy that device configuration to other devices.

Tip: The configuration steps and examples in this guide use ACEmanager.

Rev 4.0 Mar.12 13

Raven XE for Sprint User Guide

ACEview

ACEview is an efficient status and connection monitoring application with a
low-profile, easy to read interface. In ACEview, you can also update the PRL
(Protocol Roaming List) on a device.

Figure 1-5: ACEview Main Screen

Modem Doctor

Modem Doctor and Modem Doctor USB is a troubleshooting and diagnostics
utility. This utility allows you to get a log file of the Raven XE activity which you
can then send to Sierra Wireless support or erase the current configuration
completely.

Figure 1-6: Modem Doctor

14 20080616

Introduction to the Raven XE

Connecting to Sprint

The Raven XE uses Sprint as an ISP (Internet Service Provider) to connect you
to the Internet.

Connection Steps:

1. When your Raven XE is powered on, it automatically searches for cellular
service using CDMA-based cellular technology.

2. Your Raven XE establishes a PPP (Point to Point Protocol or “dial” up
connection) link to the Sprint network, also called registering on the network,
and receives an IP address.

3. When your Raven XE has received its IP address from Sprint, a connection to
the Internet or the cellular network is also available for computers or other
devices connected directly to the Raven XE.

The Raven XE will perform routing for all internet traffic to and from the computers
or other host devices.

With the Raven XE in Ethernet Public mode, only one device connected to the
Ethernet port will receive the public IP address which is the one provided by the
cellular network. In Ethernet Private mode, with a hub or switch connected to the
Ethernet port, the Raven XE will provide NAT for a range of computers or other
devices connected to the switch or hub and Internet access to all of them.

Dynamic vs. Static IP Addresses

There are two types of addresses on networks: dynamic and static.

• Dynamic addresses are assigned on a “need to have” basis. Your Raven XE
might not always receive the same address each time it connects with Sprint.

• Static addresses are permanently assigned to a particular account and will
always be used whenever your Raven XE connects to the Internet. The IP
address will not be given to anyone else.

Most ISPs (cellular included) use dynamic IP addresses rather than static IP
addresses since it allows them to reuse a smaller number of IP addresses for a
large number of customers. A dynamic IP address is suitable for many common

Rev 4.0 Mar.12 15

Raven XE for Sprint User Guide

Internet uses, such as web browsing, looking up data on another computer
system, or other client functions (such as data only being sent out or only being
received after an initial request).

Tip: If your account with Sprint includes a dynamic IP address and you need a static IP,

please consult your Sprint Representative for more information about changing your
account for static IP support.

If you need to contact your Raven XE, a device connected to the Raven XE, or a
host system using the Raven XE from the Internet, you need to have a known IP
(such as one which is static) or domain name (an IP address which is converted
by a DNS server into a word-based name). If you have a dynamic IP address for
your modem, you can use a Dynamic DNS service (such as Sierra Wireless’s IP
Manager) to translate your IP address into to a domain name.

Caution: If you want to connect remotely to your Raven XE using TCP/IP or UDP/IP, the

IP address given to your modem by Sprint cannot be a private or internal IP address (such
as a special private network) unless you are on the same network or inside that network’s
firewall (such as with frame relay).

EV-DO

CDMA (Code Division Multiple Access) is the underlying digital radio network
technology used by many cellular providers across the globe and is prevalent in
North America. To provide backward compatibility and seamless connections in
a wider range of locations, Sierra Wireless EV-DO products your Raven XE will
fall back to 1x when EV-DO is not available.

Sierra Wireless is certified with Sprint, a prominent North American 1x and EV­DO carrier.

EV-DO revision A is an enhancement on the original revision 0 adding expanded
upload capabilities and a more robust connection overall. In addition to increasing
the downlink speed, revision A also increases the uplink speed. In addition, it is
backwards compatible and automatically connects with existing and broadly
deployed EV-DO Rev. 0 and 1x networks ensuring reliable and pervasive
connectivity.

Security

1x data transmissions are highly secure. Originally developed and based on the
“spread spectrum” pioneered by the US Department of Defense, security in
CDMA technologies is obtained by spreading the digital information contained in
a particular signal of interest over multiple coded paths over a much greater
bandwidth that the original signal.

16 20080616