Raven CDMA/1xRTT User Guide AirLink Communications, Inc. Version 2.
Information in this document is subject to change without notice ©Copyright AirLink Communications, Inc., 1993-2005. All rights reserved. WARNING The antenna(s) used for this transmitter must be installed to provide a separation distance of at least 20 cm from all persons and must not be co-located or operating in conjunction with any other antenna or transmitter. Important Notice Because of the nature of wireless communications, transmission and reception of data can never be guaranteed.
Contents CHAPTER 1 Introduction to Raven CDMA/1xRTT 1 Raven Overview 1 Raven front and back 1 CDMA/1xRTT Overview 2 Establishing a Internet Connection 2 Using the Raven to connect to the Internet 3 Using CDMA/1xRTT to Communicate with Your Equipment Common Uses for the Raven 3 4 Financial POS and Kiosk 4 Automation and Telemetry 5 Backup connection to the Internet 5 CHAPTER 2 Raven Activation 6 Connecting the Raven to your computer Quick Start Guide and Setup Wizard 6 6 Setup Wizard Menu
Contents Raven Indicator Lights 8 Raven indicator lights 8 CHAPTER 3 Raven Utilities 9 AceView 10 AceView 10 AceView: About Raven 10 Wireless ACE and Wireless ACE Web 11 Wireless ACE 11 AceNet 12 AceNet 12 Modem Doctor 13 Modem Doctor 13 CHAPTER 4 DNS: Using Names Instead of IP addresses Configuring DNS 14 14 Wireless ACE: DNS 15 PPP-Peer 15 CHAPTER 5 IP Manager 16 Fully Qualified Domain Name Dynamic Name Resolution 17 17 Configuring the Raven for Dynamic IP 18 Wireless ACE:
Contents CHAPTER 7 Host Modes 22 AT Mode 23 PassThru Mode PPP Mode 25 Slip Mode 25 UDP Pad Mode 24 26 UDP Auto Answer 26 Reliable UDP 27 Multicast UDP 28 TCP PAD Mode 28 TCP Auto Answer 29 Hybrid Modes 29 Hybrid Mode Settings 30 CHAPTER 8 Modbus/BSAP Configuration Modbus Overview 31 31 Telemetry 32 Remote Terminal Unit (RTU) 32 Supervisory Control and Data Acquisition (SCADA) 32 Programmable Logic Controller (PLC) 32 Modbus TCP/IP 33 Raven Modbus on UDP 33 Automation and Telemetry 33
Contents Host Raven IP 37 Wireless ACE: Destination IP 37 Dynamic IPs 37 RTU settings 38 Raven mounted in an enclosure with an RTU 38 RTU to Raven setup 39 Power Connections 39 CHAPTER 9 Simple Network Management Protocol (SNMP) SNMP Overview 40 40 Management Information Base (MIB) 41 SNMP Traps 41 Raven SNMP Configuration 41 Listening Port 41 Wireless ACE: *SNMPPORT 41 Security Level 42 Wireless ACE: *SNMPPORT 42 User Name and Password 42 Wireless ACE: Changing the Raven Password - Menu Option 43
Contents Using Telnet Terminal Emulation 54 HyperTerminal: Connection Name 55 HyperTerminal: TCP/IP Settings 55 HyperTerminal: AT mode via Telnet 56 Direct Serial Connection 56 HyperTerminal: Connection Name 56 HyperTerminal: Comport Setting 57 HyperTerminal: Comport Settings 57 AT Commands 57 Information and Status 58 Basic Commands 60 Activating (Provisioning) 62 Cellular Network (TELUS) 63 Local Network and Host Modes 64 PassThru Mode 71 Telnet 72 Friends Mode 73 Time and Date 74 Logging 74 DNS
CHAPTER 1 Introduction to Raven CDMA/1xRTT The AirLink Raven’s serial port can be connected to a computer or other device. The Raven uses CDMA/1xRTT to connect to TELUS’s cellular network to allow communication to the Internet. Raven Overview The Raven's rugged form factor is ideal for industrial and commercial applications that require real-time communications.
Introduction to Raven CDMA/1xRTT The Raven has several built in features to make it more effective in a variety of settings. In addition, Airlink provides several modem tools to further enhance the capabilities of the Raven. These features and tools are introduced in this User Guide.
Introduction to Raven CDMA/1xRTT FIGURE 2. Using the Raven to connect to the Internet Note: Private network connections are unique for each configuration and not covered as part of the standard installation. Using CDMA/1xRTT to Communicate with Your Equipment There are two types of addresses in TCP/IP, dynamic and static. • Dynamic addresses are assigned on a “need to have” basis. Your Raven might not always receive the same address each time it connects with TELUS.
Introduction to Raven CDMA/1xRTT If you have a dynamic IP address for your Raven, you can use a service (such as IP Manager, covered later in this User Guide) to translate a dynamic IP address to a fully qualified domain name so you can contact the Raven as if it had a static IP. Caution: The IP address given to your Raven by TELUS must also be Internet routable if the computer you need to connect to the Raven is not connected directly to TELUS's IP network.
Introduction to Raven CDMA/1xRTT 5 FIGURE 4. Automation and Telemetry FIGURE 5. Backup connection to the Internet TELUS CDMA/1xRTT Raven User Guide Version 2.
CHAPTER 2 Raven Activation Your Raven needs specific parameters before it can operate on the CDMA/1xRTT network. Generally TELUS will provide you with the necessary parameters to get the Raven configured. Connecting the Raven to your computer Your Raven’s serial port can be connected directly to most computers or devices using a standard straight through serial cable.
Raven Activation Note: The web site may have a more recent Setup Wizard and Quick Start Guide than those included with your Raven. It is recommended that you check with the web site for the latest version before installing your Raven. You will need to look for TELUS, CDMA/1xRTT, and the Raven. Other Setup Wizards may not work to connect you to TELUS. To run the Setup Wizard, you will need the Microsoft .NET framework and Microsoft Windows 98, Microsoft Windows 2000, Microsoft Windows XP, or later. 1.
Raven Activation Configuring the Raven using Wireless ACE You can configure your modem using Wireless ACE (page 11) or AceNet (page 13). It is not recommended to activate a modem using either Wireless ACE or AceNet. An alternate method to configure and activate your Raven is by AT commands (full listing beginning on page 58) sent directly to the modem via a terminal application (page 55).
CHAPTER 3 Raven Utilities AirLink offers a suite of utilities to optimize your Raven’s performance, allowing you to remotely view status and make changes to the configuration as needed. • • • • AceView Wireless ACE and Wireless ACE Web AceNet Modem Doctor This section of the Raven User Guide covers basic information about these utilities. For additional information on a specific utility, please refer to the user guide for that utility.
Raven Utilities AceView AceView is a low-profile monitoring tool to view the status of your AirLink Raven and display network status, IP address, RSSI strength, firmware version, and other basic information. FIGURE 1. AceView You can connect to your Raven locally or remotely using a known IP address or a fully qualified domain name. The display is updated periodically as AceView polls the Raven at a specified interval. GPS is available only for PinPoint modems. FIGURE 2.
Raven Utilities Wireless ACE and Wireless ACE Web Wireless AirLink Configuration Executive (ACE) and Wireless Ace Web allow you to monitor your Raven either remotely or locally with a direct connection to the modem. Wireless ACE Web has a web-based interface and covers nearly the same range of features a Wireless ACE. Features discussed in this section apply to both versions unless otherwise noted. FIGURE 3.
Raven Utilities AceNet With AceNet you can monitor several AirLink modems at the same time. The modems can be connected locally or remote. Several features can be displayed and logged. AceNet is a seperate product which can be purchased from AirLink. FIGURE 4. AceNet Using a template from Wireless ACE, you can change the configuration in several modems at the same time and can check and update their firmware as well. AceNet also features logging to a database and charting for the monitored modems.
Raven Utilities Modem Doctor Modem Doctor is a troubleshooting utility. This utility will allow you to get a log file of the Raven activity which you can then send to AirLink support, erase the current configuration completely, and temporarily set the Raven to a known serial configuration to aid in trouble shooting. FIGURE 5. 13 Modem Doctor TELUS CDMA/1xRTT Raven User Guide Version 2.
CHAPTER 4 DNS: Using Names Instead of IP addresses A domain name is a name of a server or device on the Internet which is associated, generally, with an IP address. In a way, a domain name is like the street address of your house with the phone number being like the IP address. You can contact the house either by going to the address (name) or by calling the phone number (IP address).
DNS: Using Names Instead of IP addresses You can use AT commands (page 58), Wireless ACE (page 11), and ACE Net (page 12) using a template built from Wireless ACE to configure DNS in your Raven. FIGURE 1. Wireless ACE: DNS *DNS1 and *DNS2 - Set these to your primary and secondary DNS servers. These maybe be overwritten by TELUS when your Raven gets its IP address.
CHAPTER 5 IP Manager IP Manager translates a dynamic IP address to a fully qualified domain name so you can contact Raven by name as if it had a static IP. Since TELUS frequently does not offer static IP addresses, IP Manager is a free service provided by AirLink for your Raven to translate a dynamic IP address into a fully qualified domain name so it can be contacted directly on the Internet.
IP Manager Fully Qualified Domain Name A fully qualified domain name (FQDN) generally has several parts. • Top Level Domain (TDL): The TDL is the ending suffix for a domain name (.com, .net, .org, etc.) • Country Code Top Level Domain (ccTDL): This suffix is often used after the TDL for most countries except the US (.ca, .uk, .au, etc.) • Domain name: This is the name registered with ICANN (Internet Corporation for Assigned Names and Numbers) or the registry for a the country of the ccTDL (i.e.
IP Manager If the Raven is configured for Dynamic IP, when the Raven first connects to the Internet, it sends a IP change notification to IP Manager. IP Manger will acknowledge the change and update the DNS record. The changed IP address will then be the address for the Raven’s configured name. Once the Raven’s IP has been updated in IP Manager, it can be contacted via name. If the IP address is needed, you can use the domain name to determine the IP address.
IP Manager 3. IP Manager IP Address: The IP or domain name of the dynamic DNS server. Earlink.com is the IP Manger server provided by AirLink. Note: To use the name here instead of the IP, you need to have DNS set up in your Raven. See “DNS: Using Names Instead of IP addresses” on page 14. 4. IP Manager update interval: How often you want the address sent to IP Manager. If this is set to zero, the modem will only send an update if the IP changes (i.e.
CHAPTER 6 Keepalive It is not uncommon for your Raven to be disconnected from TELUS after an extended period of inactivity. This is generally a feature intended to reduce your charges for inactive use. Keepalive is used to test and maintain the Raven’s connection to TELUS by pinging an IP address after a specified period of inactivity. Keepalive is recommended for users who have a remote terminated modem that infrequently communicates to the network.
Keepalive To set the Keepalive using Wireless ACE, select Other from the menu on the left. FIGURE 1. Keepalive Configuration in Wireless ACE *IPPING sets the interval, in minutes, you want Keepalive to test the network connection. To disable Keepalive, set *IPPING to 0 (default setting). *IPPINGADDR sets the IP address you want to use for the test. If *PPINGADDR is left blank or is set to an invalid IP address (i.e.
CHAPTER 7 Host Modes The Raven can be in one of six communication modes as the Host to the computer or other device attached to the serial port of the Raven. AT: The Raven accepts and responds to standard, Hayes-style AT commands. This is enabled by default. PassThru: Direct connection to internal hardware (OEM Module) of the Raven. PPP: The Raven uses PPP to communicate. SLIP: The Raven uses SLIP to communicate.
Host Modes in the AT Command listing, page 66) to the desired mode. If this setting is nonzero, the modem will enter the specified mode after 5 seconds. If you want to cancel this behavior, the ATMD0 command can be used before the 5-second time-out expires. If the modem 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).
Host Modes For V=0, (Terse mode), a numeric result code is output with a single trailing (no is output), while any AT query response is followed by (there is no preceding output).
Host Modes PPP Mode In PPP mode, the Raven acts as a PPP server, providing an IP address, and DNS servers (if available) to the Host. PPP mode is entered from the AT mode by using any of the following commands: AT\APPP ATDT10.0.0.1 ATDT10001 ATD#19788 CLIENT In response to any of the preceding commands, the modem will respond with CONNECT and is ready for the host to begin PPP negotiations.
Host Modes UDP Pad Mode When the modem is in UDP PAD (Packet Assembly and Disassembly) Mode, all characters received on the serial port are assembled into UDP packets and sent to the Raven’s remote IP address/port, and any packets received from the same IP/ port-destined for the Raven’s Device Port (see *DPORT)--are disassembled and dumped onto the serial line. A UDP session is initiated by one of the following events: • Using the Dial UDP (DP) AT command (ex. ATDP192.168.3.
Host Modes commands), while allowing sessions to be established from different UDP sources. A UDP session will be initiated either by incoming serial data or by an incoming UDP packet. The session, started by either method, will be terminated when no data has been sent or received for the S82 period. Once the session terminates, another may be initiated by either means. When the session is initiated by serial data, the new session will be established using the destination address specified in S53.
Host Modes Multicast UDP Multicast UDP results in any data received from the host serial port being sent to all the clients in the Modbus list. The remote port number is taken from S53. To avoid flooding the network, the packets are sent to each client with a 20ms pause in between. The receipt of UDP packets works as in normal UDP mode (i.e. bound by the value S53 and/or AIP).
Host Modes TCP packet assembly is affected by the values of S50 (PAD Forwarding Time-out) and S51 (PAD Forwarding Character). Data received in the serial buffer will be transmitted when the idle inter-character time-out specified in S50 (in tenths of seconds) occurs or when a character is received that matches S51 (if non-zero). The TCP session will be terminated if no data is transmitted or received for the time interval specified in TCPT and TCPS.
Host Modes TABLE 1. Hybrid Mode Settings AT Setting Hybrid (MD5) Hybrid2 (MD6) MD 3 3 S82 2 2 S0 1 1 *UDPLAST 0 1 TELUS CDMA/1xRTT Raven User Guide Version 2.
CHAPTER 8 Modbus/BSAP Configuration 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.
Modbus/BSAP Configuration Telemetry Telemetry is an automated communications process by which data is collected from instruments located at remote or inaccessible points and transmitted to receiving equipment for measurement, monitoring, display, and recording. Transmission of the information may be over physical pairs of wires, telecommunication circuits, radios or satellite.
Modbus/BSAP Configuration to a user-created program stored in its memory. Containing inputs and outputs similar to an RTU, PLCs are frequently used for typical relay control, sophisticated motion control, process control, Distributed Control System and complex networking. Modbus TCP/IP Modbus TCP/IP simply takes the Modbus instruction set and wraps TCP/IP around it. Since TCP/IP is the communications standard for the Internet and most networked computers, this provides a simpler installation.
Modbus/BSAP Configuration Configuring the Raven at the Polling Host for Modbus on UDP You can use either Wireless ACE (page 11 and page 53), direct serial communication or Telnet (page 55) to configure the modem using AT commands (page 58). This section covers standard Modbus, variations may need additional commands (AT Commands: page 84). Port The destination port for the Raven at the host needs to match the device port in use on all the Ravens at the remote sites.
Modbus/BSAP Configuration • • • • ATMD13: Modbus ASCII ATMD23: Modbus RTU (Binary) ATMD33: BSAP ATMD63: Variable Modbus (individual parameters are set up manually) IDs to IPs The last step of configuring the Raven at the host is setting the IDs to their specific IPs. In Wireless ACE, select the menu option Addr List. FIGURE 5. Wireless ACE: Addr List Addresses can be entered in decimal or hex. Wireless ACE will translate hex entries into decimal.
Modbus/BSAP Configuration When you configure IPManager for the host Raven, make note of your modem name and domain setting in Wireless ACE in the menu selection Dynamic IP to be used with the remote modems. FIGURE 6. Wireless ACE: Modem Name and Domain With names instead of IPs for the Address List, the host Raven will query the DNS server for the current IP assigned to the specific name of a remote Raven to send a message coroponding to the ID.
Modbus/BSAP Configuration Default Power-up Mode Each Raven at the remote locations will need to be configured to communicate with the Raven at the host. In Wireless ACE, select UDP in the side menu. Select 03UDP (normal UDP operation) as the value for MD. FIGURE 7. Wireless ACE: UDP Power-up Mode Host Raven IP If the Host Raven has a static IP, enter it in the Destination Address for S53. In Wireless ACE, select Misc in the side menu. FIGURE 8.
Modbus/BSAP Configuration 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. FIGURE 9. Raven mounted in an enclosure with an RTU TELUS CDMA/1xRTT Raven User Guide Version 2.
Modbus/BSAP Configuration 39 FIGURE 10. RTU to Raven setup FIGURE 11. Power Connections TELUS CDMA/1xRTT Raven User Guide Version 2.
CHAPTER 9 Simple Network Management Protocol (SNMP) The Raven is can be configured as an SNMP agent and supports SNMPv2c and SNMPv3. SNMP Overview The Simple Network Management Protocol (SNMP) was designed to allow remote management and monitoring of a variety of devices from a central location.
Simple Network Management Protocol (SNMP) Management Information Base (MIB) The management information base (MIB) is a type of database used to compile the information from the various SNMP agents. Reports from various agents, such as the Raven, are sent as data in form designed to be parsed by the NMS into its MIB. The data is hierarchical with entries addressed through object identifiers.
Simple Network Management Protocol (SNMP) Security Level *SNMPSECLVL sets the security level and which version of SNMP communications are used. FIGURE 2. Wireless ACE: *SNMPPORT 0 - No security required. SNMPv2c and SMNPv3 communications are allowed. 1 - Authentication required. SNMPv3 is required to do authentication and SNMPv2c transmissions will be silently discarded. Authentication is equivalent to the authNoPriv setting in SNMPv3. 2 - Authentication required and messages are encrypted.
Simple Network Management Protocol (SNMP) FIGURE 3. Wireless ACE: Changing the Raven 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”. FIGURE 4. Wireless ACE: Changing the Raven Password For the password, you can use numbers, letters, and/or punctuation. Caution: The password is case sensitive. “drowssaP” is not the same as “drowssap”. 43 TELUS CDMA/1xRTT Raven User Guide Version 2.
Simple Network Management Protocol (SNMP) 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. FIGURE 5. Wireless ACE: *SNMPPORT 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.
Simple Network Management Protocol (SNMP) SYNTAX MAX-ACCESS STATUS ::= { general 2 } DisplayString read-only current 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 }
Simple Network Management Protocol (SNMP) otaProgrammingEnable OBJECT-TYPE SYNTAX INTEGER { disabled(0), enabled(1) } MAX-ACCESS read-only STATUS current ::= { common 2 } devicePort OBJECT-TYPE SYNTAX INTEGER(0..
Simple Network Management Protocol (SNMP) serialPortSettings OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { common 9 } serialPortFlowControl OBJECT-TYPE SYNTAX INTEGER { 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 S
Simple Network Management Protocol (SNMP) serialReceived OBJECT-TYPE SYNTAX INTEGER MAX-ACCESS read-only STATUS current ::= { status 6 } hostMode OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current ::= { status 7 } 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 curren
CHAPTER 10 Hardware Installation Your AirLink Raven should be mounted in a position that allows easy access for the cables so they are not bent or constricted. The LEDs on the front panel should be visible for ease of operational verification. You should ensure that there is adequate airflow around the modem but that it is kept free from direct exposure to the elements (sun, rain, etc.). The exterior of the case should also be grounded.
Hardware Installation FIGURE 1. Raven Mounting Bracket, part number 100-170-1009 A TELUS CDMA/1xRTT Raven User Guide Version 2.
Hardware Installation Connecting the Antenna Your Raven will work with most standard cellular antennas with a TNC connector and rated to work with CDMA/1xRTT technology. Connect the antenna or RF cable directly to the TNC connector on the back of the Raven. FIGURE 2. Raven connectors Connecting power Your Raven can be used with either DC (available in most automobiles) or 110 AC (standard US wall power) with the appropriate power adapter (available from AirLink).
Hardware Installation Your Raven can also be connected to a USB to serial port device connected to a computer or other device which does not have an available serial port but does have USB. TELUS CDMA/1xRTT Raven User Guide Version 2.
CHAPTER 11 AT Commands Just as with a Hayes compatible analog modem, the Raven parameters can all be configured with AT commands. Wireless ACE and Wireless ACE Web (See “Wireless ACE and Wireless ACE Web” on page 11. and below) are a graphical interface for the AT commands and it is highly recommended that you use one of them to modify any parameters, however a terminal emulation application, such as Telnet, can be used instead.
AT Commands To set or commit the changes in the modem, use the Write button at the top of Wireless ACE interface. FIGURE 2. Wireless ACE: toolbar For more information on using Wireless ACE or Wireless ACE Web, please refer to the Wireless ACE User Guide. Note: Some of the AT Commands are not able to be configured in Wireless ACE. Using Telnet Terminal Emulation Most installations of Microsoft Windows come with a version of HyperTerminal. Start>All Programs>Accessories>Communications>HyperTerminal 1.
AT Commands FIGURE 3. 2. Select TCP/IP (Winsock) for Connect Using. If the modem is remote, the host address will be the current Internet IP of the Raven. Change the port number to 2332 (default telnet port for the Raven). FIGURE 4. 3. 55 HyperTerminal: Connection Name HyperTerminal: TCP/IP Settings When HyperTerminal connects to the Raven, you may be prompted for a password. The default password is 12345. When you press Enter, you should get back a reply of “OK”.
AT Commands FIGURE 5. HyperTerminal: AT mode via Telnet 4. Type AT and press Enter. You should get a reply of “OK” or “0”. 5. 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. 6. 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 FIGURE 7. 3. HyperTerminal: Comport Setting Change the Bits per Second to 115200 (default), Data Bits to 8, Parity to None, Stop Bits to 1, and Flow Control to Hardware. FIGURE 8. HyperTerminal: Comport Settings 4. Type AT and press Enter. You should get a reply of “OK” or “0”. 5. 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. 6. If you get a reply of “OK”, then you entered the command successfully.
AT Commands • Acceptable parameters and/or specific formats are in the parameters column. • Required variable parameters are denoted with italicized text, ex. Dn. The n is variable and noted in the parameters column. • Optional parameters are denoted with square brackets [ ]. • Most commands with parameters can be entered with ? to read the current value, i.e. AT&D? will respond with “2” if the default has not been changed. • AT Commands are not case sensitive.
AT Commands TABLE 1. Information and Status Command Details *NETIP? The current IP address of the modem reported by the embedded OEM module (generally obtained from Carrier). This is the address to which packets can be sent in order to contact the Raven from the Internet. Note: If there is no current network IP, 0.0.0.0 may be displayed. Use *NETALLOWZEROIP if you need to allow the display of an IP ending in a zero. See “*NETALLOWZEROIP=n” on page 79. *NETOK Checks the CDMA/1xRTT network connection.
AT Commands TABLE 1. Information and Status Command Details *SMTPSTATUS? The status of the last issued SMTP message (*SMTPSEND). If no status is available 0 is returned. Once read, the status is cleared. The status codes are received from the SMTP server the modem attempted to send the request. Ex. 354 = send in progress, 250 = sent ok. *SNTPQUERY? The current SNTP (Simple Network Time Protocol) time and date. +ECIO? The EC/IO value. +PRL? Preferred Roaming List (PRL) version.
AT Commands TABLE 2. Basic Command Commands Parameters Details Hn Hang-Up Command n=1 O none Hang-up Online (Remote) Causes the modem to go from Command State to data state. 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. Vn Command Response Mode. n=0 Terse (numeric) command responses n=1 Verbose command responses (Default). Xn Z Extended Call Progress Result mode.
AT Commands Note: You may need go into PassThru mode to activate the Raven. In that case, you will need to refer to the PassThru Mode table (page 91page 71page 53) and the Commands Usable with PassThru table (page 105page 86page 66). TABLE 3. Activating Command (Provisioning) Parameters Details OPRG=n Enables/disables over-the-air firmware upgrading of the Raven. n=0 Disables over-the-air programming. n=1 Enables over-the-air programming.
AT Commands TABLE 3. Activating (Provisioning) *PROVISION2= [MSL],[MDN],[MIN],[SID], [NID] same as above but with MDN and MIN “split” A second set of modem provision parameters, when the MDN and MIN (MSID) are different or “split”. *STATICIP=d.d.d.d d.d.d.d=IP 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 module and try again. The default is 0.0.0.0, which allows any IP address from the network. Ex.
AT Commands TABLE 4. Cellular Network (TELUS) Command Parameters Details *NETSTATE? none See “*NETSTATE?” on page 16.. *NETWDOG=n n=minutes Network connection watchdog: The number of minutes to wait for a network connection. If no connection is established within the set number of minutes, the Raven resets. Default = 20 min. 0 = Disable. The Local network for the Raven is the one to which it is connected physically via the serial port to your computer, device, hub, or switch.
AT Commands TABLE 5. Local Network and Host Modes Command Parameters Details MDhh hh (hex byte) = Default power-up mode 00 - normal 02 - PPP mode When the Raven is power-cycled, it may enter the mode specified by this command after 5 seconds. On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode. 03 - UDP mode See also S53 to set the port for UDP or TCP.
AT Commands TABLE 5. Local Network and Host Modes Command Parameters Details S23=[speed],[databits] [parity][stop bits] speed= Serial line parameters. 300 | 1200 | 2400 | 4800 | 9600 | 19200 | 38400 | 57600 | 115200 | 230400 Ex. ATS23=19200,8N1 (sets modem to 19200, etc.) databits = 7 or 8 Note: MUST be 8 data bits for PPP mode. The settings take affect after reset. parity = O=Odd E=Even N=None M=Mark Can also be set using &L=[speed],[databits] [parity][stop bits] stopbits = 1 | 1.
AT Commands TABLE 5. Local Command Network and Host Modes Parameters Details S211=n S221=n For applications or situations where hardware control of the DTR signal is not possible, the modem can be configured to ignore DTR. When Ignore DTR is enabled, the modem operates as if the DTR signal is always asserted. n=0 Use hardware DTR. (default) n=1 Ignore DTR. n=3 Ignore DTR and assert DSR. This value is deprecated, and it is recommended to use &S to control the DSR instead.
AT Commands TABLE 5. Local Command Network and Host Modes Parameters Details &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 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. Note: S211 can also be used to request that DSR is always asserted.
AT Commands TABLE 5. Local Network and Host Modes Command Parameters Details *HOSTMODE? none The current host mode (AT, PPP, UDP, etc.) which the modem is in. If the modem is not in AT mode, telnet into the modem to execute this command. *HOSTNETMASK=n.n.n.n n.n.n.n = subnet mask, i.e. 255.255.255.0 Netmask for the host interface. Allows communication with a subnet behind the host interface. *HOSTPAP=n Use PAP to request the user login and password during PPP negotiation on the host connection.
AT Commands TABLE 5. Local Command Network and Host Modes Parameters Details *UALL=n Accepts UDP packets from any IP address when a UDP session is active. If there is no UDP session active, an incoming UDP packet will be treated according to the UDP auto answer and AIP settings. n=0 No effect (Default). n=1 Accept UDP data from all IP addresses when in a UDP session. *UDPLAST=n If enabled, sets S53 to the last accepted IP address through UDP auto answer.
AT Commands PassThru Mode is used to communicate directly to the Raven’s internal hardware (OEM module). TABLE 6. PassThru Mode Command Parameters Details \APASSTHRU none Set modem operation to pass through mode. This will pass any characters received on the serial port directly to the internal OEM module and output any characters from the internal OEM module out the serial port. This allows direct access/configuration of the OEM module.
AT Commands TABLE 7. Telnet Command Parameters S60=n Details Telnet Client Echo Mode *TELNETTIMEOUT=n n=0 No Echo n=1 Local Echo (Default) n=2 Remote Echo n=minutes 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. *TPORT=p p=0-65535 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.
AT Commands Friends Mode can limit access to the Raven from the Carrier network and the Internet. Friends Mode is a limited form of security. TABLE 8. Friends Command Mode Parameters FM=[n] Fn=[d.d.d.d] 73 Details Friends Mode - Only allow specified IPs to access the Raven. n=0 Disable Friends mode n=1 Enable Friends mode - Only packets from friends will be accepted (see below); packets from other IP addresses are ignored. n = Friends list index [0 - 9] Friends mode IP address d.d.d.
AT Commands Time and Date in the Raven is set to UTC (Coordinated Universal Time). Time is expressed in 24-hour format, i.e. 13:23:57 would be 1:23pm. You can set time and date manually or you can have it set automatically with a regular query to an Internet time server (such as time.nist.gov) using SNTP (Simple Network Time Protocol). TABLE 9. Time and Date Command Parameters Details *DATE=[mm/dd/ yyyy],[hh:mm:ss] mm/dd/yyyy = Sets and queries the clock in the unit.
AT Commands TABLE 10. Logging Command Parameters Details *DBGEVTLOGCLEAR none Clears the content of the logs in the modem. *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 the event log. *DBGPPPLVL=n Sets the logging level for the PPP stack. n=0 No logging n=1-3 Enables logging at different levels of detail.
AT Commands IPManager (See “IP Manager translates a dynamic IP address to a fully qualified domain name so you can contact PinPoint by name as if it had a static IP.” on page 16.) is a service from AirLink which allows a Raven with a dynamic IP to be contacted as if it had a static IP by using a Fully Qualified Domain Name. TABLE 12. IPManager Command Parameters Details *DOMAIN=[name] name = domain name (i.e. eairlink.com) Domain (or domain zone) of which the Raven is a part.
AT Commands TABLE 12. IPManager Command Parameters Details *MODEMNAME=[name] name = domain name (i.e. eairlink.com) Name of the Raven (up to 20 characters long) to use when performing IP change notifications to IPManager. The value in *DOMAIN provides the domain zone to add to this name. Caution: Only letters, numbers, and hyphens can be used. Example: if *MODEMNAME=mymodem and *DOMAIN=eairlink.com, then the modem's fully qualified domain name is mymodem.eairlink.com.
AT Commands TABLE 13. Keepalive Command Parameters *IPINGFORCE=n *MINXMIT=n Details Have IP pings be always sent when their specified period expires. n=0 IP pings are sent only when the Raven has not received any IP packets for the specified IP ping interval. n=1 IP pings are issued when the IP ping interval expires regardless of received IP packets. n=seconds Minimum transmit period enforcement.
AT Commands TABLE 14. Direct Communication Command Parameters Details D[method][d.d.d.d][/ppppp] method = or P - Establish a UDP connection Dial a connection to a remote IP and Port using either UDP, TCP, or Telnet. D[method][@name][/ppppp] T - Establish a TCP connection N - Establish a Telnet connection d.d.d.d = IP address to contact name = domain name to contact ppppp = IP port to contact Examples: ATD - Dial (establish) default connection per S53 ATDP192.168.13.
AT Commands TABLE 14. Direct Communication Command Parameters Details S53=[method][d.d.d.d][/ ppppp] method = P - UDP Destination IP address, port, and method. These are used as defaults for the D (Dial) AT command. T - TCP Examples: N - Telnet ATS53=T192.168.100.23/12345 d.d.d.d = IP address or name ATS53=foo.earlink.com ppppp = the port address ATS53=192.168.100.
AT Commands TABLE 15. SMTP (email) Command Parameters Details *SMTPSEND=[email] [body] email=email address Sends an email to the address specified, followed by the body of the email message. body=message body The email message is terminated and sent by entering a . or Ctrl-Z on an empty line. See also *SMTPSUBJ, *SMYPFROM, and *SMTPADDR *SMTPSTATUS? none Returns the status of the last issued SMTP message (*SMTPSEND). If no status is available 0 is returned. Once read, the status is cleared out.
AT Commands TABLE 16. Modbus Settings Command Parameters Details MDhh hh (hex byte) = Set or query the modem's default power-up mode 00 - normal 02 - PPP mode When the Raven is power-cycled, it may enter the mode specified by this command after 5 seconds. On startup, typing ATMD0 within 5 seconds changes the mode to normal (AT command) mode. 03 - UDP mode See also S53 to set the port for UDP or TCP. 01 - SLIP mode 04 - TCP mode MLISTid=d.d.d.d id=ID d.d.d.
AT Commands TABLE 16. Modbus Command Settings Parameters Details MVOPT=n Modbus Variant Option Sets various behavioral options when dealing with a Modbus-variant protocol. This parameter is used when the when the Mode Default (MD) is set to hex 63 n=0 No special action (Default) n=1 Skip leading zeroes in Modbus packets. Cannot be configured in Wireless ACE. MVTYP=n Modbus Variant Type The data-type of the RTU ID in a modbus-variant protocol.
AT Commands TABLE 16. Modbus Settings Command Parameters Details S53=[method][d.d.d.d][/ ppppp] method = P - UDP Destination IP address, port, and method. These are used as defaults for the D (Dial) AT command. T - TCP Examples: N - Telnet ATS53=T192.168.100.23/12345 d.d.d.d = IP address or name ATS53=foo.earlink.com ppppp = the port address ATS53=192.168.100.
AT Commands Simple Network Management Protocol (SNMP) can be used to monitor devices connected to a network for any conditions which warrant administration attention. By default, SNMP uses port 161, however most Internet providers (including cellular) block all ports below 1024 as a security measure. TABLE 17. SNMP Command Parameters Details \ACEPW=pw pw=password Change the ACE password to a new value. Password is case-sensitive. Default password is 12345. Ex.
AT Commands TABLE 18. Other Command Settings Parameters Details *NUMTOIP=n \ACEPW=pw Convert 12 digit number to IP. n=0 Use as name. n=1 Use as IP. pw=password Change the ACE password to a new value. Password is case-sensitive. Default password is 12345. Ex. AT\ACEPAW=new123 +CTA=n n=seconds 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.
AT Commands TABLE 19. Commands Command Usable with PassThru Parameters I[n] O Details n=0 The modem’s module type. n=3 The OEM module's unique ID (ESN). none Online (Remote) Causes the modem to go from Command State to data state. 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.
AT Commands TABLE 19. Commands Usable with PassThru Command Parameters Details S8=n n=0-255 Comma Pause Time (Dial Modifier) Whenever a dial command contains the comma character, the contents of this register specify the pause time for each comma. S9=n n=0-255 Carrier Detect Response Time Specifies the time that the received carrier must be present for the modem to recognize it and turn on Data Carrier Detect (DCD) if applicable. The implementation is entirely at the IWF modem.
AT Commands TABLE 19. Commands Usable with PassThru Command Parameters Details !STATUS none Displays the current modem status.
AT Commands TABLE 19. Commands Usable with PassThru Command Parameters Details +WMDN=[num] num=phone number Set the Mobile Directory Number (MDN). C311 Valid numbers are between 10 and 15 digits in length. For support of Wireless Number Portability in all nonRUIM software versions, changes to the MDN will update the IMSI_M portion (least significant 10 digits) of the IMSI.
AT Commands TABLE 19. Commands Usable with PassThru Command Parameters Details +WVSS=[n] n=roam type Preferred Roaming List 0 - Home Only Note: The values depend on the currently loaded PRL.
CHAPTER 12 Raven Specifications Physical Characteristics: • • • • • • Weight: < 1 lb. Size: 3” wide x 1.1” high x 5.1" long Status LEDs RF Antenna Connector: 50 Ohm TNC Receive Diversity RF Antenna Connector: 50 Ohm SMA Serial Interface: RS232 DB-9F with Data Services & RF Features: • • • • • • Full duplex transceiver Dual-band support for both 800 MHz cellular and 1.9 GHz PCS bands Dual band Receive Diversity Adheres to CDMA authentication as specified in CDMA2000 1X 224 mW RF output (+23.
Raven Specifications Environmental: • Operating ranges: -30°C to +70°C • 10% duty cycle limit above 60°C • Humidity: 5%-95% Non-condensing Power Management: • Low power consumption • Input Voltage: 10 VDC to 28 VDC • Input Current: 20 mA to 350 mA 93 TELUS CDMA/1xRTT Raven User Guide Version 2.
Troubleshooting If you encounter problems with your Raven, AirLink’s support staff can help. Support web site The Airlink web site is updated frequently with Setup Wizards, Utilities, FAQs, and other documentation. http://www.airlink.com/support Contacting Technical Support For support assistance please email support@airlink.com or call 510-781-9760 Monday through Friday 6 AM to 5 PM Pacific Standard Time. Support is not available weekends or holidays. TELUS CDMA/1xRTT Raven User Guide Version 2.