Page 1
Raven 1x for TELUS User Guide 20070914 Rev 3.0B...
Page 2
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
Preface 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. Patents Portions of this product may be covered by some or all of the following US patents: 5,515,013 5,629,960 5,845,216 5,847,553 5,878,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...
Monday to Friday, except US Holidays support@sierrawireless.com E-mail: Sales Desk: Phone: 1-510-781-4200 1-604-232-1488 Hours: 8:00 to 5:00 Pacific Time MobileandM2Msales@sierrawireless.com E-mail: Post: Sierra Wireless America 3159 Corporate Place Hayward, CA 94545 Sierra Wireless 13811 Wireless Way Richmond, BC Canada V6V 3A4 Fax: 1-510-781-4299 1-604-231-1109 www.sierrawireless.com...
Q2: 2005-Q2: AirLink Communications documentation - CDMA, EV-DO, EDGE, and 2007 HSDPA. in draft Converted documentation from AirLink Communications documentation format into Sierra Wireless documentation format. Phase II of the conversion completed. Raven modem line documentation is revised. Rev 3.0B Feb.08...
• Connecting to the Powered by ALEOS™, Raven modems are designed to TELUS Network maintain a reliable, consistent network connection. With a • 1x Communication serial interface and a vast library of machine protocols, the Raven is a workhorse for industrial and mission critical appli‐ cations. Class I Divison 2 certified as nonincendive equipment, the Raven Series is ideally suited for use in hazardous environ‐ ments. Key applications include utilities, manufacturing, automation, oil and gas, SCADA, telemetry, Homeland Security and asset monitoring. 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 • Real‐Time Notification •...
Introduction to the Raven • Protocol Spoofing Figure 1-2: Powered by ALEOS AceWare™ A wireless solution is not complete until you have software tools to manage the devices monitoring your valuable equipment. AceWare™ is the device management and monitoring application suite for Sierra Wireless AirLink products powered by ALEOS. AceManager • • AceNet • AceView • Setup Wizard • 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.
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. Rev 3.0B Feb.08...
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 Setup Wizard A quick and easy way to activate and configure your Raven to connect to the TELUS cellular network is by using the AceWare Setup Wizard. 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., and temporarily set the Raven to a known configuration to aid in trouble shooting (SOS mode). Rev 3.0B Feb.08...
Introduction to the Raven 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”.
Introduction to the Raven Figure 1-7: Modem Doctor: USB connection Connecting to the TELUS Network The Raven uses TELUS 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 1x. Your Raven establishes a PPP (Point to Point Protocol or “dial” up connection) link to the TELUS network, also called registering on the network, and receives an IP address. When your Raven has received its IP address from TELUS, a connection to the Internet or the cellular network is also available for a computer or other device connected directly to the Raven. Rev 3.0B Feb.08...
Introduction to the Raven 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 TELUS cannot be a private or internal IP address (such asspecial private network) unless you are on the same network or inside that network’s firewall (such as with frame relay).
3: Activating your Raven on the TELUS Network • Setup Wizard • Activating Using AT This chapter provides step‐by‐step directions for activating Commands your Raven on the TELUS cellular network. Setup Wizard You can find the Setup Wizard installation on the CD which came with your Raven or on the Sierra Wireless website: http:// www.sierrawireless.com/support/AirLink/default.aspx.Use only the Setup Wizard for TELUS for best results. Note: The Setup Wizard requires the Microsoft .NET Note: If you are setting modem for circuit switched mode, pelase test framework v.
Raven 1x Figure 3-1: Setup Wizard Click Next to start the Wizard process. 2. Connecting to the Modem Selector USB/net connection Note: If you want to use USB with the Setup Wizard you will need to first install the driver, refer to Installing the USB driver section in this Chapter.
Page 26
Activating your Raven on the TELUS Network Note: You cannot activate with serial and would need USB/net to use set up wizard. After the Setup Wizard connects to your Raven, the details for your specific model will be displayed. If the incorrect model is displayed, press the Reset Button on your Raven so the Wizard can attempt to connect again. Click Next. Figure 3-3: Setup Wizard : Connected 3. Selecting Tasks After the Wizard detects your Raven, you will be offered a menu of Setup tasks. Choose the tasks you need from those displayed. Note: Some tasks shown in the example here might not be available for your Raven model.
Page 27
Note: While checking for ALEOS Firmware updates, the Setup Wizard uses the Internet connection on your computer to connect to the Sierra Wireless server. Your Raven is not connected to the wireless network for this process. Figure 3-5: ALEOS Update Tip: You can download current ALEOS firmware from the Sierra Wireless web site and install it separately.
Page 28
Activating your Raven on the TELUS Network 5. Activate Modem The steps and data required to activate your Raven on the TELUS network varies depending on the model. The Wizard is designed to support older models as well as those currently shipping. To configure or provision your modem to work on the TELUS network, you will need device activation information provided by TELUS. Fill in the requested information and click Next on each screen. • MSL ‐ Master Subsidy Lock or Activation Code to unlock the internal hardware of your Raven. This code is provided by TELUS. • Activation Code to unlock the internal hardware of your Raven. This code is provided by TELUS. • Le code dʹactivation est le code requis pour saisir des données dans le Raven. Figure 3-6: Setup Wizard : Activation Code • MDN ‐ The phone number of your cellular account. • MIN or MSID ‐ The identification number for your cellular account. Caution: Your MDN and MIN or MSID may be different.
Page 29
Raven 1x Figure 3-7: Setup Wizard MDN and MIN/MSID • Static IP ‐ If you have a cellular account with a static IP address, check this box if it is displayed. Caution: If you do not have a static IP account and check the Static IP box, you may not be able to activate your Raven or register on the TELUS network.
Page 30
Activating your Raven on the TELUS Network Figure 3-8: Setup Wizard : Signal Test Tip: 6. Test Modem Setup Your connection of your Raven to the Internet is tested using the TELUS cellular network. Figure 3-9: Setup Wizard: Connection Test Green checks in the boxes indicate the tests were successful and your Raven is functioning properly. At this point your modem is configured and activated to work on the TELUS network. Note: These tests, depending on the strength of your signal, may take a few minutes.
Page 31
Raven 1x 7. Optional: Setting up a DUN Connection Dial‐up Networking (DUN) allows a computer or other device to use the serial port on a Raven to connect to the Internet or private network just like an analog modem using a standard phone line. The Setup Wizard will install a driver for the Raven and set up the connection between your computer and the Raven. You will need to have administrator access on the computer for this section of the installation. If you already have other modems installed on your computer, they will be listed on the Sierra Wireless AirLink Modem Installation screen. If you have other modems installed on your computer using the same serial port, they may conflict. As long as you do not intend to use them, you can Remove other modems using this menu. Figure 3-10: Setup Wizard : DUN driver Select Install to begin adding the driver for the Raven to your computer. Figure 3-11: Setup Wizard : DUN settings The COM port and speed should match the settings of the Raven and where it will be connected (default settings will be pre‐entered). ...
Page 32
Activating your Raven on the TELUS Network your computer. Select Continue Anyway to install the driver. When the driver is installed, you will return to the Modem installation screen. The Raven should now be listed (in addition to any other modem installed on your computer). Click Next to continue to install the DUN configu‐ ration. Figure 3-12: Setup Wizard : DUN connections If you already have a DUN connection installed for a different modem, it will be listed on the Dial‐up Networking Connection screen. Select Add to create a new connection for the Raven. Figure 3-13: Setup Wizard : DUN settings From the drop down menu, select Sierra Wireless modem. The defaults for the phone number, user name and password will already be entered. Select Next to begin the install. Rev 3.0B Feb.08...
Raven 1x Figure 3-14: Setup Wizard : DUN At the completion of the DUN installation, you will return to the Dial‐up Networking Connection screen. The AirLink modem should now be listed as a connection. Your modem is now ready to be used as a DUN device for any applications on your computer needing a network connection. If you have DUN installed for more than one modem, you will need to specify in your application which DUN to use. Unless it is the only DUN, your Raven may not be the one your computer sees as a default. Activating Using AT Commands An alternate method to configure and activate your Raven is by using AT commands sent directly to the modem with a terminal application (refer to the troubleshooting section). This method is recommended only in situations where the Setup Wizard is not available and/or when the configuration for the Raven is unusual. Caution: It is not possible to activate the Raven using either AceManager or AceNet. Set telnet timeout in to 20 minutes. ...
Page 34
Activating your Raven on the TELUS Network · If you have the different numbers for the MIN and MDN or MSID: AT*PROVISION2=MSL,MDN,MIN/MSID[,SID,NID] Rev 3.0B Feb.08...
4: Hardware Installation of the Raven • Connecting to Power • Connecting to a Your Raven should be mounted in a position that allows easy Computer or other access for the cables so they are not bent, constricted, in close Device proximity to high amperage, or exposed to extreme tempera‐ • Indicator Lights tures. The LEDs on the front panel should be visible for ease of operational verification. You should ensure that there is • Mounting 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.
The DC power cable positive lead should be connected to the Note: When using a DC power battery or power source positive terminal. The power cable source (such as a car battery or negative lead should be connected to the battery or power solar cell), Sierra Wireless source negative terminal. 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.
Hardware Installation of the Raven Connecting to a Computer or other Device Figure 4-2: Serial The serial port of your Raven can be connected directly to most computers or other devices using a standard straight through cable. If you have a DCE device, you will need a null modem or null modem cable. Indicator Lights When your Raven is connected to power and an antenna, there is a specific pattern to the lights to indicate its operation mode. Figure 4-3: Raven Indicator lights • Chan (channel) ‐ Indicates the modem has acquired a network channel. • Link ‐ Indicates a successful connection to the cellular network. • Reg (registration) ‐ Indicates the Raven has acquired an IP fromTELUS. • 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.
Hardware Installation of the Raven 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 Equal to or weaker than -100 •...
Page 40
Hardware Installation of the Raven Figure 4-4: Optional Mounting Bracket Rev 3.0B Feb.08...
Page 41
Hardware Installation of the Raven Figure 4-5: 100-170-1009 : Mounting Bracket for Raven Rev 3.0B Feb.08...
Page 42
Hardware Installation of the Raven Figure 4-6: 100-170-1006 : Mounting Bracket for Raven Rev 3.0B Feb.08...
5: Configuring your Raven • Using AceManager • Using Templates With ALEOS as its “brain”, the Raven is a highly configurable • Using a Terminal device, more than just a “dumb” modem. Application with AT To configure your Raven, you have two options. You can use Commands the configuration and management applications of the AceWare suite or you can use a terminal emulator application such as HyperTerminal, PuTTY, or many others. 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.
Page 44
Configuring your Raven 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 ...
Configuring your Raven 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 Rev 3.0B Feb.08...
Configuring your Raven 4. Write the changes to the modem Click the Write button on the tool bar of AceManager. Wait for the message “Write Successful” to appear in the status bar. Figure 5-5: AceManager : Write Tip: Some configuration settings will require you to reset the modem before they will take effect. You can reset the modem by using the Reset button in AceManager or by using the reset button on the modem.
Page 47
Configuring your Raven 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. ·...
Configuring your Raven 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 49
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 50
Configuring your Raven 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 ...
Configuring your Raven Using a Terminal Application with AT Commands You can access and configure your Raven using a terminal application such as Microsoft HyperTerminal, PuTTY, or similar. The following directions are for HyperTerminal which is part of a standard installation of Windows XP. Start > All Programs > Accessories > Communications > HyperTer‐ minal 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.
Page 52
Configuring your Raven 2. Connect To Select COM1, or the comport to which the modem is connected, for the “Connect Using”. Figure 5-14: Connect To Type in 192.169.13.31 for Host Address. Change the “Port Number” to 2332. Select OK. 3. Port Settings (serial only) Change or verify the settings: · Bits per Second: 115200 (default) · Data Bits: 8 · Parity: None · Stop Bits: 1 Rev 3.0B Feb.08...
Page 53
Configuring your Raven · Flow Control: Hardware. Figure 5-15: Port Settings Tip: If you have configured the Raven 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. Select OK.
Configuring your Raven 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 • Serial Modes • Data Communication 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.
Data Communication and Host Modes • UDP and UDP PAD: Any data received on the serial port is assembled into UDP packets and sent to the session’s associated IP address and Port (described later). Any responses received from the associated IP address and port destined for the Device Port are unwrapped and sent out the serial port. • TCP and TCP PAD: Any data received on the serial port is packaged into TCP messages and sent to the associated connection’s IP address and Port (described later). Any data received from the TCP peer is unwrapped and sent out the serial. Data Communication • Public and Private Modes: The method used by the Raven to pass an IP address to a connected device. • Keepalive: How the Raven maintains its connection to the cellular network. Basic Modes Start up Mode The serial port of the Raven can be configured to enter any of the modes automatically on power up (in most cases, this is also after it has registered on the cellular network). This is done by setting the Startup Mode Default to the desired mode. If this setting is non‐zero, the modem will enter the specified mode after 5 seconds. If you want to cancel this behavior, the ATMD0 command can be used before the 5‐second time‐out expires. You can configure the Startup Mode in AceManager at part of the UDP group.
Data Communication and Host Modes If the serial port of the Raven is in any mode other than AT or PassThru, the AT command mode can be re‐entered by: • Deactivating DTR (if &D2 or Ignore DTR, S211, is not set). • Issuing the +++ escape sequence (if Disable AT Escape, DAE, is not set). • Resetting or Power cycling the modem. Note: DTR needs to be asserted (S211=1 or &D0) by the host before PPP Mode, SLIP Mode, UDP PAD Mode, or TCP PAD Mode can be entered.
Data Communication and Host Modes carriage return ‐ if V=0 carriage return and new line OK another carriage return and new line ‐ if V=1 Note: These commands work for the port on which they are executed. For example, if the user types ATE1 and then AT&W using a serial port connection, it will set the serial port to Echo On. PassThru Mode In PassThru mode, the Raven does not behave normally, all ...
Data Communication and Host Modes PassThru Mode allows only specific AT commands. Some ALEOS commands will be unavailable when the Raven is in PassThru mode. The commands usable also depend heavily on the modem model number (found on the label on the top of the Raven). Note: Some internal hardware requires upwards of 20 seconds before AT commands can be entered, so be patient if there seems to be no response to AT commands. Telnet Mode In AceManager you can configure Telnet operation.
Page 60
Data Communication and Host Modes PPP mode is entered from the AT mode by using any of the following commands: • AT\APPP • ATDT10.0.0.1 • ATDT10001 • ATD#19788 or #777 *99***1# • CLIENT In response to any of the preceding commands, the Raven will respond with CONNECT a carriage return and new line and is ready for the host to begin PPP negotiations. The IP received by the host in the resulting negotiation will either be a private (non‐routable) IP address or a public (network‐routable) IP address provided by the network, depending on the settings of *HOSTPRIVMODE. If *HOSTPRIVMODE=1, the value of the private IP address can be determined beforehand by querying S110. The private IP address to be used can be defined with the command AT*HOSTPRIVIP=192.168.100.33, substituting the desired IP address. Figure 6-5: AceManager : PPP/Ethernet Using a private IP insulates the PPP client from changes in IP addresses of the underlying network. The will perform basic NAT‐like address translation on all packets. If a public IP address is being used, any changes in the IP (as determined by the wireless network) will result in the PPP link to the host being disconnected, requiring the host to reinitiate it. The public IP is passed to the host in the PPP negotiations, so when the network forces a change, the modem has to force ...
Data Communication and Host Modes SLIP SLIP mode is entered be using the “AT\ASLIP” command. As in PPP Mode, the IP address that the host assumes is affected by the setting of *HOSTPRIVMODE. SLIP does not negotiate the IP address with the connected device or computer, so before making a SLIP connection, the SLIP driver on that device or computer must be configured to use the IP address specified by querying S110. UDP and UDP Pad When the modem is in UDP PAD (Packet Assembly and Disas‐ sembly) Mode, all characters received on the serial port are assembled into UDP packets and sent to the remote IP address/port or the Raven, and any packets received from the same IP/port‐destined for the device port of Raven (see *DPORT)‐‐are disassembled and dumped onto the serial line. A UDP session is initiated by one of the following events: • Using the Dial UDP (DP) AT command (example, ATDP192.168.3.23/3456). • Setting the Startup Mode Default (MD) to 3 (UDP) so that a UDP session is entered automatically when the modem registers onto the network. Serial data will be sent to the IP/port specified in S53. Incoming UDP packets will be processed out the serial port if • UDP auto answer is enabled (S82=2); • The destination IP address matches that in S53 (if Friends Mode is enabled, the IP address also needs to be present on the Friends List); • Or allow any IP is set (AIP=1);...
Data Communication and Host Modes remote IP/port until no data is sent or received for the time interval defined in the UDP auto answer time‐out (S83). During this session, packets from other IP/port addresses will be rejected, unless *UALL is set. Whether or not an incoming packet will cause the modem to enter a UDP session is always dependent on the S53 and AIP settings. The Normal UDP Mode (MD3) can be combined with UDP auto answer to cause the incoming serial data to be sent in UDP packets (instead of being treated as AT commands), while allowing sessions to be established from different UDP sources. A UDP session will be initiated either by incoming serial data or by an incoming UDP packet. The session, started by either method, will be terminated when no data has been sent or received for the S82 period. Once the session termi‐ nates, another may be initiated by either means. When idle, after the time‐out has occurred, the modem is in AT command mode on the serial port, and any valid AT command may be entered during this time. Tip: It is best to ensure the idle time-outs for TCP and UDP are never 0 if you're going to be using auto-answer, or either PAD mode. In those circumstances, you will want the modem to close the socket if the connection goes idle for too long, particularly if the other side doesn’t normally close the connection.
Data Communication and Host Modes until it receives an acknowledgement with this sequence number. If an acknowledgement is not received within the time‐out period (specified in S7), the data will be retrans‐ mitted. This will continue until an acknowledgement is received or the modem is reset. Likewise any UDP packets received by the Raven are expected to have this simple header. The Raven will issue an acknowledgement for any valid packets which are received. To configure the Raven for a normal UDP session, you need to set the Startup Mode Default to 73 (ATMD73). If you are using two modems, configure the Destination IP and Port in each to point to each other. Serial data will then be sent reliably between the two. Caution: Although it adds reliability, the simple implementation of the Reliable UDP mode in the does not check for duplicate packets. UDP Multicast Mode UDP Multicast mode results in any data received from the host ...
Data Communication and Host Modes • TCP auto answer is enabled (S1), a TCP connection request is received, and the modem is not in a data session. • Data is received on the serial port and · The Startup Mode Default (MD) is 4 (auto TCP) · The remote TCP destination, as defined in S53, success‐ fully responds to the TCP connection request. The value of S7 (TCP Connection Time‐out) specifies the number of seconds to wait, after initiating a TCP connection attempt, for a successful connection to be established. If the connection has not been successfully established before the time‐out occurs, ERROR/BUSY is returned. TCP packet assembly is affected by the values of S50 (PAD Forwarding Time‐out) and S51 (PAD Forwarding Character). Data received in the serial buffer will be transmitted when the idle inter‐character time‐out specified in S50 (in tenths of seconds) occurs or when a character is received that matches S51 (if non‐zero). The TCP session will be terminated if no data is transmitted or received for the time interval specified in TCPT and TCPS. TCPT is the number of minutes (TCPS=0) or seconds (TCPS=1) used for this idle time‐out. Caution: TCPT should never be 0 when using the TCP mode. A broken TCP session can result in the modem being left with a TCP half-open connection that can only be terminated with a reset.
Page 65
Data Communication and Host Modes with UDP PAD mode (MD3), effectively this is the same as MD5 and MD6 previously accomplished. Setting MD5 and MD6 are still supported, but not recommended. AT Command Hybrid Mod Hybrid Mode2 (MD5) (MD6) *UDPLAST Rev 3.0B Feb.08...
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.
Data Communication and Host Modes Figure 6-6: 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.
Data Communication and Host Modes properly. If it determines the connection is not functioning, the modem will then attempt to reconnect to TELUS to reestablish IP connectivity. Configuring Keepalive In AceManager, the Keepalive settings are part of the Other group. Figure 6-7: 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.
Page 69
Data Communication and Host Modes and is billable by TELUS. The following *IPPING settings will incur approximate monthly data usage in addition to any other data usage: *IPPING Estimated Usage 15 minutes 400k / month 30 minutes 200k / month 60 minutes 100k / month 120 minutes 50k / month Rev 3.0B Feb.08...
7: IP Manager • Understanding Domain Names • Using IP Manager with If you have a fleet of Sierra Wireless AirLink modems or even your Raven if you only have one, it can be difficult to keep track of the • Understanding DNS 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 survey a specific area. • An oil derek that needs to be triggered to begin pumping. •...
IP Manager • 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.) • Country Code Top Level Domain (ccTLD): This suffix is often used after the TLD for most countries except the US ...
IP Manager 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.
IP Manager 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 •...
IP Manager 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 data traffic could be billed by your carrier. Each update is a total of 68 bytes from the modem with a 50 ...
24/7. 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.
IP Manager 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. Rev 3.0B Feb.08...
8: Configuring Modbus/BSAP • Configuring the Raven at the Polling Host The Raven supports Modbus ASCII, Modbus RTU, BSAP, and for Modbus on UDP can also emulate other protocols like DF1 or others using its • Configuring the Modbus Variable feature. Remote Ravens for Modbus with UDP 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. For more infor- mation, refer to your Modbus equipment distributor or manufacturer or http://www.modbus.org.
Raven 1x 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 provides a simpler installation. Modbus TCP/IP uses standard ...
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 80
Raven 1x 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. 20070914...
Page 81
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 1x 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...
Configuring Modbus/BSAP 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 “12345”, then the Modbus host modem’s S53 destination port should be set to “12345”. Set the destination port (S53) to match the device port of the host modem (*DPORT). Make sure the device port of the remote modem (*DPORT) matches the destination port of the host modem (S53). 2. Configure IP addresses for the host. If the Host modem has a static IP address, enter it in the Desti‐ nation Address for S53. If the modem at the host has a dynamic IP and is using IP Note: With a name instead of Manager, instead of an IP address for S53, specify the name of IPs for the host modem, the the host modem (*MODEMNAME). If the remote modems are remote modems will query the using a different DDNS than the host modem, you will need to ...
Page 84
Raven 1x 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 85
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 The Simple Network Management Protocol (SNMP) was Sample 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 used to compile the information from the various SNMP agents. Reports from various agents, such as the Raven, are sent as data in form designed to be parsed by the NMS into its ...
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. You should be able to use a higher numbered port such as 10161.
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.
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 91
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 SYNTAX DisplayString...
Page 92
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 STATUS current...
Page 93
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 ::= { status 2 } netChannel OBJECT-TYPE...
A: Configuration Commands • Info (information) • Status • Common The configuration commands (AT commands) in this chapter • Logging are arranged according to their placement in AceManager. • Telemetry/Addr List The commands available in AceManager will depend of the • 1x/EV-DO 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 1x Figure 1-1: AceManager : Info *DEVICEID? The 64‐bit device ID the modem uses to identify itself to the cellular network. *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 (ESN). • n=5 : View active profile (the contents of the active registers). Not displayed with AceManager. Information Displayed in AceManager without AT Commands Listed • Versions of ALEOS, internal hardware, boot, and MSCI: Versions of internally configured hardware and software. 20070914...
Configuration Commands 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. *NETCHAN? The current active 1x/CDMA channel number. *NETERR? The EVDO or CDMA network frame error rate. *NETIP? The current IP address of the modem reported by the internal Note: If there is no current module, generally obtained from TELUS. This is the address network IP address, 0.0.0.0 may can contact the Raven from the Internet. be displayed. Tip: Use *NETALLOWZEROIP if you need to allow the display of an IP ending in a zero.
Raven 1x *NETOP? The current cellular carrier from the modemʹs firmware version, for example, TELUS. *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: • Connecting To Network: The Raven is in the process of trying to connect to the cellular network. • Network Authentication Fail: Authentication to the cellular network has failed. Verify settings to activate the Raven. • Data Connection Failed: The Raven failed to connect, and it is now waiting a set time interval before it attempts to reconnect. Verify settings to activate the Raven. • Network Negotiation Fail: Network connection negoti‐ ation failed. This is usually temporary and often clears up during a subsequent attempt. • Network Ready: The Raven is connected to the 1x cellular network and ready to send data.
Configuration Commands +HWTEMP? Displays the internal temperature of the radio module in degrees Centigrade. +PRL? Preferred Roaming List (PRL) version. 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. +CBIP? The current IP address of the modem reported by the internal module, generally obtained from TELUS. This is the address can contact the Raven from the Internet. Note: If there is no current network IP address, 0.0.0.0 may be displayed.
Raven 1x +ECIO? Indicates the signal‐to‐noise ratio, essentially the quality of the signal. +GSN ESN (Electronic Serial Number) of the internal hardware module. +WHWV Serial number of the module. +WPRL? Preferred Roaming List (PRL) version. +WSSW Software version of the internal hardware module. !RSSI Received Signal Strength Indicator. C3x10 or C3x10E. !STATUS Displays the current modem status. C3x10 or C3x10E. Format of response: • Current band: <band> • Current channel: <chan> • SID:<sid> NID:<nid> Roaming:<n> • Temp:<temp> • Pilot [NOT] acquired • Modem has [NOT] registered 20070914...
Configuration Commands Common The groups under the heading Common encompass those commands that are common to most Sierra Wireless AirLink modems. Misc (Miscellaneous) The commands of the “Misc” group are a variety of commands that don’t directly fit in other categories. Figure 1-3: AceManager : Misc AT Escape sequence. If the Raven is in a data mode (any mode Note: +++ is not proceeded by other than PassThru), this command causes the modem to re‐ AT nor does it require a carriage enter AT command mode. The “+” is ASCII 0x2B. return (enter). There must be an +++ is not ...
Raven 1x 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 S53 are used. If a telnet connection is requested (N) and the ...
Configuration Commands 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. Reset the Raven. In AceManager, this command is performed with the Reset option on the toolbar. Tip: *DATZ=1 will disable Z. &W Writes all changed modem settings. If this command is not ...
Raven 1x +CICB=n Mode for answering data with the A (answer) or via auto answer (S0=1). Cannot be configured in AceManager. C3x11 or C3x11E only. • n=0 : Data • n=1 : Speech • n=2 : Data once (10 minute timeout). *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. •...
Configuration Commands *NETROAMPREF=n Allow configuration of the roaming preference. n=0 : Restrict to home network only. • • n=1‐3 : Allow roaming to affiliated networks. *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 address is not granted while registering on the cellular network, the modem will try to register on the network again until it receives that IP address.
Raven 1x Figure 1-4: AceManager : Serial Toggle AT command echo mode. • n=0 : Echo Off. • n=1 : Echo On. The AT quiet‐mode setting. If quiet mode is set, there will be no responses to AT commands except for data queried. • n=0 : Off (Default). • n=1 : Quiet‐mode on. S3=n The standard end of line character used to indicate the end of an AT command. This character is also used as the carriage return character for framing responses and result codes in command state. Cannot be configured in AceManager. • n=0‐127 (ASCII character number) S4=n The standard line feed character sent by the modem to the host at the end of a response or return code in command state. Cannot be configured in AceManager. • n=0‐127 (ASCII character number) S5=n This register sets the character recognized as a backspace during command entry. Cannot be configured in AceManager. • n=0‐127 (ASCII character number) 20070914...
Configuration Commands S6=n This register denotes the wait time, in seconds, before a blind dial (no dial tone detection). Cannot be configured in AceManager. • n=2‐10 seconds S8=n Whenever a dial command contains the comma character, the contents of this register specify the pause time for each comma. Cannot be configured in AceManager. • n=0‐255 S9=n Specifies the time that the received carrier must be present for the modem to recognize it and turn on Data Carrier Detect (DCD) if applicable. The implementation is entirely at the IWF modem. Cannot be configured in AceManager. • n=0‐255 S10=n Specifies the amount of time that the carrier from the remote modem can be lost before the modem goes on‐hook. This allows temporary disruptions to carrier without disconnecting. A setting of 255 causes the modem to disable Carrier Detect and presume carrier is always present. Cannot be configured in AceManager. • n=1‐2545 S23=[speed],[databits][parity][stop bits] Serial line parameters. The settings take affect after reset. • speed=300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 | 230400 • databits=7 or 8 (Databits MUST be 8 data bits for PPP mode.) • parity=O : Odd •...
Raven 1x Tip: Can also be set using &L=[speed],[databits] [parity][stop bits] S50=n Data forwarding idle time‐out. If set to 0, a forwarding time‐ out of 10ms is used. Used in UDP or TCP PAD mode. • n=tenths of a second S51=n PAD data forwarding character. ASCII code of character that will cause data to be forwarded. Used in UDP or TCP PAD mode. • n=0 : No forwarding character. S211=n For applications or situations where hardware control of the DTR signal is not possible, the modem can be configured to ignore DTR. When Ignore DTR is enabled, the modem operates as if the DTR signal is always asserted. • n=0 : Use hardware DTR. (default). • n=1 : Ignore DTR. • n=3 : Ignore DTR and assert DSR. This value is deprecated, and it is recommended to use &S to control the DSR instead. When this value is set to 3, &S will automatically be set to 0. See also: &D and &S. Command Response Mode. • n=0 : Terse (numeric) command responses • n=1 : Verbose command responses (Default). ...
Configuration Commands &Dn Set DTR mode. n=0 : Ignore DTR, same effect as HW DTR always asserted • (same as S211=1). • n=2 : Use hardware DTR (same as S211=0). &Sn Set DSR mode. • n=0 : Always assert DSR (Default). • n=1 : Assert DSR when in a data mode (UDP, TCP, PPP, or SLIP) (Default). • n=2 : Assert DSR when the modem has network coverage. Tip: S211 can also be used to request that DSR is always asserted. If S211 is set to 3 and &S is changed to a non-zero value, S211 will be changed to 1.
Raven 1x • n=0 : Disable • n=3 : Data for one call. • n=4 : Data for all calls (default). *CTSE=n Clear To Send Enable: This feature asserts CTS when there is a network connection. • n=0 : Disabled (Default). • n=1 : Enable assertion of CTS when there is network coverage. RS232 voltage levels: Positive = Network coverage. Negative = No coverage. Tip: Flow control (AT\Q) will override this indication, so if you want to use CTS to indicate network coverage, flow control has to be off (AT\Q0).
Configuration Commands Figure 1-5: AceManager : TCP S0=n This register determines how the Raven responds to an incoming TCP connection request. The Raven remains in AT Command mode until a connection request is received. DTR must be asserted (S211=1 or &D0) and the Raven must be set for a successful TCP connection. The Raven will send a “RING” string to the host. A “CONNECT” sent to the host indicates acknowledgement of the connection request and the TCP session is established. • n=0 : Off (Default). • n=1 : On. • n=2 : Use Telnet server mode on TCP connections. • n=3 : With a Telnet connection, overrides the clientʹs default echo, allowing the server on the host port to perform the echo. CRLF sequences from the telnet client will also be edited to simply pass CRs to the server on the host port. S7=n Specifies the number of seconds to wait for a TCP connection to be established when dialing out. • n=seconds S60=n Telnet Client Echo Mode. • n=0 : No Echo • n=1 : Local Echo (Default) • n=2 : Remote Echo S221=n Connect Delay: Number of seconds to delay the “CONNECTʹ ...
Raven 1x • n=0 ‐ 255 TCPS=n TCP connection time‐out (TCPS) units. Specifies a time interval upon which if there is no in or outbound traffic through a TCP connection, the connection will be terminated. • n=0 : minutes • n=1 : seconds TCPT=n Interval to terminate a TCP connection when no in or outbound traffic. This value affects only the TCP connection in TCP PAD mode. n=interval • Caution: TCPT should never be 0 when using the TCP mode. A broken TCP session can result in the modem being left with a TCP half-open connection that can only be terminated with a reset.
Configuration Commands • n=0 : Allow only the IP address specified in S53 to connect when UDP auto answer is enabled (S82=2). • n=1 : Allow any incoming IP address to connect when UDP auto answer is enabled (S82=2). Note: Always subject to any Friends filters that may be defined. HOR=n Half‐Open Response ‐ In UDP auto answer (half‐open) mode. • n=0 : No response codes when UDP session is initiated. • n=1 : RING CONNECT response codes sent out serial link before the data from the first UDP packet. Note: Quiet Mode must be Off. MDhh Default power‐up mode for the serial port: When the Raven modem is power‐cycled, the serial port enters the mode specified by this command after 5 seconds. On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode. See also S53 to set the port for UDP or TCP. • hh (hex byte)=00 : normal •...
Raven 1x S83=n Set or query UDP auto answer idle time‐out. If no data is sent or received before the time‐out occurs, the current UDP session will be terminated. While a session is active, packets from other IP addresses will be discarded (unless *UALL is set). • n=0 : No idle time‐out (Default). • n=1 ‐ 255 : Time‐out in seconds. *DU=n The dial command always uses UDP, even when using ATDT. • n=0 : Dial using the means specified (default). • n=1 : Dial UDP always, even when using ATDT. Note: When this parameter is set you cannot establish a TCP PAD connection. *UALL=n Accepts UDP packets from any IP address when a UDP session is active. If there is no UDP session active, an incoming UDP packet will be treated according to the UDP auto answer and AIP settings. • n=0 : No effect (Default). • n=1 : Accept UDP data from all IP addresses when in a UDP session. *UDPLAST=n If enabled, sets S53 to the last accepted IP address through ...
Configuration Commands This group includes commands specific to the modem being able to use domain names instead of IP addresses for other configuration options. Figure 1-7: 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. ...
Raven 1x Figure 1-8: 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=”). •...
Configuration Commands • 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 1x Figure 1-9: 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. *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 *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. 20070914...
Configuration Commands *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). • n=1 : Private IP Mode: When the Host initiates a 1x connection, the host will be given the IP address specified in *HOSTPRIVIP. The modem will then perform 1 to 1 NAT‐like address translation, which shields the Host from network IP changes. *HOSTPW=string Host Password for PAP or CHAP.
Raven 1x Caution: While the modem is in PassThru mode, ALEOS is disabled. If you need to connect to the Raven while it is in PassThru mode, you will need to do so with a terminal application. Not all commands are available while the modem is in PassThru mode.
Configuration Commands *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. Talk to your network administrator to ensure you can send email through the email server using your Raven.
Raven 1x *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. *SMTPSEND=email[body] Sends an email to the address specified, followed by the body ...
Configuration Commands *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. Remarque : +CMGD=n[,flag] This command is used to delete one or several messages for C3 x11 or C3x11E only. Requires PassThru mode. • n=0‐9 : Index number of the message (location). • flag=0 : Delete message at location. • flag=1 : Delete All READ messages. • flag=2 : Delete All READ and SENT messages. ...
Raven 1x • body= message body Note: E-mail is available if *NETSMS2EMAIL has been configured. Use the email address instead of the phone number. !CNTSMS Reports the number of messages stored. C3x10 or C3x10E only. Requires PassThru mode. New Urgent Msg {Index = 1}: <n> New Regular Msg {Index = 2}: <r> Voice Messages {Index = 3}: <v> The Index number corresponds to the SMS list index used to ...
Configuration Commands Note: The text is enclosed in quotations. The quote character cannot appear in the body text. Messages with over 160 bytes of body text will be truncated and sent anyway. !SSMS? The progress of the last message sent. C3x10 or C3x10E only. Requires PassThru mode. Possible responses are: Pending message has not left the modem Sent successfully Sent to the network Delivered successfully...
Raven 1x *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. If you set *IPPING for a value between 0 and 15, the minimum value of 15 will be set. *IPPINGADDR=[d.d.d.d][name] Set the IP address or valid internet domain name for the Raven ...
Configuration Commands Caution: You may need to reactivate your modem if you erase the non-volatile data. *SNMPCOMMUNITY=string The SNMP Community String acts like a password to limit access to the modem’s SNMP data. • string =string of no more than 20 characters (default = public). *SNMPPORT=n This controls which port the SNMP Agent listens on. • 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 ...
Raven 1x *SNTPADDR=[d.d.d.d][name] SNTP Server IP address, or fully‐qualified domain name, to use if *SNTP=1. If blank, time.nist.gov is used. • d.d.d.d=IP address • name=domain name *TELNETTIMEOUT=n Telnet port inactivity time out. By default, this value is set to close the AT telnet connection if no data is received for 2 minutes. • n=minutes *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..
Configuration Commands Figure 1-13: AceManager : Friends 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.
Raven 1x Figure 1-14: AceManager : Logging *DBGCOMMLVL=n Set the logging level for the host or module COM port. • n=0 : No logging • n=1 : Host COM Port • n=2 : Module COM Port *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 Telemetry/Addr List Modbus, commonly used with telemetry devices, allows a ...
Configuration Commands Figure 1-15: 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. • n=0 ‐ 255 Rev 3.0B Feb.08...
Raven 1x 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-16: AceManager : Addr List 20070914...
Configuration Commands 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 1x/EV-DO This group includes commands specific to 1x and EV‐DO. If you are not connecting to a modem which uses EV‐DO or 1x, you will not see this group in the menu. Figure 1-17: AceManager : 1x/EV-DO +CTA=n Inactivity timer, in seconds. Typical network settings cause a link to go dormant after 10 to 20 seconds of inactivity, no packets transmitted or received. This time can be shortened to release the physical RF link sooner when the application only transmits short bursts. • n=0 : Allows the cellular network to determine the inactivity timer. • n= seconds (maximum 20 seconds) $QCMIP=n Mobile IP (MIP) Preferences. On a Mobile IP network, a device ...
If the number is rejected, the ERROR result is returned. If three successive Errors are returned, the modem must be reset by Sierra Wireless AirLink Solutions to allow any further attempts. The modem permits 99 failures of this command during its lifetime.
Configuration Commands +WSPC=[lock],[nnnnnn] Service Programming Code. C3x11 and C3x11E only. Upon successful entry of this code, all other service provisioning AT commands may be used. • lock=0 : OTKSL(One Time Key Subsidy Lock) • lock=1 : MSL (Master Subsidy Lock) • nnnnnn=6 digit unlock code Note: If an OTKSL is used to enter provisioning mode, only the +WIMI, +WMDN, and +WCMT commands will be allowed. All other commands will return ERROR. Caution: This command supports five attempts to enter the correct service programming code.
Raven 1x update the MDN. Changes will automatically update the Access Overload Class values unless specifically modified using +WAOC command. +WSID=[idx],[SID],[NID] Set SID and NID. C3x11 and C3x11E only. • idx=The location in the SID/NID list to store the values. • sid=system ID • nid=network ID The new SID/NID values are committed to NV with the +WCMT command (AT+WCMT=1). A maximum of 20 index locations (0‐19) are supported. Error 22 is returned if the specified index value is not in the valid range. ~NAMVAL=nam[,min,msid,sid,nid] Tip: It is recommended to use the Setup Wizard for your carrier to provision the modem. Write account activation data. C3x10 and C3x10E only. Following writing the values, the modem must be reset. • nam=0 • min=phone number •...
B: Circuit Switch Communications • Step by Step Configuration • Step by Step Circuit‐switch communication requires the Raven to be in Configuration PassThru mode, communicating directly with the internal hardware. PassThru mode disables the use of ALEOS in the modem. Any Note: When the Raven is used features available using ALEOS are not usable when the for circuit switch, the circuit modem is in PassThru mode. In PassThru mode, the settings switch configuration will disable available are those of the internal hardware. The Raven C3211 all ALEOS features except for in PassThru mode can save settings internally like a conven‐...
Raven 1x Figure 2-1: AceManager : UDP > MD 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.
Circuit Switch Communications Commands Specific to the Raven 1x C3210 and C3216 The command string cannot contain any spaces, commas, the plus (+) symbol, or a semi‐colon (;). If an AT command needed for the string contains a plus or comma (for example, +IFC=0,0), you will need to designate a break character since you cannot use the standard break of ; for the plus to be read and a replacement for the comma. The break and comma designations need to be at the end of the *PTINIT command and separated with commas. During the INIT sequence, the modem looks at the entire command before executing the AT command string. If there are replacement values, it will perform the appropriate replacement before executing the AT command. Table 2-1: Example for the Raven C3210 and C3216 Command Components AT*PTINIT=AT&C1S0=1$QCVAD=4%+IFC=0^0,%,^ AT*PTINIT= Include this portion only if you will not be entering the command using a AceManager.
Raven 1x Table 2-2: Example for the Raven C3211 Command Components AT*PTINIT=ATS0=1+CICB=0 AT*PTINIT= Include this portion only if you will not be entering the command using a AceManager. The remainder of the example is the command string. All AT commands must start with “AT”. S0=1+CICB=0 The string is a combination of AT Commands limited to a maximum of 40 characters.
Circuit Switch Communications 1. Gather the required information, hardware, and software Different model numbers will have different configurations. Some of the configuration steps for one model will not work at all with any other model number. The model number for your Raven is on the sticker which is on the top of the modem (example, Raven 1x C3211 or Raven CDMA C3210). The first letter and number (C3) indicates the communication technology your modem uses. The next number (2) indicates the modem model (Raven). The final two numbers (10, 11, or 16) indicate the internal hardware model. 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. • A CDMA/1x account that supports circuit‐switched communication. Software Required • Setup Wizard ‐ The activation utility. You can download the Setup Wizard from the Sierra Wireless AirLink Solutions website: http://www.airlink.com. A default ...
Raven 1x www.airlink.com/docs/AppNotes/CircuitSwitchTem‐ plates/. You should only download the template which matches your modem model and/or configuration needs. Information Required for CDMA/1x only • Master Subsidy Lock (MSL) ‐ also called the Unlock Code or Activation Code. This should be provided by your Wireless Provider. The incorrect MSL can cause the config‐ uration to fail. This might also be programmed for you as part of the Setup Wizard activation process. • MIN and MDSN or MSID ‐ The phone number for your cellular account (also called the MIN). You may have two phone numbers for your modem, the MIN and MDN or MSID. If you have two numbers which are different and you only enter one, the configuration will fail. The MIN and MDN or MSID (if it is different) should be provided by your Wireless Provider. • Username (SID or NID) and Password ‐ You may also need a user name and password for your account. The user name for your account may be the same as your MIN. The user name and password should be provided by your Wireless Provider. 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 ...
Page 144
Circuit Switch Communications 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. Figure 2-5: Raven: Reset button Click the Exit button in Modem Doctor when the process is complete. Rev 3.0B Feb.08...
Page 145
Raven 1x 4. Activate the Raven Using the Setup Wizard, activate the Raven for your cellular account with your Wireless Provider. Follow the directions in the Quick Start Guide for the Raven to activate (also called provision) your modem. Complete the Setup Wizard and verify that the account is good using the Setup Wizard test screen. If your modem fails any of the tests then contact your cellular provider and troubleshoot the account. Do not proceed until the account is functioning correctly. Figure 2-6: Setup Wizard : Testing Modem 5. Start AceManager. Start > All Programs > AirLink Communications > AceManager 3G > AceManager 3G Click the Connect button. Figure 2-7: AceManager Select PPP. Select COM1 for the Port. Enter 12345 for the Password. Click OK. 20070914...
Page 146
Circuit Switch Communications Figure 2-8: AceManager : Connect to Modem using PPP 6. Configure serial port speed. On the left, under the GROUPS heading, select Serial. Figure 2-9: 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-10: AceManager : Write Click the Clear button. Figure 2-11: AceManager : Clear Click the Disconnect button. ...
Page 147
Raven 1x Figure 2-12: AceManager : Disconnect Press the modem Reset button on the front of the modem. Figure 2-13: 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-14: AceManager : Refresh All Click the Load button on the tool bar. ...
Page 148
Circuit Switch Communications Figure 2-15: AceManager : Load Change to the folder (directory) where you downloaded the template(s) and select the template for your modem model and/or preferred mode. Figure 2-16: AceManager : Templates Tip: If landline emulation is desired then choose the “non-quiet” template. If direct serial cable replacement is desired then choose the “quiet” template. 9. Configure additional PassThru settings.
Page 149
Raven 1x Figure 2-17: 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 150
Circuit Switch Communications 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 Note: The dial test should be line and verify that the modem automatically answers completed with the serial cable the call with modem tones. disconnected to verify that no signaling is required by the Verify outgoing calls. modem. Connect the modem to your computer with a serial cable. Using a terminal emulation program (HyperTerminal) set up for 9600bps, 8 data bits, no parity and 1 stop bit. Enter the command: . For the ATD[phone number] [phone number], enter a known phone number ...
Page 151
Raven 1x is strongly recommended that a value of 18 or better be used as a minimum value. Tip: You can use the A/ command to repeat the last AT command. Remove the connection to the Laptop PC and connect your equipment to the Raven Modem. Have the actual application call your equipment via the modem telephone number and verify communica‐ tions. 20070914...
C: Windows Dial-up Networking (DUN) • Installing a modem driver for Raven Dial‐up Networking (DUN) allows a computer or other device • Creating a Dial-Up to use the serial port on your Raven to connect to the Internet Networking (PPP) or private network using PPP just like an analog modem using Connection a standard phone line. • Connecting to the Internet Using DUN 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 153
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. Rev 3.0B Feb.08...
Page 154
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. Rev 3.0B Feb.08...
Page 155
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 (commonly COM1).
Page 156
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...
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. Rev 3.0B Feb.08...
Page 158
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 over as the “default route” for network communication and specifically for Internet access. If you want the two connections ...
Page 159
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. Rev 3.0B Feb.08...
Page 160
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. Rev 3.0B Feb.08...
Page 161
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 162
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 163
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. Rev 3.0B Feb.08...
Page 164
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. Rev 3.0B Feb.08...
Page 165
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. Rev 3.0B Feb.08...
Page 166
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. Rev 3.0B Feb.08...
Windows Dial-up Networking (DUN) Figure 3-28: Advanced TCP/IP Tip: You may want to check the Options tab and change the settings for applications you might be using. The default options are generally applicable for most uses. 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.
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 169
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 170
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 1x and is the answer not in the manual?
Questions and answers