| Download: |  |
| Mirror Download [FCC.gov] | |
| Document ID | 618966 |
| Application ID | hqATUYn3Mz/1ZJOwiwJE/Q== |
| Document Description | users manual |
| Short Term Confidential | No |
| Permanent Confidential | No |
| Supercede | No |
| Document Type | User Manual |
| Display Format | Adobe Acrobat PDF - pdf |
| Filesize | 316.3kB (3953775 bits) |
| Date Submitted | 2006-01-12 00:00:00 |
| Date Available | 2006-01-11 00:00:00 |
| Creation Date | 2005-12-08 22:07:08 |
| Producing Software | Acrobat Distiller 6.0 (Windows) |
| Document Lastmod | 2005-12-08 22:14:56 |
| Document Title | Microsoft Word - PCIe Integration Guide SE Sept30.doc |
| Document Creator | PScript5.dll Version 5.2.2 |
| Document Author: | KGOODFELLOW |
Novatel Wireless, Inc.
PCI Express Mini-card
Integration & Design Guidelines
Version 1. A
Novatel Wireless, Proprietary & Confidential
Page1
Notice: Restricted Proprietary Information
© Copyright Novatel Wireless, Inc. (2005)
The information contained in this document is the exclusive property of Novatel Wireless, Inc. All
rights reserved. Unauthorized reproduction of this manual in any form without the expressed
written approval of Novatel Wireless, Inc. is strictly prohibited. This manual may not, in whole or in
part, be copied, reproduced, translated, or reduced to any electronic or magnetic storage medium
without the written consent of a duly authorized officer of Novatel Wireless Inc.
The information contained in this document is subject to change without notice and should not be
construed as a commitment by Novatel Wireless Inc. unless such commitment is expressly given
in a covering document.
Novatel Wireless Inc. makes no warranties, either expressed or implied, regarding this document,
its merchantability, or its fitness, for any particular purpose.
Printed and produced in United States of America.
Document Revision History
Rev.
1.0
1.1
1. A
Date
March 28,
2005
August
1,2005
September
30,2005
Brief Description of Change
Initial Draft
Originator
John Ross
Added SDK and AT Commands
Matt Golden
Second Draft
Sharon Lee
Novatel Wireless, Proprietary & Confidential
Page2
Approved by
Table of Contents
Introduction.................................................................................................................................. 14
PCI Express Mini Card.......................................................................................................... 14
www.pcisig.com/home .......................................................................................................... 14
Getting Started............................................................................................................................. 15
Introduction ........................................................................................................................... 15
Windows Platforms ............................................................................................................... 15
Safety Warning ................................................................................................................. 15
FCC RF Interference Statement ................................................................................... 16
Radio Frequency Exposure Evaluation Requirements ......................................................... 16
Technical Support Contacts.................................................................................................. 16
Device Specifications.................................................................................................................. 17
Introduction ........................................................................................................................... 17
Product Overview ............................................................................................................. 17
Hardware................................................................................................................................... 17
Card Specifications ............................................................................................................... 17
Mechanical Specification ...................................................................................................... 18
Shielding / Mechanical enclosure ......................................................................................... 20
Host Interface connector....................................................................................................... 20
Interface Specification............................................................................................................... 21
Host Interface........................................................................................................................ 21
USB Interface........................................................................................................................ 22
RF Interface .......................................................................................................................... 22
Subscriber Identification Module (SIM) Interface.................................................................. 22
USIM Interface ...................................................................................................................... 22
LED Interface ........................................................................................................................ 22
Power Supply ........................................................................................................................ 23
Power Class .......................................................................................................................... 25
WDISABLE............................................................................................................................ 26
Electrostatic Discharge and Electro-Magnetic Interference.................................................. 27
Firmware ................................................................................................................................... 27
Overview ............................................................................................................................... 27
Memory ................................................................................................................................. 27
EU730/740 Firmware Features............................................................................................. 27
EV620 Firmware Features .................................................................................................... 32
Application Software ................................................................................................................. 34
Environmental ........................................................................................................................... 35
Provisioning with IOTA.............................................................................................................. 36
eIOTA.................................................................................................................................... 36
Enabling, disabling, and starting eIOTA ............................................................................... 36
Checking eIOTA status ......................................................................................................... 37
Development Board..................................................................................................................... 38
Fixture Diagram/Assembly Diagram ......................................................................................... 38
Photo of Top View..................................................................................................................... 39
Schematic.................................................................................................................................. 40
Hardware Design Guidelines...................................................................................................... 41
Power Supply Requirements for GSM Bursting........................................................................ 41
SIM Card Socket Location ........................................................................................................ 42
Antenna ..................................................................................................................................... 42
1XEV-DO Diversity Antenna Requirements ......................................................................... 42
FCC Implications – Mobile vs. Portable Devices .................................................................. 43
TRP (Total Radiated Power) Requirements ......................................................................... 43
MobiLink Phoenix SDK ............................................................................................................... 45
Novatel Wireless, Proprietary & Confidential
Page3
Introduction ........................................................................................................................... 45
Requirements........................................................................................................................ 45
SDK MODULES ........................................................................................................................ 45
Phoenix & Blaze.................................................................................................................... 45
NetMonkey ............................................................................................................................ 46
Profile Manager..................................................................................................................... 46
Hotspot Finder....................................................................................................................... 46
Menu ..................................................................................................................................... 46
Utilities................................................................................................................................... 46
PHOENIX SERVER Software design ....................................................................................... 47
Single Server and Multiple Clients ........................................................................................ 47
Novatel Wireless Product Line Support ................................................................................ 48
State Machine with 2-Way Communication .......................................................................... 48
MobiLink Connection Manager .................................................................................................. 49
Overview ............................................................................................................................... 49
Purpose................................................................................................................................. 49
Applicable Documents .......................................................................................................... 49
GENERAL FEATURES............................................................................................................. 49
User Interface Functionality .................................................................................................. 49
Layout ................................................................................................................................... 50
Mouse Over........................................................................................................................... 51
Snap to Edge ........................................................................................................................ 51
Hot Swapping........................................................................................................................ 51
Skinning Customization ........................................................................................................ 51
Localization ........................................................................................................................... 52
File ........................................................................................................................................ 52
MOBILINK™ FEATURES ......................................................................................................... 53
Main Display Window............................................................................................................ 53
Indicators............................................................................................................................... 57
Connect/Disconnect Button .................................................................................................. 58
Menu ..................................................................................................................................... 58
SIM/Lock Management ......................................................................................................... 70
Quick Access Buttons ........................................................................................................... 71
Software Web Upgrade......................................................................................................... 71
SMS Client ............................................................................................................................ 71
Addressbook Features.......................................................................................................... 75
Phoenix API Interface to PCI Express Mini Card...................................................................... 78
Overview ............................................................................................................................... 78
Client Object.............................................................................................................................. 78
ChangeLockCode method .................................................................................................... 79
Connect method.................................................................................................................... 79
DebugPrint method ............................................................................................................... 80
DeleteMessage method ........................................................................................................ 80
Disconnect method ............................................................................................................... 81
GetAdapter method............................................................................................................... 81
GetAdapterList method ......................................................................................................... 82
GetConnectStatus method.................................................................................................... 82
GetContact method............................................................................................................... 83
GetContactInfo method......................................................................................................... 83
GetDeviceId method ............................................................................................................. 84
GetDeviceModel method ...................................................................................................... 84
GetDeviceNetwork method ................................................................................................... 85
GetDeviceState method........................................................................................................ 85
GetDeviceTechnology method.............................................................................................. 87
GetFID method...................................................................................................................... 87
GetHardwareVersion method ............................................................................................... 87
Novatel Wireless, Proprietary & Confidential
Page4
GetLockStatus method ......................................................................................................... 88
GetMessage method............................................................................................................. 88
GetMessageCount method ................................................................................................... 89
GetMessageStatus method .................................................................................................. 89
GetMobileNumber method.................................................................................................... 90
GetNetworkOperatorList method .......................................................................................... 90
GetNetworkPreference method ............................................................................................ 91
GetNewMessageCount method............................................................................................ 91
GetOSVersionInfo method.................................................................................................... 92
GetPRLVersion method ........................................................................................................ 92
GetRasErrorString method ................................................................................................... 93
GetSigStr method.................................................................................................................. 93
GetSoftwareVersion method................................................................................................. 94
IsDormant method ................................................................................................................ 94
IsMessageMemoryFull method............................................................................................. 95
IsRoaming method................................................................................................................ 95
SendMessage method .......................................................................................................... 95
SetAdapter method ............................................................................................................... 96
SetAutoLock method............................................................................................................. 96
SetCallSettings method ........................................................................................................ 97
SetContact method ............................................................................................................... 97
SetMessageStatus method................................................................................................... 98
SetNetworkOperator method ................................................................................................ 99
SetNetworkPreference method............................................................................................. 99
SetProxy method................................................................................................................. 100
SetSMSC method ............................................................................................................... 100
Shutdown method ............................................................................................................... 101
Unlock method .................................................................................................................... 101
IEventPhoenixNotifySink object .............................................................................................. 102
FireEventDeviceState method ............................................................................................ 102
FireEventDormant method.................................................................................................. 102
FireEventIncomingCall method........................................................................................... 102
FireEventNetwork method .................................................................................................. 102
FireEventRoaming method ................................................................................................. 103
FireEventSigStr method...................................................................................................... 103
FireEventSMSStatus method.............................................................................................. 103
QoS object............................................................................................................................... 103
deliveryofSDUError property............................................................................................... 104
deliveryOrder property ........................................................................................................ 104
guarBitDL property.............................................................................................................. 104
guarBitUL property.............................................................................................................. 104
maxBitDL property .............................................................................................................. 105
maxBitUL property .............................................................................................................. 105
maxSDUSize property ........................................................................................................ 105
ResBitErrorRatio property................................................................................................... 105
SDUErrorRatio property...................................................................................................... 106
trafficClass property ............................................................................................................ 106
trafficHandling property....................................................................................................... 106
transferDelay property ........................................................................................................ 106
Blaze object............................................................................................................................. 107
EventDeviceState event...................................................................................................... 107
EventDormant event ........................................................................................................... 107
EventIncomingCall event .................................................................................................... 107
EventNetwork event............................................................................................................ 108
EventRoaming event........................................................................................................... 108
EventSigStr event ............................................................................................................... 108
Novatel Wireless, Proprietary & Confidential
Page5
EventSMSStatus event ....................................................................................................... 108
Attach method ..................................................................................................................... 108
Detach method.................................................................................................................... 109
Hotspots object ....................................................................................................................... 109
AboutBox method ............................................................................................................... 109
Init method .......................................................................................................................... 109
ViewHotspots method ......................................................................................................... 109
Menu object............................................................................................................................. 110
Init method .......................................................................................................................... 110
ShowAbout method............................................................................................................. 110
ShowActivation method ...................................................................................................... 110
ShowConfig method............................................................................................................ 111
ShowDebug method ........................................................................................................... 111
ShowProp method .............................................................................................................. 111
ShowReport method ........................................................................................................... 111
ShowUnlock method ........................................................................................................... 112
Language object...................................................................................................................... 112
GetLanguageCount method................................................................................................ 112
GetLanguageIndex method ................................................................................................ 112
GetString method ................................................................................................................ 113
GetStringTableCount method ............................................................................................. 113
Init method .......................................................................................................................... 113
ProfileManager object ............................................................................................................. 114
AboutBox method ............................................................................................................... 114
CreateProfile method .......................................................................................................... 114
GetDefaultProfileName method .......................................................................................... 114
GetProfile method ............................................................................................................... 115
GetProfileNameList method................................................................................................ 115
Init method .......................................................................................................................... 115
SetDefaultProfile method .................................................................................................... 116
ShowProfileList method ...................................................................................................... 116
Profile object............................................................................................................................ 116
APN property....................................................................................................................... 116
AuthenticationType property ............................................................................................... 117
CarrierName property ......................................................................................................... 117
ConnectType property ........................................................................................................ 117
DataSpeed property............................................................................................................ 118
DefaultGateway property .................................................................................................... 118
DeliveryofSDUError property .............................................................................................. 118
DeliveryOrder property........................................................................................................ 119
DialString property .............................................................................................................. 119
Fallback2GProfile property ................................................................................................. 119
IPAddress property ............................................................................................................. 120
MaxSDUSize property ........................................................................................................ 120
Password property .............................................................................................................. 120
PDPAddress property ......................................................................................................... 120
PDPType property .............................................................................................................. 121
PrimaryDNS property.......................................................................................................... 121
PrimaryWINS property ........................................................................................................ 121
ProfileName property .......................................................................................................... 122
ProxyAddress property ....................................................................................................... 122
ProxyPort property .............................................................................................................. 122
ResErrorRatio property ....................................................................................................... 123
SDUErrorRatio property...................................................................................................... 123
SecondaryDNS property ..................................................................................................... 123
SecondaryWINS property ................................................................................................... 124
Novatel Wireless, Proprietary & Confidential
Page6
SetProxy property ............................................................................................................... 124
SMSC property.................................................................................................................... 124
SMSEmailNumber property ................................................................................................ 125
StaticIP property.................................................................................................................. 125
SubnetMask property.......................................................................................................... 125
Technology property ........................................................................................................... 125
TrafficClass property........................................................................................................... 126
TrafficHandling property...................................................................................................... 126
TransferDelay property ....................................................................................................... 126
UseDNS property ................................................................................................................ 127
Username property ............................................................................................................. 127
UseVPN property ................................................................................................................ 127
UseWINS property .............................................................................................................. 128
VPNEntryName property .................................................................................................... 128
NetMonkey Lib objects............................................................................................................ 128
EventAdapterFound event .................................................................................................. 128
EventAdapterUpdate event................................................................................................. 128
LAN object............................................................................................................................... 129
GetAdapter method............................................................................................................. 129
GetAdapterList method ....................................................................................................... 129
GetBytesIn method ............................................................................................................. 129
GetBytesOut method .......................................................................................................... 130
GetConnectState method ................................................................................................... 130
GetDefaultGateway method................................................................................................ 130
GetDuration method............................................................................................................ 130
GetFriendlyName method................................................................................................... 131
GetIPAddress method......................................................................................................... 131
GetLinkSpeed method ........................................................................................................ 131
GetMacAddress method ..................................................................................................... 132
GetNdisName method ........................................................................................................ 132
GetSubnetMask method ..................................................................................................... 132
Init method .......................................................................................................................... 132
SetAdapter method ............................................................................................................. 133
WLAN object ........................................................................................................................... 133
AddWepKey method ........................................................................................................... 133
Disassociate method........................................................................................................... 133
FindProfile method.............................................................................................................. 134
GetAccessPoints method.................................................................................................... 134
GetAdapter method............................................................................................................. 134
GetAdapterList method ....................................................................................................... 135
GetBssid method................................................................................................................. 135
GetBytesIn method ............................................................................................................. 135
GetBytesOut method .......................................................................................................... 135
GetConnectState method ................................................................................................... 136
GetDefaultGateway method................................................................................................ 136
GetDuration method............................................................................................................ 136
GetFriendlyName method................................................................................................... 137
GetIPAddress method......................................................................................................... 137
GetLinkSpeed method ........................................................................................................ 137
GetMacAddress method ..................................................................................................... 137
GetNdisName method ........................................................................................................ 138
GetRssi method .................................................................................................................. 138
GetSigStr method................................................................................................................ 138
GetSubnetMask method ..................................................................................................... 138
GetSupportedRates method ............................................................................................... 139
GetWZCServiceState method............................................................................................. 139
Novatel Wireless, Proprietary & Confidential
Page7
Init method .......................................................................................................................... 139
IsAdminUser method .......................................................................................................... 140
RemoveWepKey method .................................................................................................... 140
Scan method ....................................................................................................................... 140
SetAdapter method ............................................................................................................. 140
StartWZCService method ................................................................................................... 141
StopWZCService method ................................................................................................... 141
WWAN object .......................................................................................................................... 141
DisableDevice method ........................................................................................................ 141
EnableDevice method......................................................................................................... 141
GetAdapter method............................................................................................................. 142
GetAdapterList method ....................................................................................................... 142
GetBytesIn method ............................................................................................................. 142
GetBytesOut method .......................................................................................................... 143
GetConnectState method ................................................................................................... 143
GetDefaultGateway method................................................................................................ 143
GetDuration method............................................................................................................ 143
GetFriendlyName method................................................................................................... 144
GetIPAddress method......................................................................................................... 144
GetLinkSpeed method ........................................................................................................ 144
GetNdisName method ........................................................................................................ 145
GetSubnetMask method ..................................................................................................... 145
Init method .......................................................................................................................... 145
InitDevice method ............................................................................................................... 145
IsDeviceEnabled method .................................................................................................... 146
SetAdapter method ............................................................................................................. 146
UpdateDeviceParam method.............................................................................................. 146
AT Commands ........................................................................................................................... 148
Introduction ......................................................................................................................... 148
NW PCI AT Command Set...................................................................................................... 148
A/......................................................................................................................................... 148
ATA ..................................................................................................................................... 149
ATD ..................................................................................................................................... 149
ATE ..................................................................................................................................... 151
ATH ..................................................................................................................................... 151
ATV ..................................................................................................................................... 151
ATZ ..................................................................................................................................... 152
AT&C................................................................................................................................... 152
AT&D................................................................................................................................... 153
AT&V................................................................................................................................... 153
AT+CFC .............................................................................................................................. 154
AT+CRM ............................................................................................................................. 155
AT+CSQ.............................................................................................................................. 155
AT+CSS .............................................................................................................................. 156
AT+CXT .............................................................................................................................. 156
AT+ER................................................................................................................................. 157
AT+ETBM ........................................................................................................................... 157
AT+FCLASS ....................................................................................................................... 158
AT+GCAP ........................................................................................................................... 158
AT+GMI............................................................................................................................... 158
AT+GMM............................................................................................................................. 159
AT+GMR ............................................................................................................................. 159
AT+GSN.............................................................................................................................. 159
AT$QCQNC ........................................................................................................................ 160
AT$QCPREV ...................................................................................................................... 160
AT$QCCLR ......................................................................................................................... 160
Novatel Wireless, Proprietary & Confidential
Page8
AT$QCPKND ...................................................................................................................... 161
AT$QCVAD......................................................................................................................... 161
AT$QCMDR ........................................................................................................................ 162
AT$QCMIP.......................................................................................................................... 162
AT$QCMIPP ....................................................................................................................... 163
AT$QCMIPT........................................................................................................................ 163
AT$QCMIPEP ..................................................................................................................... 164
AT$QCMIPGETP ................................................................................................................ 164
AT$QCMIPNAI.................................................................................................................... 164
AT$QCMIPRT ..................................................................................................................... 165
AT$QCMIPMASS................................................................................................................ 165
AT$QCMIPMHSS ............................................................................................................... 166
AT$QCMIPMASSX ............................................................................................................. 167
AT$QCMIPMHSSX............................................................................................................. 167
AT$QCMIPMASPI .............................................................................................................. 168
AT$QCMIPMHSPI .............................................................................................................. 168
AT$NW................................................................................................................................ 169
AT$NVTLLTIME.................................................................................................................. 169
AT$NVTLMDN .................................................................................................................... 169
AT+IOTA ............................................................................................................................. 170
AT$NWACTIVATION.......................................................................................................... 170
AT+PZID ............................................................................................................................. 171
AT$SPNAI........................................................................................................................... 171
Novatel Wireless Developer Network Library ......................................................................... 172
AT+COPS ........................................................................................................................... 172
AT+CSPN ........................................................................................................................... 173
AT$NWATR ........................................................................................................................ 174
AT$NWCID ......................................................................................................................... 174
AT$NWFLASH .................................................................................................................... 175
AT$NWHLR ........................................................................................................................ 175
AT$NWICCID...................................................................................................................... 178
AT$NWNPC ........................................................................................................................ 178
AT$NWPDN ........................................................................................................................ 179
AT$NWPINR ....................................................................................................................... 180
AT$NWRAT ........................................................................................................................ 180
Additional AT Commands ....................................................................................................... 181
ATH ..................................................................................................................................... 181
ATI....................................................................................................................................... 182
ATL...................................................................................................................................... 182
ATO..................................................................................................................................... 182
ATP ..................................................................................................................................... 182
ATQ..................................................................................................................................... 182
ATS0 ................................................................................................................................... 183
ATS3 ................................................................................................................................... 183
ATS4 ................................................................................................................................... 183
ATS5 ................................................................................................................................... 183
ATS6 ................................................................................................................................... 183
ATS7 ................................................................................................................................... 184
ATS8 ................................................................................................................................... 184
ATS10 ................................................................................................................................. 184
ATT ..................................................................................................................................... 184
ATX ..................................................................................................................................... 184
AT&F ................................................................................................................................... 185
AT+CBC .............................................................................................................................. 185
AT+CBST............................................................................................................................ 185
AT+CCFC ........................................................................................................................... 186
Novatel Wireless, Proprietary & Confidential
Page9
AT+CCUG........................................................................................................................... 186
AT+CCWA .......................................................................................................................... 186
AT+CFUN ........................................................................................................................... 186
AT+CGACT......................................................................................................................... 186
AT+CGATT ......................................................................................................................... 187
AT+CGCLASS .................................................................................................................... 187
AT+CGDCONT ................................................................................................................... 187
AT+CGDSCO...................................................................................................................... 187
AT+CGEQMIN .................................................................................................................... 188
AT+CGEQREQ ................................................................................................................... 188
AT+CGEREP ...................................................................................................................... 189
AT+CGMI ............................................................................................................................ 189
AT+CGMM .......................................................................................................................... 189
AT+CGMR .......................................................................................................................... 190
AT+CGQMIN....................................................................................................................... 190
AT+CGQREQ ..................................................................................................................... 190
AT+CGREG ........................................................................................................................ 191
AT+CGSMS ........................................................................................................................ 191
AT+CGSN ........................................................................................................................... 191
AT+CGTFT ......................................................................................................................... 191
AT+CHLD............................................................................................................................ 192
AT+CHSN ........................................................................................................................... 192
AT+CHUP ........................................................................................................................... 193
AT+CIMI.............................................................................................................................. 193
AT+CLCK............................................................................................................................ 193
AT+CMEE ........................................................................................................................... 193
AT+CMGC .......................................................................................................................... 193
AT+CMGD .......................................................................................................................... 194
AT+CMGF........................................................................................................................... 194
AT+CMGL ........................................................................................................................... 194
AT+CMGR .......................................................................................................................... 194
AT+CMGS........................................................................................................................... 194
AT+CMGW.......................................................................................................................... 194
AT+CMMS .......................................................................................................................... 195
AT+CMOD .......................................................................................................................... 195
AT+CMSS ........................................................................................................................... 195
AT+CNMA........................................................................................................................... 195
AT+CNMI ............................................................................................................................ 195
AT+CPAS............................................................................................................................ 196
AT+CPBF............................................................................................................................ 196
AT+CPBR ........................................................................................................................... 196
AT+CPBS............................................................................................................................ 196
AT+CPBW........................................................................................................................... 196
AT+CPIN ............................................................................................................................. 197
AT+CPMS ........................................................................................................................... 197
AT+CPWD .......................................................................................................................... 197
AT+CR ................................................................................................................................ 197
AT+CRC.............................................................................................................................. 197
AT+CREG ........................................................................................................................... 198
AT+CRLP............................................................................................................................ 198
AT+CSCA ........................................................................................................................... 198
AT+CSCB ........................................................................................................................... 198
AT+CSCS ........................................................................................................................... 199
AT+CSDH ........................................................................................................................... 199
AT+CSIM ............................................................................................................................ 199
AT+CSMP ........................................................................................................................... 199
Novatel Wireless, Proprietary & Confidential
Page10
AT+CSMS ........................................................................................................................... 199
AT+CSTA............................................................................................................................ 200
AT+CUSD ........................................................................................................................... 200
AT+DR ................................................................................................................................ 200
AT+DS................................................................................................................................. 200
AT+ES................................................................................................................................. 200
AT+ESA .............................................................................................................................. 201
AT+FAR .............................................................................................................................. 201
AT+FCL............................................................................................................................... 201
AT+FDD .............................................................................................................................. 201
AT+FIT ................................................................................................................................ 202
AT+FRH .............................................................................................................................. 202
AT+FRM.............................................................................................................................. 202
AT+FRS .............................................................................................................................. 202
AT+FTH............................................................................................................................... 203
AT+FTM .............................................................................................................................. 203
AT+FTS............................................................................................................................... 203
AT+ICF................................................................................................................................ 203
AT+IFC................................................................................................................................ 203
AT+IPR................................................................................................................................ 204
CME ERROR Codes for CDMA Commands .......................................................................... 204
CMS Error Codes for CDMA Commands ............................................................................... 205
Regulatory Approval Requirements ........................................................................................ 207
FCC (Federal Communication Commission) .......................................................................... 207
GCF (Global Certification Forum) ........................................................................................... 207
PTCRB (PCS Type Certification Review Board)..................................................................... 207
CE (Conformance European).................................................................................................. 207
IOT .......................................................................................................................................... 209
Compliance Certification Process ........................................................................................... 210
EV-DO FCC Accreditation....................................................................................................... 210
EV-DO CDG Interoperability ................................................................................................... 210
EV-DO Verizon Certification Process ..................................................................................... 211
HDSPA FCC Accreditation...................................................................................................... 211
GCF Compliance Process....................................................................................................... 211
PTCRB Compliance Process .................................................................................................. 212
CE Mark Certification Process ................................................................................................ 213
Infrastructure IOT Process ...................................................................................................... 214
Carrier Certification Process ................................................................................................... 214
Test Laboratories .................................................................................................................... 215
FCC / CE Test Houses ....................................................................................................... 215
PTCRB / GCF Test Houses ................................................................................................ 215
Reference Parts Specifications................................................................................................ 216
RF Connector...................................................................................................................... 216
Mini Card Connector ........................................................................................................... 217
FAQ (Frequently Asked Questions)......................................................................................... 218
References ................................................................................................................................. 219
Glossary ..................................................................................................................................... 220
Table of Figures
Figure 1:
Figure 2:
Figure 3:
Figure 4:
EV620 Module ..................................................................................................... 18
EU730/EU740 Module ......................................................................................... 19
PCIe Minicard Module Envelope ......................................................................... 20
W_Disable Pull-up Configuration......................................................................... 26
Novatel Wireless, Proprietary & Confidential
Page11
Figure 5:
Figure 6:
Figure 7:
Figure 8:
Figure 9:
Figure 10:
Figure 11:
Figure 12:
Figure 13:
Figure 14:
Figure 15:
Figure 16:
Figure 17:
Figure 18:
Figure 19:
Figure 20:
Figure 21:
Figure 22:
Figure 23:
Figure 24:
Figure 25:
Figure 26:
Figure 27:
Figure 28:
Figure 29:
Figure 30:
Figure 31:
Figure 32:
Figure 33:
Figure 34:
Figure 35:
Figure 36:
Figure 37:
Figure 38:
Figure 39:
Figure 40:
Figure 41:
Figure 42:
Figure 43:
Figure 44:
Figure 45:
Figure 46:
Figure 47:
Figure 48:
Up-ramp for Highest Power Levels...................................................................... 41
Up-Ramp for Lowest Power Levels ..................................................................... 41
Up-Ramp for Lowest Power Levels (Scheme 2) ................................................. 42
Total Radiated Power .......................................................................................... 43
Applications.......................................................................................................... 45
Module Design ..................................................................................................... 47
Automation Server ............................................................................................... 47
State Machine ...................................................................................................... 48
Main MobiLink Display ......................................................................................... 50
Skin Design.......................................................................................................... 51
On-Line Help........................................................................................................ 52
Status Indication .................................................................................................. 53
3G Wireless View................................................................................................. 54
WiFi View ............................................................................................................. 55
HotSpot Activation ............................................................................................... 56
Network Connection............................................................................................. 56
Ethernet View....................................................................................................... 57
Connection Button ............................................................................................... 58
3G Profiles ........................................................................................................... 59
Profile Settings..................................................................................................... 60
Different Tab Settngs ........................................................................................... 60
Profile Wizard Step 1 ........................................................................................... 61
Profile Wizard Step #2 ......................................................................................... 62
Profile Wizard Step #3 ......................................................................................... 62
General Tab ......................................................................................................... 63
Mobile Tab ........................................................................................................... 64
WiFi Tab............................................................................................................... 65
WAP Window ....................................................................................................... 65
Ethernet Tab ........................................................................................................ 66
AP Window .......................................................................................................... 66
CDMA................................................................................................................... 67
UMTS/HSDPA ..................................................................................................... 67
Report Log ........................................................................................................... 68
Desktop Transparency......................................................................................... 69
About Dialogue .................................................................................................... 70
Enter PUK ............................................................................................................ 70
Configuration Menu.............................................................................................. 70
Quick Access Button Default Functions............................................................... 71
MobiLink SMS Client............................................................................................ 72
Compose Message .............................................................................................. 74
Address Book....................................................................................................... 76
Select Group Contacts......................................................................................... 77
RF Connector..................................................................................................... 216
Mini PCI Express Connector.............................................................................. 217
Table of Tables
Table 1:
Table 2:
Table 3:
Table 4:
Table 5:
Table 6:
Table 7:
Host Interface specification.................................................................................. 21
LED Function ....................................................................................................... 22
EV620 DC Specifications..................................................................................... 23
EU740 DC Specifications..................................................................................... 23
EU730 DC Specifications.................................................................................... 24
GPRS/GSM Duty Cycles and Typical power consumption ................................. 24
EV620 Power Class ............................................................................................. 25
Novatel Wireless, Proprietary & Confidential
Page12
Table 8:
Table 9:
Table 10:
Table 11:
Table 12:
Table 13:
Table 14:
Table 15:
Table 16:
Table 17:
Table 18:
Table 19:
Table 20:
Table 21:
Table 22:
Table 23:
Table 24:
Table 25:
Table 26:
Table 27:
Table 28:
Table 29:
Table 30:
Table 31:
EU740 Power Classes ......................................................................................... 25
EU730 Power Classes ......................................................................................... 26
EU730/740 Environmental Specification ............................................................. 35
EV620 Environmental Specification..................................................................... 35
Suggested Ramp Timing for Scheme 2............................................................... 42
Design specifications for the Diversity EVDO antenna........................................ 42
CDMA Test Frequencies...................................................................................... 44
GSM-1900 Test Frequencies............................................................................... 44
Status Indication .................................................................................................. 53
3G Indicators........................................................................................................ 57
Menu Subjects ..................................................................................................... 58
General Tab Features.......................................................................................... 63
Mobile Tab Features ............................................................................................ 64
Identity Properties ................................................................................................ 67
Report Values ...................................................................................................... 68
Mailbox List .......................................................................................................... 72
Fields List............................................................................................................. 73
Tool Bar Button .................................................................................................... 74
Destination Addresses ......................................................................................... 75
Address Books..................................................................................................... 76
CME Error Codes............................................................................................... 204
CMS Error Codes............................................................................................... 205
R&TTE ............................................................................................................... 208
GSM/GPRS European Regulations................................................................... 209
Novatel Wireless, Proprietary & Confidential
Page13
Introduction
PCI Express Mini Card
Novatel Wireless has designed a line of embedded broadband access modules around the PCI
Express Mini Card standard. This product line provides platform developers and system
integrators with the ability to enable global 3G broadband access. The governing body for PCI
Express standardization is PCI SIG (Peripheral Component Interconnect Special Interest Group.)
The website for PCI SIG can be found at the following URL:
www.pcisig.com/home
Novatel Wireless, Proprietary & Confidential
Page14
Getting Started
Introduction
The purpose of this document is to provide advance design and integration information to assist
in the integration planning and evaluation of Novatel Wireless PCI Express Mini-cards. This
document is intended to specify key components of the integration tools available for the Novatel
Wireless line of PCI Express Mini-cards.
The EV620 is Novatel Wireless’s versatile module to add WLAN capability to other devices. It
was developed to be integrated into other devices such as kiosks or vending machines based on
the PCI Express Mini-card specification 1.0.
The EU730™ and EU740™ are Novatel Wireless’s mini-card developed for small form factor PCI
Express cards specifically used for Wide Area Wireless (WAN, i.e. cellular) technology.
Therefore, the EU730™ and EU740™ will work with all Windows driven laptops given the drivers
are properly installed. When you install MobiLink™ on a Windows OS system it will automatically
include the drivers necessary to communicate with the PCI Express Mini Card. MobiLink™ is
Novatel’s Windows application manager for the PCI Express Mini Card. MobiLink provides an
easy interface to make a data connection, change operating parameters, and view alerts such as
SMS or signal strength indicator. However, anyone can still install the drivers manually and so will
be discussed in the following sections. In addition, once the drivers are installed, following the
Phoenix Client API functions, anyone could develop their Client side software manager to interact
with the PCI Express Mini Card.
When using any of these devices, EU730, EU740™ or the EV620, activation is required for the
device to be allowed on the operator’s network. For example, Sprint requires the customer to run
IOTA, Internet Over-The-Air, provisioning to prepare the device to work on the wireless network.
Activation is required for the EV620 while the EU730™ and EU740™ require a valid SIM card
before it can be used on the operator’s wireless network. Please refer to section on provisioning
with IOTA for assistance.
Windows Platforms
The Phoenix API will interface with your top level applications and provide the abstraction of the
module specifics to the upper applications. Please refer to the Phoenix API Interface Chapter for
details.
Please refer to the MobiLink Phoenix SDK chapter for details on developing applications and
communicating with the modem on Windows platforms.
Safety Warning
Neither the EV620 nor EU730 / EU740 products may be used in an environment where radio
frequency equipment is prohibited or restricted in its use. This includes aircraft/airports, hospitals,
and other sensitive electronic areas.
Under extended operation the EU730™ and EU740™ modem will generate a noticeable amount
of heat. Like all PC Cards, the modem generates heat during normal operation and will be heated
by the host computer. For this reason it is recommended that after extended periods of operation,
prior to removal and handling, you allow the modem to cool down.
Novatel Wireless, Proprietary & Confidential
Page15
FCC RF Interference Statement
FCC applies to EV630 and EU730/740. Refer to sections on Regulatory Compliance for more
details.
Federal Communications Commission Radio Frequency Interference Statement: The EV620
product has been certified to comply within the limits of a class B digital device pursuant to Part
15, Part 22 and Part 24 of the FCC Rules. These limits are designed to provide reasonable
protection against harmful interference in residential situations. This equipment generates, uses,
and can radiate radio frequency energy, and, if not properly installed and used in accordance with
the instructions, may cause harmful interference to radio or television reception, or to laptop
computers and PDA's. This can be determined by turning the equipment on and off. You are
encouraged to try to correct the interference by one or more of the following measures:
•
Reorient or relocate the receiving antenna of the television, radio or cordless telephone.
•
Increase the separation between the equipment and the receiver.
•
Connect the equipment to an outlet on a circuit different from that to which the receiver is
connected.
•
Consult the dealer or an experienced radio/television technician for additional
suggestions.
Radio Frequency Exposure Evaluation Requirements
The radio frequency exposure evaluation requirements for the embedded module are specified in
the module Product Specification. In general, for the United States market, the embedded
modules are treated as “mobile devices” as per FCC CFR47 paragraph 2.1091.
A mobile device is defined as “a transmitting device designed to be used in other than fixed
locations and to generally be used in such a way that a separation distance of at least 20 cm is
normally maintained between the transmitter’s radiating structure(s) and the body of the user or
nearby persons.” The antenna type used for the radio frequency exposure evaluation must be
specified in the documentation and sold with the module. If the module is used with a different
antenna type and/or in a design where the separation distance of 20 cm is not normally
maintained, the radio frequency exposure evaluation should be repeated for the new
configuration. In some cases the module use may fit the definition of “portable devices” as per
FCC CFR47 paragraph 2.1093.
Some devices are not subject to radio frequency exposure evaluation prior to equipment
authorization, depending on the transmitter power level and frequency band of operation.
Technical Support Contacts
WWW: http://www.nvtl.com/support/index.html
Email: support@novatelwireless.com
Novatel Wireless, Proprietary & Confidential
Page16
Device Specifications
Introduction
The purpose of this document is to provide the specifications for the EU730/EU740 and the
EV620 module. This section is intended to specify electrical, mechanical and software interfaces
and performance; and to provide the information necessary to integrate the module into an overall
product design.
Product Overview
The EV620 will operate in the 800/1900 CDMA bands. The EV620 is primarily targeted for the
North American market.
The EU730 and EU740 are wireless modem modules designed to be embedded into laptop
computers and other host devices.
The EU730 & EU740 provide for quad band GSM support as well as UMTS/HSDPA operation at
800MHz, 1900MHz & 2100MHz. The EU730 is primarily targeted for the North American market
and the EU740 is primarily targeted for EMEA (Europe, Middle East and African) markets.
•
The EU740 will operate in the 850/900/1800/1900 GPRS/EDGE bands and 2100
UMTS/HSDPA band.
•
The EU730 will operate in the 850/900/1800/1900 GPRS/EDGE bands, and 1900
MTS/HSDPA band.
The modules will be compatible with Windows™ compliant applications including VPN, e-mail,
and web browsing.
The core protocol stack will be supplied by Qualcomm and contains UMTS, HSDPA, GPRS and
EDGE technologies for EU730/740, and CDMA, CDMA 1XRTT, and CDMA 1XEV-DO
technologies for EV620. Around this core, Novatel Wireless has created the firmware drivers that
provide access to the hardware on the embedded modem. The feature set is comprised of the
data device features supported in the Qualcomm protocol stack.
The hardware consists of a PCI Express Mini Card compliant interface (except as detailed
herein), a baseband chipset from Qualcomm™, an RF radio chipset from Qualcomm™, and the
various other components used to support these major components. The baseband and firmware
are based on the MSM6275 series chipset for EU730/740 and MSM6500 series chipset for
EV620.
Hardware
Card Specifications
The EV620, EU730 and EU740 are designed to meet the PCI Express Mini Card electromechanical card standard with some exceptions to accommodate the power requirements. The
EU730 and EU740 are USB only cards.
Novatel Wireless, Proprietary & Confidential
Page17
Mechanical Specification
The drawing below shows the dimensions of the EV620 module. The measurements given below
are typical. Consider thickness to be 5.0 max in designing.
Figure 1: EV620 Module
The drawing below shows the dimensions of the EU730/EU740 module.
Novatel Wireless, Proprietary & Confidential
Page18
Figure 2: EU730/EU740 Module
Novatel Wireless, Proprietary & Confidential
Page19
Figure 3: PCIe Minicard Module Envelope
5.0 mm
1.35 mm
Shielding / Mechanical enclosure
The EU730 and 740 use a metalized plastic shield technology. The shields are held in place
using solder balls.
The EV620 will use a stamped sheet metal shield technology. The shields are held in place with
solder.
Host Interface connector
The host interface connector is a 1 mm wide card edge connector. This is compatible with the
following host connectors:
Novatel Wireless, Proprietary & Confidential
Page20
Molex
67910-0002
FCI
10019331-001
The host connector should be compliant with the Mini PCI express Electromechanical
specification.
Interface Specification
Host Interface
The EV620 and EU730/740 is designed to meet the PCI Express Mini-Card specification. The
table below gives a description of the pin-out and usage. The USB option of the specification is
supported. Deviations from the Mini PCI Express card specification are noted.
The PCI Express Mini Card provides two power sources: one at 3.3V (+3.3V) and one
at 1.5V (+1.5V). The auxiliary voltage source (+3.3Vaux) is sourced over the same pins as the
primary voltage (+3.3V) and is available during the system’s stand-by/suspend state to support
wake event 5 processing on the communications card.
Table 1:
Host Interface specification
Pin
PCIe Spec
EV620
EU730/740
Pin
PCIe Spec
EV620
EU730/740
11
13
15
WAKE#
Reserved
Reserved
CLKREQ#
GND
REFCLKREFCLK+
GND
NC
NC
NC
NC
GND
NC
NC
GND
NC
NC
NC
NC
GND
NC
NC
GND
10
12
14
16
3.3V
GND
1.5V
UIM_PWR
UIM_DATA
UIM_CLK
UIM_RESET
UIM_VPP
3.3V
GND
NC
UIM_PWR
UIM_DATA
UIM_CLK
UIM_RESET
NC
3.3V
GND
NC
UIM_PWR
UIM_DATA
UIM_CLK
UIM_RESET
NC
GND
W_DISABLE#
PERST#
+3.3Vaux
GND
+1.5V
SMB_CLK
SMB_DATA
GND
USB_DUSB_D+
GND
LED_WWAN#
LED_WLAN#
LED_WPAN#
+1.5V
GND
3.3V
GND
W_DISABLE#
NC
NC
GND
NC
NC
NC
GND
USB_DUSB_D+
GND
LED_WWAN#
NC
NC
NC
GND
3.3V
GND
W_DISABLE#
NC
NC
GND
NC
NC
NC
GND
USB_DUSB_D+
GND
LED_WWAN#
NC
NC
NC
GND
3.3V
Mechanical Key
17
19
21
23
25
27
29
31
33
35
37
39
41
43
45
47
49
51
Reserved
Reserved
GND
PERn0
PERp0
GND
GND
PETn0
PETp0
GND
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
Reserved
NC
NC
GND
NC
NC
GND
GND
NC
NC
GND
GND
3.3V
3.3V
GND
NC
NC
NC
NC
NC
NC
GND
NC
NC
GND
GND
NC
NC
GND
GND
3.3V
3.3V
GND
NC
NC
NC
NC
18
20
22
24
26
28
30
32
34
36
38
40
42
44
46
48
50
52
Novatel Wireless, Proprietary & Confidential
Page21
USB Interface
The Mini card acts as a peripheral device and supports the USB 2.0 standard at low speed (1.5
Mbps) and full speed (12 Mbps). It does not support the high speed (480 Mbps) mode of
operation.
RF Interface
The EV620 and EU730/740 are designed to be connected to an external antenna integrated into
the laptop. The antenna port presents a nominal 50Ω impedance.
Subscriber Identification Module (SIM) Interface
A 5 line SIM interface is provided on the mini-card edge connector for the EU730/740. The signal
levels comply with the ETSI standard Specification of the 3 Volt Subscriber Identity Module Mobile Equipment (SIM-ME) interface (GSM 11.12 version 4.3.1). Note that no ESD protection
will be provided on the card. The host device is expected to provide the ESD protection at the
SIM connector.
The OEM Module supports a 3.3V SIM as described in ETSI 11.12. The relevant signals are
brought out on the 70 pin connector.
The ETSI specification also dictates that the system be made aware if the SIM card is
disconnected during operation. This function is handled by the SIM_IN signal. This line should be
asserted high when a SIM is present. The SIM_IN signal is pulled low on the OEM Module by a
4.7kΩ resistor so that when a SIM is not present the line will be low. Care should be taken not to
use a weak pull-up for the SIM_IN signal. If the OEM Module will be integrated into a system in
which the SIM cannot be removed.
USIM Interface
The USIM will be provided by the host. A SIM connector is not included on the card. The interface
to the USIM is provided on the host interface connector.
LED Interface
The LED_WWAN signal provides an LED driver as per the Mini Express PCI card specification.
The LED operation is outlined in the table below.
Table 2:
LED Function
State
LED function
On
The WWAN radio is on, and capable of transmitting.
Off
The WWAN radio is not capable of transmitting
Slow Blink
Powered but not associated or authenticated; searching
Intermittent blink
Activity proportional to transmitting/ receiving speed
Novatel Wireless, Proprietary & Confidential
Page22
Power Supply
Power is drawn from the 3.3V pins on the Mini Card connector as shown in tables following. The
current in the various operating modes in given.
Table 3:
EV620 DC Specifications
Symbol
Parameter
Min
Typical
Max
Units
Vcc
Supply Voltage
3.0
3.3
3.6
Icc max
maximum supply current
1000
mA
Icc stdby
Target Standby supply current
TBD
mA
Table 4:
EU740 DC Specifications
Symbol
Parameter
Min
Typ
Max
Units
Vcc
Supply Voltage
3.04
3.3
3.56
Icc max
maximum supply current
2750
mA
Icc stdby
Target Standby supply current
180
Icc csd
Target CSD supply current
500
TBD
mA
Icc grps avg
Target GPRS supply current
average
750
TBD
mA
Icc grps
peak
Target GPRS supply current peak
2200
TBD
mA
Icc WCDMA
Target WCDMA supply current
900
TBD
mA
Novatel Wireless, Proprietary & Confidential
Page23
mA
Table 5:
EU730 DC Specifications
Symbol
Parameter
Min
Typ
Max
Units
Vcc
Supply Voltage
3.04
3.3
3.56
Icc max
maximum supply current
2750
mA
Icc stdby
Target Standby supply current
180
Icc csd
Target CSD supply current
500
TBD
mA
Icc grps avg
Target GPRS supply current
average
750
TBD
mA
Icc grps
peak
Target GPRS supply current peak
2200
TBD
mA
Icc WCDMA
Target WCDMA supply current
Table 6:
mA
mA
GPRS/GSM Duty Cycles and Typical power consumption
Mode
Average battery power
Peak & duty cycle
GPRS Transmitting
2.3 W average
7.0 W / 25%
GPRS Receiving
2.3 W average
7.0 W / 25%
GSM Transmitting
1.7 W average
7.7 W / 12.5%
GSM Receiving
1.7 W average
7.7 W / 12.5%
Novatel Wireless, Proprietary & Confidential
Page24
Power Class
The power classes are shown in following tables.
Table 7:
Band (MHz)
800
1900
Power Class
Comment
CDMA
Class III
+23dBm ERP
CDMA 1XRTT
Class III
+23dBm ERP
CDMA 1XEV-DO
Class III
+23dBm ERP
CDMA
Class II
+23dBm EiRP
CDMA 1XRTT
Class II
+23dBm EiRP
CDMA 1XEV-DO
Class II
+23dBm EiRP
Table 8:
Band (MHz)
850
900
1800
1900
2100
EV620 Power Class
EU740 Power Classes
Power Class
Comment
GPRS
+33 dBm nominal
EDGE
E2
+27 dBm nominal
GPRS
+33 dBm nominal
EDGE
E2
+27 dBm nominal
GPRS
+30 dBm nominal
EDGE
E2
+26 dBm nominal
GPRS
+30 dBm nominal
EDGE
E2
+26 dBm nominal
UMTS/HSDPA
+24 dBm nominal
Novatel Wireless, Proprietary & Confidential
Page25
Table 9:
Band (MHz)
EU730 Power Classes
Power Class
Comment
GPRS
+33 dBm nominal
EDGE
E2
+27 dBm nominal
GPRS
+33 dBm nominal
EDGE
E2
+27 dBm nominal
GPRS
+30 dBm nominal
EDGE
E2
+26 dBm nominal
GPRS
+30 dBm nominal
EDGE
E2
+26 dBm nominal
1900
UMTS/HSDPA
+21 dBm nominal
850
UMTS/HSDPA
+21 dBm nominal
850
900
1800
1900
WDISABLE
The modem is made incapable of transmitting when the WDISABLE pin is pulled low. The
following diagram illustrates the Pull-Up resistor configuration:
Figure 4: W_Disable Pull-up Configuration
Novatel Wireless, Proprietary & Confidential
Page26
Electrostatic Discharge and Electro-Magnetic Interference
The modem does not protect itself from ESD. It is the responsibility of the host to ensure that
there will not be any harmful discharges to the modem.
With regard to EMI, the modem will meet FCC part 15 for North American markets, and ETSI EN
301 489-1 for European markets. This device when incorporated in any other product may require
FCC and/or other approvals. It is the user’s responsibility to do this.
Firmware
Overview
The firmware for the EU730/740 is comprised of the Qualcomm supplied UMTS/GPRS protocol
stack (Advanced Mobile Subscriber Station (AMSS) 6275 Software) with additional Novatel
Wireless firmware specific to the Mini Card implementation. The firmware runs on ARM9 core in
the MSM6275 ASIC.
The firmware for the EV620 is comprised of the Qualcomm supplied CDMA2000 protocol stack
(Advanced Mobile Subscriber Station (AMSS) 6500 Software) with additional Novatel Wireless
firmware specific to the PC card implementation. The firmware runs on ARM9 core in the
MSM6500 ASIC.
Memory
In order to reduce the MSM6275 and the MSM6500 firmware memory footprint, unused
application features, drivers and services are removed. The network protocol layers (Mobility
Management, Data services, Radio Resource Control, Radio Link Control, Media Access Control,
Physical Layer control and Drivers to Qualcomm’s RF chipsets) remains unaltered.
EU730/740 Firmware Features
Protocol of HSDPA Features for EU730/740
•
•
•
•
•
•
•
•
•
•
UMTS: 3GPP Release 5, June 2004
UE Category 12, QPSK, 1.8 Mbps Peak Rate
• QTC Release 2 will support 384 Ul and 1.8 M DL
PS RAB (DL: up to 1.8M and UL: up to 384 K) on HSDPA channel
DCCH 3.4 Kbps
Establish/ Release/ Reconfigure of HSDPA channel
HSDPA channel re- pointing (Synchronized and non- synchronized cell change ) for
mobility.
Up switching and Down switching of PS RAB between DPCH and HS- DSCH
Switching between HSDPA channel and common channel
Integrity protection and ciphering
Primary PDP context.
Novatel Wireless, Proprietary & Confidential
Page27
GPRS/EGPRS Protocol and Feature Rollout for EU730/740
GPRS
•
•
•
•
•
•
•
channel coding schemes CS1-4
link adaptation
multislot class 10
One-phase packet access
Two-phase packet access
GPRS test modes ( ETSI test mode A and B)
Attach / Detach
• GPRS detach only
• Combined GPRS/IMSI detach
• MS-initiated detach
• NW-initiated detach
• Automatic GPRS attach at power-up
• GPRS attach status indication
EGPRS
•
•
•
•
•
•
•
•
•
•
Uplink modulation and coding schemes MCS 1-4
downlink modulation and coding schemes MCS 1-9
8PSK modulation on both uplink and downlink for MCS 5-9
multislot class 1
One-phase packet access
Two-phase packet access
EGPRS test modes (ETSI test mode A and B)
EGPRS link adaptation
EGPRS incremental redundancy
EGPRS multislot class 10
NC0
Medium access modes – dynamic allocation
RLC-acknowledged operation mode
RLC unacknowledged operation mode
LLC-acknowledged transmission mode
LLC-unacknowledged transmission mode
GSM network operation mode I
GSM network operation mode II
PBCCH/PCCCH support in NOM I
PDP Context
•
•
•
•
•
•
•
•
•
Mobile-originated PDP context activation
Mobile-originated PDP context deactivation
Network-originated PDP context deactivation
Network-originated PDP context activation
PDP context modification (NW initiated)
Active PDP context indication
PDP address (IPv4)
PDP address (IPv6)
PDP context type – IP
• Static IP
• Dynamic IP
Novatel Wireless, Proprietary & Confidential
Page28
•
• RFC1144 TCP/IP header compression
• WINS address support-primary and secondary
QoS
• Support QoS profile (release 97)
• Enhanced QoS (refer to 3GPP TS 22.060, Section 5.6.2; TS 24.008, Section
10.5.6.5)
• Support QoS profile (release 99, EGPRS-capable terminals)
• Background QoS class supported
• Interactive QoS class supported
• Streaming QoS class supported
V.42bis data compression
Carrier will be able to program GPRS service parameters (PDP context) (via Application Profile)
Data counter (time and transferred bytes per session and cumulative sessions)
Packet enhanced measurement report (PEMR)
Network-assisted cell change (R4 GERAN Feature Set 1)
Extended UL TBF mode (R4 GERAN Feature Set 1)
UMTS
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Cell_PCH and URA_PCH
WCDMA-to-GPRS reselection in CELL_FACH
64K Sync CSD
Radio link failure (RRC)
Inter-frequency reselection in Cell_FACH
CLTD mode 1
SIB scheduling
Path loss measurements
6F/6G (UE internal)
Re-establishment procedure
SIB modification
SIB 7
Inter-frequency redirection
Inter-RAT redirection (RRC connection reject to GSM)
HCS
Security
•
•
•
•
•
•
•
•
•
•
•
•
Support of encryption A5/1
Support of encryption A5/2
GPRS ciphering algorithm GEA1
GPRS ciphering algorithm GEA2
PAP for RADIUS authentication - GPRS/EGPRS
CHAP for RADIUS authentication - GPRS/EGPRS
Support for encryption algorithm UEA1 (Kasumi)
Support for integrity algorithm UIA1 (Kasumi)
IMEI Security
OMA DRM v1.0
• Forward lock
• Combined delivery
• Separate delivery
OMA DRM v2.0
SIM lock
Novatel Wireless, Proprietary & Confidential
Page29
SMS
•
•
•
•
•
•
•
•
•
Mobile-originated SMS (MO-SMS) over CS channel
Mobile-originated SMS (MO-SMS) over PS channel
Mobile-originated SMS over PS shall fall back to CS if: a) PS service is not available, or
b) there is a PS network failure
Mobile-originated SMS (MO-SMS) concatenation (minimum of 5 segments)
Mobile-terminated SMS (MT-SMS) over CS channel
Mobile-terminated SMS (MT-SMS) over PS channel
Mobile-terminated SMS (MT-SMS) concatenation (minimum of 5 segments)
Mobile-originated SMS email
Mobile-originated SMS email concatenation (minimum of 5 segments)
USSD
•
•
Unstructured supplementary service data – mobile-originated (MO-USSD)
Unstructured supplementary service data – mobile-terminated (MT-USSD)
•
•
•
•
•
•
•
•
Calling Line Identification Restriction (CLIR)
Calling Name Presentation (CNAP)
Barring of All Outgoing Calls (BAOC)
Barring of Outgoing International Calls (BOIC)
Barring of Outgoing International Calls except to Home PLMN (BOIC-exHC)
Barring of All Incoming Calls (BAIC)
Barring of All Incoming Calls when Roaming outside the Home PLMN (BIC-Roam)
International Access Function “+“
SS
Network Selection
•
•
•
•
•
•
•
•
Support for the network selection procedures described in 3G 22.011, R4 minimum
Support for the network selection procedures described in 3G 23.122, R4 minimum
Support for the RRC connection reject message to redirect from a 3G system to a 2G
system, according to 25.331, R4 minimum
Support for the network selection procedures described in 3G 43.022, R4 minimum
Support for an initial HPLMN scan at a 2mins after power on
Support for a HPLMN rescan irrespective of the serving MCC
Support of equivalent PLMN
Network selection within 30 seconds upon power up
Inter-RAT and Inter-Frequency
•
•
•
•
•
•
•
•
•
•
GSM900 1 WCDMA2100 handover – blind mode
GSM1800 1 WCDMA2100 handover – blind mode
GSM900 " WCDMA2100 handover – idle frame measurements
GSM1800 " WCDMA2100 handover – idle frame measurements
GSM900 1 WCDMA2100 cell reselection
GSM1800 1 WCDMA2100 cell reselection
GSM900 1 WCDMA2100 CCO
GSM900 1 WCDMA 2100 CCO
GSM900 (w/BCCH/ PBCCH) " WCDMA2100 reselection in packet transfer
GSM1800 (w/BCCH/ PBCCH) " WCDMA2100 reselection in packet transfer
Novatel Wireless, Proprietary & Confidential
Page30
•
•
•
•
•
•
PS data continuity during OOS and RAT change
PS data continuity with MPDP (primary and secondary contexts) and RAT change
EDGE 1 WCDMA cell reselection in packet transfer
Inter-RAT NACC 2G 1 3G
3G background PLMN search while in 2G
3G background PLMN search while in 3G
HSPDA
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Category 12 (QPSK)
Code Rates
• Rate ¼
• Rate ½
• Rate 1/3
HSDPA Logical Channels
• HS-SCCH
• HS-DPCCH
• HS-PDSCH
• Up to 5 HS-PDSCH channels support
HSPDPA Transport Channels
• HS-DSCH
• . 120 kbps
• . 240 kbps
• . 360 kbps
Fast L1 HARQ
Incremental redundancy
Chase combining retransmission scheme
Multi-Code Operation 1 code
• 5 codes
• 480 kbps
• 600 kbps
• 720 kbps
• 1.2 Mbps
• 1.8 Mbps
Fast link adaptation
Vary the effective code rate
HARQ, MAC-HS disassembly
MAC-HS reordering queue distribution and processing support
Synchronous and non-synchronous cell change support
Intra-NodeB (softer re-pointing) cell change support
Inter-NodeB (soft re-pointing) cell change support
Up-switching and down-switching of PS RAB between HS-PDSCH and DPCH
Ciphering on the HS channel
Support to not resume the HS channel if inter-RAT handover fails, but save the RB
mapping information
Support to not resume the HS channel if a radio link failure occurs, but save the RB
mapping information
QoS
• Background QoS class supported
• Interactive QoS class supported
• Streaming QoS class supported
Novatel Wireless, Proprietary & Confidential
Page31
System
•
•
•
Network Selection
Enhanced Network Selection (ENS)
Supplementary Services
SIM
•
Dual IMSI
Fixes to Feature and Protocol deficiencies identified through testing of Beta Release
HSDPA Compressed mode with active HS channel
Video on DPCH
MAC-d de-multiplexing
EV620 Firmware Features
Firmware Naming Convention
There are two firmware release strings that can be retrieved from the device, a short form
consisting of a three digit decimal starting at 100 and run sequentially and a long string M6500CBBIRD-XXXXX.YYY [MMM DD HH:MM:SS]. XXXXX is the Qualcomm base release and patch
level, YYY is identical to the three digit decimal from the short form, [] contains the release date
and time.
The starting version of firmware is 136.
Standards Support
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
IS-707: 14.4 kbps Data Services
TSB-74: 14.4 kbps Radio Link Protocol and Interband Operations
TIA/EIA/IS-2000 PN-4756 (Ballot Version): Addendum 1 (to the IS-2000 standard)
IS-707A: CDMA Data Services Revision for IS-95B
IS-707A-1: CDMA Data Services Revision for cdma2000 Rel. 0
IS-95A, IS-95B: CDMA Dual-Mode Air Interface Standard
PN-4430 (Ballot Resolution Version 0.14, to be published as TIA/EIA-IS-2000.4):
cdma2000: Signaling Layer 2 Standard for Spread Spectrum Systems
J-STD-008: IS-95 adapted for 1900 MHz frequency band
PN-4429 (Ballot Resolution Version, to be published as TIA/ EIA-IS-2000.3): Medium
Access Control (MAC) for cdma2000 Spread Spectrum Systems
TIA/EIA-95-B: Mobile Station-Base Station Compatibility Standard for Dual-Mode Spread
Spectrum Systems
IS-683A: OTA Update: Roaming System Selection and Programming Block
PN-4428 (Ballot Resolution Version, to be published as TIA/ EIA-IS-2000.2): Physical
Layer Standard for cdma2000 Spread Spectrum Systems
IS-637A: Short Message Service including mobile-origination
PN-4431 (Ballot Resolution Version 1.06, to be published as TIA/EIA-IS-2000.5): Upper
Layer (Layer 3) Signaling Standard for cdma2000 Spread Spectrum Systems
IS-856-2 (3GPP2 C.S0024): cdma2000® High Rate Packet Data Air Interface
Specification
Novatel Wireless, Proprietary & Confidential
Page32
Frequency Band Support
•
•
Band Class 0 – Cellular 800 MHz
Band Class 1 – PCS 1.9 GHz
CDMA Air Interface
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
TIA/EIA/IS-95-A Air Interface
TIA/EIA-95-B Air Interface
J-STD-008 + TSB74 Air Interface
TIA/EIA/IS-2000-0 Air Interface
TIA/EIA/IS-2000-A Air Interface
TIA/EIA/IS-2001 Data Session Handoff
TIA/EIA-126 Loop back Services
TIA/EIA/IS-870 Test Data Services
TIA/EIA/IS-871 Markov Services
TIA/EIA/IS-707-A Data Services
TIA/EIA-637-A Short Message Services
TIA/EIA/IS-683-A OTASP Services
Traffic State Receiver Diversity Combining
Idle State Low-Power Slotted Mode
Dynamic P_REV Specification
Dynamic Feature Selection
1XEV-DO Air Interface
•
•
•
•
•
•
•
•
•
•
•
•
TIA/EIA/IS-856-2 Air Interface
TIA/EIA-878 Authentication and Session Handoff
TIA/EIA/IS-890-1 Test Application
Connected State Receiver Diversity Combining
Idle State Low-Power Slotted Mode
Acquisition State Micro Searching
Connected State Off-Frequency Neighbor Searching
Extended Username and Password for AN Authentication
System Access Inhibit Response
Air Interface Session Association With PPP Session
1xEV-DO to 1x Hand-Down Algorithm DRC Filter
1xEV-DO Suspend timer disabled
Multimode Services
•
•
•
•
•
•
•
•
•
System Determination 2.0
Multimode Call Manager
TIA/EIA/IS-683C Preferred Roaming List
CDMA-Only Mode
HDR-Only Mode
CDMA+HDR Mode
CDMA+HDR Hybrid Mode
CDMA QPCH in Hybrid Idle State
Hybrid in CDMA Power-Save
Novatel Wireless, Proprietary & Confidential
Page33
Data Services
•
•
•
•
•
•
•
•
•
•
•
TIA/EIA/IS-707 AT Command Processing
TIA/EIA/IS-835 Wireless IP Networking
Internet Protocol Stack (TCP/UDP/IP/PPP)
Simple IP Address Management
Mobile IP Address Management
RFC1750 Dynamic Mobile IP Key Update (DMU)
Embedded internet over the air (eIOTA) activation Client
Relay Mode Operation
Network Mode Operation
Sockets Mode Operation
Socket Layer API
UIM Card Services
•
No R-UIM Support will be provided.
Universal Serial Bus Interface
•
•
•
•
•
•
•
USB Specification 2.0
Full Speed Device Operation
Communications Device Class Profile
Composite Device Profile
Data Service Interface
Diagnostics Service Interface
Download Service Interface
Application Software
Novatel provides Mobilink™ application software . The software is defined in later Chapter.
MobiLink™ connection manager software to install and configure modem (for all supported
platforms)
AT Command Set Support per IS-707
Fully compatible and interoperable with current Microsoft OS platforms: PPC 2000/2002/HPC,
Windows 98, Windows 2000, Windows ME, & Windows XP
Integrated drivers for Windows OS, configurable as either a modem or network card
PCI Express Mini-card
Compatibility with all major brands of PC's and PPC computing platforms
Sleep Mode capabilities
Uses common base technology shared with OEM Module
IS-683A compliant - Over-The-Air activation and parameter update capabilities.
On-line help, getting started guide, documentation
All software applications necessary to communicate with the PCI Express Mini Card will operate
with the following platforms: PPC 200/2002/HPC, Windows 98, Windows 2000, Windows ME, &
Windows XP
Novatel Wireless, Proprietary & Confidential
Page34
All software shall support 640x480, 640x240, and 800x600 color and monochrome displays
MobiLink™ allows the user to configure the modem easily
MobiLink provides diagnostic capability
MobiLink provides a Help menu that is Context Sensitive
Environmental
The EU730/740 and EV620 will be compliant with the Mini PCI Express Electromechanical
specification as detailed in the table below.
It should be noted that Novatel Wireless cannot guarantee that the host device (laptop; PDA;
notebook etc.) will be able to endure these same environmental conditions. Users are advised to
consult the host device documentation for specifications and observe any restrictions of use.
Table 10: EU730/740 Environmental Specification
Parameter
Condition
Low Temperature Storage
-20 °C
High Temperature Storage
85 °C
Low Temperature Operating
0 °C
High Temperature Operating (within spec)
65 °C1
High Temperature Operating (relaxed spec)
85 °C
Relative Humidity
95% maximum (non condensing)
Vibration and High Frequency
147m/s2 (15G) peak; 10 to 2000 Hz
Drop
75 cm
Table 11: EV620 Environmental Specification
Parameter
Condition
Low Temperature Storage
-30 °C
High Temperature Storage
85 °C
Low Temperature Operating
-20 °C
High Temperature Operating
65 °C2
Relative Humidity
ESD
95% maximum (non condensing)
8kV Air / 4kV Contact
It is required that the shield temperature not exceed 80°C at anytime. It may be necessary for
the system integrator to provide some method to insure this surface temperature is not exceeded.
It is required that the shield temperature not exceed 80°C at anytime. It may be necessary for
the system integrator to provide some method to insure this surface temperature is not exceeded.
Novatel Wireless, Proprietary & Confidential
Page35
Vibration and High Frequency
Drop
147m/s2 (15G) peak; 10 to 2000 Hz
75 cm
The EV620 product operates in a reliable fashion consistent with CDMA (IS-98C) and PCMCIA
V2.1 standards. It will withstand three-foot drop and still remain functional.
Provisioning with IOTA
This applies only to the EV620. The EU730 & 740 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 EV620 module needs to perform any provisioning on Sprint’s network.
Since the EV620 module does not use MobiLink, you must run IOTA from the primary port on the
EV620 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 perform provisioning of the EV620. Once this is done, the EV620 can access the
1xRTT and 1xEVDO networks.
For use with Sprint PCS, the subscriber first needs to contact a sales representative to activate
the EV620. 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 EV620 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 EV620 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.
At the end of this section, there is a flowchart diagram that further explains the process of using
eIOTA.
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 EV620 has not already completed provisioning.
When the subscriber finishes entering the MDN or MIN, they could either enable eIOTA and have
the EV620 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:
Novatel Wireless, Proprietary & Confidential
Page36
•
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.
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, Proprietary & Confidential
Page37
Development Board
Fixture Diagram/Assembly Diagram
Novatel Wireless, Proprietary & Confidential
Page38
Photo of Top View
Novatel Wireless, Proprietary & Confidential
Page39
Schematic
Novatel Wireless, Proprietary & Confidential
Page40
Hardware Design Guidelines
Power Supply Requirements for GSM Bursting
One power ramping scheme uses two timings for high and low power levels, as shown in the
following representative ramps.
Figure 5: Up-ramp for Highest Power Levels
Figure 6: Up-Ramp for Lowest Power Levels
The Second power ramping scheme uses one timing for all power levels. A representative ramp
for low power levels is shown, with suggested ramp timings.
Novatel Wireless, Proprietary & Confidential
Page41
Table 12: Suggested Ramp Timing for Scheme 2
GSM PL 5 – 16
GSM PL 17 – 19
DCS PL 0 – 10
DCS PL 11 –15
TX_Enable high
Vramp start
-17 us
-17 us
-17 us
-17 us
-15 us
-8 us
-15 us
-8 us
Vramp length (to full
power)
14 us
7 us
14 us
7 us
Figure 7: Up-Ramp for Lowest Power Levels (Scheme 2)
SIM Card Socket Location
SIM Card must be placed so as to minimize trace length between SIM Card and Connector. If
there is too much distance this will impede good performance.
Antenna
1XEV-DO Diversity Antenna Requirements
Table 13: Design specifications for the Diversity EVDO antenna
Description
Primary Antenna (Transmit & Receive)
Peak Antenna Gain
Average Gain
Efficiency
Polarization (Ratio Gv:Gh)
Minimum
Maximum
1.0
-3.0
-4.0 (40)
0.0
Novatel Wireless, Proprietary & Confidential
Page42
Unit
dBi
dBi
dB (%)
dB
Input VSWR
Average Power Handling
Secondary Antenna (Receive Only Diversity)
Average Gain
Efficiency
Polarization (Ratio Gv:Gh)
Input VSWR
Antenna to Antenna Requirements
Isolation
Fading Correlation Coefficient
2.5:1
2.0
Watt
-9.0
-10.0 (10)
0.0
dBi
dB (%)
dB
2.5:1
-8.0
0.5
dB
dB (%)
FCC Implications – Mobile vs. Portable Devices
Testing for SAR for Portable Device must be done if within 20 cm of body. SAR testing is not
necessary for Mobile Devices.
TRP (Total Radiated Power) Requirements
Good radiated performance is critical to the effective operation of a mobile in networks. A
comprehensive characterizing of radiated performance enables carriers to know how well mobiles
work within the specific network design constraints. Generally , peak EIRP (Effective Isotropic
Radiated Power) is not a good indication of mobile performance in the field. From a field
performance perspective, measurement of the average and peak EIRP on a head model is more
meaningful than measurement of peak EIRP in free-space conditions. This spherical effective
isotropic radiated power is termed TRP (Total Radiated Power.) The TRP is the sum of all power
radiated by the antenna, regardless of direction or polarization, as illustrated below.
Figure 8: Total Radiated Power
Tests shall be carried out for three different frequency pairs across the bands supported by the
device, as defined for CDMA TIA/EIA-98-D and for GSM 1900 3GPP TS 51.010 in the tables
below.
Novatel Wireless, Proprietary & Confidential
Page43
Table 14: CDMA Test Frequencies
Table 15: GSM-1900 Test Frequencies
Radiated power measurements will be recorded in the “free-space” configuration on all applicable
frequencies. For portable units , TPR measurements are repeated on all applicable frequencies.
TPR will be reported using the Figure of Merit for industry analysis. Device power shall comply
with the power levels specified in the relevant industry standards.
Novatel Wireless, Proprietary & Confidential
Page44
MobiLink Phoenix SDK
Introduction
This document describes the high-level architecture and design of the Phoenix SDK. This SDK is
meant for Novatel Wireless data products.
Requirements
•
Single Server
•
Multiple Clients
•
Support Novatel Wireless product line
•
Single, Internal State Machine
•
Event Driven support for 2-way communication
SDK MODULES
Any number of Client applications can take full advantage of the Phoenix SDK.
Figure 9: Applications
MobiLink
UCM
SMS Client
Address
book
Web Update
Applications
ActiveX
Phoenix &
Blaze
NetMonke
Profile
Manager
Hotspot
Finder
Menu
Utilities
Phoenix & Blaze
Phoenix is the brains of the SDK. Phoenix maintains a single state machine which 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 wanting to use
Phoenix in Visual Studio, import the type library Phoenix.tlb and create a wrapper class for it.
Novatel Wireless, Proprietary & Confidential
Page45
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 wanting 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.
Sample Code: Refer to PhoenixClient VC++/MFC Project
NetMonkey
NetMonkey ActiveX control provides interfaces to some very useful networking components for
managing WLAN, LAN, & WWAN. The WLAN component utilizes Windows XP’s Wireless Zero
Config when managing and configuring Wi-Fi access points for seamless and easy-to-use
access. Currently, the WWAN component supports only Novatel Wireless products, given the
proper NDIS drivers. Refer to NetMonkey.chm for API documentation.
Profile Manager
Profile Manager ActiveX control helps to manage many types of WWAN network configurations
needed in order to make successful connections to a network. Mostly utilized by UMTS/HSDPA
networks, it provides a means to store settings like PDP type, PDP Address, APN, Quality of
Services settings, IP addresses, proxy settings and more. Each profile is maintained in a local
database in a proprietary XML format. Profile properties allow for seamless use via the Phoenix
server API. Refer to ProfileManager.chm for API documentation.
Hotspot Finder
Hotspot Finder ActiveX control, given a database directory of Wi-Fi hotspots, provides a simple
GUI which allows the end-user to easily refine searches in order to find the closest Wi-Fi hotspot.
Refer to Hotspots.chm for API documentation.
Menu
Menu ActiveX control, currently used in MobiLink, provides a set of GUI’s for the end-user. The
Properties dialog displays details relating to the currently selected device. The Configuration
dialog provides a means to change certain UI settings, as well as change a limited amount of
WWAN, WLAN, and LAN settings. The Report dialog shows connection logs and statistics, while
the Unlock dialog provides a UI for unlocking the current device. Lastly, the Activation dialog
provides a step-by-step Wizard for the user to activate his or her device, while the Debug dialog
provides immediate network debugging information for technical support. Refer to Menu.chm for
API documentation. (Debug Info and Activation work in progress)
Utilities
Utilities ActiveX control mainly provides a set of Novatel Wireless proprietary utility components.
Currently available is the Language component, which provides a set of translations for a number
of languages. Components involving any kind of UI take advantage of the Language component
in order to support localization. Refer to Utilities.chm for API documentation.
Novatel Wireless, Proprietary & Confidential
Page46
PHOENIX SERVER Software design
Overall module design is shown below.
Figure 10: Module Design
Phoenix
ActiveX
Modules
Main
State
Machine
DebugLog
PnP
Detection
RAS
SMS
Address
Book
##Debug
Universal
Loader
Single Server and Multiple Clients
Server-Client design has been implemented using COM and OLE Automation.
Figure 11: Automation Server
Menu
3rd Party
App
MobiLink
Automation
Server
Novatel Wireless, Proprietary & Confidential
Page47
Novatel Wireless Product Line Support
Customer driven product line will be support via the Universal Loader which will allow Phoenix a
generic means of communication to all products.
State Machine with 2-Way Communication
Figure 12: State Machine
MobiLink
Methods, Properties, and Events
Universal
Loader
Events
SMS
message
caching
Address Book
Caching
Thread
Phoenix server
Server-Client Communication Layer
Main Thread maintaining device
status and states
Novatel Wireless, Proprietary & Confidential
Page48
Menu ActiveX
SMS Client
3rd Party Application
MobiLink Connection Manager
Overview
Firmware is installed in all modems prior leaving the manufacturing facility. Firmware updates in
the EV620 can be performed by using the EV620 Development Kit Interface Board and Novatel’s
MobiLink. However in the EU730™ and EU740™, all that is necessary is the MobiLink software.
The MobiLink tool can also be used to change CDMA parameters and many other settings. All
these actions will be explained in the following sections.
These instructions may change for future product release.
The Novatel Wireless MobiLink™ Communications Software Suite is a family of wireless
connectivity applications that connect mobile devices using wireless wide area networks (WWAN)
as well as WiFi and Ethernet in a single application to allow quick and easy access to email, the
Internet and corporate networks anytime, anywhere. With MobiLink and a wide area wireless
device, mobile users can stay productive and connected to customers and colleagues while out of
the office. MobiLink is optimally engineered to work with all of Novatel Wireless' Wireless
Modems for best in class 3G wireless broadband access solutions.
The MobiLink Communications Software Suite of applications contains a messaging Client that
manages 2 way SMS operations, an addressbook Client that manages contacts and phone
number, connection manager that manages the connectivity, and a customization utility to
manage and generate install customization settings. The following section will detail the features
of each application.
Purpose
This section provides high level user interface information regarding the appearance and
operation of the MobiLink™ Connection Manager application developed for Windows 2000, XP
Pro, and XP Home.
Applicable Documents
All software names and version numbers displayed should meet the requirements outlined in the
Consistency & Naming Conventions Requirements Document. This document also covers
the requirements for the desktop, including the necessary icons and the use of the Start menu.
For more details on meeting the requirements for Microsoft Windows certification, refer to the
document entitled, Application Specification for Microsoft Windows 2000 and Windows XP
for Desktop Applications, which can be found on Microsoft’s web site.
GENERAL FEATURES
User Interface Functionality
The first design principle for MobiLink applications is that the basic information and controls
needed for day-to-day operations are quickly and easily accessible while less frequently used
functions are located deeper in the menu system. The user interface is designed to be intuitive to
use and will not require a large learning curve for the average user. The second design principle
Novatel Wireless, Proprietary & Confidential
Page49
for MobiLink is to be easily customizable in order to be able to meet the various requirements of a
global market.
Layout
The general layout of the main windows is designed to display important information for
connectivity while making it easy to navigate to other functions. The main function such as mobile
status and signal strength display is shown in the main window. The connection button is
prominently displayed and easily accessible. The main MobiLink display is shown below.
Figure 13: Main MobiLink Display
The Dashboard Area in the layout is designed as a launching area for other applications. The
default applications in the current design are internet browser, SMS Client, Addressbook, and
Help file. Other applications can be launched.
The Active Profile Selection is a list that allows for easy access to choose the active profile to use
for connection. For 3G, this list is a list of connection profiles while for WiFi, this is a list of access
points found. For WiFi, this list also shows the signal quality and whether the access point is
encrypted.
Lastly, there are the standard minimize and close buttons that are the main stay of any
application. The minimize button hides the application as a tray icon and the close button
gracefully closes the application.
Novatel Wireless, Proprietary & Confidential
Page50
Mouse Over
Mouse over is a feature of the application that displays helpful hint about the function of the
application as the mouse is moved over an active area of the application such as the menu
button.
Snap to Edge
Snap to edge is a feature that makes the MobiLink application window snap to the sides of the
Windows desktop as the user drags the application close to the edge.
Hot Swapping
The design of MobiLink allows for hot swapping of the 3G device. Users can plug and unplug a
3G wireless device and MobiLink will automatically recognize the technology and dynamically
change the display to show the relevant information.
Skinning Customization
Due to the software design and the underlying graphics engine used, the main “skin” of MobiLink
is completely customizable. The skin is contained in separate resource files that can be easily
changed for branding or function. One design is shown below and more can be developed.
Figure 14: Skin Design
Novatel Wireless, Proprietary & Confidential
Page51
Localization
It is the intent of the MobiLink™ connection manager design to be able to support localization.
Double byte Unicode is used and all the text used by MobiLink is kept in resource files that can
easily be translated and added. Currently MobiLink supports the following languages:
•
•
•
•
•
•
•
•
•
•
Chinese Simplified
Chinese Traditional
Danish
English
French
German
Italian
Spanish
Swedish
Polish
File
The MobiLink™ connection manager shall contain a help file that can be accessed through a help
button or via F1 key. The help file is also localizable and is in HTML format as shown below:
Figure 15: On-Line Help
Novatel Wireless, Proprietary & Confidential
Page52
MOBILINK™ FEATURES
The following sections describe the various features of MobiLink.
Main Display Window
The main display area of MobiLink is used for status indication of the different types of
connections. The following information is displayed.
Figure 16: Status Indication
Table 16: Status Indication
Number
Reference
Status Information
Description
Signal Strength Bar
This is the quality of the signal for the selected
Connection Status
This is a text indicating the connection status
Connect Duration
This indicates the number of hours, minutes, and
seconds the current connection has been up
Bytes Out/Packets Out
This indicates the number of bytes sent for the
current connection
Novatel Wireless, Proprietary & Confidential
Page53
5
Bytes In/Packet In
This indicates the number of bytes received for the
current connection
Network Name
For UMTS/HSDPA, this would show the network
name received from the AT+COPS command
Profile List
This is the list of supported profiles that contains the
connection settings such as username and
password and QoS for 3G. This is a list of the 3G
profiles for the 3G networks and a list of WiFi
profiles for the WiFi network. The displayed profile is
the active profile.
Indicators
The indicators are icons that show additional status
of the 3G wireless. Each indicator will be described
below.
Connection Type Selection
Bar
This is a navigation bar that selects which
connection information is displayed in the main
window. As the connection is selected, the main
window will slide to show the right information. Each
of the connection icons for this navigation bar also
shows the signal strength of the respective
connection.
The connection navigation bar was added to support the universal connection management
functionality. By having a navigation bar, the user is presented with just the information that is
required for the connection of interest. The pictures below show the three views for each
connection type.
Figure 17: 3G Wireless View
Novatel Wireless, Proprietary & Confidential
Page54
With the 3G Wireless view, connection button can be used to connect to the chosen profile
displayed. The status icons for 3G will be displayed on the top right corner and when connected,
byte count and time displayed will be shown. The vertical bar next to the navigation bar indicates
which view is currently active. When the user clicks on the WiFi navigation button, the WiFi view
will be shown.
Figure 18: WiFi View
The WiFi view does not have a connection button since WiFi is a connectionless adaptor. The
view does show signal strength, packet count, and connection time as well as connection status.
Since MobiLink’s WiFi is developed using Windows zero configuration, MobiLink WiFi control can
coexist with Windows wireless network connection. The default hotspot is shown in the selection
list in the same place as the 3G profile list. The list of hotspots is dynamically generated based on
a WiFi network scan of the area. Users can chose to make another hotspot active by clicking on
the selection list shown below.
Novatel Wireless, Proprietary & Confidential
Page55
Figure 19: HotSpot Activation
The connection list displays all the available hotspots seen by the WiFi adaptor. The list is
arranged in alphabetical order and the signal level for each is shown on the side. Also, if the
hotspot is WEP protected, a lock icon will be shown. To change hotspot, users can select one
from the list. If the hotspot is WEP protected the following dialog will be displayed to query for the
network key.
Figure 20: Network Connection
Lastly, the user can view the Ethernet connection by clicking on the Ethernet navigation bar icon.
Novatel Wireless, Proprietary & Confidential
Page56
Figure 21: Ethernet View
The Ethernet view shows the connection status, the packet count, and the connection duration.
Indicators
3G indicators are shown on the right upper corner of the main status display. The design of these
indicators is based on standard 3G indicators used on mobile devices. The following table
describes all the indicators.
Table 17: 3G Indicators
Indicator
Status/Description
3G radio is roaming
3G in dormant mode (May not be applicable for all MAs)
New SMS is available
3G device is locked
WWAN
Network
This is the type of WWAN protocol that is acquired. The types are:
• HSDPA
• UMTS
• GPRS
• GSM
• IS95a
• 1XRTT
• EVDO
Novatel Wireless, Proprietary & Confidential
Page57
Connect/Disconnect Button
Since the main purpose of MobiLink’s connection manager is for connecting the user to the
internet, the connection button is prominently placed. The Connection button is used to initiate a
3G data connection. The connection button is not used for WiFi or Ethernet since the network
adaptors are connectionless and will automatically connect as long as there is a valid connection.
Figure 22: Connection Button
Menu
When the Menu button is clicked, the following menu subjects are displayed:
Table 18: Menu Subjects
Menu Item
Description
Profile Manager
This menu item opens up the dialog for creating, editing, and deleting
profiles
Configuration
This menu item opens up a dialog for changing MobiLink settings
Properties
This menu item opens up a dialog that displays the properties of the
3G modem
Report
This menu item opens up a dialog that displays the connections
statistics and connection history
Novatel Wireless, Proprietary & Confidential
Page58
Transparency
This menu item is to set the application display transparency. This
feature allows the desktop items below the application to be shown
through the transparency
About
This menu item brings up information about the MobiLink application
Exit
This menu item will quit the MobiLink application
Profile Manager
The profile manager allows the user to manage the connection profiles for both the 3G
connection and WiFi connection. The user can create a profile using the New, edit or view the
profile, and delete a profile.
3G Wireless Profiles
The first tab shows the 3G wireless profiles as shown below.
Figure 23: 3G Profiles
The wireless profiles can be selected for viewing in the case of a locked profile and for editing in
the case of an unlocked profile. Locked profiles are preset and can not be deleted or altered.
This is to reduce the incidence of connection problems related to incorrect settings due to user
error. The dialog below shows the actual profile settings. For locked profiles, the settings are
grayed out and cannot be modified.
Novatel Wireless, Proprietary & Confidential
Page59
Figure 24: Profile Settings
The profile settings are categorized under different tabs and can be different for UMTS and
CDMA. In the case of CDMA, the QoS tab does not apply. The following screens show the
various settings under each tab.
Figure 25: Different Tab Settngs
Novatel Wireless, Proprietary & Confidential
Page60
When changes are made to any of the tabs, the user must click the Apply button to effect the
changes. Cancel can be clicked to cancel the settings. The exception is the on the last VPN tab.
When creating a new VPN, the VPN entry is created when the user clicks the New button with an
entry name. The apply button is used to change the associated VPN for the profile. VPN
association is used to automatically establish a VPN session after a successful 3G connection.
When creating a profile by clicking on the New button, the profile wizard is used to guide the user
through some simple steps for creating a new profile. The advanced settings are preset based on
a template profile for the carrier network and hidden from the user. In the rare case where
advanced parameters need to be changed, the user can then select the newly created profile and
click on Edit to edit the parameters.
Figure 26: Profile Wizard Step 1
Novatel Wireless, Proprietary & Confidential
Page61
Figure 27: Profile Wizard Step #2
Figure 28: Profile Wizard Step #3
WiFi Profiles
TBD
Configuration
The configuration menu has all the available settings for MobiLink. The configuration window is
broken down in to four functional tabs. The General tab is for the user interface settings and
language selection. The Mobile tab is used to set parameters for the 3G device. The WiFi tab
has settings for WiFi adaptor, and the Ethernet tab is used to set the Ethernet adaptor. Each of
the tabs is shown below.
Novatel Wireless, Proprietary & Confidential
Page62
Figure 29: General Tab
Table 19: General Tab Features
General Tab Feature
Description
Always on top
When checked, the application is always the top most
application on the desktop
Sound Effects On
When checked, sounds will be played on user actions
Language
This is a selection list for choosing the language to be
used for MobiLink. Windows Default will base the
language on what Windows uses as the native language
Novatel Wireless, Proprietary & Confidential
Page63
Figure 30: Mobile Tab
Table 20: Mobile Tab Features
Feature
Description
Auto-Connect when
launch
This feature is for MobiLink to automatically connect to the
network when launched
Network Selection
This selection is used to select the network preference.
For CDMA, this is to select the operating network and for
UMTS/HSDPA, it’s for selection the radio access
technology
Auto-Lock on power up
Check to lock the SIM upon power up. A 4 to 8 digits code
must be supplied to turn on and off the auto lock feature.
Change Lock Code
Chick this button to change the lock code. This button is
only active if the auto-lock SIM feature is turned on.
Novatel Wireless, Proprietary & Confidential
Page64
Figure 31: WiFi Tab
The WiFi tab allows user to choose the WiFi adaptor from a list of detected adaptors. Also, the
adaptor properties can be modified by clicking on the properties button. The wireless adaptor
properties window is shown below.
Figure 32: WAP Window
Novatel Wireless, Proprietary & Confidential
Page65
Figure 33: Ethernet Tab
The Ethernet tab allows user to choose the Ethernet adaptor from a list of detected adaptors.
Also, the adaptor properties can be modified by clicking on the properties button. The adaptor
properties window is shown below.
Figure 34: AP Window
Novatel Wireless, Proprietary & Confidential
Page66
Properties Menu
The properties menu displays some of the key properties of the UMTS and EVDO devices.
Figure 35: CDMA
Figure 36: UMTS/HSDPA
Table 21: Identity Properties
Property
Description
Firmware Version
Firmware version of the 3G device
IMEI/ESN
International Mobile Equipment Identity (UMTS)/ Electronic
Serial Number (CDMA)
Mobil Number
Number for the mobile
Manufacturer
Who produced the modem
Modem Type
Modem technology
Novatel Wireless, Proprietary & Confidential
Page67
Technology
3G technology
PRL version
Preferred Roaming List version number(CDMA)
FID
Factory ID. This is a unique tracking number for factory
builds
Report Log
The report log has statistic information about the current connection as well as a history list of
past connections.
Figure 37: Report Log
Table 22: Report Values
Value
Description
Instant downlink
This is most recent measured downlink throughput
Average downlink
This is the average of all the measured downlink
throughput
Max downlink
This is the maximum achieved downlink throughput
Novatel Wireless, Proprietary & Confidential
Page68
Total data
This is the total data that has been ever sent since
MobiLink has been installed on the machine
Connection time
The is the amount of time the connection has lasted
MB per month
This is a resettable counter of how many bytes since the
last reset
Minutes per month
This is a resettable counter of how many minutes since the
last reset
Transparency
This menu feature allows the user to select the percent transparency for MobiLink. The choices
range from 0% to 90% with 0% being solid and 90% being very transparent. Transparency
allows desktop items below MobiLink to be displayed for better multitasking. Below is an
example of MobiLink transparency on a desktop.
Figure 38: Desktop Transparency
About
The About dialog displays MobiLink information such as version number, release date, and
copyright.
Novatel Wireless, Proprietary & Confidential
Page69
Figure 39: About Dialogue
SIM/Lock Management
Upon Mobilink startup, ff the device is locked on power up, a small dialog will be displayed such
as below to ask the user to enter the unlock code prior to continuing with MobiLink.
Figure 40: Enter PUK
The lock setting and code can be managed in the Mobile tab of the configuration menu shown
below.
Figure 41: Configuration Menu
Novatel Wireless, Proprietary & Confidential
Page70
Quick Access Buttons
The quick access buttons are designed to provide a launch pad for other applications. Four
buttons are provided and can be remapped to other applications. The picture below shows the
default functions assigned to the quick access buttons.
Figure 42: Quick Access Button Default Functions
Software Web Upgrade
TBD
SMS Client
The MobiLink SMS Client is used to manage reading and sending SMS messages. The SMS
Client is an application that is part of the MobiLink application suite. The design of this
application is to emulate an email Client to reduce the amount of new learning that is required to
start using this application. This application is launched from the main connection manager Quick
Access button. The following features are supported.
•
•
•
•
•
•
•
•
•
Send new messages
Reply to message
Forward message
Email interworking
Concatenated SMS
Set priority of message
Rich text editing functions
Printing
Support for embedded hyper links and email links in message
Novatel Wireless, Proprietary & Confidential
Page71
•
•
•
•
Auto language selection
Send to multiple recipients
Status receipt of sent messages
Status bar to indicate number of messages, character count, etc…
Figure 43: MobiLink SMS Client
SMS Mailboxes
Very much like an email Client, the SMS Client has multiple mail boxes to store different types of
messages.
Table 23: Mailbox List
Mailbox
Description
Inbox
All incoming SMS is delivered to this mail box
and will be highlighted if unread.
Outbox
All outgoing SMS will be put into this mailbox.
If the SMS has not been sent to the card, it will
be held here until it can be sent.
Sent
All sent SMS messages are placed here.
Novatel Wireless, Proprietary & Confidential
Page72
SIM
All SMS messages that are still stored on the
SIM.
The message panel contains the key information for a list of messages. The messages can be
reorder in the message panel by clicking on the fields located on the top strip. The fields are the
following:
Table 24: Fields List
Field
Description
Importance
From
Where the message is from. Only shown when
Inbox is selected.
To
Where the message is sent. Only shown in
when Outbox or Sent box is selected.
Message
Displays the first few characters of the
message
Received
Time when the message is received
Sent
Time when the message is sent
Callback
Callback number
Menu Bar
The menu bar contains the following items:
Menu
Item
Description
• File
o Exit
Exits the application
• Edit
o Undo
Undo last text editing
o Cut
Cut the selected text
o Copy
Copy the selected text
o Paste
Paste text on clipboard
o Select All
Select all text in message content panel
o Toolbar
Display tool bar
o Statusbar
Display Status bar
o About SMSClient
Display About dialog
• View
• Help
Novatel Wireless, Proprietary & Confidential
Page73
Toolbar
The tool bar is accessible across the top and gives user quick access to common tasks. The tool
bar contains the following buttons:
Table 25: Tool Bar Button
Button
Description
New SMS Message
Opens up dialog to create a new SMS message
Delete
Deletes the highlighted message or group of messages.
Reply
Reply to the highlighted message.
Forward
Forward the contents of the highlighted message.
Status Bar
The status bar displays information about each of the mailbox selected. It will give the number of
messages and the number of unread messages. The status bar is located on the bottom strip.
Compose Message Window
Clicking on the New SMS Message button will bring up the following dialog: This window allows
the user to enter the destination address, SMS message, a callback number for CDMA, and a
subject text. Standard text editing such as cutting, copying, pasting is supported in the message
box. In addition, the user can use the tool bar or the menu to set the priority and encoding of the
message. Both Unicode and ASCII are supported. Unicode is used to send characters not in the
standard ASCII character set.
Figure 44: Compose Message
Novatel Wireless, Proprietary & Confidential
Page74
For the destination address, users can chose to select from the address book by clicking on the
To button. Also, multiple destinations can be entered separated by a comma or semicolon.
The toolbar supports the following functions: Clicking on the “To” button or the Addressbook
button will bring up the following dialog to select the contact to insert into the destination field.
Multiple destination addresses can be selected.
Table 26: Destination Addresses
Button
Description
Send
Send the SMS message
Print the SMS message
Editing functions. Cut, copy, and paste text
Open the addressbook to select from
Emergency priority
Urgent priority
Set Unicode encoding for message
Email Interworking
A new feature added to this version of MobiLink is the ability for email interworking. What this
feature does is to allow an email message to be sent over an SMS message. If the user types in
an email address in the To filed, the application will automatically format the SMS message so
that the SMSC on the network side will forward it as an email.
The recipient of this email can simply reply to the message and the message will be forwarded
back to the wireless device.
Concatenated SMS
With the addition of email interworking, the ability to send an SMS that is longer than the limited
160 characters is very important. To address that issue, the SMS Client will allow the user to
enter a long message and automatically segment the message and send it as separate SMS with
a special tag to indicate the messages are segments of a long message.
Addressbook Features
The MobiLink address book allows the management of phone numbers on the SIM, Windows
Address Book and Outlook. The following screen shows the address book Client.
Novatel Wireless, Proprietary & Confidential
Page75
Figure 45: Address Book
The address book Client has a selection box that allow the user to chose which address book to
view. The following addresses can be selected:
Table 27: Address Books
Addressbook
Description
Windows Address
Book
This is the native Windows Addressbook that is part of
Windows Accessories folder
Outlook Address
Book
This is the local Outlook Addressbook. This is only
accessible if Outlook is installed on the computer
SIM
This is the address book located on the 3G device or the
SIM of the device
Global Group
Contact
This is the group contacts that contain distribution lists
created by the user. This list can contain contacts from
any of the above address books
User can create, delete, and view contact properties as well as send an SMS message using the
selected contact by clicking on one of the buttons on the bottom of the Address Book Client.
Global Group Contact
Global Group Contact feature allows users to create distribution lists for sending SMS.
Novatel Wireless, Proprietary & Confidential
Page76
Figure 46: Select Group Contacts
When the user chooses to create a Global Group Contact, a new dialog will be opened up to
allow the user to select from the different address books and move them to create a new
distribution list. The total number in a distribution list is up to 100. The list can contain a mixture
from different address books and can contain both mobile numbers as well as email addresses.
Novatel Wireless, Proprietary & Confidential
Page77
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, Proprietary & Confidential
Page78
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, nSecondaryDNS As Long,
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
Novatel Wireless, Proprietary & Confidential
Page79
nPapChap
lpszVPN
Long
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:
Syntax:
A Long value.
object.DeleteMessage(nMsgBoxEnum As Long, nIndex As Long)
The DeleteMessage method syntax has these parts:
Novatel Wireless, Proprietary & Confidential
Page80
Part
Object
nMsgBoxEnum
nIndex
Description
An expression evaluating to an object of type Client.
Long
Long
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:
Syntax:
A Long value.
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:
Return Type:
Syntax:
Get the name of the currently selected/active device.
A String value.
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;
Novatel Wireless, Proprietary & Confidential
Page81
InvokeHelper(0x1b, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
GetAdapterList method
Description:
Get a list of currently available devices.
Return Type:
Syntax:
A Long value.
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)
Novatel Wireless, Proprietary & Confidential
Page82
{
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;
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
Novatel Wireless, Proprietary & Confidential
Page83
varContactNameMax
varContactDetailsMax
Variant
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;
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:
Syntax:
A String value.
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:
Syntax:
A String value.
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()
Novatel Wireless, Proprietary & Confidential
Page84
Cstring result;
InvokeHelper(0xc, DISPATCH_METHOD, VT_BSTR, (void*)&result, NULL);
return result;
GetDeviceNetwork method
Description:
Get currently attached network type.
Return Type:
Syntax:
A String value.
object.GetDeviceNetwork
The GetDeviceNetwork method syntax has these parts:
Part
Description
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:
Syntax:
A Long value.
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,
Novatel Wireless, Proprietary & Confidential
Page85
PX_STATE_UNKNOWN
= 0,
// State of device cannot be
determined
PX_STATE_NOCARD
PX_STATE_INITIALIZING
= 1,
= 2,
PX_STATE_DISABLED
Fn-F2 or user intervention
= 3,
PX_STATE_LOCKED
PX_STATE_SEARCHING
= 4,
= 5,
PX_STATE_IDLE
PX_STATE_CONNECTING
= 6,
= 7,
PX_STATE_AUTHENTICATING
= 8,
PX_STATE_CONNECTED
= 9,
PX_STATE_NDIS
PX_STATE_SHUTDOWN
= 10,
= 11,
PX_STATE_STANDBY
//
// Disabled by
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
Novatel Wireless, Proprietary & Confidential
Page86
= 12,
} SMSBoxEnum;
GetDeviceTechnology method
Description:
Get device technology defined by NovatelModemAPI.h.
Return Type:
Syntax:
A Long value.
object.GetDeviceTechnology
The GetDeviceTechnology method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
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:
Syntax:
A String value.
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:
Syntax:
A String value.
object.GetHardwareVersion
Novatel Wireless, Proprietary & Confidential
Page87
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:
Syntax:
A Long value.
object.GetLockStatus(varLockStatus As Variant, varAutoLockOn As Variant)
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
Novatel Wireless, Proprietary & Confidential
Page88
nIndex
varState
varMsg
nMsgSize
Long
Variant
Variant
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.
Return Type:
Syntax:
A Long value.
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:
Syntax:
As Variant)
A Long value.
object.GetMessageStatus(nMsgBoxEnum As Long, nIndex As Long, varState
The GetMessageStatus method syntax has these parts:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page89
object
nMsgBoxEnum
nIndex
varState
An expression evaluating to an object of type Client.
Long
Long
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:
Syntax:
A String value.
object.GetMobileNumber
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:
Return Type:
Syntax:
Get a list of operators. (UMTS/HSDPA Only)
A Long value.
object.GetNetworkOperatorList(varOperatorList As Variant)
The GetNetworkOperatorList method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
Novatel Wireless, Proprietary & Confidential
Page90
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:
Syntax:
A Long value.
object.GetNetworkPreference(varMode As Variant)
The GetNetworkPreference method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
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:
Syntax:
A Long value.
object.GetNewMessageCount
The GetNewMessageCount method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
Novatel Wireless, Proprietary & Confidential
Page91
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
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:
Return Type:
Syntax:
Get the PRL version of the device. (CDMA/EVDO Only)
A String value.
object.GetPRLVersion
Novatel Wireless, Proprietary & Confidential
Page92
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:
Syntax:
A String value.
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)
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:
Syntax:
A Long value.
object.GetSigStr
The GetSigStr method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
Novatel Wireless, Proprietary & Confidential
Page93
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:
Syntax:
A String value.
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;
IsDormant method
Description:
Determine whether the device is currently dormant.
Return Type:
Syntax:
A Long value.
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;
Novatel Wireless, Proprietary & Confidential
Page94
IsMessageMemoryFull method
Description:
Check to see if the message box memory is full.
Return Type:
Syntax:
A Long value.
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:
Syntax:
A Long value.
object.IsRoaming
The IsRoaming method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
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:
Syntax:
Variant)
A Long value.
object.SendMessage(varMsg As Variant, nMsgSize As Long, varMsgIndex As
The SendMessage method syntax has these parts:
Novatel Wireless, Proprietary & Confidential
Page95
Part
object
varMsg
nMsgSize
varMsgIndex
Description
An expression evaluating to an object of type Client.
Variant
Long
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;
InvokeHelper(0x1c, DISPATCH_METHOD, VT_EMPTY, NULL, parms,
lpszAdapter);
SetAutoLock method
Description:
Return Type:
Syntax:
To turn ON or OFF the autolock setting.
A Long value.
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
Novatel Wireless, Proprietary & Confidential
Page96
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[] =
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.
Novatel Wireless, Proprietary & Confidential
Page97
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
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;
Novatel Wireless, Proprietary & Confidential
Page98
SetNetworkOperator method
Description:
To set the network operator provided by GetNetworkOperatorList. (UMTS/HSDPA
Only)
Return Type:
Syntax:
As String)
A Long value.
object.SetNetworkOperator(nMode As Long, nFormat As Long, lpszOperator
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:
Syntax:
A Long value.
object.SetNetworkPreference(nMode As Long)
The SetNetworkPreference method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Client.
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,
Novatel Wireless, Proprietary & Confidential
Page99
nMode);
return result;
SetProxy method
Description:
Set proxy settings given a proxy IP address and port.
Return Type:
Syntax:
A Long value.
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:
Syntax:
A Long value.
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
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);
Novatel Wireless, Proprietary & Confidential
Page100
return result;
Shutdown method
Description:
A means of synchronously shutting down the device.
Return Type:
Syntax:
A Long value.
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:
Syntax:
A Long value.
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,
nLockType, lpszLockCode);
return result;
Novatel Wireless, Proprietary & Confidential
Page101
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, Proprietary & Confidential
Page102
Part
object
nStatus
Description
An expression evaluating to an object of type IEventPhoenixNotifySink.
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:
Novatel Wireless, Proprietary & Confidential
Page103
deliveryofSDUError property
Description:
property deliveryofSDUError
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.
Novatel Wireless, Proprietary & Confidential
Page104
Value
A Long value.
maxBitDL property
Description:
property maxBitDL
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]
Novatel Wireless, Proprietary & Confidential
Page105
The ResBitErrorRatio property syntax has these parts:
Part
Description
Object
An expression evaluating to an object of type Qos.
Value
A String value.
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.
Novatel Wireless, Proprietary & Confidential
Page106
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.
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:
Part
Description
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
Novatel Wireless, Proprietary & Confidential
Page107
EventNetwork event
Syntax
Sub object_EventNetwork(nVal As Long)
The EventNetwork event syntax has these named arguments:
Part
Description
nVal
Long
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:
Novatel Wireless, Proprietary & Confidential
Page108
Part
Description
object
An expression evaluating to an object of type Blaze.
Detach method
Syntax
object.Detach
The Detach method syntax has these parts:
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:
Part
Description
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:
Part
Description
object
An expression evaluating to an object of type Hotspots.
ViewHotspots method
Shows Hotspot dialog.
Return Type
Novatel Wireless, Proprietary & Confidential
Page109
A Long value.
Syntax
object.ViewHotspots
The ViewHotspots method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Hotspots.
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:
Part
Description
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:
Part
Description
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:
Novatel Wireless, Proprietary & Confidential
Page110
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.
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.
Novatel Wireless, Proprietary & Confidential
Page111
Return Type
A Long value.
Syntax
object.ShowReport
The ShowReport method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Menu.
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
Novatel Wireless, Proprietary & Confidential
Page112
object.GetLanguageIndex(nIndex As Long)
The GetLanguageIndex method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Language.
nIndex
Long
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
An expression evaluating to an object of type Language.
lStringId
Long
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:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page113
object
An expression evaluating to an object of type Language.
lpszFilePath
String
ProfileManager object
NVTL ProfileManager Object is contatined in the ProfileManager ActiveX Control. The
ProfileManager Control uses the following methods:
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:
Part
Description
object
An expression evaluating to an object of type ProfileManager.
Technology
Long
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:
Part
Description
object
An expression evaluating to an object of type ProfileManager.
Novatel Wireless, Proprietary & Confidential
Page114
Technology
Long
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:
Part
Description
object
An expression evaluating to an object of type ProfileManager.
ProfileName
String
Technology
Long
Profile
Object
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:
Part
Description
object
An expression evaluating to an object of type ProfileManager.
varNameList
Variant
Technology
Long
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:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page115
object
An expression evaluating to an object of type ProfileManager.
ProfilePath
String
SetDefaultProfile method
Sets the default profile for a given technology.
Return Type
A Long value.
Syntax
object.SetDefaultProfile(ProfileName As String, Technology As Long)
The SetDefaultProfile method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type ProfileManager.
ProfileName
String
Technology
Long
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
An expression evaluating to an object of type ProfileManager.
Technology
Long
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]
Novatel Wireless, Proprietary & Confidential
Page116
The APN property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
AuthenticationType property
property AuthenticationType
Property type
A Long value.
Syntax
object.AuthenticationType [= value]
The AuthenticationType property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
CarrierName property
property CarrierName
Property type
A String value.
Syntax
object.CarrierName [= value]
The CarrierName property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
ConnectType property
property ConnectType
Property type
A Long value.
Syntax
object.ConnectType [= value]
The ConnectType property syntax has these parts:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page117
object
An expression evaluating to an object of type Profile.
value
A Long value.
DataSpeed property
property DataSpeed
Property type
A Long value.
Syntax
object.DataSpeed [= value]
The DataSpeed property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
DefaultGateway property
property DefaultGateway
Property type
A Long value.
Syntax
object.DefaultGateway [= value]
The DefaultGateway property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
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
An expression evaluating to an object of type Profile.
value
A Long value.
Novatel Wireless, Proprietary & Confidential
Page118
DeliveryOrder property
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 Profile.
value
A Long value.
DialString property
property DialString
Property type
A String value.
Syntax
object.DialString [= value]
The DialString property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
Fallback2GProfile property
property Fallback2GProfile
Property type
A String value.
Syntax
object.Fallback2GProfile [= value]
The Fallback2GProfile property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
Novatel Wireless, Proprietary & Confidential
Page119
IPAddress property
property IPAddress
Property type
A Long value.
Syntax
object.IPAddress [= value]
The IPAddress property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
MaxSDUSize property
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 Profile.
value
A Long value.
Password property
property Password
Property type
A String value.
Syntax
object.Password [= value]
The Password property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
PDPAddress property
property PDPAddress
Property type
Novatel Wireless, Proprietary & Confidential
Page120
A Long value.
Syntax
object.PDPAddress [= value]
The PDPAddress property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
PDPType property
property PDPType
Property type
A Long value.
Syntax
object.PDPType [= value]
The PDPType property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
PrimaryDNS property
property PrimaryDNS
Property type
A Long value.
Syntax
object.PrimaryDNS [= value]
The PrimaryDNS property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
PrimaryWINS property
property PrimaryWINS
Property type
A Long value.
Syntax
object.PrimaryWINS [= value]
Novatel Wireless, Proprietary & Confidential
Page121
The PrimaryWINS property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
ProfileName property
property ProfileName
Property type
A String value.
Syntax
object.ProfileName [= value]
The ProfileName property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
ProxyAddress property
property ProxyAddress
Property type
A Long value.
Syntax
object.ProxyAddress [= value]
The ProxyAddress property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
ProxyPort property
property ProxyPort
Property type
A Long value.
Syntax
object.ProxyPort [= value]
The ProxyPort property syntax has these parts:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page122
object
An expression evaluating to an object of type Profile.
value
A Long value.
ResErrorRatio property
property ResErrorRatio
Property type
A String value.
Syntax
object.ResErrorRatio [= value]
The ResErrorRatio property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
SDUErrorRatio property
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 Profile.
value
A String value.
SecondaryDNS property
property SecondaryDNS
Property type
A Long value.
Syntax
object.SecondaryDNS [= value]
The SecondaryDNS property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
Novatel Wireless, Proprietary & Confidential
Page123
SecondaryWINS property
property SecondaryWINS
Property type
A Long value.
Syntax
object.SecondaryWINS [= value]
The SecondaryWINS property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
SetProxy property
property SetProxy
Property type
A Long value.
Syntax
object.SetProxy [= value]
The SetProxy property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
SMSC property
property SMSC
Property type
A String value.
Syntax
object.SMSC [= value]
The SMSC property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
Novatel Wireless, Proprietary & Confidential
Page124
SMSEmailNumber property
property SMSEmailNumber
Property type
A String value.
Syntax
object.SMSEmailNumber [= value]
The SMSEmailNumber property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
StaticIP property
property StaticIP
Property type
A Long value.
Syntax
object.StaticIP [= value]
The StaticIP property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
SubnetMask property
property SubnetMask
Property type
A Long value.
Syntax
object.SubnetMask [= value]
The SubnetMask property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
Technology property
property Technology
Property type
Novatel Wireless, Proprietary & Confidential
Page125
A Long value.
Syntax
object.Technology [= value]
The Technology property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
TrafficClass property
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 Profile.
value
A Long value.
TrafficHandling property
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 Profile.
value
A Long value.
TransferDelay property
property TransferDelay
Property type
A Long value.
Syntax
object.TransferDelay [= value]
Novatel Wireless, Proprietary & Confidential
Page126
The TransferDelay property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
UseDNS property
property UseDNS
Property type
A Long value.
Syntax
object.UseDNS [= value]
The UseDNS property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
Username property
property Username
Property type
A String value.
Syntax
object.Username [= value]
The Username property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
UseVPN property
property UseVPN
Property type
A Long value.
Syntax
object.UseVPN [= value]
The UseVPN property syntax has these parts:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page127
object
An expression evaluating to an object of type Profile.
value
A Long value.
UseWINS property
property UseWINS
Property type
A Long value.
Syntax
object.UseWINS [= value]
The UseWINS property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A Long value.
VPNEntryName property
property VPNEntryName
Property type
A String value.
Syntax
object.VPNEntryName [= value]
The VPNEntryName property syntax has these parts:
Part
Description
object
An expression evaluating to an object of type Profile.
value
A String value.
NetMonkey Lib objects
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.
Novatel Wireless, Proprietary & Confidential
Page128
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
A String value.
Syntax
object.GetAdapter
The GetAdapter method syntax has these parts:
Part
Description
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
An expression evaluating to an object of type LAN.
varAdapterList
Variant
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.
Novatel Wireless, Proprietary & Confidential
Page129
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
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:
Part
Description
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:
Part
Description
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
Novatel Wireless, Proprietary & Confidential
Page130
The GetDuration method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type LAN.
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
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.
Novatel Wireless, Proprietary & Confidential
Page131
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 LAN.
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:
Part
Description
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:
Novatel Wireless, Proprietary & Confidential
Page132
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
object
An expression evaluating to an object of type LAN.
lpszAdapterNdisName
String
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:
Part
Description
object
An expression evaluating to an object of type WLAN.
nKeyIndex
Long
lpszKeyMaterial
String
Disassociate method
Disassociates with the current access point.
Syntax
object.Disassociate
The Disassociate method syntax has these parts:
Part
Description
Novatel Wireless, Proprietary & Confidential
Page133
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:
Part
Description
object
An expression evaluating to an object of type WLAN.
lpszProfile
String
nInfrastructureMode
Long
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
An expression evaluating to an object of type WLAN.
varAccessPoints
Variant
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.
Novatel Wireless, Proprietary & Confidential
Page134
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:
Part
Description
object
An expression evaluating to an object of type WLAN.
varAdapterList
Variant
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:
Part
Description
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
Novatel Wireless, Proprietary & Confidential
Page135
The GetBytesOut method syntax has these parts:
Part
Description
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
The GetConnectState method syntax has these parts:
Part
Description
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:
Part
Description
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:
Part
Description
object
An expression evaluating to an object of type WLAN.
Novatel Wireless, Proprietary & Confidential
Page136
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
An expression evaluating to an object of type WLAN.
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:
Part
Description
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:
Novatel Wireless, Proprietary & Confidential
Page137
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:
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:
Part
Description
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.
Novatel Wireless, Proprietary & Confidential
Page138
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 WLAN.
GetSupportedRates method
Gets interface supported rates.
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.
Novatel Wireless, Proprietary & Confidential
Page139
IsAdminUser method
Return Type
A Long value.
Syntax
object.IsAdminUser
The IsAdminUser method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type WLAN.
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
An expression evaluating to an object of type WLAN.
nKeyIndex
Long
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
An expression evaluating to an object of type WLAN.
Novatel Wireless, Proprietary & Confidential
Page140
lpszAdapterNdisName
String
StartWZCService method
Syntax
object.StartWZCService
The StartWZCService method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type WLAN.
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:
Part
Description
object
An expression evaluating to an object of type WWAN.
lpszDeviceID
String
EnableDevice method
Enables devices and turns on NDIS.
Novatel Wireless, Proprietary & Confidential
Page141
Return Type
A Long value.
Syntax
object.EnableDevice(lpszDeviceID As String)
The EnableDevice method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type WWAN.
lpszDeviceID
String
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 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:
Part
Description
object
An expression evaluating to an object of type WWAN.
varAdapterList
Variant
GetBytesIn method
Gets the number of bytes received.
Return Type
A Long value.
Syntax
object.GetBytesIn
The GetBytesIn method syntax has these parts:
Novatel Wireless, Proprietary & Confidential
Page142
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
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:
Part
Description
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:
Part
Description
object
An expression evaluating to an object of type WWAN.
GetDuration method
Gets the duration time of the connection.
Novatel Wireless, Proprietary & Confidential
Page143
Return Type
A String value.
Syntax
object.GetDuration
The GetDuration method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type WWAN.
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
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:
Part
Description
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:
Part
Description
object
An expression evaluating to an object of type WWAN.
Novatel Wireless, Proprietary & Confidential
Page144
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 WWAN.
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:
Part
Description
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)
Novatel Wireless, Proprietary & Confidential
Page145
The InitDevice method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type WWAN.
lpszDeviceID
String
lpszNetConnName
String
nShowIcon
Long
nReEnable
Long
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
An expression evaluating to an object of type WWAN.
lpszDeviceID
String
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
An expression evaluating to an object of type WWAN.
lpszAdapterNdisName
String
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)
Novatel Wireless, Proprietary & Confidential
Page146
The UpdateDeviceParam method syntax has these parts:
Part
Description
object
An expression evaluating to an object of type WWAN.
lpszDeviceID
String
lpszValName
String
dwType
Long
lpszInBuffer
String
dwBuffSize
Long
dwVal
Long
Novatel Wireless, Proprietary & Confidential
Page147
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 Minicards, and to provide the information necessary to integrate the module into an overall product
design.
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 case sensitive; use upper or lower case
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.
NW PCI 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
Novatel Wireless, Proprietary & Confidential
Page148
Response:
Returns the command response from the previous command.
Example:
AT+GMI
+GMI: Novatel Wireless, Inc.
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
then switches to data mode. The 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.
Novatel Wireless, Proprietary & Confidential
Page149
This command can be stopped by receiving a character during execution,
except during some states of connection establishment such as
handshaking.
Syntax:
ATD[]
Parameters:
The string of dialing digits and the optional V.25ter modifiers. The valid dialing
digits are:
0-9, * , #, +, A, B, C
and the V.25ter modifiers which are ignored:
Response:
If there is no dial tone, the modem will return the 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:
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
where 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:
Novatel Wireless, Proprietary & Confidential
Page150
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[]
Parameters:
Response:
turns echo mode off
turns echo mode on
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 the 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.
Novatel Wireless, Proprietary & Confidential
Page151
In terse form, all result codes are represented by an error code number
and all text messages have only a carriage return () 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 () character
pair before and after the text message.
Syntax:
ATV[]
Parameters:
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:
If the command has been set to 1, it will return the response:
OK
Example:
ATV1
ATZ
Description: RESET PARAMETERS TO SAVED SETTINGS
This command uses the user-defined modem settings profile stored in the nonvolatile 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[]
Parameters:
Novatel Wireless, Proprietary & Confidential
Page152
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[]
Parameters:
0 – instructs the modem to ignore the data terminal ready state
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
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 :
Novatel Wireless, Proprietary & Confidential
Page153
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: "+44385016005",145
+CSMP: 17,167
OK
Example:
AT&V
AT+CFC
Description: U m INTERFACE FAX COMPRESSION
Syntax:
AT+CFC=
Parameters:
0 – No compression.
1 – V.42bis compression with parameters as set by the +CDS command
2 – Modified the Modified Read Compression.
Response:
This command will return the string OK.
Example:
Input
Response
Query
AT+CFC?
current values
Set
AT+CFC=0
OK
Test
AT+CFC=?
list of supported values
Novatel Wireless, Proprietary & Confidential
Page154
AT+CRM
Description: SET R m INTERFACE PROTOCOL
The default value for the +CRM parameter shall be 0 if this value is supported
by the MT2. If0 is not supported, the default +CRM value shall be manufacturerspecific.
Syntax:
AT+CRM=
Parameters:
0 – Asynchronous Data or Fax
1 – Packet data service, Relay Layer Rm interface
2 – Packet data service, Network Layer Rm interface, PPP.
3 – Packet data service, Network Layer Rm interface, SLIP.
4 – STU-III Service.
5-127 – Reserved for future use.
128-255 – Reserved for manufacturer-specific use.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT+CRM?
AT+CRM=?
AT+CRM=0
current values
list of supported values
OK
AT+CSQ
Description: SIGNAL QUALITY REPORT
Execution command returns received signal strength indication and channel
frame error rate from the modem. Test command returns values supported by
the modem.
Syntax:
AT+CSQ?
Parameters: None
Response:
+CSQ: , OK
RSSI (in dBm) = ( X 2) –113 (FOR 0<= <=31)
RSSI (in dBm) = -51 (FOR 31<= <=98)
(FOR 99<= ) rssi is not known or not detectable
FER:
<0.01%
0.01% to less than 0.1%
0.1% to less than 0.5%
Novatel Wireless, Proprietary & Confidential
Page155
3
0.5% to less than 1.0%
1.0% to less than 2.0%
2.0% to less than 4.0%
4.0% to less than 8.0%
>= 8.0%
99
FER not known or is not detectable
Example:
Input
Response
Test
AT+CSQ?
list of RSSI and FER OK
AT+CSS
Description: REPORT SERVING SYSTEM INFORMATION
Syntax:
AT+CSS?
Parameters: None
Response:
+CSS: ,, OK
Band Class:
The mobile station is registered with a cellular system.
The mobile station is registered with a PCS system.
Band:
The mobile station is registered with a PCS A-band system.
The mobile station is registered with a PCS B-band system.
The mobile station is registered with a PCS C-band system.
The mobile station is registered with a PCS D-band system.
The mobile station is registered with a PCS E-band system.
The mobile station is registered with a PCS F-band system.
The mobile station is registered with a cellular A-band system.
The mobile station is registered with a cellular B-band system.
The mobile station is not registered.
SID:0-16383
The mobile station is registered with the system indicated.
99999
The mobile station is not registered.
Example:
Input
Response
Test
AT+CSS?
+CSS: 1,0,1031 OK
AT+CXT
Description: ACTION FOR AN UNRECOGNIZED COMMAND
Novatel Wireless, Proprietary & Confidential
Page156
Syntax:
AT+CXT=
Parameters:
Do not pass unrecognized commands to the IWF.
When detecting an unrecognized AT command, open transport layer
connection and pass unrecognized command to the IWF.
Example:
Input
Response
Query
AT+CXT?
+CXT: 0 OK
Set
AT+CXT=0
OK
AT+ER
Description: ERROR CONTROL REPORTING
This extended-format numeric parameter controls whether the extendedformat +ER: intermediate result code is transmitted from the IWF over
the U m interface.
Syntax:
AT+ER=
Parameters:
should be referred to IS-131.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Set
AT+ER?
AT+ER=0
current values
OK
AT+ETBM
Description: CONTROLS THE HANDLING OF DATA REMAINING IN IWF BUFFERS
This extended-format compound parameter controls the handling of data
remaining in IWF buffers upon service termination.
Syntax:
AT+ETBM=
Parameters:
should be referred to IS-131.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Set
AT+ETBM?
AT+ETBM=1,1,20
current values
OK
Novatel Wireless, Proprietary & Confidential
Page157
AT+FCLASS
Description: FAX CLASS SET OR TEST
Sets a particular mode of operation (data, fax). This causes the TA to process
information in a manner suitable for that specific type of device.
Syntax:
AT+FCLASS[= or ?][?]
Parameters:
, [?]
data
2.0
fax class 2 (TIA-578-A)
queries the command and returns its current setting or displays
the valid values for the commands parameters
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT+FCLASS?
AT+FCLASS=?
AT+FCLASS=0
current values
list of supported values
OK
AT+GCAP
Description: REPORT ADDITIONAL CAPABILITIES
Modem reports a list of additional capabilities.
Syntax:
AT+GCAP
Parameters: None
Response:
This command will return the string OK.
Example:
Input
Response
Query
AT+GCAP
+GCAP: +CIS707-A, +MS, +ES, +DS,
+FCLASS OK
AT+GMI
Description: MANUFACTURER IDENTITY
Request for manufacturer identification
Syntax:
AT+GMI
Parameters: None
Response:
+GMI: OK
Example:
Input
Response
Novatel Wireless, Proprietary & Confidential
Page158
Query
AT+GMI
+GMI: Novatel Wireless Inc. OK
AT+GMM
Description: MODEM IDENTITY
Request TA model identification. Unit reports one or more lines of information
text which permits you to identify the specific model of device. Typically, the text
will consist of a single line containing the name of the product, but
manufacturers may choose to provide any information desired.
Syntax:
AT+GMM
Parameters: None
Response:
+GMM: OK
Example:
Input
Response
Query
AT+GMM
EXPDV620
AT+GMR
Description: REVISION NUMBER / IDENTITY
This command reports the version, revision and date of the software or
firmware used in the device. It is also used to identify the software version to
facilitate easier tracking and code updates.
Syntax:
AT+GMR
Parameters: None
Response:
+GMR: OK
Example:
Input
Query
AT+GMR
Response
M6500C-NIRVANA_VZW-Q40305.136 [Mar 22 2005 14:00:00]
AT+GSN
Description: ESN NUMBER IDENTITY
This command causes the MT2 to transmit one or more lines of information text,
determined by the manufacturer, which is intended to permit you of the MT2 to
identify the individual device. Typically, the text will consist of a single line
containing a manufacturer-determined alphanumeric string, but manufacturers
may choose to provide any information desired.
Syntax:
AT+GSN
Parameters: None
Response:
+GSN: OK
Novatel Wireless, Proprietary & Confidential
Page159
Example:
Input
Response
Query
AT+GSN
+GSN: OK
AT$QCQNC
Description: ENABLE/DISABLE QUICK NET CONNECT (QNC)
Syntax:
AT$QCQNC=
Parameters:
Disable QNC capability. This means that packet Originations will
use the Pack Data Service Option number.
Enable QNC capability. This means that Packet Originations will
use the Async Data Service Option number.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCQNC?
AT$QCQNC=?
AT$QCQNC=0
current values
list of supported values
OK
AT$QCPREV
Description: REPORT PROTOCOL REVISION IN USE
Syntax:
AT$QCPREV
Parameters:
None
Response:
Returns one of the following codes:
JSTD008
IS_95A
IS_95B
IS_2000
Example:
Input
Response
Query
AT$QCPREV
AT$QCCLR
Description: CLEAR MOBILE ERROR LOG
This command will clear the mobile error log.
Syntax:
AT$QCCLR
Novatel Wireless, Proprietary & Confidential
Page160
Parameters:
None
Response:
This command will return the string OK.
Example:
AT$QCCLR
AT$QCPKND
Description: AUTOMATIC PACKET DETECTION
Enable/Disable Automatic Packet Detection after a Dial command
Syntax:
AT$QCPKND=
Parameters:
Disable Packet No Dial. If a PPP packet is received by the mobile
without a just prior dial command (that is, ATDT #), then the
mobile will originate a Packet (or QNC) data call.
Enable Packet No Dial. Reception of a PPP packet without a just prior
dial command will NOT Originate a PPP packet (or QNC) call.
Example:
Input
Response
Query
Test
Set
AT$QCPKND?
AT$QCPKND=?
AT$QCPKND=0
current values
list of supported values
OK
AT$QCVAD
Description: PREARRANGEMENT SETTING
Prearrangement setting; respond to Page message that has a Voice
service option with a Page response that has a Data service option
Syntax:
AT$QCVAD=
Parameters:
Off
Fax for next call
Fax for all calls
Async for next call
Async for all calls
Example:
Input
Response
Query
Test
AT$QCVAD?
AT$QCVAD=?
current values
list of supported values
Novatel Wireless, Proprietary & Confidential
Page161
Set
AT$QCVAD=0
OK
AT$QCMDR
Description: SET MEDIUM DATA RATE SETTING
Set Medium Data Rate (MDR) (also known as HSPD) setting.
Syntax:
AT$QCMDR=
Parameters:
MDR Service Only. The mobile will originate with SOS 22 or SO 25.
The mobile will not negotiate to any other service option if SO 22 and
SO 25 are unavailable.
MDR Service, if available. The mobile will originate with SO 22 or SO 25, but
will negotiate to a Low-Speed Packet service option if MDR is not available.
The mobile will not negotiate to SO 33.
LSPD only. The mobile will originate a Low-Speed Packet call only. The
mobile will not negotiate to SO 22, SO 25, or SO 33.
SO 33, if available. The mobile will negotiate to MDR or Low-Speed Packet
service options if SO 33 is not available.
Example:
Input
Response
Query
Test
Set
AT$QCMDR?
AT$QCMDR=?
AT$QCMDR=0
current values
list of supported values
OK
AT$QCMIP
Description: MOBILE IP (MIP) DATA CALL
Sets the mobile to a certain type of packet data call.
Syntax:
AT$QCMIP=
Parameters:
Mobile IP disabled, Simple IP only.
Mobile IP preferred.
In the initial MIP registration, if the network does not support Mobile IP, then the
mobile automatically reverts to Simple IP (force a PPP renegotiation by sending
a LCP C-Req).
However, if a Mobile IP session is registered, and then the mobile enters a
network that does not support Mobile IP, the mobile will drop the session and
inform the upper layers of the failure (for example, by dropping DCD to a laptop).
Mobile IP only.
Novatel Wireless, Proprietary & Confidential
Page162
The mobile will make data calls only when Mobile IP is supported in the network.
During a MIP session, if the mobile hands off to a network that does not support
MIP, then the mobile will drop the session and inform the upper layers of the
failure (for example, by dropping DCD to a laptop).
Example:
Input
Response
Query
Test
Set
AT$QCMIP?
AT$QCMIP=?
AT$QCMIP=0
current values
list of supported values
OK
AT$QCMIPP
Description: SELECT MIP USER PROFILE TO BE ACTIVE
This value is stored in NV. This AT command is expected to be used by users to
configure Dial-Up Networking.
Syntax:
AT$QCMIPP=
Parameters:
is between 0 and 5 for the profile number.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCMIPP?
AT$QCMIPP=?
AT$QCMIPP=0
current values
list of supported values
OK
AT$QCMIPT
Description: RFC 2002bis AUTHENTICATION SETTING
Enable/disable the use of RFC 2002bis authentication. This is a bug fix
to RFC 2002 where it fails to include the SPI in the calculation of the MN-HA
authenticator.
Syntax:
AT$QCMIPT=
Parameters:
Use of RFC 2002bis authentication is disabled.RFC 2002 style
authentication is used instead.
Use of RFC 2002bis authentication is enabled.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCMIPT?
AT$QCMIPT=?
AT$QCMIPT=0
current values
list of supported values
OK
Novatel Wireless, Proprietary & Confidential
Page163
AT$QCMIPEP
Description: CURRENT ACTIVE MIP PROFILE
Enable/disable currently active profile.
Syntax:
AT$QCMIPEP=
Parameters:
Disable the currently active profile (profile is unavailable until it is reenabled.
Enable the currently active profile.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCMIPEP?
AT$QCMIPEP=?
AT$QCMIPEP=0
current values
list of supported values
OK
AT$QCMIPGETP
Description: REPORT ALL INFORMATION FOR A MIP PROFILE
Return all information corresponding to the specified profile number.
Syntax:
AT$QCMIPGETP=
Parameters:
is a number between 0 and 5. If no profile number is entered, all
information corresponding to the currently active profile is returned.
Response:
This command will return the string OK. If there is no profile associated
with the specified number, an error is returned.
Example:
Input
Response
Query
Test
Set
AT$QCMIPGETP?
AT$QCMIPGETP=?
AT$QCMIPGETP=0
current active profile
list of supported values
OK
AT$QCMIPNAI
Description: SET NETWORK ACCESS IDENTIFER (NAI)
Set the NAI for the currently active profile.
Syntax:
AT$QCMIPNAI=,
Parameters:
length of 72 characters. Double quotes are only required if the
string contains a comma.
Novatel Wireless, Proprietary & Confidential
Page164
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will
be deleted at the end of the following call or if $QCMIPP is called.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCMIPNAI
AT$QCMIPNAI=?
AT$QCMIPNAI=test,0
current values
list of supported values
OK
AT$QCMIPRT
Description: SET REVERSE TUNNELING
Set the reverse tunneling currently active profile.
Syntax:
AT$QCMIPRT=,
Parameters:
Do not request reverse tunneling.
Request reverse tunneling.
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will be
deleted at the end of the following call or if AT$QCMIPP is called.
Example:
Input
Response
Query
Test
Set
AT$QCMIPRT?
AT$QCMIPRT=?
AT$QCMIPRT=0
current values
list of supported values
OK
AT$QCMIPMASS
Description: SET MOBILE NODE (MN) AUTHENTICATION AUTHORIZATION
ACCOUNTING (AAA) SHARED SECRET
Set MN-AAA shared secrets for the currently active profile.
Syntax:
AT$QCMIPASS=,
Novatel Wireless, Proprietary & Confidential
Page165
Parameters:
length of 16 characters. Double quotes are only required if the string
contains a comma.
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will
be deleted at the end of the following call or if AT$QCMIPP is called.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCMIPASS?
AT$QCMIPASS=?
AT$QCMIPASS=test,0
current values
list of supported values
OK
AT$QCMIPMHSS
Description: SET MOBILE NODE (MN) HOME AGENT (HA) SHARED SECRET
Set MN-HA shared secrets for the currently active profile.
Syntax:
AT$QCMIPMHSS=,
Parameters:
length of 16 characters. Double quotes are only required if the string
contains a comma.
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will be
deleted at the end of the following call or if AT$QCMIPP is called.
Response:
This command will return the string OK.
Example:
Input
Response
Query
Test
Set
AT$QCMIPMHSS?
AT$QCMIPMHSS=?
AT$QCMIPMHSS=test,0
current values
list of supported values
OK
Novatel Wireless, Proprietary & Confidential
Page166
AT$QCMIPMASSX
Description: SET MOBILE NODE (MN) AUTHENTICATION AUTHORIZATION
ACCOUNTING (AAA) SHARED SECRET IN HEX
Set MN-AAA shared secrets for the currently active profile in HEX.
Syntax:
AT$QCMIPMASSX=,
Parameters:
length of 16 bytes.
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will be
deleted at the end of the following call or if AT$QCMIPP is called.
Example:
Input
Response
Query
Test
Set
AT$QCMIPMASSX?
AT$QCMIPMASSX=?
AT$QCMIPMASSX=5AE6F1,0
current values
list of supported values
OK
AT$QCMIPMHSSX
Description: SET MOBILE NODE (MN) HOME AGENT (HA) SHARED SECRET IN
HEX
Set MN-HA shared secrets for the currently active profile in HEX.
Syntax:
AT$QCMIPMHSSX=,
Parameters:
length of 16 bytes.
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will be
deleted at the end of the following call or if AT$QCMIPP is called.
Response:
This command will return the string OK.
Novatel Wireless, Proprietary & Confidential
Page167
Example:
Input
Response
Query
Test
Set
AT$QCMIPMHSSX?
AT$QCMIPMHSSX=?
AT$QCMIPMHSSX=5EF3A1,0
current values
list of supported values
OK
AT$QCMIPMASPI
Description: SET MOBILE NODE (MN) AUTHENTICATION AUTHORIZATION
ACCOUNTING (AAA) SECURITY PARAMETER INDEX (SPI)
Set MN-AAA SPIs for the currently active profile.
Syntax:
AT$QCMIPMASPI=,
Parameters:
length of 4 bytes.
Do not commit to NV.
Commit to NV.
If the value provisioned is not committed to NV, the temporary values will be
deleted at the end of the following call or if AT$QCMIPP is called.
Example:
Input
Response
Query
Test
Set
AT$QCMIPMASPI?
AT$QCMIPMASPI=?
AT$QCMIPMASPI=1234,0
current values
list of supported values
OK
AT$QCMIPMHSPI
Description: SET MOBILE NODE (MN) HOME AGENT (HA) SECURITY PARAMETER
INDEX (SPI)
Set MN-HA SPIs for the currently active profile.
Syntax:
AT$QCMIPMHSPI=,
Parameters:
Length of 4 bytes.
Do not commit to NV.
Commit to NV.
Novatel Wireless, Proprietary & Confidential
Page168
If the value provisioned is not committed to NV, the temporary values will be
deleted at the end of the following call or if AT$QCMIPP is called.
Example:
Input
Response
Query
Test
Set
AT$QCMIPMHSPI?
AT$QCMIPMHSPI=?
AT$QCMIPMHSPI=1234,0
current values
list of supported values
OK
AT$NW
Description: This command returns Novatel Wireless company description
Syntax:
AT$NW
Parameters:
None
Example:
Input
Response
Query
AT$NW
Novatel Wireless Inc.
www.novatelwireless.com
Developed in the USA.
AT$NVTLLTIME
Description: This command returns the local time received from the network and time zone
offset. If there is no service available then the time reported starts from
1980/01/06
Syntax:
AT$NVTLLTIME
Parameters:
None
Example:
Input
Response
Query
AT$NVTLLTIME
2005.5.18.16.39.0.2.-7
OK
AT$NVTLMDN
Description:
This command returns the mobile directory number of the device.
Syntax:
AT$NVTLMDN
Parameters:
None
Example:
Input
Response
Query
AT$NVTLMDN
0000000140
OK
Novatel Wireless, Proprietary & Confidential
Page169
AT+IOTA
Description:
This command is used to enable/disable/start eIOTA. (Only available on the
Sprint PCS Network)
Syntax:
AT+IOTA
Parameters:
QUERY TEST, AT+IOTA=?
This command returns the range that the command supports (0-2).
ARGUMENT, AT+IOTA=
This command setup the IOTA setting.
Value:
Disable eIOTA
Enable eIOTA
Start eIOTA session
QUERY, AT+IOTA?
This command returns the current status during IOTA session.
Status format:
IOTA Enabled or IOTA Disabled
In Progress:
(0 = not in progress, 1 = in progress)
Repeat Test OK:
(x = number of repeat test OK)
Repeat Test Failed: (x = number of repeat test failed)
Retry Command:
(x = retry command in numeric)
Current State:
(x = current IOTA state in numeric)
Network Up or Network Down
Server Connected or Server Disconnected
Retry:
(x = the number of retry IOTA session)
Global State:
Number Get:
Number Post:
Proxy Trusted or Proxy Not Trusted
AT$NWACTIVATION
Description:
This command is used to manually provision the Novatel PCMCIA card (program
the MDN and MIN).
Syntax:
AT$NWACTIVATION
Parameters:
Novatel Wireless, Proprietary & Confidential
Page170
QUERY TEST, AT$NWACTIVATION =?
This command returns the range that the following string:
$NWACTIVATION: (ACTIVATION CODE:[xxxxxx] MDN:[XXXXXXXXXX]
MIN:[XXXXXXXXXX])
ARGUMENT, AT$NWACTIVATION = , ,
This command programs the MDN and MIN into the PCMCIA card using the
correct SPC.
Value:
SPC
Service Programming Code (6 digits)
MDN -
Mobile Directory Number (10 digits)
MIN
Mobile Identification Number (10 digits)
QUERY, AT$NWACTIVATION?
This command returns the MDN, Min1, and MIN2.
AT+PZID
Description:
This command is used to retrieve the PZID of the current network. Values are
only 1 and 0 being non zero or else zero. (Only available on the Sprint PCS
Network)
Syntax:
AT+PZID
Parameters:
QUERY, AT+PZID?
This command returns the current PZID of serving network.
Status format:
PZID -
1 for non zero value of PZID
0 for zero value of PZID
AT$SPNAI
Description:
This command is used to determine if the current device supports 6 MIP
profiles. (Only available on the Sprint PCS Network)
Syntax:
AT$SPNAI
Parameters:
QUERY, AT$SPNAI?
This command returns the state if the device supports 6 MIP profiles.
Status format:
SPNAI
1 current device does support 6 MIP profiles
Novatel Wireless, Proprietary & Confidential
Page171
0 does not support 6 MIP profiles
Novatel Wireless Developer Network Library
The NWDN Library is a comprehensive reference for developers writing applications for Novatel
Wireless modems. It contains software API references, modem AT command set references,
and any other documentation you might need to develop solutions that use Novatel Wireless
modems.
AT+COPS
Description:
Set command forces an attempt to select and register the GSM network operator. is
used to select whether the selection is done automatically by the ME or is forced by this
command to operator (it shall be given in format ). If the selected operator is not
available, no other operator shall be selected (except =4). The selected operator name
format shall apply to further read commands (+COPS?) also. =2 forces an attempt to
deregister from the network. The selected mode affects to all further network registration (e.g.
after =2, ME shall be unregistered until =0 or 1 is selected). Refer subclause 9.2
for possible values. This command should be abortable when registration/deregistration
attempt is made.
Read command returns the current mode and the currently selected operator. If no operator is
selected, and are omitted.
Test command returns a list of quadruplets, each representing an operator present in the
network. Quadruplet consists of an integer indicating the availability of the operator , long
and short alphanumeric format of the name of the operator, and numeric format representation of
the operator. Any of the formats may be unavailable and should then be an empty field. The list of
operators shall be in order: home network, networks referenced in SIM, and other networks. It is
recommended (although optional) that after the operator list TA returns lists of supported
s and s. These lists shall be delimited from the operator list by two commas.
Syntax:
Command
Response
+COPS=[[,[,]]] +CME ERROR:
+COPS: [,,[,
+COPS: [list of supported (,long
alphanumeric ,short alphanumeric
+COPS=?
,numeric [,])s] [,,(list of
supported s),(list of supported s)]
+CME ERROR:
Values:
Value Description
automatic ( field is ignored)
manual ( field shall be present)
deregister from network
set only (for read command +COPS?), do not attempt
Novatel Wireless, Proprietary & Confidential
Page172
4
registration/deregistration ( field is ignored); this value is not applicable in
read command response
manual/automatic ( field shall be present); if manual selection fails,
automatic mode (=0) is entered (NOT SUPPORTED)
Value Description
long format alphanumeric
short format alphanumeric
numeric
: string type; indicates if the format is alphanumeric or numeric;
long alphanumeric format can be up to 16 characters long and short format up to 8
characters (refer GSM MoU SE.13 [9]); numeric format is the GSM Location Area
Identification number (refer GSM 04.08 [8] subclause 10.5.1.3) which consists of a
three BCD digit country code coded as in ITU-T E.212 Annex A [10], plus a two
BCD digit network code, which is administration specific; returned shall not
be in BCD format, but in IRA characters converted from BCD; hence the number
has structure: (country code digit 3)(country code digit 2)(country code digit
1)(network code digit 2)(network code digit 1)
Value Description
Unknown
Available
Current
Forbidden
Value Description
GSM
GSM Compact (Not Supported)
UTRAN
Automatic
Note:
value of 3 (automatic) is an added feature not supported by 3GPP.
Example:
AT+COPS?
AT+COPS=1,1,”T-Mobile”
AT+CSPN
Description:
Returns the current service provider name.
Syntax:
Command
+CSPN?
+CSPN=?
+CSPN
Response
+CSPN:
ERROR, +CME ERROR:
ERROR, +CME ERROR:
Novatel Wireless, Proprietary & Confidential
Page173
Values:
String type; long alphanumeric format can be up to 16 characters long
Example:
AT+CSPN?
AT$NWATR
Description:
This command allows the user to read the ATR (answer-to-reset) string from the SIM. Used
for AT+CSIM to determine the capabilities of the SIM. The ATR string is described in
ISO/IEC 7816-3 as mentioned in ETSI 31.111.
Syntax:
Command
$NWATR
$NWATR
=?
$NWATR
$NWATR
Response
$NWATR: ,
ERROR, +CME ERROR:
ERROR, +CME ERROR:
ERROR, +CME ERROR:
Values:
Length of .
string of hex characters as described in ISO/IEC 7816-3.
Example:
AT$NWATR?
AT$NWCID
Description:
Read command returns the current serving cell ID and LAC information.
Syntax:
Comman
Response
$NWCID?
$NWCID: ,
$NWCID=
$NWCID
ERROR
ERROR
Novatel Wireless, Proprietary & Confidential
Page174
Note:
$NWCID command is only available in BUILD 38 (U530) and BUILD 10 (U630) or greater.
If the UE has not camped on a cell then the read command returns “Unknown.”
Example:
AT$NWCID
AT$NWFLASH
Description:
Read command returns the memory device that is populated on the PCB.
Syntax:
Command
$NWFLASH?
$NWFLASH=
$NWFLASH
Response
$NWFLASH:
ERROR
ERROR
Note:
$NWFLASH command is only available on U630 devices.
Example:
AT$NWFLASH?
AT$NWHLR
Description:
The HLR Lock feature, when enabled, allows service providers to limit a UE’s roaming area
(country and network specific) as well as prohibit unauthorized or stolen SIMs from operating
within their network.
The HLR Lock feature utilizes a portion of the SIM International Mobile Subscriber Identity
(IMSI) number to carry out the algorithm. The makeup of the IMSI number is composed of a
3 digit MCC value, a 2 (or 3) digit MNC value and a 9 digit MSIN value. The first three
leading digits of the MSIN form the HLR-value (2 digits) and a NDC identity (1 digit).
The MCC/MNC pair, NDC identity and HLR range(s) that are programmed within the UE are
secured by a service provider specified password.
Syntax:
Command
$NWHLR=(0,,)|(1,,,[hlr
rangelow>,,…]|(2)|(3,1,)|(4,)
Novatel Wireless, Proprietary & Confidential
Page175
Response
$NWHLR:
,
$NWHLR:
OK, ERROR, +CME
ERROR:
ERROR
ERROR
$NWHLR=?
$NWHLR?
Values:
Parameter specifies the desired command.
Valu
Description
Write new MCC/MNC value
Write new OR append to OR delete an HLR
entry
Erase all HLR entries
Set Password/Enable HLR feature
Read HLR entries
Parameter specifies the desired write operation within the specified command.
Valu
Description
Write a new HLR entry
Append to an existing HLR
entry
Erase an existing HLR entry
Parameter specifies the desired read operation within the specified command.
Valu
Description
Read MCC/MNC entry
Read existing HLR
list(s)
Parameter specifies the mobile country code.
Parameter specifies the mobile network code.
Parameter specifies a valid NDC digit or valid HLR list INDEX
Parameter specifies the 12 digit alphanumeric password required to lock/unlock the HLR lists.
Once the password is set, the user must use the facility lock (AT+CLCK) to unlock the HLR
codes.
Parameter specifies the numeric low value of the acceptable HLR value. Acceptable entries
range from 0 to 99 inclusive.
Novatel Wireless, Proprietary & Confidential
Page176
Parameter specifies the numeric high value of the acceptable HLR value. Acceptable entries
range from 0 to 99 inclusive.
Note:
A maximum of 4 NDC values with 15 corresponding HLR range specifications may be
entered. Only one MCC/MNC pair is supported.
Example:
The HLR Lock codes can be read, set, erased and locked using the following custom AT
command:
AT$NWHLR=,[,,…]
Where is one of the following:
0 : for entry of MCC/MNC pair
1 : for entry/appending/deleting of NDC/HLR values
2 : for deletion of entire HLR entries (including MCC/MNC pair)
3 : for password entry and activation of HLR Lock
4 : for displaying HLR entries
Where ,,… represents action items corresponding to the requested (see
below for further details)
If < cmd > = 0,
, is comma-delimitated MCC/MNC network identifier.
(only one entry supported with this command)
If < cmd > = 1,
,,[,…] is comma-delimitated for entry, appending
or deleting HLR parameters.
If < mode > = 0,
= NDC digit (IMSI 8th digit if MNC is 2 digits in length or IMSI 9th digit if MNC is 3 digits in
length)
, is comma-delimitated service provider specified ranges (valid
entries are from 0 to 99). Up to 5 HLR range pairs (low/high) may be entered per =0
command.
If < mode > = 1,
= index (0,1,2,3 to an existing HLR list)
, is comma-delimitated service provider specified ranges (valid
entries are from 0 to 99). Up to 5 HLR range pairs (low/high) may be entered for appending to an
existing list (per command).
If < mode > = 2,
= index (0,1,2,3 to delete a single HLR list entry)
If < cmd > = 2 entire HLR entries deleted (Index 0-3 and MCC/MNC pair)
If < cmd > = 3,1,
To enable & lock the HLR feature.
= “xxxxxxxxxxx” up to 12 digits in length.
Novatel Wireless, Proprietary & Confidential
Page177
If < cmd > = 4,
= 0 to display the single MCC/MNC entry.
= 1 to display NDC and HLR range values.
To populate the network personalization code for the HLR Lock feature (lock to network 123
02):
AT$NWHLR=0,123,02
To populate a new NDC value of 7 and the following HLR ranges; 10-15, 20-22, 34-38, and
67-70:
AT$NWHLR=1,0,7,10,15,20,22,34,38,67,70
AT$NWICCID
Description:
Read command returns the SIM ICC ID.
Syntax:
Command
$NWICCID?
$NWICCID=
$NWICCID
Response
$NWICCID:
ERROR
ERROR
Note:
$NWICCID command is only available on HSDPA devices.
Example:
AT$NWICCID?
AT$NWNPC
Description:
This command allows the user to read, set, and erase the network personalization codes.
The network personalization codes are stored on each card. The purpose is to allow the card
to function only if the MNC/MCC list on the SIM matches the list stored on the card.
Syntax:
Command
$NWNPC?
Response
ERROR, +CME ERROR:
$NWNPC: (list of supported
s)
$NWNPC=?
$NWNPC=0|(1,, )|(2, )|(3,
)
$NWNPC
$NWNPC: ,
ERROR, +CME ERROR:
Values:
Parameter specifies valid s.
Novatel Wireless, Proprietary & Confidential
Page178
Value
Description
Read current NPC list
Write new NPC entry
Erase NPC entry
Set password
Parameter specifies the mobile country code.
Parameter specifies the mobile network code.
Parameter specifies a valid NPC index number.
Parameter specifies the 12 digit alphanumeric password required to unlock the network
personalization code. Once the password is set, the user must use the facility lock
(AT+CLCK) to unlock the network personalization codes.
Note:
A maximum of 30 NPC entries are allowed to be entered. This command is only enabled in
TEST state.
Example:
AT$NWNPC=0
See Also:
AT+CLCK
AT$NWPDN
Description:
This command performs an orderly shutdown of the modem saving the current MRU settings.
Syntax:
Command
$NWPDN
Response
OK
Note:
$NWPDN Command only available in Build 34 or greater.
Once the $NWPDN is issued, the OK response is returned upon completion of the command.
Upon completion of the command, the card must then be power cycled before it is operational
again. It is expected that $NWPDN be the last command issued by a modem manager before it
removes power from the device.
Example:
AT$NWPDN
Novatel Wireless, Proprietary & Confidential
Page179
AT$NWPINR
Description:
This command allows the user to read the number of incorrect PIN entries remaining on the
SIM before PUK lock is enabled.
Syntax:
Command
$NWPINR?
$NWPINR=?
$NWPINR=
$NWPINR
Response
$NWPINR:
ERROR, +CME ERROR:
ERROR, +CME ERROR:
ERROR, +CME ERROR:
Values:
None.
Note:
This command should be used after AT+CPIN? To verify that the SIM PIN is requested. If the
SIM is already unlocked and SIM PIN entry is not necessary then the command does not
return a valid number of retries.
Example:
AT$NWPINR?
AT$NWRAT
Description:
Set command controls the preferred Radio Access Technology to be used by the modem.
Read command returns the preferred and current Radio Access Technology being employed
by the modem.
Syntax:
Command
$NWRAT?
Response
$NWRAT: ,,
$NWRAT: (list of supported s, list of supported
$NWRAT=?
s)
$NWRAT=, OK, ERROR, +CME ERROR:
Values:
Value Description
Automatic
GSM Only
WCDMA Only
Value Description
CS Only (Circuit Switched)
PS Only (Packet Swicthed)
Novatel Wireless, Proprietary & Confidential
Page180
2
CS+PS
Value Description
Searching
WCDMA CS
WCDMA PS
WCDMA CS+PS
GSM CS
GSM PS
GSM CS+PS
Note:
$NWRAT Command only available in Build 20 or greater.
When switching the service domain within a specific mode (RAT) the modem would not
change its service domain unless it lost coverage or changed modes. For example, if the
modem is GSM PS and the following command is issued AT$NWRAT=1,0 to change to GSM
CS, the change will not occur until loss of coverage or change of RAT.
Example:
AT$NWRAT=2,2
Additional AT Commands
This section provides the additional details of the ETSI AT command set implementation for
capable mobile equipment. This implements a minimally featured data-capable WCDMA and
GSM ASIC that performs the needed circuit-switched and packet-switched (PDP type PPP and
GPRS) service.
A series of tables lists these commands, with the first table describing the type of information
provided in each column. Unless specifically noted in the command description, all commands
listed in the following tables are rejected by the command processor when the SIM is absent or
when SIM PIN validation is pending.
Each of the following sections discusses an individual AT command in the subsections below:
Description:
Describes the command. Defines any conditions required to use the
command
Syntax:
Lists the syntax the command requires
Parameters:
Lists any parameters and value ranges for the command
Implementation:
Explains whether QUALCOMM has implemented the command
ATH
Description:
Hook control command to terminate call in progress. Does not terminate
voice calls.
Syntax:
ATH
Parameters:
Novatel Wireless, Proprietary & Confidential
Page181
Values per Spec ITU-T V.25ter
Implementation:
Fully. Online command mode only supported for Async data
ATI
Description:
Request identification information
This extended-format compound parameter is used to control t he operation
of local flow control between the DTE and DCE.
Syntax:
ATI
Parameters:
No value accepted
Implementation:
Fully. Unit outputs: manufacturer, model number, mobile software revision,
boot block version, release date, release time, IMEI, complete capabilities list
ATL
Description:
Monitor speaker loudness
Syntax:
ATL |