User Guide
Contents
Introduction to the Raven XE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
ALEOS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 ACEware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Modem Doctor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
IPSec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 GRE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Events Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Tools and Reference Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Power Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Contents
Preface
Important Notice
Duetothenatureofwirelesscommunications,transmission andreceptionofdatacanneverbeguaranteed.Datamaybe delayed,corrupted(i.e.,haveerrors)orbetotallylost. Althoughsignificantdelaysorlossesofdataarerarewhen wirelessdevicessuchastheSierraWirelessAirLinkRavenXE areusedinanormalmannerwithawellconstructednetwork, theSierraWirelessAirLinkRavenXEshouldnotbeusedin situationswherefailuretotransmitorreceivedatacouldresult indamageofanykindtotheuseroranyotherparty,including butnotlimitedtopersonalinjury,death,orlossofproperty. SierraWirelessacceptsnoresponsibilityfordamagesofany kindresultingfromdelaysorerrorsindatatransmittedor receivedusingtheSierraWirelessAirLinkRavenXE,orfor failureoftheSierraWirelessAirLinkRavenXEtotransmitor receivesuchdata. DonotoperatetheSierraWirelessAirLinkRavenXEinareas whereblastingisinprogress,whereexplosiveatmospheres maybepresent,nearmedicalequipment,nearlifesupport equipment,oranyequipmentwhichmaybesusceptibletoany formofradiointerference.Insuchareas,theSierraWireless AirLinkRavenXEMUSTBEPOWEREDOFF.TheSierra WirelessAirLinkRavenXEcantransmitsignalsthatcould interferewiththisequipment. DonotoperatetheSierraWirelessAirLinkRavenXEinany aircraft,whethertheaircraftisonthegroundorinflight.In aircraft,theSierraWirelessAirLinkRavenXEMUSTBE POWEREDOFF.Whenoperating,theSierraWirelessAirLink RavenXEcantransmitsignalsthatcouldinterferewith variousonboardsystems.
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
Preface
DIRECT,INDIRECT,SPECIAL,GENERAL,INCIDENTAL, CONSEQUENTIAL,PUNITIVEOREXEMPLARYDAMAGES INCLUDING,BUTNOTLIMITEDTO,LOSSOFPROFITSOR REVENUEORANTICIPATEDPROFITSORREVENUE ARISINGOUTOFTHEUSEORINABILITYTOUSEANY SIERRAWIRELESSPRODUCT,EVENIFSIERRAWIRELESS AND/ORITSAFFILIATESHASBEENADVISEDOFTHE POSSIBILITYOFSUCHDAMAGESORTHEYARE FORESEEABLEORFORCLAIMSBYANYTHIRDPARTY. Notwithstandingtheforegoing,innoeventshallSierra Wirelessand/oritsaffiliatesaggregateliabilityarisingunderor inconnectionwiththeSierraWirelessproduct,regardlessof thenumberofevents,occurrences,orclaimsgivingriseto liability,beinexcessofthepricepaidbythepurchaserforthe SierraWirelessproduct.
Patents
Portionsofthisproductmaybecoveredbysomeorallofthe followingUSpatents: 5,515,013 5,629,960 5,845,216 5,847,553 5,878,234 5,890,057 5,929,815 6,169,884 6,191,741 6,199,168 6,339,405 6,359,591 6,400,336 6,516,204 6,561,851 6,643,501 6,653,979 6,697,030 6,785,830 6,845,249 6,847,830 6,876,697 6,879,585 6,886,049 6,968,171 6,985,757 7,023,878 7,053,843 7,106,569 7,145,267 7,200,512 D442,170 D459,303 andotherpatentspending. LicensedunderthefollowingNortelNetworksLimited patents: UnitedStatespatentnumbers:5128925,5398247 Francepatentnumbers:2665993,2653959,2659812,2745091
Copyright Trademarks
ii
Preface
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 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
Revision History
Revision number 2.x Release date Q2:2009 Changes Raven XE documentation created and revised.
iii
TheRavenXEisanintelligentwirelessgateway,poweredby ALEOS,andoptimalforprovidingprimaryorbackup networkconnectivityforanyhighreliability/highavailability applications. TheRavenXEistheperfectsolutionforanydevicewithan Ethernetconnectionthatrequirespervasiveconnectivity includingPCs,routers,networkequipmentandPOS/ATMsas wellascommercialautomationequipment. PoweredbyALEOS,RavenXEmodemsaredesignedto maintainareliable,consistentnetworkconnection.ClassI Divison2certifiedasnonincendiveequipment,theRaven Seriesisideallysuitedforuseinhazardousenvironments. Keyapplicationsincludeutilities,manufacturing,automation, oilandgas,ethernetbasedSCADA,telemetry,Homeland Securityandassetmonitoring.
ALEOS
ALEOS,theembeddedcoretechnologyoftheSierraWireless AirLinkproductssimplifiesinstallation,operationandmainte nanceofanysolution,andprovidesanalwayson,always awareintelligentconnectionformissioncriticalapplications. ALEOSenables: PersistentNetworkConnectivity OverTheAir(OTA)Upgrades WirelessOptimizedTCP/IP RealTimeNotification PacketLevelDiagnostics DeviceManagement&Control ProtocolSpoofing
ACEware
Awirelesssolutionisnotcompleteuntilyouhavesoftware toolstomanagethedevicesmonitoringyourvaluable equipment.UsingtheAirLinkControlEnvironment(ACE), ACEWareisthedevicemanagementandmonitoringappli cationsuiteforSierraWirelessAirLinkdevicespoweredby ALEOS.
ACEmanager,theAceWareremoteconfigurationand monitoringtool,simplifiesdeploymentandprovidesextensive monitoring,controlandmanagementcapabilities. ACEmanagergivesyouthepowertomonitorandcontrolyour SierraWirelessAirLinkcommunicationsplatformsinreal time. Simplified Deployment ACEmanagerprovidestheabilitytoremotelysetupand configureyourSierraWirelessAirLinkproducts.Remote devicesetupandconfigurationreducesthedeployment timelineofyourwirelesssolutionandprovidesaquickerpath toROI. Templatesallowyoutoeasilyconfiguredevicesinyourfleet withidenticalsettings,ensuringasimple,accurate deployment. Monitor and Control ACEmanagerallowsanadministratortoremotelymonitora modemsstatus,healthandconfigurationsettings.Theuser interfacedisplayssignalstrength,cellsiteinformation,byte countersanderrorconditions,enablingyoutopinpointany issuesandtroubleshootimmediately. ACEmanagerenablesremoteconfigurationandparameter settingstobechangedorresetinstantlyovertheair,changea devicesportconfiguration,IPaddresssettings,GPSsettings, andmuchmore.Afterconfiguringonemodem,usethe templatefeaturetocopythatdeviceconfigurationtoother devices.
Tip: Configuration steps and examples in this guide use
ACEmanager.
Modem Doctor
ModemDoctorandModemDoctorUSBisatroubleshooting anddiagnosticsutility.Thisutilitywillallowyoutogetalog fileoftheRavenXEactivitywhichyoucanthensendtoSierra Wirelesssupportorerasethecurrentconfigurationcompletely.
2.
TheRavenXEwillperformroutingforallinternettrafficto andfromthecomputersorotherenddevicse.
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.
Communication
GSMNetworksuseSIMcardswhicharesmartcards containingtheaccountholdersdetails.ASIMcangenerallybe movedfromonedevicetoanotherallowingforaccountporta bilityandflexibility. EDGE EDGE(EnhancedDataratesforGSMEvolution)providesend toendpacketdataserviceswithanenhancedconnectivity buildingonGPRStechnologyandusingtheestablishedGSM networks.EDGEprovideshighertransmissionratesandbetter transmissionqualityfordatathanGPRS.EDGEcancarrydata atspeedstypicallyupto384kbit/sinpacketmode. WhenEDGEisnotavailable,yourRavenXEwillfallbackto GPRSfortheconnectiontoyourcellularprovidertoprovide continuedconnectivity. GPRS GeneralPacketRadioService(GPRS)ispacketswitchedwith manyuserssharingthesametransmissionchannel,butonly transmittingwhentheyhavedatatosend.Thismeansthatthe totalavailablebandwidthcanbeimmediatelydedicatedto thoseuserswhoareactuallysendingatanygivenmoment, providinghigherutilizationwhereusersonlysendorreceive dataintermittently.GPRSprovidesspeedsof3070kbpswith burstsupto170kbps.
Connection methods
YoucanconnecttheRavenXEtoaUSBoraEthernet(RJ45)on acomputer.WhenconnectedtoaUSBorEthernetport,the RavenXEbehaveslikeanetworkcard.
USB
TheRavenXEisequippedwithaUSBportwhichincreasesthe methodsbywhichyoucansendandreceivedata.TheUSB portcanbesettoworkaseitheravirtualEthernetportora virtualserialport.Adriverinstallationisrequiredtousethe USBportineithermode.
Networking
IPSec
TheIPprotocolthatdrivestheInternetisinherentlyinsecure. InternetProtocolSecurity(IPSec),whichisastandardsbased protocol,securescommunicationsofIPpacketsoverpublic networks. IPSecisacommonnetworklayersecuritycontrolandisused tocreateavirtualprivatenetwork(VPN). TheadvantagesoftheIPSecfeatureincludes: DataProtection:DataContentConfidentialityallowsusers toprotecttheirdatafromanyunauthorizedview,because thedataisencrypted(encryptionalgorithmsareused). AccessControl:AccessControlimpliesasecurityservice thatpreventsunauthorizeduseofaSecurityGateway,a networkbehindagatewayorbandwidthonthatnetwork. DataOriginAuthentication:DataOriginAuthentication verifiestheactualsender,thuseliminatingthepossibility offorgingtheactualsendersidentificationbyathird party. DataIntegrity:DataIntegrityAuthenticationallowsboth endsofthecommunicationchanneltoconfirmthatthe originaldatasenthasbeenreceivedastransmitted, withoutbeingtamperedwithintransit.Thisisachieved byusingauthenticationalgorithmsandtheiroutputs.
GRE
GRE(GenericRoutingEncapsulation)tunnelisusedtocarry nonIPpacketsthroughanIPNetwork.NonIPpackets,that aresendovertheGREtunnel,needtobefirstencapsulated. Hence,ALEOSisusedtoconfigureandencapsulatenonIP packetsandtransmitoverIPthroughtheGREtunnel.
Applications
Events Reporting
EventsReportingisSierraWirelessAirLinksmodemsnew softwarefeatureprovidedviaACEmanager,thatallowsthe userstogeneratereportsfromtheeventsthattakeplace.Event ReportingProtocolisanintuitiveembeddedprotocol,which automaticallyformatsthemessagesbasedonaneventtrigger. Themessagesgeneratedarethenreportedtotheremote server.
Software
TheRavenXEmodemcomeswiththefollowingsoftware: ACEview,thesoftwarefortheRavenXEwhichallowsyou tomonitoryourconnections. ThedriverthatformstheinterfacebetweentheRavenXE andyourWindowsoperatingsystemwhenusingUSB virtualEthernetorUSBvirtualserial. Thefirmwarethatisstoredinnonvolatilememoryand includesACEmanager.
Documentation
ThisRavenXEUserGuidedescribeshowto: InstalltheRavenXEhardware. Connecttheradioantennas. Connectanotebookcomputerandotherinput/output (I/O)devices. InterprettheLEDsontheRavenXEandtheindicatorsin theACEviewsoftware.
2: Specifications
Power Connector
Features and Benefits EmbeddedIntelligence LowPowerConsumption CompactSize RuggedAluminiumCase HighSpeedProcessor(ARM9) HighSpeed2wayData 10/100MbpsEthernetPort PersistentNetworkConnectivity RemoteManagementandConfiguration ClassIDiv2Certified
Technology HSUPA WithFallbackto: HSDPA UMTS EDGE GPRS(MS12) GSM Bands TriBandforUMTS/HSDPA/HSUPA 850/1900/2100MHz QuadBandGPRS/EDGE 850/900/1800/1900MHz
10
Specifications
Standards/Approvals Carrierspecificapprovals CE(ClassAdeviceperEN55022) RoHS FCC IndustryCanada PTCRB ThisapparatusissuitableforuseinClassI,Division2, GroupsA,B,C,Dorunclassifiedornonhazardous locations.
closer than 20 cm from the human body. It is one of the RSS-102 requirements for devices not requiring SAR.
Dimensions 75mmx27mmx103mm 185grams
11
Specifications
Power ResetButton
12
Specifications
Power Connector
*ConfigurationterminologyinACEmanager
Figure 2-1: Power Connector (not to scale)
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.
13
Note: Until you install a driver for the USB port, you cannot use your USB port to configure the modem.
14
replace Plug-in Modules unless power has been disconnected or the area is known to be free of ignitible concentrations of flammable Gasses or vapors.
15
Tip: The top of the card faces the bottom of the modem.
Note: The card and SIM may be a different color than these examples.
16
ThedefaultAPNisInternet.IfyouneedadifferentAPN,use ACEmanagertoconfigureit.
17
Note: This device is not intended for use within close proximity of the human body. Antenna installation should provide for at least a 20 CM separation from the operator.
18
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.
the receive diversity option. In ACEmanager, in the WAN/Cellular group, configure RX Diversity.
Connecting to Power
TheRavenXEdigitalI/Oportconsistsofa4pinpower connector,whichincludestwodigitalI/Oports.Port4is softwareconfigurable,whileport3isDigitalInputonlyand notsoftwareconfigurable. ThisI/Oporthandlesexternalinputandoutputevents.An externaldevicecansenddigitalinputtothemodem,through thedigitalI/Oport.
19
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.
equipment unless power has been switched off or the area is known to be non-hazardous.
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.
20
YourRavenXEsfullspeed(12Mbit)USB2.0portcanbe connecteddirectlytomostcomputersorotherdevicesusinga standardfullspeedUSB2.0cable.Ifthecomputerordevice youareconnectingorthecableisnotratedforfullspeed,the modemwillcommunicateatareducedspeedtomatch.The RavenXEfunctionsasadevice,notahost. Whenitisconnectedtoacomputer,theUSBportshouldbe seenasaCOMportorEthernetportaftertheapplicabledriver isinstalled. TheRavenXEhasastandardminiBconnector.
hazardous environment.
Indicator Lights
WhenyourRavenXEisconnectedtopowerandanantenna, thereisaspecificpatterntothelightstoindicateitsoperation mode.
21
RSSI LED Ranges RSSI/Signal LED Status On Solid Fast Blink Normal blink Slow Blink Extinguished Ranges of RSSI (dBm) Equal to or stronger than -69 -70 to -79 -80 to -89 -90 to -99 Equal to or weaker than -100
ActivityLightswillflashasdataistransferredtoand fromtheRavenXEontheremotenetwork. PowerIndicatesthepoweradapterisconnectedand thereispowergettingtotheRavenXE. TheResetbutton(ontheleftsideoftheRavenXE)hastwo functions.Ifitisquicklydepressedandreleased,the modemwillsimplypowercycletheinternalhardware.If, however,theresetisdepressedandheldforseveral seconds(countapproximately30seconds,andwaitforthe powerlighttogooffafterthelightpatternstops),the ALEOSconfigurationsettingswillreturntothefactory defaults.
Caution: If you reset the modem configuration using the reset button,
Light Patterns TheLEDsonthefrontofthemodemwillrespondindifferent patternstoindicatemodemstates. NormalEachLED,mentionedabove,islitasapplicable. StartupTheLEDswillcyclefromlefttoright. ConfigurationResetTheLEDswillcyclelefttorightand thenrighttoleft4times. AuthenticationFailureTheNetwork,Signal,and ActivityLEDsblinkevery2seconds. DataRetryTheNetwork,Signal,andActivityLEDsblink every3seconds.
22
Mounting
AnoptionalaccessoryforyourRavenXEisamountingkit, whichincludesabracket.Thebracketisdesignedtosnugly cradlethemodemandholditinplacewhereyouneedit.You canuseastraparoundthebracketandmodemforextra security.Thebracketcanbeattachedtoastationarylocation using#6screwswiththemountingholediameterapproxi mately0.150. Theinstructionstobracketinstallationisfollowing: 1. Mountthebracketusingnumber6screws.Therearetwo holeseach,tofastenscrews,andminimumofonehole eachendisrequiredformountingbracket. PositionRavenXEbetweenAlignmentears. EngagetopgrooveinbodyofRavenXEwithtwotabs. PushonfarsideofRavenXEincentersothatittouches sideofBracket. Pressdownandreleasewhenuppergrooveonfarsideof RavenXE,alignswithtabs. Releasetocompleteinstallationintomountingbracket.
2. 3. 4. 5. 6.
23
24
25
ACEmanager
TogetamoreexpandedviewoftheotherACEmanager features,refertotheACEmanagerGuide. Afulllistingofalltheconfigurationcommandsforyou modemareinChapter6.
Tip: If you want to have a connection saved for both local and
remote, it is recommended the connection name reflect the connection type, i.e. Raven XE local.
b. SelectOK.
26
2. Connect To
UsingUSB/Serial: a. SelectCOM1,orthecomporttowhichthemodemis connected,fortheConnectUsing.
27
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.
SelectOK.
192.168.14.31
f.
SelectOK.
3. Connected
ConnectingonUSB/netwillpromptforpassword.
28
a.
Ifyouarepromptedforapassword,enter12345 (defaultpassword).
Tip: You will not be prompted for a password if you connect using a
COM port.
b. TypeATandpressEnter.Youshouldgetareplyof OKor0.
29
c.
AT Command
Whenusingaterminalapplication,youwillneedtomanually typeineachcommand. Formostcommands,whenyouareenteringthemusinga terminalconnection,youwillneedtoprefacethe commandwithAT(exceptionsarenoted),i.e.ATAwhich islistedasA. Somecommandshavespecificparameterswhileother commandswilltakewhateveryoutype. Requiredvariableparametersaredenotedwithitalicized text,example,Dn.Thenisvariable. Acceptableparametersand/orspecificformatsarelisted witheachcommand. Mostcommandswithparameterscanbeenteredwith?to readthecurrentvalue(forexample,AT&D?willrespond with2ifthedefaulthasnotbeenchanged). Optionalparametersaredenotedwithsquarebrackets[]. ATCommandsarenotcasesensitive.AcapitalEisthe sameasalowercasee. Whenyouareusingaterminalconnection,ifyouentera commandwhichisrecognizedbytheRavenXE,itwill respondwithOK.Ifthecommandisnotrecognized,the responsewillbeERROR. Thosecommandsapplicableonlytocertainmodel numbersoftheRavenXEwillbenoted.
part of the command and must be included. Commands with symbols other than * may require PassThru mode.
30