Sierra Wireless AirLink Raven XE, Raven XE User Manual

AirLink Raven XE

User Guide

20080616

Rev 2.0

Preface

Important
Notice

Safety and
Hazards

Due to the nature of wireless communications, transmission and reception of data
can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be
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 damage of any kind 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, where explosive atmospheres may be present, near medical
equipment, near life support equipment, or 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.

Limitation of
Liability

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.

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

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, be in excess of the price paid by the purchaser for the Sierra Wireless
product.

Rev 2.0 Mar.10 i

Raven XE

QUALCOMM

®

3G

Patents Portions of this product may be covered by some or all of the following US

patents:

5,515,013 5,629,960 5,845,216 5,847,553 5,878,2345,890,0575,929,8156,169,884
6,191,741 6,199,168 6,339,405 6,359,591 6,400,3366,516,2046,561,8516,643,501
6,653,979 6,697,030 6,785,830 6,845,249 6,847,8306,876,6976,879,5856,886,049
6,968,171 6,985,757 7,023,878 7,053,843 7,106,5697,145,2677,200,512D442,170
D459,303

and other patents pending.

This product includes
technology licensed from:

Licensed by QUALCOMM Incorporated under one or more of the following United
States patents and/or their counterparts in other nations:

4,901,307 5,056,109 5,101,501 5,109,390 5,228,0545,267,2615,267,2625,337,338
5,414,796 5,416,797 5,490,165 5,504,773 5,506,8655,511,0735,535,2395,544,196
5,568,483 5,600,754 5,657,420 5,659,569 5,710,7845,778,338

Manufactured or sold by Sierra Wireless or its licensees under one or more
patents licensed from InterDigital Group.

Copyright © 2010 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

QUALCOMM
under license.

Other trademarks are the property of the respective owners.

Contact
Information

®

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

®

is a registered trademark of Microsoft Corporation.

®

is a registered trademark of QUALCOMM Incorporated. Used

Support Desk: Phone: [phone]

Sales Desk: Phone: [phone]

®

is a trademark of Sierra Wireless, registered in the

Hours: 5:00

E-mail: [e-mail]

Hours: 8:00

E-mail: [e-mail]

AM to 5:00 PM Pacific Time,

Monday to Friday, except US Holidays

1-604-232-1488

AM to 5:00 PM Pacific Time

ii 20080616

Revision
History

Preface

Post: Sierra Wireless America

39677 Eureka Drive
Newark, CA
USA 94560

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

Fax: [phone]

1-604-231-1109

Web: www.sierrawireless.com

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

www.sierrawireless.com

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

Release
date

Changes

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

Rev 2.0 Mar.10 iii

Raven XE

iv 20080616

Contents

Introduction to the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

ACEware™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2

ACEview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

Modem Doctor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Connecting to your cellular provider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Dynamic vs. Static IP Addresses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5

EV-DO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Connection methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

USB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6

Virtual serial port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

IPSec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

GRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Events Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8

Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Tools and Reference Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11

Power Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Activating your Raven XE on your cellular provider . . . . . . . . . . . . . . . . . .15

OMA-DM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Hands Free Activation (HFA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Activating Raven XE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Updating Raven XE firmware. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Verifying USB connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Confirming IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Rev 2.0 Mar.10 1

Configuring through ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Activating Using AT Commands. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Using Direct Commands to the Internal Hardware . . . . . . . . . . . . . . . . . .19

PassThru mode through AT Command . . . . . . . . . . . . . . . . . . . . . . . . . .20

Hardware Installation of the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21

Connecting to Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Connecting to a Computer or other Device . . . . . . . . . . . . . . . . . . . . . . . . . 23

Indicator Lights. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Mounting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

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

Capturing External Events using Inputs . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Digital Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Contents

Connecting devices to the IO Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31

Monitoring the Input and Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .32

Connecting the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33

ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

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

AT Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Rev 2.0 Mar.10 2

1: Introduction to the Raven XE

• ACEware™

• Connecting to your

cellular provider

• EV-DO

• Connection

methods

• Networking

• Applications

• Software

• Documentation

The Raven XE is an intelligent wireless gateway, powered by
ALEOS™, 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.

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

1

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

Figure 1-1: Sierra Wireless AirLink Raven XE

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

• Persistent Network Connectivity

Rev 2.0 Mar.10 1

Raven XE

• 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), Windows-based applications (ACEview and Modem Doctor), and
a web-hosted application (ACEnet). You can download the applications and their
user guides from the Sierra Wireless AirLink Solutions web site: 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/.

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 monitor and control your Sierra
Wireless AirLink communications platforms in real-time.

2 20080616

Introduction to the Raven XE

Figure 1-4: ACEmanager

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:

Configuration steps and examples in this guide use ACEmanager.

ACEview

ACEview is an efficient status and connection monitoring application with a low­profile, easy to read interface. In ACEview, you can also update PRL.

Rev 2.0 Mar.10 3

Raven XE

Figure 1-5: ACEview

Modem Doctor

Modem Doctor and Modem Doctor USB is a troubleshooting and diagnostics
utility. This utility will allow 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

Connecting to your cellular provider

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

Steps of a connection:

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 your cellular provider network, also called registering on
the network, and receives an IP address.

4 20080616

Introduction to the Raven XE

Raven XE

3. When your Raven XE has received its IP address from your cellular provider,

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

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 your
cellular provider.

• 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
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 your cellular provider includes a dynamic IP address and you
need a static IP, please consult your your cellular provider Representative for more infor­mation 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 IP Manager) to
translate your IP address into to a domain name.

Rev 2.0 Mar.10 5

Raven XE

Caution:

given to your modem by your cellular provider 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).

If you want to connect remotely to your Raven XE using TCP/IP, the IP address

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 your cellular provider, 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 based upon 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 than the original signal.

Connection methods

You can connect the Raven XE to a USB or a Ethernet (RJ45) on a computer.
When connected to a USB or Ethernet port, the Raven XE behaves like a network
card.

USB

The Raven XE is equipped with a USB port which increases the methods by
which you can send and receive data. The USB port can be set to work as either
a virtual Ethernet port or a virtual serial port. A driver installation is required to
use the USB port in either mode.

It is recommended that you use a USB 2.0 cable with your Raven XE and connect
directly to your computer for best throughput.

6 20080616

Introduction to the Raven XE

Virtual serial port

The Raven XE supports one virtual serial port over USB. This VSP can be used,
for example, to send AT commands, or to run many serial based applications
such as HyperTerminal

®

.

Networking

IPSec

The IP protocol that drives the Internet is inherently insecure. Internet Protocol
Security (IPSec), which is a standards-based protocol, secures communications
of IP packets over public networks.

IPSec is a common network layer security control and is used to create a virtual
private network (VPN).

The advantages of the IPSec feature includes:

• Data Protection: Data Content Confidentiality allows users to protect their

data from any unauthorized view, because the data is encrypted (encryption
algorithms are used).

• Access Control: Access Control implies a security service that prevents

unauthorized use of a Security Gateway, a network behind a gateway or
bandwidth on that network.

• Data Origin Authentication: Data Origin Authentication verifies the actual

sender, thus eliminating the possibility of forging the actual sender’s identifi­cation by a third-party.

• Data Integrity: Data Integrity Authentication allows both ends of the communi-

cation channel to confirm that the original data sent has been received as
transmitted, without being tampered with in transit. This is achieved by using
authentication algorithms and their outputs.

The IPSec architecture model includes the Sierra Wireless AirLink gateway as a
remote gateway at one end communicating, through a VPN tunnel, with a VPN
gateway at the other end. The remote gateway is connected to a Remote network
and the VPN is connected to the Local network. The communication of data is
secure through the IPSec protocols.

Rev 2.0 Mar.10 7