POWERED OFF. When operating, the Sierra Wireless AirLink Raven 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 may be used at this time. The driver or operator of any vehicle should not operate the Sierra Wireless AirLink Raven 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, ...
Page 3
Patents Copyright Trademarks Rev 3.0B Feb.08 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. 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,890,057 5,929,815 6,169,884 6,339,405 6,359,591 6,400,336 6,643,501 6,653,979 6,697,030 6,847,830 6,876,697 6,879,585 6,985,757 7,023,878...
AirLink Communications documentation - CDPD, CDMA, and GPRS. AirLink Communications documentation - CDMA, EV-DO, EDGE, and HSDPA. Converted documentation from AirLink Communications documentation format into Sierra Wireless documentation format. Phase II of the conversion completed. Raven modem line documentation is revised. Preface...
Connecting to the your cellular provider Network • EDGE Communication Rev 3.0B Feb.08 The Raven 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 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. Figure 1-1: Sierra Wireless AirLink Raven ALEOS™ ALEOS, the embedded core technology of the Sierra Wireless AirLink products simplifies installation, operation and mainte‐ nance of any solution, and provides an always‐on, always‐ aware intelligent connection for mission‐critical applications. ALEOS enables: • Persistent Network Connectivity • Over‐The‐Air (OTA) Upgrades • Wireless Optimized TCP/IP •...
Rev 3.0B Feb.08 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. AceWare™ is the device management and monitoring application suite for Sierra Wireless AirLink products powered by ALEOS. • AceManager • AceNet • AceView • Modem Doctor These modem utilities, except AceNet, are free of charge to those who own Sierra Wireless AirLink modems. 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 information on AceNet. Note: AceView, AceManager, and AceNet require the Microsoft .NET Framework v. 1.1 and Microsoft Windows 98, Windows 2000, Windows XP, or later.
Introduction to the Raven Figure 1-3: AceManager Simplified Deployment AceManger 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 other devices in your fleet with identical settings, ensuring a simple, accurate deployment. Monitor and Control AceManger 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, and much more. After configuring one modem, use the template feature to copy that device configuration to other modems. Tip: Configuration steps and examples in this guide use AceManager.
Introduction to the Raven AceNet AceNet, the enterprise grade productivity enhancing tool, enables you to efficiently deploy and monitor Sierra Wireless AirLink products on a large scale. Figure 1-4: AceNet Network Monitoring AceNet allows you to efficiently deploy, monitor, and maintain wireless networks of any size by enabling you to quickly configure an entire group of Sierra Wireless AirLink modems to the same parameter settings using templates built with AceManger. To ensure your implementation is optimal, users can easily see when modems are out of contact and periodically poll each device for performance statistics. AceView AceView is an efficient status and connection monitoring application with a low‐profile, easy to read interface. Figure 1-5: AceView Rev 3.0B Feb.08...
Introduction to the Raven Modem Doctor Modem Doctor is a troubleshooting and diagnostics utility. This utility will allow you to get a log file of the Raven activity which you can then send to Sierra Wireless support, erase the current configuration completely. Rev 3.0B Feb.08...
Rev 3.0B Feb.08 Figure 1-6: Modem Doctor Modem Doctor USB Open the ModemDoctorUSB.exe. Select any one option. Note: If you are using USB port as serial, then USB device is set to “o” and if you are using the default option then the USB device is set to “1”.
Rev 3.0B Feb.08 Figure 1-7: Modem Doctor: USB connection Connecting to the your cellular provider Network The Raven uses your cellular provider as an ISP (Internet Service Provider) to connect you to the Internet. Steps of a connection: When your Raven is powered on, it automatically searches for cellular service using EDGE. Your Raven establishes a PPP (Point to Point Protocol or “dial” up connection) link to the your cellular provider network, also called registering on the network, and receives an IP address. When your Raven has received its IP address from your cellular provider, a connection to the Internet or the cellular network is also available for a computer or other device connected directly to the Raven. Cellular Introduction to the Raven...
Rev 3.0B Feb.08 Figure 1-8: Connecting to the Internet The Raven will perform a one‐to‐one routing for all internet traffic to and from the computer or other end device. One‐to‐ one means that your Raven will provide a connection for one device to the Internet at a time. In Private Mode, the Raven will provide NAT (Network Address Translation) for the computer or other end device. Note: The Raven does not provide advanced routing required by one- to-many (several devices connected to one port). If you need to have more than one device connected to the Internet through your Raven, you will need to have a router connected to the modem.
Introduction to the Raven 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. Caution: If you want to connect remotely to your Raven 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 custom APN or special private network) unless you are on the same network or inside that network’s firewall (such as with frame relay).
2: Specifications • Power Connector Rev 3.0B Feb.08 Features and Benefits • Embedded Intelligence • Low Power Consumption • High‐Speed 2‐way Data • Ethernet Port • Persistent Network Connectivity • Remote Management and Configuration • Class I Div 2 Certified Technology • GSM EDGE With Fallback to: · GPRS (MS‐12) Bands • Quad Band GPRS/EDGE · 850 MHz, 900 MHz, 1800 MHz and 1900 MHz Environmental • Operating Temperature: · ‐30 to 70° Celsius •...
Network • Installating the SIM • Configuring the APN Rev 3.0B Feb.08 This chapter provides step‐by‐step directions for activating your Raven on the your cellular provider cellular network. Installating the SIM The SIM in the Raven is a smartcard securely storing the key identifying a cellular subscriber. Generally, you will only need to install a SIM once in the life of the modem and it may be pre‐installed by your Sierra Wireless Representative. 1. Before you start If the SIM was pre‐installed, unless you need to set a custom APN, activation of your modem is complete. Cellular Account Required • Cellular account ‐ To use your modem you need to have a SIM (Subscriber Identity Module) with an active account with an EDGE cellular provider. Software Required • AceManager ‐ Graphical interface for entering most AT ...
Rev 3.0B Feb.08 Activating Raven on your cellular provider Network • Slim stylus ‐ A PDA stylus, an unbent paperclip, or other such item. 1. Opening the Case Unplug the Raven power and all cables. Using a small phillips head screw driver, remove the screws on the back of the Raven. Slide the case off of the Raven and set it aside. Figure 3-1: Partially removed case Carefully remove the SIM card from the card you got from your cellular provider. 3. Ejecting the SIM tray Tip: The button is between two boards. Figure 3-2: SIM tray button...
Page 24
Note: The card and SIM may be a different color than these examples. Rev 3.0B Feb.08 Activating Raven on your cellular provider Network 4. Insert the SIM into the Tray Remove the SIM from the card you obtained from your your cellular provider. Figure 3-3: Insert SIM in to the modem Place the SIM into the tray and gently press to click it ...
Rev 3.0B Feb.08 Activating Raven on your cellular provider Network Figure 3-5: Inserting the SIM 6. Finishing the SIM installation Slide the Raven back into the case. Secure the back of the Raven with the screws. Configuring the APN The APN (Access Point Name) is the way your modem knows how it will be communicating with the network. The APN allows custom IP addressing and tailoring your companyʹs wireless IP solution to meet the security and IP addressing requirements of your applications. Note: Most accounts use the default addressing solution of Private or Public IP addresses supplied by the Internet and Proxy APNs.
Rev 3.0B Feb.08 Activating Raven on your cellular provider Network Figure 3-6: AceManager 2. Connect to the Modem Click the Connect button. Select TCP or UDP. Enter the connection information. · For UDP or TCP, enter 192.168.13.31 as the IP address. Enter the password. The default password will be entered for you. Select OK. 3. Enter the APN Select EDGE/HSDPA from the menu on the left side of AceManager (under “Groups”)
Page 27
Rev 3.0B Feb.08 Activating Raven on your cellular provider Network Figure 3-7: AceManager : EDGE/HSDPA Type your APN in the New Value field of *NETAPN. Figure 3-8: AceManager : EDGE/HSDPA - *NETAPN Optional: If you need to configure your modem for a cus‐ tom APN, after entering the APN, there is additional infor‐ mation you will need to enter. Select Misc from the menu on the left side under the Common group. Figure 3-9: AceManager : Misc Enter the NAI into the new value field for *NETUID and enter your network password into the new value field for *NETPW. Figure 3-10: AceManager : Misc - *NETUID, *NETPW...
Page 28
Rev 3.0B Feb.08 Activating Raven on your cellular provider Network 4. Write the Settings to the Raven Click the Write button on the tool bar of AceManager. Wait for the message “Write Successful” to appear in the status bar. Figure 3-11: AceManager : Write Reset the Raven.
4: Hardware Installation of the Raven • Connecting to Power • Connecting to a Computer or other Device • Indicator Lights • Mounting Rev 3.0B Feb.08 Your Raven 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 tempera‐ tures. The LEDs on the front panel should be visible for ease of operational verification. You should ensure that there is adequate airflow around the modem but that it is kept free from direct exposure to the elements, such as sun, rain, dust, etc. In a mobile location, such as a car or truck, ensure the location is secure both against abrupt movements of the vehicle and from other items coming into contact with the modem. Caution: The Raven is in a hardened case and designed for use in industrial and extreme environments.
Note: When using a DC power source (such as a car battery or 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.
Rev 3.0B Feb.08 Hardware Installation of the Raven Connecting to a Computer or other Device Figure 4-2: Ethernet The Ethernet port of your Raven can be connected directly to a computer or other Ethernet device with either a cross‐over cable or a straight‐through cable. The Ethernet port on the Raven is auto‐sensing and connects at 10baseT. If you are connecting the modem to a hub or switch you should use a straight through cable or use the uplink port on the hub or switch with a cross‐over cable. Tip: On some computers, the TCP receive window may be set to 16 kbytes. To optimize the throughput of your Raven, it is recommended that you change the TCP window to 128 kbytes to 256 kbytes using a TCP Optimizer.
Rev 3.0B Feb.08 Hardware Installation of the Raven • RSSI (signal level) ‐ 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. RSSI LED Ranges RSSI/Signal LED Status Ranges of RSSI (dBm) On Solid Equal to or stronger than -69 Fast Blink -70 to -79 Normal blink -80 to -89 Slow Blink -90 to -99 Extinguished...
Page 33
Hardware Installation of the Raven 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ʺ. Figure 4-4: Optional Mounting Bracket Rev 3.0B Feb.08...
Page 34
Hardware Installation of the Raven Figure 4-5: 100-170-1009 : Mounting Bracket for Raven Rev 3.0B Feb.08...
Page 35
Hardware Installation of the Raven Figure 4-6: 100-170-1006 : Mounting Bracket for Raven Rev 3.0B Feb.08...
Since the AceWare applications are designed for ease of use, nearly all descriptions and screen shots of Raven configuration in this guide and Application Notes are done with AceManager. In addition to the various chapters in this guide giving information and directions about using the features of your Raven, the Configuration Commands appendix briefly describes all the commands available. 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 Appendix A. Using AceManager AceManager is a free utility and is available on the product CD or can be downloaded from the Sierra Wireless America website:http://www.sierrawireless.com/support/AirLink/ default.aspx. Tip: AceManager is the same application as Wireless Ace. The name was changed to fit better with its features.” 1. Start AceManager Start > All Programs > AirLink Communications > AceManager ...
Page 37
Rev 3.0B Feb.08 Figure 5-1: AceManager 2. Connect to your Raven Click the Connect button. Figure 5-2: AceManager : Connect to Modem Select a connection method: · If you are connecting remotely, you can use UDP, TCP, or SMS. · If you are connecting locally with the modem connected directly to your computer using a serial cable, you can use PPP. · If you are connecting locally with the modem connected directly to your computer using an Ethernet cable, you can use UDP, TCP, or Ethernet. Enter the connection information. · For UDP or TCP, if you are connecting locally, use the *HOSTPEERIP of the modem to connect. The default for the *HOSTPEERIP is 192.168.13.31. · For SMS, enter the phone number of the modem and select your wireless carrier. · For PPP, select the COM port to which the modem is ...
Page 38
Rev 3.0B Feb.08 Select OK. Figure 5-3: AceManager : Connected 3. Enter the configuration options On the left side of AceManager is the Groups menu. Select the appropriate group as needed or directed. Enter your changes in the New Value column by typing in the desired change or using the drop down menus. The current configuration is shown in the Value column. Figure 5-4: AceManager : Changing values Configuring your Raven...
You can reset the modem by using the Reset button in AceManager or by using the reset button on the modem. You can also reset the modem by cycling the power. Using Templates If you have a modem configuration that works well for your needs, using AceManager, you can save that modem’s configu‐ ration as a template and then apply it to other Sierra Wireless AirLink modems. 1. Creating the Template with AceManager Configure the “master” modem. Click the Copy button on the tool bar to transfer all the ...
Page 40
Rev 3.0B Feb.08 Note: Some of the configuration settings are specific to individual modems. You do not want to have those settings in your saved template otherwise the modems you configure with the template could cease to work with the cellular or local network. ·...
Page 41
Rev 3.0B Feb.08 2. Applying a Template to one modem with AceManager You can use a template you created yourself, using the steps above, or a template provided by your AirLink representative or someone in your company who has set up a modem template. The template you wish to apply must be saved to your hard drive. Load the template. Connect to the modem you want to configure using AceManager. Click on the Load button on the toolbar. Figure 5-8: AceManager : Load Select the template you have saved (you may need to change folders if you saved it to a different location). Verify the configuration settings. Tip: After you load the template, it’s best to go back over the AceManager groups to make sure all the settings are what you require.
Page 42
Configuring your Raven Tip: You can use common settings on one modem to configure those same settings on another modem even of a different type. For example, you can use the serial settings of a modem (such as PinPoint X or Raven X) to configure the serial settings of a Raven. Settings not applicable to the modem on which you are loading the template, will be discarded.
Page 43
Rev 3.0B Feb.08 Figure 5-10: AceNet : Selected modems Tip: Click on the first with your mouse and, with the control button held down, click the additional modem. Select the Modem option in the tool bar and then select Apply AceManager Template. Figure 5-11: AceNet : Modem menu Either type in the Template file name, or click browse and select the template file you want to apply (you may need to change folders). Figure 5-12: AceNet : Template select Set the Retry Interval and check if you want to have ...
Figure 5-13: HyperTerminal 1. Choose a name and icon for your connection. Choose a name for your connection, such as Raven or Sierra Wireless AirLink Solutions. The name and icon are only for your own reference so you can find the connection at a later date. 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 local.
Page 45
Rev 3.0B Feb.08 2. Connect To Select TCP/IP (Winsock) for “Connect Using”. Type in 192.169.13.31 for Host Address. Change the “Port Number” to 2332. Select OK. 3. Connected Figure 5-14: HyperTerminal : TCP/IP connected If you are prompted for a password, enter 12345. Configuring your Raven...
Rev 3.0B Feb.08 Type AT and press Enter. You should get a reply of “OK” or “0”. 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. If you get a reply of “OK”, then you entered the command successfully. If you get a reply of “0” or “ERROR”, try entering the command again. AT Commands When using a terminal application, you will need to manually type in each command. • 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. • Acceptable parameters and/or specific formats are listed with each command. • 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). • Optional parameters are denoted with square brackets [ ]. • AT Commands are not case sensitive. A capital “E” is the same as a lower‐case “e”. • When you are using a terminal connection, if you enter a command which is recognized by the Raven, it will ...
6: Data Communication and Host Modes • Basic Modes • Data Communication Rev 3.0B Feb.08 The Raven plays the part of a HOST when a computer or another device is connected directly to its port and routes data to/from the connected device to the cellular network. Caution: The Raven moves data from one port to the cellular network in a simple one-to-one routing. It does not employ a routing table or any complicated routing protocol.
Rev 3.0B Feb.08 Data Communication and Host Modes Basic Modes AT Mode Using a terminal connection, AT commands are used to configure the modem, command it to do something, or query a setting. For a full listing of the AT commands, refer to the appendix. AceManager is a graphical user interface for most AT Commands. • AT commands must always be terminated by <CR> (ASCII character 0x0D), a carriage return (pressing enter on the keyboard). Some may also include a new line or line feed <LF>. • If E=1 (Echo On), the AT command (including the termi‐ nating <carriage return) will be displayed (output) before any responses. • Two settings affect the format of AT command output: V (Verbose) and Q (Quiet). • If Q=1 (Quiet On), no result codes are output whatsoever, so there is no response generated by a (non query) command. • If Q=0 (Quiet Off), result codes are output. The format of this output is then affected by the Verbose setting. If Quiet mode is off, the result code is affected as follows: For V=1 (Verbose mode), the textual result code is sur‐ rounded by a carriage return and new line. Any AT query response is also surrounded by a carriage return and new line.
Data Communication and Host Modes PassThru Mode In PassThru mode, the Raven does not behave normally, all port communication is passed directly between the internal hardware and the computer connected directly to the modem. This mode can be used to configure hardware‐specific settings. For example, provisioning, troubleshooting, communicating with legacy equipment, etc. Caution: ALEOS is disabled in PassThru Mode. You cannot use most ALEOS specific commands while the modem is in PassThru Mode. While in PassThru mode, you also cannot use AceManager to connect with the PinPoint.
Rev 3.0B Feb.08 Data Communication and Host Modes Telnet Mode In AceManager you can configure Telnet operation. Figure 6-2: AceManager : S0 If you need to change the port for Telnet (for example, you have the default port blocked on your firewall), the option is on the Other tab. The default telnet port is 2332. You can also change the Telnet timeout, if the connection is idle, default 2 minutes. Figure 6-3: AceManager : Other - *TPORT, *TELNETTIMEOUT. UDP and UDP Pad TCP and TCP Pad Hybrid Modes AT Command Hybrid Mod (MD5) *UDPLAST...
NAT to forward packets to the end device. Tip: When using Public mode, Sierra Wireless recommends connecting the modem directly to the computer or other end device. Using a hub or switch may prevent the Raven from updating the IP address of the end device when an IP address is received from the cellular network.
Rev 3.0B Feb.08 Data Communication and Host Modes Figure 6-4: AceManager : PPP/Ethernet • *HOSTPRIVMODE ‐ Set to 1 to enable the explicit IP addresses. • *HOSTPRIVIP ‐ Set to the IP address you want the Raven to give to your device. • *HOSTPEERIP ‐ Set to the IP address you want for the Raven. • *HOSTNETMASK ‐ Set to the subnetmask, generally 255.255.255.0. Tip: If you are using Private Mode (*HOSTPRIVMODE=1), you will need to make sure that *HOSTPRIVIP and *HOSTPEERIP are on the same subnet.
Rev 3.0B Feb.08 Data Communication and Host Modes When the Raven registers on the cellular network, it is assigned an IP address from your cellular provider, let’s say A.B.C.D. Acting as a DHCP server, in Public Mode, when the Raven receives a DHCP request from an Ethernet device, it hands off the assigned address to the device and sets up the default gateway address as A.B.C.1. If the fourth octet is already a 1, it assigns A.B.C.2 as the router address. The Raven also sends a /24 netmask (255.255.255.0 by default) and sets up a static route which maps 192.168.13.31 (or the address configured with *HOSTPEERIP if it is changed) to A.B.C.1 (or A.B.C.2 if that was what the gateway address was given as). Tip: When PPPoE is used with the Raven, DHCP is not needed. A tunnel is set up connecting a device (such as your computer or a router) with the modem.
Rev 3.0B Feb.08 Data Communication and Host Modes Figure 6-5: AceManager : Other • *IPPING sets the interval, in minutes, you want Keepalive to test the network connection. To disable Keepalive, set *IPPING to 0 (default setting). Note: 15 minutes is the minimum time which can be set for Keepalive. If you set *IPPING for a value less than the minimum, the minimum value will be set.
7: IP Manager • Understanding Domain Names • Using IP Manager with your Raven • Understanding DNS Rev 3.0B Feb.08 If you have a fleet of Sierra Wireless AirLink modems or even if you only have one, it can be difficult to keep track of the current IP addresses, especially if the addresses aren’t static but change every time the modems connect to Provider. If you need to connect to a modem, or the device behind it, it is so much easier when you have a domain name (car54.mydomain.com, where are you?). Reasons to contact the modem and/or the connected device: • Requesting a location update from a delivery truck. • Contacting a surveillance camera to download logs or ...
Rev 3.0B Feb.08 • Dynamic IP addresses are granted only when your Raven is connected and can change each time the modem recon‐ nects to the network. • Static IP addresses are granted the same address every time your Raven is connected and are not in use when your modem is not connected. Since many cellular providers, like wire‐based ISPs, do not offer static IP addresses or static address accounts cost a premium vs. dynamic accounts, Sierra Wireless AirLink Solutions developed IP Manager to work with a Dynamic DNS server to receive notification from Sierra Wireless AirLink modems to translate the modem’s dynamic IP address to a fully qualified domain name. Thus, you can contact your Raven directly from the Internet using a domain name. Understanding Domain Names A domain name is a name of a server or device on the Internet which is associated with an IP address. Similar to how the street address of your house is one way to contact you and your phone number is another, both the IP address and the domain name can be used to contact a server or device on the Internet. While contacting you at your house address or with your phone number employ different methods, using a domain name instead of the IP address actually uses the same method, just a word based name is commonly easier to remember for most people than a string of numbers. Understanding the parts of a domain name can help to under‐ stand how IP Manager works and what you need to be able to configure the modem. A fully qualified domain name (FQDN) generally has several parts. • Top Level Domain (TLD): The TLD is the ending suffix for a domain name (.com, .net, .org, etc.) •...
Rev 3.0B Feb.08 need to be registered with ICANN or any other registry. It is the responsibility of a domain to keep track of its own subs. car54.mydomain.com • .com is the TLD • mydomain is the domain (usually noted as mydomain.com since the domain is specific to the TLD) • car54 is the subdomain or server name associated with the device, computer, or modem registered with mydomain.com car54.mydomain.com.ca This would be the same as above, but with the addition of the country code. In this example, the country code (.ca) is for Canada. Tip: A URL (Universal Resource Locator) is different from a domain name in that it also indicates information on the protocol used by a web browser to contact that address, such as http:// www.sierrawireless.com.
Rev 3.0B Feb.08 Note: The fully qualified domain name of your Raven will be a subdomain of the domain used by the IP Manager server. Using IP Manager with your Raven To allow your Sierra Wireless AirLink modem to be addressed by name, the modem needs to have a minimum of three elements configured. You can also configure a second dynamic server as a backup, secondary, or alternate server. In AceManager, select Dynamic IP. Figure 7-1: AceManager: Dynamic IP •...
Rev 3.0B Feb.08 the IP address changes (example, if your Raven is reset or is assigned a different IP address). • *IPMGRKEY1 and *IPMGRKEY2: User defined password key which is used instead of AirLink secret key when using an IP Manager server other than the one provided by Sierra Wireless. Restrictions for Modem Name For the Modem Name, you should use something which is unique but also easy to remember. Your company name or the intended function of the modem are recommended. If you have more than one modem and want to name them the same, you can append a number for each. Since it is an Internet domain name, there are some restrictions for the name. • Must begin with a letter or number • Can include a hyphen (‐) • Cannot contain spaces • Must be no longer than 20 characters total Data Usage for IP Manager Server Updates The IP Manager update is a small packet sent to the server with a response sent back to the modem. If you have *IPMGRUPDATE1 or *IPMGRUPDATE2 set to any number but zero, the modem will send the update not only when it receives a new IP address but at the time interval as well. The ...
*DOMAIN : eairlink.com • *IPMANAGER1 : edns2.eairlink.com • *IPMANAGER2 : eairlink.com Tip: When using the IP Manager service offered by Sierra Wireless, since there are many modems using the service, it is even more imperative to have a unique name for your modem. Understanding DNS The Raven has the ability to query DNS servers in order to ...
Rev 3.0B Feb.08 Figure 7-2: AceManager: DNS *DNS1 and *DNS2 ‐ The primary and secondary DNS • servers set by Provider when your Raven gets its IP address. • *DNSUSER ‐ Set this, if desired, to an additional DNS server to query first before the primary or secondary (just as a hosts file is queried first on a computer). If *DNSUSER is set to 0.0.0.0, it will be ignored. • *DNSUPDATE ‐ This command sets how often you want DNS Updates to be requested. Otherwise the Raven will only send updates when it is reset, powered up, or the IP address is granted by network changes. The “PPP-Peer” Domain Name The Raven uses the unqualified domain name of “ppp‐peer” when it is in PPP or SLIP address mode to resolve the address of the device or computer connected via PPP or SLIP address. If the Raven is not in PPP or SLIP address mode, “ppp‐peer” will resolve to 0.0.0.0. IP Manager...
8: Configuring Modbus/BSAP • Configuring the Raven at the Polling Host for Modbus on UDP • Configuring the Remote Ravens for Modbus with UDP Rev 3.0B Feb.08 The Raven supports Modbus ASCII, Modbus RTU, BSAP, and can also emulate other protocols like DF1 or others using its Modbus Variable feature. Modbus Overview The Modbus Protocol, developed by Modicon in 1979, provides for client‐server (also referred to as master‐slave) communications between intelligent devices. As a de facto standard, it is the most widely used network protocol in the industrial manufacturing environment to transfer discrete/ analog I/O and register data between control devices. Modbus, BSAP, and other Modbus variations are often used in conjunction with telemetry devices. Tip: This section is just a brief overview of Modbus.
Raven EDGE The RTU connects to physical equipment such as switches, pumps, and other devices and monitors and controls these devices. The RTU can be part of a network set up for Super‐ visory Control and Data Acquisition. Supervisory Control and Data Acquisition (SCADA) Supervisory Control and Data Acquisition (SCADA) describes solutions across a large variety of industries and is used in industrial and engineering applications to monitor and control distributed systems from a master location. SCADA encom‐ passes multiple RTUs, a central control room with a host computer (or network), and some sort of communication infra‐ structure. SCADA allows for “supervisory” control of remote devices as well as acquiring data from the remote locations. Program‐ mable Logic Controllers allow for a higher degree of automated SCADA. Programmable Logic Controller (PLC) A Programmable Logic Controller (PLC) is a small industrial computer which generally monitors several connected sensor inputs and controls attached devices (motor starters, solenoids, pilot lights/displays, speed drives, valves, etc.) according to a user‐created program stored in its memory. Containing inputs and outputs similar to an RTU, PLCs are frequently used for typical relay control, sophisticated motion control, process control, Distributed Control System and complex networking. Modbus TCP/IP Modbus TCP/IP simply takes the Modbus instruction set and wraps TCP/IP around it. Since TCP/IP is the communications standard for the Internet and most networked computers, this ...
Configuring Modbus/BSAP The remote Raven then disassembles the packet before trans‐ mitting the RTU ID and serial data to the remote unit. The remote units operate in normal UDP mode and their data is sent to the host via the remote Raven and host Raven. Configuring the Raven at the Polling Host for Modbus on This section covers a Polling Host with standard Modbus, variations may need additional AT commands. 1. Configure the listening/device ports In AceManager, select Misc in the side menu. Figure 8-1: AceManager: Misc The destination port for the modem at the host needs to match the device port (*DPORT) in use on all the modems at the remote sites. For example, if the remote modem’s device port (*DPORT) is “12345”, then the Modbus host modemʹs S53 destination port should be set to “12345”. Take note of (or set) the Device Port setting in *DPORT to configure the destination port on the remote modems. Rev 3.0B Feb.08...
Page 66
Raven EDGE 2. Configure the default mode for start-up. In AceManager, select UDP in the side menu. Select the appro‐ priate MD mode from the drop down menu. Figure 8-2: AceManager: UDP - MD • MD13: Modbus ASCII • MD23 : Modbus RTU (Binary) • MD33: BSAP • MD63: Variable Modbus ‐ individual parameters are set up manually. 3. Configure IP addresses for the Modbus IDs. The last step of configuring the modem at the host is setting the IDs to their specific IPs. In AceManager, select the menu option Addr List. Figure 8-3: AceManager: Addr List.
Page 67
Configuring Modbus/BSAP Addresses can be entered in decimal or hex. AceManager will translate hex entries into decimal. The number before the “=” is ID, the number after is the IP address. There can be a total of 100 remote ID/Local addresses entered into the modem. When using AT commands via telnet or direct serial connection, use ATMLIST for decimal IDs and ATMLISTX for hexidecimal. For example, if the ID is 27 and the IP is 123.123.123.124, you would enter it as ATMLIST27=123.123.123.124 or ATMLISTX1B=123.123.123.124. 4. Optional: Dynamic IP Address If you do not have a static IP, the host modem should be configured to report its current IP to a Dynamic DNS (DDNS) server with IP Manager. In the Host modem’s configuration, instead of IP address for the Addr List (ATMLIST or ATMLISTX), substitute a single unique name for each modem, i.e. remote1, remote2, etc. When you configure IP Manager for the host modem, make note of your modem name and domain setting in AceManager in the menu selection Dynamic IP to be used with the remote modems. Figure 8-4: AceManager: Dynamic IP With names instead of IP addresses for the Address List, the host modem will query the DNS server for the current IP address assigned to the specific name of a remote modem to send a message corresponding to the ID. When you use names instead of IP addresses, to ensure your modems are updated quickly with the correct IP addresses for the names, you will want to set the DNS settings as well. In AceManager, select DNS. Rev 3.0B Feb.08...
Raven EDGE Figure 8-5: AceManager: DNS Configure *DNSUSER to the same IP address as the IP Manager (*IPMANAGER1). If your modems have dynamic IP addresses and not static (the IP address can change when it is powered up), configure *DNSUPDATE to a low interval to allow frequent updates. Configuring the Remote Ravens for Modbus with UDP This section covers standard Modbus settings for the Raven at the remote unit, variations may need additional commands. 1. Configure the ports In AceManager, select Misc in the side menu. Figure 8-6: AceManager: Misc 20070914...
Page 69
Note: With a name instead of IPs for the host modem, the remote modems will query the DNS server for the current IP assigned to the host modem before sending data back to the host. Rev 3.0B Feb.08 The destination port for the modem at the host needs to match the device port in use on all the modems at the remote sites. For example, if the remote modem’s device port (see below) is ...
Page 70
Raven EDGE Enable S82, UDP auto answer. Set S83 to the idle time‐out applicable to your appli‐ cation, commonly 20. 4. Configure other RTU settings. Other parameters may need to be changed, but this is dependent on the RTU type being used. As a minimum, this typically involves setting the proper serial settings to match your RTU. 5. Optional: Dynamic IP Address If you do not have a static IP, the host modem should be configured to report its current IP to a Dynamic DNS (DDNS) server with IP Manager. You will need to match the name of the modem to the names specified in the host modem’s MLIST or MLISTX for the connected RTU. When you configure IP Manager for the host modem, make note of your modem name and domain setting in AceManager in the menu selection Dynamic IP to be used with the remote modems. Figure 8-8: AceManager: Dynamic IP When you use names instead of IP addresses, to ensure your modems are updated quickly with the correct IP addresses for the names, you will want to set the DNS settings as well. In AceManager, select DNS. 20070914...
Page 71
Configuring Modbus/BSAP Figure 8-9: AceManager: DNS Configure *DNSUSER to the same IP address as the IP Manager (*IPMANAGER1). If your modems have dynamic IP addresses and not static (the IP address can change when it is powered up), configure *DNSUPDATE to a low interval to allow frequent updates. Rev 3.0B Feb.08...
9: SNMP : Simple Network Management Protocol • SNMP Configuration • SNMP MIB Definition Sample Rev 3.0B Feb.08 The Simple Network Management Protocol (SNMP) was designed to allow remote management and monitoring of a variety of devices from a central location. The SNMP management system is generally composed of agents (such as your Raven, a router, a UPS, a web server, a file server, or other computer equipment) and a Network Management Station (NMS) which monitors all the agents on a specific network. Using the management information base (MIB), an NMS can include reporting, network topology mapping, tools to allow traffic monitoring and trend analysis, and device monitoring. Authentication ensures SNMP messages coming from the agent, such as the Raven, have not been modified and the agent may not be queried by unauthorized users. SNMPv3 uses a User‐Based Security Model (USM) to authenticate and, if desired or supported, message encryption. USM uses a user name and password specific to each device. The Raven can be configured as an SNMP agent and supports SNMPv2c and SNMPv3. Management Information Base (MIB) The management information base (MIB) is a type of database ...
Rev 3.0B Feb.08 SNMP : Simple Network Management Protocol SNMP Configuration To configure your Raven to work as an SNMP agent, you can use either AceManager, or a terminal connection to configure the modem using AT commands. In AceManager, the SNMP commands are all part of the Other group under the Common group. There are only three commands to set for SNMP in the Raven: the listening port, the security level, and the trap destination. Figure 9-1: AceManager : Common > Other Listening Port sets the port for the SNMP agent to listen on. If set *SNMPPORT to zero, default, SNMP is disabled. Tip: SNMP generally uses port 161, however most Internet providers (including cellular) block all ports below 1024 as a security measure.
SNMP : Simple Network Management Protocol User Name and Password The user name is ʹuserʹ. The user name cannot be changed. The Ravenʹs password is used as the SNMP password (default is ʹ12345ʹ). Tip: The eight-character password requirement for SMNPv3 is not enforced by the PinPoint X Agent to allow the default password to function. Your SNMP administrator or MIS may require you to change to a more secure and/or longer password.
Rev 3.0B Feb.08 SNMP : Simple Network Management Protocol Trap Destination *SNMPTRAPDEST needs to be set with the destination IP and port. If either are set to zero or empty, SNMP traps are disabled. Note: Traps are sent out according to the SNMP security level (i.e. if the security level is 2, traps will be authenticated and encrypted). Currently, the only trap supported is LinkUp. Community String The community string can be configured using *SNMPCOM‐...
Page 77
Rev 3.0B Feb.08 SNMP : Simple Network Management Protocol electronicID OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { general 3 } modemType OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { general 4 } aleosSWVer OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { general 5 } aleosHWVer OBJECT-TYPE...
Page 78
Rev 3.0B Feb.08 SNMP : Simple Network Management Protocol STATUS current ::= { common 2 } devicePort OBJECT-TYPE SYNTAX INTEGER(0..65535) MAX-ACCESS read-only STATUS current ::= { common 3 } netUID OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { common 4 } netPW OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only...
Page 79
Rev 3.0B Feb.08 SNMP : Simple Network Management Protocol none(0), hardware(2), software(4) } MAX-ACCESS read-only STATUS current ::= { common 10 } -- STATUS -- ipAddress OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS read-only STATUS current ::= { status 1 } netState OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current...
A: Configuration Commands • Info (information) • Status • Common • Logging • Telemetry/Addr List • Edge/HSDPA Rev 3.0B Feb.08 The configuration commands (AT commands) in this chapter are arranged according to their placement in AceManager. The commands available in AceManager will depend of the model number of your Raven and, in some cases, the version of the ALEOS firmware installed. Note: Some commands can only be configured using a terminal emulation and typed AT commands. Some commands also require PassThru mode.
Raven EDGE Figure 1-1: AceManager : Info *DEVICEID? The 64‐bit device ID the modem uses to identify itself to the cellular network. *ETHMAC? The MAC address of the Ethernet port. *NETPHONE? The modemʹs phone number, if applicable or obtainable. &V View active profile, the contents of the active registers. Not displayed with AceManager. • n=0 : Product name (for example, Raven). • n=1 : The Raven’s firmware (ALEOS) version, hardware ID, and copyright. • n=2 : The internal hardwareʹs firmware version and relevant hardware ID. • n=3 : The hardware moduleʹs unique identification number or serial number. • n=5 : View active profile (the contents of the active registers). Not displayed with AceManager. 20070914...
Note: If there is no current network IP address, 0.0.0.0 may be displayed. Rev 3.0B Feb.08 Information Displayed in AceManager without AT Commands Listed • Versions of ALEOS, internal hardware, boot, and MSCI: Versions of internally configured hardware and software. Status Most of the commands in the “Status” group have read‐only parameters and provide information about the modem. The Status Group has more fields that can be displayed on most screens. You can either resize your window or use the scroll bar on the side to display the remainder. Figure 1-2: AceManager : Status *HOSTMODE? The current host mode (AT, PPP, UDP, etc.). If the Raven is not in AT mode, telnet into the modem to execute this command. ...
Raven EDGE Tip: Use *NETALLOWZEROIP if you need to allow the display of an IP ending in a zero. *NETOP? The current cellular carrier from the modemʹs firmware version, for example, your cellular provider. *NETRSSI? The current RSSI (Receive Signal Strength Indicator) of the Raven as a negative dBm value. Tip: The same information is displayed with the command S202?. *NETSERV? The type of service being used by the modem, for example Tech. *NETSTATE? The current network state: •...
Rev 3.0B Feb.08 +RCIQ Current Cell Info Information. GPRS or EDGE Only. Information Displayed in AceManager without AT Commands Listed • Bytes and Packets Received and Sent: Network traffic for the applicable port. • Number of System Resets: Counter of the number of system resets over the life of the modem or since the configuration was reset. • Bad Password Count: Counter of the number of bad password attempts. • IP Reject Count or Log: Rejected IP Data. • Temperature of the Internal Hardware Module: The temperature of the internal radio module. AT Commands Requiring PassThru mode These commands are not displayed in AceManager. +CCID Subscriber Identity Module ID. Subscriber Identity Module ID. Configuration Commands...
Raven EDGE Note: +++ is not proceeded by AT nor does it require a carriage return (enter). There must be an idle time (set by S50) on the serial port before and after this command. Note: A/ is not proceeded by AT.
Rev 3.0B Feb.08 D[method][d.d.d.d][/ppppp] or D[method][@name][/ ppppp] Dial a connection to a remote IP and Port using method. Cannot be configured in AceManager. • method=P : Establish a UDP connection • method=T : Establish a TCP connection • method=N : Establish a Telnet connection • d.d.d.d= IP address to contact • ppppp= port to contact Examples: ATD - Dial (establish) default connection. ATDP192.168.13.31/2332 - Dial (establish) UDP session to 192.168.13.31, at port 2332. To end the connection, issue the +++ escape sequence or drop the DTR line (if Ignore DTR S211=0 or &D2). The default connection is set in S53. If the method, IP address, or port is omitted, the values from ...
Raven EDGE With an AT telnet connection, this command will terminate the host data mode and return the Raven to an AT mode. Cannot be accessed in AceManager. Online (Remote): Causes the Raven to go from Command State to data state. Cannot be configured in AceManager. OPRG=n Enables/disables over‐the‐air firmware upgrading of the Raven. When Sierra Wireless releases a new version of ALEOS, you can upgrade your remote modems with OPRG enabled. • n=0 : Disables • n=1 : Enables S53=[method][d.d.d.d][/ppppp] Destination IP address, port, and method. These are used as defaults for the D (Dial) AT command. • method= P : UDP • method=T : TCP • method=N : Telnet • d.d.d.d=IP address or domain name • ppppp=the port address Examples: ATS53=T192.168.100.23/12345 ATS53=foo.earlink.com Telnet to the specified IP at port 12345. ATS53=192.168.100.23/12345 Query the specified IP at port 12345. ATS53=/12345 Query port 12345. Command Response Mode. • n=0 : Terse (numeric) command responses •...
Rev 3.0B Feb.08 &W Writes all changed modem settings. If this command is not issued, any modified values will revert back to their previous values at modem reset. Cannot be configured in AceManager. *DATE=[mm/dd/yyyy],[hh:mm:ss] Sets and queries the internal clock. Either the date and time can be specified, or simply one of the two can be specified in which case the unspecified value will remain unchanged. The date and time are always specified 24‐hour notation. • mm/dd/yyyy=date in month/day/year notation • hh:mm:ss=time in 24‐hour notation *DPORT=n The modemʹs Device Port which the modem is listening on for inbound packets/data/polls. Can also be set with the command S110. • n=1‐65535 *HOSTPAP=n Use PAP to request the user login and password during PPP negotiation on the host connection. • n=0 : Disable PAP request (Default). • n=1 : Takes user login and password from Windows DUN connection and copies to *NETUID and *NETPW. *NETALLOWZEROIP=n Allows the displayed IP address in *NETIP to end in zero (ex. 192.168.1.0). • n=0 : Do not allow. • n=1 : Allow. *NETPW=pw The password that is used to login to the cellular network, when required. •...
Raven EDGE *NETUID=uid The login that is used to login to the cellular network, when required. • uid=user id (up to 64 bytes) *STATICIP=d.d.d.d Set the static IP required to be received from the network. If the modem does not get this IP address from the network, it will reset the internal hardware and try again. The default is 0.0.0.0, which allows any IP address from the network. • d.d.d.d=IP address Example: AT*STATICIP=192.168.1.23 Caution: STATICIP does not set the IP address of the modem, it merely tells the modem which IP address to expect. If the expected IP...
Rev 3.0B Feb.08 Figure 1-4: AceManager : DNS *DNSn=d.d.d.d Queries the DNS addresses. Your cellular carrier provides the DNS addresses while your modem is registering on their network. • n=1 or 2 : First and second DNS address. • d.d.d.d=IP address of domain server. *DNSUPDATE=n Indicates whether the modem should send DNS updates to the DNS server specified by *DNSUSER. These updates are as per RFC2136. They are not secure and are recommended only for a private network. In a public network, the IP Logger services should be used instead. • n=0 : DNS updates disabled (Default). • n=1 : DNS updates enabled. *DNSUSER=d.d.d.d Sets a user‐provided DNS to query first when performing name resolutions in the modem. • d.d.d.d=IP address of domain server Dynamic IP This group includes commands specific to dynamic DNS. Dynamic DNS allows the Raven to use a dynamic IP address account, with an IP address that can change each time you connect, and still allow you to use a fully qualified domain name to contact the Raven using IP Manager running on a server with a dynamic DNS updater. Configuration Commands...
Raven EDGE Figure 1-5: AceManager : Dynamic IP *DOMAIN=name Domain (or domain zone) of which the Raven is a part. This value is used during name resolutions if a fully qualified name is not provided and also for DNS updates. This value can be up to 20 characters long. • name=domain name (i.e. eairlink.com) If *DOMAIN=eairlink.com, then when ATDT@remote1 is entered, the fully qualified name remote1.eairlink.com will be used to perform a DNS query to resolve the name to an IP address. Tip: Only letters, numbers, hyphens, and periods can be used in a domain name. *IPMANAGERn=[name][IP address] Sets a domain name or IP address to send IP change notifica‐ tions to. Up to two independent IP Manager servers can be set, using either AT*IPMANAGER1 or AT*IPMANAGER2. Updates to a server can be disabled by setting that entry to nothing (for example, “AT*IPMANAGER1=”).
Rev 3.0B Feb.08 • n=2 : Second IP Manager server. • key=128‐bit key in hexadecimal [32 hex characters] *IPMGRUPDATEn=m Sets the number of minutes to periodically send an IP update notification to the corresponding server. This will occur even if the IP address of the Raven doesnʹt change. *IPMGRUPDATE1 is used to set the refresh rate to *IPMANAGER1, while *IPMGRUPDATE2 is used with *IPMANAGER2. If the value is set to 0, then periodic updates will not be issued (i.e. IP change notifications will only be sent when the IP actually changes). • n=1 : First IP Manager server. • n=2 : Second IP Manager server. • m=0, 5‐255 : Number of minutes to send an update. *MODEMNAME=name Name of the Raven (up to 20 characters long) to use when performing IP address change notifications to IP Manager. The value in *DOMAIN provides the domain zone to add to this name. • name=modem name (for example, mymodem) Example: if *MODEMNAME=mymodem and *DOMAIN=eairlink.com, then the modemʹs fully qualified domain name is mymodem.eairlink.com. Automatically Generated Names: #I3 ‐ The ESN/IMEI will be used as the name. #CCID ‐ The CCID will be used as the name. #NETPHONE ‐ The phone number will be used as the name. Tip: Each modem using IP Manager needs a unique name. Two modems cannot be called “mymodem”.
Raven EDGE Figure 1-6: AceManager : PPP/Ethernet *DHCPSERVER=n • Act as a DHCP server for any Ethernet device connecting to the Raven. DHCP (Dynamic Host Configuration Protocol) allows one device, the DHCP server, to provide dynamic IP addresses to any other device which requests them. • n=1 : Enabled. The modem will act as the primary DHCP server for the network. n=2 : Enabled if no other DHCP server is detected • (default). If another DHCP server is detected on the network, the Raven will not send out replies to DHCP requests.n=0 : Disabled. The Raven X will not send out replies to DHCP requests. Tip: For PPPoE, set *DHCPSERVER=0. *HOSTAUTH=n Host Authentication Mode: Use PAP or CHAP to request the user login and password during PPP or CHAP negotiation on the host connection. The username and password set in *HOSTUID and *HOSTPW will be used. • n=0 : Disable PAP or CHAP request (Default). • n=1 : PAP and CHAP. • n=2 : CHAP Tip: For PPPoE, set *HOSTAUTH=1 or *HOSTAUTH=2.
Rev 3.0B Feb.08 *HOSTNETMASK=n.n.n.n Subnet mask for the host interface. Allows communication with a subnet behind the host interface. • n.n.n.n = subnet mask, example 255.255.255.0. *HOSTPEERIP=d.d.d.d Set or query the IP address that can be used to directly contact the Raven once a cellular connection is established. If this value is not specified, 192.168.13.31 will be used. • d.d.d.d=local or peer IP address of the modem. Note: This is not normally used nor needed by user applications. *HOSTPRIVIP=d.d.d.d Set or query the private IP address that is to be negotiated by the 1x connection if *HOSTPRIVMODE =1. • d.d.d.d=IP Address *HOSTPRIVMODE=n Set or query whether a private or public (network) IP is to be used when the Host initiates a 1x connection to the modem. • n=0 : Public (network) IP Mode: When the Host initiates a PPP connection, the host will be given the network IP address that was obtained from the cellular carrier while registering on the network. If the network issues a new IP address, the cellular connection will be closed (since the IP address has changed) and has to be re‐initiated. (default). •...
Raven EDGE Note: This mode is not available through the remote AT telnet server. You will need to connect to the Raven with it connected directly to your computer. PassThru PassThru Mode is used to communicate directly to the Raven internal hardware. Caution: While the modem is in PassThru mode, ALEOS is disabled.
Rev 3.0B Feb.08 *PTINIT=string Any AT Command string to be passed to the OEM module before entering PASSTHRU mode, e.g. AT&S1V1, etc. • string=AT command(s) *PTREFRESH=n Number of minutes of inactivity in PASSTHRU mode to resend the *PTINIT string to the hardware module. • n=0 : Disabled • n=1‐255 minutes *RESETPERIOD=n In PASSTHRU mode, modem will be reset after this period if no data has been sent or received. Value is in hours. • n=0 : Disabled • n=1‐255 hours SMTP SMTP (Simple Mail Transfer Protocol) is the de facto standard for email transmission across the Internet. The Raven can send messages using SMTP if it has been configured to use a mail server. Note: You cannot send an Email with your Raven unless the Email server you have configured allows your Raven as a relay host.
Raven EDGE Figure 1-8: AceManager : SMTP *NETSMS2EMAIL=n Specify the SMS/E‐mail server number. This maybe necessary to send an SMS message to an email address. Cannot be used with AceManager. • n=SMS/E‐mail server number *SMTPADDR=[d.d.d.d][name] Specify the IP address or Fully Qualified Domain Name (FQDN) of the SMTP server to use. • d.d.d.d=IP Address • name=domain name (maximum: 40 characters). *SMTPFROM=email Sets the email address from which the SMTP message is being sent. email=email address (maximum: 30 characters). • *SMTPPW=pw Sets the password to use when authenticating the email account (*SMTPFROM) with the server (*SMTPADDR). • pw= password Note: Not required to use SMTP settings but may be required by your cellular carrier.
Rev 3.0B Feb.08 *SMTPSTATUS? Returns the status of the last issued SMTP message (*SMTPSEND). If no status is available 0 is returned. Once read, the status is cleared out. The status codes returned come from the SMTP server to which that the modem sent the request. Unless the receiving server is not standard, they follow the RFC for SMTP. Cannot be used with AceManager. Example: 354 = send in progress 250 = sent ok *SMTPSUBJ=subject Allows configuration of the default Subject to use if one isnʹt specified in the message by providing a “Subject: xxx” line as the initial message line. • subject=message subject *SMTPUSER=user The email account username to authenticate with the SMTP server (*SMTPADDR) for sending email. • user=username (maximum: 40 characters). Note: Not required to use SMTP settings but may be required by your cellular carrier.
Raven EDGE Other Figure 1-9: AceManager : Other DAE=n AT Escape Sequence detection. • n=0 : Enable • n=1 : Disable *DATZ=n Enables or disables reset on ATZ. • n=0 : Normal Reset (Default). • n=1 : Disable Reset on ATZ. *IPPING=n Set the period to ping (if no valid packets have been received) a specified address (*IPPINGADDR) to keep the modem alive (online). • n=0 : Disable pinging (default) • n=15‐255 minutes Note: 15 minutes is the minimum interval which can be set for Keepalive.
Rev 3.0B Feb.08 *IPPINGADDR=[d.d.d.d][name] Set the IP address or valid internet domain name for the Raven to ping to keep itself alive (online). *IPPING must to be set to a value other than 0 to enable pinging. • d.d.d.d=IP address • name=domain name *MSCIUPDADDR=name[/port] Modem Status Update Address ‐ where Name/Port is the domain name and port of the machine where the modem status updates will be sent. The status parameters of the Raven are sent in an XML format. • name=domain name • port=port *MSCIUPDPERIOD=n Modem Status Update Period ‐ where n defines the update period in seconds. • n=0 : Disabled. • n=1‐255 seconds *NETWDOG=n Network connection watchdog: The number of minutes to wait for a network connection. If no connection is established within the set number of minutes, the Raven modem resets. • n=0 : Disabled. • n=minutes : Default = 120 min. *RESETCFG Wipe the non‐volatile data in the modem. Cannot be used with AceManager. Caution: You may need to reactivate your modem if you erase the non-volatile data.
Raven EDGE • n=0 : SNMP is disabled. • n=1‐65535 *SNMPSECLVL=n Selects the security level requirements for SNMP communica‐ tions. • n=0 : No security required. SNMPv2c and SNMPv3 communications are allowed. • n=1 : Authentication equivalent to “authNoPriv” setting in SNMPv3. SNMPv3 is required to do authentication, SNMPv2c transmissions will be silently discarded. • n=2 : Authentication and encryption, equivalent to “authPriv”ʹ setting in SNMPv3. SNMPv3 is required to do authentication and encryption, SNMPv2c and SNMPv3 authNoPriv transmissions will be silently discarded. Messages are both authenticated and encrypted to prevent a hacker from viewing its contents. *SNMPTRAPDEST=host/[port] Controls destination for SNMP Trap messages. If port is 0 or host is empty, traps are disabled. Traps are sent out according to the SNMP security level (i.e. if the security level is 2, traps will be authenticated and encrypted). Currently, the only trap that can be generated is linkup. • host=IP address • port=TCP port *SNTP=n Enables daily SNTP update of the system time. • n=0 : Off • n=1 : On *SNTPADDR=[d.d.d.d][name] SNTP Server IP address, or fully‐qualified domain name, to ...
Rev 3.0B Feb.08 *TPORT=n Sets or queries the port used for the AT Telnet server. If 0 is specified, the AT Telnet server will be disabled. The default value is 2332. • n=0 : Disabled. • n=1‐65535 Tip: Many networks have the ports below 1024 blocked. It is recom- mended to use a higher numbered port. *TQUIT Disconnects the telnet session. Not available in AceManager.. Friends Friends Mode can limit access to the Raven from the cellular network and the Internet. Friends mode is a basic firewall. Caution: If you are using Friends Mode you will not be able to use AceManager remotely or Telnet to the modem unless you are contacting the modem from one of the configured IP addresses.
Raven EDGE FM=n Friends Mode ‐ Only allow specified IPs to access the Raven modem. • n=0 : Disable Friends mode • n=1 : Enable Friends mode ‐ Only packets from friends will be accepted, packets from other IP addresses are ignored. Fn=[d.d.d.d] Friends mode IP address. • n=0‐9 Friends list index • d.d.d.d = IP address Using 255 in the IP address will allow any number. Example: 166.129.2.255 allows access by all IPs in the range 166.129.2.0‐166.129.2.255. Tip: ATF? will return a list of all the current Fn settings. Logging This group includes commands specific to the internal log. Caution: Logging is intended for diagnostic purposes only. Extensive use of logging features can cause degraded modem performance.
Rev 3.0B Feb.08 *DBGDHCPLVL=n Enable or disable internal DHCP logging. n=0 : No logging • • n=1 : Log DHCP events. *DBGETHLVL=n Sets the logging level for the Ethernet port. • n=0 : No logging • n=1 : Log errors: invalid/corrupt packets, etc. • n=2 : Log the header of all received packets. Note that this can quickly exhaust available space for the event log. *DBGIPLVL=n Sets the logging level for the IP subsystem. • n=0 : No logging • n=1 : Log errors (i.e. invalid/corrupt packets, etc.). • n=2 : Log the header of all received packets. Note that this can quickly exhaust available space for the event log. • n=3 : Log the header of all received and sent packets. Note that this can quickly exhaust available space for the event log. *DBGPPPLVL=n Sets the logging level for the PPP stack. • n=0 : No logging • n=1 : Log client events (default) • n=2 : Log server events • n=3 : Log client and Server events ...
Raven EDGE Figure 1-12: AceManager : Telemetry IPL=n IP List Dial allows access the Modbus IP list using the first two digits of the dial string. Example: ATDT1234567 would go to ID “12” on the Modbus list and use the associated IP as the destination. • n=0 : Disabled • n=1 : Enabled MVLEN=n Modbus Variant ID Length: Length of the RTU ID in a modbus‐variant protocol, in bytes. • n=1 : This parameter is used to define the length of the RTU ID in Modbus‐like protocol data packets. • n=2 : This parameter is used when the when the MD is set to hex 63. MVMSK=hh Modbus Variant ID Mask: Byte hex mask to use when extracting the ID. Specify which bits in the ID field to use. This parameter is used when the when the Mode Default (MD) is set to hex 63. • hh=hex value · 00 ‐ no mask, all 8 bits (default) · 0F ‐ only the low order 4 bits MVOFF=n Modbus (variable mode) Offset: Indicates the offset in the data of where the Modbus ID starts. •...
Rev 3.0B Feb.08 MVOPT=n Modbus Variant Option: Sets various behavioral options when dealing with a Modbus‐variant protocol. This parameter is used when the when MD is set to hex 63. Cannot be configured in AceManager. • n=0 : No special action (Default). • n=1 : Skip leading zeroes in Modbus packets. MVTYP=n Modbus Variant Type: The data‐type of the RTU ID in a modbus‐variant protocol. This parameter is used to define the data‐type of the RTU ID in Modbus‐like protocol data packets. This parameter is used when MD is set to 63. • n=0 : Binary (Default) • n=1 : ASCII Hex • n=2 : ASCII Decimal RKEY=n Enable/disable MDS Radio transceiver keying. Radio keying is designed to assert CTS when a packet is received, delay the time as specified, send the data out the serial port, wait the same amount time, drop CTS. This way, the CTS signal can be used to key a transmitter on and give it time to reach its power level before data is sent to it. Delay interval is specified in S221. • n=0 : Off (Default). • n=1 : On. Addr List Figure 1-13: AceManager : Addr List Configuration Commands...
Raven EDGE MLIST and MLISTX are configured by the fields available in the Addr List group. AceManager automatically differentiates between them to enter the correct command for the modem. MLISTid=d.d.d.d Enters an ID and IP address into the Modbus List. ID is a decimal value (1 to 100). • id=ID • d.d.d.d=IP address or name MLISTXhexid=d.d.d.d Enters an ID and IP address into the Modbus List. ID is a hexadecimal value (0 to 64). hexid=ID • • d.d.d.d=IP address or name Edge/HSDPA This group includes commands specific to HSDPA, EDGE and GPRS. If you are not connecting to a modem which uses HSDPA, EDGE, or GPRS, you will not see this group in the menu. 20070914...
Rev 3.0B Feb.08 Figure 1-14: AceManager : EDGE/HSDPA *NETAPN=apn Easy entry of the APN. If left blank, the modem will attempt to use the default subscriber value as defined by the account. apn=access point name • +CGQMIN Minimum Acceptable Quality of Service Profile. Change should be at carrierʹs request. Normally not required to be changed. +CGQREQ Set Quality of Service Profile. Change should be at carrierʹs request. Normally not required to be changed. +COPS=mode,[format][,oper] Manually specify an operator. Refer also to *NETOP. • mode=0 : Automatic ‐ any affiliated carrier [default]. • mode=1 : Manual ‐ use only the operator <oper> specified. • mode=4 : Manual/Automatic ‐ if manual selection fails, goes to automatic mode. • format=0 : Alphanumeric (ʺnameʺ) (G3x10 must use this format). • format=2 : Numeric • oper=”name” Configuration Commands...
B: Circuit Switch Communications • Step by Step Configuration • Step by Step Configuration Note: When the Raven is used for circuit switch, the circuit switch configuration will disable all ALEOS features except for serial port communication. Rev 3.0B Feb.08 Circuit‐switch communication requires the Raven to be in ...
Raven EDGE The Raven needs a command string sent to the modem after it is initialized. The command string will need to be tailored for your application. Different models of the Raven may respond differently to some of the commands. In the PassThru group, type your command string in the input field for *PTINIT. Figure 2-2: AceManager: PassThru AT Commands and the Command String Each modem requires a command string that is a combination of AT commands limited to a maximum of 40 characters. The command string will vary depending on the needs of the connected device. For example, some devices need DTR to be high while others need DTR to be ignored. For a full listing as well as parameters and defaults, refer the AT Command appendix. Caution: The only commands that can be used in the string are those which do not require ALEOS. All AT Commands beginning with an * (asterix) require ALEOS.
1. Gather the required hardware and software Hardware Required • A personal computer with a functioning serial port or USB port and a USB to serial converter configured to work with your computer. • A straight through RS232 cable (DB9M‐DB9F). • A suitable power supply and antenna for the Raven. Without suitable signal strength the modem will not function. Better than at least ‐100dBM is required. Software Required • Modem Doctor ‐ Utility to conduct diagnostics and to bring your modem to a base‐level of configuration. You can download Modem Doctor from the Sierra Wireless AirLink Solutions website: http://www.airlink.com. This utility does not need to be installed; it is run directly. Remember where you downloaded it to, so you can run it as part of the instructions below. • AceManager ‐ Graphical interface for entering most AT Commands. You can download AceManager from the Sierra Wireless AirLink Solutions website: http:// www.airlink.com/. A default installation of this utility is assumed later in these directions. • Raven Templates for Circuit‐Switch ‐ These templates are provided by your Sierra Wireless AirLink Solutions repre‐ sentative and have a .xml extension. You can also download the appropriate template from: http:// www.airlink.com/docs/AppNotes/CircuitSwitchTem‐...
Page 115
Raven EDGE 2. Connect the modem to your computer Using the RS232 cable, connect the modem to the computer and apply power to the modem. 3. Erase the internal memory The Raven should have the internal memory erased to bring the modem to a known starting point without any configu‐ ration or account programming. Start Modem Doctor. Select Erase the modemʹs non‐volatile data. Figure 2-3: Modem Doctor Select Serial from the Interface options and select the Port on your computer to which the Raven is connected. Leave the Baud setting at 115200. Figure 2-4: Modem Doctor: Interface Click the Next button and press the modem Reset button when prompted. The modem Reset button is located on the front panel of the modem and can be accessed with the point of a pen or similar tool. 20070914...
Page 116
Rev 3.0B Feb.08 Circuit Switch Communications Figure 2-5: Raven: Reset button Click the Exit button in Modem Doctor when the process is complete. 4. Activate the Raven 5. Start AceManager. Start > All Programs > AirLink Communications > AceManager 3G > AceManager 3G Click the Connect button. Figure 2-6: AceManager Select PPP. Select COM1 for the Port. Enter 12345 for the Password. Click OK. Figure 2-7: AceManager : Connect to Modem using PPP 6. Configure serial port speed. On the left, under the GROUPS heading, select Serial. ...
Page 117
Raven EDGE Figure 2-8: AceManager : Serial - *MODEMHISPEED Change the *MODEMHISPEED setting to “0”. 7. Save the serial setting. Click the Write button on the tool bar of AceManager and wait for the message “Write Successful” to appear in the status bar. Figure 2-9: AceManager : Write Click the Clear button. Figure 2-10: AceManager : Clear Click the Disconnect button. Figure 2-11: AceManager : Disconnect Press the modem Reset button on the front of the modem. 20070914...
Page 118
Rev 3.0B Feb.08 Circuit Switch Communications Figure 2-12: Raven: Reset Wait until the modem REG indicator is lit and then proceed to the next step. 8. Configure the Raven using a AceManager template. Caution: Do not proceed to this step before the REG indicator light is lit. Click the Refresh All button on the tool bar of AceManager and wait until all of the modem infor‐ mation is loaded into the AceManager application. Figure 2-13: AceManager : Refresh All Click the Load button on the tool bar. ...
Page 119
Raven EDGE 9. Configure additional PassThru settings. On the left, under the GROUPS heading, select PassThru. Figure 2-16: AceManager : PassThru For *PTREFRESH, enter a value of 15. For *RESETPERIOD, enter a value of 6. 10. Save the configuration settings. Click the Write button on the tool bar of AceManager and wait for the message “Write Successful” to appear in the status bar. 11. Configure the Raven for your equipment. Make any appropriate changes to the serial port parameters to match your equipment. These changes are made under the group Serial. Caution: Do not under any circumstances change the *MODEMHISPEED setting from the template configuration, the only recommended setting to change is the S23 setting.
Page 120
Note: The dial test should be completed with the serial cable disconnected to verify that no signaling is required by the modem. Rev 3.0B Feb.08 Circuit Switch Communications 13. Test the Raven Configuration. Once the modem has been activated and you’ve built the command string it is recommended that the Raven modem be tested previous to field installation. Verify that the modem Chan, Link and Reg indicators are blinking in unison confirming that the modem is now operating in circuit switched (IS‐95) mode. Dial the Raven modem telephone number from a land line and verify that the modem automatically answers ...
C: Windows Dial-up Networking (DUN) • Installing a modem driver for Raven • Creating a Dial-Up Networking (PPP) Connection • Connecting to the Internet Using DUN Rev 3.0B Feb.08 Dial‐up Networking (DUN) allows a computer or other device to use the on your Raven to connect to the Internet or private network using PPP just like an analog modem using a standard phone line. Caution: To install any driver on your computer, you may need to be logged in as Administrator or have Administrator privileges for your login.
Page 123
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-1: Phone and Modem Options Select the Modems tab. Figure 3-2: Phone and Modem Options: Modems Select Add.
Page 124
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-3: Add Hardware Wizard Check Don’t detect my modem; I will select it from a list. Select Next. Figure 3-4: Add Hardware Wizard: Install New Modem Select (Standard Modem Types) from the Manufacturers column. Select Standard 33600 bps Modem from the Models column.
Page 125
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Tip: If you have the speed for your modem configured as something other than the default, use the Standard Modem that matches the speed you configured. Select Next. Figure 3-5: Add Hardware Wizard: Select Ports Check Selected Ports Select the COM port the modem is connected to ...
Windows Dial-up Networking (DUN) 3. Configure the driver. When you return to the Phone and Modem Options window, you should see the newly installed modem “attached to” the correct COM port. Figure 3-7: Phone and Modem Options: Modems Highlight the modem and select Properties. Figure 3-8: Modem Properties Rev 3.0B Feb.08...
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Select the Modem tab. Figure 3-9: Modem Properties: Modem Maximum Port Speed should be set to 115200 (default). Select OK to exit. Select OK again to exit out of the Phone and Modem Options. Creating a Dial-Up Networking (PPP) Connection Once you have the driver for the modem installed on your computer, you can set up and configure Dial Up Networking (DUN) to use the modem as your connection to the Internet using PPP. Note: No other device or program can be using the same COM port (serial port) configured for the modem driver.
Page 128
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Caution: If you have an existing LAN connection, installing DUN for the modem may interfere with the LAN connection. It's recommended to disconnect your LAN connection before using a PPP connection with your Raven. Once the DUN connection is initiated, by default, it will take ...
Page 129
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Select Create a New Connection under Network Tasks in the menu area on the left. Figure 3-11: Create New Connection Select Next to start installing and configuring the DUN connection. Figure 3-12: New Connection Wizard Select Connect to the Internet. Select Next. ...
Page 130
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-13: New Connection: Type Select Set up my connection manually. Select Next. Figure 3-14: New Connection: How do you want to connect? Select Connect using a dial‐up modem. Select Next. Figure 3-15: New Connection: Connect using... Optional: If you have multiple modems installed on your computer, you may be prompted to select the modem to be used. If you only have one modem installed, this option will be omitted. Check Standard 33600 bps Modem. Select Next. ...
Page 131
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-16: New Connection: Select Modem Type in a name for the connection, such as Sierra Wireless AirLink Modem. Select Next. Figure 3-17: New Connection: Connection Name Tip: The name provided here will not effect the connection in any way. It is only a label for the icon. It can be the name of your wireless service provider (Provider), your modem (Raven), or any other desig- nation for the connection.
Page 132
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-19: New Connection: Permissions Generally the modem takes care of the Account Information, User name and Password, for the connection, so you can leave the fields blank (unless otherwise instructed by Support). If you want to allow others to use the same login for the modem, select Use this account name and password... Select Next. Figure 3-20: New Connection: Connection Information Caution: If you have a LAN connection to the Internet and select Make this the default Internet Connection for the DUN configuration, you will not be able to use the LAN to connect to the Internet and may also affect the network connection on your computer to the rest of the LAN.
Page 133
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-21: New Connection: Finish 2. Configure the DUN connection After you complete the New Connection Wizard, there are a few more things you will want to configure in the connection. Select Properties. Figure 3-22: DUN Connection Uncheck Use dialing rules. ...
Page 134
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Check Show icon...when connected. Select Configure, below the Connect using line. Figure 3-23: DUN Properties Select 115200 as the Maximum speed. Check Enable hardware flow control. Do not check any other option. Select OK. ...
Page 135
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-24: Modem Configuration Back at the main properties screen, select the Networking tab. Figure 3-25: Networking Select Settings. Remove the checks from all three PPP settings. Select OK. ...
Page 136
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) Figure 3-26: PPP Settings Select (highlight) Internet Protocol (TCP/IP) and then select Properties. Tip: For most configurations, you will be obtaining the IP address and the DNS server address automatically. Select Advanced. Figure 3-27: TCP/IP Properties Uncheck Use IP header compression. Check Use default gateway on remote network. Select OK.
Caution: Unless specifically directed to do so by Support or your network administrator, you do not need to make any changes to the options on the Security tab. Select OK until you return to the Connect window. Connecting to the Internet Using DUN There are two methods you can use to connect with Raven to the Internet using DUN, AceView and the Windows DUN connection directly. AceView AceView is a small utility which can maintain your DUN connection and monitor the connection of your Raven to Provider. If you have not already installed AceView you can obtain the most recent version from the Sierra Wireless Airlink website. This guide assumes you have a default installation of AceView. 1. Start AceView. Start > All Programs > AirLink Communications > AceView...
Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) 2. Enable the Connection. Figure 3-29: AceView: Menu Right‐click on the AceView window to open the menu. Select Connection Settings. Figure 3-30: AceView: Connection Settings Select Auto Start in the DUN section. Select Maintain Persistent Connection. When checked, AceView will continually check the DUN connection to ensure it is not down. If so, AceView will attempt to connect again. Tip: When using the DUN connection, make sure the IP Address is set to the local IP address of the modem, 192.168.13.31 by default. Select OK.
Page 139
Provider or the Internet. Rev 3.0B Feb.08 Windows Dial-up Networking (DUN) 1. Start the DUN session. Start > Connect To > Sierra Wireless Airlink Modem If you named the connection differently, use the name of the PPP connection you made earlier. Figure 3-31: DUN Connection Tip: Generally you will not need to enter a Username or Password. If you do need to enter either, you can enter these parameters beforehand using *NETUID and *NETPW.
Page 140
Windows Dial-up Networking (DUN) Caution: For DUN connections on a Windows Mobility or other non- personal computer, the DNS settings may not be configured with the DUN connection. You may need to go into the network settings and add DNS servers manually. Rev 3.0B Feb.08...
Need help?
Do you have a question about the Raven EDGE and is the answer not in the manual?
Questions and answers