AirLink Raven XE User Guide 20080616 Rev 2.
Preface Important Notice 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.
Raven XE Patents Portions of this product may be covered by some or all of the following US patents: 5,515,013 6,191,741 6,653,979 6,968,171 D459,303 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 and other patents pending.
Preface Post: Sierra Wireless America 39677 Eureka Drive Newark, CA USA 94560 Sierra Wireless 13811 Wireless Way Richmond, BC Canada V6V 3A4 Fax: 1-510-624-4299 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 History Revision number Release date Changes 1.x Q2:2009 Raven XE documentation created and revised. 2.
Raven XE iv 20080616
Contents Introduction to the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 ACEware™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 ACEmanager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 ACEview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 Modem Doctor . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents 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 . . . . . . .
1 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.
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.
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.
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.
Introduction to the 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. Raven XE The Raven XE will perform routing for all internet traffic to and from the computers or other end devicse.
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 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.
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.
Raven XE Figure 1-7: IPSec Architecture 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.
Introduction to the Raven XE Documentation This Raven XE User Guide describes how to: • Install the Raven XE hardware. • Connect the radio antennas. • Connect a notebook computer and other input/output (I/O) devices. • 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.
Raven XE 10 20080616
2 2: Specifications • Power Connector Features and Benefits • Embedded Intelligence • Low Power Consumption • Compact Size • Rugged Aluminium Case • High-Speed Processor (ARM 9) • High-Speed 2-way Data • 10/100 Mbps Ethernet Port • Persistent Network Connectivity • Remote Management and Configuration • Class I Div 2 Certified Technology • CDMA EV-DO Revision A With Fallback to: · CDMA 1xRTT · CDMA IS-95 Bands • 800 Mhz Cellular • 1900 Mhz PCS Environmental • Operating Temperatur
Raven XE • RoHS • FCC • Industry Canada • This apparatus is suitable for use in Class I, Division 2, Groups A, B, C, D or unclassified or non-hazardous locations. 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.
Specifications * Configuration terminology in ACEmanager Figure 2-1: Power Connector (not to scale) Warning: Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is known to be non-hazardous. Note: Raven XE I/O Port 4 is software configurable. Rev 2.0 Mar.
Raven XE 14 20080616
3 3: Activating your Raven XE on your cellular provider • OMA-DM • Hands Free Activation (HFA) • Activating Raven XE • Verifying USB connection • Configuring through ACEmanager • Activating Using AT Commands This chapter provides step-by-step directions for activating your Raven XE on your cellular provider’s network. 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.
Raven XE 4. Observe the LEDs, as indicated in Chapter 4, Indicator Lights section. Wait approximately 30 seconds, to allow the Raven XE to initialize and go over the air. Updating Raven XE firmware For installing the latest firmware version (.exe file), you can go to the Sierra Wireless website: http://www.sierrawireless.com/support. For the updater tool to execute, please install the USB drivers available on the website before executing the .exe file. Tip: Copy the USB Serial Driver.
Activating your Raven XE on your cellular provider Table 3-1: Factory Defaults Interface Raven XE Connected Device Ethernet Private default 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 *can be changed via ACEmanager Figure 3-2: Configuration: Interface selection 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.
Raven XE Figure 3-3: Verify USB Connection Confirming IP Address Check the IP Address in your Local Area Connection window. Figure 3-4: Confirm IP Address Configuring through ACEmanager ACEmanager is a free utility. Follow the steps below to connect to ACEmanager for configuring the modem. 18 • Ensure Raven XE connectivity to access ACEmanager. • Go to: http://192.168.13.31:9191 the first time you connect to ACEmanager.
Activating your Raven XE on your cellular provider Activating Using AT Commands An alternate method to configure and activate your Raven XE is by using AT commands sent directly to the modem with a terminal application. Caution: It is not possible to activate the Raven XE using either ACEmanager or AceNet. 1. Set telnet timeout in to 20 minutes. 2. Save the telnet setting. 3. Enter the user name of your account (NAI).
Raven XE 6. Reset the module. AT!RESET 7. Press the reset button on the front of the modem. When the modem restarts, it should register on the network. PassThru mode through AT Command Issuing the “AT\APASSTHRU” from a terminal emulation enters the PassThru mode. The modem responds with OK, at which point a direct connection to the internal hardware is established. Figure 3-5: PassThru mode Tip: PassThru can only be exited by resetting or power-cycling the modem.
4: Hardware Installation of the Raven XE 4 • Connecting to Power • Connecting to a Computer or other Device • Indicator Lights • Mounting Note: During installation, please be sure that the cables are secure but do not bear any additional weight that could loosen the connector from the unit. Your Raven XE should be mounted in a position that allows easy access for the cables so they are not bent, constricted, in close proximity to high amperage, or exposed to extreme temperatures.
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. To provide for diversity in the signal reception, connect the second antenna to the second antenna port (SMA, labeled Rx Div ANT2) on the back of the Raven XE.
Hardware Installation of the Raven XE Note: When using a DC power source (such as a solar cell), Sierra Wireless recommends placing a fuse (1-2 Amp) on the line close to the power source to protect your power source from possible surges due to shorts or other line issues. 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.
Raven XE Your Raven XE’s 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.
Hardware Installation of the Raven XE • 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.
Raven XE Figure 4-6: Optional Mounting Bracket Figure 4-7: Mounting bracket installation 26 20080616
Hardware Installation of the Raven XE Figure 4-8: 100-170-1015 : Mounting Bracket for Raven XE Rev 2.0 Mar.
Raven XE 28 20080616
5 5: Inputs, Relay Outputs, and Power Status • Capturing External Events using Inputs The Raven XE has special features for use in an M2M environment. The Raven XE can be configured to monitor the input, respond to specific types of events, and even trigger a digital output. These features can be configured to your needs. Capturing External Events using Inputs While using a special power cable with I/O, the Raven XE is equipped with an I/O interface for use in instrumentation applications.
Raven XE Figure 5-2: Digital Input Contact Closure 30 • When a door or other latch is opened or closed. • Counting pulses or other electronic events. • When a gauge reaches a certain point. • When a container fills or empties. • When a switch or valve is opened or closed. • When the tow bar is raised or lowered. • Connected to a sensor, the level of fuel in a vehicle. • When the trunk of a vehicle is opened or closed. • When the ignition is turned on or off.
Inputs, Relay Outputs, and Power Status Digital Output Figure 5-3: Digital Output Connecting devices to the IO Port Note: Before you install the Raven XE in its final location, be sure to cover all exposed wiring. 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.
Raven XE Digital Input Digital Input/Output VOHmin (IOH - 24 mA) 2.3V VOLmax(IOL 24mA) 0.55V Figure 5-4: Power Connector Diagram Caution: Never apply voltage to the Digital inputs. The inputs can only be switched open or closed to ground. Monitoring the Input and Output You can monitor the status of the digital inputs using ACEmanager, AT Commands, or with special reports sent by email, SMS, or other report types using Event Reporting. In ACEmanager, select the I/O group.
6 6: Connecting the Raven XE • ACEmanager • Using a Terminal Application with AT Commands • AT Command With ALEOS as its “brain”, the Raven XE is a highly configurable device. To configure your Raven XE, you have two options. You can use the configuration and management applications of the AceWare suite or you can use a terminal emulator application such as HyperTerminal, PuTTY, or many others. ACEmanager To get a more expanded view of the other ACEmanager features, refer to the ACEmanager Guide.
Raven XE Figure 6-1: Connect To b. Change or verify the settings: · Bits per Second: 115200 (default) · Data Bits: 8 · Parity: None · Stop Bits: 1 · Flow Control: Hardware. Figure 6-2: Port Settings 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.
Connecting the Raven XE 192.168.14.31 g. Select OK. 3. Connected Connecting on USB/net will prompt for password. Figure 6-3: HyperTerminal : TCP/IP connected Rev 2.0 Mar.
Raven XE Figure 6-4: HyperTerminal : connected a. If you are prompted for a password, enter 12345 (default password). Tip: You will not be prompted for a password if you connect using a COM port. b. Type AT and press Enter. You should get a reply of “OK” or “0”. c. To see what you are typing as you type it, you will need to turn on the echo and verbose mode. Type ATE1V1 and press Enter. d. If you get a reply of “OK”, then you entered the command successfully.
Connecting the Raven XE • Optional parameters are denoted with square brackets [ ]. • AT Commands are not case sensitive. A capital “E” is the same as a lowercase “e”. • 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”. • Those commands applicable only to certain model numbers of the Raven XE will be noted.
Raven XE 38 20080616
