AT Command Set Reference Guide Expedite and Merlin Wireless IP Modems PS-01016529 UNRELEASED Release 2.1 Friday, May 7, 1999...
Page 2
The information disclosed herein is the exclusive property of NOVATEL WIRELESS TECHNOLOGIES LTD. and is not to be disclosed without the written consent of NOVATEL WIRELESS TECHNOLOGIES LTD. No part of this publication may be reproduced or transmitted in any form or by any means including electronic storage, reproduction, execution or transmission without the prior written consent of NOVATEL WIRELESS TECHNOLOGIES LTD.
Page 3
REVISION HISTORY REV# ECO# EFF. DATE DESCRIPTION PREPARED APPROVED 99010 990505 Initial release. D. Barber S. Smilar 99024 990705 Updated to include new features for D. Barber S, Smilar TV01-02, including Friends Mode, Quiet mode and Stack Check features. Added registration mode and out-of- service sleep commands.
Page 4
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Table of Contents INTRODUCTION..............................6 Scope ..................................6 PHYSICAL INTERFACE ............................7 Protocol................................
Page 5
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Service ID Preference............................59 CDPD Operating Version ..........................60 Wireline Compatibility ............................
The scope of this document is limited to providing information on the various AT commands which can be used on Novatel CDPD products as well as a brief summary of some of the standard AT commands which are not supported. Internal design issues, detailed operating instructions and cost information is not included in this document.
The AT-command set described herein is derived from “CDPD Implementor Guidelines”, Release 1.1 . It contains a subset of the commands described in Part 2014 that are supported by the Novatel Expedite Wireless IP Modem. For the purposes of this specification, “NRM” refers to the Novatel Expedite Wireless IP Modem; “Host”...
L T D . Software Interface A brief description of those functions specific to the Expedite Wireless IP Modem is described here. AT Command Mode AT commands and responses are active in command mode only; as determined by the state of the DSR line.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Data Mode Description The modem contains an integrated TCP/IP protocol stack. It is accessed via AT commands that put the modem into either a TCP or UDP data communications mode.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Internal Stack Description IP (Internet Protocol) is the basic network protocol that routes packets on an IP network. CDPD networks and the Internet are IP networks.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . UDP Mode Description User Datagram Protocol is a basic transport protocol that provides a best-effort, connectionless delivery service with minimum overhead.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . TCP Mode Description Transport Control Protocol, reliable, connection-oriented transport protocol that uses...
Page 13
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Connection failed to complete within the time specified in register S7 (sec). Normal values are about 30 seconds, but is very dependent upon the application requirements.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . DTR Control Description The Data Terminal Ready (DTR) line is used by the modem as a qualifier for its operation in a data mode, TCP, UDP, SLIP or PPP.
Their assignment is made using the programmable GPIO features of the Expedite Wireless IP Modem. The modem can hold up to 4 messages, determined by reading register S251, before the buffer overflows and message data is lost.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Slip Mode Description: The command to enter Serial Line Internet Protocol mode (SLIP) is used when an external stack configuration is needed.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Point to Point Protocol (PPP) Description: The command to enter Point to Point Protocol mode (PPP) is used when an external stack configuration is needed.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Data Transmission Mode Packet Assembly The NRM provides a local Packet Assembly and Disassembly (PAD) function. For transmission, the character stream from the Host is assembled into packets for RF transmission under the following conditions: -Idle time-out: If the time between successive characters exceeds the time interval specified in...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Data Reception Mode Packet Disassembly The NRM begins transmitting the character stream associated with a received packet to the Host as soon as all the associated blocks have been received and processed.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Sleep Mode Description Sleep mode can be activated by sending the commands AT#ZZ=1, AT#ZZ=2 or deactivated by the command AT#ZZ=0.
These commands permit the user to define what the parameters of out-of-service sleep mode and to enable or disable the operation of this mode. If out-of-service sleep mode does not appear to work with your application, please contact Novatel Wireless for assistance. The default setting for this mode is off. Format:...
Page 23
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . c = complete scan period in seconds. This is the time that the modem will be awake once in each cycle count sleep cycles.
Page 24
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . C o m m a n d S p e c i f i c a t i o n - E x p e d i t e a n d M e r l i n W i r e l e s s...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Power-up Default Mode Description: The power up default mode command permits the user to define how the modem will act after power is applied and the modem begins operating.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Set Hardware Configuration Command to set the hardware release version number, i.e. Rev 3.2, Rev 3.3, Rev SM-1 etc.. The hardware configuration setting is set at the factory and should not normally be set by the user.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Profile Configuration Commands Description: Upon power-on/reset, the NRM issues a HELLO (verbose) or a 9 (terse) result code and proceeds to register with the CDPD system.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Program Mode Description: Program mode permits the user to change S register parameters that affect the modems operation. Program mode was created as a means of protecting the configuration of the modem from spurious or unwanted attempts to change them.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Local Echo Description: The Set Local Echo command permits the user to select whether the modem should echo the characters sent to it back to the host.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Response Format Description: The Set Response Format command is used to define what manner the modem returns when commands are sent to it.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Programmable I/O Description: Commands used to configure the General Purpose I/O lines for predefined functions. Any of these signals can be associated with any of the GPIO pins on the interface.
Page 32
Other Considerations: For additional information on the electrical characteristics of the pins and their placement on the connector, please consult the Expedite Wireless IP Hardware Interface Specification. Related Topics: Host Interface/Power Connector, Program Mode, Low Battery Warnings, Power Boost feature,...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Soft Reset Description: The soft reset command is used to return the modem to the initial conditions upon power up. The Soft Reset will return S Registers to their stored values, restart the channel scan process, clear all data buffers including any pending data that is still contained within the modem.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Side Preference Description: This command allows the user to specify the CDPD Service Side preference. Since there are two sides within a CDPD service area this command makes it possible to specify one side over the other or simply force the unit to either side only.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Password Description: The set password command is used to change the alphanumeric password string used to secure the entry to program mode and also as a qualifier for the activation of the escape sequence.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Escape Sequence Description: The Data Mode Escape sequence is used to discontinue use of the internal UDP or TCP stack. The escape sequence does not cause any deviation to SLIP or PPP operation and would not normally be used in this manner.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Hardware Flow Control Description: The set flow control command is used to configure the modem to either respond to the hardware flow control signal Request To Send (RTS) and generate Clear To Send (CTS) or ignore them and pass data without regard to the RTS input.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Disconnect (Hang-up) Description: The Disconnect or Hang-up Command is used to end a TCP or UDP session and possibly power the modem off.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Restore Factory Defaults Description: The restore factory default command sets the following S registers to their default factory setting. The settings are stored in RAM only and will not be saved unless a Save Settings command is issued before power down or a soft reset.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Line Speed and Format Description: This command allows the user to specify the data bit rate or “line speed” and format of the host serial port for all subsequent communications.
Page 41
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Related Topics: Software Reset C o m m a n d S p e c i f i c a t i o n - E x p e d i t e a n d M e r l i n...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . View Active Profile Description: This command displays the current active configuration state of most NRM data registers. Format: AT&V View active profile...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Save Current Profile Description: This command is used to save any changes made to register settings or configuration parameters. All values are stored in the modems Non-Volatile Memory (NVM).
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Destination IP Address/Port Description: This command is used to store the default IP address for the remote host. When the modem is directed to establish a session using TCP, or send UDP packets, without specifying an IP address, the IP address specified by register S53 is used at the destination IP.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Debug Mode Description: This command sets the NRM into debug mode, sending debug information out the serial port. The debug information is generated by the “Radio Resource Manager”...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Auto Answer (TCP Listen) Description: Register S0 is used to put the NRM into a state where the modem will accept a TCP session request from a remote server or another modem.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Connection Establishment Time-out Description: When initiating a session request as a remote client, attempting to talk to a server, a time-out limit for establishing the connection can be specified by setting register S7 to the appropriate value.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Data Forwarding Idle Time-out Description: When using the internal stack either UDP or TCP, the data being sent to the modem is automatically encapsulated in an IP packet using the preset protocol.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Data Forwarding Idle Character Description: When using the internal stack either UDP or TCP, the data being sent to the modem is automatically encapsulated in an IP packet using the preset protocol.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . UDP Half Open Mode Description: Once the modem is configured to operate in the half-open mode, it can accept AT commands from the keyboard, it can also receive UDP packets through the RF channels for the duration specified by the user without performing and ATD command.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Status Reporting Description: The CDPD Status Reporting feature provides a status code to be automatically issued each time the modems connection status changes.
Page 52
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . The status reporting can be enabled or disabled in either AT Command or Program modes. Changes made in AT Command mode and not saved with the AT&W command in Program mode will not be retained after power down.
These difficulties are overcome with Static IP addressing which is used by the Expedite Wireless IP Modem. Register S110 is reserved for specifying the IP address for the NRM. The optional ‘port extension’ is the TCP/UDP port number used to further identify the Host application for the connection-oriented service.
Page 54
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Related Topics: C o m m a n d S p e c i f i c a t i o n - E x p e d i t e a n d M e r l i n...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Service ID Preference Description: In addition to being able to set the side preference, and specifying the cellular channel side used by the modem, the user can also specify the preferred carrier that the connection should be made with.
L T D . Channel Scan Mode Description: The Expedite Wireless IP Modem modems can be programmed to scan for available CDPD channels in three different manners. Each manner has different operating characteristics and is targeted for specific applications. Channel scan mode 0 has the NRM performing an initial scan of all cellular channels associated with the selected side preference (see AT\N).
Page 57
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Related Topics: C o m m a n d S p e c i f i c a t i o n - E x p e d i t e a n d M e r l i n...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Channel List Description: Register S113 is used to contain the channel list. This is the list of cellular channels on which the NRM may use to search for CDPD service, depending on the setting of S112.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Service ID Preference Description: Register S116 is reserved for the service ID preference mode. Format: ATS116? Query Service ID preference...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . CDPD Operating Version Description: The CDPD specification has gone through two revisions; the first established version 1.0 networks using dedicated channels.
Wireline Compatibility Description: In order to accommodate certain host computer systems and their expected responses from the Expedite Wireless IP Modem, a register is provided which enables the trailing line feed character to be stripped off. The default setting for the modem is to send the line feed, which is contrary to what some wire-line modems do.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Set DTR Control Description: For applications or situations where hardware control of the modem is not possible, DTR control can be over-ridden and the host can avoid the necessity of adding extra control lines.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . DTR Mode Setting Description: The DTR control can be used to power off the modem in situations where it is desired. This setting is similar to that of setting register S211 to 4.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . DSR Control Setting Description: This setting provides more complete control of the DSR configuration. The DTR mode and control settings provide inferred control of the DSR pin, but this control register allows more specific control of the DSR configuration.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . TCP Timer Description: When using TCP, a session is initiated by one party calling and the other party accepting or declining the session request.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Identity Registers Description: The identity registers are used to identify the modem to the host. These read only registers present the following information: The modems Electronic Identifier Number (EID) The Software Version, creation date and time...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Query Network Connection Status Description: The command to determine the current network connection status is used to determine is it is acceptable for the host to go into a data mode and reliably exchange data over the CDPD network.
Page 68
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Because the modem is disconnected from the network in Program mode, this command will return an ERROR code if used in program mode.
Page 69
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Registration Process Background Registration involves 4 message exchanges, all of which have to be successful: M-ES MD-IS TEI REQ...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Last network registration error code Description: Should the modem fail to register within a sizable window of opportunity, typical times vary from 3 to 5 seconds for a “Hot List”...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Authentication Parameter Description: The Authentication Parameters can be set to zero using the AUTH command. This command is only used if the network equipment requires the modem to start service using a zero key value.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Query Current RSSI Value Description: To determine the current Receive Signal Strength Intensity, RSSI, value for the current channel being scanned, register S202 can be read.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Query Current Block Error Rate (BLER) Description: The modem maintains statistics on its performance and operation. One of the parameters measured and maintained is the block error rate.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Current RF Channel in use Description: To determine the current channel that the modem is currently locked to, the contents of register S204 can be read.
Page 75
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Cell Site ID in Use Description: The CDPD Network is composed of a multitude of cellular towers transmitting their signals over a portion of the total coverage area.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Area Color Code in Use Description: The CDPD Network is composed of a multitude of cellular towers transmitting their signals over a portion of the total coverage area.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Power Level Query Description: The Power Level query will return the current transmit power level being used by the modem on the current CDPD system.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Symbol Error Rate Query Description: A percentage rate of symbol errors encountered by the modem on the Forward channel is provided to assist in identifying sub-optimal signal conditions.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Power Product Description: The Power Product is a CDPD system parameter that ultimately determines the power level used by the modem for transmissions.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Authentication Failures Query Description: The number of authentication failures is available here in a register. The concept is to track the number of times that the authentication credentials were invalid since the last known point as a means of identifying any unusual behavior of the modem firmware, or failures in the EE device.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Dial (Connection Setup) Description: In wire-line modems a connection s made when the modem is instructed to dial a telephone number for the desired computer service.
Page 82
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Other Considerations: Related Topics: C o m m a n d S p e c i f i c a t i o n - E x p e d i t e a n d M e r l i n...
Description: It is anticipated that many of the users of the Expedite Wireless IP Modem will wish to do so in a mobile environment, and thus one where the supply voltage may not be constant. To that end, a power condition control system has been provided.
Page 84
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Format: AT#ADM? Queries the current ADC monitoring mode setting AT#ADM=0 No ADC monitoring AT#ADM=1...
Page 85
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Configuration: In order to use these features, we must perform some configuration of the system to reflect our desires. The order of events to configure the system is as follows: *enter program mode AT\APROG,NRM6812...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Ping Command Description: The Ping command causes the modem to transmit a single ICMP packet of the specified size to the ICMP/PING entity of the specified address.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Power Boost Description: This feature provides support for an external 3watt booster. Format: ATAC? To query the configuration...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Message Waiting Description: This command turns on the Message Waiting signal if it exists. Format: ATMW? To query the state of the signal...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Internal MRU Setting Description: This feature defines the maximum negotiated MRU size during a PPP session. In many host systems, the host stack will configure a default MRU size from its own defaults, but this may not be the optimum size for the CDPD network.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . TCP Suspension Enable Description: This allows any TCP session to be suspended. Format: AT#TCPX? Query TCP suspend enable...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Call Progress Result Mode Description: Format: ATX? Query the call progress selection ATX=xx Set the call progress selection Validity:...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Answer Description: This feature represents of the normal ATA answer command. In this system, the ATA will be sent by the host to release any pending push messages, which would have asserted the Ring Indication line of the modem interface.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Telnet Echo Description: A command to assist in Telnet terminal emulation. This command and the associated S register determine how characters are echoed, either locally, remotely or with no echo.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Modem Identification Description: This feature allows another AT command to query the Modem ID or EID value. Format: Queries modem EID ATI0...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Friends Mode Description: In “Friends” mode, the modem can be configured to reject all messages received that do not originate from a “friendly”...
Page 96
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Other Considerations: Related Topics: C o m m a n d S p e c i f i c a t i o n - E x p e d i t e a n d M e r l i n...
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Stack Check Description: This feature allows users to query the number of unused bytes on the stack. This query is useful in diagnosing stack related problems.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Quiet Mode Description: This feature allows for Quiet mode of AT operation. In this mode, there are no responses sent to the host for any AT command entered.
N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Registration Mode Description: This feature allows control of whether or not the modem will attempt to register upon initialization and to control when it will attempt registration at other times.
1 0 0 N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Fixed Parameters The following behaviors are fixed for the NRM. BEHAVIOR SETTING Equivalent...
1 0 1 N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Unsupported Commands The following commands (listed in CDPD Part 2014) are not supported by the NRM. If these commands, or any other AT command not described above, are received, the NRM will return an ERROR response.
1 0 2 N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . Appendix A: AT Command Set Quick Reference ATS250? Query Wake Up Protocol State ATS250=1...
Page 103
1 0 3 N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . AT&L? To determine the current line setting ATS23=<S>,<D><P><N>...
Page 104
1 0 4 N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . ATI3 To determine the hardware version ATS57? To determine current network status ATS200?
Page 105
1 0 5 N O V A T E L W I R E L E S S T E C H N O L O G I E S L T D . AT\R Network Registration Control AT\S Set Subscriber Identity AT\T Automatic Transmit Control AT&C...
Need help?
Do you have a question about the Expedite and is the answer not in the manual?
Questions and answers