Novatel Wireless NRM-EU860D Users Manual

Proprietary & Confidential 121

Reject Cause 15

This feature, when enabled, will search ALL available RAT’s if a Reject Cause 15 is sent by the
network as the result of a cell selection. In the disabled state, the modem searches the same
RAT from which it received the Reject Cause 15 message. Disabled is the normal search used by
carriers other than CarrierX.

Name

States

Devices

FW Version

AT Command

NV Item

SearchAllRatsAfterRejectCause15Enable

Enable, Disable

U630, xU7x0, xU860/U870

U630 – Build 21 and above

xU7x0 – Build 30 and above

xU860/U870 – Build 7 and above

N/A

NW_NV_SRCH_RATS_REJECT_15_I

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 122

N.A. CarrierZ

N.A. CarrierZ has mandated that Enhanced Network Selection (ENS) be enabled on all modems
delivered to N.A. CarrierZ. This feature should also be enabled for all OEM customers launching
on the N.A. CarrierZ network.

Enhanced Network Selection (ENS)

The N.A. CarrierZ network consists of different MNCs deployed in the various N.A. CarrierZ
markets and the Empire and Triton markets having a non-N.A. CarrierZ MNC. GSM network
selection procedures are an issue in that terminals perform their periodic higher prio rity PLMN
scans even when on a N.A. CarrierZ network in spite of the display indicating a N.A. CarrierZ
network. This causes customer issues when they travel from one N.A. CarrierZ market that uses
one MNC to another N.A. CarrierZ market, which uses a different MNC. Additionally, Empire and
Triton based customers are impacted more in that they are continuously in a roaming scenario on
the T-Mobile/Triton network and yet from a billing, service and customer care perspective they
are considered to be on the home N.A. CarrierZ network.

Name

States

Devices

FW Version

AT Command

NV Item

EnsEnable

Enable, Disable

xU7x0, xU860/U870

All

N/A

NV_ENS_ENABLED_I

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 123

Factory Fulfillment

The following section details the features which relate to fulfillment of modems.

International Mobile Equipment Identity (IMEI)

The IMEI is a number unique to every GSM and UMTS mobile. It is found printed on the IMEI
label located on the modem.
The IMEI number can be used by the GSM network to identify valid or network approved devices
and is independent of the SIM.
The IMEI is a 15-digit number which includes information on the origin, model, and serial number
of the device. The model and origin comprise the initial 8-digit portion of the IMEI, known as the
Type Allocation Code (TAC). The remainder of the IMEI is manufacturer-defined, with a Luhn
check digit at the end (which is never transmitted).
As of 2004, the format of the IMEI is as follows: AA-BBBBBB-CCCCCC-D
where: AA – Reporting Body Identifier, indicating the GSMA – approved group that allocated the

modem TAC code BBBBB,

BBBBBB – TAC
CCCCCC – serial number of the modem model
D – Luhn check digit for the entire number

Name

States

Devices

FW Version

AT Command

NV Item

OEM customers will supply range corresponding to their GCF or PTCRB grant.

NVTL has its own IMEI for generic cards.

U630, xU7x0, xU860/U870

IMEI

All

AT+CGSN

NV_UE_IMEI_I

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 124

E725 Provisioning with IOTA

This applies only to the E725. The EU860D & EU870D use SIM cards and don’t require any type
of IOTA.

Sprint PCS uses IOTA to perform their provisioning before a wireless device is allowed on the
data network. This process is operator specific so there maybe variations as to how provisioning
is done. In all cases, please contact the network operator if you have questions concerning
activation and subscriber related questions.

When using the PCI Express Mini Card, the activation is done by MobiLink™. MobiLink™ will
automatically detect if the E725 module needs to perform any provisioning on Sprint’s network.

If an E725 module does not use MobiLink, you must run IOTA from the primary port of the E725
module. Novatel Wireless has developed an embedded IOTA Client called, eIOTA that interfaces
through AT commands. This Client will allow the subscriber to execute an IOTA session to
provision the E725. Once this is done, the E725 can access the operator’s 1xRTT and 1xEVDO
networks.

For use with Sprint PCS, the subscriber first needs to contact a sales representative to activate
the E725. The Sprint PCS representative will present to the subscriber the MDN or MIN numbers
with the SPC. These parameters need to be entered into the E725 if it does not already exist.
Upon the time of receiving these parameters, Sprint PCS has a time provisioning requirement of

1.5 days to 2 days for the E725 to perform and complete an IOTA session. If the subscriber does
not complete the IOTA provisioning within this time, the subscriber will have to call Sprint PCS
again to reset the provisioning timer.

eIOTA

eIOTA is a subscriber unit provisioning Client, or Provisioning Service Agent. Embedded in the
CDMA wireless modem, the Client communicates with Handset Configuration Manager, the
operator’s IOTA server, to download provisioning data to the subscriber unit or upload settings
per server's request. It allows the operator to remotely perform provisioning without having to
bring the wireless device into a sales location.

eIOTA is disabled by default from the factory. This is done because if eIOTA was active, it would
automatically attempt an eIOTA session if the E725 has not already completed provisioning.
When the subscriber finishes entering the MDN or MIN, they could either enable eIOTA and have
the E725 automatically attempt an IOTA session after a power cycle or initiate a manual IOTA
session.

Enabling, disabling, and starting eIOTA

eIOTA Client can be enabled or disabled by issuing the AT commands:

To enable: AT+IOTA=1
To disable: AT+IOTA=0
To force start: AT+IOTA=2

There are two ways to start eIOTA, NIIP(Network Initiated Initial Provisioning) or CIIP(Client
Initiated Initial Provisioning). In NIIP, operator’s IOTA server pushes a special SMS message to
the Client to trigger an IOTA session. In CIIP, a session can be triggered by locally issuing an AT
command: AT+IOTA=2.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 125

Checking eIOTA status

The AT command: AT+IOTA=? Is used to query the eIOTA status while IOTA is active.
Please refer to AT+IOTA in the AT Commands Chapter for details.

Cautions that need to be taken when eIOTA is active

DO NOT power off the unit until IOTA session is finished.
DO NOT remove the antenna from the unit.
DO NOT disconnect the data call issued by eIOTA.
When running eIOTA, to ensure no power lost, make sure to use the AC power and NOT the

battery power.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 126

Appendix B - Development Tools & Procedures

Introduction

This appendix contains identification and introductory guidance on development tools used in the
validation, certification and compliance testing of the Novatel Wireless PCI Express Mini-cards

Satimo Chamber

Novatel Wireless has the in-house ability* to test TRP/TIS on host devices integrating the Novatel
Wireless PCI Express Mini card. It is of great value to pre-scan the integrated device for both
development and meeting carrier TRP/TIS requirements. Please contact Novatel Wireless for
further information.

* Sept 2006

HSDPA: Set Mini card to Circuit Switch (CS) Mode

In order to assist in the execution of FCC/CE testing Novatel Wireless has developed an
executable that will force the EU860D/EU870D into CS mode of operation. This tool allows for
configuring a manual mobile originated/terminated GSM circuit switched voice call on the Novatel
Wireless EU8X0 modem in a test lab environment. Please contact Novatel Wireless for further
information.

Thermal Limit Tool

The Thermal Limit Tool is used for the purpose of enabling/disabling, or modifying, the thermal
shutdown settings of the EU8X0 modem.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 127

Band Preference Tool

The band preference tool enables or disables specific bands on the Novatel Wire less EU8X0
modem in a test lab environment.

When executing conducted RF tests the PCI Express Mini card can also receive over the air
signaling from commercial networks. The PCI Express Mini card may try to connect to these
commercial networks (depending on the modem configuration) and not connect to the intended
conducted band. This tool allows the disabling of specific bands.

Band Preference Application Tool Box

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 128

HSDPA: RF Application

The RF Application and procedure provides the instructions of how to set up and use the Novatel
Wireless RF application tool for the purpose of performing TX and RX lab environment tests on
the Novatel Wireless EU8X0 HSDPA modem.

Figure 1 – NW RF Application Tool Box

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 129

EVDO RF Application

In order to assist in the execution of FCC testing Novatel Wireless has developed a test setup
application that is used to configure the E725 for FCC testing. Please contact Novatel Wireless
for father information.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 130

Appendix C - Regulatory Approval and Compliance

As both the EU860D and EU870D support four bands of GPRS operation, including North
American and European bands, both products are covered by regulatory requirements of North
America and Europe. Both products will have FCC, PTCRB, CE and GCF certification.

The E725, as a CDMA product in North America requires FCC certification.

FCC (Federal Communication Commission)

The E725, EU870D and EU860D products conform to the requirements of applicable American
laws with respect to safety; health, environment and consumer protection.

This E725, EU870D and EU860D will comply, per applicable band, with the following parts of the
Federal Communication Commission’s (FCC) Code of Federal Regulations (CFR):

FCC CFR47 Part 2 (General Rules and Regulations, RF Exposure Evaluation)
FCC CFR47 Part 15 (All Radio Frequency Devices)
FCC CFR47 Part 24 (Narrow and wideband PCS modules)
FCC CFR47 Part 22 (Cellular Service)

A FCC grant shall be obtained in order to demonstrate compliance.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 131

CE (Conformance European)

The EU870D and EU860D products comply with the essential requirements of the applicable
European laws and directives with respect to safety; health, environment and consumer
protection. The products conform to the essential requirements of the R&TTE (Radio and
Telecommunications Terminal Equipment) Directive, 1999/5/EC, and have the CE mark affixed.
The applicable sections of the following standards have been used to demonstrate compliance to
this requirement. The EU860D and EU870D products will comply with the 3GPP standards TS

51.010 for GSM and TS 34.121 for WCDMA.

R&TTE

R&TTE

Discipline Definition Applied Standard

Requirement

Article 3.1(a) Health Safety Testing

(flammability, etc…)

ICNIRP 19985 European Council

Rec.1999/519 EC
Article 3.1(a) Safety IEC 60950-16
Article 3.1(b) EMC EMC testing

(unintentional radiators,

etc.…)

Article 3.2 Spectrum Network Testing (power,

frequency stability, etc…)

EN 301 489-017
EN 301 489-078

EN 301 489-24

EN 301 51110
EN 301 908-111
EN 301 908-2

12

9

5

International Commission on Non-Ionizing Radiation Protection

6

Safety of Information Technology Equipment

7

Electromagnetic compatibility and Radio Spectrum Matters (ERM) ElectroMagnetic Compatibility
( EMC) standard for radio equipment and services
Part 1: Common Technical requirements

8

Electromagnetic compatibility and Radio Spectrum Matters (ERM) ElectroMagnetic Compatibility
( EMC) standard for radio equipment and services
Part 7: Specific conditions for mobile and portable radio and ancillary equipment of digital cellular
radio telecommunications systems ( GSM and DCS)

9

Electromagnetic compatibility and Radio Spectrum Matters (ERM) ElectroMagnetic
Compatibility ( EMC) standard for radio equipment and services
Part 24: Specific conditions for IMT-2000 CDMA Direct Spread (URTA) for Mobile and portable
radio and ancillary equipment.

10

Global System for Mobile communications (GSM):
Harmonized EN for mobile stations in the GSM 900 and GSM1800 bands covering essential
requirements under article 3.2 of the R&TTE directive

11

Electromagnetic compatibility and Radio Spectrum Matters (ERM) Base Stations (BS) and User
Equipment (UE) for IMT-2000 Third-Generation cellular networks.

12

Electromagnetic compatibility and Radio Spectrum Matters (ERM) Base Stations (BS) and User
Equipment (UE) for IMT-2000 Third-Generation cellular networks.
Part 2: Harmonized EN for IMT-2000,

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 132

The EU860D and EU870D products will comply with the applicable GSM/GPRS European
Regional Regulatory Requirements as per the following table.

GSM/GPRS European Regulations

GSM 11.10 /

TS 51.010

Requirement

12.1.1 Conducted spurious emissions - MS allocated a channel Yes

12.1.2 Conducted spurious emissions - MS in idle mode Yes

12.2.1 Radiated spurious emissions - MS allocated a channel Yes

12.2.2 Radiated spurious emissions - MS in idle mode Yes

13.1 Transmitter – Frequency error and phase error Yes

13.2 Transmitter – Frequency error under multipath and interference conditions Yes

13.3-1

13.4 Transmitter - Output RF spectrum Yes

13.6

13.7 Transmitter output power and burst timing in HSCSD configurations Yes

13.8 Transmitter, Output RF spectrum in HSCSD multislot configuration Yes

13.16.1 Frequency error and phase error in GP RS multislot configuration Yes

13.16.2 Transmitter output power in GPRS multislot configuration Yes

Transmitter output power and burst timing - MS with permanent antenna

Transmitter – Frequency error and phase error in HSCSD multislot

Description

connector

configuration

EU /

R&TTE

Directive

Yes

Yes

13.16.3 Output RF spectrum in GPRS multislot configuration Yes

13.17.1 Frequency error and Modulation accuracy in EGPRS Configuration Yes

13.17.2

13.17.3-1 EGPRS Transmitter output power- MS with permanent antenna connector Yes

13.17.4 Output RF spectrum in EGPRS Configuration Yes

14.7.1 Blocking and spurious response - speech channels Yes

14.18.5 Blocking and spurious response in EGPRS Configuration Yes

CDMA Direct Spread (UTRA FDD) (UE) covering essential requirements of article 3.2 of the
R&TTE Directive

Novatel Wireless Doc No. OM-01017857 Rev 1

Frequency error under multipath and interference conditions in EGPRS

Configuration

Yes

Proprietary & Confidential 133

GCF (Global Certification Forum)

The EU870D product will be tested to and meet the GCF CC (Certification Criteria) requirements
in order to comply with Regional Regulatory Requirements.

Novatel Wireless will provide a full GCF declaration for the EU870D including GCF-AP Annex C,
D, E and F based on GCF-CC.

GCF Version Compliance

Commercial Release

• Release 4.0E Patch 3 GCF 3.22

Post Commercial Upgrade

• Release 4.0E Patch 4 GCF 3.23

13

13

Targeted Firmware release and GCF Compliance versions are subject to chan ge without
notice. Please contact Novatel Wireless for actual Firmware release and GCF compliance
version

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 134

PTCRB (PCS Type Certification Review Board)

The EU860D product will be compliant to PTCRB.

14

PTCRB Version Compliance

Commercial Release

• Release 4.0E Patch 3 PTCRB 3.7.1

Post Commercial Upgrade

• Release 4.0E Patch 4 PTCRB 3.9.1

14

Targeted Firmware release and PTCRB Compliance versions are subject to change without
notice. Please contact Novatel Wireless for actual Firmware release and PTCRB compliance
version

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 135

Appendix D - Carrier Accreditation and Infrastructure
IOT

Carrier Accreditation

Contact Novatel Wireless for further information and details on Carrier Accreditation.

Infrastructure IOT

Novatel Wireless works with the carriers and infrastructure vendors to complete Interoperability
testing with the PCI Express Mini Card in either lead host devices or in stand alone testing.
Contact Novatel Wireless for further information and details on Carrier Accreditation.

.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 136

Estimated Timelines for Compliance & Certification

Disclaimer

The Estimated Timelines is provided for informational purposes only
providing the Information because it may be useful. The Information is provided solely on the
basis that you will be responsible for making your own assessments of the information and are
advised to verify all representations, statements and information before using or relying upon any
of the Information. Although Novatel Wireless believes it has exercised reasonable care in
providing the Information, Novatel Wireless does not warrant the accuracy of the information and
is not responsible for any damages arising from the use of or reliance upon the information.
Novatel Wireless in no way represents that Novatel Wireless is providing the information in
accordance with any standard or service (routine, customary or otherwise) related to the
consulting, services, hardware or software industries.

. Novatel Wireless is

EV-DO FCC Accreditation

EV-DO CDG Interoperability

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 137

EV-DO Verizon Certification Process

HDSPA FCC Accreditation

HDSPA FCC Accreditation takes approximately 4 weeks until an FCC grant is issued.

Notes:

Hardware should be near final, any changes after a module pre-screen are handled as eith er

a Class I or Class II permissive change, depending on their scope.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 138

GCF Compliance Process

The EU870D product will be tested for compliance to GCF as per the applicable GCF test
criterion at the time of testing. Novatel Wireless is a current member of the GCF (Global
Certification Forum). GCF quarterly meetings are attended in order to keep appraised of new
procedures, policies and technical requirements associated with GCF termi nal certification.

GCF certification is very powerful. Because it provides for parametric as well as protocol and
field test plans, certification under this body can be highly leveraged to gain accreditation on
carrier networks. For North American, PTCRB provides similar coverage to GCF. As such,
results from either GCF or PTCRB can be leveraged to one another.

Typically 9 weeks until GCF Approval.
Spurious Emissions is required on the host laptop/handheld to achieve compliance on the

integrated system.

Notes:

GCF provides a framework to have devices accepted by most carriers in Europe.
There is a large amount of overlap with PTCRB (North American equivalent). Results from

PTCRB can be leveraged for GCF and vice versa.
Unlike PTCRB, this is voluntary. However, it is required by Vodafone.
It includes RF performance, emissions, protocol and field performance test cases. It is a kin

to the CDG Stage 1, Stage 2, & Stage 3 recommendations for CDMA.
Requires mandatory testing in at least 5 networks.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 139

PTCRB Compliance Process

The EU860D product will be tested for compliance to PTCRB as per the applicable PTCRB test
criterion at the time of testing.

North America – PTCRB (PCS Type Certification Review Board)
Novatel Wireless is a current Member of the PTCRB (PCS Type Certification Review Board).

PTCRB quarterly meetings are attended in order to keep appraised of new policies, proced ures
and technical requirements associated with GCF terminal certification. Novatel Wireless has
attained PTCRB approval with several product offerings.

Spurious Emissions & SIM electrical is required on the host laptop/handheld to achieve
compliance on the integrated system.

Notes:

North American equivalent of GCF.
This a group comprised of both Operators and Manufacturers.
The radiated emission testing is similar to the FCC requirements but not entirely identical.
This is mandatory in North America to operate GSM devices in the PCS band. There are

approximately 1,200 test cases.
Any changes (MMI, RF, Baseband, etc…), no matter how insignificant which occur after

certification, are to be reported to the PTCRB for review.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 140

CE Mark Certification Process

The CE Mark Certification process takes approximately 7 weeks until CE Mark Compliance is
complete.

Notes:

Module hardware should be final at module pre-screen. However, modifications are self

policed and are less restrictive than FCC permissive change policies.
R&TTE governs the CE initiative.
Article Definition
Article 3.1 (a) – Safety Testing (flammability, etc…)
Article 3.1 (b) – EMC testing (unintentional radiators, etc.…)
Article 3.2 – Network Testing (power, frequency stability, etc…)

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 141

Infrastructure IOT Process

A Protocol Implementation Control Statement (PICS) statement will be provided outlining the
protocol supported in Qualcomm™’s stack as integrated into EU860D and EU870D code release.
This will be used to plan IOT test cases.

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 142

Carrier Accreditation Process

The typical Carrier Accreditation roadmap is shown in the two example diagrams N.A. HSDPA
Carrier Accreditation and European HSDPA Carrier Accreditation.

Novatel Wireless works with the carriers and infrastructure vendors to complete Accreditation
Testing with the PCI Express Mini Card in either a lead device (such as a PC card or Express
card), a lead host laptop or in stand alone testing.

With the mini card or PC card validated on the network the carrier looks to the host
laptop/handheld integrator to complete incremental GCF or PTCRB testing on the
laptop/handheld.

Novatel attains GCF or PTCRB on the core PCI Express Mini-card which is the bulk of the testing
and test cases. Typically the incremental GCF or PTCRB testing on the integrated system

consists of SIM Electrical
Host integrator completes TRP/TIS measurements. These results are required to be

compliant to carrier’s TRP/TIS requirements. In some cases the carrier will have additional
requirements specific to the carrier such as incremental SAR testing.

The Carrier will require several laptops/handhelds configured with the PCI Express Mini
Card to evaluate in additional to requiring PTCRB/GCF compliance and TRP/TIS test results.

15

and Spurious Emissions.

Contact Novatel Wireless for further information and details on carrier accreditation.

Europe HSDPA Carrier Accreditation

Qualcomm
Stack

Novatel
FW

GCF

QM S/W

NW F/W

Novatel
Module

(i.e. GCF 3.22)

Carrier Accreditation

TRP/TIS
VF SAR
CE

Spurious Emissions (R&TTE)

15

SIM Electrical testing optional for GCF

Novatel Wireless Doc No. OM-01017857 Rev 1

Proprietary & Confidential 143

N.A. HSDPA Carrier Accreditation

Qualcomm
Stack

Novatel
FW

PTCRB

QM S/W

Novatel
PC Card

NW F/W

(i.e. PTCRB 3.7.1)

Novatel
Module

Carrier Accreditation

CHIP
TRP/TIS
FCC

SIM Electrical
Spurious Emissions

Carrier Certification Process

Step 1

• Initial test

lab sanity

check

Semi-Final

Hardware &

Firmware
Available

Step 2/3

• Detailed accreditation test plan

executed

• User trial executed

1-5 months 1-2 weeks

1-2 months
Laptop / Handheld
Evaluation

Hardware &

Firmware
Approval

Novatel Wireless Doc No. OM-01017857 Rev 1

Appendix E - Reference Parts Specifications

RF Connector

Hirose U.FL series, with U.FL-R-SMT receptacle mating to the following connectors illustrated.
Note that . This connector is designed for a limited number of insertions. For an embedd ed
application this is expected to be acceptable.

Figure 49: RF Connector

Mini Card Connector

Molex 67910 series, mates with the mini PCI Express Card. Use with Latch 48099-0003.

Novatel Wireless Doc No. OM-01017857 Rev 1

145

Figure 50: Mini PCI Express Connector

Novatel Wireless Confidential & Proprietary Information

Revision 1

146

Appendix G - Phoenix API Interface to PCI Express Mini
Card

Overview

This is the Phoenix API Command Set Reference for the Novatel Wireless CDMA Modem
product. This document describes the modem API used by host applications running on Windows
2000, and Windows XP.

The SDK provides universal API support for both 1XEV-DO and HSDPA mini-cards. This
provides interfaces through the Windows XP and Windows 2000 operating systems. It includes
API support as well as sample code to provide for ease of application development.

Phoenix is the brains of the SDK. Phoenix maintains a single state machine that all Clients
communicate with. Anything and everything involving communication to the device takes places
through the Phoenix server. Implemented as a Document/View executable supporting
automation, the Phoenix server automatically keeps a count of how many Clients are attached to
it via COM interfacing. The server is initialized automatically once the first Client is instantiated
and shut down once the last Client instance is terminated. With the beauty of OLE Automation,
the Phoenix server can be utilized using many different programming languages, including C++,
MFC, JavaScript, VBScript, etc. Refer to Phoenix.chm for API documentation. If you want to
use Phoenix in Visual Studio, import the type library Phoenix.tlb and create a wrapper class for it.

Blaze ActiveX control helps Client applications to receive events fired by the Phoenix server.
This allows for simple 2-way communication, replacing redundant loop checking used in the past.
Refer to Blaze.chm for API documentation. If you want to use Blaze ActiveX control in Visual
Studio, add the NVTL Blaze control from the registered Components and Controls Gallery and
create a wrapper class for it.

Phoenix API is the communication engine between host applications and a Novatel Wireless
CDMA modem. It is a DLL library that provides an interface for user/host applications to
communicate commands to the modem for purposes of serial access, general diagnostic, NV
programming, SMS messaging, and general modem functions. It provides the hardware
abstraction that the host applications don’t need to involve itself with.

The following facts and conventions are applicable across the whole document unless specially
specified.

All API calls are synchronous. The calling thread will be blocked until the function call returns.
HANDLE hCom is used in most Loader functions as the first argument. It will not be repeated

in the Parameters section for every function. The com port handle must be obtained by

calling function Open_Output_Handles( ). NULL is not a valid handle value. The handle

should be closed before applications quit.
Modem: Novatel Wireless CDMA Modem
Loader: Novatel Wireless CDMA Modem Loader API
Applications: Host applications using Loader API to access Novatel Wireless CDMA PC Card

Modem

Client Object

The Client object uses the following methods:

Novatel Wireless Confidential & Proprietary Information

Revision 1

147

ChangeLockCode method

Description: Used to change the lock code of the device.
Return Type: A Long value.

Syntax: object.ChangeLockCode(lpszLockCode As String, lpszNewLockCode As

String)

The ChangeLockCode method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.
lpszLockCode String

lpszNewLockCode String

Sample Code using ChangeLockCode Method:

long IPhoenixWrapper::ChangeLockCode(LPCTSTR lpszLockCode, LPCTSTR
lpszNewLockCode)

{
long result;
static BYTE parms[] =
VTS_BSTR VTS_BSTR;
InvokeHelper(0x18, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
lpszLockCode, lpszNewLockCode);
return result;
}

Connect method

Description: To initiate a PS or CS (if supported by device) call.
Return Type: A Long value.
Syntax:

object.Connect(lpszUsername As String, lpszPassword As String, lpszNumber As String,
varErrorMsg As Variant, nIPAddress As Long, nPrimaryDNS As Long, nSecond aryDNS As L ong,
nPrimaryWINS As Long, nSecondaryWINS As Long, nPapChap As Long, lpszVPN As String)

The Connect method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

lpszUsername String

lpszPassword String

lpszNumber String
varErrorMsg Variant

nIPAddress Long

nPrimaryDNS Long

nSecondaryDNS Long

nPrimaryWINS Long

nSecondaryWINS Long

nPapChap Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

148

lpszVPN String

Sample Code using Connect Method:

long IPhoenixWrapper::Connect(LPCTSTR lpszUsername, LPCTSTR lpszPassword, LPCTSTR
lpszNumber, VARIANT* varErrorMsg, long nIPAddress, long nPrimaryDNS, long
nSecondaryDNS, long nPrimaryWINS, long nSecondaryWINS, long nPapChap, LPCTSTR
lpszVPN)
{
long result;
static BYTE parms[] =
VTS_BSTR VTS_BSTR VTS_BSTR VTS_PVARIANT VTS_I4 VTS_I4 VTS_I4
VTS_I4 VTS_I4 VTS_I4 VTS_BSTR;
InvokeHelper(0x5, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
lpszUsername, lpszPassword, lpszNumber, varErrorMsg, nIPAddress,
nPrimaryDNS, nSecondaryDNS, nPrimaryWINS, nSecondaryWINS, nPapChap, lpszVPN);
return result;
}

DebugPrint method

Description: Used to write out to the log file.
Syntax: object.DebugPrint(nModule As Long, nLevel As Long, lpszDebug As String)

The DebugPrint method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nModule Long

nLevel Long

lpszDebug String

Sample Code using DebugPrint Method:

void IPhoenixWrapper::DebugPrint(long nModule, long nLevel, LPCTSTR lpszDebug)
{
static BYTE parms[] =
VTS_I4 VTS_I4 VTS_BSTR;
InvokeHelper(0x1e, DISPATCH_METHOD, VT_EMPTY, NULL, parms,
nModule, nLevel, lpszDebug);
}

DeleteMessage method

Description: Delete a message.
Return Type: A Long value.

Syntax: object.DeleteMessage(nMsgBoxEnum As Long, nIndex As Long)

The DeleteMessage method syntax has these parts:

Part Description

Object An expression evaluating to an object of type Client.

nMsgBoxEnum Long

nIndex Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

149

Sample Code using DeleteMessage Method:

long IphoenixWrapper::DeleteMessage(long nMsgBoxEnum, long nIndex)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_I4;
InvokeHelper(0x21, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMsgBoxEnum, nIndex);
return result;
}

Disconnect method

Description: To terminate call.
Return Type: A Long value.

Syntax: object.Disconnect

The Disconnect method syntax has these parts:

Part Description

Object An expression evaluating to an object of type Client.

Sample Code using Disconnect Method:

long IphoenixWrapper::Disconnect()
{
long result;
InvokeHelper(0x6, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

GetAdapter method

Description: Get the name of the currently selected/active device.
Return Type: A String value.

Syntax: object.GetAdapter

The GetAdapter method syntax has these parts:

Part Description

Object An expression evaluating to an object of type Client.

Sample Code using GetAdapter Method:

Cstring IphoenixWrapper::GetAdapter()
{
Cstring result;
InvokeHelper(0x1b, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetAdapterList method

Description: Get a list of currently available devices.

Novatel Wireless Confidential & Proprietary Information

Revision 1

150

Return Type: A Long value.
Syntax: object.GetAdapterList(varAdapterList As Variant)

The GetAdapterList method syntax has these parts:

Part Description

Object An expression evaluating to an object of type Client.

varAdapterList Variant

Sample Code using GetAdapterList Method:

long IphoenixWrapper::GetAdapterList(VARIANT* varAdapterList)
{
long result;
static BYTE parms[] =
VTS_PVARIANT;
InvokeHelper(0x1d, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varAdapterList);
return result;
}

GetConnectStatus method

Description: Once connected, get RAS status info of the current connection.
Return Type: A Long value.
Syntax:

object.GetConnectStatus(varState As Variant, varError As Variant, varBytesIn As Variant,
varBytesOut As Variant, varDuration As Variant)

The GetConnectStatus method syntax has these parts:

Part Description

Object An expression evaluating to an object of type Client.
varState Variant
varError Variant

varBytesIn Variant

varBytesOut Variant

varDuration Variant

Sample Code using ConnectStatus Method:

long IphoenixWrapper::GetConnectStatus(VARIANT* varState, VARIANT* varError, VARIANT*
varBytesIn, VARIANT* varBytesOut, VARIANT* varDuration)
{
long result;
static BYTE parms[] =
VTS_PVARIANT VTS_PVARIANT VTS_PVARIANT VTS_PVARIANT
VTS_PVARIANT;
InvokeHelper(0x8, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varState, varError, varBytesIn, varBytesOut, varDuration);
return result;
}

Novatel Wireless Confidential & Proprietary Information

Revision 1

151

GetContact method

Description: Get the contact’s name and details by index.
Return Type: A Long value.

Syntax: object.GetContact(nIndex As Long, varContactName As Variant,

varContactDetails As Variant)
The GetContact method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nIndex Long

varContactName Variant

varContactDetails Variant

Sample Code using GetContact Method:

long IphoenixWrapper::GetContact(long nIndex, VARIANT* varContactName, VARIANT*
varContactDetails)

{
long result;
static BYTE parms[] =
VTS_I4 VTS_PVARIANT VTS_PVARIANT;
InvokeHelper(0x28, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nIndex, varContactName, varContactDetails);
return result;
}

GetContactInfo method

Description: Get phonebook’s max size, contact name’s max length, and contact detail’s max

length.

Return Type: A Long value.
Syntax: object.GetContactInfo(varPhonebookMax As Variant, varContactNameMax As

Variant, varContactDetailsMax As Variant)
The GetContactInfo method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

varPhonebookMax Variant

varContactNameMax Variant

varContactDetailsMax Variant

Sample Code using GetContactInfo Method:

long IphoenixWrapper::GetContactInfo(VARIANT* varPhonebookMax, VARIANT*
varContactNameMax, VARIANT* varContactDetailsMax)

{
long result;
static BYTE parms[] =
VTS_PVARIANT VTS_PVARIANT VTS_PVARIANT;

Novatel Wireless Confidential & Proprietary Information

Revision 1

152

InvokeHelper(0x27, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varPhonebookMax, varContactNameMax, varContactDetailsMax);
return result;
}

GetDeviceId method

Description: Get the device ID (ESN/IMEI) of the device
Return Type: A String value.

Syntax: object.GetDeviceId

The GetDeviceId method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetDeviceID Method:

Cstring IphoenixWrapper::GetDeviceId()
{
Cstring result;
InvokeHelper(0xe, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetDeviceModel method

Description: Get the model name of the device.
Return Type: A String value.

Syntax: object.GetDeviceModel

The GetDeviceModel method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetDeviceModel Method:

Cstring IphoenixWrapper::GetDeviceModel()
{
Cstring result;
InvokeHelper(0xc, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetDeviceNetwork method

Description: Get currently attached network type.
Return Type: A String value.

Syntax: object.GetDeviceNetwork

The GetDeviceNetwork method syntax has these parts:

Part Description

Novatel Wireless Confidential & Proprietary Information

Revision 1

153

object An expression evaluating to an object of type Client.

Sample Code using GetDeviceNetwork Method:

Cstring IphoenixWrapper::GetDeviceNetwork()
{

Cstring result;
InvokeHelper(0x3, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetDeviceState method

Description: Get device state. Refer to SDK.h for possible states.
Return Type: A Long value.

Syntax: object.GetDeviceState

The GetDeviceState method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetDeviceState Method:

long IphoenixWrapper::GetDeviceState()
{
long result;
InvokeHelper(0x11, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

Possible States

typedef enum _PX_DEVICE_STATE
{
// PX_STATE_MIN = 0,
PX_STATE_UNKNOWN = 0, // State of device cannot be determined
PX_STATE_NOCARD = 1,
PX_STATE_INITIALIZING = 2,
PX_STATE_DISABLED = 3, // Disabled by Fn-F2 or user intervention
PX_STATE_LOCKED = 4,
PX_STATE_SEARCHING = 5,
PX_STATE_IDLE = 6,
PX_STATE_CONNECTING = 7,
PX_STATE_AUTHENTICATING = 8,
PX_STATE_CONNECTED = 9,
PX_STATE_NDIS = 10,

Novatel Wireless Confidential & Proprietary Information

Revision 1

154

PX_STATE_SHUTDOWN = 11,
PX_STATE_STANDBY = 12,
// PX_STATE_MAX
}PX_DEVICE_STATE;

// States that all public SMS functions will return
typedef enum {
SMS_STATE_EMPTY = 60000,
SMS_STATE_UNREAD,
SMS_STATE_UNREAD_PRIORITY,
SMS_STATE_READ,
SMS_STATE_FORWARDED,
SMS_STATE_REPLIED,
SMS_STATE_SENDING,
SMS_STATE_SENT,
SMS_STATE_DELIVERED,
SMS_STATE_FAILED_SEND
} SMSMessageState;

typedef enum {
SMSInbox,
SMSOutbox,
SMSSentbox,
SMSSIM
} SMSBoxEnum;

GetDeviceTechnology method

Description: Get device technology defined by NovatelModemAPI.h.
Return Type: A Long value.

Syntax: object.GetDeviceTechnology

The GetDeviceTechnology method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Novatel Wireless Confidential & Proprietary Information

Revision 1

155

Sample Code using GetDeviceTechnology Method:

long IphoenixWrapper::GetDeviceTechnology()
{
long result;
InvokeHelper(0x2, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

GetFID method

Description: Get the FID of the device. (CDMA/EVDO Only)
Return Type: A String value.

Syntax: object.GetFID

The GetFID method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetFID Method:

Cstring IphoenixWrapper::GetFID()
{
Cstring result;
InvokeHelper(0x10, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetHardwareVersion method

Description: Get the hardware version of the device
Return Type: A String value.

Syntax: object.GetHardwareVersion

The GetHardwareVersion method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetHardwareVersion Method:

Cstring IphoenixWrapper::GetHardwareVersion()
{
Cstring result;
InvokeHelper(0xb, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetLockStatus method

Description: Determine whether the device is locked, including autolock setting.
Return Type: A Long value.

Syntax: object.GetLockStatus(varLockStatus As Variant, varAutoLockOn As Variant)

Novatel Wireless Confidential & Proprietary Information

Revision 1

156

The GetLockStatus method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

varLockStatus Variant

varAutoLockOn Variant

Sample Code using GetLockStatus Method:

long IphoenixWrapper::GetLockStatus(VARIANT* varLockStatus, VARIANT* varAutoLockOn)
{
long result;
static BYTE parms[] =
VTS_PVARIANT VTS_PVARIANT;
InvokeHelper(0x17, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varLockStatus, varAutoLockOn);
return result;
}

GetMessage method

Description: Retrieve message given which message box and an index.
Return Type: A Long value.

Syntax: object.GetMessage(nMsgBoxEnum As Long, nIndex As Long, varState As

Variant, varMsg As Variant, nMsgSize As Long)
The GetMessage method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nMsgBoxEnum Long

nIndex Long
varState Variant

varMsg Variant

nMsgSize Long

Sample Code using GetMessage Method:

long IphoenixWrapper::GetMessage(long nMsgBoxEnum, long nIndex, VARIANT* varState,
VARIANT* varMsg, long nMsgSize)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_I4 VTS_PVARIANT VTS_PVARIANT VTS_I4;
InvokeHelper(0x20, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMsgBoxEnum, nIndex, varState, varMsg, nMsgSize);
return result;
}

GetMessageCount method

Description: Get current count given which message box.

Novatel Wireless Confidential & Proprietary Information

Revision 1

157

Return Type: A Long value.
Syntax: object.GetMessageCount(nMsgBoxEnum As Long)

The GetMessageCount method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nMsgBoxEnum Long

Sample Code using GetMessageCount Method:

long IphoenixWrapper::GetMessageCount(long nMsgBoxEnum)
{
long result;
static BYTE parms[] =
VTS_I4;
InvokeHelper(0x24, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMsgBoxEnum);
return result;
}

GetMessageStatus method

Description: Get a message status. Refer to SDK.h for possible states.
Return Type: A Long value.

Syntax: object.GetMessageStatus(nMsgBoxEnum As Long, nIndex As Long, varState

As Variant)
The GetMessageStatus method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nMsgBoxEnum Long

nIndex Long
varState Variant

Sample Code using GetMessageStatus Method:

long IphoenixWrapper::GetMessageStatus(long nMsgBoxEnum, long nIndex, VARIANT*
varState)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_I4 VTS_PVARIANT;
InvokeHelper(0x22, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMsgBoxEnum, nIndex, varState);
return result;
}

GetMobileNumber method

Description: Get the mobile number (MDN) of the device.
Return Type: A String value.

Syntax: object.GetMobileNumber

Novatel Wireless Confidential & Proprietary Information

Revision 1

158

The GetMobileNumber method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GeMobileNumber Method:

Cstring IphoenixWrapper::GetMobileNumber()
{
Cstring result;
InvokeHelper(0xd, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetNetworkOperatorList method

Description: Get a list of operators. (UMTS/HSDPA Only)
Return Type: A Long value.

Syntax: object.GetNetworkOperatorList(varOperatorList As Variant)

The GetNetworkOperatorList method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

varOperatorList Variant

Sample Code using GetNetworkOperatorList Method:

long IPhoenixWrapper::GetNetworkOperatorList(VARIANT* varOperatorList)
{
long result;
static BYTE parms[] =
VTS_PVARIANT;
InvokeHelper(0x1a, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varOperatorList);
return result;
}

GetNetworkPreference method

Description: Get network mode: RAT_MODE_AUTO (0), RAT_MODE_GSM (1),

RAT_MODE_WCDMA (2) (UMTS/HSDPA Only)

Return Type: A Long value.
Syntax: object.GetNetworkPreference(varMode As Variant)

The GetNetworkPreference method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Novatel Wireless Confidential & Proprietary Information

Revision 1

159

varMode Variant

Sample Code using GetNetworkPreference Method:

long IPhoenixWrapper::GetNetworkPreference(VARIANT* varMode)
{
long result;
static BYTE parms[] =
VTS_PVARIANT;
InvokeHelper(0x2d, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varMode);
return result;
}

GetNewMessageCount method

Description: Get new message count.
Return Type: A Long value.

Syntax: object.GetNewMessageCount

The GetNewMessageCount method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetNewMessageCount Method:

long IPhoenixWrapper::GetNewMessageCount()
{
long result;
InvokeHelper(0x1f, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

GetOSVersionInfo method

Description: Get the OS versioning info.
Return Type: A Long value.

Syntax: object.GetOSVersionInfo(varMajorVersion As Variant, varMinorVersion As

Variant, varCSDVersion As Variant)
The GetOSVersionInfo method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.
varMajorVersion Variant
varMinorVersion Variant

varCSDVersion Variant

Novatel Wireless Confidential & Proprietary Information

Revision 1

160

Sample Code using GetOSVersionInfo Method:

long IPhoenixWrapper::GetOSVersionInfo(VARIANT* varMajorVersion, VARIANT*
varMinorVersion, VARIANT* varCSDVersion)
{
long result;
static BYTE parms[] =
VTS_PVARIANT VTS_PVARIANT VTS_PVARIANT;
InvokeHelper(0x9, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varMajorVersion, varMinorVersion, varCSDVersion);
return result;
}

CString IPhoenixWrapper::GetSoftwareVersion()
{
CString result;
InvokeHelper(0xa, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

GetPRLVersion method

Description: Get the PRL version of the device. (CDMA/EVDO Only)
Return Type: A String value.

Syntax: object.GetPRLVersion

The GetPRLVersion method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code:

CString IphoenixWrapper::GetPRLVersion()
{

Cstring result;
InvokeHelper(0xf, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;

GetRasErrorString method

Description: Pass a RAS error code and get a RAS error string.
Return Type: A String value.

Syntax: object.GetRasErrorString(nErrorCode As Long)

The GetRasErrorString method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nErrorCode Long

Sample Code using GetRasErrorString Method:

CString IPhoenixWrapper::GetRasErrorString(long nErrorCode)

Novatel Wireless Confidential & Proprietary Information

Revision 1

161

{
CString result;
static BYTE parms[] =
VTS_I4;
InvokeHelper(0x1, DISPATCH_METHOD, VT_BSTR, (void*)&result, parms,
nErrorCode);
return result;
}

GetSigStr method

Description: Get Signal Strength. Values: 0 – 5
Return Type: A Long value.

Syntax: object.GetSigStr

The GetSigStr method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetSigStr Method:

long IPhoenixWrapper::GetSigStr()
{
long result;
InvokeHelper(0x4, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

GetSoftwareVersion method

Description: Get the software (firmware) version of the device.
Return Type: A String value.

Syntax: object.GetSoftwareVersion

The GetSoftwareVersion method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using GetSoftwareVersion Method:

CString IPhoenixWrapper::GetSoftwareVersion()
{
CString result;
InvokeHelper(0xa, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
}

Novatel Wireless Confidential & Proprietary Information

Revision 1

162

IsDormant method

Description: Determine whether the device is currently dormant.
Return Type: A Long value.

Syntax: object.IsDormant

The IsDormant method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using IsDormat Method:

long IPhoenixWrapper::IsDormant()
{
long result;
InvokeHelper(0x14, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

IsMessageMemoryFull method

Description: Check to see if the message box memory is full.
Return Type: A Long value.

Syntax: object.IsMessageMemoryFull

The IsMessageMemoryFull method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using IsMessageMemoryFull Method:

long IPhoenixWrapper::IsMessageMemoryFull()
{
long result;
InvokeHelper(0x26, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

IsRoaming method

Description: Determine whether the device is currently roaming.
Return Type: A Long value.

Syntax: object.IsRoaming

The IsRoaming method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Novatel Wireless Confidential & Proprietary Information

Revision 1

163

Sample Code using IsRoaming Method:

long IPhoenixWrapper::IsRoaming()
{
long result;
InvokeHelper(0x13, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

SendMessage method

Description: To send a message.
Return Type: A Long value.

Syntax: object.SendMessage(varMsg As Variant, nMsgSize As Long, varMsgIndex As

Variant)
The SendMessage method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

varMsg Variant

nMsgSize Long

varMsgIndex Variant

Sample Code using SendMessage Method:

long IPhoenixWrapper::SendMessage(VARIANT* varMsg, long nMsgSize, VARIANT*
varMsgIndex)
{
long result;
static BYTE parms[] =
VTS_PVARIANT VTS_I4 VTS_PVARIANT;
InvokeHelper(0x25, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
varMsg, nMsgSize, varMsgIndex);
return result;
}

SetAdapter method

Description: To select a new active device.
Syntax: object.SetAdapter(lpszAdapter As String)

The SetAdapter method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

lpszAdapter String

Sample Code using SetAdapter Method:

void IPhoenixWrapper::SetAdapter(LPCTSTR lpszAdapter)
{
static BYTE parms[] =
VTS_BSTR;

Novatel Wireless Confidential & Proprietary Information

Revision 1

164

InvokeHelper(0x1c, DISPATCH_METHOD, VT_EMPTY, NULL, parms,
lpszAdapter);
}

SetAutoLock method

Description: To turn ON or OFF the autolock setting.
Return Type: A Long value.

Syntax: object.SetAutoLock(nAutoOn As Long, lpszLockCode As String)

The SetAutoLock method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nAutoOn Long

lpszLockCode String

Sample Code using SetAutoLock Method:

long IPhoenixWrapper::SetAutoLock(long nAutoOn, LPCTSTR lpszLockCode)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_BSTR;
InvokeHelper(0x16, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nAutoOn, lpszLockCode);
return result;
}

SetCallSettings method

Description: Set the call settings, including quality of service settings. (UMTS/HSDPA Only)
Return Type: A Long value.

Syntax: object.SetCallSettings(nPDPType As Long, lpszAPN As String, nPDPAddress

As
Long, lpdQoS As Object)

The SetCallSettings method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nPDPType Long

lpszAPN String

nPDPAddress Long

lpdQoS Object

Sample Code using SetCallSettings Method:

long IPhoenixWrapper::SetCallSettings(long nPDPType, LPCTSTR lpszAPN, long nPDPAddress,
LPDISPATCH lpdQoS)
{
long result;
static BYTE parms[] =

Novatel Wireless Confidential & Proprietary Information

Revision 1

165

VTS_I4 VTS_BSTR VTS_I4 VTS_DISPATCH;
InvokeHelper(0x12, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nPDPType, lpszAPN, nPDPAddress, lpdQoS);
return result;
}

SetContact method

Description: Set the contact’s name and details by index.
Return Type: A Long value.

Syntax: object.SetContact(nIndex As Long, lpszContactName As String,

lpszContactDetails As String)
The SetContact method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nIndex Long

lpszContactName String

lpszContactDetails String

Sample Code using SetContact Method:

long IPhoenixWrapper::SetContact(long nIndex, LPCTSTR lpszContactName, LPCTSTR
lpszContactDetails)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_BSTR VTS_BSTR;
InvokeHelper(0x29, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nIndex, lpszContactName, lpszContactDetails);
return result;
}

SetMessageStatus method

Description: Set the state of a message.
Return Type: A Long value.
Syntax:

object.SetMessageStatus(nMsgBoxEnum As Long, nIndex As Long, nState As Long)
The SetMessageStatus method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nMsgBoxEnum Long

nIndex Long
nState Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

166

Sample Code using SetMessageStatus Method:

long IPhoenixWrapper::SetMessageStatus(long nMsgBoxEnum, long nIndex, long nState)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_I4 VTS_I4;
InvokeHelper(0x23, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMsgBoxEnum, nIndex, nState);
return result;
}

SetNetworkOperator method

Description: To set the network operator provided by GetNetworkOperatorList. (UMTS/HSDPA

Only)

Return Type: A Long value.
Syntax: object.SetNetworkOperator(nMode As Long, nFormat As Long, lpszOperator

As String)
The SetNetworkOperator method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nMode Long

nFormat Long

lpszOperator String

Sample Code using SetNeworkOperator Method:

long IPhoenixWrapper::SetNetworkOperator(long nMode, long nFormat, LPCTSTR lpszOperator)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_I4 VTS_BSTR;
InvokeHelper(0x19, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMode, nFormat, lpszOperator);
return result;
}

SetNetworkPreference method

Description: Set network mode: RAT_MODE_AUTO (0), RAT_MODE_GSM (1),

RAT_MODE_WCDMA (2) (UMTS/HSDPA Only)

Return Type: A Long value.
Syntax: object.SetNetworkPreference(nMode As Long)

The SetNetworkPreference method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Novatel Wireless Confidential & Proprietary Information

Revision 1

167

nMode Long

Sample Code using SetNetworkPreference Method:

long IPhoenixWrapper::SetNetworkPreference(long nMode)
{
long result;
static BYTE parms[] =
VTS_I4;
InvokeHelper(0x2c, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nMode);
return result;
}

SetProxy method

Description: Set proxy settings given a proxy IP address and port.
Return Type: A Long value.

Syntax: object.SetProxy(nProxy As Long, nPort As Long)

The SetProxy method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nProxy Long

nPort Long

Sample Code using SetProxy Method:

long IPhoenixWrapper::SetProxy(long nProxy, long nPort)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_I4;
InvokeHelper(0x7, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
nProxy, nPort);
return result;
}

SetSMSC method

Description: Setting the SMSC is required for proper SMS functionality
Return Type: A Long value.

Syntax: object.SetSMSC(lpszSMSC As String)

The SetSMSC method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

lpszSMSC String

Novatel Wireless Confidential & Proprietary Information

Revision 1

168

Sample Code using SetSMSC Method:

long IPhoenixWrapper::SetSMSC(LPCTSTR lpszSMSC)
{
long result;
static BYTE parms[] =
VTS_BSTR;
InvokeHelper(0x2a, DISPATCH_METHOD, VT_I4, (void*)&result, parms,
lpszSMSC);
return result;
}

Shutdown method

Description: A means of synchronously shutting down the device.
Return Type: A Long value.

Syntax: object.Shutdown

The Shutdown method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

Sample Code using Shutdown Method:

long IPhoenixWrapper::Shutdown()
{
long result;
InvokeHelper(0x2b, DISPATCH_METHOD, VT_I4, (void*)&result, NULL);
return result;
}

Unlock method

Description: To unlock the device. Refer to NovatelModemAPI.h for possible lock types.
Return Type: A Long value.

Syntax: object.Unlock(nLockType As Long, lpszLockCode As String)

The Unlock method syntax has these parts:

Part Description

object An expression evaluating to an object of type Client.

nLockType Long

lpszLockCode String

Sample Code using Unlock Method:

long IPhoenixWrapper::Unlock(long nLockType, LPCTSTR lpszLockCode)
{
long result;
static BYTE parms[] =
VTS_I4 VTS_BSTR;
InvokeHelper(0x15, DISPATCH_METHOD, VT_I4, (void*)&result, parms,

Novatel Wireless Confidential & Proprietary Information

Revision 1

169

nLockType, lpszLockCode);
return result;
}

IEventPhoenixNotifySink object

The following section lists the event interface for Phoenix Clients. This is used for receiving server
events for two-way communication. The IEventPhoenixNotifiy Sink object uses the following
methods:

FireEventDeviceState method

Description: Event fired when the device state changes. Refer to SDK.h for possible states.
Syntax: object.FireEventDeviceState(nState As Long)

The FireEventDeviceState method syntax has these parts:

Part Description

object An expression evaluating to an object of type IeventPhoenixNotifySink.

nState Long

FireEventDormant method

Description: Event fired when service is dormant. Values: 0 or 1
Syntax: object.FireEventDormant(nStatus As Long)

The FireEventDormant method syntax has these parts:

Part Description

object An expression evaluating to an object of type IEventPhoenixNotifySink.

nStatus Long

FireEventIncomingCall method

Description: Event fired when receiving an incoming call.
Syntax: object.FireEventIncomingCall(nStatus As Long)

The FireEventIncomingCall method syntax has these parts:

Part Description

object An expression evaluating to an object of type IEventPhoenixNotifySink.

nStatus Long

FireEventNetwork method

Description: Event fired when network service changes.
Syntax: object.FireEventNetwork(nStatus As Long)

The FireEventNetwork method syntax has these parts:

Novatel Wireless Confidential & Proprietary Information

Revision 1

170

Part Description

object An expression evaluating to an object of type IEventPhoenixNotifySink.

nStatus Long

FireEventRoaming method

Description: Event fired when service is roaming. Values: 0 or 1
Syntax: object.FireEventRoaming(nRoaming As Long)

The FireEventRoaming method syntax has these parts:

Part Description

object An expression evaluating to an object of type IEventPhoenixNotifySink.

nRoaming Long

FireEventSigStr method

Description: Event fired when the signal strength changes. Values: 0 - 5
Syntax:

object.FireEventSigStr(nSigStr As Long)
The FireEventSigStr method syntax has these parts:

Part Description

object An expression evaluating to an object of type IEventPhoenixNotifySink.

nSigStr Long

FireEventSMSStatus method

Description: Event fired when new SMS messages are available. Values: 0 or 1
Syntax: object.FireEventSMSStatus(nStatus As Long)

The FireEventSMSStatus method syntax has these parts:

Part Description

object An expression evaluating to an object of type IEventPhoenixNotifySink.

nStatus Long

QoS object

NVTL QoS Class used to set Quality of Service call settings. The QoS object uses the following
properties:

deliveryofSDUError property

Description: property deliveryofSDUError

Novatel Wireless Confidential & Proprietary Information

Revision 1

171

Property type: A Long value.
Syntax: object.deliveryofSDUError [= value]

The deliveryofSDUError property syntax has these parts:

Part Description

object An expression evaluating to an object of type Qos.

value A Long value.

deliveryOrder property

Description: property deliveryOrder
Property type: A Long value.

Syntax: object.deliveryOrder [= value]

The deliveryOrder property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

guarBitDL property

Description: property guarBitDL
Property type: A Long value.

Syntax:

object.guarBitDL [= value]
The guarBitDL property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

guarBitUL property

Description: property guarBitUL
Property type: A Long value.

Syntax: object.guarBitUL [= value]

The guarBitUL property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

maxBitDL property

Description: property maxBitDL

Novatel Wireless Confidential & Proprietary Information

Revision 1

172

Property type: A Long value.
Syntax: object.maxBitDL [= value]

The maxBitDL property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

maxBitUL property

Description: property maxBitUL
Property type: A Long value.

Syntax: object.maxBitUL [= value]

The maxBitUL property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

maxSDUSize property

Description: property maxSDUSize
Property type: A Long value.

Syntax: object.maxSDUSize [= value]

The maxSDUSize property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

ResBitErrorRatio property

Description: property ResBitErrorRatio
Property type: A String value.

Syntax: object.ResBitErrorRatio [= value]

The ResBitErrorRatio property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A String value.

Novatel Wireless Confidential & Proprietary Information

Revision 1

173

SDUErrorRatio property

Description: property SDUErrorRatio
Property type: A String value.

Syntax: object.SDUErrorRatio [= value]

The SDUErrorRatio property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A String value.

trafficClass property

Description: property trafficClass
Property type: A Long value.

Syntax:

object.trafficClass [= value]
The trafficClass property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

trafficHandling property

Description: property trafficHandling
Property type: A Long value.

Syntax: object.trafficHandling [= value]

The trafficHandling property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

transferDelay property

Description: property transferDelay
Property type: A Long value.

Syntax: object.transferDelay [= value]

The transferDelay property syntax has these parts:

Part Description

Object An expression evaluating to an object of type Qos.

Value A Long value.

Novatel Wireless Confidential & Proprietary Information

Revision 1

174

Blaze object

NVTL Blaze ActiveX Control module uses the following events and methods:

EventDeviceState event

Syntax
Sub object_EventDeviceState(nVal As Long)

The EventDeviceState event syntax has these named arguments:

Description

Part

nVal Long

EventDormant event

Syntax
Sub object_EventDormant(nVal As Long)

The EventDormant event syntax has these named arguments:

Part

Description

nVal Long

EventIncomingCall event

Syntax
Sub object_EventIncomingCall(nVal As Long)

The EventIncomingCall event syntax has these named arguments:

Part

Description

nVal Long

EventNetwork event

Syntax
Sub object_EventNetwork(nVal As Long)

The EventNetwork event syntax has these named arguments:

Description

Part

nVal Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

175

EventRoaming event

Syntax
Sub object_EventRoaming(nVal As Long)

The EventRoaming event syntax has these named arguments:

Part

Description

nVal Long

EventSigStr event

Syntax
Sub object_EventSigStr(nVal As Long)

The EventSigStr event syntax has these named arguments:

Part

Description

nVal Long

EventSMSStatus event

Syntax
Sub object_EventSMSStatus(nVal As Long)

The EventSMSStatus event syntax has these named arguments:

Part

Description

nVal Long

Attach method

Syntax
object.Attach

The Attach method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type Blaze.

Detach method

Syntax
object.Detach

The Detach method syntax has these parts:

Novatel Wireless Confidential & Proprietary Information

Revision 1

176

Part Description

object

An expression evaluating to an object of type Blaze.

Hotspots object

NVTL Hotspots ActiveX Control Module uses the following methods:

AboutBox method

Syntax
object.AboutBox

The AboutBox method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type Hotspots.

Init method

Initializes Hotspot dialog.
Return Type
A Long value.
Syntax
object.Init

The Init method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type Hotspots.

ViewHotspots method

Shows Hotspot dialog.
Return Type
A Long value.
Syntax
object.ViewHotspots

The ViewHotspots method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type Hotspots.

177

Menu object

NVTL Menu Control uses the following methods:

Init method

Initializes language and reporting support.
Return Type
A Long value.
Syntax
object.Init

The Init method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type Menu.

ShowAbout method

Shows the About dialog.
Return Type
A Long value.
Syntax
object.ShowAbout

The ShowAbout method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type Menu.

ShowActivation method

Shows Activation Wizard.
Return Type
A Long value.
Syntax
object.ShowActivation

The ShowActivation method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Menu.

ShowConfig method

Shows the Configuration dialog. Contents change depending on device technology.
Return Type
A Long value.

Novatel Wireless Confidential & Proprietary Information

Revision 1

178

Syntax
object.ShowConfig

The ShowConfig method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Menu.

ShowDebug method

Shows Debug info dialog.
Return Type
A Long value.
Syntax
object.ShowDebug

The ShowDebug method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Menu.

ShowProp method

Shows the Properties dialog. Contents change depending on device technology.
Return Type
A Long value.
Syntax
object.ShowProp

The ShowProp method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Menu.

ShowReport method

Shows Report dialog. Captures connection statistics and logs all sessions.
Return Type
A Long value.
Syntax
object.ShowReport

The ShowReport method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type Menu.

179

ShowUnlock method

Shows the unlock SIM dialog. Used for PIN, PUK, and network locks.
Return Type
A Long value.
Syntax
object.ShowUnlock

The ShowUnlock method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Menu.

Language object

NVTL Language object is contained in the UtilitiesLib ActiveX Control Module. The Language
Control uses the following methods:

GetLanguageCount method

Returns a total count of all supported languages.
Return Type
A Long value.
Syntax
object.GetLanguageCount

The GetLanguageCount method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Language.

GetLanguageIndex method

Returns the language index defined by standards.
Return Type
A Long value.
Syntax
object.GetLanguageIndex(nIndex As Long)

The GetLanguageIndex method syntax has these parts:

Description

Part

object

nIndex Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type Language.

180

GetString method

Given a string id, returns the string in the currently selected language.
Return Type
A String value.
Syntax
object.GetString(lStringId As Long)

The GetString method syntax has these parts:

Part

Description

object

lStringId Long

An expression evaluating to an object of type Language.

GetStringTableCount method

Returns a total count of all strings per language.
Return Type
A Long value.
Syntax
object.GetStringTableCount

The GetStringTableCount method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type Language.

Init method

Initializes objects and parses all language xml files.
Return Type
A Long value.
Syntax
object.Init(lpszFilePath As String)

The Init method syntax has these parts:

Description

Part

object

lpszFilePath String

An expression evaluating to an object of type Language.

ProfileManager object

NVTL ProfileManager Object is contatined in the ProfileManager ActiveX Control. The
ProfileManager Control uses the following methods:

Novatel Wireless Confidential & Proprietary Information

Revision 1

181

AboutBox method

Syntax
object.AboutBox

The AboutBox method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type ProfileManager.

CreateProfile method

Shows Profile Wizard given a technology.
Return Type
A Long value.
Syntax
object.CreateProfile(Technology As Long)

The CreateProfile method syntax has these parts:

Description

Part

object

Technology Long

An expression evaluating to an object of type ProfileManager.

GetDefaultProfileName method

Gets the default profile name given a technology.
Return Type
A String value.
Syntax
object.GetDefaultProfileName(Technology As Long)

The GetDefaultProfileName method syntax has these parts:

Description

Part

object

Technology Long

An expression evaluating to an object of type ProfileManager.

GetProfile method

Gets a profile. Pass in object of type. Profile.
Return Type
A Long value.
Syntax
object.GetProfile(ProfileName As String, Technology As Long, Profile As Object)

The GetProfile method syntax has these parts:

Novatel Wireless Confidential & Proprietary Information

Revision 1

182

Part Description

object

ProfileName String

Technology Long

Profile Object

An expression evaluating to an object of type ProfileManager.

GetProfileNameList method

Retrieves a list of profile names given a technology.
Return Type
A Long value.
Syntax
object.GetProfileNameList(varNameList As Variant, Technology As Long)

The GetProfileNameList method syntax has these parts:

Description

Part

object

varNameList Variant

Technology Long

An expression evaluating to an object of type ProfileManager.

Init method

Initializes language support and profile database.
Return Type
A Long value.
Syntax
object.Init(ProfilePath As String)

The Init method syntax has these parts:

Description

Part

object

ProfilePath String

An expression evaluating to an object of type ProfileManager.

SetDefaultProfile method

Sets the default profile for a given technology.
Return Type
A Long value.
Syntax
object.SetDefaultProfile(ProfileName As String, Technology As Long)

Novatel Wireless Confidential & Proprietary Information

Revision 1

183

The SetDefaultProfile method syntax has these parts:

Description

Part

object

ProfileName String

Technology Long

An expression evaluating to an object of type ProfileManager.

ShowProfileList method

Shows the Profile list dialog which includes Mobile, WiFi, and Ethernet.
Return Type
A Long value.
Syntax
object.ShowProfileList(Technology As Long)

The ShowProfileList method syntax has these parts:

Part

Description

object

Technology Long

An expression evaluating to an object of type ProfileManager.

Profile object

NVTL Profile Object is contatined in the ProfileManager ActiveX Control. The Profile Class has
the following properties:

APN property

property APN
Property type
A String value.
Syntax
object.APN [= value]

The APN property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

A String value.

AuthenticationType property

property AuthenticationType

Novatel Wireless Confidential & Proprietary Information

Revision 1

184

Property type
A Long value.
Syntax
object.AuthenticationType [= value]

The AuthenticationType property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

CarrierName property

property CarrierName
Property type
A String value.
Syntax
object.CarrierName [= value]

The CarrierName property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

ConnectType property

property ConnectType
Property type
A Long value.
Syntax
object.ConnectType [= value]

The ConnectType property syntax has these parts:

A Long value.

A String value.

Description

Part

object

value

An expression evaluating to an object of type Profile.

A Long value.

DataSpeed property

property DataSpeed
Property type
A Long value.
Syntax
object.DataSpeed [= value]

Novatel Wireless Confidential & Proprietary Information

Revision 1

185

The DataSpeed property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

A Long value.

DefaultGateway property

property DefaultGateway
Property type
A Long value.
Syntax
object.DefaultGateway [= value]

The DefaultGateway property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

A Long value.

DeliveryofSDUError property

property DeliveryofSDUError
Property type
A Long value.
Syntax
object.DeliveryofSDUError [= value]

The DeliveryofSDUError property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

A Long value.

DeliveryOrder property

property DeliveryOrder
Property type
A Long value.
Syntax
object.DeliveryOrder [= value]

The DeliveryOrder property syntax has these parts:

Part

Description

Novatel Wireless Confidential & Proprietary Information

Revision 1

186

object

value

An expression evaluating to an object of type Profile.

DialString property

property DialString
Property type
A String value.
Syntax
object.DialString [= value]

The DialString property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

Fallback2GProfile property

A Long value.

A String value.

property Fallback2GProfile
Property type
A String value.
Syntax
object.Fallback2GProfile [= value]

The Fallback2GProfile property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

A String value.

IPAddress property

property IPAddress
Property type
A Long value.
Syntax
object.IPAddress [= value]

The IPAddress property syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type Profile.

187

value

MaxSDUSize property

property MaxSDUSize
Property type
A Long value.
Syntax
object.MaxSDUSize [= value]

The MaxSDUSize property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

Password property

property Password
Property type
A String value.
Syntax
object.Password [= value]

The Password property syntax has these parts:

A Long value.

A Long value.

Description

Part

object

value

An expression evaluating to an object of type Profile.

PDPAddress property

property PDPAddress
Property type
A Long value.
Syntax
object.PDPAddress [= value]

The PDPAddress property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

A String value.

A Long value.

Novatel Wireless Confidential & Proprietary Information

Revision 1

188

PDPType property

property PDPType
Property type
A Long value.
Syntax
object.PDPType [= value]

The PDPType property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

PrimaryDNS property

property PrimaryDNS
Property type
A Long value.
Syntax
object.PrimaryDNS [= value]

The PrimaryDNS property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

PrimaryWINS property

property PrimaryWINS
Property type
A Long value.
Syntax
object.PrimaryWINS [= value]

The PrimaryWINS property syntax has these parts:

A Long value.

A Long value.

Part

Description

object

value

An expression evaluating to an object of type Profile.

A Long value.

ProfileName property

property ProfileName
Property type

Novatel Wireless Confidential & Proprietary Information

Revision 1

189

A String value.
Syntax
object.ProfileName [= value]

The ProfileName property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

ProxyAddress property

property ProxyAddress
Property type
A Long value.
Syntax
object.ProxyAddress [= value]

The ProxyAddress property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

ProxyPort property

property ProxyPort
Property type
A Long value.
Syntax
object.ProxyPort [= value]

The ProxyPort property syntax has these parts:

A String value.

A Long value.

Part

Description

object

value

An expression evaluating to an object of type Profile.

A Long value.

ResErrorRatio property

property ResErrorRatio
Property type
A String value.
Syntax
object.ResErrorRatio [= value]

Novatel Wireless Confidential & Proprietary Information

Revision 1

190

The ResErrorRatio property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

SDUErrorRatio property

property SDUErrorRatio
Property type
A String value.
Syntax
object.SDUErrorRatio [= value]

The SDUErrorRatio property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

SecondaryDNS property

property SecondaryDNS
Property type
A Long value.
Syntax
object.SecondaryDNS [= value]

The SecondaryDNS property syntax has these parts:

A String value.

A String value.

Part

Description

object

value

An expression evaluating to an object of type Profile.

A Long value.

SecondaryWINS property

property SecondaryWINS
Property type
A Long value.
Syntax
object.SecondaryWINS [= value]

The SecondaryWINS property syntax has these parts:

Part

Description

Novatel Wireless Confidential & Proprietary Information

Revision 1

191

object

value

An expression evaluating to an object of type Profile.

SetProxy property

property SetProxy
Property type
A Long value.
Syntax
object.SetProxy [= value]

The SetProxy property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

SMSC property

property SMSC
Property type
A String value.
Syntax
object.SMSC [= value]

The SMSC property syntax has these parts:

A Long value.

A Long value.

Part

Description

object

value

An expression evaluating to an object of type Profile.

A String value.

SMSEmailNumber property

property SMSEmailNumber
Property type
A String value.
Syntax
object.SMSEmailNumber [= value]

The SMSEmailNumber property syntax has these parts:

Description

Part

object

value

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type Profile.

A String value.

192

StaticIP property

property StaticIP
Property type
A Long value.
Syntax
object.StaticIP [= value]

The StaticIP property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

SubnetMask property

property SubnetMask
Property type
A Long value.
Syntax
object.SubnetMask [= value]

The SubnetMask property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

Technology property

property Technology
Property type
A Long value.
Syntax
object.Technology [= value]

The Technology property syntax has these parts:

A Long value.

A Long value.

Description

Part

object

value

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type Profile.

A Long value.

193

TrafficClass property

property TrafficClass
Property type
A Long value.
Syntax
object.TrafficClass [= value]

The TrafficClass property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

TrafficHandling property

property TrafficHandling
Property type
A Long value.
Syntax
object.TrafficHandling [= value]

The TrafficHandling property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

TransferDelay property

property TransferDelay
Property type
A Long value.
Syntax
object.TransferDelay [= value]

The TransferDelay property syntax has these parts:

A Long value.

A Long value.

Part

Description

object

value

An expression evaluating to an object of type Profile.

A Long value.

UseDNS property

property UseDNS
Property type

Novatel Wireless Confidential & Proprietary Information

Revision 1

194

A Long value.
Syntax
object.UseDNS [= value]

The UseDNS property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

Username property

property Username
Property type
A String value.
Syntax
object.Username [= value]

The Username property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

UseVPN property

property UseVPN
Property type
A Long value.
Syntax
object.UseVPN [= value]

The UseVPN property syntax has these parts:

A Long value.

A String value.

Part

Description

object

value

An expression evaluating to an object of type Profile.

A Long value.

UseWINS property

property UseWINS
Property type
A Long value.
Syntax
object.UseWINS [= value]

Novatel Wireless Confidential & Proprietary Information

Revision 1

195

The UseWINS property syntax has these parts:

Part

Description

object

value

An expression evaluating to an object of type Profile.

VPNEntryName property

property VPNEntryName
Property type
A String value.
Syntax
object.VPNEntryName [= value]

The VPNEntryName property syntax has these parts:

Description

Part

object

value

An expression evaluating to an object of type Profile.

NetMonkey Lib objects

A Long value.

A String value.

NVTL NetMonkey ActiveX Control Module Objects use the following events:

EventAdapterFound event

Event fired when interface detection state changes.

Syntax
Sub object_EventAdapterFound

EventAdapterUpdate event

Event fired when interface updated values are available.

Syntax
Sub object_EventAdapterUpdate

LAN object

NVTL LAN Object is contained in the NetMonkey ActiveX Control Module. The LAN Control uses
the following methods:

GetAdapter method

Gets the currently selected interface from registry.
Return Type

Novatel Wireless Confidential & Proprietary Information

Revision 1

196

A String value.
Syntax
object.GetAdapter

The GetAdapter method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type LAN.

GetAdapterList method

Gets a list of LAN interfaces available.
Return Type
A Long value.
Syntax
object.GetAdapterList(varAdapterList As Variant)

The GetAdapterList method syntax has these parts:

Part

Description

object

varAdapterList Variant

An expression evaluating to an object of type LAN.

GetBytesIn method

Gets the number of bytes received.
Return Type
A Long value.
Syntax
object.GetBytesIn

The GetBytesIn method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type LAN.

GetBytesOut method

Gets the number of bytes sent.
Return Type
A Long value.
Syntax
object.GetBytesOut

The GetBytesOut method syntax has these parts:

Description

Part

Novatel Wireless Confidential & Proprietary Information

Revision 1

197

object

An expression evaluating to an object of type LAN.

GetConnectState method

Gets the interface connection status.
Return Type
A Long value.
Syntax
object.GetConnectState

The GetConnectState method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type LAN.

GetDefaultGateway method

Gets the current default gateway.
Return Type
A String value.
Syntax
object.GetDefaultGateway

The GetDefaultGateway method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type LAN.

GetDuration method

Gets the duration time of the connection.
Return Type
A String value.
Syntax
object.GetDuration

The GetDuration method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type LAN.

GetFriendlyName method

Gets the interface friendly name.
Return Type
A String value.

Novatel Wireless Confidential & Proprietary Information

Revision 1

198

Syntax
object.GetFriendlyName

The GetFriendlyName method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type LAN.

GetIPAddress method

Gets the current IP address.
Return Type
A String value.
Syntax
object.GetIPAddress

The GetIPAddress method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type LAN.

GetLinkSpeed method

Gets the interface link speed in bps.
Return Type
A String value.
Syntax
object.GetLinkSpeed

The GetLinkSpeed method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type LAN.

GetMacAddress method

Gets the interface MAC address in hex.
Return Type
A String value.
Syntax
object.GetMacAddress

The GetMacAddress method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type LAN.

199

GetNdisName method

Gets the interface GUID.
Return Type
A String value.
Syntax
object.GetNdisName

The GetNdisName method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type LAN.

GetSubnetMask method

Gets the current subnet mask.
Return Type
A String value.
Syntax
object.GetSubnetMask

The GetSubnetMask method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type LAN.

Init method

Instantiates object and starts worker thread.
Return Type
A Long value.
Syntax
object.Init

The Init method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type LAN.

SetAdapter method

Sets the current interface and saves it to registry.
Syntax
object.SetAdapter(lpszAdapterNdisName As String)

The SetAdapter method syntax has these parts:

Part

Description

Novatel Wireless Confidential & Proprietary Information

Revision 1

200

object

lpszAdapterNdisName String

An expression evaluating to an object of type LAN.

WLAN object

NVTL WLAN Object is contained in the NetMonkey ActiveX Control Module. The WLAN Control
uses the following methods:

AddWepKey method

Add a WEP key to an index.
Return Type
A Long value.
Syntax
object.AddWepKey(nKeyIndex As Long, lpszKeyMaterial As String)

The AddWepKey method syntax has these parts:

Description

Part

object

nKeyIndex Long

An expression evaluating to an object of type WLAN.

lpszKeyMaterial String

Disassociate method

Disassociates with the current access point.
Syntax
object.Disassociate

The Disassociate method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

FindProfile method

Finds if a profile exists in WZConfig
Return Type
A Long value.
Syntax
object.FindProfile(lpszProfile As String, nInfrastructureMode As Long)

The FindProfile method syntax has these parts:

Description

Part

Novatel Wireless Confidential & Proprietary Information

Revision 1

201

object

lpszProfile String

nInfrastructureMode Long

An expression evaluating to an object of type WLAN.

GetAccessPoints method

Gets a list of all available access points.
Return Type
A Long value.
Syntax
object.GetAccessPoints(varAccessPoints As Variant)

The GetAccessPoints method syntax has these parts:

Part

Description

object

varAccessPoints Variant

An expression evaluating to an object of type WLAN.

GetAdapter method

Gets the currently selected interface from registry.
Return Type
A String value.
Syntax

object.GetAdapter

The GetAdapter method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

GetAdapterList method

Gets a list of WLAN interfaces available.
Return Type
A Long value.
Syntax
object.GetAdapterList(varAdapterList As Variant)

The GetAdapterList method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

varAdapterList Variant

Novatel Wireless Confidential & Proprietary Information

Revision 1

202

GetBssid method

Gets the associated access point's MAC address.
Return Type
A String value.
Syntax
object.GetBssid

The GetBssid method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetBytesIn method

Gets the number of bytes received.
Return Type
A Long value.
Syntax

object.GetBytesIn

The GetBytesIn method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

GetBytesOut method

Gets the number of bytes sent.
Return Type
A Long value.
Syntax

object.GetBytesOut

The GetBytesOut method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetConnectState method

Gets the interface connection status.
Return Type
A Long value.
Syntax

object.GetConnectState

Novatel Wireless Confidential & Proprietary Information

Revision 1

203

The GetConnectState method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetDefaultGateway method

Gets the current default gateway.
Return Type
A String value.
Syntax

object.GetDefaultGateway

The GetDefaultGateway method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetDuration method

Gets the duration time of the connection.
Return Type
A String value.
Syntax

object.GetDuration

The GetDuration method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetFriendlyName method

Gets the interface friendly name.
Return Type
A String value.
Syntax

object.GetFriendlyName

The GetFriendlyName method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type WLAN.

204

GetIPAddress method

Gets the current IP address.
Return Type
A String value.
Syntax

object.GetIPAddress

The GetIPAddress method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

GetLinkSpeed method

Gets the interface link speed in bps.
Return Type
A String value.
Syntax

object.GetLinkSpeed

The GetLinkSpeed method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetMacAddress method

Gets the interface MAC address in hex.
Return Type
A String value.
Syntax

object.GetMacAddress

The GetMacAddress method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

GetNdisName method

Gets the interface GUID.
Return Type
A String value.
Syntax

object.GetNdisName

The GetNdisName method syntax has these parts:

Novatel Wireless Confidential & Proprietary Information

Revision 1

205

Part Description

object

An expression evaluating to an object of type WLAN.

GetRssi method

Gets the interface signal strength in dDm.
Return Type
A Long value.
Syntax

object.GetRssi

The GetRssi method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetSigStr method

Gets the interface signal strength of values 0-5.
Return Type
A Long value.
Syntax

object.GetSigStr

The GetSigStr method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

GetSubnetMask method

Gets the current subnet mask.
Return Type
A String value.
Syntax

object.GetSubnetMask

The GetSubnetMask method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WLAN.

GetSupportedRates method

Gets interface supported rates.

Novatel Wireless Confidential & Proprietary Information

Revision 1

206

Return Type
A String value.
Syntax

object.GetSupportedRates

The GetSupportedRates method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

GetWZCServiceState method

Return Type
A Long value.
Syntax

object.GetWZCServiceState

The GetWZCServiceState method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

Init method

Instantiates object and starts worker thread.
Return Type
A Long value.
Syntax
object.Init
The Init method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

IsAdminUser method

Return Type
A Long value.
Syntax

object.IsAdminUser

The IsAdminUser method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type WLAN.

207

RemoveWepKey method

Remove a WEP key from an index.
Return Type
A Long value.
Syntax
object.RemoveWepKey(nKeyIndex As Long)

The RemoveWepKey method syntax has these parts:

Part

Description

object

nKeyIndex Long

An expression evaluating to an object of type WLAN.

Scan method

Begins a scan for all available access points.
Syntax
object.Scan
The Scan method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

SetAdapter method

Sets the current interface and saves it to registry.
Syntax
object.SetAdapter(lpszAdapterNdisName As String)

The SetAdapter method syntax has these parts:

Part

Description

object

lpszAdapterNdisName String

An expression evaluating to an object of type WLAN.

StartWZCService method

Syntax

object.StartWZCService

The StartWZCService method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type WLAN.

208

StopWZCService method

Syntax
object.StopWZCService
The StopWZCService method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WLAN.

WWAN object

NVTL WWAN Object is contained in the NetMonkey ActiveX Control Module. The WWAN Control
uses the following methods:

DisableDevice method

Disable device and turns off NDIS.
Return Type
A Long value.
Syntax
object.DisableDevice(lpszDeviceID As String)

The DisableDevice method syntax has these parts:

Description

Part

object

lpszDeviceID String

An expression evaluating to an object of type WWAN.

EnableDevice method

Enables devices and turns on NDIS.
Return Type
A Long value.
Syntax
object.EnableDevice(lpszDeviceID As String)

The EnableDevice method syntax has these parts:

Description

Part

object

lpszDeviceID String

An expression evaluating to an object of type WWAN.

GetAdapter method

Gets the currently selected interface from registry.

Novatel Wireless Confidential & Proprietary Information

Revision 1

209

Return Type
A String value.
Syntax

object.GetAdapter

The GetAdapter method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WWAN.

GetAdapterList method

Gets a list of WWAN interfaces available.
Return Type
A Long value.
Syntax
object.GetAdapterList(varAdapterList As Variant)

The GetAdapterList method syntax has these parts:

Description

Part

object

varAdapterList Variant

An expression evaluating to an object of type WWAN.

GetBytesIn method

Gets the number of bytes received.
Return Type
A Long value.
Syntax

object.GetBytesIn

The GetBytesIn method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WWAN.

GetBytesOut method

Gets the number of bytes sent.
Return Type
A Long value.
Syntax

object.GetBytesOut

The GetBytesOut method syntax has these parts:

Part

Description

Novatel Wireless Confidential & Proprietary Information

Revision 1

210

object

An expression evaluating to an object of type WWAN.

GetConnectState method

Gets the interface connection status.
Return Type
A Long value.
Syntax

object.GetConnectState

The GetConnectState method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WWAN.

GetDefaultGateway method

Gets the current default gateway.
Return Type
A String value.
Syntax

object.GetDefaultGateway

The GetDefaultGateway method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WWAN.

GetDuration method

Gets the duration time of the connection.
Return Type
A String value.
Syntax

object.GetDuration

The GetDuration method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WWAN.

GetFriendlyName method

Gets the interface friendly name.
Return Type
A String value.

Novatel Wireless Confidential & Proprietary Information

Revision 1

211

Syntax

object.GetFriendlyName

The GetFriendlyName method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WWAN.

GetIPAddress method

Gets the current IP address.
Return Type
A String value.
Syntax
object.GetIPAddress
The GetIPAddress method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WWAN.

GetLinkSpeed method

Gets the interface link speed in bps.
Return Type
A String value.
Syntax
object.GetLinkSpeed
The GetLinkSpeed method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WWAN.

GetNdisName method

Gets the interface GUID.
Return Type
A String value.
Syntax

object.GetNdisName

The GetNdisName method syntax has these parts:

Part

Description

object

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type WWAN.

212

GetSubnetMask method

Gets the current subnet mask.
Return Type
A String value.
Syntax

object.GetSubnetMask

The GetSubnetMask method syntax has these parts:

Part

Description

object

An expression evaluating to an object of type WWAN.

Init method

Instantiates object and starts worker thread.
Return Type
A Long value.
Syntax

object.Init

The Init method syntax has these parts:

Description

Part

object

An expression evaluating to an object of type WWAN.

InitDevice method

Initializes NDIS.
Return Type
A Long value.
Syntax

object.InitDevice(lpszDeviceID As String, lpszNetConnName As String, nShowIcon As Long,
nReEnable As Long)

The InitDevice method syntax has these parts:

Description

Part

object

lpszDeviceID String

lpszNetConnName String

nShowIcon Long
nReEnable Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type WWAN.

213

IsDeviceEnabled method

Checks the status of the NDIS device.
Return Type
A Long value.
Syntax
object.IsDeviceEnabled(lpszDeviceID As String)

The IsDeviceEnabled method syntax has these parts:

Part

Description

object

lpszDeviceID String

An expression evaluating to an object of type WWAN.

SetAdapter method

Sets the current interface and saves it to registry.
Syntax
object.SetAdapter(lpszAdapterNdisName As String)

The SetAdapter method syntax has these parts:

Description

Part

object

lpszAdapterNdisName String

An expression evaluating to an object of type WWAN.

UpdateDeviceParam method

Update NDIS related registry keys. eg. DialString, InitString.
Return Type
A Long value.
Syntax

object.UpdateDeviceParam(lpszDeviceID As String, lpszValName As String, dwType As Long,
lpszInBuffer As String, dwBuffSize As Long, dwVal As Long)

The UpdateDeviceParam method syntax has these parts:

Description

Part

object

lpszDeviceID String
lpszValName String

dwType Long

lpszInBuffer String

Novatel Wireless Confidential & Proprietary Information

Revision 1

An expression evaluating to an object of type WWAN.

214

dwBuffSize Long

dwVal Long

Novatel Wireless Confidential & Proprietary Information

Revision 1

Appendix H - AT Commands

Introduction

The purpose of this section is to provide advance design and integration information to assist in
the integration planning and evaluation of Novatel Wireless PCI Express Mini-cards. This section
is intended to specify supported AT Commands for the Novatel Wireless line of PCI Express Mini­cards, and to provide the information necessary to integrate the module into an overall product
design. The full AT command list is shown for completeness. A subset of the commands shown
will not be relevant to a target Mini-card.

AT Commands allow communications software to control and direct the modem. The term AT is
derived from the word ATtention, meaning to get the modem’s attention. AT Commands are
issued by an intelligent device to a modem to perform a specific function. For example, AT
Commands can be used to initiate a call, answer a call or to simply transmit data. The prefix AT
obtains synchronization, identifies the character parameters, and indicates that a command may
be in the following characters. AT Commands are not
letters in the command syntax

The ETSI specification created a complete set of commands to interface with the terminal adapter
or modem as well as specifying certain commands from ITU 25. To make the AT Command
interface easier to understand and provide faster customer integration, a number of the standard
AT Commands have been implemented to substitute some of the more specialized ETSI
commands. All commands relevant to the control and operation of the modem have been
implemented.

case sensitive; use upper or lower case

Novatel Wireless AT Command Set

Each of the following sections discusses an individual AT command and its five subsections listed
below:

Description: describes the command and defines any conditions required to use the

command

Syntax: lists the syntax the command requires
Parameters: lists any parameters and values available to the command
Response: lists and defines any responses the command may return

Example: (optional) provides examples of the command

A/

Description: REPEAT LAST COMMAND

This command repeats the last command sent to the modem.

Syntax: A/
Parameters: None
Response: Returns the command response from the previous command.
Example: AT+GMI

+GMI: Novatel Wireless, Inc.

Novatel Wireless Doc No. OM-01017857 Rev 1

216

OK
A/
+GMI: Novatel Wireless, Inc.
OK

ATA

Description: ANSWER

This command sets the modem to answer the next call. The modem sends an
off-hook signal to the remote station. Any additional commands on the same
command line are ignored. The modem switches to data mode and after call is
released, returns to command mode.

This command can be stopped by receiving a character during
execution, except during some states of connection establishment such
as handshaking.

Syntax: ATA
Parameters: None
Response: If the connection is successful the modem will return the string:

CONNECT<text>

then switches to data mode. The <text> is only displayed if the
command ATX has been set to a value greater than 0.

When the modem releases the call and returns to command mode, it
returns the string:

OK

If no connection is made, the modem will return the string:

NO CARRIER

Example: ATA

ATD

Description: DIAL NUMBER

This command will instruct the modem to originate a call to a disabled number.
The modem attempts to set up an outgoing call.

This command can be stopped by receiving a character during execution,

except during some states of connection establishment such as
handshaking.

Syntax: ATD[<value>]
Parameters:

<value>

The string of dialing digits and the optional V.25ter modifiers. The valid dialing
digits are:

Novatel Wireless Confidential & Proprietary Information

Revision 1

217

0-9, * , #, +, A, B, C

and the V.25ter modifiers which are ignored:

Response: If there is no dial tone, the modem will return th e string:
NO DIALTONE

where the command ATX has been set to 2 or 4.
If there is an error and it is related to the mobile equipment’s (ME)

functionality, the modem will return the string:

+CME ERROR: <error>

If the connection is busy, the modem will return the string:

BUSY

where the command ATX has been set to 3 or 4.
If the connection cannot be established, the modem will return the string:

NO CARRIER

If the connection is successful and is non-voice call, the modem switches

to data state and the modem will return the string:

CONNECT<text>

where <text> is only displayed if the command ATX has been set to a

value greater than 0.

If connection successful and is a voice call, the modem will return the

string:

OK

When the modem releases the call and returns to command mode, it

returns the string:

OK
Example:

ATD9,555-1212 DIAL 9, PAUSE, DIAL 5551212
ATD555-1234; DIAL 5551234
ATD#777 Packet data call

ATE

Description: ECHO MODE

This command sets the echo mode of the modem, that is, whether or not the
modem echoes characters received from terminal while the modem is in
command mode.

Syntax: ATE[<value>]
Parameters: <value>

0 turns echo mode off

Novatel Wireless Confidential & Proprietary Information

Revision 1

218

1 turns echo mode on

Response: This command will return the string OK.
Example:

ATE1 All further data entered is echoed
ATE0 All further data entered is not echoed

ATH

Description: HANG-UP (DISCONNECT)

This command instructs the modem to disconnect from the current connection
and terminate the call.

Syntax: ATH[0]
Parameters: 0 – This parameter is the default, as well as the only parameter, and does not

necessarily have to be typed with the command.

Response: This command will return the string OK, after th e Data Carrier Detect

(DCD) is turned off, if it was previously on.

Example: ATH

ATV

Description: VERBOSE

This command displays the modem’s result codes in terse or verbose form.

In terse form, all result codes are represented by an error code numbe r

and all text messages have only a carriage return (<cr>) character
appended to them.

In verbose form, all result codes are returned as words or sentences and

all text messages have a carriage return-line feed (<cr><lf>) character
pair before and after the text message.

Syntax: ATV[<value>]
Parameters: <value>

0 will set the response format to terse

1will set the response format to verbose

Response: If the command has been set to 0, it will return the response:
0
If the command has been set to 1, it will return the response:
OK

Example: ATV1

ATZ

Description: RESET PARAMETERS TO SAVED SETTINGS

Novatel Wireless Confidential & Proprietary Information

Revision 1

219

This command uses the user-defined modem settings profile stored in the non­volatile memory as the active profile. If the user-defined profile is invalid, the
modem will use the factory default settings. Any additional commands on the
same command line are ignored. This command uses the profile created by the
AT&W command.

Syntax: ATZ[0]
Parameters: 0 – This parameter is the default, as well as the only parameter, and

does not necessarily have to be typed with the command.

Response: This command will return the string OK.

AT&C

Description: DATA CARRIER DETECT (DCD) MODE

This command sets the data carrier detect mode.

Syntax: AT&C[<value>]
Parameters: <value>

0 – sets the data carrier detect so it is always on

1 – sets the data carrier detect so it is only on in the presence of a data

carrier

2 – sets data carrier detect to always on but wink when connection

disconnect (Qualcomm™ implemented)

Response: This command will return the string OK.
Example: AT&C1

AT&D

Description: DATA TERMINAL READY (DTR) CONTROL

This command defines how the modem responds, while in data mode, to the
data terminal ready (DTR) circuit changing state from ON to OFF.

Syntax: AT&D[<value>]
Parameters: <value>

0 – instructs the modem to ignore the data terminal ready s tate

1 – instructs the modem to change to command mode, while remaining

connected to the call

2 – instructs the modem to disconnect from the call and then change to

command mode. While the data terminal ready state is set to off, the
modem’s auto-answer function is also off.

Response: This command will return the string OK.
Example: AT&D2

Novatel Wireless Confidential & Proprietary Information

Revision 1

220

AT&V

Description: VIEW ACTIVE PROFILE

This command will display the active profile settings on the terminating
equipment.

Syntax: AT&V[0]
Parameters: 0 – This parameter is the default, as well as the only parameter, and

does not necessarily have to be typed with the command.

Response: The response will be a listing of the current configuration followed by the

string OK. For example

ACTIVE PROFILE :
E1 L1 M1 Q0 V1 X4 &C1 &D2
S0:0 S2:43 S3:13 S4:10 S5:8 S6:2 S7:60 S8:2 S10:15 S12:
+CBST: 7,0,1
+CSMS: 0
+CRLP: 61,61,48,6,0,3
+CRC: 0
+CR: 0
+FCLASS: 0
+IFC: 2,2
+IMODE: 0
+ICF: 3,3
+DR: 0
+CMGF: 0
+CSDH: 0
+CNMI: 2,1,0,0,0
+ILRR: 0
+IPR: 115200
+DS: 3,0,512,20
+CMEE: 0
+CREG: 0
+CCUG: 0,0,0
+CLIP: 0
+COLP: 0
+CCWA: 0
+CAOC: 1
+CLIR: 0
+CSCA: "[phone]",145
+CSMP: 17,167

OK
Example: AT&V

AT+CFC

Description: Um INTERFACE FAX COMPRESSION
Syntax: AT+CFC=<value>
Parameters: <value>

Novatel Wireless Confidential & Proprietary Information

Revision 1