Raven 1x for TELUS User Guide 20070914 Rev 3.
Preface Important Notice Due to the nature of wireless communications, transmission and reception of data can never be guaranteed. Data may be delayed, corrupted (i.e., have errors) or be totally lost.
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.
Preface AirLink™ and AceWare™ are trademarks of Sierra Wireless. Sierra Wireless, the Sierra Wireless logo, the red wave design, and the red‐tipped antenna are trademarks of Sierra Wireless. Windows® is a registered trademark of Microsoft Corporation. QUALCOMM® is a registered trademark of QUALCOMM Incorporated. Used under license. Other trademarks are the property of the respective owners.
Preface Revision History Revision number Release date Changes 1.x 2003-2005 AirLink Communications documentation - CDPD, CDMA, and GPRS. 2.x Q2: 2005-Q2: 2007 AirLink Communications documentation - CDMA, EV-DO, EDGE, and HSDPA. 3.0 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.
Contents Introduction to the Raven . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 ALEOS™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 AceWare™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 AceManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Indicator Lights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Light Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Mounting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Configuring your Raven . . . . . . . . . . . . . .
Contents Restrictions for Modem Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Data Usage for IP Manager Server Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Eairlink.com . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Understanding DNS . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents *NETOP? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 *NETRSSI? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 *NETSERV?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 *NETSTATE?. . . . . . . . . . . . . . . . . . .
Contents S9=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 S10=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 S23=[speed],[databits][parity][stop bits] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 S50=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents *HOSTPEERIP=d.d.d.d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 *HOSTPRIVIP=d.d.d.d . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 *HOSTPRIVMODE=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 *HOSTPW=string . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents *DBGPPPLVL=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Telemetry/Addr List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 IPL=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 MVLEN=n . . . . . . . . . . . . . . . . . . . . . . . . . .
1: Introduction to the Raven • ALEOS™ • AceWare™ • Connecting to the TELUS Network • 1x Communication 1 Powered by ALEOS™, Raven modems are designed to maintain a reliable, consistent network connection. With a 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.
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.
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.
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.
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).
Introduction to the Raven Figure 1-6: Modem Doctor Modem Doctor USB 1. Open the ModemDoctorUSB.exe. 2. 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”. The available port is automatically detected. Passsword is the fault password. 3. Press Erase. The modem will then reset. Note: If you erase the fatory defaults will be restored. USBnet is the factory default port. Rev 3.0B Feb.
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: Rev 3.0B Feb.08 1. When your Raven is powered on, it automatically searches for cellular service using 1x. 2. 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. 3.
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 oneto-many (several devices connected to one port).
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).
2: Specifications 2 • Interface Port Pin-Outs • Power Connector Features and Benefits • Embedded Intelligence • Low Power Consumption • Serial Port • Machine Protocols • Simple Integration with Legacy Equipment • Persistent Network Connectivity • Remote Management and Configuration • Class I Div 2 Certified Technology • CDMA 1xRTT • CDMA IS‐95 Bands • 800 Mhz Cellular • 1900 Mhz PCS Environmental • • Operating Temperature: · ‐30 to 70° Celsius Storage Temperature: · ‐40 to 85° Cel
Specifications Host Interfaces • RS‐232: DB9 DCE (300‐230400 baud) • Antenna Connection: · Cellular ‐ 50 Ohm TNC Dimensions • 76mm x 25mm x 129mm • 317 grams Application Interfaces • TCP/IP, UDP/IP, DHCP, HTTP, SNMP, SMTP, SMS, MSCI, Binary, Modbus, and more LED Indicators • Channel • Link • Registration • RSSI • Transmission/Receive • Power Interface Port Pin-Outs Serial Port Unused CTS (Clear to Send) < RTS (Request to Send) - > DSR (Data to Send) < - 9 5 4 8 3 7 2 6 1 < - > GND
3: Activating your Raven on the TELUS Network • Setup Wizard • Activating Using AT Commands 3 This chapter provides step‐by‐step directions for activating 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 framework v. 1.
Raven 1x Figure 3-1: Setup Wizard e. 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. Select Connected to a Serial Port, check Auto Detect Port Settings or select the port from the drop down menu. Click Next.
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.
Raven 1x • Test Modem Setup: Verify your Raven is properly configured and connecting on the TELUS network. • Setup a DUN Connection: Create a Dial‐Up Networking entry for local connection. This part of the setup is only needed if you will be using your Raven to connect directly from a computer to the Internet or other network. Click Next when you have selected your desired options. Note: Based on your selections, you may not need to do all of the following Wizard steps. 4.
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.
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. The Wizard will check the signal strength of your Raven (RSSI). Click Next to begin the activation process. Note: The process may take a few minutes.
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.
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.
Activating your Raven on the TELUS Network your computer. Select Continue Anyway to install the driver. e. 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). f. Click Next to continue to install the DUN configu‐ ration.
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.
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.
Raven 1x 30 20070914
4: Hardware Installation of the Raven • Connecting to Power • Connecting to a Computer or other Device • Indicator Lights • Mounting 4 Your Raven should be mounted in a position that allows easy access for the cables so they are not bent, constricted, in close proximity to high amperage, or exposed to extreme tempera‐ tures. The LEDs on the front panel should be visible for ease of operational verification.
Hardware Installation of the Raven Antennas selected should not exceed a maximum gain of 5 dBi under standard installation configuration. In more complex installations (such as those requiring long lengths of cable and/ or multiple connections), it’s imperative that the installer follow maximum dBi gain guidelines in accordance with the radio communications regulations of the Federal Communica‐ tions Commission (FCC), Industry Canada, or your country’s regulatory body (if used outside the US).
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 Rev 3.0B Feb.
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 • TxRx (transmit/receive) ‐ The light will flash as data is transferred to and from the Raven‐E modem on the remote network. • Pwr (power) ‐ Indicates the power adapter is connected and there is power getting to the Raven.
Hardware Installation of the Raven Figure 4-4: Optional Mounting Bracket Rev 3.0B Feb.
Hardware Installation of the Raven Figure 4-5: 100-170-1009 : Mounting Bracket for Raven Rev 3.0B Feb.
Hardware Installation of the Raven Figure 4-6: 100-170-1006 : Mounting Bracket for Raven Rev 3.0B Feb.
5: Configuring your Raven • Using AceManager • Using Templates • Using a Terminal Application with AT Commands 5 With ALEOS as its “brain”, the Raven is a highly configurable device, more than just a “dumb” modem. To configure your Raven, you have two options. You can use the configuration and management applications of the AceWare suite or you can use a terminal emulator application such as HyperTerminal, PuTTY, or many others.
Configuring your Raven Figure 5-1: AceManager 2. Connect to your Raven a. Click the Connect button. Figure 5-2: AceManager : Connect to Modem b. 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. c.
Configuring your Raven e. Select OK. Figure 5-3: AceManager : Connected 3. Enter the configuration options a. On the left side of AceManager is the Groups menu. Select the appropriate group as needed or directed. b. Enter your changes in the New Value column by typing in the desired change or using the drop down menus. c. The current configuration is shown in the Value column. Figure 5-4: AceManager : Changing values Rev 3.0B Feb.
Configuring your Raven 4. Write the changes to the modem a. Click the Write button on the tool bar of AceManager. b. 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. You can also reset the modem by cycling the power.
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. · Cellular Technology specific settings (the CDMA/EV‐DO group) · *MODEMNAME · *HOSTPRIVIP · *HOSTPEERIP · *HOSTUID · *HOSTPW d. Click the Save button on the toolbar. e.
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. a. Load the template. 1. Connect to the modem you want to configure using AceManager. 2. Click on the Load button on the toolbar. Figure 5-8: AceManager : Load 3.
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. 3.
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. b. Select the Modem option in the tool bar and then select Apply AceManager Template. Figure 5-11: AceNet : Modem menu c. 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 d.
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. a.
Configuring your Raven 2. Connect To a. Select COM1, or the comport to which the modem is connected, for the “Connect Using”. Figure 5-14: Connect To b. Type in 192.169.13.31 for Host Address. c. Change the “Port Number” to 2332. d. Select OK. 3. Port Settings (serial only) a. Change or verify the settings: · Bits per Second: 115200 (default) · Data Bits: 8 · Parity: None · Stop Bits: 1 Rev 3.0B Feb.
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. b. Select OK. 4. Connected Figure 5-16: HyperTerminal : connected Rev 3.0B Feb.
Configuring your Raven a. Type AT and press Enter. You should get a reply of “OK” or “0”. b. 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. c. 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.
6: Data Communication and Host Modes • Basic Modes • Serial Modes • Data Communication 6 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).
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.
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.
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.
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.
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.
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.
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.
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 Rev 3.0B Feb.
Data Communication and Host Modes Data Communication Note: The Raven forwards messages to and from the cellular network for only ONE device per port. The Raven is a one-to-one gateway and does not have advanced routing features required to do one-tomany routing. The primary purpose of the Raven is to forward data from a single device connected to one of the ports to the cellular network and, ultimately, under most circumstances, to the Internet in a one‐to‐one gateway configuration.
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).
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 Rev 3.0B Feb.
7: IP Manager • Understanding Domain Names • Using IP Manager with your Raven • Understanding DNS 7 If you have a fleet of Sierra Wireless AirLink modems or even if you only have one, it can be difficult to keep track of the current IP addresses, especially if the addresses aren’t static but change every time the modems connect to Provider. If you need to connect to a modem, or the device behind it, it is so much easier when you have a domain name (car54.mydomain.com, where are you?).
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.
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.
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 • *MODEMNAME : The name you want for the modem.
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.
IP Manager Note: The IP Manager service from Sierra Wireless is currently not a guaranteed service though every effort is made to keep it operational 24/7. • *DOMAIN : eairlink.com • *IPMANAGER1 : edns2.eairlink.com • *IPMANAGER2 : eairlink.com Tip: When using the IP Manager service offered by Sierra Wireless, since there are many modems using the service, it is even more imperative to have a unique name for your modem.
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.
8: Configuring Modbus/BSAP • Configuring the Raven at the Polling Host for Modbus on UDP • Configuring the Remote Ravens for Modbus with UDP 8 The Raven supports Modbus ASCII, Modbus RTU, BSAP, and can also emulate other protocols like DF1 or others using its Modbus Variable feature. Modbus Overview The Modbus Protocol, developed by Modicon in 1979, provides for client‐server (also referred to as master‐slave) communications between intelligent devices.
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.
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 UDP 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.
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.
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.
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.
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.
Raven 1x a. Enable S82, UDP auto answer. b. 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.
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.
Raven 1x 81 20070914
9: SNMP : Simple Network Management Protocol • SNMP Configuration • SNMP MIB Definition Sample 9 The Simple Network Management Protocol (SNMP) was designed to allow remote management and monitoring of a variety of devices from a central location. The SNMP management system is generally composed of agents (such as your Raven, a router, a UPS, a web server, a file server, or other computer equipment) and a Network Management Station (NMS) which monitors all the agents on a specific network.
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.
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‐ MUNITY. The default is “public”.
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 MAX-ACCESS read-only STATUS current ::= { general 6 } modemSWVer OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS cu
SNMP : Simple Network Management Protocol STATUS current ::= { common 2 } devicePort OBJECT-TYPE SYNTAX INTEGER(0..
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 SYNTAX INTEGER MAX-ACCESS read-only STATUS current ::= { status 3 } rssi OBJECT-TYPE SYNTAX INTEGER(-125..
SNMP : Simple Network Management Protocol powerMode OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { status 8 } fixObtained OBJECT-TYPE SYNTAX INTEGER { no(0), yes(1) } MAX-ACCESS read-only STATUS current ::= { gps 1 } satelliteCount OBJECT-TYPE SYNTAX INTEGER MAX-ACCESS read-only STATUS current ::= { gps 2 } latitude OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { gps 3 } longitude OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current :
SNMP : Simple Network Management Protocol Object AT Command aleosHWVer I1 modemSWVer I2 modemHWVer I2 date *DATE? otaProgrammingEnable OPRG? devicePort *DPORT? netUID *NETUID? netPW *NETPW? requestPAP *HOSTPAP? destinationAddress S53 destinationPort S53 serialPortSettings S23 serialPortFlowControl \Q ipAddress *NETIP? netState *NETSTATE? netChannel *NETCHAN? rssi *NETRSSI? serialSent not applicable for Raven-E serialReceived not applicable for Raven-E hostMode *HOST
A: Configuration Commands • • • • • • Info (information) Status Common Logging Telemetry/Addr List 1x/EV-DO A The configuration commands (AT commands) in this chapter are arranged according to their placement in AceManager. The commands available in AceManager will depend of the model number of your Raven and, in some cases, the version of the ALEOS firmware installed. Note: Some commands can only be configured using a terminal emulation and typed AT commands. Some commands also require PassThru mode.
Raven 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. In • 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.
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.
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.
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.
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.
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 +++ Note: +++ is not proceeded by AT nor does it require a carriage return (enter). There must be an idle time (set by S50) on the serial port before and after this command. AT Escape sequence.
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.
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. O 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.
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.
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. n=3 *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.
Raven 1x Figure 1-4: AceManager : Serial En Toggle AT command echo mode. • n=0 : Echo Off. • n=1 : Echo On. Qn 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.
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.
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.
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).
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.
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.
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.
Configuration Commands DNS 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.
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.
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.
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).
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.
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. Figure 1-10: AceManager : PassThru \APASSTHRU Note: This mode is not available through the remote AT telnet server. You will need to connect to the Raven with it connected directly to your computer. Sets the modem operation to pass through 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.
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).
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.
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}: New Regular Msg {Index = 2}: Voice Messages {Index = 3}: The Index number corresponds to the SMS list index used to retrieve messages. The counters n, r, and v indicate the number of messages in each list.
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.
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 to ping to keep itself alive (online).
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.
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.
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.
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.
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.
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.
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.
Raven 1x Note: Your account with your cellular carrier may not support Mobile IP. ~NAMLCK=nnnnnn The NAMLCK is the modemʹs 6‐digit OTSL (One Time Subsidy Lock), MSL (Master Subsidy Lock), or SPC (Service Provisioning Code). Your cellular carrier will provide the unlock code. • nnnnnn=6 digit unlock code Caution: If the number is accepted by the modem, the OK result code is returned. If the number is rejected, the ERROR result is returned.
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.
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.
B: Circuit Switch Communications B • Step by Step Configuration • Step by Step Configuration Note: When the Raven is used for circuit switch, the circuit switch configuration will disable all ALEOS features except for serial port communication. Circuit‐switch communication requires the Raven to be in PassThru mode, communicating directly with the internal hardware. PassThru mode disables the use of ALEOS in the modem. Any features available using ALEOS are not usable when the modem is in PassThru mode.
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.
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.
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. AT 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.
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.
Circuit Switch Communications Figure 2-3: Modem Doctor c. 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 d. 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 e. Rev 3.0B Feb.
Raven 1x 4. Activate the Raven Using the Setup Wizard, activate the Raven for your cellular account with your Wireless Provider. a. Follow the directions in the Quick Start Guide for the Raven to activate (also called provision) your modem. b. 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.
Circuit Switch Communications Figure 2-8: AceManager : Connect to Modem using PPP 6. Configure serial port speed. a. On the left, under the GROUPS heading, select Serial. Figure 2-9: AceManager : Serial - *MODEMHISPEED b. Change the *MODEMHISPEED setting to “0”. 7. Save the serial setting. a. 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 b. Click the Clear button.
Raven 1x Figure 2-12: AceManager : Disconnect d. Press the modem Reset button on the front of the modem. Figure 2-13: Raven: Reset e. 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. a. 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.
Circuit Switch Communications Figure 2-15: AceManager : Load c. 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. a. On the left, under the GROUPS heading, select PassThru. Rev 3.
Raven 1x Figure 2-17: AceManager : PassThru b. For *PTREFRESH, enter a value of 15. c. 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. a. Make any appropriate changes to the serial port parameters to match your equipment. These changes are made under the group Serial.
Circuit Switch Communications a. 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. Note: The dial test should be completed with the serial cable disconnected to verify that no signaling is required by the modem. b. Dial the Raven modem telephone number from a land line and verify that the modem automatically answers the call with modem tones. c. Verify outgoing calls. 1.
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. e. Remove the connection to the Laptop PC and connect your equipment to the Raven Modem. f. 146 Have the actual application call your equipment via the modem telephone number and verify communica‐ tions.
C: Windows Dial-up Networking (DUN) • Installing a modem driver for Raven • Creating a Dial-Up Networking (PPP) Connection • Connecting to the Internet Using DUN C Dial‐up Networking (DUN) allows a computer or other device to use the serial port on your Raven to connect to the Internet or private network using PPP just like an analog modem using a standard phone line.
Windows Dial-up Networking (DUN) Figure 3-1: Phone and Modem Options b. Select the Modems tab. Figure 3-2: Phone and Modem Options: Modems c. Rev 3.0B Feb.08 Select Add.
Windows Dial-up Networking (DUN) Figure 3-3: Add Hardware Wizard d. Check Don’t detect my modem; I will select it from a list. e. Select Next. Figure 3-4: Add Hardware Wizard: Install New Modem f. Select (Standard Modem Types) from the Manufacturers column. g. Select Standard 33600 bps Modem from the Models column. Rev 3.0B Feb.
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. h. Select Next. Figure 3-5: Add Hardware Wizard: Select Ports i. Check Selected Ports j. Select the COM port the modem is connected to (commonly COM1). k. Select Next. Figure 3-6: Add Hardware Wizard: Finish l. Rev 3.0B Feb.08 Once the modem driver is installed, select Finish.
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 a. Highlight the modem and select Properties. Figure 3-8: Modem Properties Rev 3.0B Feb.
Windows Dial-up Networking (DUN) b. Select the Modem tab. Figure 3-9: Modem Properties: Modem c. Maximum Port Speed should be set to 115200 (default). d. Select OK to exit. e. 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.
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.
Windows Dial-up Networking (DUN) b. Select Create a New Connection under Network Tasks in the menu area on the left. Figure 3-11: Create New Connection c. Select Next to start installing and configuring the DUN connection. Figure 3-12: New Connection Wizard d. Select Connect to the Internet. e. Select Next. Rev 3.0B Feb.
Windows Dial-up Networking (DUN) Figure 3-13: New Connection: Type f. Select Set up my connection manually. g. Select Next. Figure 3-14: New Connection: How do you want to connect? h. Select Connect using a dial‐up modem. i. Select Next. Figure 3-15: New Connection: Connect using... j. 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. k.
Windows Dial-up Networking (DUN) Figure 3-16: New Connection: Select Modem m. Type in a name for the connection, such as Sierra Wireless AirLink Modem. n. 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 designation for the connection. o. Type in 10001 as the phone number for the modem to dial.
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). s. If you want to allow others to use the same login for the modem, select Use this account name and password.... t. Select Next.
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. a. Select Properties. Figure 3-22: DUN Connection b. Uncheck Use dialing rules. Rev 3.0B Feb.
Windows Dial-up Networking (DUN) c. Check Show icon...when connected. d. Select Configure, below the Connect using line. Figure 3-23: DUN Properties e. Select 115200 as the Maximum speed. f. Check Enable hardware flow control. g. Do not check any other option. h. Select OK. Rev 3.0B Feb.
Windows Dial-up Networking (DUN) Figure 3-24: Modem Configuration i. Back at the main properties screen, select the Networking tab. Figure 3-25: Networking j. Select Settings. k. Remove the checks from all three PPP settings. l. Rev 3.0B Feb.08 Select OK.
Windows Dial-up Networking (DUN) Figure 3-26: PPP Settings m. 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. n. Select Advanced. Figure 3-27: TCP/IP Properties o. Uncheck Use IP header compression. p. Check Use default gateway on remote network. q. Select OK. Rev 3.0B Feb.
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. r. Select OK until you return to the Connect window.
Windows Dial-up Networking (DUN) 2. Enable the Connection. Figure 3-29: AceView: Menu a. Right‐click on the AceView window to open the menu. b. Select Connection Settings. Figure 3-30: AceView: Connection Settings c. Select Auto Start in the DUN section. d. 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.
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. 2. Select Dial to connect to the modem and the cellular network.
Windows Dial-up Networking (DUN) Caution: For DUN connections on a Windows Mobility or other nonpersonal 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.
