Raven XT 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 HSUPA/HSDPA. 3.0 Q2: 2008 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.0D Jul.
Contents Introduction to the Raven XT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 ALEOS™ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 AceWare™. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 AceManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Connecting to a Computer or other Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Indicator Lights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Light Patterns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Mounting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents Basic Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Start up Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 AT Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 PassThru Mode . . . . . . . . .
Contents Telemetry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Remote Terminal Unit (RTU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supervisory Control and Data Acquisition (SCADA) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Programmable Logic Controller (PLC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents +GSN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Common . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Misc (Miscellaneous) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Enable Event Reporting = n. . . . . . . . . .
Contents *MODEMHISPEED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 *NUMTOIP=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 *PPPNOCARRIER=n . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 TCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents *SMTPSTATUS? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 *SMTPSUBJ=subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 *SMTPUSER=user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Other . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Contents *PROVISION2=MSL,MDN,MIN[,SID][,NID]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 ~NAMVAL=nam[,min,msid,sid,nid] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Edge/HSDPA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 *NETAPN=apn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1: Introduction to the Raven XT 1 • ALEOS™ • AceWare™ • Connecting to your cellular provider • EV-DO Powered by ALEOS™, Raven XT modems are designed to maintain a reliable, consistent network connection. With a serial interface and a vast library of machine protocols, the Raven XT is a workhorse for industrial and mission critical applications. Class I Divison 2 certified as nonincendive equipment, the Raven Series is ideally suited for use in hazardous environments.
Introduction to the Raven XT • Extensive Machine Protocols • Packet Level Diagnostics • Device Management & Control • Protocol Spoofing Figure 1-2: Powered by ALEOS AceWare™ A wireless solution is not complete until you have software tools to manage the devices monitoring your valuable equipment. AceWare™ is the device management and monitoring application suite for Sierra Wireless AirLink products powered by ALEOS.
Introduction to the Raven XT Figure 1-3: AceManager Simplified Deployment AceManager provides the ability to remotely set up and configure your Sierra Wireless AirLink products. Remote device setup and configuration reduces the deployment timeline of your wireless solution and provides a quicker path to ROI. Templates allow you to easily configure other devices in your fleet with identical settings, ensuring a simple, accurate deployment.
Introduction to the Raven XT 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 AceManager. To ensure your implementation is optimal, users can easily see when modems are out of contact and periodically poll each device for performance statistics.
Introduction to the Raven XT erase the current configuration completely., and temporarily set the Raven XT to a known configuration to aid in trouble shooting (SOS mode). 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.
Introduction to the Raven XT Figure 1-7: Modem Doctor: USB connection Connecting to your cellular provider The Raven XT uses your cellular provider as an ISP (Internet Service Provider) to connect you to the Internet. Steps of a connection: Rev 3.0D Jul.09 1. When your Raven XT is powered on, it automatically searches for cellular service using CDMA. 2.
Introduction to the Raven XT Raven XT Figure 1-8: Connecting to the Internet The Raven XT 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 XT will provide a connection for one device to the Internet at a time. In Private Mode, the Raven XT will provide NAT (Network Address Translation) for the computer or other end device.
Introduction to the Raven XT uses, such as web browsing, looking up data on another computer system, or other client functions (such as data only being sent out or only being received after an initial request). Tip: If your account with your cellular provider includes a dynamic IP address and you need a static IP, please consult your your cellular provider Representative for more information about changing your account for static IP support.
Introduction to the Raven XT Note: Your Raven XT does not have a second antenna for received diversity. Received diversity is disabled by default. Security 1x data transmissions are highly secure. Originally developed based upon the “spread spectrum” pioneered by the US Department of Defense, security in CDMA technologies is obtained by spreading the digital information contained in a particular signal of interest over multiple coded paths, over a much greater bandwidth than the original signal. Rev 3.
2: Specifications 2 • Interface Port Pin-Outs • Power Connector Features and Benefits • Embedded Intelligence • Low Power Consumption • High‐Speed Processor • High‐Speed 2‐way Data • Serial and USB Port • Machine Protocols • Simple Integration with Legacy Equipment • Persistent Network Connectivity • Remote Management and Configuration • Suitable for use in Class I, Division 2, Groups A, B, C, D or unclassified or non‐haardous locations Technology • • CDMA EV‐DO Revision A GPRS (MS‐12
Specifications • Input Current 40 mA to 120 mA • Input Voltage 9 ‐ 28V DC Standards/Approvals • Carrier specific approvals • FCC • Industry Canada Host Interfaces • USB2.0 Full Speed (Mini‐B5) • Antenna Connection: · Cellular ‐ 50 Ohm SMA Warning: The antenna should be installed no closer than 20 cm from the human body. It is one of the RSS-102 requirements for devices not requiring SAR.
Specifications Power Connector Digital Output 4 3 Digital 2 Ground (black) 1 Input Power (red) Figure 2-2: Power Connector (not to scale) Warning: Explosion Hazard - Do not disconnect equipment unless power has been switched off or the area is known to be non-hazardous. Rev 3.0D Jul.
3: Activating your Raven XT on your cellular provider • Activating Using AT Commands 3 This chapter provides step‐by‐step directions for activating your Raven XT on your cellular provider’s network. H Tip: If you want to use USB to activate the Raven XT, you will need to install the USB driver first. Please refer to,Installing the USB driver, in Chapter 6.
Raven XT · If you have the different numbers for the MIN and MDN or MSID: AT*PROVISION2=MSL,MDN,MIN/MSID[,SID,NID] Using Direct Commands to the Internal Hardware Use only if the ALEOS method is unsuccessful. Activating the Modem 1. Put modem into passthru mode to by‐pass ALEOS. This will allow direct communication with the wireless module for programming. Entering passthru will take 10‐15 seconds and will return an ‘OK’ when it is complete. AT\APASSTHRU 2. Verify you are in Passthru mode. AT!STATUS 3.
Activating your Raven XT on your cellular provider Note: These AT commands are only needed if your cellular account supports Private Networking . Not all of the parameters are required. Please check with your carrier, which parameters need to be set. 1. Put modem into passthru mode. AT\APASSTHRU 2. Verify you are in Passthru mode. AT!STATUS 3. Set the NAI. AT$QCMIPNAI=[NAI],1 4. Set the IP address of the primary home agent. AT$QCMIPPHA=[PHA_IP],1 5. Set the IP address of the secondary home agent.
Raven XT 16 20070914
4: Hardware Installation of the Raven XT 4 • Connecting to Power • Connecting to a Computer or other Device • Indicator Lights • Mounting Note: During installation, please be sure that the cables are secure but do not bear any additional weight that could loosen the connector from the unit. Your Raven XT should be mounted in a position that allows easy access for the cables so they are not bent, constricted, in close proximity to high amperage, or exposed to extreme temperatures.
Hardware Installation of the Raven XT radio communications regulations of the Federal Communica‐ tions Commission (FCC), Industry Canada, or your country’s regulatory body (if used outside the US). Your Raven XT will work with most cellular antennas with a SMA connector. Connect the primary antenna or primary RF cable directly to the antenna connector on the back of the Raven XT. Tip: When using a cable to an antenna placed away from the modem, minimize the length of your cable.
Hardware Installation of the Raven XT Note: When using a DC power source (such as a solar cell), Sierra Wireless recommends placing a fuse (1-2 Amp) on the line close to the power source to protect your power source from possible surges due to shorts or other line issues. The DC power cable positive lead should be connected to the battery or power source positive terminal. The power cable negative lead should be connected to the battery or power source negative terminal.
Hardware Installation of the Raven XT Indicator Lights When your Raven XT is connected to power and an antenna, there is a specific pattern to the lights to indicate its operation mode. Figure 4-4: Raven XT Indicator lights • Network ‐ Indicates a successful connection to the cellular network with an IP address given and a channel acquired. • Signal ‐ 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 XT seconds (count 10 slowly, and wait for the power light to go off after the light pattern stops), the ALEOS configu‐ ration settings will return to the factory defaults. Caution: If you reset the modem configuration using the reset button, you may need to reactivate your Raven XT with your cellular provider. Light Patterns The LEDs on the front of the modem will respond in different patterns to indicate modem states.
Hardware Installation of the Raven XT To remove, press on the two edges of the modem and the brackets, as pointed by arrows in the diagram provided below. By doing this, the modem will snap out of the mounting bracket. Figure 4-5: Optional Mounting Bracket Rev 3.0D Jul.
Hardware Installation of the Raven XT Figure 4-6: Mounting bracket installation Rev 3.0D Jul.
Hardware Installation of the Raven XT Figure 4-7: 100-170-1013 : Mounting Bracket for Raven XT Rev 3.0D Jul.
5: Configuring your Raven XT • Using AceManager • Using Templates • Using a Terminal Application with AT Commands 5 With ALEOS as its “brain”, the Raven XT is a highly configu‐ rable device, more than just a “dumb” modem. To configure your Raven XT, 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 XT 2. Connect to your Raven XT 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 XT 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.0D Jul.
Configuring your Raven XT 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 XT 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 XT 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 XT 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 XT. Settings not applicable to the modem on which you are loading the template, will be discarded. 3.
Configuring your Raven XT 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. Rev 3.0D Jul.09 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).
Configuring your Raven XT Figure 5-12: AceNet : Template select d. Set the Retry Interval and check if you want to have the modems Reset when the template has been applied. Using a Terminal Application with AT Commands You can access and configure your Raven XT 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.
Configuring your Raven XT Figure 5-13: HyperTerminal 1. Choose a name and icon for your connection. a. Choose a name for your connection, such as Raven XT or Sierra Wireless AirLink Solutions. The name and icon are only for your own reference so you can find the connection at a later date. Tip: If you want to have a connection saved for both local and remote, it is recommended the connection name reflect the connection type, i.e. Raven XT local. b. Select OK. 2. Connect To a.
Configuring your Raven XT 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 · Flow Control: Hardware. Rev 3.0D Jul.
Configuring your Raven XT Figure 5-15: Port Settings Tip: If you have configured the Raven XT 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 a. Type AT and press Enter. You should get a reply of “OK” or “0”. Rev 3.0D Jul.
Configuring your Raven XT 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: Universal Serial Bus (USB) • Changing the USB port communication • Installing the USB driver • Using the Virtual Ethernet Port • Using the Virtual Serial Port 6 The Raven XT is equipped with a USB port which increases the methods by which you can send and receive data. The USB port can be set to work as either a virtual Ethernet port or a virtual serial port. A driver installation is required to use the USB port in either mode. Note: It is recommended that you use a USB 2.
Universal Serial Bus (USB) Figure 6-1: AceManager : USB By default, the port is set to work as a virtual Ethernet port (*USBDEVICE=1). To change the USB port to allow virtual serial port communi‐ cation, set *USBDEVICE to 0. To disable the USB port, set *USBDEVICE to 2. Note: If you use a terminal connection with the USB port to change *USBDEVICE, the change is immediate. Your connection will be terminated after inputting the command. Installing the USB driver 1.
Universal Serial Bus (USB) 2. Connect the Raven XT to your computer’s USB port When you connect the Raven XT for the first time to a USB port on your computer, Windows should detect a new device and prompt you to install the driver. Note: Windows will see each port type as a different USB device and will see every port on your computer separately. If you change the port type on the Raven XT or connect to a different USB port on your computer or hub, Windows will see it as a new device.
Universal Serial Bus (USB) · If you have installed AceManager or the Setup Wizard, the drivers have been conveniently copied to your hard drive. Enter C:\Program Files\Common Files\AirLink as the location to search. · If you will be installing the driver from a file downloaded from the Sierra Wireless website, select Include this location in the search and type in the location where you downloaded the file. b. Click Next.
Universal Serial Bus (USB) 4. Optional: Verify and Configure the Virtual Port Settings Virtual Ethernet The USB Ethernet connection will show up in your Network Connections as a Local Area Connection. Tip: If you also have an Ethernet card on the computer or have installed the USB Ethernet to more than one USB port on your computer, the USB Ethernet may show up with a number. Figure 6-7: Network Connections Note: By default, your Host IP is 192.168.14.100.
Universal Serial Bus (USB) Figure 6-8: System Properties d. Click on the + in front of Network Adapters. The newly installed driver, AirLink USB Ethernet/RNDIS, should be displayed. If the driver is displayed with a # and number behind the driver name (such as, AirLink USB Ethernet/RNDIS #2), it means more than one is installed on your computer, most likely for different USB port. More than one copy of the driver should not cause any problems since only the connected port and its driver would be active.
Universal Serial Bus (USB) Virtual Serial You can verify the installation by looking in the Device Manager. a. Click on Start > Control Panel. b. Double‐click on the System icon. c. Select the Hardware tab and click the Device Manager button. Figure 6-10: System Properties d. Click on the + in front of Modems. The newly installed driver, AirLink USB Serial Port, should be displayed.
Universal Serial Bus (USB) Figure 6-11: Device Manager - Serial To connect to the modem using the USB virtual serial, most applications or utilities will require you to select or enter the serial (COM) port number. The USB connection will appear as a standard serial port, so you will need to determine its number to connect to it. The driver installation will automati‐ cally assign a port or you can change it if you wish to another unused port. a.
Universal Serial Bus (USB) Figure 6-13: Driver Properties c. At the bottom of the screen, the current port used will be listed. Use the drop down menu to select an available COM port number if you need to change it. Figure 6-14: Advanced Settings Note: The COM port number assigned by driver installation is the next port that is available.The port number might vary depending on the number of devices connected (using serial or virtual serial).
Universal Serial Bus (USB) Using USB Ethernet with AceManager In AceManager, use the UDP or TCP connection and enter the IP address of the modem (192.168.14.31 by default) and the password (12345 by default). 192.168.14.31 Figure 6-15: AceManager : TCP Using USB Ethernet with a Terminal Emulation Utility Configure your terminal application for telnet communication. a. In HyperTerminal, select TCP/IP (Winsock) b. Use the IP address of the modem (192.168.14.
Universal Serial Bus (USB) Using the USB virtual serial port with AceManager In AceManager, the USB virtual serial port connection will appear as a standard serial port. Use the PPP connection and select the COM#serial port of the USB connection. Figure 6-17: AceManager : PPP Tip: You will need to open AceManager after you connect the USB cable to your computer for AceManager to have access to the USB Serial PORT. Using the USB virtual serial port with a Terminal Emulation Utility a.
7: Inputs, Relay Outputs, and Power Status 7 • Sub-section • Sub-section The Raven XT has special features for use in and M2M environment. The Raven XT can be configured to monitor the inputs and respond to specific types of events. These features can be configured to your needs. Capturing External Events using Inputs As part of its power connector, the Raven XT is equipped with an I/O interface for use in instrumentation applications.
Raven XT Figure 7-2: Digital Input Contact Closure • When a door or other latch is opened or closed. • Counting pulses or other electronic events. • When a gauge reaches a certain point. • When a container fills or empties. • When a switch or valve is opened or closed. • When the tow bar is raised or lowered. • Connected to a sensor, the level of fuel in a vehicle. • When the trunk of a vehicle is opened or closed. • When the ignition is turned on or off.
Inputs, Relay Outputs, and Power Status Caution: Never apply voltage to the Digital inputs. The inputs can only be switched open or closed to ground. Monitoring the Input and Output You can monitor the status of the digital inputs using ACEmanager, AT Commands, or with special reports sent by email, SMS, or other report types using Event Reporting. In ACEmanager, select the I/O group. Figure 7-3: ACEmanager : I/O Rev 3.0D Jul.
Raven XT Power Effect on device State Once the transition from powered on to standby, low‐power mode starts, the device will change state to AT mode. This results in the current mode being gracefully terminated. For the brief period when the device is preparing for low‐power mode, the device will remain in AT mode. At that time, it wonʹt auto‐answer, ATD will fail, etc. Once low‐power mode is entered, the device will then discard any data received on the host port.
8: Data Communication and Host Modes • Basic Modes • Serial Modes • Data Communication 8 The Raven XT 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 XT 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 XT 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 Figure 8-2: AceManager : PassThru PassThru Mode allows only specific AT commands. Some ALEOS commands will be unavailable when the Raven XT 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 XT). 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.
Data Communication and Host Modes Figure 8-3: AceManager : S0 If you need to change the port for Telnet (for example, you have the default port blocked on your firewall), the option is on the Other tab. The default telnet port is 2332. You can also change the Telnet timeout, if the connection is idle, default 2 minutes. Figure 8-4: AceManager : Other - *TPORT, *TELNETTIMEOUT.
Data Communication and Host Modes • AT\APPP • ATDT10.0.0.1 • ATDT10001 • ATD#19788 or #777 *99***1# • CLIENT In response to any of the preceding commands, the Raven XT 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.
Data Communication and Host Modes Link Radio Coverage There are three options for the “Link Radio Coverage to” field. You can link radio coverage to either Ethernet or USB (USBnet or USBserial)or disable the specified port. Hence, when not in coverage, the specified host port is turned off. Minimum off‐ time of 10 seconds apply for both USB and Ethernet. Note: When the cellular connection is down, the port is also down. SLIP SLIP mode is entered be using the “AT\ASLIP” command.
Data Communication and Host Modes 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). UDP Auto Answer UDP auto answer (previously called UDP half‐open) is set with S82=2. When set, the Raven XT will automatically establish a UDP session to the source IP address and port of the UDP packet received.
Data Communication and Host Modes Tip: TCP auto answer (S0) may also be set simultaneously with UDP auto answer. Then, when in the idle state, the modem will accept either a TCP or UDP incoming packet, and enter a TCP or UDP session as appropriate. Reliable UDP Reliable UDP adds a simple protocol on top of UDP to provide reliable delivery of data. When data is received from the host serial port, a 2 byte header is added to the data, containing a message type and a sequence number.
Data Communication and Host Modes When the Raven XT is in a TCP session, all characters received on the serial port are assembled into TCP packets and sent to the modeʹs remote IP address/port, and any packets received from the remote end of the TCP connection are disassembled and dumped onto the serial line. A TCP connection is established by one of the following methods: • Using the Dial TCP (DT) AT command. For example, ATDT192.168.3.23/3456.
Data Communication and Host Modes Hybrid Modes Hybrid modes are supported mainly for legacy implementa‐ tions. Some previous hybrid modes (MD=5, 6) are no longer implemented as special, unique modes. Now that UDP auto answer (UDP Half‐open, S82=2) can be enabled in conjunction 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.
Data Communication and Host Modes If you need more control over which gateway address, device address, and netmask that is given out by the internal DHCP server, you can use the private host mode, *HOSTPRIVMODE, and set the internal network IP addresses. The Raven XT will use 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.
Data Communication and Host Modes • *HOSTPEERIP ‐ Set to the IP address you want for the Raven XT. • *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. If the subnet mask is 255.255.255.0, it is safe to use 192.168.x.
Data Communication and Host Modes *HOSTPEERIP if it is changed) to 10.1.2.1 (or 10.1.2.2 if that was what the gateway address was given as). Tip: When PPPoE is used with the Raven XT, DHCP is not needed. A tunnel is set up connecting a device (such as your computer or a router) with the modem. The device will then simply use the MAC address of the Raven XT to send all outgoing packets.
Data Communication and Host Modes Figure 8-7: AceManager: Port Forwarding Figure 8-8: Port Forwarding In AceManager, enter the fields in the Port Forwarding group. Rev 3.0D Jul.09 • Number of PF Entries: Set value to number of used Port forward rules for performance gain. Each forwarding entry has four parameters: · Public Port: Port number of the Modem/Gateway. · Host/IF: Physical connection type to the modem. (USB, Ethernet, Serial). · Host IP: IP address of the connected device/computer.
Data Communication and Host Modes ports to be forwarded, and or changed without individual entry. For example, if Public range is 8080 ‐ 8090 to 80, this will cause 8086 to be forwarded to 86. You can set a default in the PPP/Ethernet group, if you do not need: • To forward to specific ports on your connected device, but you want all data to be directly used by ALEOS, or otherwise forwarded. • To pass to only one connected device.
Data Communication and Host Modes Note: In addition to the security settings in ALEOS, Inbound connections also require mobile terminated or Internet routable WAN/Cellular account. Figure 8-9: Outbound IP Filtering Rev 3.0D Jul.
Data Communication and Host Modes Figure 8-10: AceManager: Firewall - IP Note: Port Filtering Mode does not require to be set when you enable Non-Friends Port Forwarding. Rev 3.0D Jul.09 • Port Filtering Mode: Independent of the IP filtering, this mode can be enabled to block ports specified or allow ports specified. When enabled, all ports not matching the rule will be allowed or blocked depending on the mode.
Data Communication and Host Modes Figure 8-11: AceManager: Firewall Ports • Firewall Port: Specify the port you wish to have blocked or allowed, depending on the mode configured. • Packet Filtering: Not available at this time. Figure 8-12: AceManager: Firewall VPN Sierra Wireless AirLink modems with IPSec are designed to support the gateway‐to‐gateway security model. IPsec is the most general security model, in that it allows either side to initiate a VPN session. Rev 3.0D Jul.
Data Communication and Host Modes Split Tunnel Figure 8-13: GRE in AceManager: Default Configuration Name Default Value Description Incoming Out of Band 0 Enable (1) or Disable (0) access to modem remotely from machines that are not part of the IPSec network. Outgoing Aleos Out of Band 1 Enable (1) or Disable (0) sending of ALEOS traffic over the IPSec tunnel to a remote location. This option allows ALEOS generated data (E.g. RAP) to be sent outside the IPSec tunnel.
Data Communication and Host Modes VPN 1 The VPN group tab will show IPSec and GRE related param‐ eters and configuration fields on the right side of the pane Figure 8-14: AceManager: VPN 1 Rev 3.0D Jul.
Data Communication and Host Modes Table 8-1: Configuration Parameters in AceManager Name Tunnel Type Default Value 0 Description There are three options for each VPN tunnel and they are as follows: • Feature not used • IPSec • GRE • GRE and IPSec IPSec Status Disconnected Shows the status of IPSec. IPSec Gateway 64.163.70.30 Fill in the IPSec of the VPN concentrator. When GRE is enabled - Enter GRE gateway address, for example, 64.163.70.115.
Data Communication and Host Modes Table 8-1: Configuration Parameters in AceManager Name Local Address Type Default Value 1 Description Choose from drop-down menu. • “1” indicates Modem Public IP. It is the IP of the device behind the modem, when the modem is in public mode. • “2” indicates Host Private Subnet of the device behind the modem on the same subnet, when the modem is in private mode. • “5” indicates Single Address. • “17” indicates Subnet Address. Local Address 0.0.0.
Data Communication and Host Modes Table 8-1: Configuration Parameters in AceManager Name Default Value Description IPSec Key Group 2 Different Key Groups are, 1-DH1, 2-DH2 and 5-DH5. DH5 denotes highest security IPSec SA Life Time 7200 (seconds) This indicates how often the modem renegotiates the IKE SA. While the renegotiation happens the VPN tunnel gets disconnected temporarily. Note: For further information on IPSec, please refer to the IPSec User Guide.
Data Communication and Host Modes properly. If it determines the connection is not functioning, the modem will then attempt to reconnect to your cellular provider to reestablish IP connectivity. Configuring Keepalive In AceManager, the Keepalive settings are part of the Other group. Figure 8-15: 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 • *IPPINGADDR sets the IP address you want to use for the connection test. Caution: If *IPPINGADDR is left blank or is set to an invalid IP address (example, an IP which is unreachable or one which is not a valid IP address), modem performance will be adversely affected. Data usage using Keepalive Keepalive is an optional feature. If you frequently pass data with your modem, you most likely do not need to have Keepalive enabled.
9: IP Manager • Understanding Domain Names • Using IP Manager with your Raven XT • Understanding DNS 9 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 XT is connected and can change each time the modem reconnects to the network. • Static IP addresses are granted the same address every time your Raven XT 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 XT will be a subdomain of the domain used by the IP Manager server. Using IP Manager with your Raven XT 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 9-1: AceManager: Dynamic IP Rev 3.0D Jul.
IP Manager • *MODEMNAME : The name you want for the modem. There are some restrictions listed below for the modem name. • *DOMAIN : The domain name to be used by the modem. This is the domain name of the server configured for *IPMANAGER1. • *IPMANAGER1 : The IP address or domain name of the dynamic DNS server which is running IP Manager. • *IPMANAGER2 : The secondary server for the domain. While it is optional to have two servers configured, it is highly recommended.
IP Manager Each update is a total of 68 bytes from the modem with a 50 byte total response from the server for a round trip update of 118 bytes. interval (minutes) total bytes per day (24 hours) 10 16992 bytes 30 5664 bytes 60 2832 bytes 500 339.84 bytes Eairlink.com As a service, Sierra Wireless maintains a IP Manager servers which can be used for any AirLink modem.
IP Manager internal to the local network or frequently changing IP addresses, the DNS servers provided by Provider should be all you need.
IP Manager The “PPP-Peer” Domain Name The Raven XT 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 XT is not in PPP or SLIP address mode, “ppp‐peer” will resolve to 0.0.0.0. Rev 3.0D Jul.
10: Configuring Modbus/BSAP • Configuring the Raven XT at the Polling Host for Modbus on UDP • Configuring the Remote Raven XTs for Modbus with UDP 10 The Raven XT 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 XT 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 remote unit matching the RTU ID. The remote Raven XT then disassembles the packet before transmitting 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 XT and host Raven XT. Configuring the Raven XT at the Polling Host for Modbus on UDP This section covers a Polling Host with standard Modbus, variations may need additional AT commands. 1.
Raven XT 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 10-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 XT Figure 10-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 Raven XTs for Modbus with UDP This section covers standard Modbus settings for the Raven XT 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 XT 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 10-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.0D Jul.
Raven XT 97 20070914
11: SNMP : Simple Network Management Protocol • SNMP Configuration • SNMP MIB Definition Sample 11 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 XT, 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 XT 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 XT: the listening port, the security level, and the trap desti‐ nation. Figure 11-1: AceManager : Common > Other Rev 3.0D Jul.
SNMP : Simple Network Management Protocol Listening Port *SNMPPORT sets the port for the SNMP agent to listen on. If set 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. Security Level *SNMPSECLVL sets the security level and which version of SNMP communications are used. • 0 ‐ No security required.
SNMP : Simple Network Management Protocol Figure 11-2: AceManager : Change Password menu option The current password will be pre‐entered. As you type the new password and confirm it, the characters you type will be obscured by “x”. For the password, you can use numbers, letters, and/or punctuation. Figure 11-3: Change Password Caution: The password is case sensitive. “drowssaP” is not the same as “drowssap”. Trap Destination *SNMPTRAPDEST needs to be set with the destination IP and port.
SNMP : Simple Network Management Protocol Community String The community string can be configured using *SNMPCOM‐ MUNITY. The default is “public”.
SNMP : Simple Network Management Protocol ::= { 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 current ::= { general 7 } modemHWVer OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { general 8 } -- COMMON -date OBJECT-TYPE SYNTAX DisplayString MAX-AC
SNMP : Simple Network Management Protocol MAX-ACCESS read-only STATUS current ::= { common 4 } netPW OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { common 5 } requestPAP OBJECT-TYPE SYNTAX INTEGER { no(0), yes(1) } MAX-ACCESS read-only STATUS current ::= { common 6 } destinationAddress OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { common 7 } destinationPort OBJECT-TYPE SYNTAX INTEGER(0..
SNMP : Simple Network Management Protocol 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 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 ::= { gps 4 } END Display Responses The string that is displayed for these objects is the same display for the corresponding AT Command. Object Rev 3.
SNMP : Simple Network Management Protocol Object AT Command netPW *NETPW? requestPAP *HOSTPAP? destinationAddress S53 destinationPort S53 serialPortSettings S23 serialPortFlowControl \Q ipAddress *NETIP? netState *NETSTATE? netChannel *NETCHAN? rssi *NETRSSI? hostMode *HOSTMODE? powerMode *POWERMODE? PinPoint line modems only fixObtained PinPoint line modems only satelliteCount PinPoint line modems only latitude PinPoint line modems only longitude PinPoint line modems only
A: Configuration Commands • • • • • Info (information) Status Common Logging 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 XT 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 XT 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 109 • n=0 : Product name (for example, Raven XT). • n=1 : The Raven XT’s firmware (ALEOS) version, hardware ID, and copyright. • n=2 : The internal hardwareʹs firmware version and relevant hardware ID.
Configuration Commands Information Displayed in AceManager without AT Commands Listed • Versions of ALEOS, internal hardware, boot, and MSCI: Versions of internally configured hardware and software. Status Most of the commands in the “Status” group have read‐only parameters and provide information about the modem. The Status Group has more fields that can be displayed on most screens. You can either resize your window or use the scroll bar on the side to display the remainder.
Raven XT *HOSTMODE? The current host mode (AT, PPP, UDP, etc.). If the Raven XT 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? Note: If there is no current network IP address, 0.0.0.0 may be displayed. The current IP address of the modem reported by the internal module, generally obtained from your cellular provider.
Configuration Commands • Data Connection Failed: The Raven XT failed to connect, and it is now waiting a set time interval before it attempts to reconnect. Verify settings to activate the Raven XT. • Network Negotiation Fail: Network connection negoti‐ ation failed. This is usually temporary and often clears up during a subsequent attempt. • Network Ready: The Raven XT is connected to the 1x cellular network and ready to send data.
Raven XT AT Commands Requiring PassThru mode These commands are not displayed in AceManager. +GSN ESN (Electronic Serial Number) of the internal hardware module. 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.
Configuration Commands +++ 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. If the Raven XT is in a data mode (any mode other than PassThru), this command causes the modem to re‐enter AT command mode. The “+” is ASCII 0x2B.+++ is not available in AceManager. Tip: DAE=1 disables the +++ command. A/ Note: A/ is not proceeded by AT. Re‐execute last command.
Raven XT Several special dialing numbers exist to make it easy to establish a PPP or SLIP connection with the modem. ATD#19788 or ATDT#19788 will establish a PPP connection (see \APPP) and ATDT#7547 will establish a SLIP connection (see \ASLIP). Tip: The source port of the session is the Device Port (set by S110 or *DPORT). DS=n Allows a PPP connection to be initiated on the host port. • n=2 : Initiates the PPP connection. Cannot be configured in AceManager. Hn Hang‐Up Command.
Configuration Commands 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. Z Reset the Raven XT. 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 issued, any modified values will revert back to their previous values at modem reset. Cannot be configured in AceManager.
Raven XT • n=1 : Allow. *NETPW=pw The password that is used to login to the cellular network, when required. • pw=password (30 characters maximum) *NETPHONE? The modem’s phone number, if applicable or obtainable. *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.
Configuration Commands Serial This group includes commands specific to general use of the serial port. Figure 1-4: AceManager : Serial En Toggle AT command echo mode. • n=0 : Echo Off. • n=1 : Echo On. Note: With more than one connection types (serial, and Telnet, and USB) the echo command can be set differently on each interface. USB is only available on PinPoint X or Raven XT. Qn The AT quiet‐mode setting. If quiet mode is set, there will be no responses to AT commands except for data queried.
Raven XT 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. S5=n This register sets the character recognized as a backspace during command entry. Cannot be configured in AceManager. S6=n This register denotes the wait time, in seconds, before a blind dial (no dial tone detection). Cannot be configured in AceManager.
Configuration Commands Example: ATS23=19200,8N1 Sets modem to 19200, 8 databits, no parity, and 1 stop bit. 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.
Raven XT • n=1 : Assert DCD when in a data mode (UDP, TCP, PPP, or SLIP) (Default). • n=2 : Assert DCD when the modem has network coverage. &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.
Configuration Commands • n=0 : Fax/data call. • n=8 : Normal interconnect. +WVCLASS? queries the current setting. +IPR=n I/O Port Rate: Sets the data rate for the serial port (DTE‐DCE). C3x11 or C3x11E only. Default is 115200. Cannot be configured in AceManager. +WVLASS=n This command sets the Raven XT into a particular voice‐mode operation, which causes the internal hardware to process infor‐ mation presented in the Dial command in a manner suitable for that type of information.
Raven XT • n=0 : 115200 (valeur par défaut) • n=0 : 38400 (valeur par défaut) • n=1 : 230400 • n=1 : 115200 This command is only available with CDMA, iDEN, EDGE, or GPRS modems. May not be available for all modem models. *NUMTOIP=n Convert 12 digit number to IP. • n=0 : Use as name. • n=1 : Use as IP address. *PPPNOCARRIER=n Provides a “No Carrier” message to a device connected to the serial port using PPP or CHAP when the cellular connection becomes unavailable. • n=0 : Disabled (Default).
Configuration Commands • 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. S60=n Telnet Client Echo Mode.
Raven XT *ENQ=n Outputs an ENQ [0x05] after the TCP CONNECT delayed by the Delay Connect Response time (S221). • n=0 : Disabled (Default). • n=1 : Enable ENQ on CONNECT. UDP This group includes commands specific to UDP serial commu‐ nications. Figure 1-6: AceManager : UDP AIP=n Allow IP address. • 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).
Configuration Commands MDhh Default power‐up mode for the serial port: When the Raven XT 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. S82=n Enables UDP auto answer (half‐open) mode. • n=0 : Normal mode • n=2 : Enable UDP auto answer mode. S83=n Set or query UDP auto answer idle time‐out.
Raven XT *UDPLAST=n Note: *UDPLAST does not change the S53 setting in NVRAM. If the modem is reset, the original S53 setting will be restored from NVRAM. If enabled, sets S53 to the last accepted IP address through UDP auto answer. This can be used in conjunction with MD3 so that when there is no UDP session, new ethernet host data will cause a connection to be restored to the last IP accepted through UDP auto answer. • n=0 : Does not change S53 setting. (Default).
Configuration Commands • 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 Note: You can set up a second DNS User, if you have two DNS users. Dynamic IP This group includes commands specific to dynamic DNS.
Raven XT *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=”). • n=1 : First IP Manager server. • n=2 : Second IP Manager server. • name=domain name *IPMGRKEYn=key Sets the 128‐bit key to use to authenticate the IP update notifi‐ cations.
Configuration Commands 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”. One could be “mymodem1” with the other as “mymodem”. PPP/Ethernet This group includes commands specific to PPP (serial) or Ethernet connections between the Raven XT and a connected device.
Raven XT Protocol) allows one device, the DHCP server, to provide dynamic IP addresses to any other device which requests them. • n=0 : Disabled. The Raven X will not send out replies to DHCP requests. • n=0 : Disabled (cannot be configured in AceManager). • n=0 : Disables the DHCP server. • 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 *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.
Raven XT \APASSTHRU Note: This mode is not available through the remote AT telnet server. You will need to connect to the Raven XT with it connected directly to your computer. Sets the modem operation to pass through mode. This mode will pass any characters received on the port Ethernet directly to the internal hardware module and output any characters from the internal hardware module out the port Ethernet. This allows direct access/configuration of the hardware module.
Configuration Commands SMTP SMTP (Simple Mail Transfer Protocol) is the de facto standard for email transmission across the Internet. The Raven XT can send messages using SMTP if it has been configured to use a mail server. Note: You cannot send an Email with your Raven XT unless the Email server you have configured allows your Raven XT as a relay host. Talk to your network administrator to ensure you can send email through the email server using your Raven XT.
Raven XT • 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 of the email message. The email message is terminated and sent by entering a . or Ctrl‐Z on an empty line. Cannot be configured with AceManager.
Configuration Commands Other Figure 1-12: AceManager : Other DAE=n AT Escape Sequence detection. • n=0 : Enable • n=1 : Disable *DATZ=n Enables or disables reset on ATZ. • n=0 : Normal Reset (Default). • n=1 : Disable Reset on ATZ. *IPPING=n Set the period to ping (if no valid packets have been received) a specified address (*IPPINGADDR) to keep the modem alive (online).
Raven XT *IPPINGADDR=[d.d.d.d][name] Set the IP address or valid internet domain name for the Raven XT to ping to keep itself alive (online). *IPPING must to be set to a value other than 0 to enable pinging. • d.d.d.d=IP address • name=domain name *MSCIUPDADDR=name[/port] Modem Status Update Address ‐ where Name/Port is the domain name and port of the machine where the modem status updates will be sent. The status parameters of the Raven XT are sent in an XML format.
Configuration Commands • 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.
Raven XT *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 recommended to use a higher numbered port. *TQUIT Disconnects the telnet session. Not available in AceManager.. Firewall Firewall Mode can limit access to the Raven XT from the cellular network and the Internet.
Configuration Commands Figure 1-13: AceManager : Firewall FM=n Firewall mode ‐ Only allow specified IPs to access the Raven XT modem. • n=0 : Disable Firewall mode • n=1 : Enable Firewall mode ‐ Only packets from friends will be accepted, packets from other IP addresses are ignored. Fn=[d.d.d.d] Friends List 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.
Raven XT Firewall Range You can define three different ranges of start and end. All IP addresses between the start of the range and the end of the range would be allowed. For example, if Range 1 Start was set to 192.168.13.50 and the Range 1 End was set to 192.68.13.95, then the IP address of 192.168.13.100 would not be allowed since it would be outside of the range; but 192.168.13. 75 would be allowed. Port Filtering Mode allows only the defined user ports and can block other ports.
Configuration Commands Figure 1-14: AceManager: Port Forwarding Note: There are no AT commands for Port Forwarding parameters, they need to be configured using AceManager. Number of PF Enteries = n Set value to number of used Port forward rules for perfor‐ mance gain. Each forwarding entry has four parameters. • n = 1‐5 Public Port = n Port number of the Modem/Gateway. • n = 8090 Host/IF = n Physical connection type to the modem. (USB, Ethernet, Serial). • Host IP = d.d.d.
Raven XT • n= 80 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. Figure 1-15: 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.
Configuration Commands n=3 : Log client and Server events Telemetry/Addr List • Modbus, commonly used with telemetry devices, allows a connection via serial port to the modem. Telemetry and Addr List commands are only used when the modem is in one of the Modbus start‐up modes. Further, Telemetry and the Addr List are available with all Raven line modems which have a serial port, such as the Raven X and the Raven XT.
Raven XT • 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.
Configuration Commands Addr List Figure 1-17: AceManager : Addr List 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).
Raven XT Figure 1-18: 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.
Configuration Commands ~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.
Raven XT • NID=network ID ~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. Following writing the values, the modem must be reset. • nam=0 • min=phone number • msid=second number • sid=0 or the system ID • nid=63355 or the network ID Note: If ~NAMLCK has not been successfully executed, the modem returns ERROR.
Configuration Commands Edge/HSDPA This group includes commands specific to HSDPA, EDGE and GPRS. If you are not connecting to a modem which uses HSDPA, EDGE, or GPRS, you will not see this group in the menu. Figure 1-19: AceManager : EDGE/HSDPA *NETAPN=apn Easy entry of the APN. If left blank, the modem will attempt to use the default subscriber value as defined by the account. • apn=access point name +CGQMIN Minimum Acceptable Quality of Service Profile. Change should be at carrierʹs request.
Raven XT 151 20070914
B: Windows Dial-up Networking (DUN) • Installing a modem driver for Raven XT • Creating a Dial-Up Networking (PPP) Connection • Connecting to the Internet Using DUN B Dial‐up Networking (DUN) allows a computer or other device to use the serial port or USB virtual serial port on your Raven XT 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 2-1: Phone and Modem Options b. Select the Modems tab. Figure 2-2: Phone and Modem Options: Modems c. Rev 3.0D Jul.09 Select Add.
Windows Dial-up Networking (DUN) Figure 2-3: Add Hardware Wizard d. Check Don’t detect my modem; I will select it from a list. e. Select Next. Figure 2-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.0D Jul.
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 2-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 2-6: Add Hardware Wizard: Finish l. Rev 3.0D Jul.09 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 2-7: Phone and Modem Options: Modems a. Highlight the modem and select Properties. Figure 2-8: Modem Properties Rev 3.0D Jul.
Windows Dial-up Networking (DUN) b. Select the Modem tab. Figure 2-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 XT. 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 2-11: Create New Connection c. Select Next to start installing and configuring the DUN connection. Figure 2-12: New Connection Wizard d. Select Connect to the Internet. e. Select Next. Rev 3.0D Jul.
Windows Dial-up Networking (DUN) Figure 2-13: New Connection: Type f. Select Set up my connection manually. g. Select Next. Figure 2-14: New Connection: How do you want to connect? h. Select Connect using a dial‐up modem. i. Select Next. Figure 2-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 2-16: New Connection: Select Modem m. Type in a name for the connection, such as Sierra Wireless AirLink Modem. n. Select Next. Figure 2-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 XT), or any other designation for the connection. o.
Windows Dial-up Networking (DUN) Figure 2-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 2-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 2-22: DUN Connection b. Uncheck Use dialing rules. Rev 3.0D Jul.
Windows Dial-up Networking (DUN) c. Check Show icon...when connected. d. Select Configure, below the Connect using line. Figure 2-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.0D Jul.
Windows Dial-up Networking (DUN) Figure 2-24: Modem Configuration i. Back at the main properties screen, select the Networking tab. Figure 2-25: Networking j. Select Settings. k. Remove the checks from all three PPP settings. l. Rev 3.0D Jul.09 Select OK.
Windows Dial-up Networking (DUN) Figure 2-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 2-27: TCP/IP Properties o. Uncheck Use IP header compression. p. Check Use default gateway on remote network. q. Select OK. Rev 3.0D Jul.
Windows Dial-up Networking (DUN) Figure 2-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 2-29: AceView: Menu a. Right‐click on the AceView window to open the menu. b. Select Connection Settings. Figure 2-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 > Prosoft Technology RadioLinx Modem If you named the connection differently, use the name of the PPP connection you made earlier. Figure 2-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.0D Jul.
