Documente Academic
Documente Profesional
Documente Cultură
User Guide
20080616
Rev 2.0
Preface
Important
Notice
Safety and
Hazards
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.
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.
Limitation of
Liability
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.
Raven XE
Patents
5,629,960
6,199,168
6,697,030
6,985,757
5,845,216
6,339,405
6,785,830
7,023,878
5,847,553
6,359,591
6,845,249
7,053,843
5,878,2345,890,0575,929,8156,169,884
6,400,3366,516,2046,561,8516,643,501
6,847,8306,876,6976,879,5856,886,049
7,106,5697,145,2677,200,512D442,170
QUALCOMM 3G
5,056,109
5,416,797
5,600,754
5,101,501
5,490,165
5,657,420
5,109,390
5,504,773
5,659,569
5,228,0545,267,2615,267,2625,337,338
5,506,8655,511,0735,535,2395,544,196
5,710,7845,778,338
Copyright
Trademarks
Contact
Information
Support Desk:
Phone: 1-877-231-1144
Hours: 5:00 AM to 5:00 PM Pacific Time,
Monday to Friday, except US Holidays
E-mail: support@sierrawireless.com
Sales Desk:
Phone: 1-510-624-4200
1-604-232-1488
Hours: 8:00 AM to 5:00 PM Pacific Time
E-mail: MobileandM2Msales@sierrawireless.com
ii
20080616
Preface
Revision
History
Revision
number
Release
date
Changes
1.x
Q2:2009
2.x
Q1:2010
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
Contents
Raven XE
Real-Time Notification
Protocol Spoofing
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.
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.
20080616
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.
ACEview
ACEview is an efficient status and connection monitoring application with a lowprofile, easy to read interface. In ACEview, you can also update PRL.
Raven XE
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.
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
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.
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.
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 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 IP Manager) to
translate your IP address into to a domain name.
Rev 2.0 Mar.10
Raven XE
Caution: If you want to connect remotely to your Raven XE using TCP/IP, the IP address
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
networks 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 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.
20080616
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 Integrity: Data Integrity Authentication allows both ends of the communication 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.
Raven XE
GRE
GRE (Generic Routing Encapsulation) tunnel is used to carry non-IP packets
through an IP Network. Non -IP packets, that are send over the GRE tunnel, need
to be first encapsulated. Hence, ALEOS is used to configure and encapsulate
non-IP packets and transmit over IP through the GRE tunnel.
Applications
Events Reporting
Events Reporting is Sierra Wireless AirLinks modems new software feature
provided via ACEmanager, that allows the users to generate reports from the
events that take place. Event Reporting Protocol is an intuitive embedded
protocol, which automatically formats the messages based on an event trigger.
The messages generated are then reported to the remote server.
Software
The Raven XE modem comes with the following software:
AceView, the software for the Raven XE which allows you to monitor your
connections.
The driver that forms the interface between the Raven XE and your Windows
operating system when using USB virtual Ethernet or USB virtual serial.
20080616
Documentation
This Raven XE User Guide describes how to:
Interpret the LEDs on the Raven XE and the indicators in the AceView
software.
This User Guide is provided as a PDF (Portable Document Format) file on the
installation CD or from the Sierra Wireless support website.
Description
This document discusses software configuration in ACEmanager and explains all the
ALEOS features.
This document explains the use of this utility tools which is used to view and monitor the
connection state of a Sierra Wireless AirLink device.
This document explains the use of ACEnet services for remote management of Sierra
Wireless AirLink device.
Raven XE
10
20080616
2: Specifications
Power Connector
Embedded Intelligence
Compact Size
Technology
Bands
Environmental
Operating Temperature:
-30 to 70 Celsius
Storage Temperature:
-40 to 85 Celsius
Idle 80 mA
Standards/Approvals
11
Raven XE
RoHS
FCC
Industry Canada
Warning: Explosion Hazard - Substitution of any components may impair suitability for
Class I, Division 2.
Note: In consideration of
EU regulations, this
device is classified as
Class A device for use in
commercial environments.
Host Interfaces
Antenna Connection:
Cellular - 50 Ohm SMA
Receive Diversity - 50 Ohm SMA
I/O Ports: 2
Warning: The antenna should be installed no closer than 20 cm from the human body. It
is one of the RSS-102 requirements for devices not requiring SAR.
Dimensions
185 grams
Application Interfaces
TCP/IP, UDP/IP, DHCP, HTTP, SNMP, SMTP, SMS, MSCI, Modbus and more
LED Indicators
Network
Signal
Activity
Power
Reset Button
Power Connector
12
20080616
Specifications
Warning: Explosion Hazard - Do not disconnect equipment unless power has been
switched off or the area is known to be non-hazardous.
13
Raven XE
14
20080616
OMA-DM
Raven XE is an embedded router solution that supports Network
Initiated (NI) OMA-DM Device Configuration (DC) and PRL Updates
(PRL) on the Sprint network. The Raven XE firmware registers
notifications with the MC5727 radio module for OMA-DM NI alerts
and session state and processes them appropriately. The alert
response instructs the radio module to immediately process the NI
OMA-DM command. When the OMA-DM session state is IDLE,
Raven XE records the session type and session result code and then
re-establishes the data connection.
Activating Raven XE
To activate your Raven XE, follow the instructions below:
1. Connect the Raven XE with antennas.
2. Plug the power cable to the power connector on the back panel of
the Raven XE.
3. Connect your computer to the Raven XE with an ethernet cable.
15
Raven XE
connect USB. Install from specific location and point to this .inf file. For detailed instructions on installing the USB drivers, please refer to Universal Serial Bus Application Note.
b. Choose the interface you want to program the modem through and click
on Next.
The default private for Ethernet is also in a different subnet from the other
connection types.
16
20080616
Raven XE
Connected Device
192.168.13.31*
192.168.13.100
USB/NET
192.168.14.31
192.168.14.100
DUN
192.168.15.31
192.168.15.100
c. The next screen will prompt you to reset the modem manually. Click on
Next after resetting the modem manually.
Installation begins and can take up to a few minutes.
17
Raven XE
Confirming IP Address
Check the IP Address in your Local Area Connection window.
18
If you have the different numbers for the MIN and MDN or MSID:
AT*PROVISION2=MSL,MDN,MIN/MSID[,SID,NID]
19
Raven XE
7. Press the reset button on the front of the modem. When the modem restarts,
it should register on the network.
Tip: PassThru can only be exited by resetting or power-cycling the modem. This mode
20
20080616
Note: At least 20 cm
separation distance
between the antenna and
the user's body must be
maintained at all times.
21
Raven XE
Tip: When using a cable to an antenna placed away from the modem, minimize the length
of your cable. All gain from a more advantageous antenna placement can be lost with a
long cable to the modem.
Note: Use of receive
diversity for EV-DO is
optional. Data transmission and reception may
be adversely affected if it is
not used.
Connecting to Power
The Raven XE digital I/O port consists of a 4 pin power connector, which includes
two digital I/O ports. Port 4 is software configurable, while port 3 is Digital Input
only and not software configurable.
This I/O port handles external input and output events. An external device can
send digital input to the modem, through the digital I/O port.
Warning: Risk of electric shock: Only use the supply voltages listed in this user guide.
Warning: When using AC to DC adapter the ambient temperature should not exceed
40 0C.
Your Raven XE can be used with either DC or AC, with the appropriate power
adapter. DC cables and AC adapters are available as optional accessories in
addition to the one included with your Raven XE.
22
20080616
The DC power cable positive lead should be connected to the battery or power
source positive terminal. The power cable negative lead should be connected to
the battery or power source negative terminal.
Tip: The DC power cable has a white wire lead in addition to the power positive and
negative. This is for a feature not present in the Raven line modems. In the Raven XE, the
white wire lead has no function and can be ignored.
Warning: Explosion Hazard - Do not disconnect equipment unless power has been
switched off or the area is known to be non-hazardous.
Tip: On some computers, the TCP receive window may be set to 16 kbytes. To optimize
the throughput of your Raven XE, it is recommended that you change the TCP window to
128 kbytes to 256 kbytes using a TCP Optimizer.
23
Raven XE
Your Raven XEs full-speed (12 Mbit) USB 2.0 port can be connected directly to
most computers or other devices using a standard full-speed USB 2.0 cable. If the
computer or device you are connecting or the cable is not rated for full-speed, the
modem will communicate at a reduced speed to match. The Raven XE functions
as a device, not a host.
When it is connected to a computer, the USB port should be seen as a COM port
or Ethernet port after the applicable driver is installed.
The Raven XE has a standard mini-B connector.
Warning: The USB port can only be used in a non-hazardous environment.
Indicator Lights
When your Raven XE is connected to power and an antenna, there is a specific
pattern to the lights to indicate its operation mode.
Signal - Light shows the strength of the signal and may be nearly solid
(strong signal) or flashing (weaker signal). A slow flash indicates a very weak
signal.
24
On Solid
Fast Blink
-70 to -79
Normal blink
-80 to -89
Slow Blink
-90 to -99
Extinguished
Activity - Lights will flash as data is transferred to and from the Raven XE on
the remote network.
20080616
Power - Indicates the power adapter is connected and there is power getting
to the Raven XE.
The Reset button (on the left side of the Raven XE) has two functions. If it is
quickly depressed and released, the modem will simply power cycle the
internal hardware. If, however, the reset is depressed and held for several
seconds (count approximately 30 seconds, and wait for the power light to go
off after the light pattern stops), the ALEOS configuration settings will return
to the factory defaults.
Caution: If you reset the modem configuration using the reset button,
you may need to reactivate your Raven XE with your cellular provider.
Light Patterns
The LEDs on the front of the modem will respond in different patterns to indicate
modem states.
Configuration Reset - The LEDs will cycle left to right and then right to left 4
times.
Authentication Failure - The Network, Signal, and Activity LEDs blink every
2 seconds.
Data Retry - The Network, Signal, and Activity LEDs blink every 3 seconds.
Mounting
An optional accessory for your Raven XE is a mounting kit, which includes a
bracket. The bracket is designed to snugly cradle the modem and hold it in place
where you need it. You can use a strap around the bracket and modem for extra
security. The bracket can be attached to a stationary location using #6 screws
with the mounting hole diameter approximately 0.150".
The instructions to bracket installation is following:
1. Mount the bracket using number 6 screws. There are two holes each, to
fasten screws, and minimum of one hole each end is required for mounting
bracket.
2. Position Raven XE between Alignment ears.
3. Engage top groove in body of Raven XE with two tabs.
4. Push on far side of Raven XE in center so that it touches side of Bracket.
5. Press down and release when upper groove on far side of Raven XE, aligns
with tabs.
6. Release to complete installation in to mounting bracket.
To remove, press on the two edges of the modem and the brackets, as pointed by
arrows in the diagram provided below. By doing this, the modem will snap out of
the mounting bracket.
25
Raven XE
26
20080616
27
Raven XE
28
20080616
Digital Input
By measuring contact closures on switches, the digital input(s) can
report a simple open or closed state. Digital input(s) can be wired to
the two ground signals via a switch. When the switch is open, the
input will read OPEN. When the switch is closed and the input is
connected to ground, the input will read CLOSED.
29
Raven XE
30
20080616
Digital Output
You can purchase an optional I/O Power Cable for the Raven XE which can be
used to attach devices to the combination I/O port and power connector. The
harness has pre-wired leads to allow you to customize your own connections. The
wires are paired and color-coded.
Warning: Risk of electric shock: Only use the supply voltages listed in this user guide.
Digital Input
Digital Input/Output
Pin 4
Function
Input
Output Only
Max VDC
3.3V
3.3V
V Positive VDC
1.3 to 2.2VDC
1.3 to 2.2VDC
V negative VDC
0.6 TO 1.5VDC
Hysteresis VDC
0.4 to 1.2VDC
0.4 to 1.2VDC
Internal Pullup
52kohm to 3.3VDC
Input Only
Output
IOUT
50mA
2.4V
31
Raven XE
Digital Input
Digital Input/Output
2.3V
VOLmax(IOL 24mA)
0.55V
Caution: Never apply voltage to the Digital inputs. The inputs can only be switched open
or closed to ground.
Note: Please refer to the ALEOS User Guide for configuring Raven XE I/O in
ACEmanager.
32
20080616
ACEmanager
To get a more expanded view of the other ACEmanager features,
refer to the ACEmanager Guide.
A full listing of all the configuration commands for you modem are in
Chapter 6.
recommended the connection name reflect the connection type, i.e. Raven
XE local.
b. Select OK.
c.
2. Connect to
Using USB/Serial:
a. Select COM1, or the comport to which the modem is
connected, for the Connect Using.
33
Raven XE
Tip: If you have configured the Raven XE for settings different than the defaults for Bits
per Second, Data Bits, Parity, and/or Stop Bits, you will need to use your changed settings.
c. Select OK.
Using Ethernet:
d. Select TCP/IP (Winsock) for Connect Using.
e. Type in 192.169.14.31 for Host Address.
f.
34
20080616
192.168.14.31
g. Select OK.
3. Connected
Connecting on USB/net will prompt for password.
35
Raven XE
AT Command
When using a terminal application, you will need to manually type in each
command.
36
For most commands, when you are entering them using a terminal
connection, you will need to preface the command with AT (exceptions are
noted), i.e. ATA which is listed as A.
Some commands have specific parameters while other commands will take
whatever you type.
Required variable parameters are denoted with italicized text, example, Dn.
The n is variable.
Most commands with parameters can be entered with ? to read the current
value (for example, AT&D? will respond with 2 if the default has not been
changed).
20080616
When you are using a terminal connection, if you enter a command which is
recognized by the Raven XE, it will respond with OK. If the command is not
recognized, the response will be ERROR.
Caution: Symbols listed with commands, such as *, /, &, or ?, are part of the command
and must be included. Commands with symbols other than * may require PassThru mode.
37
Raven XE
38
20080616