mp 3g modems - sierra wireless

MP 3G Modems

AT Command Reference

2130810Rev 1.4

Preface

Rev 1.4 A

Important Notice Due to the nature of wireless communications, transmission and reception of data can never be guaranteed. Data may be delayed, corrupted (that is, have errors) or be totally lost. Although significant delays or losses of data are rare when wireless devices such as the Sierra Wireless modem are used in a normal manner with a well‐constructed network, the Sierra Wireless modem should not be used in situations where failure to transmit or receive data could result in damage of any kind to the user or any other party, including but not limited to personal injury, death, or loss of property. Sierra Wireless accepts no responsibility for damages of any kind resulting from delays or errors in data transmitted or received using the Sierra Wireless modem, or for failure of the Sierra Wireless modem to transmit or receive such data.

Safety and Hazards Do not operate the Sierra Wireless modem in areas where blasting is in progress, where explosive atmospheres may be present, near medical equipment, near life support equipment, or any equipment which may be susceptible to any form of radio interference. In such areas, the Sierra Wireless modem MUST BE POWERED OFF. The Sierra Wireless modem can transmit signals that could interfere with this equipment.

Do not operate the Sierra Wireless modem in any aircraft, whether the aircraft is on the ground or in flight. In aircraft, the Sierra Wireless modem MUST BE POWERED OFF. When operating, the Sierra Wireless modem can transmit signals that could interfere with various onboard systems.

Note: Some airlines may permit the use of cellular phones while the aircraft is on the ground and the door is open. Sierra Wireless modems may be used at this time.

The driver or operator of any vehicle should not operate the Sierra Wireless modem while in control of a vehicle. Doing so detracts from the driver or operatorʹs control and operation of that vehicle. In some states and provinces, operating such communications devices while in control of a vehicle is an offence.

Limitation of Liability

The information in this manual is subject to change without notice and does not represent a commitment on the part of Sierra Wireless. SIERRA WIRELESS AND ITS AFFILIATES SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL DIRECT, INDIRECT, SPECIAL, GENERAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES INCLUDING, BUT NOT LIMITED TO, LOSS OF PROFITS OR

ug.08 3

MP 3G Modems AT Command Reference

4

REVENUE OR ANTICIPATED PROFITS OR REVENUE ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR THEY ARE FORESEEABLE OR FOR CLAIMS BY ANY THIRD PARTY.

Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its affiliates aggregate liability arising under or in connection with the Sierra Wireless product, regardless of the number of events, occurrences, or claims giving rise to liability, be in excess of the price paid by the purchaser for the Sierra Wireless product.

Patents Portions of this product may be covered by some or all of the following US patents:5,515,013 5,629,960 5,845,216 5,847,553 5,878,2345,890,057 5,929,815 6,169,884 6,191,741 6,199,1686,339,405 6,359,591 6,400,336 6,516,204 6,561,8516,643,501 6,653,979 6,697,030 6,785,830 6,845,2496,847,830 6,876,697 6,879,585 6,886,049 6,968,1716,985,757 7,023,878 7,053,843 7,106,569 D442,170D459,303and other patents pending.

This product includestechnology licensed from:

Licensed by QUALCOMM Incorporated under one or more of the following United States patents and/or their counterparts in other nations:4,901,307 5,056,109 5,101,501 5,109,390 5,228,0545,267,261 5,267,262 5,337,338 5,414,796 5,416,7975,490,165 5,504,773 5,506,865 5,511,073 5,535,2395,544,196 5,568,483 5,600,754 5,657,420 5,659,5695,710,784 5,778,338

Manufactured or sold by Sierra Wireless or its licensees under one or more patents licensed from InterDigital Group.

Copyright © 2008 Sierra Wireless. All rights reserved.

QUALCOMM® 3G

2130810

Preface

Rev 1.4 A

Trademarks “Heart of the Wireless Machine®” is a registered trademark of Sierra Wireless. Watcher® is a trademark of Sierra Wireless, registered in the European Community. Sierra Wireless, the Sierra Wireless logo, and the red wave design 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.

Contact Information

Consult our web site for up‐to‐date product descriptions, documentation, application notes, firmware upgrades, trouble‐shooting tips, and press releases:

www.sierrawireless.com

Sales Desk: Phone: 1-604-232-1488

Hours: 8:00 AM to 5:00 PM Pacific Time

E-mail: [email protected]

Post: Sierra Wireless13811 Wireless WayRichmond, BCCanada V6V 3A4

Fax: 1-604-231-1109

Web: www.sierrawireless.com

ug.08 5

mailto:[email protected]

http://sierrawireless.com

http://sierrawireless.com

Revision History

Revision number

Release date

Changes

1.1 Aug. 2007 • Removed sections concerning Network Address Translation (NAT).

• Added comments to !MPCWSETUP.• Added Appendix A to further explain !MPCWSETUP.• Added explanation of Connection Watchdog statistics to

!MPCWINFO?.• Added explanation of the reset counters to !MPRESETCNT?.

1.2 Dec. 2007 Added new commands for router and WAP functionalities:• !MPCFG

• !MPCFGOPEN

• !MPDHCPLANAD

• !MPDHCPOSLIP

• !MPDHCPSTATUS

• !MPETIP

• !MPNATSTATUS

• !MPPORTMAP

• !MPSTATICROUTE

• !MPWAP

• !MPWAPCHAN

• !MPWAPCIPHER

• !MPWAPSECURE

• !MPWAPSSID

1.3 Feb. 2008 Added new commands:• AT!MPEID

• AT!MPDIVERSITY

Rev 1.4 Aug.08 7

ContentsIntroduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9

References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Terminology and acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Currency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Upgrading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Document structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Establish a communication session. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Using 3G Watcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Using a physical serial port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Using a virtual serial port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Configure the MP modem to send TAIP commands. . . . . . . . . . . . . . . . . . . . 13

Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

AT command set summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Basic operation actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Basic MP modem configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Reference tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18! Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19& Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58No Prefix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Stored profile settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

MP 3G Modems

8 2130810

Rev 1.4 A

11: Introduction• References• Currency• Document structure• Conventions• Establish a

communication session

This guide describes the Attention (AT) command set supported by the Sierra Wireless MP 3G ruggedized wireless modems.

The MP modem can be controlled by AT commands and Control and Status (CnS) messages. Some features or capabil‐ities of the MP modem require the use of CnS. This document presumes that the AT interface is the only interface available to you; features requiring CnS are not discussed.

ReferencesThis guide covers only the command set used by the Sierra Wireless MP modem, and does not deal with operational use guides. Consult the individual product manuals for guidance.

You may also want to consult the other documents available at www.sierrawireless.com.

Terminology and acronyms

This document makes wide use of acronyms that are in common use in data communications and cellular technology. Our Internet site provides a Glossary (document #2130891) that may be helpful in understanding some acronyms and terminology used in this guide.

CurrencyThis document is current with version R2_0_2AP of the MP modem firmware. You can determine your firmware version using the AT command, AT!MPGVER?. See “!MPGVER” on page 17.

Upgrading

If your MP modem firmware is an earlier version, you can obtain updated firmware from our web site or by contacting your account manager.

ug.08 9

http://www.sierrawireless.com


10

Document structureThe document presents the commands, registers, result codes, and defaults provided in the command state of the MP modem.

In addition to the commands, this document also describes the definitions and use of status registers.

Commands are listed in strict ASCII alphabetical order, including prefixes (beginning on page 18).

To help determine whether or not a command exists to perform a desired function, commands are also summarized according to the following functional groups:• Basic MP modem operation—Commands that make the

MP modem execute an immediate action such as dialing or restoring settings (page 15).

• Basic MP modem configuration—Settings governing the MP modem’s behavior when executing basic operations (page 16).

Factory and reset defaults settings are also provided (page 59).

ConventionsThe following format conventions are used in this reference:• The “AT” characters are not shown, but must be included

before all commands except as noted in the reference tables.

• Command and register syntax is noted using an alternate font: !DSMS=<i>,[m].

• Character codes or keystrokes that are described with words or standard abbreviations are shown within angle brackets using a different font: such as <CR> for Carriage Return and <space> for a blank space character.

• Numeric values are decimal unless prefixed as noted below.

• Hexadecimal values are shown with a prefix of 0x, that is, in the form 0x3D.

• Binary values are shown with a prefix of 0b, that is, in the form 0b00111101.

• Required characters are shown in uppercase; parameters are noted in lowercase. Required parameters are enclosed in angle brackets (<i>), while optional parameters are enclosed within square brackets ([m]). Do not include the square brackets in the command string.

2130810

Rev 1.4 A

Default settings are noted in the command tables. Note that these are the factory default settings and not the default parameter value assumed if no parameter is specified. The factory defaults are also noted in a section at the end of each operational mode reference.

Result Code—This is a numeric or text code that is returned after all commands (except resets). Only one result code is returned for a command line—regardless of the number of individual commands contained on the line.

Response—This term indicates a response from the MP modem that is issued prior to a result code. Reading registers or issuing commands that report information provides a response followed by a result code unless the command generates an error.

Responses and result codes from the MP modem, or host system software prompts, are shown in this font: CONNECT 14400.

Establish a communication session

Using 3G Watcher

The easiest way to establish a communications session that allows you to issue AT commands to the MP modem is to use the 3G Watcher software that comes with the MP modem.

To send AT commands using 3G Watcher:1. From the main 3G Watcher window, select Tools > AT

Commands.

Note: If you are using Watcher to enter AT commands, this causes the commands to enter the MP in all capitals.

Using a physical serial port

Alternatively, you can use any terminal emulation program, such as HyperTerminal®, a program typically installed with Windows, to establish a session with the MP modem.

To create a communications session using HyperTerminal:1. If the MP modem is not already connected to a serial port

on your computer, connect it.

ug.08 11


12

2. If open, close 3G Watcher (or any other program that communicates with the MP modem).

3. Select Start > Programs > Accessories > Communications > HyperTerminal to launch HyperTerminal. (The command path may vary depending on your version of Windows.)

4. Enter a name for the connection, select an icon, then click OK.

5. In the Connect using field, select the COM port the MP modem is connected to (usually COM1); click OK.

6. Select these port settings:· Bits per second 115,200· Data bits 8· Parity None· Stop bits 1· Flow control Hardware

7. Click OK.8. To verify that the communications session is functional,

enter AT. The MP modem should respond with OK. If the echo is off, your command is not displayed. Enter ATE1 to turn the echo on.

Using a virtual serial port

If you do not have a physical serial port on your computer, or it is already used by another device, you can configure HyperTerminal to use the virtual serial port (VSP).1. Connect the MP modem to your computer using either the

USB or Ethernet ports.2. If open, close 3G Watcher (or any other program that

communicates with the MP modem).1. Select Start > Programs > Accessories > Communications >

HyperTerminal to launch HyperTerminal. (The command path may vary depending on your version of Windows.)

2. Enter a name for the connection, select an icon, then click OK.

3. Select the appropriate COM port from the Connect Using drop‐down list.To determine the correct COM port, open the Device Manager in windows by selecting Start > Settings > Control Panel > System > Hardware > Device Manager > Ports. The correct COM port corresponds to Sierra Wireless Application Interface 2. (The COM port number will vary from computer to computer.)

4. Click OK.

2130810

Rev 1.4 A

5. To verify that the communications session is functional, enter AT. The MP modem should respond with OK. If the echo is off, your command is not displayed. Enter ATE1 to turn the echo on.

Configure the MP modem to send TAIP commandsYou can query the GPS module directly by using Trimble ASCII Interface Protocol (TAIP) commands. These commands produce results in printable American Standard Code for Information Interchange (ASCII) characters.

TAIP commands can be sent using AT!MPGPSCMD with the accompanying TAIP command. However, the results are directed to the serial port and will not be displayed unless a compatible application is listening at the port.

To verify that the GPS module is responding to TAIP commands:

Note: For a list of TAIP commands consult the “MP 3G Modems TAIP Reference” (document #2130312) found at www.sierrawireless.com.

1. Follow the steps in “Using a virtual serial port” on page 12.

2. Select Tools > AT Commands to open the AT command window.

3. Type AT!MPGPSRESET=0 in the command line.4. Type AT!MPVSOPT=1.5. Type AT!MPGPSCOMOUT=1.6. Type a TAIP command in the AT command window in

3G Watcher.7. The result should be displayed in the HyperTerminal

window.For example:a. You type AT!MPGPSCMD=”>QVR<“.b. The following result is displayed in HyperTerminal:

>RVR CT COPERNICUS APP; VERSION 01.05 (05/23/06);ID=<

As long as a message is displayed, your MP modem has been configured properly.

8. To return the MP modem to its original state, type AT!MPGPSCOMOUT=0.

ug.08 13



14
2130810

Rev 1.4 A

22: Commands• AT command set

summary• Reference tables• Status registers• Stored profile settings

AT command set summaryThe reference tables are presented in strict ASCII alphabetical order (including prefixes). This format allows quick look‐up of each command to verify syntax, parameters, and behaviors. It does not lend itself to finding whether or not the MP modem has a command to perform a particular service or setting.

The summary in this section organizes the commands into functional groups to allow you to more quickly locate a desired command when you know the operation but not the command.

Basic operation actions

Table 2-1: Basic MP modem operation actions

Command Page Description

&C 58 Data carrier detect control

&D 58 Data terminal ready options

&F 58 Factory settings restore

&V 58 View configuration

&W 58 Store user-defined profile

A/ 59 Repeat last command (re-execute the line in the command buffer)

D**##[n] 59 Dial

E 59 Echo (command state)

H 59 Hang up (disconnect)

I 59 Display product identification

O 60 Online

Q 60 Quiet result code display option

S 60 S-Register read and write

ug.08 15


16

Basic MP modem configuration

V 61 Verbose–Result code form

Z 61 Reset MP modem to user-defined profile

Table 2-1: Basic MP modem operation actions (Continued)


Table 2-2: Basic MP modem configuration


!MPAIN 19 Report the state of the specified analog input channel

!MPAINCFG 19 Analog input channel configuration

!MPAUTHPPP 20 Enable/disable PPP authentication between the MP modem and the host computer

!MPBARSVC 20 Bar services

!MPCFG 21 Set configuration lock

!MPCFGDUMP 21 Dump configuration

!MPCFGOPEN 21 Open configuration lock

!MPCLIENTIP 21 Report the IP address

!MPCONFSNAP 22 Configure UDP port number

!MPCONREJ 22 Enable/disable reset feature

!MPCWINFO 23 Reset/display Connection Watchdog statistics

!MPCWSETUP 24 Set Connection Watchdog

!MPDBGINFO 26 Display debug information

!MPDHCPLANAD 27 Change/set IP addresses for Ethernet and Wireless Access Point (WAP)

!MPDHCPOSLIP 27 Change/set the offline scope DHCP IP address

!MPDHCPSTATUS 28 Query the DHCP server’s runtime status

!MPDIO 29 Set the value at a specified digital I/O channel

!MPDIOCFG 30 Digital I/O channel configuration

!MPDIVERSITY 31 Enable, disable, and query diversity (MP595 and MP595W only)

!MPEID 31 Query the MP’s Electronic ID

!MPETIP 31 Change/set the IP address for the Ethernet interface

!MPFBKEND 31 Set response to network reacquisition

2130810

Rev 1.4 A

!MPFBSETUP 32 Configure the Fallback connection

!MPFBTIME 32 Set Fallback timer

!MPGCCLR 32 Clear crash dump data

!MPGCDUMP 33 Read crash dump data

!MPGPSCMD 33 Send TAIP command to GPS module

!MPGPSCOMOUT 33 Enable GPS output to the AT command port

!MPGPSDATA 35 Report current GPS data

!MPGPSESC 36 Set method of escaping from GPS output mode to AT command mode

!MPGPSINIT 37 Set initialization string

!MPGPSINTSET 37 Set GPS update interval

!MPGPSNMEA 37 Set NMEA messages

!MPGPSRESET 38 Reset GPS module

!MPGPSST 38 Request GPS status

!MPGPSSTOR 39 Enable/disable storing and forwarding of GPS records

!IMPGPSTAIP 40 Set/query TAIP messages sent in RNAP

!MPGPSTRACK 40 Set/query GPS tracking for MT reporting

!MPGRESET 40 Reset the MP and the PC Card

!MPGVER 41 Query current firmware revision

!MPIDTIME 41 Set the inactivity timeout

!MPIGNSENSE 41 Report ignition status

!MPMAC 41 Query the MAC address of MP

!MPMTCONF 41 Configure MT protocol

!MPNAME 43 Change/query MP name

!MPNATSTATUS 44 Query the NAT server’s runtime status

!MPNVDEF 44 Set MP modem configuration parameters to defaults

!MPOPMODE 45 Select operating mode

!MPPADCONF 45 PAD configuration

!MPPADCONN 47 Establish PAD connection

!MPPADSETUP 47 Set up a PAD connection

Table 2-2: Basic MP modem configuration (Continued)


ug.08 17


18

Reference tablesResult codes are not shown in the command tables unless special conditions apply. Generally the result code OK is returned when the command has been executed. ERROR may be returned if parameters are out of range, and is returned if the command is not recognized or is not permitted in the current state or condition of the MP modem.

!MPPDDELAY 48 Set power down timer

!MPPORTMAP 49 Configure a NAP port-mapped server entry

!MPPRIVIP 51 Set the private IP address

!MPRESETCNT 51 Display/reset the counters that record the number of times the MP modem has been reset

!MPSETDFLT 51 Set the default connection profile

!MPSETUP 52 Configure a connection profile

!MPSIMSLED 52 Report the status of the SIM sled

!MPSTATICROUTE 53 Configure a static route within the DHCP server

!MPUSB 54 Enable/disable USB operation

!MPVSOPT 55 Change/set the virtual MP modem port options

!MPWAP 55 Enable/disable the Wireless Access Point interface

!MPWAPCHAN 56 Set Wireless Access Point channel number

!MPWAPCIPHER 56 Set Wireless Access Point cipher option

!MPWAPSECURE 57 Set Wireless Access Point security key

!MPWAPSSID 57 Set Wireless Access Point SSID

!MPNAT 43 Enable/Disable NAT mode

Table 2-2: Basic MP modem configuration (Continued)


2130810

Rev 1.4 A

! Prefix

Table 2-3: !Prefix Commands

Command Description

!MPAIN?<chan>,<scale>

Report the state of the specified analog input channel

The MP modem has four analog input channels, allowing analog sensors and gauges to be connected to the MP modem. These must be connected to the appropriate pins of the DB15 I/O connector. (See the User Guide for more information about configuring I/O devices.)

The channels correspond to the pins as follows:• <chan>=1 Analog input 1—Pin 14• <chan>=2 Analog input 2—Pin 7• <chan>=3 Analog input 3—Pin 15• <chan>=4 Analog input 4—Pin 8

Channels 5, 7, and 8, correspond to test points in the MP modem. The voltage at these points is measured for diagnostic purposes. Channel 6 reports the battery voltage. Watcher uses this to control the low-battery indicator and display warning messages.

The <scale> value determines how the state is reported:• <scale>=0 Reports the raw value (0 to 1023)• <scale>=1 Reports the scaled value (See !MPAINCFG below.)

!MPAINCFG=<chan>,"<input label>", "<unit label>",<zero scale>, <full scale>

!MPAINCFG?=<chan>

Analog input channel configuration

Sets the labels and the scale for the specified input channel.

Parameter settings

The supported values are:• Channel <chan>=

1 Analog input 12 Analog input 23 Analog input 34 Analog input 4

Parameter settings

• Sensor or gauge description <input label>=20 character string

• Name of units <unit label>=20 character string

• Minimum value <zero scale>=0 to 65535 (Must be less than <full scale>)

• Maximum value <full scale>=0 to 65535 (Must be greater than <zero scale>)

!MPAINCFG? returns the configuration parameter values for the specified channel.

ug.08 19


20

!MPAUTHPPP=<n>

!MPAUTHPPP?

Enable/disable PPP authentication between the MP modem and the host computer

Controls whether PPP authentication is used in the MP modem-to-host computer link. (This command has no effect on the link between the MP modem and the embedded AirCard, over which PPP authentication is always used.)

The <n> parameter has these settings:• <n>=1 Enables PPP authentication• <n>=0 Disables PPP authentication between the MP modem and the host

computer (default)

Disabling PPP authentication allows you to use a single dial-up PPP connection on multiple MP modems with different profiles.

!MPAUTHPPP? returns the current setting.

!MPBARSVC=<value>

!MPBARSVC?

Bar services

Controls the type of connections (packet data or dial-up) that can be made by the MP modem. (See !MPFBSETUP on page 32 for a discussion of dial-up connections and the Fallback feature.)

The <value> parameter has these settings:• <value>=0 No services barred—network connections are available; where

there is no packet data service, the MP modem attempts a Fallback dial-up connection. (The Fallback connection must be set up using !MPFBSETUP. See page 32.) (This is the default.)

• <value>=1 All services barred—No connections are available.• <value>=2 Fallback connections barred—network connections are

available; the Fallback connection is never attempted.• <value>=3 Packet data connections barred—Any attempt to establish a

connection invokes the Fallback connection.

!MPBARSVC? returns the current setting.

Table 2-3: !Prefix Commands (Continued)

Command Description

2130810

Rev 1.4 A

!MPCFG=“<key>”

!MPCFG?

Set Configuration Lock

Sets or queries the configuration lock/unlock code.

Note: The MP modem must be unlocked for configuration. See !MPCFGOPEN on page 21.

Parameter Value Description

<key> 4–15 characters Code to be set

Example: at!mpcfg=”sierra”

!MPCFG? returns the lock/unlock code.

If ERROR is returned, unlock the configuration-related commands for the MP. See !MPCFGOPEN on page 21.

!MPCFGDUMP?<batch>

Dump configuration

Returns settings for all parameters of the AT commands that are used to configure the MP modem. The report lists each AT command followed by the setting of each parameter of the command.

Parameter settingsTo return all configuration settings, you must run the command twice, with <batch> =1 (to return the first batch of settings), and then <batch> =2 (to return the second batch of settings).

!MPCFGOPEN=“<key>”

Unlock configuration-related commands

Unlocks configuration-related commands for features such as Wireless Access Point setup so you can modify those values. Once unlocked, the configuration lock reverts to the locked state after a set period of time (5 minutes).

To open the configuration lock for the first time, the factory default is MP3G. Use the !MPCFG command to change the password. (See page 21.)

Example: at!mpcfgopen=”MP3G”

If you have changed the password and cannot remember the new password, you can use the AT!MPNVDEF command to restore the factory default values (including the default password). See “!MPNVDEF” on page 44.

!MPCLIENTIP? Report the IP address

Returns the client IP address assigned to the MP modem by the network. If there is no network connection, 0.0.0.0 is returned.


Command Description

ug.08 21


22

!MPCONFSNAP=<rnapport>, <rawgpsport>,<RNAPhostrelayflag>

!MPCONFSNAP?

Configure UDP port number

Sets the port number on which the MP modem receives RNAP/UDP or raw-GPS/UDP packets and sets the RNAP host relay flag.

The parameters are:• <rnapport> The UDP port number used to listen for RNAP packets (1 -

65535).• <rawgpsport> The UDP port number used to listen for raw GPS (TAIP)

messages (1 - 65535).• <RNAPhostrelayflag> Determines how RNAP data is routed. When

disabled (<RNAPhostrelayflag>=0), RNAP data is encapsulated in UDP packets and sent to the network. When enabled (<RNAPhostrelayflag>=1), RNAP data is sent to Watcher on a host computer, so that Watcher can route it through the computer’s VPN connection.

The !MPMTCONF command sets whether raw GPS data or MTP data is sent. (The <ctype> parameter is used to make the setting. See page 41.)

!MPCONFSNAP? returns the current ports.

!MPCONREJ=<max connect failures>

!MPCONREJ?

Enable/disable reset feature

Enables and disables the feature that resets the MP modem after repeated connection attempts fail.

The parameter <max connect failures> sets the number of consecutive connection attempt failures after which the MP modem shuts down, resetting the radio component. If the parameter is set to 0, the feature is disabled. It is disabled by default.

For example, the command at!mpconrej=3 configures the MP modem to automatically reset the radio component if three consecutive connection attempts fail.

!MPCONREJ? returns the current setting.

Note: The MP modem must be connected to a network before the <Blue XRef>“!MPCWSETUP’ command on page 24 takes effect.


Command Description

2130810

Rev 1.4 A

!MPCWINFO=<reset>

!MPCWINFO?

Reset/Display Connection Watchdog statistics

Displays and resets values related to the Connection Watchdog. (The Connection Watchdog is enabled, disabled, and configured with the command !MPCWSETUP. See page 24.)

Parameter settings

The only supported value for the <reset> parameter is “1”, which causes a reset of the following statistics stored in non-volatile (NV) memory:

• DNS checks: Number of times the MP modem verifies the DNS server• CW-trig disconnect: Number of disconnections triggered by the Connection

Watchdog• CW-trig reset: Number of resets triggered by the Connection Watchdog.

(The resets occur after a specified number of terminated connections.)

!MPCWINFO? returns the current statistics. These are:

• CW state: Verifying DNS/PING or Connection Watchdog On or Not Connected/CW OFF

• DNS/PING checks (NV): DNS/PING check counter• CW-trig disconnect (NV): disconnect because PING/DNS failed• CW-trig AC resets (NV): radio reset because PING/DNS failed• Total TX bytes by CW while in CWON: bytes sent when CW was on• Total RX bytes by CW while in CWON: bytes received when CW was on• Total TX bytes by CW while in CWVERIFY: bytes sent when CW was

verifying DNS/PING• Total RX bytes by CW while in CWVERIFY: bytes received when CW was

verifying DNS/PING


Command Description

ug.08 23


24

!MPCWSETUP=<rxtime>, <verificationtime>, <dnsport#>, <dnsname>, <radio Reset Flag>,<PING IP>,<mode>

Set Connection Watchdog

The Connection Watchdog monitors connections to determine whether the MP modem is receiving data. If the MP modem is not receiving data, the Connection Watchdog either sends a DNS query to the DNS server or pings a specified IP address. As long as the MP modem is able to resolve the DNS name or verify the IP address, it maintains the connection regardless of whether or not data is being transmitted. If it cannot confirm either of these values it terminates the connection. If the MP modem is in “always-on” mode, the MP modem attempts reconnection once the connection is terminated. (See !MPOPMODE on page 45.)

This command also allows you to set the MP modem to either disconnect the data connection or reset the radio component whenever the Connection Watchdog has detected an invalid data connection.

When a new connection is established, the MP modem verifies that the DNS server is valid or that pings are possible (depending on the <mode> setting) before the MP modem begins monitoring for data receipt. If the MP modem is unable to verify the DNS server or the ping fails, the Connection Watchdog remains inactive, but the MP modem continues to either ping or verify the DNS server at the interval set by the <verificationtime> parameter.

Note: The <dnsname> and <PING IP> parameters are used to verify that the MP modem can send and receive data. Be sure to use values that you know are valid.

Parameters:

<rxtime>Interval (in minutes) at which the MP modem checks whether data is being received. When this interval is reached, depending on the <mode> setting, the MP modem either sends a DNS query or pings the address specified by the <PING IP> parameter. The allowed values are 0 to 240. When set to 0, the Connection Watchdog is disabled. (0 is the default.)

<verificationtime>Interval (in minutes) at which the MP modem checks for a DNS server or attempts a ping when a new connection is established. The allowed values are 1 to 240. (30 is the default.)

<dnsport#> DNS port number used by the MP. The allowed values are 1 to 65535. The default is 7367. To avoid selecting a port number that is in use by another component, it is advisable to use the default port number.

<dnsname> Web site name for DNS to resolve (such as www.sierrawireless.com). The maximum string length is 128 characters.

(continued on next page)


Command Description

2130810

Rev 1.4 A

!MPCWSETUP(continued)

Set Connection Watchdog (continued)

<radio Reset Flag> Flag that determines whether the radio component is reset when the Connection Watchdog determines that a connection has failed.

When set to 0 (the default), the Connection Watchdog terminates invalid connections, but does NOT perform a reset.

When set to 1, the Connection Watchdog resets the radio component after terminating the connection.

<PING IP> IP address that the MP modem pings when the <mode> parameter is set to ping. The format is X.X.X.X where X is a value between 0 and 255. (The default is 0.0.0.0.)

<mode> Action that the MP modem takes when the <rxtime> interval is reached; 0 = DNS query, 1 = ping.

To display or reset Connection Watchdog statistics, see the !MPCWINFO on page 23.

For a more detailed explanation of the Connection Watchdog process, see “!MPCWSETUP Flowchart” on page 63.

In the following example, the AT command configures the MP modem to verify a DNS address when a connection is established:

at!mpcwsetup=10,30,7367,”www.sierrawireless.com”,0,0.0.0.0,0

In the above example:• Once a connection is established, the Connection Watchdog goes into

“validating mode” and attempts to validate the DNS server. (<mode> = 0)• DNS validation is performed by looking up the domain name

www.sierrawireless.com (<dnsname> = “www.sierrawireless.com”)• If the DNS lookup fails, the MP modem remains in “validating mode”,

looking up the domain name every 30 minutes (<verificationtime> = 30)• If the DNS lookup is successful, the Connection Watchdog goes into

“monitoring mode”. The MP modem checks the Rx byte count every 10 minutes (<rxtime> = 10). If the Rx byte count changes during the 10 minute interval, the connection is deemed to be valid. If the Rx byte count does not change, the MP modem generates traffic by performing a DNS look-up. If the Rx byte count changes as a result of the DNS look-up, the connection is deemed to be valid. Otherwise the connection is terminated.

• The Connection Watchdog does NOT reset the MP modem after termi-nating an invalid connection (<radio Reset Flag> = 0). If the <radio Reset Flag> is set to 1, the radio component resets after the MP modem terminates any invalid connection.



Command Description

ug.08 25


26

!MPCWSETUP(continued)

Set Connection Watchdog (continued)

In the next example, the following AT command configures the MP modem to ping a specified IP address when a connection is established:

at!mpcwsetup=10,30,7367,www.sierrawireless.com,0,100.101.102.103,1

In the above example:• Once a connection is established, the Connection Watchdog goes into

“validating mode” and attempts to ping the server. (<mode> = 1)• DNS validation is performed by pinging the address 100.101.102.103

(<PING IP> = 100.101.102.103)• If the ping fails, the MP modem remains in “validating mode”, looking up the

domain name every 30 minutes (<verificationtime> = 30).• If the ping is successful, the Connection Watchdog goes into “monitoring

mode”. The MP modem checks the Rx byte count every 10 minutes (<rxtime> = 10). If the Rx byte count changes during the 10 minute interval, the connection is deemed to be valid. If the Rx byte count does not change, the MP modem generates traffic by pinging the server. If the Rx byte count changes as a result of the DNS look-up, the connection is deemed to be valid. Otherwise the connection is terminated.

• The Connection Watchdog does NOT reset the MP modem after termi-nating an invalid connection (<radio Reset Flag> = 0). If the <radio Reset Flag> is set to 1, the radio component resets after the MP modem termi-nates any invalid connection.

!MPDBFGINFO? Display debugging information

This command displays debug information for use by firmware engineers.


Command Description

2130810

Rev 1.4 A

!MPDHCPLANAD=<ethernet ip addr>,<WAP ip addr>

!MPDHCPLANAD?

Change/set IP addresses for Ethernet and Wireless Access Point

Changes the subnet portion of the IP address; this command only applies when the MP modem is operating as a router, that is, NAT is enabled and at least one of the two interfaces (Ethernet and Wireless Access Point) is being used to exchange IP traffic between a client on the internal LAN(s) and the external network.

After issuing the command, the two addresses must be different.

Parameters:• <ethernet ip addr> 192.168.x.1 — IP address to assign to Ethernet port.

“x” may be any number from 0 to 255, as long as it is different from the “y” value in the Wireless Access Point IP address. Default value: 192.168.1.1

• <WAP ip addr> 192.168.y.1 — IP address to assign to Wireless Access Point interface. “y” can be any number from 0 to 255, as long as it is different from the “x” value in the Ethernet IP address. Default value: 192.168.2.1

Example: at!mpdhcplanad=192.168.8.1,192.168.4.1

Note: For this command to take effect, you need to reset the modem. See MPGRESET on page 40.

This command checks to see that the IP addresses you input are valid with respect to static routing and port mapping configurations. If this command invalidates mapping or static routes, you are reminded to reconfigure static route and port forwarding entries. See !MPSTATICROUTE on page 53 and/or !MPPORTMAP on page 49.

!MPDHCPLANAD? returns <ethernet ip addr>, <WAP ip addr>

!MPDHCPOSLIP= <ip addr>

!MPDHCPOSLIP?

Change/set the offline scope DHCP IP address

Queries or sets the IP address the DHCP server assigns to the host when there is no wireless data connection.

When a wireless data connection is established on the wireless network, the DHCP package acquires an IP address provided to the MP by the network and reassigns it to the bound host.

Note: This command only applies to non-NAT mode.

Parameter:<ip addr> —w.x.y.z, where w, x, y, z are any number 0 to 255. Default value in NV is 192.168.1.10

Example: at!mpdhcposlip=120.130.140.150

!MPDHCPOSLIP? returns <ip addr>


Command Description

ug.08 27


28

!MPDHCPSTATUS? Query the DHCP server’s runtime status

Provides a summary of the state of the DHCP server, listing each active session by displaying the MAC address and associated IP address, the type and interface used for the connection. This command is query-only.

Parameter Values Description

Type Dynamic IP address allocated from the DHCP server’s pool

Static IP address statically allocated(Configured using !MPSTATICROUTE [page 53])

Interface wl or et Interface the associated host device uses to connect to the MP.wl: Wireless Access Point interfaceet: Ethernet interface

IP ADDR 192.168.x.y IP address allocated to the host by the DHCP server.Default values for x are:1: Ethernet interface2: Wireless Access Point interfaceTo change the subnet for either interface, use !MPDHCPLANAD (see page 27).

MAC ADDR aa-bb-cc-dd-ee-ffMAC address of the client assigned the IP address listed in the IP Addr field

Externalnetworkaccess ENABLED or DISABLED

If Watcher has not been started, this field always indicates enabled. If Watcher is running and the user has clicked the Connect or Disconnect button, this field indicates whether clients on the internal LAN(s) are permitted to access the external network.

Note that under certain circumstances, there may be a delay before the change takes effect. For example, if the user clicks the Disconnect button, it may take a bit of time before the client is no longer able to access the external network.


Command Description

Syntax AT!MPDHCPSTATUS? Returned string !MPDHCPSTATUS:

Type Interface IP ADDR MAC ADDR -------- ------------ ------------ ----------------Dynamic wl 192.168.2.19 0-e-35-5a-cd-a6 -------------------------------------------------------- External network access: ENABLED OK

2130810

Rev 1.4 A

!MPDIO=<chan>

!MPDIO?

Set the value at a specified digital I/O channel

The MP modem has four digital input/output channels, allowing digital sensors and gauges to be connected to the MP modem. All four channels can be used to provide input to the MP modem. Two of the four can be used alternatively to provide output from the MP modem.

Sensors and gauges must be connected to the appropriate pins of the DB15 I/O connector. (See the User Guide for more information about configuring I/O devices.) The channels correspond to the pins as follows:

• <chan>=1 Digital I/O 1—Pin 3 • <chan>=2 Digital I/O 2—Pin 11• <chan>=3 Digital input 3—Pin 4• <chan>=4 Digital input 4—Pin 12

The initial configuration of the I/O channels must be done using the command !MPDIOCFG. Once configured, you can use !MPDIO to set the logic level for channels 1 and 2, if configured as outputs. (!MPDIOCFG could also be used for this purpose but would require that more parameters be entered.)

!MPDIO? reports the logic level of all four channels, whether configured as inputs or outputs.

The allowed <value> settings are 0 (logic level low) and 1 (logic level high).


Command Description

ug.08 29


30

!MPDIOCFG=<chan>,<type>,"<IO label>",<alarm>, "<logic low label>","<logic high label>",[<level>]

!MPDIOCFG?<chan>

Digital I/O channel configuration

Sets the type (input or output), labels, and alarm trigger for the specified I/O channel.

Parameter settings

The supported values are:

• Channel <chan>=

1 Digital I/O 1—Pin 3 (input or output)2 Digital I/O 2—Pin 11 (input or output)3 Digital I/O 3—Pin 4 (input only)4 Digital I/O 4—Pin 12 (input only)

• Input / output type <type>=

0 Input1 Output (only valid for channel 1 and 2)

• Sensor or gauge description <IO label>=

20 character string

• Alarm trigger <alarm>=

0 No alarm; no logging1 Alarm triggered (and event logged) when logic level low occurs2 Alarm triggered (and event logged) when logic level high occurs3 No alarm; any change in logic level is logged

The name and location of the log file is set in Watcher. (See the Watcher online help for details.) State when logic level is low <logic low label>= 20 character string

• State when logic level is high <logic high label>=

20 character string

• Output level <level>=

This parameter is only valid for channels 1 and 3 and only where <type>=1.0 Low1 High

!MPDIOCFG? returns the configuration values for the specified channel.


Command Description

2130810

Rev 1.4 A

!MPDIVERSITY = <value>

!MPDIVERSITY?

Disable, enable or query radio module diversity

Note: This command applies only to the MP595 and MP595W.

By default, diversity is enabled. If you are using a diversity antenna, leave diversity enabled. If you are not using the diversity antenna, disable diversity for optimum performance.

Parameter settings

<value>= 0 Diversity is disabled<value>= 1 Diversity is enabled

!MPDIVERSITY? returns the diversity-enabled status.

!MPEID? Query the MP Electronic ID

!MPEID? returns the MP’s electronic ID number:

For UMTS modems, it returns the MP’s International Mobile Equipment Identifier (IMEI)Example: 354220010034568

For CDMA modems, it returns the MP’s Electronic Serial Number (ESN)Example: 602D378B

!MPETIP=<ip addr>

!MPETIP?

Change/query the IP address for the Ethernet interface

Sets or queries the IP address used for the Ethernet/Wireless LAN interface.

Note: This command only applies to non-NAT mode.

<ip addr> w.x.y.z, where w, x, y, z are numbers from 0 to 255. Default value: 192.168.1.1

Example: at!mpetip=130.140.150.160

!MPETIP? returns <ip addr>

!MPFBKEND=<value>

!MPFBKEND?

Set response to network reacquisition

Determines how the MP modem behaves if network service is reacquired during a Fallback connection (See !MPFBSETUP on page 32.)

The <value> setting determines whether the dial-up connection is maintained:• <value>=0 Disconnect immediately• <value>=1 Maintain dial-up connection (Default)

(Disconnecting may save excess charges for dial-up services.)

!MPFBKEND? returns the current setting.


Command Description

ug.08 31


32

!MPFBSETUP=<label>,<username>,<password>,<phone#>

!MPFBSETUP?

Configure the Fallback connection

The Fallback feature allows the MP modem to automatically establish a dial-up (circuit-switched) connection when packet data service is lost during a connection. (Fallback is only useful in areas that have network but not packet data coverage. See the MP User Guide for more information about this feature.) !MPFBSETUP sets up the dial-up connection invoked by the Fallback feature.

These other commands affect the behavior of the feature:• !MPFBTIME—determines how long the MP modem waits between losing

packet data service and initiating the Fallback connection.• !MPFBKEND—determines how the MP modem behaves if packet data

service is re-acquired during a Fallback connection.• !MPBARSVC—enables and disables Fallback and packet data connec-

tions (effectively enabling and disabling this feature). Fallback only works where the network supports dial-up connections.

Parameter settings

The supported values are:• Connection description <label>=

32 character string

• Username <Username>=

32 character string

• Password <Password>=

32 character string

• Phone number <Phone#>=

32 characters (0-9, #, *)

!MPFBSETUP? returns the current configuration.

!MPFBTIME=<value>

!MPFBTIME?

Set Fallback timer

Sets the duration that the MP modem waits between losing packet data service and initiating a Fallback connection. (See !MPFBSETUP on page 32.)

The <value> is in seconds (minimum 0, maximum 300). (The default is 60.)

!MPFBTIME? returns the current timer duration.

!MPGCCLR Clear crash dump data

When a crash occurs, data associated with the crash is written to a memory location on the MP modem. This command deletes the contents of that memory location. (See !MPGCDUMP below.)


Command Description

2130810

Rev 1.4 A

!MPGCDUMP Read crash dump data

This command shows the contents of the memory location to which crash dump data is written. (See !MPGCCLR above.) The memory location is overwritten whenever a crash occurs.

!MPGPSCMD=<"TAIP command">

Send TAIP command to GPS module

This command requires that the module be configured to use the TAIP protocol. (See !MPGPSRESET on page 38.)

Note that TAIP commands use “>” as the start delimiter and “<“ as the end delimiter. For example, to issue the TAIP command QST (which queries the operational status of the GPS module), you would enter:at!mpgpscmd=">QST<"

For a listing of TAIP commands see the MP 3G Modems TAIP Reference (document #2130312) on the Sierra Wireless web site (www.sierrawireless.com) or see the Trimble web site (www.trimble.com).

!MPGPSCOMOUT=<enable>,<save to NV>

Enable GPS output to the AT command port

When GPS output to the AT command port is enabled (the <enable> parameter is set to 1), the MP modem sends TAIP or NMEA data to the COM port. This might be used to provide data to a third-party “moving map” application. Setting the <enable> parameter to 0 stops the output. (The default is 0.)

The <save to NV> parameter is used to specify whether the <enable> setting is saved to non-volatile memory. If the setting is saved to memory, it persists across power cycles. (The default is 0, where the <enable> setting is NOT saved to memory.)



Command Description

ug.08 33


http://www.trimble.com


34

!MPGPSCOMOUT (continued)

Enable GPS output to the AT command port (continued)

Note: When GPS output to the AT command port is enabled, GPS output occurs until the DTR line is deasserted or TIES is issued, depending on the setting made using the command !MPGPSESC. (See page 36.)

The <enable> and <save to NV> parameters have this effect:

enable>=0, <save to NV>=0 GPS data is NOT sent to the COM port. When the MP modem is reset, GPS data will be sent or not, based on thepreviously saved <enable> setting. (If no setting has been previouslysaved, GPS data will NOT be sent to the COM port.)

<enable>=0, <save to NV>=1 GPS data is NOT sent to the COM port. When the MP modem is reset, GPS data will NOT be sent.

<enable>=1, <save to NV>=0 GPS data is sent to the COM port. When the MP modem is reset, GPS data will be sent or not, based on the previously saved <enable> setting. If no setting has been previously saved, GPS data will NOT be sent to the COM port.)

<enable>=1, <save to NV>=1 GPS data is sent to the COM port. When the MP modem is reset, GPS data will continue to be sent.


Command Description

2130810

Rev 1.4 A

!MPGPSDATA? Report current GPS data

This returns a parsed string:

Valid FlagUsed internally to verify data.

LED Status of the GPS LED on the front panel of the MP modem:1 Off2 On flashing3 On solid

Receiver St1 & Status Byte 1 and Status Byte 2 Receiver St2 As returned by the TAIP command, >QST<. The codes

indicate the operational status of the GPS module. (TAIP command documentation is available on the Trimble and Sierra Wireless web sites. See !MPGPSCMD on page 33.)

Latitude Latitude in this form:AB.C.D.E:A Direction (N=North, S=South, U=Unknown)B DegreeC MinuteD SecondE Second (decimal place) (continued on next page)


Command Description

ug.08 35


36

!MPGPSDATA? (continued)

Report current GPS data (continued)

Longitude Longitude in this form: AB.C.D.E:

A Direction (E=East, W=West, U=Unknown)B DegreeC MinuteD SecondE Second (decimal place)

Altitude Altitude in meters (+ if above sea level and - if below.)

Horz Sp Speed in kilometers per hour

Heading Heading in degrees from True North (0) increasing clockwise

Num SV Number of satellites fixed. (The MP modem must have a fix on at least four satellites to report longitude, latitude, heading, altitude, and speed.)

Data Age Used internally to determine validity of the data.

UTC Time Universal Coordinated Time (the time and date in Greenwich, England) in the format: H:M:S D/MO/Y OF FLAG

H HoursM MinutesS SecondsD DayMO MonthY YearOF GPS Time Offset (Difference between GPS and UTC time standards)FLAG GPS Time Offset Flag (1=valid and 0=invalid)

!MPGPSESC=<escape>

!MPGPSESC?

Set method of escaping from GPS output mode to AT command mode

Sets the method of switching from GPS output mode (in which TAIP or NMEA data is sent directly the COM port) to using the COM port to issue AT commands. (See !MPGPSCOMOUT on page 33 for an explanation of how to enable the GPS output and how to save that setting to memory.)

The <escape> parameter is used to set whether GPS output is terminated by deasserting DTR or by issuing TIES:• <escape>=0 deasserting DTR (default)• <escape>=1 issuing TIES • <escape>=2 either deasserting DTR or issuing TIES

TIES (Time Independent Escape Sequence) consists of sending the string “AT+++”. (The “AT” must be in upper case).

The setting made with this command persists across power cycles.

!MPGPSESC? returns the current setting.


Command Description

2130810

Rev 1.4 A

!MPGPSINIT=<init no>,<"TAIP command">

Set initialization string

Specifies TAIP commands to be executed by the MP modem on start-up. (This can be used, for example, to set up the automatic reports.) Up to five commands can be configured to execute during initialization. The maximum length of the initialization string is 127 characters.

The <init no> designates the order in which commands are executed (1=first; 5=last).

The command !MPGPSST? allows you to query the current initalization strings. (See page 38.)

!MPGPSINTSET=<update interval>

!MPGPSINTSET?

Set GPS update interval

Sets the interval at which the GPS module does position and altitude readings. This does not control the frequency at which this data is reported (which is controlled by the !MPMTCONF command.)

The <update interval> is in seconds (minimum 0, maximum 255). The default is 1.

!MPGPSINTSET? returns the current update interval.

!MPGPSNMEA=[<RMC>],[<GGA>],[<GLL>],[<VTG>],[<GSV>],[<GSA>],[<ZDA>]

!MPGPSNMEA?

Set NMEA messages

Sets which NMEA messages are generated by the GPS module when in NMEA mode. (See !MPGPSRESET on page 38.)

The NMEA protocol includes several different message types, of which these are supported:• GGA—Global positioning system fix data• GLL—Global position / latitude and longitude• GSA—GPS DOP (Dilution of Precision) and active satellites• GSV—Satellites in view• RMC—Recommended minimum specific GPS / transit data• VTG—Track made good and ground speed• ZDA—Time and dateTo enable a message, set the parameter to “1”; to disable, set the parameter to “0”. For example:• <GGA>=0 disables the Global positioning system fix data message• <GGA>=1 enables the Global positioning system fix data message

Messages are separated by <LF><CR>. By default, the GGA, VTG, and ZDA messages are generated, and these three messages must be enabled in order for Watcher to display GPS information. See the NMEA web site, www.nmea.org to obtain the standards documents that provide the message formats.

!MPGPSNMEA? returns the setting, showing which messages are currently enabled.


Command Description

ug.08 37

http://www.nmea.org


38

!MPGPSRESET=[<protocol>]

Reset GPS module

The MP modem has an embedded Trimble GPS module.The module supports Trimble ASCII Interface Protocol/Trimble Standard Interface Protocol (TAIP/TSIP) and National Marine Electronics Association (NMEA).

!MPGPSRESET restarts the GPS module setting the protocol.

The <protocol> value determines the protocol in use following the reset:• <protocol>=0 TAIP (default)• <protocol>=1 NMEA

!MPGPSST? Request GPS status

This returns a parsed string:

State State of the GPS module:0 Idle1 Booting up; sending configuration sequence2 Active3 Sent remote command; waiting for acknowledgement4 Sending command sequence (TAIP command)5 Waiting for results from query command6 Resetting; waiting for reset timer to expire

Recv Drop Number of packets lost because the buffer space was exceeded (0-255)

Recv Len Drop Number of messages lost because the message length was exceeded (0-255)

Max Rx Buf Used Maximum number of buffers used (0-255)

Reset Cnt Number of resets that occurred due to a lack of response from the GPS module (0-255)

(continued on the next page)


Command Description

2130810

Rev 1.4 A

!MPGPSST? (continued)

Request GPS status (continued)

Protocol Navigation protocol in use:0 TAIP1 NMEA2 TSIP (for diagnostic use only)

InitBaudRate Baud rate (4800 or 9600)

localUpdateInt Local GPS query interval in seconds (0-255)

rmFlag Bit-mapped storage of the flags set using the >SRM< TAIP command:Bit 0 ID_FLAG: 0 = FALSE; 1 = TrueBit 1 CS_FLAG: 0 = FALSE; 1 = True Bit 2 EC_FLAG: 0 = FALSE; 1 = True Bit 3 FR_FLAG: 0 = FALSE; 1 = True Bit 4 CR_FLAG: 0 = FALSE; 1 = True

Init Str 1 First TAIP initialization string executed when the GPS module is powered or reset (Maximum length 128 characters)

Init Str 2 Second TAIP initialization string executed when the GPS module is powered or reset (Maximum length 128 characters)

Init Str 3 Third TAIP initialization string executed when the GPS module is powered or reset (Maximum length 128 characters)

Init Str 4 Fourth TAIP initialization string executed when the GPS module is powered or reset (Maximum length 128 characters)

Init Str 5 Fifth TAIP initialization string executed when the GPS module is powered or reset (Maximum length 128 characters)

!MPGPSSTOR=<#GPSrecords>

!MPGPSSTOR?

Enable/disable storing and forwarding of GPS records

GPS records (TAIP or NMEA) can be stored on the MP modem when the MP modem is out of network coverage and automatically forwarded when network coverage is reacquired. The parameter <#GPSrecords> sets the total number of records the MP modem accumulates while out of coverage (maximum 1000). When this number is reached, the MP modem discards the oldest record as each new record is captured so that the stored records are the most recent. The feature is disabled when <#GPSrecords> is set to 0.

!MPGPSSTOR? returns the current setting, showing how many records are being stored.


Command Description

ug.08 39


40

!MPGPSTAIP=<LN>, <PV>,<CP>, <AL>,<ST>

!MPGPSTAIP?

Set/query TAIP messages sent in RNAP

This command requires that the module be configured to use the TAIP protocol (see !MPGPSRESET on page 38).

GPS data sent from the MP modem is framed according to a proprietary protocol called RNAP.

Unless the MP modem is configured to use NMEA, GPS data is sent in the form of TAIP messages which are embedded in the RNAP messages.

This command allows you to specify which of the following TAIP messages are sent:• LN–Long navigation message• PV–Position and velocity solution• CP–Compact position solution• AL–Altitude and vertical velocity• ST–StatusThe TAIP Reference on the Sierra Wireless web site describes these messages in detail.

Parameter settings

For each parameter (<LN>, <PV>, <CP>, <AL>,<ST>), a setting of 1 enables the message (includes it in the RNAP message) and a setting of 0 disables the message. By default, only <LN> is enabled.

!MPGPSTAIP? returns the current settings, showing which messages are enabled.

!MPGPSTRACK=<track>

!MPGPSTRACK?

Set/query GPS tracking for MT reporting

This command allows you to suppress MT messages from being sent when the GPS module does not have a fix on enough satellites to calculate its position. This command only has effect when the MP is in non-polling mode (that is, the last parameter of the !MPMTCONF command is set to zero). In this mode, the GPS module must be configured for frequency or distance reporting in order for GPS reports to be issued by the GPS module.

When the <track> parameter is set to 0, all GPS messages are forwarded, regardless of whether the message contains valid GPS data. When the <track> parameter is set to 1, GPS messages are only forwarded if the GPS module is able to calculate a position. (The module must have a fix on three satellites to calculate latitude and longitude.)

!MPGPSTRACK? returns the current setting of the <track> parameter.

!MPGRESET Reset the MP module and the PC Card

Generates a hard reset of the MP modem (the equivalent of powering down then powering up).


Command Description

2130810

Rev 1.4 A

!MPGVER? Query current firmware revision

Returns a text string identifying the current firmware revision of the PC Card module.

!MPIDTIME=<value>

!MPIDTIME?

Set the inactivity timeout

Sets the interval after which a connection is lost if no data transmission occurs. This applies only if the operating mode is “On demand”. (See !MPOPMODE on page 45.)

This timeout has no effect during PAD sessions. (The PAD has its own inactivity timer. See !MPPADCONF on page 45.)

The <value> is in seconds (minimum 1, maximum 3600). The default is 2.

!MPIGNSENSE? Report ignition status

The white wire of the power harness is the ignition sense. The MP modem powers on when this wire is pulled high. (See the User Guide for your MP modem.) !MPIGNSENSE? returns either:• 0 Off—ignition sense is pulled low (less than 2 V)• 1 On—ignition sense is pulled high (5 to 36 V)

!MPMAC? Query MAC (Media Access Control) address

This command allows you to query the MAC address of the MP when using the Ethernet interface.

Returns the MAC address in a 6-byte hyphenated hexidecimal format.Example: 00-A0-D5-FF-FF-AB

!MPMTCONF=<engid>,<ctype>,<destip>,<destport>, <lowtmr>,<fasttmr>, <gpstmr>

!MPMTCONF?<n>

Configure MT protocol

A proprietary protocol called “MT” is used to report the GPS and I/O data from the MP modem. “MT” stands for Monitoring and Tracking. The protocol defines the contents and format of the reported data.

The MP modem provides four independent reporting engines, allowing the MT data to be simultaneously sent to four different destinations. The !MPMTCONF command sets the destination addresses, port numbers, and timers for each of the four engines.

Three timers control how frequently MT reports are sent: the low rate timer, the fast rate timer, and the GPS timer. Each of these timers can be set to send reports at a different frequency. The high rate timer only becomes active when an alarm condition is triggered by a rise or drop in the level of one of the digital I/O channels. (The !MPDIOCFG command, described on page 30, controls the alarm triggers on the digital I/O channels.)



Command Description

ug.08 41


42

!MPMTCONF(continued)

!MPMTCONF?<n>

Configure MT protocol (continued)

When there is no active alarm, the low rate timer and GPS timer determine the frequency of the reports. Where both timers are enabled, the timer with the shortest interval controls the report frequency. The GPS timer (which is in seconds) is generally set to a shorter interval than the low rate timer (which is in minutes). Having two timers supports a system that reports data more frequently in certain conditions. For example, the GPS timer can be disabled when the vehicle is stationary and enabled when the vehicle is moving.

Parameter settings

The supported values are:• Reporting engine <engid>=

0 Engine 01 Engine 12 Engine 23 Engine 3

• Connection type <ctype>=

0 Engine is unused1 MTP embedded in UDP packets2 Unused3 Raw GPS data embedded in UDP packetsSetting <ctype> to 0 disables the engine.

• Destination address <destip>=

IP address (in the form, nnn.nnn.nnn.nnn) of the destination device.

• Destination port number <destport>=

1 - 65535 • Low rate timer <lowtmr>=0 Disabled1-255 Interval between reports in minutes (5 by default.)

• Fast rate timer <fasttmr>=0 Disabled2-30 Interval between reports in seconds (3 by default.)

• GPS timer <gpstmr>=0 Disabled1-255 Interval between reports in seconds (10 by default.)When the GPS timer is disabled, the module continues to send unsolicited reports.

!MPMTCONF?<n> returns the configuration settings for the engine as specified by <n> (where <n> is 0, 1, 2, or 3).


Command Description

2130810

Rev 1.4 A

!MPNAME= “<MPname>”

!MPNAME?

Change/query the MP name

This command allows you to change or query the MP name.If you have a fleet of vehicles with MP modems, it is useful to assign a name to each MP modem so that each vehicle can be easily identified. For example, you could assign them names such as “MP xxx - car #34763”, “MP xxx- car #34764”, and so on.

You can change the name of the MP modem:• From the Watcher software• From the MP modem Manager software1

• With the !MPNAME command

1MP modem Manager is a web-based diagnostic software management tool that enables network administrators to monitor, configure, and upgrade a fleet of MP modems remotely.

Parameters Value

<MPname> Maximum string length is 32 character

The default is MP xxx GPS, where xxx is the MP number; for example, MP 875 GPS.

!MPNAME? returns the current value for <MPname>.

!MPNAT=<n>

!MPNAT?

Enable/disable NAT mode

In NAT mode, the MP modem has a built-in DHCP server that automatically assigns private network IP addresses to devices connected to it. The IP addresses assigned are in the range 192.168.1.10 to 192.168.1.19 for Ethernet and 192.168.2.10 to 192.168.2.19 for WAP.

In non-NAT configuration, you can connect only one client device, such as a computer to the MP modem.In NAT mode, you can connect up to 10 devices to the MP modem using Ethernet connections and up to 10 additional devices using WAP.

Note: When NAT is enabled, USB and Serial DUN are disabled.

Values:

• <n>=1 Enables NAT mode • <n>=0 Disables NAT mode (default)

The MP modem must be reset before the command takes effect. (The MP modem can be reset using the reset button or the !MPGRESET command. See page 40.)

!MPNAT? returns the NAT mode settings.


Command Description

ug.08 43


44

!MPNATSTATUS? Query the NAT server’s runtime status

Provides a summary of the state of the NAT server, displaying the number of sessions used in each of the translation tables for each of the supported protocols. This command is query-only.

Parameter Value DescriptionXLation TCP, UDP, ICMP Indicates which translation table the

numerical results apply to. As clients on the internal network use the internet, they consume TCP and UDP translation table entries.

MaximumEntries 600 for TCP

and UDP, 300 for ICMP

These values are fixed.

In Use 0...Maximum As entries are consumed by active clients using the internet, this column displays the number of entries in use. If the number reaches the maximum value for that type of translation table, no additional sessions may be started until some are freed.

Port forwarding assignments Total number of port forwarding assigned. See !MPPORTMAP for more details on port forwarding.

!MPNVDEF Set MP modem configuration parameters to defaults

Resets parameters stored in non-volative memory to defaults. This includes configuration settings for GPS, I/O, MTP, Fallback, Connection Watchdog, Operating Mode, PAD, and USB.


Command Description

Syntax AT!MPNATSTATUS? Returned string !MPNATSTATUS:

======================== xLation Maximum In Table Entries Use ----- ------- --- TCP 600 8 UDP 600 28 ICMP 300 0 ------------------------ Port forwarding assignments: 0 OK

2130810

Rev 1.4 A

!MPOPMODE=<value>

!MPOPMODE?

Select operating mode

The MP modem has two operating modes: Always On and On Demand. The mode selection determines whether the MP modem establishes a modem-to-network connection in the absence of a host-to-modem connection. If there is a modem-to-network connection, but no host-to-modem connection, the MP modem can send GPS data and provide notification on the state of any connected sensors or gauges. The host-to-modem connection is required if the user wants to web browse or send or receive messages.

• Always On—the MP modem establishes a modem-to-network connection whenever network service is acquired. The connection is only terminated when network service is lost or the MP modem is powered down.

• On Demand—the MP modem establishes a network connection only when a connect request is made (by an AT command or from an application such as Watcher). That is, the modem-to-network connection is established only when the host-to-modem connection is requested. When the host discon-nects, the modem-to-network connection is lost as soon as the inactivity timer expires. (See !MPIDTIME on page 41.)

The <value> is either:• <value>=0 Always On• <value>=1 On DemandThe setting is maintained across power cycles.

!MPOPMODE? returns the operating mode.

!MPPADCONF=<idle>,<c2c>,<escape>,<fwden>,<fwdchar>,<thre>,<echo>,<edit>,<bs>

!MPPADCON?

PAD configuration

Controls how packets are assembled, how PAD sessions are terminated, and whether echoing and buffer editing are enabled or disabled.

Note: The MP modem source port number is hard coded and is 7238. This port number should be used as the destination UDP port number by a remote host sending PAD data to the MP modem.

The PAD assembles and sends a packet to the network when any of the following occur:• The maximum packet length is reached (as defined by the <thre>

parameter).• The Inter-character timeout expires (if enabled by the <c2c> parameter).• The forwarding character is received, as defined by the <fwdchar>

parameter (if enabled by the <fwden> parameter).



Command Description

ug.08 45


46

!MPPADCONF=(continued)

!MPPADCONF?

PAD configuration (continued)

Parameter settings

The supported values are:• Inactivity timeout <idle>=

0 Disabled1 - 255 Timer duration in minutesThe timer counts down from each received data packet. If the timer expires, the PAD session is terminated.

• Inter-character timeout <c2c>=

0 Disabled1 - 255 Timer duration in hundreds of milliseconds.Example: If <c2C>=10, a packet is sent if no data is received for a period of 1000 milliseconds.• Escape option <escape>=

When exchanging binary data, it is best to use option 3 or 4 so that TIES (Time Independent Escape Sequence) is disabled. (Otherwise, if the string “AT+++” occurs in the data, it will cause the MP modem to switch to command mode.)

0 TIES—the MP modem switches to command mode on receipt of the sequence: “AT+++”.

1 TIES and DTR option 1—the MP modem switches to command mode on receipt of the sequence, “AT+++”, or, when the DTR line switches from on to off (maintaining any connected call).

2 TIES and DTR option 2— the MP modem switches to command mode on receipt of the sequence, “AT+++”, or when the DTR line switches from on to off (terminating any connected call).

3 DTR option 1—the MP modem switches to command mode only when the DTR line switches from on to off (maintaining any connected call).

4 DTR option 2—the MP modem switches to command mode only when the DTR line switches from on to off (terminating any connected call).

Note: When switching to command mode during a PAD session using “AT+++”, the “AT” must be included and must be in upper case. When command mode is invoked in this way, the PAD session remains open. The command “ATO” can then be used to resume the PAD session. The command “ATH” will close the PAD session.

• Include/exclude forwarding character <fwden>=

0 Disabled1 On receipt of the primary forwarding character, PAD sends the packet,

including the primary forwarding character, and terminates the session.2 On receipt of the primary forwarding character, PAD forwards the packet,

without including the primary forwarding character, and terminates the session.

• Forwarding character <fwdchar>=

ASCII code (0-255) for the forwarding character (by default, 13 or <CR>).

• Maximum packet length <thre>=

Length in bytes (minimum 1, maximum 1460). The default is 1460.


Command Description

2130810

• Enable/disable echo <echo>=

0 Disabled1 Enabled (continued on next page)

Rev 1.4 A

!MPPADCONF=(continued)

PAD configuration (continued)

When enabled, the PAD echoes every character received from the host. If input buffer editing is also enabled, on receipt of the backspace character, the PAD echoes the following: <backspace character><space><backspace character>. (The backspace character is defined using the <bs> parameter.)

• Input buffer editing <edit>=

0 Disabled1 EnabledWhen enabled, the PAD removes the last character from the input buffer on receipt of the backspace character. (The backspace character is defined using the <bs> parameter.)

• Input buffer backspace character <bs>=

ASCII code (0-255) for the backspace character (by default, 8).

!MPPADCONF? returns the current PAD configuration.

!MPPADCONN[n] Establish PAD connection

Initiates the PAD connection defined by the !MPPADSETUP command (on page 47) using the configuration specified by the !MPPADCONF command (on page 45).


The connection profile used to establish the connection is specified by n:• <n>=1 Profile 1• <n>=2 Profile 2• <n>=3 Profile 3Profiles are defined using the !MPSETUP command.

If n is not specified, the default profile is used. The default is defined by the !MPSETDFLT command. (See page 51.)

!MPPADSETUP=<ctype>,<ipaddr>,<port#>,<autoconn>

!MPPADSETUP?

Set up a PAD connection

Creates a UDP or TCP connection with a specified device. This defines the connection established by the !MPPADCONN command. (See page 47.)




Command Description

ug.08 47


48

!MPPADSETUP (continued)

Set up a PAD connection (continued)

Parameter settings

The supported values are:• Connection type <ctype>=

0 Undefined 1 UDP2 TCPNo data communication is possible when <ctype>=0.

• Destination IP address <IP address>=

IP address (in the form, nnn.nnn.nnn.nnn) of the destination device.

• Destination port number <port#>=

1 - 65535

• Autoconnection option <autoconn>=

0 Disabled (default)1 EnabledWhen enabled, the MP modem initiates a connection to the specified destination address and port on power-up.

!MPPADSETUP? returns the PAD connection setup.

!MPPDDELAY=<value>

!MPPDDELAY?[<querytype>]

Set power-down timer

Sets the length of a timer that begins counting down when the power is removed or the ignition sense wire is pulled low. (See !MPIGNSENSE on page 41.) The MP modem powers down when the timer expires.

The <value> is in minutes (minimum 0, maximum 240). (The default is 0.)

Depending on the <querytype>, !MPPDDELAY? returns:• <querytype>=0 Length of the timer (default)• <querytype>=1 Time remaining before expiry


Command Description

2130810

Rev 1.4 A

!MPPORTMAP=<idx>,<iface>,<type>,<IP addr><serverport>

!MPPORTMAP?

Configure a NAT port-mapped server entry

Configures a port-mapping, effectively making a host PC on the Wireless Access Point or Ethernet accessible to clients in the public network. Use this command in conjunction with the static route assignment command (!MPSTATICROUTE on page 53) so that the destination IP address can be known in advance.

Once configured, this setting remains until it is either deleted or changed. Entering a new command using the index of a previously-configured entry results in that entry being overwritten with the new value (provided there are no errors in the entry).

Changes made with this command take effect the next time the MP is rebooted.See !MPGRESET on page 40.

If NAT is disabled, the assignment version of this command is rejected. Deleting any entry is always permitted regardless of the MP’s operating mode.

When the command is used to enter a port mapping, the IP address used must be on the same subnet as the specified interface. If not, the command does not allow the configuration and prints a warning. However, it is possible to create a valid port mapping configuration and subsequently change the IP address of the interface, putting it onto a different subnet. In this case, the port mapping configuration would be invalidated and the MP would detect this condition on startup and simply not configure the mapping with the NAT server. If NS-package logging is available during startup, you could detect this condition by viewing the log output.

To change the MP’s IP addresses for the Ethernet and Wireless Access Point interfaces see !MPDHCPLANAD on page 27.


<idx> 1...10 The index of the configuration table entry, numbered from 1 to 10. Any index may be specified; you do not need to configure them in sequence.

<iface> 1|2|0 The interface through which the device is connected to the MP. 1 <default> is the Ethernet interface.2 is the Wireless Access Point interface.

If the parameter value of 0 is specified, no further parameters are required and the corresponding entry is deleted from the configuration list.



Command Description

ug.08 49


50

!MPPORTMAP(continued)

!MPPORTMAP (continued)

<type> 1|2 1: UDP protocol2: TCP protocolNote: If both protocols must be mapped, use two separate entries of this AT command.

<IP Addr> 192.168.x.y IP address of the device the server application is running on. The “x” value depends on which subnet the device is on: 1: Ethernet LAN2: Wireless Access Point.

If the “y” value is within the range of dynamically-allocated IP addresses, the configuration is accepted, however there is no guarantee that the same host will receive that IP address across subsequent DHCP Discovery sessions. It is best to use a statically-allocated IP address. See !MPSTATICROUTE on page 53.

<serverport> 0...65535 The server application on the host machine is assumed to be monitoring this port number. The MP forwards all traffic of the specified type arriving at the MP with the destination port = serverport into packets with <IP Addr> as their destination on the internal network.

Examples:

Port mapping #1 over Wireless LAN: at!mpportmap=1,2,1,192.168.2.14,300Port mapping #2 over Ethernet LAN: at!mpportmap=2,1,192.168.1.11,200

!MPPORTMAP? returns the index number (or Not Configured if it is unassigned), the protocol type, the IP address, and the server port number.


Command Description

2130810

Rev 1.4 A

!MPPRIVIP=<IP addr>,<local port>,<host port>

!MPPRIVIP?

Set the private IP address

The private IP is used for data traffic between the MP and Watcher, to distinguish control and status messages from network traffic.

Any valid private IP address can be used. Using a public IP address could cause the application to fail.

Parameter settings

The parameters are:• <IP addr> The IP address used between Watcher and the MP modem (not

used for network traffic)• <local port> UDP port number on which the MP modem receives control

and status messages• <host port> UDP port number to which the MP modem sends control and

status messages!MPPRIVIP? returns the current private IP address. The default is 10.0.0.1

!MPRESETCNT=1

!MPRESETCNT?

Reset the counters

Resets the six counters that record the number of times the MP modem has been reset to 0.

!MPRESETCNT? returns the number of times the MP modem has been reset for each of the six counters:

• MP Total: MP modem grand total reset counter• MiniCard Init Fail: Reset because radio module initialization failed• MiniCard Total: Radio module grand total reset counter• CM-trig (Con fail) MC: Reset caused by at!mpconrej• CM-trig (Discon fail) MC: Reset because disconnect failed and can't

communicate with the radio module• CW-trig MC: Connection Watchdog reset

!MPSETDFLT=<value>

Set the default connection profile

The MP modem supports up to three connection profiles (dependent on model of MP modem). This command sets which is the default:• <value>=1 Profile 1 is the default• <value>=2 Profile 2 is the default• <value>=3 Profile 3 is the default

As shipped, the default profile is Profile 1. The default profile is the one used to establish a connection, unless the user explicitly selects a different profile.


Command Description

ug.08 51


52

!MPSETUP=<index>,<label>,<username>,<password>,<apn>

Configure a profile

The MP modem allows for up to three profiles. See the User Guide for more detailed information about profiles.

Parameter settings

The supported values are:

• Profile number <index>=1 Profile 12 Profile 23 Profile 3

• Description of profile <label>=32 character string

• Username <username>=32 character string

• Password <password>=32 character string

• Access Point Name <apn>=100 character string

Unless the user explicitly selects a different profile, the default profile is used to establish connections. (See !MPSETDFLT on page 51.)

!MPSIMSLED? Report the status of the SIM sled

The status returned is either:• 0 Closed—the sled is fully inserted• 1 Open—the sled is not fully inserted(This does not indicate whether there is a SIM in the sled.)


Command Description

2130810

Rev 1.4 A

!MPSTATICROUTE=<idx>,<iface>,<MAC Addr>,<IP Addr>

!MPSTATICROUTE?

Configure a Static Route Within the DHCP Server

Configures a static route within the DHCP server. Once configured, this setting remains until it is either deleted or changed. Entering a new command overrides the existing setting (provided there are no errors).

Any changes made with this command take effect after the MP is rebooted. See !MPGRESET on page 40.

Requirements:• You must know in advance the MAC address of the device to be assigned

the static IP address.

• The IP address to be assigned to the device must be on the same subnet as the device.

• The IP address to be assigned to the device must not be within the range of the IP addresses dynamically allocated by the DHCP server.

• The IP address must be on the same subnet as the specified interface (Ethernet or Wireless Access Point)

Note: It is possible to create a valid static route configuration and subsequently change the IP address on the interface, putting it onto a different subnet. In this case, the configured static route is invalidated and the MP detects this condition. On startup it would simply not configure the static route in the DHCP server. If DL-package logging is available during startup, you could detect this condition by viewing the log output.

To change the MP’s IP addresses for the Ethernet and Wireless Access Point interfaces see !MPDHCPLANAD on page 27.

If NAT is disabled, the assignment version of this command is rejected. Deleting any entry is always permitted regardless of the MP’s operating mode.


<idx> 1...10 Index of the configuration table entry, numbered from 1 to 10. Any index may be specified; you do not need to configure them in sequence.

<iface> 1|2|0 The interface through which the device is connected to the MP. 1 <default>: Ethernet interface2: Wireless Access Point interface.

If the parameter value of 0 is specified, no further parameters are required and the corresponding entry is deleted from the configuration list.

(continued on the next page)


Command Description

ug.08 53


54

!MPSTATICROUTE (continued)

Configure a Static Route Within the DHCP Server (continued)

<MAC Addr> “aa-bb-cc-dd-ee-ff” The MAC address of the device that is receiving the static route IP address. Must be enclosed in a pair of double-quotes and each octet must be separated by hyphens for a total of 17 characters, not including the double-quotes.

<IP Addr> 192.168.x.y The IP address assigned to the device. The “x” value depends on which subnet the device is on: 1: Ethernet LAN2: Wireless Access Point.

The “y” value must be outside the range of dynamically-allocated IP address, that is, the lowest it can be is 20.

Examples:Static route #1 over Wireless LAN: at!mpstaticroute=1,2,”10-11-12-13-14-15”,192.168.2.100

Static route #2 over Ethernet LAN:at!mpstaticroute=2,1,”A1-B1-C1-D1-E1-F1”,192.168.1.200

!MPSTATICROUTE? returns the index, interface, MAC address and IP address.

!MPUSB=<n>

!MPUSB?

Enable/disable USB operation

The MP modem can be connected to the host computer with either a serial or USB cable. If only a serial cable is in use, this command has no effect.

If a USB cable is in use, this command enables and disables USB operation, as specified by <n>:• <n>=1 Enables USB operation (default)• <n>=0 Disables USB operation

If the MP modem is attached to the host computer by USB cable (or by both a USB and serial cable), USB operation must be disabled to allow for a DUN (Dial-Up Networking) connection using ATD. (ATD is described on page 59.)

The MP modem must be reset before the command takes effect. (The MP modem can be reset using the reset button or the !MPGRESET command. See page 40.)

!MPUSB? returns the current USB state.


Command Description

2130810

Rev 1.4 A

!MPVSOPT=<GPS Startup enable>,<PAD Startup enable>,<PPP enable>

!MPVSOPT?

Change/set the MP modem virtual port options

You can configure the MP to be in GPS or PAD mode automatically on start-up using the commands AT!MPGPSCOMOUT and AT!MPPADSETUP respectively. When configured to start up in one of these modes, the AT!MPVSOPT command tells the MP modem which serial port to use: the true physical port or the virtual port. This command is also used to enable dial-up PPP connection over the virtual serial port. When this option is selected, the MP disables the NDIS/LAN connection over USB so it provides only one data connection at a time to the host computer.

Parameters

<GPS Startup enable> • 0: Use true serial port for GPS mode on startup, if this option is selected.

• 1: Use the virtual port for GPS mode on startup, if this option is selected.

<PAD Startup enable>• 0: Use true serial port for GPS mode on startup, if this option is selected.

• 1: Use the virtual port for GPS mode on startup, if this option is selected.

<PPP enable>• 0: Do not allow dial-up / PPP connection on virtual serial port.

• 1: Allow dial-up / PPP connection on virtual serial port. This will disable NDIS / LAN connection over USB.

See also !MPGPSCOMOUT on page 33 and !MPPADSETUP on page 47.

!MPWAP=<0|1>

!MPWAP?

Enable/Disable the Wireless Access Point interface

Changes the status of the Wireless Access Point interface. Requires an MP reset before the change takes effect. Changes remain in effect until the next time this command is executed. See !MPGRESET on page 40.


Values:• 0: Disable Wireless Access Point• 1: Enable Wireless Access Point

Example: at!mpwap=1

!MPWAP? returns the Wireless Access Point status.


Command Description

ug.08 55


56

!MPWAPCHAN=<channel>

!MPWAPCHAN?

Set Wireless Access Point Channel Number

Sets the Wireless Access Point channel number. Requires an MP reset before the change takes effect. See !MPGRESET on page 40.


Parameter Values Description

<channel> 1 – 11 channel number

Example: at!mpwapchan=2

!MPWAPCHAN? returns the channel number.

!MPWAPCIPHER=<prci>

!MPWAPCIPHER?

Set Wireless Access Point Cipher Option

Sets the Wireless Access Point cipher option. Requires an MP reset before the change takes effect. See !MPGRESET on page 40.


Parameter Description

<prci> Wireless Access Point pairwise cipher option, cipher option only works with certain security modes:

0: None (Open mode only)1: TKIP (WPA and WPA2 modes only)2: CCMP (WPA and WPA2 modes only)3: TKIP + CCMP (WPA and WPA2 modes only)4: Open WEP (Open WEP mode only)5: Shared WEP (Shared WEP mode only)

Example: at!mpwapcipher=1

!MPWAPCIPHER? returns the pairwise and group cipher.


Command Description

2130810

Rev 1.4 A

!MPWAPSECURE=<security>,“<key>”

!MPWAPSECURE?

Set Wireless Access Point Security Key

Sets the Wireless Access Point’s security type and key. Requires an MP reset for the changes to the security key to take effect. See !MPGRESET on page 40.


Parameter Description

<security> Wireless Access Point security type:

0: Open1: WPA2: WPA23: Open WEP4: Shared WEP

<key> Key for the security type (optional). If not present, the key stored in the NV is used. If used, the key must have the following formats for the specified security:

WPA and WPA2: “string 8-64 ASCII characters”, for example: abcdefghij

WEP: “string 10 ASCII characters”, for example: abcdefghij or “26 hex characters”, for example: 0123456789ABCDEF0123456789

Examples:

WPA mode: at!mpwapsecure=1, “sierrawireless”Shared WEP mode: at!mpwapsecure=4,”abcdefghij”Shared WEP mode: at!mpwapsecure=4,”0123456789ABCDEF0123456789”Open WEP mode: at!mpwapsecure=3,”abcdefghij”Open WEP mode: at!mpwapsecure=3,”0123456789ABCDEF0123456789”

!MPWAPSECURE? returns the security and key settings.

!MPWAPSSID=“<ssid>”

!MPWAPSSID?

Set Wireless Access Point SSID (Service Set IDentifier)

Sets the Wireless Access Point’s SSID. Requires an MP reset for the change to take effect. See !MPGRESET on page 40.


Parameter Value Description<ssid> Maximum 32 characters Wireless Access Point SSID

Example: at!mpwapssid=”My MP3G WAP”

!MPWAPSSID? returns the SSID.


Command Description

ug.08 57


58

& Prefix

Table 2-4: & Prefix commands

Command Description

&C[n] Data Carrier Detect Control

Determines the behavior of the Data Carrier Detect (DCD) signal to the host (DTE) in response to the presence of a connection.

Value Setting0 DCD is always ON1 DCD reflects state of connection2 Unix compatible DCD control. DCD is always ON except for a short

time (~1 second) when the carrier is lost. (Default)

&D[n] Data Terminal Ready Options

Determines what actions are taken by the MP modem in response to the Data Terminal Ready (DTR) signal from the host (DTE). DTR must be off for a period of 2–10 milliseconds in order for action to be taken.

Value Setting0 Ignore DTR.1 Enter command state for an on-to-off DTR transition. The MP modem

condition (on or offline) is not affected.2 Hang up and enter command state for an on-to-off DTR transition.

Auto-answer is disabled if DTR is off. (Default)

&F Factory Settings Restore

Reloads the factory-stored default configurations into active memory. See Table 2-6 on page 61 for information on factory settings.This command is functionally the same as Z (Reset) on page 61. If there is an active call, the command executes and the call is dropped.

&V View Configuration

Displays the active profile (commands and S-register contents).Any numeric parameter is ignored.

&W Store user-defined profile

Saves current configuration settings into non-volatile memory. When the MP modem is reset or powered off and on, these settings are restored.

This only saves settings configured with these commands: ATE, ATV, ATQ, ATL, ATM, ATX, and AT&C.

The settings stored using AT&W can also be restored using the ATZ command (see page 61). The AT&F command (see page 58) returns the MP modem to the factory default settings (see page 61).

2130810

Rev 1.4 A

No Prefix

Table 2-5: Alphabetic AT commands

Command Description

A/ Repeat Last command (not preceded by AT)

Re-executes the last command string entered. The previously executed command remains in the command buffer until AT is entered or the MP modem is reset or power-cycled.

This command does not require the AT prefix or a <CR> at the end. It executes immediately on entry of the slash character.

D**##[n] Make a dial-up connection

Establishes a connection using the specified profile. The !MPSETUP is used to maintain profiles; up to three profiles are supported. (See page 52.)

The profile used in the connection is specified by n:• <n>=0 Default profile. (Set by the !MPSETDFLT command.)• <n>=1 Profile 1• <n>=2 Profile 2• <n>=3 Profile 3

E[n] Echo

Controls echoing of characters received from the host (DTE) back to the host when in command state. This also affects framing of responses.

Value Setting• 0:Disable echo• 1: Enable echo (Default)

H[0] Hook Control

Go on-hook to disconnect a data call. If the MP modem was already on-hook, no change is made. The only parameter allowed is 0 (zero), which is optional. The MP modem goes from online condition to offline condition.

I[<value>] Display product identification

Displays model and version information.

The <value> determines what information is displayed:• <value>=0 Manufacturer and model• <value>=4 Mobile ID used by the MT protocol. (See !MPMTCONF on

page 41.)The Mobile ID is derived from the IMEI or ESN.• <value>=5 Firmware revision• <value>=6 Bootloader revision

ug.08 59


60

O Online

Causes the MP modem to go from command state (online condition) to data state. The MP modem responds with the normal CONNECT response codes (if enabled) as if the connection were new.

This command is executed by the MP modem. If the MP modem was in an offline condition and without an airlink, the NO CARRIER and OK result codes are returned. If the MP modem was offline and the airlink was established (passthrough state), but without a call in place, the MP modem attempts to process the command. The typical result is either NO ANSWER or NO CARRIER. This is, however, dependent on the MP modem.

Q[n] Quiet Result Code Display Option

Controls the return or suppression of result codes to the host (DTE).

Value Setting0 Disables Quiet mode (enables return of result codes) (Default)1 Enables Quiet mode (disables return of result codes)

Result Codes:

OK n = 0 Otherwise the result code is suppressed (n=1).

S<n>=<x>

S<n>?

S-Register Set/Query

Sets or queries the contents of the specified S-register (n) to the new value (x). Zeros are assumed where parameter values are omitted.

Var. Rangen Valid S-register numberx as determined by the S-register (n)

Result Codes:

OK S-register n set to xERROR Invalid S-register value (n) or,

setting (x) outside of permitted range.

Table 2-5: Alphabetic AT commands (Continued)

Command Description

2130810

Rev 1.4 A

Stored profile settingsThe Sierra Wireless MP modems do not support a user‐defined profile. Both Z (Reset) (page 61) and &F (Factory Settings Restore) (page 58) restore these settings.

V[n] Verbose Result Code Form

Specifies whether the MP modem displays the result codes in numeric format or as words (verbose).

Note that numeric codes are returned as ASCII character numerals.

Value Setting0 Numeric result codes1 Verbose result codes (Default)

Result Codes:

OK(0) n = 0, 1 (returned in the new setting)ERROR(4) otherwise

Z Profile Restore

The MP modem goes on-hook (drops any active call) and then resets the command and register parameters to the defaults. See Table 2-6 on page 61 for information on factory settings.

Table 2-5: Alphabetic AT commands (Continued)

Command Description

Table 2-6: Profile settings

Command Page Description Factory

E 59 Echo (command state) 1 (enabled)

Q 60 Quiet result code display option 0 (Codes returned)

V 61 Verbose result code form 1 (Words)

&C 58 Data carrier detect control 2 (UNIX wink)

&D 58 Data terminal ready options 2 (Hang up)

S registers

S0 60 Auto-answer mode 0 (disabled)

S3 60 Carriage return character 013 (CR)

S4 60 Line feed character 010 (LF)

S5 60 Backspace character 008 (BS)

ug.08 61


62
2130810

Rev 1.4 A

AA: !MPCWSETUP Flowchart

Figure A-2: The process that the Connection Watchdog follows once a connection is established.

Wait for new connection

Wait <verification time> minutes

ConnectionWatchdoginactive

Check validityof <dns name> or

<PING IP> address

Success

Failure

ConnectionWatchdog

active

Wait<rx time>minutes

Check forreceived

dataData received

No data received

DNS<mode>?

NoTry to

address

Try to resolve

<dns name>

Terminateconnection

Ping failed DNS resolution failed

<Radio ResetFlag> is on?

Reset radioYes

No

Ping successful DNS resolved

<PING IP>

Yes

Valid

atio

n pe

riod

Con

nect

ion

Wat

chdo

g A

ctiv

e P

erio

d

ug.08 63


64

Following is a step‐by‐step explanation of the process described in Figure A‐1:

Note: Steps 1-2 are the “Validation Period”.

1. Once a network connection is established, the MP modem verifies the validity of the <dnsname> or <PING IP> values.

2. If the MP modem verifies that the value is valid, the Connection Watchdog is activated. If the value is invalid, it waits the number of minutes spec‐ified by the <verificationtime> parameter and then tries again until it is able to validate the value.

Note: Steps 3-7 are the “Connection Watchdog Active Period”.

3. Once the Connection Watchdog is active, it checks that data is being received.

4. If data is being received, the Connection Watchdog waits the number of minutes specified by the <rxtime> parameter before checking again. If data is not received during the number of minutes speci‐fied by the <rxtime> parameter, it takes the action (check <dnsname> or <PING IP>) determined by the <mode> value.

5. If the ping is successful, or the DNS name is resolved, then the Connection Watchdog will again check to see if data is being received (returns to Step 4).If the ping is unsuccessful, or the DNS name cannot be resolved, the Connection Watchdog terminates the connec‐tion.

6. If the <reset Radio Flag> is set to 0 (the default), the radio is not reset.If the <reset Radio Flag> is set to 1, the radio is reset.

7. The MP modem waits for a new connection, and once it is detected, returns to Step 1.

Benefits of this process:• The primary benefit is that the Connection Watchdog

automatically check the validity of the network connection even if no data is being received. Without the ability to ping an IP address or resolve a DNS name, administrators would have to manually verify a given MP modem is operational if it is not transmitting,.

• The “Validation Period” prevents the Connection Watchdog from prematurely terminating connections. If the MP modem bypassed the “Validation Period” and the IP address or DNS name turned out to be invalid, the Connection Watchdog would terminate the connection rather than wait the <rxtime> for more data. This could be especially problematic during emergency situations.

2130810

Rev 1.

Index
A
Always On, 45analog input channel

configuration, 19report the state of, 19

AT commandsbasic modem configuration, 16basic operation actions, 15summary, 15

B

bar services, 20

C

cipher, 56communication session, establishing, 11configuration

saving, 58unlock, 21

configuration lock, set, 21configuration parameters, set to defaults, 44connection profile, set the default profile, 51Connection Watchdog

set, 24statistics, reset or display, 23

counters, reset, 51crash dump data

clear, 32read, 33

currency, 9

D

Data Carrier Detect Control, 58Data Terminal Ready Options, 58debugging information, displaying, 26defaults, set modem configuration parameters to, 44DHCP

configure static route within, 53IP address, 27query DHCP server’s runtime status, 28

dial‐up connection, 59digital I/O channel

configuration, 30set values, 29

diversity, 31document conventions, 10dump configuration, 21

E

echo, 59electronic ID, 31ESN, query, 31Ethernet

IP address for, 31set IP address for, 27

F

factory settings restore, 58fallback connection, configure, 32fallback feature, 32fallback timer, set, 32firmware

query current version, 41upgrading, 9version, 9

G

GPRSconnections, establishing, 15, 59

GPSenable output to the AT command port, 33output mode, 36reporting data, 35request status, 38resetting module, 38resetting the module, 38set / query tracking, 40set update interval, 37storing and forwarding records, 39update interval, 37

I

ignition status, report, 41IMEI, query, 31inactivity timeout, set, 41initialization string, set, 37IP address

Ethernet interface, 31set offline scope DHCP IP address, 27wireless access point interface, 27

IP address, report, 21IP address, set, 27

L

last command repeat, 59

4 Aug.08 65

Index

Rev 1.

M

MAC address, query, 41mapping. ports, 49mobile ID, 59MP module, reset, 40MP name, change or query, 43MT protocol, configure, 41

N

NATconfigure NAT port‐mapped server entry, 49query NAT server’s runtime status, 44, 44

National Marine Electronics Association See NMEA.network

re‐acquisition, set response to, 31NMEA, 38NMEA messages, set, 37

O

On Demand, 45operating mode, select, 45

P

PADconfiguration, 45connection, establishing, 47

port forwarding, 49port mapping, 49port settings, for communicating with modem, 12power‐down timer, set, 48PPP authentication, enable or disable, 20private IP address, set, 51profile, configure, 52

R

reset feature, enable or disable, 22RNAP, 40

S

saving settings, 58security key, 57set configuration lock, 21set offline scope DHCP IP address, 27settings, 58SIM sled, report the status of, 52SSID, 57store user‐defined profile, 58stored profile settings, 61

T

TAIPmessages, 40send commands to GPS module, 33set GPS module to use, 38

U

UDP port number, configure, 22unlock MP configuration, 21USB operation, enable or disable, 43, 54

V

versionfirmware, 59

view configuration, 58virtual port options, 55

W

WAP, 55, 56channel number, 56security key, 57SSID, 57

wireless access point, 55, 56channel number, 56cipher option, 56enable/disable wireless access point interface, 55security key, 57set IP address for, 27SSID, 57

4 Aug.08 66

mp 3g modems - sierra wireless

Documents