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