Extended AT Commands Manual

AirPrime

4115730
5.0
March 26, 2015
 Extended AT Commands Manual Overview

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

Safety and Hazards

Do not operate the Sierra Wireless modem in areas where cellular modems are not advised without
proper device certifications. These areas include environments where cellular radio can interfere such
as explosive atmospheres, medical equipment, or any other equipment which may be susceptible to
any form of radio interference. The Sierra Wireless modem can transmit signals that could interfere
with this equipment. Do not operate the Sierra Wireless modem in any aircraft, whether the aircraft is
on the ground or in flight. In aircraft, the Sierra Wireless modem MUST BE POWERED OFF. When
operating, the Sierra Wireless modem can transmit signals that could interfere with various onboard
systems.
Note: Some airlines may permit the use of cellular phones while the aircraft is on the ground and the door is
open. Sierra Wireless modems may be used at this time.

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

Limitations of Liability
This manual is provided “as is”. Sierra Wireless makes no warranties of any kind, either expressed or
implied, including any implied warranties of merchantability, fitness for a particular purpose, or
noninfringement. The recipient of the manual shall endorse all risks arising from its use.
The information in this manual is subject to change without notice and does not represent a
commitment on the part of Sierra Wireless. SIERRA WIRELESS AND ITS AFFILIATES
SPECIFICALLY DISCLAIM LIABILITY FOR ANY AND ALL DIRECT, INDIRECT, SPECIAL,
GENERAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES INCLUDING,
BUT NOT LIMITED TO, LOSS OF PROFITS OR REVENUE OR ANTICIPATED PROFITS OR
REVENUE ARISING OUT OF THE USE OR INABILITY TO USE ANY SIERRA WIRELESS
PRODUCT, EVEN IF SIERRA WIRELESS AND/OR ITS AFFILIATES HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES OR THEY ARE FORESEEABLE OR FOR CLAIMS BY ANY
THIRD PARTY.
Notwithstanding the foregoing, in no event shall Sierra Wireless and/or its affiliates aggregate liability
arising under or in connection with the Sierra Wireless product, regardless of the number of events,
occurrences, or claims giving rise to liability, be in excess of the price paid by the purchaser for the
Sierra Wireless product.
Customer understands that Sierra Wireless is not providing cellular or GPS (including A-GPS)
services. These services are provided by a third party and should be purchased directly by the
Customer.

4115730 Rev 5.0 March 26, 2015 2

 Extended AT Commands Manual Overview

SPECIFIC DISCLAIMERS OF LIABILITY: CUSTOMER RECOGNIZES AND ACKNOWLEDGES

SIERRA WIRELESS IS NOT RESPONSIBLE FOR AND SHALL NOT BE HELD LIABLE FOR ANY
DEFECT OR DEFICIENCY OF ANY KIND OF CELLULAR OR GPS (INCLUDING A-GPS)
SERVICES.

Patents
This product may contain technology developed by or for Sierra Wireless Inc.
This product includes technology licensed from QUALCOMM®.
This product is manufactured or sold by Sierra Wireless Inc. or its affiliates under one or more patents
licensed from InterDigital Group and MMP Portfolio Licensing.

Copyright
© 2015 Sierra Wireless. All rights reserved.

Trademarks
Sierra Wireless®, AirPrime®, AirLink®, AirVantage®, WISMO®, ALEOS® and the Sierra Wireless and
Open AT logos are registered trademarks of Sierra Wireless, Inc. or one of its subsidiaries.
Watcher® is a registered trademark of Netgear, Inc., used under license.
Windows® and Windows Vista® are registered trademarks of Microsoft Corporation.
Macintosh® and Mac OS X® are registered trademarks of Apple Inc., registered in the U.S. and other
countries.
QUALCOMM® is a registered trademark of QUALCOMM Incorporated. Used under license.
Other trademarks are the property of their respective owners.

Contact Information
Phone: 1-604-232-1488
Sales Desk: Hours: 8:00 AM to 5:00 PM Pacific Time
Contact: http://www.sierrawireless.com/sales
Sierra Wireless
13811 Wireless Way
Post:
Richmond, BC
Canada V6V 3A4
Technical Support: [email protected]
RMA Support: [email protected]
Fax: 1-604-231-1109
Web: http://www.sierrawireless.com/

Consult our website for up-to-date product descriptions, documentation, application notes, firmware
upgrades, troubleshooting tips, and press releases: www.sierrawireless.com

4115730 Rev 5.0 March 26, 2015 3

 Extended AT Commands Manual Overview

Document History
Version Date Updates

1.0 August 8, 2014 Creation

Added:
 Section 9.1.5.8 and its subsections

2.0 November 7, 2014

Updated:
 Section 1.6
 Section 9.1.5.3.2, Read Command
Aligned ECALL_DIAL_DURATION with ERA GLONASS Specification.
3.0 November 26, 2014
Added ECALL_TIME_BETWEEN_REDIALS variable.
Updated document legal boilerplate content.
4.0 January 6, 2015 Added Audio AT Commands chapter.
Updated document with Internet Library Commands chapter.
Updated document legal boilerplate content.
Added parameter <ECALL_TIME_BEFORE_UNMUTE_AFTER_AL_ACK> to
5.0 March 26, 2015 Command +ERAGSETERA
Updated AT+GPSSLEEP=? result in the Examples section.
Updated command availability in sections 8.1.1, .8.2.1, and 8.4.1.

4115730 Rev 5.0 March 26, 2015 4

 Contents
CONTENTS ............................................................................................................... 5
1. OVERVIEW .......................................................................................................... 9
1.1. Scope of this Document ......................................................................................................9
1.2. Related Documents ...........................................................................................................10
1.3. ETSI Secretariat ................................................................................................................11
1.4. Abbreviations and Definitions ............................................................................................12
1.4.1. Abbreviations ...........................................................................................................12
1.4.2. Definitions.................................................................................................................16
1.5. AT Commands Presentation Rules ...................................................................................17
1.6. AT Commands Applicability...............................................................................................18

2. AT COMMANDS FEATURES ............................................................................ 23

2.1. Sierra Wireless Line Settings ............................................................................................23
2.2. Command Line ..................................................................................................................23
2.3. Information Responses and Result Codes ........................................................................23

3. INTERNET LIBRARY COMMANDS................................................................... 24

3.1. General Configuration .......................................................................................................24
3.1.1. IP Stack Handling +WIPCFG ...................................................................................24
3.1.2. Bearers Handling +WIPBR ......................................................................................34
3.2. IP Protocol Services ..........................................................................................................43
3.2.1. Service Creation +WIPCREATE ..............................................................................43
3.2.2. Closing a Service +WIPCLOSE ...............................................................................52
3.2.3. Service Option Handling +WIPOPT .........................................................................55
3.3. Data Exchange for Protocol Services ................................................................................66
3.3.1. File Exchange +WIPFILE .........................................................................................66
3.3.2. Socket Data Exchange +WIPDATA .........................................................................76
3.3.3. DATA Offline Session +WIPDATARW .....................................................................86
3.4. Ping Services .....................................................................................................................90
3.4.1. PING Command +WIPPING ....................................................................................90
3.5. Internet Library Application Examples ...............................................................................93
3.5.1. TCP Socket ..............................................................................................................93
3.5.2. UDP Socket ..............................................................................................................96
3.5.3. PING.........................................................................................................................97
3.5.4. FTP...........................................................................................................................98
3.5.5. FTP DATA Offline ....................................................................................................98
3.5.6. HTTP ........................................................................................................................99
3.5.7. SMTP .....................................................................................................................100
3.5.8. POP3 ......................................................................................................................101
3.5.9. MMS .......................................................................................................................102
3.5.10. TCP Server Example .............................................................................................105
3.5.11. Server Creation Failure Example ...........................................................................105

4115730 Rev 5.0 March 26, 2015 5

 Extended AT Commands Manual Overview

3.5.12. TCP Client Creation Failure Example ....................................................................106

3.5.13. Socket, Client, and Server Creation Example........................................................107
3.5.14. MAX_SOCK_NUM Usage Failure Example ..........................................................110
3.5.15. Socket, Client, Server, and FTP/HTTP/SMTP/POP3 Creatoin Example...............111
3.5.16. Internet Library API Subscribe/Unsubscribe Example ...........................................115
3.5.17. TCP Client/Server Creation/Simultaneous UART Mapping Example ....................115
3.6. Error Codes .....................................................................................................................116
3.6.1. General CME Error Codes .....................................................................................116
3.6.2. GPRS CME Error Codes........................................................................................118

4. LOCATION LIBRARY COMMANDS ................................................................ 119

4.1. AT Commands Reference ...............................................................................................119
4.1.1. Command +GPSHELP...........................................................................................119
4.1.2. Command +GPSNMEA..........................................................................................120
4.1.3. Command +GPSPVT .............................................................................................124
4.1.4. Command +GPSSAVE ..........................................................................................128
4.1.5. Command +GPSSTART ........................................................................................130
4.2. Advanced AT Commands Reference ..............................................................................132
4.2.1. Command +GPSSTATE ........................................................................................132
4.2.2. Command +GPSINIT .............................................................................................133
4.2.3. Command +GPSSTOP ..........................................................................................139
4.2.4. Command +GPSSLEEP ........................................................................................140
4.2.5. Command +GPSTTFF ...........................................................................................142
4.2.6. Command +GPSRELEASE ...................................................................................143
4.2.7. Command +GPSVERS ..........................................................................................144
4.2.8. Command +GPSCONF ..........................................................................................145
4.2.9. Command +GPSDEBUG .......................................................................................150
4.2.10. Command +GPSAID ..............................................................................................152
4.2.11. Command +GPSCORE..........................................................................................163
4.3. Asynchronous Events ......................................................................................................166
4.3.1. Description .............................................................................................................166
4.3.2. Syntax ....................................................................................................................166
4.3.3. Parameters and Defined Values ............................................................................169
4.4. Location AT Commands Error Codes .............................................................................171
4.5. Aiding Event Error Codes ................................................................................................172

5. SECURITY LIBRARY COMMANDS ................................................................ 173

5.1. AT Commands Reference ...............................................................................................173
5.1.1. Command +SSLINIT ..............................................................................................173
5.1.2. Command +SSLSET ..............................................................................................174
5.1.3. Command +SSLSETOPTS ....................................................................................178
5.1.4. Command +SSLRELEASE ....................................................................................179
5.1.5. Command +SSLSTATE .........................................................................................179
5.1.6. Command +SSLBOOST ........................................................................................180
5.1.7. Command +SSLVERSION ....................................................................................182
5.2. Asynchronous Events ......................................................................................................183

4115730 Rev 5.0 March 26, 2015 6

 Extended AT Commands Manual Overview

5.3. Security AT Commands Error Codes ..............................................................................183

6. NETWORK SCAN COMMAND ........................................................................ 184

6.1. Library Description ...........................................................................................................184
6.2. Library API .......................................................................................................................184
6.3. Command +NWKSCAN...................................................................................................184
6.4. Examples .........................................................................................................................187

7. JAMMING DETECTION COMMAND ............................................................... 189

7.1. Application Description ....................................................................................................189
7.1.1. Command +WJAM .................................................................................................189

8. AUDIO AT COMMANDS .................................................................................. 190

8.1. +AUDIOINIT Audio Initialization Command ...................................................................190
8.1.1. Command Availability.............................................................................................190
8.1.2. Command Behavior ...............................................................................................190
8.1.3. Example .................................................................................................................190
8.2. +AUDIOEXIT Audio Exit Command ...............................................................................191
8.2.1. Command Availability.............................................................................................191
8.2.2. Command Behavior ...............................................................................................191
8.2.3. Examples................................................................................................................191
8.3. +AUDIOFILE Play & Record Audio Files........................................................................191
8.3.1. Command Availability.............................................................................................194
8.3.2. Command Behavior ...............................................................................................194
8.3.3. Examples................................................................................................................195
8.3.4. Errors......................................................................................................................195
8.4. +AUDIOCONVERT Transcode AMR File to PCM File...................................................196
8.4.1. Command Availability.............................................................................................196
8.4.2. Command Behavior ...............................................................................................196
8.4.3. Examples................................................................................................................197
8.4.4. Errors......................................................................................................................197

9. ECALL IN-BAND MODEM LIBRARY COMMANDS ........................................ 199

9.1. AT Commands Reference ...............................................................................................199
9.1.1. Library Control Commands ....................................................................................199
9.1.2. In-Band Channel Control Commands ....................................................................202
9.1.3. MSD Control Commands .......................................................................................205
9.1.4. CECALL functionality .............................................................................................210
9.1.5. Unified eCall Services Functionality .......................................................................213
9.2. Asynchronous Events ......................................................................................................229
9.2.1. Asynchronous Library Control Command Events ..................................................229
9.2.2. Asynchronous Unified eCall Service Events ..........................................................229
9.3. Example of AT Command Sequence ..............................................................................231
9.3.1. Pull Mode ...............................................................................................................231
9.3.2. Push Mode .............................................................................................................232
9.4. In-Band AT Command Error Codes ................................................................................233

4115730 Rev 5.0 March 26, 2015 7

 Extended AT Commands Manual Overview

10. ERA GLONASS SERVICE MANAGER COMMANDS ..................................... 234

10.1. AT Commands Reference ...............................................................................................234
10.1.1. Command +ERAGINIT...........................................................................................234
10.1.2. Command +ERAGSETERA ...................................................................................237
10.1.3. Command +ERAGCALL ........................................................................................239
10.1.4. Command +ERAGSETMSD ..................................................................................245
10.1.5. Command +ERAGCALLCANCEL..........................................................................248
10.1.6. Command +ERAGRELEASE .................................................................................249
10.1.7. Command +ERAGGETSTATE ..............................................................................250
10.1.8. Command +ERAGVERSION .................................................................................251
10.1.9. Command +ERAGOPTDATA ................................................................................252
10.1.10. Examples................................................................................................................256
10.2. Asynchronous Events ......................................................................................................256
10.2.1. Command +ERAGEV.............................................................................................257
10.2.2. Command +ERAGMSD .........................................................................................258
10.2.3. Command +ERAGERROR ....................................................................................259
10.3. ERA GLONASS Service AT Commands Error Codes ....................................................259
10.4. Example of AT Command Sequence ..............................................................................260

11. FILE SYSTEM COMMANDS ............................................................................ 262

11.1. Application Description ....................................................................................................262
11.1.1. Command +FSINIT File System Initialization ........................................................262
11.1.2. Command +FSEXIT File System Close .................................................................262
11.1.3. Command +FS File System Management ............................................................262
11.2. Possible Errors ................................................................................................................264
11.3. Examples .........................................................................................................................265

INDEX .................................................................................................................... 268

4115730 Rev 5.0 March 26, 2015 8

 1. Overview
This document provides Sierra Wireless customers with a full description of the Extended AT
commands available via the Open AT Libraries and other software elements, including the following:
 Internet Library Commands
 Location Library Commands
 Security Library Commands
 Network Scan Command
 Jamming Detection Command
 eCall In-Band Modem Library Commands
 ERA Glonass Service Manager Commands
 File System Commands
Note: Though all features are documented in this manual, new features may still be in beta stage at publication
and therefore may not yet be validated. Please refer to the Customer Release Note for complete and
detailed information regarding beta and validated features at time of release.

The AirPrime embedded modules to which the manual applies are the following:
 Q2698
 SL3010T
 SL8080T
 SL8082T
 SL8084T

1.1. Scope of this Document

This document describes the AT-command based messages exchanged between an application and
Sierra Wireless products in order to manage GSM/GPRS related events or services.

Embedded module

External AT
Application
Send AT command

Serial Link
Receive AT response

4115730 Rev 5.0 March 26, 2015 9

 Extended AT Commands Manual Overview

1.2. Related Documents

This interface specification is based on the following recommendations:
[1] AT Commands Interface Guide, Reference: 4111843
[2] Internet Application AT Commands User Guide – Internet Application, Reference: 4111846
[3] Location Library for Open AT Framework AT Commands – Interface Guide, Reference: 4111879
[4] Security AT Commands for Open AT Application Framework – Interface Guide, Reference:
4112704
[5] AT Command Interface Guide – eCall In-Band Modem Library, Reference: 4112357
[6] CW Jamming Application Note, Reference: CS-210066-AN-2
[7] AirPrime – SL808xT - Product Technical Specification & Customer Design Guidelines, Reference:
4111992
[8] ASN1 for eCall In-Band Modem Library – Application Note, Reference: 4114948 or
WM_DEV_INBM_APN_001
[9] 3GPP TS 26.267 V9.3.0 - V8.6.0
[10] 3GPP TS 26.268 V9.4.0 - V8.6.0
[11] 3GPP TS 26.269 V9.2.0 - V8.3.0
[12] DEE feature Application Note for SL3010T, Reference: Reference: 4112292
[13] Jamming Detection - Security Plug-In User Manual, Reference: WM_DEV_SEC_UGD_003

4115730 Rev 5.0 March 26, 2015 10

 Extended AT Commands Manual Overview

1.3. ETSI Secretariat

The following addresses may be of use in obtaining the latest GSM/GPRS recommendations:
Postal address: F-06921 Sophia Antipolis CEDEX – France
Office address: 650 Route des Lucioles – Sophia Antipolis – Valbonne – France
Web address: http://www.etsi.org/
Tel: +33 4 92 94 42 00
Fax: +33 4 93 65 47 16

4115730 Rev 5.0 March 26, 2015 11

 Extended AT Commands Manual Overview

1.4. Abbreviations and Definitions

1.4.1. Abbreviations

Abbreviation Definition

ACM Accumulated Call Meter

ADC Analog Digital Converter
ADN Abbreviated Dialing Number (Phonebook)
AMR Adaptive Multi-Rate
AMR-FR AMR Full Rate (full rate speech version 3)
AMR-HR AMR Half Rate (half rate speech version 3)
AOC Advice Of Charge
APN Access Point Name
ARN Address Resolution Protocol
ARFCN Absolute Radio Frequency Channel Number
ASCII American Standard Code for Information Interchange, Standard characters
table (1 byte coding)
AT ATtention; Hayes Standard AT command Set
BCCH Broadcast Channel
BER Bit Err Rate
BM Broadcoast Message Storage
CBM Cell Broadcast Message
CB Cell Broadcast
CCK Corporate Control Key
CCM Current Call Meter
CHV Card Holder Verification
CHAP Challenge handshake Authentication Protocol
CI Cell Identifier
CLI Client Line Identification
CLIP Calling Line Identification Presentation
CLIR Calling Line Identification Restriction
CNL Cooperative Network List
CODEC Coder Decoder
COLP Connected Line Identification Presentation
CPHS Common PCN Handset Specification
CPU Central Processing Unit
CSD Circuit Switched Data
CSP Customer Service Profile
CTM Cellular Text telephone Modem
CTS Clear To Send signal
CUG Closed User Group
DAC Digital to Analog Converter
DTR Data Terminal Ready

4115730 Rev 5.0 March 26, 2015 12

 Extended AT Commands Manual Overview

Abbreviation Definition

DCS Digital Cellular System

DCE Data Circuit Equipment
DCD Data Carrier Detect
DLC Data Link Connection
DLCI Data Link Connection Identifier
DM Device Management
DNS Domain Name System
DSR Data Set Ready
DTE Date Terminal Equipment
DTMF Dual Tone Multi-Frequency
DTR Data Terminal Ready
ECC Emergency Call Codes
ECM Error Correction Mode
ECT Explicit Call Transfer
EDGE Enhanced Data rates for GSM Evolution
EEPROM Electrically Erasable Programming Only Memory
EF Elementary Files
EFR Enhanced Full Rate (full rate speech version 2)
EGPRS Enhanced GPRS
ENS Enhanced Network Selection
E-ONS Enhanced Operator Name Service
ERMES European Radio Messaging System
ETSI European Telecommunications Standards Institute
FD FIFO depth
FDN Fixed Dialing Number (Phonebook)
FR Full Rate (full rate speech version 1)
GERAN GSM EDGE Radio Access Network
GPIO General Purpose Input Output
GPRS General Packet Radio Service
GSM Global System for Mobile communication
HDLC High-level Data Link Control
HFR High Frequency Regeneration
HLR Home Location Register
HR Half Rate (half rate speech version 1)
HSDPA High Speed Downlink Packet Access
HSUPA High Speed Uplink Packet Access
ID IDentifier
IETF Internet TEngineering Task ForceT
IMEI International Mobile Equipment Identity
IMSI International Mobile Subscriber Identity
IN/OUT/IN_OUT In, out or In Out. see glossary
I/O Input/Output
IP Internet Protocol

4115730 Rev 5.0 March 26, 2015 13

 Extended AT Commands Manual Overview

Abbreviation Definition

LAC Local Area Code

LED Light Emitting Diode
LND Last Number Dialed
LP Language Preferred
LPI Lines Per Inch
M Mandatory
MCC Mobile Country Code
ME Mobile Equipment
MMI Man Machine Interface
MNC Mobile Network Code
MNP Microcom Networking Protocol
MO Mobile Originated
MOC Mobile Originated Call (outgoing call)
MS Mobile Station
MSB Most Significant Bit
MSISDN Mobile Station International ISDN Number
MT Mobile Terminal
MTC Mobile Terminated Call (incoming call)
N.A. Not applicable
NCK Network Control Key
NITZ Network Information and Time Zone
NSCK Network Subset Control Key
NTC Negative Temperature Coefficient
N.U. Not used
O Optional
OA Outgoing Access
OPL Operator PLMN List
OS Operating System
OTA Over the Air
PAD Portable Application Description
PAP Password Authentication Protocol
PC Personal Computer
PCCP PC character set Code Page
PCK Personalization Control Key
PCL Power Control Level
PCM Protection Circuit Module
PCN Personal Communication Network
PCS 1900 Personal Communication Service (GSM system offering 148 full duplex voice
channels per cell)
PDP Packet Data Protocol
PDU Protocol Description Unit
PIN Personal Identification Number
PLMN Public Land Mobile Networks
PNN PLMN Network Name

4115730 Rev 5.0 March 26, 2015 14

 Extended AT Commands Manual Overview

Abbreviation Definition

PPP Point-to-Point Protocol

Peer to Peer
PSTN Public Switched Telephone Network
PTS Product Technical Specification
PUCT Price per Unit and Currency Table
PUK PIN Unlock Key
QoS Quality of Service
RAM Random Access Memory
RDMS Remote Device Management Services
RI Ring Indicator
RIL Radio Interface Layer
RLP Radio Link Protocol
RSSI Received Signal Strength Indication
RTS Ready To Send signal
RX Reception
SAP Service Access Point
SC Service Center
SDU Service Data Unit
SIM Subscriber Information Module
SMSR Short Message Status Report
SMS Short Message Service
SS Supplementary Services
SPCK Service Provider Control Key
SPN Service Provider Name
STK Sim ToolKit
SVN Software Version Number
TA Terminal Adaptor
TBF Temporary Block Flow
TE Terminal Equipment
TTY TeleTYpe
TON/NPI Type Of Number/Numbering Plan Identification
TX Transmission
UART Universal Asynchronous Receiver Transmitter
UCS2 Universal Character Set 2 Character table (2-byte coding)
UDUB User Determined User Busy
UIH Unnumbered Information with Header check
UMTS Universal Mobile Telecommunication System
USB Universal Serial Bus
USSD Unstructered Supplementary Service Data
UTRAN Universal Terrestrial Radio Access Network

4115730 Rev 5.0 March 26, 2015 15

 Extended AT Commands Manual Overview

1.4.2. Definitions
The words "Mobile Station" (MS) or "Mobile Equipment" (ME) are used for mobile terminals
supporting GSM/GPRS services.
Terminal Equipment is the Man-Machine Interface of a GSM/GPRS device (modem or handset). A TE
can be a handset MMI or the AT command line interface.

Sierra Wireless product

GSM/GPRS network

User TE ME

A call from a GSM/GPRS mobile station to the PSTN is called a "mobile originated call" (MOC) or
"outgoing call", and a call from a fixed network to a GSM/GPRS mobile station is called a "mobile
terminated call" (MTC) or "incoming call"
In this document, the word "product" refers to any Sierra Wireless product supporting the AT
commands interface.

4115730 Rev 5.0 March 26, 2015 16

 Extended AT Commands Manual Overview

1.5. AT Commands Presentation Rules

The AT commands are presented in the present documentation as follows:
 A "Description" section provides general information on the AT command (or response)
behaviour.
 A "Syntax" section describes the command and response syntaxes and all parameters
description.
 A "Parameters and Defined Values" section describes all parameters and values.
 A "Parameter Storage" presents the command used to store the parameter value and/or the
command used to restore the parameter default value.
 An "Examples" section presents the real use of the described command.
 A "Note" section can also be included indicating some remarks about the command use.
 Figures are provided where necessary

4115730 Rev 5.0 March 26, 2015 17

 Extended AT Commands Manual Overview

1.6. AT Commands Applicability

The following table presents all available AT Commands, and which are applicable to each product.
The table is marked with the indicators below.
F: Fully supported
P: Partially supported or with specific behavior – Please see Notes section of corresponding AT
command.
N: Not supported.

SL808xT (SL8080T,
Description Q2698 SL3010T
SL8082T, SL8084T)

Internet Library Commands

General Configuration

IP Stack Handling +WIPCFG F F F

Bearers Handling +WIPBR F F F

IP Protocol Services

Service Creation +WIPCREATE F F F

Closing a Service +WIPCLOSE F F F

Service Option Handling +WIPOPT F F F

Data Exchange for Protocol Services

File Exchange +WIPFILE F F F

Socket Data exchange +WIPDATA F F F

DATA Offline session +WIPDATARW F F F

Ping Services

PING command +WIPPING F F F

Location Library Commands

AT Command Reference

+GPSHELP F F F

+GPSNMEA P P P

4115730 Rev 5.0 March 26, 2015 18

 Extended AT Commands Manual Overview

SL808xT (SL8080T,
Description Q2698 SL3010T
SL8082T, SL8084T)

+GPSPVT N N N

+GPSSAVE F F F

+GPSSTART F F F

Advanced AT Commands Reference

+GPSSTATE F F F

+GPSINIT P P P

+GPSSTOP F F F

+GPSSLEEP P P P

+GPSTTFF F F F

+GPSRELEASE F F F

+GPSVERS F F F

+GPSCONF P P P

+GPSDEBUG N N N

+GPSAID P P P

+GPSCORE N N N

Security Commands

+SSLINIT F F F

+SSLSET F F F

+SSLSETOPTS F F F

+SSLRELEASE F F F

+SSLSTATE F F F

+SSLBOOST F F F

+SSLVERSION F F F

4115730 Rev 5.0 March 26, 2015 19

 Extended AT Commands Manual Overview

SL808xT (SL8080T,
Description Q2698 SL3010T
SL8082T, SL8084T)

Network Scan Library Command

Network Scan +NWKSCAN N N N

Jamming Detection Command

Jamming Detection +WJAM N N N

Audio Commands

+AUDIOINIT F N N

+AUDIOEXIT F N N

+AUDIOFILE F N N

+AUDIOCONVERT F N N

eCall In-Band Modem Library AT Commands

Library Control Commands

+INBMINIT F N N

+INBMEXIT F N N

+INBMGETVER F N N

+INBMSTATE F N N

In-Band Channel Control Commands

+INBMOPEN F N N

+INBMCLOSE F N N

+INBMCHSTATE F N N

MSD Control Commands

+INBMSETMSD F N N

+INBMPUSH F N N

+INBMMSDFORMAT F N N

+INBMTIMERCFG F N N

4115730 Rev 5.0 March 26, 2015 20

 Extended AT Commands Manual Overview

SL808xT (SL8080T,
Description Q2698 SL3010T
SL8082T, SL8084T)

CECALL functionality

+CECALLINIT F N N
+CECALL F N N

Unified eCall Services functionality

+ECALLINIT F N N
+ECALLCFG F N N
+ECALLSETMSD F N N
+ECALLCANCEL F N N
+ECALLRELEASE F N N
+ECALLGETSTATE F N N
+ECALLVERSION F N N

ERA GLONASS Service Manager AT Commands

AT Commands

+ERAGINIT F N N
+ERAGSETERA F N N
+ERAGCALL F N N
+ERAGSETMSD F N N
+ERAGCALLCANCEL F N N
+ERAGRELEASE F N N
+ERAGGETSTATE F N N
+ERAGVERSION F N N
+ERAGOPTDATA F N N

Asynchronous Events

+ERAGEV F N N
+ERAGMSD F N N
+ERAGERROR F N N

4115730 Rev 5.0 March 26, 2015 21

 Extended AT Commands Manual Overview

SL808xT (SL8080T,
Description Q2698 SL3010T
SL8082T, SL8084T)

File System AT Commands

+FSINIT F N N
+FSEXIT F N N
+FS F N N

4115730 Rev 5.0 March 26, 2015 22

 2. AT Commands Features

2.1. Sierra Wireless Line Settings

A serial link handler is set with the following default values (factory settings):
 speed according to customer choice at order time,
 8 bits data,
 1 stop bit,
 no parity,
 RTS/CTS flow control.
Please use the +IPR, +IFC and +ICF commands to change these settings.

2.2. Command Line

Commands always start with AT and finish with a <CR> character, excepted A/ command.

2.3. Information Responses and Result Codes

Responses start and end with <CR><LF>, except for the ATV0 DCE response format and the ATQ1
(result code suppression) commands.
 If command syntax is incorrect, the "ERROR" string is returned.
 If command syntax is correct but transmitted with wrong parameters, the "+CME ERROR:
<Err>" or "+CMS ERROR: <SmsErr>" strings is returned with adequate error codes if CMEE
was previously set to 1. By default, CMEE is set to 0, and the error message is only
"ERROR".
 If the command line has been executed successfully, an "OK" string is returned.
In some cases, such as "AT+CPIN?" or (unsolicited) incoming events, the product does not return the
"OK" string as a response.
In the following examples <CR> and <CR><LF> are intentionally omitted.
Note: The command syntax accepts negative parameters. If the command parameter is negative and out of the
acceptable range, the "+CME ERROR: 3" string is returned if CMEE was previously set to 1.

4115730 Rev 5.0 March 26, 2015 23

 3. Internet Library Commands

3.1. General Configuration

3.1.1. IP Stack Handling +WIPCFG

3.1.1.1. Description
The +WIPCFG command is used for performing the following operations:
 start TCP/IP stack
 stop TCP/IP stack
 configuring TCP/IP stack
 displaying version information

3.1.1.2. Syntax
 if<mode>=0,1

Action Command
AT+WIPCFG=<mode>
OK

 if <mode>=2

Action Command
AT+WIPCFG=<mode>,<opt num>,<value>
OK

 if <mode>=3

Action Command
AT+WIPCFG=<mode>
WIPsoft vXX.YY.ZZ on Open AT OS vA.B
MMM-DDD-YYYY HH:MM:SS <WIPlib: version number> <WIPsoft: version number>
OK

4115730 Rev 5.0 March 26, 2015 24

 Extended AT Commands Manual Internet Library Commands

 if <mode>=4

Action Command
AT+WIPCFG=<mode>,<action>
OK

Read Command
AT+WIPCFG?
+WIPCFG: <optnum>,<value>
[+WIPCFG: <optnum>,<value>[..]]
OK

Test Command
AT+WIPCFG=?
OK

3.1.1.3. Parameters and Defined Values

<mode>: requested operation

0 stop TCP/IP stack

start TCP/IP stack

1 Note: If the Ethernet bearer support is defined, the Ethernet driver is subscribed on
executing (+WIPCFG = 1)

2 configure TCP/IP stack

3 display TCP/IP application version

4 TCP/IP stack configuration management

<opt num>: configuration option identifier

0 WIP_NET_OPT_IP_TTL – Default TTL of outgoing data grams

This option is a limit on the period of time or number of iterations or transmissions that a
unit of data can experience before it should be discarded. The time to live (TTL) is an 8-
bit field in the Internet Protocol (IP) header. It is the 9th octet of 20. The default value of
this parameter is 64. Its value can be considered as an upper bound on the time that an
IP datagram can exist in an internet system. The TTL field is set by the sender of the
datagram, and reduced by every host on the route to its destination. If the TTL field
reaches zero before the datagram arrives at its destination, then the datagram is
discarded. This is used to avoid a situation in which an undelivered datagram keeps
circulating in the network.
range: 0-255 (default value: 64)

1 WIP_NET_OPT_IP_TOS – Default TOS of outgoing parameters

4115730 Rev 5.0 March 26, 2015 25

 Extended AT Commands Manual Internet Library Commands

The IP protocol provides a facility for the Internet layer to know about the various
tradeoffs that should be made for a particular packet. This is required because paths
through the Internet vary widely in terms of the quality of service provided. This facility
is defined as the "Type of Service" facility, abbreviated as the "TOS facility".
The TOS facility is one of the features of the Type of Service octet in the IP datagram
header. The Type of Service octet consists of following three fields:
0 1 2 3 4 5 6 7
+-----+-----+-----+-----+-----+-----+-----+-----+
| | | |
| PRECEDENCE | TOS | MBZ |
| | | |
+-----+-----+-----+-----+-----+-----+-----+-----+

The first field is "PRECEDENCE". It is intended to denote the importance or priority of

the datagram.
The second field is "TOS" which denotes how the network should maintain the tradeoffs
between throughput, delay, reliability, and cost.
The last field is "MBZ" (Must Be Zero"), is currently unused and is set to 0. The TOS
field can have the following values:
1000 -- minimize delay
0100 -- maximize throughput
0010 -- maximize reliability
0001 -- minimize monetary cost
0000 -- normal service
For more information on this field please refer to RFC1349.
range: 0-255 (default value: 0)

2 WIP_NET_OPT_IP_FRAG_TIMEO - Time to live in seconds of incomplete fragments

When a datagram’s size is larger than the MTU (Maximum Transmission Unit) of the
network, then the datagram is divided into smaller fragments. These divided fragments
are sent separately. The “WIP_NET_OPT_IP_FRAG_TIMEO” option specifies the Time
to live for these fragments.
range: 1-65535 (default value: 60)
3 WIP_NET_OPT_TCP_MAXINITWIN – Number of segments of initial TCP window
This option is used to specify the number of segments in the initial TCP window.
A TCP window specifies the amount of outstanding (unacknowledged by the recipient)
data a sender can send on a particular connection before it gets an acknowledgment
back from the receiver. The primary reason for the window is congestion control.
range: 0-65535 (default value: 0)
4 WIP_NET_OPT_TCP_MIN_MSS - Default MSS of off-link connections
This option is used by the Internet Library internally. This parameter specifies the
maximum size of TCP segment which would be sent. By default, the value of this
parameter is set to 536. Hence Internet Library would not send any TCP segment
having a length greater than 536 bytes without header.
range: 536-1460 (default value: 536)
5 WIP_NET_OPT_DEBUG_PORT
This option is used to specify the port on which the debug traces are to be sent.
range: 0-3 (default value: 0)
12 AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE - Used for TCP sockets to configure the
packet segmentation on IP network side
This option is used to specify the maximum time to wait between two successive data
chunks received from the mapped UART/serial port (please see +WIPDATA AT

4115730 Rev 5.0 March 26, 2015 26

 Extended AT Commands Manual Internet Library Commands

command). It allows the application to buffer a certain amount of data before writing on
IP network side.
Each unit in the range represents 100 msec. For example, value 10 for this option will
give a wait time of 1sec (10*100msec).
Default value for AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE option is 0. This value
means that no specific process is done to avoid TCP packets segmentation: data are
written onto IP network without any delay after the reception of data from the mapped
UART/serial port (please see +WIPDATA AT command). In this case some TCP
packets sent on the IP network may be smaller than TCP_MIN_MSS value.
Setting e.g. a 10 value for this option will make the application to wait at least 1 second
or twice the TCP_MIN_MSS value to be reached before sending data on IP network. In
this case, TCP packets size sent on the IP network should be equal to at least
TCP_MIN_MSS (Default value = 536 bytes).
range: 0- 100 (default value: 0)
13 AT_WIP_NET_OPT_ESC_SEQ_NOT_SENT : Used to configure whether a “+++”
escape sequence should be sent as data to the peer. By default, this option is set to 0
which means that the “+++”sequence is sent to the peer as data. If set to 1,
“+++”sequence is not sent as data to the peer.
range: 0 -1(default value:0)
14 AT_WIP_NET_OPT_AUTO_SWITCH - Used for TCP socket, to switch back
automatically to AT command mode when the TCP connection is closed by peer entity
0: Does not switch automatically to AT mode
1: Switches automatically to AT mode
range: 0-1 (default value:0)
15 Set DATA offline (+WIPDATARW) RX and TX buffer size in bytes
range : 1 – 32000 (default value 2048)
16 WIP_NET_OPT_TCP_REXMT_MAX – Maximum timeout of TCP packets; the
maximum time between TCP retransmissions
range: 1 - 64 (default value:64 seconds)
17 WIP_NET_OPT_TCP_REXMT_MAXCNT - Max number of TCP packet retransmissions
range: 1 - 12 (default value:12)
20 AT_WIP_NET_OPT_TCP_NOTIMEWAIT : Enables or Disables WIPLIB option
WIP_NET_OPT_TCP_NOTIMEWAIT.
 0: Set WIPLIB Option WIP_NET_OPT_TCP_NOTIMEWAIT to FALSE
 1: Set WIPLIB Option WIP_NET_OPT_TCP_NOTIMEWAIT to TRUE
range: 0-1 (default value:0)
21 WIP_NET_OPT_IP_FORWARD - Activate IP forwarding in NET.
Default value : FALSE
22 WIP_NET_OPT_DHCPS_ADDR - Listening address of the DHCP server.
Default value : 0.0.0.0
23 WIP_NET_OPT_DHCPS_NB_ADDR - Number of IP addresses of the range managed
by the server.
Default value : 1
24 WIP_NET_OPT_DHCPS_FIRST_ADDR - First IP address of the range managed by
the server.
Default value : 0.0.0.0
25 WIP_NET_OPT_DHCPS_SUBNET_MASK - Mask of the subnet managed by the
server.
Default value : 0.0.0.0
26 WIP_NET_OPT_DHCPS_LEASE - Lease time for IP address (in seconds).
Default value : 500
27 WIP_NET_OPT_DHCPS_MAX_LEASE- Maximum lease time for IP address (in
seconds).
Default value : 125000
28 WIP_NET_OPT_DHCPS - Activate DHCP server in NET. Valid configuration
parameters must be set up before activation.

4115730 Rev 5.0 March 26, 2015 27

 Extended AT Commands Manual Internet Library Commands

Default value : FALSE

Note: This option is not stored in FLASH
29 WIP_NET_OPT_PROXY – creates and initializes a DNS proxy with application defined
options. WIP_DNSPROXY_OPT_ADDR must have been defined before. The proxy is
activated by this function but it can forward messages only when a valid DNS
server address is configured
Default value : FALSE
Note: This option is not stored in FLASH
30 WIP_DNSPROXY_OPT_ADDR - Listening address of proxy.
Default : 0.0.0.0 (any address)
Note: This option is not stored in FLASH
31 WIP_DNSPROXY_OPT_DNS1 - Address of primary DNS server.
Default : 0.0.0.0 (none)
Note: This option is not stored in FLASH
32 WIP_DNSPROXY_OPT_DNS2 - Address of primary DNS server.
Default : 0.0.0.0 (none)
Note: This option is not stored in FLASH

<action>: requested operation on TCP/IP stack parameter management

0 configuration storage (when existing) is freed

1 stores the configuration parameters

<value>: value range for different configuration options

<XX.YY.ZZ >: Internet Application release version

<A.B>: Open AT Application Framework OS release version

<MM-DD-YYYY>: date of built of Internet Application

<HH:MM:SS>: time of built of Internet Application

<Internet Library: Internet Library version

version number>:

<Internet internally identifying Internet Application version

Application: version
number>:

Note: (WIP_NET_OPT_SOCK_MAX + 1) sockets are reserved when UDP sockets are created (and not for
TCP sockets); one socket buffer is added to support/afford DNS accesses
Note: For <opt num> numbers 6 through 11, the AT+WIPS command must be issued. For complete details
regarding AT+WIPS, please refer the Firmware AT Commands Interface Manual.

4115730 Rev 5.0 March 26, 2015 28

 Extended AT Commands Manual Internet Library Commands

3.1.1.4. Parameter Storage

Only one IP stack configuration set can be saved into the FLASH memory.
 “AT+WIPCFG=4,1” is used to store the TCP/IP stack configuration parameters into the
FLASH memory
 “AT+WIPCFG=4,0” is used to free the TCP/IP stack configuration storage
Executing “AT+WIPCFG=1” will apply default parameters when existing. Still it is possible to change
option values at run time using “AT+WIPCFG=2,<optnum>,<optvalue>”.

3.1.1.5. Possible Errors

The possible error message is displayed only if “AT+CMEE=1” is activated else “ERROR” is
displayed.

“+CMEE” AT error code Description

800 invalid option

801 invalid option value
802 not enough memory left
820 error writing configuration in FLASH memory
821 error freeing configuration in FLASH memory
844 stack already started
850 initialization failed
852 IP stack not initialized

4115730 Rev 5.0 March 26, 2015 29

 Extended AT Commands Manual Internet Library Commands

3.1.1.6. Examples

Command Responses

AT+WIPCFG=1
OK
Note: Start IP Stack

+WIPCFG: 0,64
+WIPCFG: 1,0
+WIPCFG: 2,60
+WIPCFG: 3,0
+WIPCFG: 4,536
+WIPCFG: 5,0
+WIPCFG: 6,8
+WIPCFG: 7,32
+WIPCFG: 8,0
+WIPCFG: 9,0
+WIPCFG: 10,4
AT+WIPCFG?
+WIPCFG: 11,4
+WIPCFG: 12,10
+WIPCFG: 13,0
+WIPCFG: 14,0
+WIPCFG: 15,2048
+WIPCFG: 16,64
+WIPCFG: 17,12

+WIPCFG: 18,80
+WIPCFG: 20,0

OK

4115730 Rev 5.0 March 26, 2015 30

 Extended AT Commands Manual Internet Library Commands

Command Responses

+WIPCFG: 0,64
+WIPCFG: 1,0
+WIPCFG: 2,60
+WIPCFG: 3,0
+WIPCFG: 4,536
+WIPCFG: 5,0
+WIPCFG: 6,20
+WIPCFG: 7,32
+WIPCFG: 8,0
+WIPCFG: 9,0
+WIPCFG: 10,4
+WIPCFG: 11,4
+WIPCFG: 12,0
+WIPCFG: 13,0
+WIPCFG: 14,0
+WIPCFG: 15,2048
AT+WIPCFG?
Note: response for an SL8 RD module
+WIPCFG: 16,64
+WIPCFG: 17,12
+WIPCFG: 18,80
+WIPCFG: 20,0
+WIPCFG: 22,0.0.0.0
+WIPCFG: 23,1
+WIPCFG: 24,0.0.0.0
+WIPCFG: 25,0.0.0.0
+WIPCFG: 26,500
+WIPCFG: 27,125000
+WIPCFG: 28,0
+WIPCFG: 29,0
+WIPCFG: 30,0.0.0.0
+WIPCFG: 31,0.0.0.0
+WIPCFG: 32,0.0.0.0

OK

AT+WIPCFG=2,0,10
OK
Note: Configure TTL of IP Stack

4115730 Rev 5.0 March 26, 2015 31

 Extended AT Commands Manual Internet Library Commands

Command Responses

+WIPCFG: 0,10
+WIPCFG: 1,0
+WIPCFG: 2,60
+WIPCFG: 3,0
+WIPCFG: 4,536
+WIPCFG: 5,0
+WIPCFG: 6,8
+WIPCFG: 7,32
+WIPCFG: 8,0
+WIPCFG: 9,0
+WIPCFG: 10,4
AT+WIPCFG?
+WIPCFG: 11,4
+WIPCFG: 12,10
+WIPCFG: 13,0
+WIPCFG: 14,0
+WIPCFG: 15,2048
+WIPCFG: 16,64
+WIPCFG: 17,12

+WIPCFG: 18,80
+WIPCFG: 20,0

OK

WIP Soft v553 on Open AT OS v640

AT+WIPCFG=3
Nov 29 2011 17:26:28
Note: Display software version
OK

AT+WIPCFG=0
OK
Note: Stop the TCP/IP Stack

AT+WIPCFG=4,1
Note: Store IP configuration parameters into OK
FLASH

AT+WIPCFG=4,0
Note: Free IP configuration parameters stored in OK
FLASH

4115730 Rev 5.0 March 26, 2015 32

 Extended AT Commands Manual Internet Library Commands

3.1.1.7. Notes
It is recommended to change the default settings of the Internet Library stack using +WIPCFG only
when it is required. Changing the parameter values especially the max number of sockets and the
max TCP buffer size with the high values lead to over consumption of the stack memory which causes
the Internet Application to crash. Hence, care must be taken when the default settings of the stack is
changed using +WIPCFG command.
Following option values set by +WIPCFG command are taken into consideration at the run time. The
below option values except for AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE and
AT_WIP_NET_OPT_ESC_SEQ_NOT_SENT will be taken into consideration at next start up only if
these are saved in the flash before stopping the stack.
 WIP_NET_OPT_IP_TTL
 WIP_NET_OPT_IP_TOS
 WIP_NET_OPT_IP_FRAG_TIMEO
 WIP_NET_OPT_TCP_MAXINITWIN
 WIP_NET_OPT_TCP_MIN_MSS
 WIP_NET_OPT_DEBUG_PORT
 AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE
 AT_WIP_NET_OPT_ESC_SEQ_NOT_SENT
 AT_WIP_NET_OPT_TCP_NOTIMEWAIT
 AT_WIP_NET_OPT_AUTO_SWITCH

4115730 Rev 5.0 March 26, 2015 33

 Extended AT Commands Manual Internet Library Commands

3.1.2. Bearers Handling +WIPBR

3.1.2.1. Description
The +WIPBR command can be used to
 select the bearer
 start/open/close/stop the bearer
 configure different bearer options such as access point name

3.1.2.2. Syntax
 if <cmdtype>=0,1 or 5

Action Command
AT+WIPBR=<cmdtype>,<bid>
OK

 if <cmdtype>=2

Action Command
AT+WIPBR=<cmdtype>,<bid>,<opt num>,<value>
OK

 if <cmdtype>=3

Action Command
AT+WIPBR=<cmdtype>,<bid>,<opt num>
+WIPBR: <bid>,<opt num>,<value>
OK

 if <cmdtype>=4

Action Command
AT+WIPBR=<cmdtype>,<bid>,<mode>[,<login>,<password>,[<caller
identity>]]
OK

4115730 Rev 5.0 March 26, 2015 34

 Extended AT Commands Manual Internet Library Commands

 if <cmdtype>=6

Action Command
AT+WIPBR=<cmdtype>,<bid>,<mode>
OK

Read Command
AT+WIPBR?
<bid>,<state>
[<bid>,<state>[..]]
OK

Test Command
AT+WIPBR=?
OK

 if <mode>=1

Unsolicited response
+WIPBR: <bid>,<status>,<local IP @>,<remote IP @>,<DNS1 @>, <DNS2 @>

3.1.2.3. Parameters and Defined Values

<cmd type>:
type of command

0 close bearer

1 open bearer

2 set value of different bearer options

3 get value of different bearer options

4 start bearer

5 stop bearer

6 bearer configuration management

<bid>:
bearer Identifier

1 UART1

2 UART2

4115730 Rev 5.0 March 26, 2015 35

 Extended AT Commands Manual Internet Library Commands

3 N/A

4 ETHER

5 GSM

6 GPRS

11..14 CMUX port over UART1

21..24 CMUX port over UART2

<opt num>:
bearer option identifier

0 WIP_BOPT_LOGIN – username (string)

max: 50 characters

1 WIP_BOPT_PASSWORD – password (string)

max: 50 characters

2 WIP_BOPT_DIAL_PHONENB – phone number (string)

max: 32 characters

5 WIP_BOPT_DIAL_RINGCOUNT - Number of rings to wait before sending the

WIP_BEV_DIAL_CALL event
range: 0-65535

6 WIP_BOPT_DIAL_MSNULLMODEM - Enable MS-Windows null-modem protocol

("CLIENT"/"SERVER" handshake)
range: 0-1

7 WIP_BOPT_PPP_PAP - Allow PAP authentication

range: 0-1

8 WIP_BOPT_PPP_CHAP - Allow CHAP authentication for the connection between

the PC and the embedded module (UART bearer)
range: 0-1

9 WIP_BOPT_PPP_MSCHAP1 - Allow MSCHAPv1 authentication

range: 0-1

10 WIP_BOPT_PPP_MSCHAP2 - Allow MSCHAPv2 authentication

range: 0-1

11 WIP_BOPT_GPRS_APN - Address of GGSN (string)

max: 96 characters

12 WIP_BOPT_GPRS_CID - Cid of the PDP context

range: 1-4

13 WIP_BOPT_GPRS_HEADERCOMP - Enable PDP header compression

range: 0-1

4115730 Rev 5.0 March 26, 2015 36

 Extended AT Commands Manual Internet Library Commands

14 WIP_BOPT_GPRS_DATACOMP - Enable PDP data compression

range: 0-1

15 WIP_BOPT_IP_ADDR - Local IP address (IP/string)

16 WIP_BOPT_IP_DST_ADDR - Destination IP address (IP/string)

Note: This option is available only for UART PPP and GSM PPP, and is not
applicable for GPRS bearer.

17 WIP_BOPT_IP_DNS1 - Address of primary DNS server (IP/string)

18 WIP_BOPT_IP_DNS2 - Address of secondary DNS server (IP/string)

19 WIP_BOPT_IP_SETDNS - Configure DNS resolver when connection is

established
range: 0-1

20 WIP_BOPT_IP_SETGW - Set interface as default gateway when connection is

established
range: 0-1

21 WIP_BOPT_GPRS_TIMEOUT - Define a time limit to connect GPRS bearer. For

example, value 300 for this option sets a wait time of 30s (300*100ms). Note: If
timer expires before GPRS bearer connects, error 847 is returned.
range: 300-1200 (default: 1200).

22 WIP_BOPT_DEBUG_PKT - Enable the debug traces of NET level 10

range: 0-1

23 WIP_BOPT_IP_DHCP - Enables auto-configuration of IP address and Netmask

with DHCP
range:0-1

24 WIP_BOPT_IP_MAC - Reads the MAC address, functioning as a read only option

25 WIP_BOPT_IP_NETMASK - Sets the Network mask

26 WIP_BOPT_IP_GW - Sets address of default gateway

27 WIP_BOPT_RESTART - Automatically restart server after connection is

terminated

28 WIP_BOPT_GPRS_ERROR_REPORTING – report <GPRS CME errors> instead

of Internet Application generic error
range:0-1 (default=0 for Internet Application generic error)
WIP_BOPT_EXTNAT -- Enable the NAT for the interface (bearer).By
29
default (FALSE) all the interfaces are private. Setting this option to TRUE
will mark the interface to public.
Default : FALSE
<mac IP @*>:
MAC address of Ethernet driver
<getway IP @*>:
default gateway address
<netmask IP @*>:
network mask address

4115730 Rev 5.0 March 26, 2015 37

 Extended AT Commands Manual Internet Library Commands

<value>:
range of value for different bearer options
<mode>:
mode of operation

0 client

1 server
<state>:
current state of the bearer

0 stopped

1 started
<status>: result of the connection process

0 successful

any other to be matched to error code value (e.g. “814” means PPP authentication failure )
value
<local IP @*>:
local IP address
<remote IP @*>:
remote IP address. (first node in internet)
<DNS1 IP @*>:
Domain Name Server address
<DNS2 IP @*>:
Domain Name Server address
<login>:
PPP login
<passwd>:
PPP password
<caller identity>:
optional ASCII string (type ascii*).
If not specified, then target will accept all DATA calls (independently of caller
identification). If specified, then target will only accept calls from <caller
identity>(which is the GSM data call number of the GSM client).

* IP @ are displayed in alpha numeric dot format. e.g. 192.168.0.1…When no IP address is known,
“0.0.0.0“ is displayed.

Caution: The options WIP_BOPT_IP_ADDR, WIP_BOPT_IP_DST_ADDR, WIP_BOPT_IP_DNS1 and

WIP_BOPT_IP_DNS2 can be read after the bearer connection is established successfully. If an
attempt is made to read the options value before the bearer connection is established successfully,
incorrect IP address will be received.
Caution: The options WIP_BOPT_IP_NETMASK and WIP_BOPT_IP_GW can be read after the bearer
connection is established successfully. If an attempt is made to read the options value before the
bearer connection is established successfully, incorrect IP address will be received.

Also the option WIP_BOPT_IP_MAC can be read after the bearer connection is open successfully. If
an attempt is made to read the options value before the bearer connection is open, incorrect IP
address will be received.

If the Ethernet bearer supported is defined, the MAC address is read from the Ethernet driver on
opening the bearer(i.e., +WIPBR=4,1).

4115730 Rev 5.0 March 26, 2015 38

 Extended AT Commands Manual Internet Library Commands

3.1.2.4. Parameter Storage

Several bearer configuration set can be saved.
Calling twice AT+WIPBR=6,<bid>,1 with the same <bid> will store the last configuration set.
 “AT+WIPBR=6,<bid>,1” is used to store the bearer configuration parameters set associated
with the bearer <bid> into the FLASH memory.
 “AT+WIPBR=6,<bid>,0” is used to free the bearer configuration parameters set associated
with the bearer <bid>.
Executing “AT+WIPBR=1,<bid>” will open bearer <bid> with default parameters of the bearer when
existing.

3.1.2.5. Possible Errors

3.1.2.5.1. General CME Errors

The possible error message is displayed only if “AT+CMEE=1” is activated else “ERROR” is
displayed.

“+CMEE” AT
Description
error code

800 invalid option

801 invalid option value
802 not enough memory left
803 operation not allowed in the current Internet Library stack state
804 device already open
807 bearer connection failure : line busy
808 bearer connection failure : no answer
815 bearer connection failure : PPP IPCP negotiation failed
816 bearer connection failure : PPP peer terminates session.
820 error writing configuration in FLASH memory
821 error freeing configuration in FLASH memory
bearer connection failure: WIP_BOPT_GPRS_TIMEOUT time limit expired before GPRS
847
bearer connected
848 impossible to connect to the bearer
connection to the bearer has succeeded but a problem has occurred during the data flow
849
establishment

3.1.2.5.2. GPRS CME Errors

GPRS CME errors are listed in the table below.

Error Resulting from the following

Meaning
code commands

103 Incorrect MS identity.(#3) +CGATT

132 service option not supported (#32) +CGACT +CGDATA ATD*99
133 requested service option not subscribed (#33) +CGACT +CGDATA ATD*99

4115730 Rev 5.0 March 26, 2015 39

 Extended AT Commands Manual Internet Library Commands

Error Resulting from the following

Meaning
code commands

service option temporarily out of order (#26, #34,

134 +CGACT +CGDATA ATD*99
#38)
148 unspecified GPRS error All GPRS commands
149 PDP authentication failure (#29) +CGACT +CGDATA ATD*99
150 invalid mobile class +CGCLASS +CGATT

3.1.2.6. Examples

Command Responses

1,0
6,1
AT+WIPBR? OK
Note: Bearer UART1 is open but not started bearer GPRS is open
and started

OK
AT+WIPBR?
Note: No bearer has been opened yet

AT+WIPBR=1,6
OK
Note: Open GPRS bearer

AT+WIPBR=2,6,11,”APN name”
OK
Note: Set APN of GPRS bearer

AT+WIPBR=3,6,11 +WIPBR: 6,11,”APN name”

Note: Get APN of GPRS bearer OK

AT+WIPBR=2,6,21,600
OK
Note: set GPRS connection timeout value to 60s

AT+WIPBR=4,6,0
OK
Note: Start GPRS bearer

AT+WIPBR=5,6
OK
Note: Stop GPRS bearer

AT+WIPBR=0,6
OK
Note: Close GPRS bearer

AT+WIPBR=1,5
OK
Note: Open GSM bearer

AT+WIPBR=2,5,0,”login”
OK
Note: Set the login for GSM bearer

4115730 Rev 5.0 March 26, 2015 40

 Extended AT Commands Manual Internet Library Commands

Command Responses

AT+WIPBR=2,5,1,”password”
OK
Note: Set the password for GSM bearer

AT+WIPBR=2,5,2,”phonenumber”
OK
Note: Set the phone number for GSM bearer

AT+WIPBR=2,5,15,”1.1.1.1”
OK
Note: Set the local IP address for GSM bearer

AT+WIPBR=2,5,16,”2.2.2.2”
OK
Note: Set the destination IP address for GSM bearer

AT+WIPBR=3,5,15 +WIPBR: 5,15,”0.0.0.0”

OK

Note: Local IP address is not set as GSM bearer is still not

Note: Read the local IP address for GSM bearer
connected

AT+WIPBR=3,5,16 +WIPBR: 5,16,”0.0.0.0”

OK

Note: Destination IP address is not set as GSM bearer is still not

Note: Read the destination IP address for GSM bearer
connected

AT+WIPBR=4,5,0
OK
Note: Start the GSM bearer as a client

AT+WIPBR=3,5,15 +WIPBR: 5,15,”1.1.1.1”

Note: Read the local IP for GSM bearer OK

AT+WIPBR=3,5,16 +WIPBR: 5,16,”2.2.2.2”

Note: Read the destination IP for GSM bearer OK

AT+WIPBR=5,5
OK
Note: Stop the GSM bearer

AT+WIPBR=0,5
OK
Note: Close the GSM bearer

AT+WIPBR=1,4
OK
Note: Opens the Ethernet bearer.

AT+WIPBR=4,4,0
OK
Note: Starts the Ethernet bearer in client mode.

AT+WIPBR=5,4
OK
Note: Stops the Ethernet bearer.

AT+WIPBR=0,4
OK
Note: Closes the Ethernet bearer.

4115730 Rev 5.0 March 26, 2015 41

 Extended AT Commands Manual Internet Library Commands

Command Responses

AT+WIPBR=2,4,23,”1”
OK
Note: Sets the DHCP to TRUE. Default: TRUE.

AT+WIPBR=3,4,24 +WIPBR: 4,24,”1.1.1.1”

Note: Reads the MAC address. OK

AT+WIPBR =2,4,25,” <getway IP

@*>” OK
Note: Sets the Default gateway address.

AT+WIPBR=2,4,26,” <netmask IP
@*>” OK
Note: Sets the Network mask address.

AT+WIPBR=3,4,23 +WIPBR: 4,23,1

Note: Reads the DHCP value. OK

AT+WIPBR=3,4,25 +WIPBR: 4,25,”10.66.67.193”

Note: Reads the Default gateway address. OK

AT+WIPBR=3,4,26 +WIPBR: 4,26,”255.255.255.192”

Note: Reads the Network mask address. OK

3.1.2.7. Notes

3.1.2.7.1. For Starting a Bearer

The mandatory parameters to start a bearer in
 server mode: <cmdtype>, <bid>, <mode>, <login> and <password>
 client mode: <cmdtype>, <bid> and <mode>
Depending on the mode and the bearer type, additional parameters are required or forbidden:

Bid Mode Other Parameters

1,3,11,14,21,24 0 None
1,3,11,14,21,24 1 <PPP login>, <PPP password>
5 0 None
5 1 <login>,<password>[,<caller identity>]
6 0 None

Starting bearer as a server requires additional parameters as mentioned in the above table.
 For PPP server, only parameters <login> and <password> are required. They will be
compared with remote PPP client login and password.
 For GSM server, <login> and <password> will be used for PPP over GSM establishment
(same behavior as described for PPP server).

4115730 Rev 5.0 March 26, 2015 42

 Extended AT Commands Manual Internet Library Commands

The <caller identity> is an optional ASCII string (type ASCII*). If not specified, then target will accept
all DATA calls (independently of caller identification). If specified, then target will only accept calls
from <caller identity> (which is the GSM data call number of the GSM client.
Opening bearer only consists in associating the IP protocol stack with the specified bearer. The
corresponding bearer setup has to be done through the adequate already existing AT commands
(please refer to +WMFM commands for UART1 and UART2, +CMUX command for CMUX virtual
ports and GSM/GPRS AT commands).
Several bearers can be opened at the same time but only one bearer can be started at a time.
If both DNS1 and DNS2 are displayed as “0.0.0.0” in the unsolicited message when bearer is opened
in server mode, it means that connecting to a remote IP host through an URL will fail.
The options WIP_BOPT_DIAL_REDIALCOUNT and WIP_BOPT_DIAL_REDIALDELAY will not be
implemented through AT commands. Nevertheless, for future compatibility reason, Opt num 3 and 4
are kept as reserved.
For GSM bearer, the options WIP_BOPT_IP_ADDR and WIP_BOPT_IP_DST_ADDR will display
valid addresses only when the bearer is started and connected, else it will display an address
“0.0.0.0”.
The Ethernet bearer can be started only in client mode.

3.2. IP Protocol Services

3.2.1. Service Creation +WIPCREATE

3.2.1.1. Description
The +WIPCREATE command is used to create UDP, TCP client, SSL TCP client and TCP server
sockets associated with the specified index and FTP/HTTP/SMTP/ POP3 service. Only one
FTP/HTTP/SMTP/POP3/MMS session at a time is available.
If a local port is specified while creating a socket, the created socket will be assigned to this port; if
not, a port will be assigned dynamically by Internet Library application. If peer IP and peer port is
specified, the created socket will be connected to the specified IP and port.
TCP server cannot be used to transfer data. To transfer data, it creates a local TCP client socket. This
process of creating local socket is referred as “spawning”. When a server socket is created using,
socket passively listens on a specified port for incoming connections. The below mentioned diagram
shows different states managed for TCP server.

4115730 Rev 5.0 March 26, 2015 43

 Extended AT Commands Manual Internet Library Commands

Closed

Server listening to the Server Socket

Close Server
remote socket for connect Creation
Socket channel
request

Listen

On reception of a connection request from a remote client socket, a server socket does the following,
 spawns a new socket (client) to connect to the remote socket
 data transfer is done between the spawned socket and the remote socket
 server socket remains in the listening mode and is ready to accept the request from other
clients
Below mentioned diagram shows connection establishment procedure.

Server Socket Client Socket

Connect request

Spawn a new
socket Client Socket Spawned
By Server

Connected

Transfer data

Socket Closed

3.2.1.2. Syntax
 if <mode>=1

Action Command
AT+WIPCREATE=<mode>,<communication index>,<local port> [,<peer
IP>,<peer port>]
OK

 if <mode>=2 or 9

4115730 Rev 5.0 March 26, 2015 44

 Extended AT Commands Manual Internet Library Commands

Action Command
AT+WIPCREATE=<mode>,<communication index>,<peer IP>,<peer port>
OK

 if <mode>=3

Action Command
AT+WIPCREATE=<mode>,<server index>,<local port>,<from idx>,<to
idx>
OK

 if <mode>=4

Action Command
AT+WIPCREATE=<mode>,<index>,<server>,[<peer_port>],<username>,
<password>[,<account>]
OK

 if <mode>=5

Action Command
AT+WIPCREATE=<mode>,<index>,[<server>[,<peer
port>]][,<username>,<password>][,<header list>[...]]]
OK

 if <mode>=6 or 7

Action Command
AT+WIPCREATE=<mode>,<index>,<server>[,<peer
port>][,<username>,<password>]
OK

 if <mode>=8

Action Command
AT+WIPCREATE=<mode>,<index>,<server>,<peer port>,<url>
OK

4115730 Rev 5.0 March 26, 2015 45

 Extended AT Commands Manual Internet Library Commands

Test Command
AT+WIPCREATE=?
OK

Read Command

AT+WIPCREATE?
+WIPREADY: <mode>, <communication index>[, <peer IP>[, <user name>[, <password>]]]
(mode = 1, 2, 4, 5, 6, 7, 8, or 9)
+WIPSERV: <mode>, <communication index>, <local port>, <from idx>, <to idx>
(mode = 1 and 3)

Note: Only sockets created with +WIPCREATE command are displayed.

Test Command
AT+WIPCREATE=?
OK

 if <mode>=1, 2, or 9

Unsolicited response
+WIPREADY: <mode>,<communication index>

 if <mode>=3

Unsolicited response
+WIPACCEPT: <server index>,<communication idx>

 if <mode>=5, 6, 7 or 8

Unsolicited response
+WIPREADY: <mode>,<index>

3.2.1.3. Parameters and Defined Values

<mode>:
specifies type of socket

1 UDP

2 TCP Client

4115730 Rev 5.0 March 26, 2015 46

 Extended AT Commands Manual Internet Library Commands

3 TCP server

4 FTP

5 HTTP Client

6 SMTP Client

7 POP3 Client

8 MMS Client

9 SSL TCP Client

<index>:
TCP/UDP/FTP/HTTP/SMTP/POP3/MMS session identifier
<local port>:
local TCP/UDP port
<peer IP>:
peer IP address; a string between quotes
indicating an address either in numeric form (e.g. “85.12.133.10”)
or as a DNS entry (e.g. “www.sierrawireless.com”)
<peer port>:
peer port or the server port
For TCP/UDP, this parameter is the port of the peer socket.
For FTP,HTTP,SMTP, POP3, and MMS, this parameter is the
server port
range: 1-65535 (default value for FTP: 21
default value for HTTP: 80
default value for SMTP: 25
default value for POP3: 110
default value for MMS: 8080)
<from idx>:
minimum index for spawned TCP sockets
range: 1-8
<server index>:
TCP server socket identifier
range: 1-4
<to idx>:
maximum index for spawned TCP sockets
range: 1-8
<communication index>:
indexes reserved for spawned sockets
It cannot be used by other sockets even if the spawned sockets
are not created yet.
range: 1-8
<server>:
server address or proxy address
This parameter is the server address for FTP, SMTP and POP3
protocol and for HTTP it is proxy server address.
It can either be a 32 bit number in dotted-decimal notation
(“xxx.xxx.xxx.xxx”) or an alpha numeric string format for hostname.

4115730 Rev 5.0 March 26, 2015 47

 Extended AT Commands Manual Internet Library Commands

<user name>:
username for the authentication in string format
Authentication is disabled when this parameter is not specified for
HTTP, SMTP and POP3.
<password>:
password for the authentication in string format
Authentication is disabled when this parameter is not specified for
HTTP, SMTP and POP3.
<account>:
account information of the user in string format
This is required by some FTP server during authentication phases.
<header list>:
HTTP header message (name-value pair)
The first string in the message header field is the name of the
header and the second string is the value of the header.
<url>:
URL of the MMS server
This is an alphanumeric string format for hostname starting with
“http://”.
<…>
additional HTTP message header fields
more pairs(name, value) of HTTP message header field can be
added

3.2.1.4. Parameter Storage

None

3.2.1.5. Possible Errors

“+CMEE” AT error code Description

3 operation not allowed

800 invalid option
803 operation not allowed in the current Internet Library stack state
830 bad index
832 bad port number
834 not implemented
836 memory allocation error
837 bad protocol
839 error during channel creation
UDP/TCP socket or FTP/HTTP/SMTP/POP3 session is already
840
active
destination host unreachable ( whether host unreachable, Network
842
unreachable, response timeout)
attempt is made to reserve/create a client socket which is already
845
reserved/opened by TCP server/client
851 incorrect number of parameters submitted
860 protocol undefined or internal error

4115730 Rev 5.0 March 26, 2015 48

 Extended AT Commands Manual Internet Library Commands

“+CMEE” AT error code Description

861 user name rejected by server

862 password rejected by server
865 authentication error
866 server not ready error

3.2.1.6. Examples

Command Responses

AT+WIPCREATE=1,1,80 OK

Note: Create the UDP socket on local port 80 with

communication index = 1  embedded module acts as Note: An unsolicited event +WIPREADY: 1,1 will be
an UDP server awaiting for incoming datagram on local received once the UDP socket is ready for usage
port 80

AT+WIPCREATE=1,1,”www.sierrawireless.com”,
80 OK

Note: Create the UDP socket on arbitrary free local port

with peer IP and peer port 80 with communication index = Note: An unsolicited event +WIPREADY: 1,1 will be
1  embedded module acts as a UDP client that can received once the UDP socket is ready for usage
send datagram towards the remote entity
AT+WIPCREATE=1,1,80,”www.sierrawireless.co
m”,80 OK

Note: Create the UDP socket on local port 80 with peer IP

and peer port 80 with communication index = 1 
Note: An unsolicited event +WIPREADY: 1,1 will be
embedded module acts as a UDP client and an UDP received once the UDP socket is ready for usage
server : it can send datagram towards the remote entity
and receiving datagram on the specified local port.

AT+WIPCREATE=3,1,80,5,8 OK

Note: Create the TCP server on port 80 with server

index=1  embedded module acts as a TCP server : it Note: An unsolicited event +WIPACCEPT: 1,5 will be
will from now on spawn TCP client socket from received once the TCP server is ready for usage
communication index 5 to 8

AT+WIPCREATE=2,1,”IP ADDR”,80 OK

Note: Create the TCP client on port 80 with index=1 

embedded module acts as a TCP client : it can from now Note: An unsolicited event +WIPREADY: 2,1 will be
on communicate with the remote specified entity through received once the TCP client is ready for usage
communication index 1
AT+WIPCREATE=4,1,”ftp.sierrawireless.com”,
”admin”,”123456”

Note: Create a FTP session  towards the remote OK

specified FTP server. Communication index to be used
then is 1

4115730 Rev 5.0 March 26, 2015 49

 Extended AT Commands Manual Internet Library Commands

Command Responses

AT+WIPCREATE=5,1,”proxyaddress”,,”user
OK
name”,”password”,”User-Agent”,”WIP-HTTP-
Client/1.0” +WIPREADY: 5, 1

Note: HTTP session with proxy and 1 message header field

Use default 80 proxy port number

1 message header field:

Message header field name is “User-Agent”

Message header field value is “WIP-HTTTP-Client/1.0”

AT+WIPCREATE=5,1,”proxyaddress”,,”user
name”,”password”,”User-Agent”,”WIP-HTTP- OK
Client/1.0”,"Accept-
Encoding","gzip","Accept-Language","en-US" +WIPREADY: 5, 1

Note: HTTP session with proxy and 3 message header

fields

Use default 80 proxy port number

3 message header fields:

Message header field name is “User-Agent” and header

field value is “WIP-HTTTP-Client/1.0”

Message header field name is “Accept-Encoding” and

header field value is “gzip”

Message header field name is “Accept-Language” and

header field value is “en-US”

AT+WIPCREATE=5,1,“proxyaddress“,,”user”,”p OK
ass”
+WIPREADY: 5, 1

Note: Authentication connection on default proxy server port

80

AT+WIPCREATE=6,1,"smtp.mail.yahoo.fr","587 OK
","user","pass"
+WIPREADY: 6, 1

Note: Connect to SMTP server port 587 with given

username and password

AT+WIPCREATE=7,1,"192.168.1.4","110","user OK
","pass"
+WIPREADY: 7, 1

Note: Connect to POP3 server port 110 with given

username and password

OK
AT+WIPCREATE=7,1, "pop.mail.server.com"
+WIPREADY: 7, 1

Note: Connect to the default port 110 of POP3 server, with

no authentication required

AT+WIPCREATE=8,1, OK
"192.168.10.200",8080,"http://mms.orange.f
r" +WIPREADY: 8, 1

4115730 Rev 5.0 March 26, 2015 50

 Extended AT Commands Manual Internet Library Commands

Command Responses

Note: Connect to the MMS server, with no authentication

required

AT+WIPCREATE=9,1,”IP ADDR”,4433 OK

Note: Create the SSL TCP client on port 4433 with index=1 
embedded module acts as a SSL TCP client : it can from now on Note: An unsolicited event +WIPREADY: 9,1 will be
communicate with the remote specified entity through received once the SSL TCP client is ready for usage
communication index 1

AT+WIPCREATE? OK

Note: No active socket/protocol.

AT+WIPCREATE=3,1,80,3,4 OK

Note: TCP server created.

+WIPACCEPT: 1,3
+WIPACCEPT: 1,4

Note: Two external TCP clients connected.

+WIPREADY: 2,3,"192.168.0.2"
+WIPREADY: 2,4,"192.168.10.20"
AT+WIPCREATE?
+WIPSERV: 3,1,80,3,4
OK

Note: Connected TCP clients (remote IP = 192.168.0.2 and

192.168.10.20 ).

TCP server listening on local port 80 for connection index

from 1 to3)

3.2.1.7. Notes
The maximum number of sockets can be set to 23 so that Internet Application can handle in the same
time either one FTP session (in passive mode)/HTTP/SMTP/POP3, 8 UDP sockets, 8 TCP client (with
1 SSL TCP client maximum included) sockets and 4 TCP servers.
SSL TCP client socket requires Security Library (refer to Security Library UGD). “+CME ERROR: 839”
error code is returned if Security Library is not initializes or not present.
Starting a TCP server requires to specify the maximum number of communication sockets that can be
spawned. This can be done using <from idx> and <to idx> parameters. Note that the value set for <to
idx> should be equal or more than <from idx>.
The maximum communication socket that can be created using Internet Application is 8. Hence, the
range for <communication index> and <from idx>, <to idx> is 1-8. Note that the spawned
communication socket and the TCP client socket share the same communication index.
It is not possible to create a client socket with AT+WIPCREATE=2, x, y, z when x is already reserved
by a server with AT+WIPCREATE=3,<server idx>, <local port>,a,b where a≤x≤b. Similarly, it is not
possible to reserve a range with AT+WIPCREATE=3, <server idx>, <local port>, a, b if one of the
TCP client socket indexes between a and b is already reserved, be it by a client or a server range

4115730 Rev 5.0 March 26, 2015 51

 Extended AT Commands Manual Internet Library Commands

The <from idx> and <to idx> are reserved for the server socket till the server socket and the spawned
sockets are closed explicitly. So when trying to create a new TCP server socket, the <from idx> and
<to idx> should be different from what was used earlier. A parameter used as <from_idx> can’t be
used as <to_idx> anymore for other TCP server socket creation until spawned sockets with specified
<from_idx> and <to_idx> are closed along with the TCP server socket explicitly and vice versa.
When no more communication index is available in the TCP server’s range (or no more resources to
accept new incoming connections), any peer trying to connect to the server will receive an accept ()
immediately followed by a shutdown () (“peer close”).
It is possible to have a TCP client and TCP server sockets running at the same time in the same
embedded module. In this scenario, when the connection is established between the TCP server and
TCP client sockets, it is necessary to unmap the mapped socket on one index in order to send/receive
data on socket which is created on another index. It is possible to use CMUX logical ports and can
have an interface connection (like UART connection) for each socket for e.g. TCP client socket on
one logical port and TCP server socket on another. In this case, it is not necessary to map or unmap
the UART connections to send or receive the data from the socket.
The +WIPCREATE command causes the connection and authentication to the FTP server. If several
file uploads and retrievals are required to/from the same server, a single connection with
+WIPCREATE is needed. Then, each file operation will be done (one +WIPFILE command per
operation), and the FTP connection will be released with +WIPCLOSE.
SIM card is required only if FTP session is established through GSM or GPRS. An FTP session upon
an UART will work without a SIM card.

3.2.2. Closing a Service +WIPCLOSE

3.2.2.1. Description
The +WIPCLOSE command is used to close a socket or FTP/HTTP/SMTP/POP3/MMS session.
When one serial port (UART or CMUX DLCI) is used to map a socket for read/write operations, [ETX]
character can also be used to close the socket.
An unsolicited event is generated, when socket or FTP/HTTP/SMTP/POP3/MMS session is closed.

3.2.2.2. Syntax

Action command
AT+WIPCLOSE=<protocol>,<idx>
OK

4115730 Rev 5.0 March 26, 2015 52

 Extended AT Commands Manual Internet Library Commands

Read Command
AT+WIPCLOSE?
NONE

Test Command
AT+WIPCLOSE=?
OK

Unsolicited response
+WIPPEERCLOSE: <protocol>,<idx>

3.2.2.3. Parameters and Defined Values

<protocol>: protocol type

1 UDP

2 TCP client

3 TCP server

4 FTP

5 HTTP

6 SMTP

7 POP3

8 MMS

9 SSL TCP Client

<idx>:
socket identifier or FTP/HTTP/SMTP/POP3 session identifier
This parameter is the index of the socket or FTP/HTTP/SMTP/POP3 session created
with +WIPCREATE command.

3.2.2.4. Parameter Storage

None

4115730 Rev 5.0 March 26, 2015 53

 Extended AT Commands Manual Internet Library Commands

3.2.2.5. Possible Errors

“+CMEE” AT error code Description

802 not enough memory

803 operation not allowed in the current Internet Library stack state
830 bad index
831 bad state
834 not implemented
837 bad protocol

3.2.2.6. Examples

Command Responses

AT+WIPCLOSE=1,1 OK

Note: Close UDP socket with communication index 1

AT+WIPCLOSE=2,1 OK

Note: Close TCP client with communication index 1

AT+WIPCLOSE=3,1 OK

Note: Close TCP server with communication index 1

AT+WIPCLOSE=4,1 OK

Note: An unsolicited event +WIPPEERCLOSE: 4,1 is received

Note: Close FTP session with index 1
once the FTP session is closed

AT+WIPCLOSE=5,1 OK

Note: Close HTTP session with index 1

AT+WIPCLOSE=6,1 OK

Note: Close SMTP session with index 1

AT+WIPCLOSE=7,1 OK

Note: Close POP3 session with index 1

AT+WIPCLOSE=8,1 OK

Note: Close MMS session with index 1

AT+WIPCLOSE=9,1 OK

4115730 Rev 5.0 March 26, 2015 54

 Extended AT Commands Manual Internet Library Commands

Command Responses

Note: Close SSL TCP client with communication index 1

3.2.2.7. Notes
After issuing +WIPCLOSE command, no more data can be sent and received over the
socket/session. In case of FTP protocol, the closure of FTP session is indicated by +WIPEERCLOSE
unsolicited response when +WIPCLOSE command is used for closing the session.
In case of TCP and UDP sockets, response “OK” is returned when the +WIPCLOSE command is
executed irrespective of whether the socket is active or not. But in case of FTP/HTTP/SMTP/POP3
session, “OK” response is returned if +WIPCLOSE command is executed when the session is active
else “+CME ERROR: 831” error code is returned.

3.2.3. Service Option Handling +WIPOPT

3.2.3.1. Description
The +WIPOPT command is used to read and/or to configure different parameters on sockets and
FTP/HTTP/SMTP/POP3/MMS service.

3.2.3.2. Syntax
 if <action>=1

Action Command
AT+WIPOPT=<protocol>,<idx>,<action>,<optnum>
OK

 if <action>=2 and <protocol> does not equal 8

Action Command
AT+WIPOPT=<protocol>,<idx>,<action>,<optnum>,<optval>
OK

 if <action>=2 and <protocol>=8

4115730 Rev 5.0 March 26, 2015 55

 Extended AT Commands Manual Internet Library Commands

Action Command
AT+WIPOPT=<protocol>,<idx>,<action>,<optnum>,<optval>
[,<optval2>,[<optval3>],[<optval4>]]
OK

Read Command
AT+WIPOPT?
NONE

Test Command
AT+WIPOPT=?
OK

 if <action>=1

Unsolicited response
+WIPOPT: <protocol>,<optnum>,<optval>

if <action>=1 and <protocol>=5 and <optnum>=54

Unsolicited response
+WIPOPT: 5,54,<message header field name>,<message header field value>,[…]

3.2.3.3. Parameters and Defined Values

<protocol>: protocol type

1 UDP

2 TCP client

3 TCP server

4 FTP

5 HTTP

6 SMTP

7 POP3

8 MMS

4115730 Rev 5.0 March 26, 2015 56

 Extended AT Commands Manual Internet Library Commands

<idx>:
socket or FTP/HTTP/SMTP/POP3/MMS session identifier
<action>:
requested operation

1 read the value of an option

2 write the value of an option

<optnum>:
option that can be read/written
<optval>:
value of an option
<optval2>:
value of an extra option (optional)
<optval3>:
value of an extra option (optional)
<optval4>:
value of an extra option (optional)

3.2.3.4. Parameter Storage

None

3.2.3.5. Possible Errors

“+CMEE” AT error code Description

800 invalid option

801 invalid option value
803 operation not allowed in the current Internet Library stack state
830 bad index
834 not implemented
835 option not supported
837 bad protocol
invalid channel option or parameter value (for example, HTTP user name too
850
long)
860 protocol undefined or internal error
863 protocol delete error
864 protocol list error

3.2.3.6. Examples

Command Responses

AT+WIPOPT=2,1,2,8,20
OK
Note: Set TTL for TCP client

AT+WIPOPT=2,1,1,8 +WIPOPT: 2,8,20

4115730 Rev 5.0 March 26, 2015 57

 Extended AT Commands Manual Internet Library Commands

Command Responses

Note: Get TTL for TCP client OK

AT+WIPOPT=3,1,2,9,10
OK
Note: Set TOS for TCP server

AT+WIPOPT=3,1,1,9 +WIPOPT: 3,9,10

Note: Get TOS for TCP server OK

AT+WIPOPT=1,1,1,1 +WIPOPT: 1,1,80

Note: Get peer port for UDP OK

AT+WIPOPT=4,1,2,40,1
OK
Note: Set data representation type for FTP

AT+WIPOPT=4,1,1,40 +WIPOPT: 4,1,1

Note: Get data representation type for FTP OK

AT+WIPOPT=5,1,2,52,0 OK

Note: Set HTTP version to 1.0

AT+WIPOPT=5,1,2,53,6
OK
Note: Set maxredirect to 6

+WIPOPT: 5,52,0
AT+WIPOPT=5,1,1,52
OK

Note: Get HTTP version

AT+WIPOPT=6,1,2,61,”[email protected]” OK

Note: Set the sender address

AT+WIPOPT=6,1,2,67,0 OK

Note: The application will format the mail header and send
it during the data sending phase

+WIPOPT: 6,61,”[email protected]”
AT+WIPOPT=6,1,1,61
OK

Note: Get the sender address

+WIPOPT:6,60,220,“220 innosoft.com SMTP

AT+WIPOPT=6,1,1,60 service ready”
OK

Note: Get last protocol error / status

+WIPOPT: 6,66,“My mail subject”

AT+WIPOPT=6,1,1,66
OK

4115730 Rev 5.0 March 26, 2015 58

 Extended AT Commands Manual Internet Library Commands

Command Responses

Note: Get the set mail subject

+WIPOPT: 7,72,243000
AT+WIPOPT=7,1,1,72
OK

Note: Get total mail size

+WIPOPT: 7,73,”1,1024”
+WIPOPT: 7,73,”2,5237”
+WIPOPT: 7,73,”3,128”
AT+WIPOPT=7,1,1,73
+WIPOPT: 7,73,”4,36400”
+WIPOPT: 7,73,”5,356”
OK

Note: Get mail listing

+WIPOPT: 7,74,10
AT+WIPOPT=7,1,2,74,10
OK

Note: Delete mail ID 10

+WIPOPT: 8,75, ”Mr Smith

AT+WIPOPT=8,1,2,82,”Mr Smith <[email protected]”
<[email protected]”
OK

Note: Add an email address to the To-field of an MMS.

3.2.3.7. Notes
It is possible to change and retrieve option value using +WIPOPT command only when the
socket/session (given by <idx>) is active else it returns error.

3.2.3.7.1. Options that can be applied to UDP, TCP Client, TCP Server
Sockets

opt Value TCP TCP

Option Type Description UDP
num format client server

0 0-65535 WIP_COPT_PORT Port of the socket R R R

1 0-65535 WIP_COPT_PEER_PORT Port of the peer socket R R -
Address of the peer
2 string WIP_COPT_PEER_STRADDR R R -
socket
Specifies whether the
socket is bounded2 to
3 0-1 WIP_COPT_BOUND a peer socket or not R - -
default: 1

4115730 Rev 5.0 March 26, 2015 59

 Extended AT Commands Manual Internet Library Commands

opt Value TCP TCP

Option Type Description UDP
num format client server

Minimum amount of
available space that
must be available in the
emission buffer before
4 1-5839 WIP_COPT_SND_LOWAT triggering a - RW RW
WIP_CEV_WRITE
event
default: 1024
Number of bytes that
can currently be read
6 0-65535 WIP_COPT_NREAD on that socket R R -
default: 0
When set to TRUE,
TCP packets are sent
immediately, even if the
buffer is not full
enough.
When set to FALSE,
the packets will be sent
7 0-1 WIP_COPT_NODELAY either, - RW RW
a) by combining
several small packets
into a bigger packet
b) when the data is
ready to send and the
stack is idle.
default: 0
Time-to-leave for
8 0-255 WIP_COPT_TTL packets RW RW RW
default: 64
Type of service
9 0-255 WIP_COPT_TOS RW RW RW
default: 0

2 The option WIP_COPT_BOUND is used to check whether an UDP socket is bound to any other UDP socket or not.
When the UDP socket is created without specifying the IP address of the peer, then the option WIP_COPT_BOUND will
be read as FALSE. This is because there is no destination IP address to communicate with. If the UDP socket is created
by specifying the peer IP address, the option WIP_COPT_BOUND will be read as TRUE. This is because the peer IP
address will be resolved by the DNS and the socket is said to be bounded to the peer socket. Hence this option will be
read as TRUE.

3.2.3.7.2. Options that can be applied to FTP Session

opt num Value format Value type Description

data representation type.

0: ASCII
40 0-1 boolean
1: binary
default: 0
FTP mode.
0: active
41 0-1 boolean
1: passive
default: 1

4115730 Rev 5.0 March 26, 2015 60

 Extended AT Commands Manual Internet Library Commands

3.2.3.7.3. Options that can be applied to HTTP Session

opt Value Value

Option type Description Type
num format type

set the size of the TCP socket

50 u32 WIP_COPT_RCV_BUFSIZE receive buffer RW
default: 0
set the size of the TCP socket send
51 u32 WIP_COPT_SND_BUFSIZE buffer. RW
default: 0
WIP_COPT_HTTP_VERSION
define the HTTP version to be used
52 0-1 u8 by the session RW
0: HTTP 1.0
default: 1
1: HTTP 1.1
set the maximum number of allowed
redirects
53 u32 WIP_COPT_HTTP_MAXREDIRECT a zero value disables automatic W
redirects
default: 8
return the HTTP message header
<ascii field (or a list of message header
54 WIP_COPT_HTTP_HEADER fields) from the last WIPFILE call R
list>
default: depends on the HTTP server

Caution: Option 54 (WIP_COPT_HTTP_HEADER) is not implemented and hence attempt to read this option
will result in +CME ERROR: 834.

3.2.3.7.4. Options that can be applied to SMTP Session

opt Value Value

Option type Description Type
num format type

get last protocol error code

60 digit/string u32/ascii WIP_COPT_SMTP_STATUS_CODE and associated error string R
default: NULL string
set the sender address
61 string ascii WIP_COPT_SMTP_SENDER RW
default: NULL string
set the sender name
62 string ascii WIP_COPT_SMTP_SENDERNAME RW
default: NULL string
set the recipients list
63 string ascii WIP_COPT_SMTP_REC RW
default: NULL string
set the CC recipients list
64 string ascii WIP_COPT_SMTP_CC_REC RW
default: NULL string
set the BCC recipients list
65 string ascii WIP_COPT_SMTP_BCC_REC RW
default: NULL string
set the mail subject
66 string ascii WIP_COPT_SMTP_SUBJ RW
default: NULL string

4115730 Rev 5.0 March 26, 2015 61

 Extended AT Commands Manual Internet Library Commands

opt Value Value

Option type Description Type
num format type

decide if the SMTP library

will format the mail header
or if the application is in
charge of formatting it
67 digit u32 WIP_COPT_SMTP_FORMAT_HEADER 0: Application formats mail RW
header
1: SMTP lib formats mail
header
default: 1

Caution: When option WIP_COPT_SMTP_FORMAT_HEADER is set to 0, application can format the mail
header to attach documents (see RFC 2822 for Standard for the Format of ARPA Internet Text
Messages for formatting details). Note that +WIPFILE command is used to send both mail header and
body.
Caution: When option WIP_COPT_SMTP_STATUS_CODE is used to retrieve the error code and the
associated error string for the SMTP session creation, it will not return any error code and error string if
no error occurred during that particular SMTP session creation. For example, After the SMTP session
is created successfully, an attempt to retrieve the error code and the associated error string, using the
option WIP_COPT_SMTP_STATUS_CODE, will result in an error code “0” and the error string
corresponding to the successful case. Create a SMTP session for the second time which will result in
the “+CME ERROR: 840” error code because the session is already active. Now an attempt to retrieve
the error code along with the associated error string, using the option
WIP_COPT_SMTP_STATUS_CODE, will result in error code “0” and the associated error string
because the first SMTP session was successful.

3.2.3.7.5. Options that can be applied to POP3 Session

opt Value Value

Option type Description Type
num format type

get last protocol error code and

70 digit/string u32/ascii WIP_COPT_POP3_STATUS_CODE R
associated error string
get total number of mails
71 u32 WIP_COPT_POP3_NB_MAILS default: depends on the mails R
available in the mail box
get total mail size
72 u32 WIP_COPT_POP3_MAILSIZE default: depends on the mails R
available in the mail box
get mail listing
The return value is a list of
strings containing mail ID and
73 digit/string ascii Not a POP3 Internet Library option R
mail size information.
default: depends on the mails
available in the mail box
delete the mail ID
The mail ID corresponds to the
mail ID returned by the mail
74 u32 Not a POP3 Internet Library option W
listing option.
default: depends on the mails
available in the mail box

Caution: When option WIP_COPT_POP3_STATUS_CODE is used to retrieve the error code and the
associated error string for the POP3 session creation, it will not return any error code and error string if
no error occurred during that particular POP3 session creation.

4115730 Rev 5.0 March 26, 2015 62

 Extended AT Commands Manual Internet Library Commands

For example, after the SMTP session is created successfully, an attempt to retrieve the error code and
the associated error string, using the option WIP_COPT_POP3_STATUS_CODE, will result in an error
code “0” and the error string corresponding to the successful case. Create a POP3 session for the
second time which will result in the “+CME ERROR: 840” error code because the session is already
active. Now an attempt to retrieve the error code along with the associated error string, using the
option WIP_COPT_POP3_STATUS_CODE, will result in error code “0” and the associated error string
because the first POP3 session was successful

3.2.3.7.6. Options that can be applied to MMS sessions

opt Value Value

Option type Description Type
num format type

Set the value of the date and time of

80 u32 u32 WIP_MMS_DATE the MMS in the following format : RW
Month/Day/Year Hour:Min:Sec
Adds a telephone number to the TO
81 string ascii WIP_MMS_TO_PHONE* RW
field in the MMS
Adds an email address to the TO
82 string ascii WIP_MMS_TO_EMAIL* RW
field in the MMS
Adds a telephone number to the CC
83 string ascii WIP_MMS_CC_PHONE* RW
field in the MMS
Adds an email address to the CC
84 string ascii WIP_MMS_CC_EMAIL* RW
field in the MMS
Adds a telephone number to the
85 string ascii WIP_MMS_BCC_PHONE* RW
BCC field in the MMS
Adds an email address to the BCC
86 string ascii WIP_MMS_BCC_EMAIL* RW
field in the MMS
Set the value of the Subject field in
87 string ascii WIP_MMS_SUBJECT RW
the MMS
See
88 u32 WIP_MMS_CLASS Set the class of the MMS RW
Table
See
89 u32 WIP_MMS_PRIORITY Set the priority of the MMS RW
Table
Set the sender visibility of the MMS
90 u32 u32 WIP_MMS_SENDER_VISIBILITY show=0 default RW
hide=1
91 string ascii WIP_MMS_FROM Set the sender of the MMS RW
Set the value of the MMS Multipart
Type via <optval> as u32.
Mixed=0 default.
Related=1.
92 u32 u32 WIP_MMS_MULTIPART_TYPE RW
In the case of “Related” the
presentation file type is sent in
<optval2> as a string and the start
file identification is sent in <optval3>
as a string.

4115730 Rev 5.0 March 26, 2015 63

 Extended AT Commands Manual Internet Library Commands

opt Value Value

Option type Description Type
num format type

About to attach a file of type

specified in <optval> as u32, please
see Table 5.3.7.6.1 for possible
values.
The size in Bytes as u32 is sent in
See <optval2>.
93 u32 WIP_MMS_ADD_FILE W
Table
The file name is sent as a string in
<optval3>
Content-id is sent in <optval4>.
At least one of either file name or
content-id must be set!
About to attach a file of type
specified in <optval> as a string
using the format of mime-type,
Example “image/xyz”.
The size in Bytes is sent in
94 string ascii WIP_MMS_ADD_FILE_ANY <optval2>. W
The file name is sent as a string in
<optval3>
Content-id is sent in <optval4>.
At least one of either file name or
content-id must be set.
Set the HTTP data transfer encoding
no encoding=0
95 u32 u32 WIP_MMS_HTTP_DATA_ENCOD RW
chunked data transfer encoding=1
default.
Sent as the last command to signal
that the MMS sending is considered
done.
This is to catch deadlocks, when for
instance a user misses to send a
96 - WIP_MMS_DONE last file.
NOTE : Once the MMS is sent, the
+WIPPEERCLOSE: 8,* is received to
indicate that MMS session is closed.
Therefore, there is no need to issue the
AT+WIPCLOSE command to close it).

* See the Phone/Mail Option Notes subsections for additional information about this option type.

Caution: For the WIP_MMS_ADD_FILE and WIP_MMS_ADD_FILE_ANY options, the total MMS size depends
on the application’s available memory (if the application is linked with 256kBytes or 1MBytes+ of RAM
memory).
• For 256kBytes (Internet Application) total MMS size must not exceed 150kBytes.
• For 1MBytes+ (Extended AT Application) total MMS size must not exceed 300kBytes.

3.2.3.7.6.1. Values of optval WIP_MMS_CLASS

These are the different types of message class.

optval Option Type

0 PERSONAL default
1 INFORMATIONAL

4115730 Rev 5.0 March 26, 2015 64

 Extended AT Commands Manual Internet Library Commands

optval Option Type

2 ADVERTISEMENT
3 AUTO

3.2.3.7.6.2. Values of optval WIP_MMS_PRIORITY

These are the different types of priority.

optval Option Type

0 LOW
1 NORMAL default
2 HIGH

3.2.3.7.6.3. Values of optval WIP_MMS_ADDFILE

These are the file types that correspond to the values predefined in the MMS header specification.
For other types of file the MIME type has to be explicitly set as a string.

optval Option Type Description

0 UTF8 A text file of type UTF8

1 UTF16 A text file of type UTF16
2 UCS2 A text file of type USC2
3 US_ASCII A text file of type (US) ASCII
4 JPEG An image file of type JPEG
5 GIF An image file of type GIF
6 TIFF An image file of type TIFF
7 PNG An image file of type PNG
8 WBMP An image file of type WBMP
9 SMIL A multimedia presentation of type SMIL

3.2.3.7.6.4. Phone/Mail Option Notes

3.2.3.7.6.5. Recipients

The total number of recipient (To+Cc+Bcc) must be less than or equal to 12, and for each recipient list
(To or Cc or Bcc), the string length must be less than 250 characters, including "/TYPE=PLMN" in
case of phone recipient type.

3.2.3.7.6.6. Command and Response

When getting WIP_MMS_TO_PHONE/WIP_MMS_TO_MAIL or

WIP_MMS_CC_PHONE/WIP_MMS_CC_MAIL or WIP_MMS_BCC_PHONE/WIP_MMS_BCC_MAIL
string is received in +WIPOPT, the response will include the complete TO or CC or BCC recipient list,
preceded by TYPE/PLMN for phone recipient type. For example:

4115730 Rev 5.0 March 26, 2015 65

 Extended AT Commands Manual Internet Library Commands

If you enter
AT+WIPOPT=8,1,2,81,”0683517984” (set WIP_MMS_TO_PHONE option)
then
AT+WIPOPT=8,1,2,82,[email protected] (set WIP_MMS_TO_MAIL option)
After entering AT+WIPOPT=8,1,1,81 (get WIP_MMS_TO_PHONE option) or AT+WIPOPT=8,1,1,82
(get WIP_MMS_TO_MAIL option), the response will be:
+WIPOPT: 8,82,”0683517984/TYPE=PLMN;[email protected]”

3.3. Data Exchange for Protocol Services

The section deals with the data exchange for the services over TCP/IP. All the commands required for
the data exchange through different services are mentioned in succeeding sections.

3.3.1. File Exchange +WIPFILE

3.3.1.1. Description
The +WIPFILE command defines the “file system” services that send a block of data through standard
TCP/IP protocols. This command is used for file transfer/reception.
The data can be transferred using two modes: continuous mode and continuous transparent mode.
The FTP/HTTP/SMTP/MMS protocols support continuous mode of operation. But, continuous
transparent mode is supported only by FTP protocol.
By default, all these protocols transfer data using continuous mode. However, data transfer using FTP
protocol can be configured using <dle_mode> parameter.
Note: There is no <dle_mode> parameter specified in the +WIPFILE command to configure mode of
operation for HTTP/SMTP protocol.

3.3.1.1.1. [ETX] Escaping Mechanism

In case an [ETX] character needs to be transmitted as data, it should be preceded by [DLE] character.
A single [ETX] character marks the end of transmission. Similarly, [ETX] characters received from the
internet are sent to the host through the serial port preceded by a [DLE] character.

4115730 Rev 5.0 March 26, 2015 66

 Extended AT Commands Manual Internet Library Commands

Desktop PC2
Internet
GSM/GPRS

Data received from PC1: “ab[ETX]c”

WCPU1

Data sent to PC1:

MAPPED UART “ab[ETX]c”

Desktop PC1

Data sent to PC2:

“ab[DLE][ETX]c[ETX]”

Data received from PC2:

“abc[DLE][ETX]c”

The above schematic explains how [ETX] characters which have a special meaning in Internet
Application are handled on Sierra Wireless embedded module.
On transmitting side, when [ETX] characters are escaped by a DLE (use case: Desktop PC1 sends
data to the embedded module. Data contains an [ETX] character escaped by a [DLE] character ([DLE]
[ETX] sequence), then the [ETX] character is transmitted as data.
On the receiving side, when [ETX] character is received as data (use case: The PC2 sends data to
the embedded module. Data contains an [ETX] character), then the [ETX] character will be preceded
by a [DLE] character when it is sent to host through the serial port.

3.3.1.1.2. [DLE] Escaping Mechanism

In case a [DLE] character needs to be transmitted as data, it should be preceded by another [DLE]
character. A single [DLE] character, not preceded by a [DLE] character will not be transmitted.
Similarly, [DLE] characters received are sent to the host through the serial port preceded by a [DLE]
character.

4115730 Rev 5.0 March 26, 2015 67

 Extended AT Commands Manual Internet Library Commands

Desktop PC2
Internet
GSM/GPRS

Data received from PC1:

“abc[DLE]d”

WCPU1

Data sent to PC1:

MAPPED UART “abc[DLE]d”

Desktop PC1

Data sent to PC2:

“ab[DLE]c[DLE][DLE]d”

Data received from PC2:

“abc[DLE][DLE]d”

The above schematic explains how [DLE] characters which have a special meaning in Internet
Application are handled on Sierra Wireless embedded module.
On the transmitting side, when [DLE] characters are escaped by another [DLE] character (use case:
Desktop PC1 sends data to the embedded module. Data contains a non escaped [DLE] character,
and another escaped [DLE] character ([DLE][DLE] sequence), then the [DLE] character is transmitted
as data. A single [DLE] character is ignored and not transmitted.

On the receiving side, when [DLE] character is received as data (use case: The PC2 sends data to
the embedded module. Data contains an [DLE] character), then the [DLE] character will be preceded
by another [DLE] character when it is sent to host through the serial port.

3.3.1.2. FTP/HTTP/SMTP Session in Continuous Mode

In continuous mode, an [ETX] character is considered as an end of data. In case an [ETX]/[DLE]
character needs to be transmitted as data, it should be preceded by [DLE] character. Similarly,
[ETX]/[DLE] characters received by the TCP/IP stack from the internet are sent to the host through the
serial port preceded by a [DLE] character.

The mapped UART can be switched back to AT mode either by:

1. sending ETX character
2. sending +++ sequence with 1 second guard time before and after the sequence
3. controlling the DTR signal using AT&D command
When the UART leaves data mode, the currently unsent data are transferred.

3.3.1.3. FTP Session in Continuous Transparent Mode

In this mode, [DLE]/[ETX] characters are considered as normal data and not as special characters. In
case [ETX]/[DLE] character is received, it will not be preceded by a [DLE] character before sending it
to the mapped UART.

4115730 Rev 5.0 March 26, 2015 68

 Extended AT Commands Manual Internet Library Commands

The mapped UART can be switched back to AT mode either by,

1. sending +++ sequence with 1 second guard time before and after the sequence
2. controlling the DTR signal using AT&D command
When the UART leaves data mode, the currently unsent data are transferred.

3.3.1.4. Syntax
 if <protocol>=4

Action Command
AT+WIPFILE=<protocol>,<index>,<mode>,<filename>[,<dle_mode>]
CONNECT
...
OK

 if <protocol>=5

Action Command
AT+WIPFILE=<protocol>,<index>,<mode>,<filename>[,<username>,
<password>][,<headers list>[…]]
CONNECT
...
OK

 if <protocol>=6

Action Command
AT+WIPFILE=<protocol>,<index>,<mode>
CONNECT
...
OK

 if <protocol>=7

Action Command
AT+WIPFILE=<protocol>,<index>,<mode>,<filename>
CONNECT
...
OK

 if <protocol>=8

4115730 Rev 5.0 March 26, 2015 69

 Extended AT Commands Manual Internet Library Commands

Action Command
AT+WIPFILE=<protocol>,<index>,<mode>,[<filename>],[<content-
id>][<lastindicator>]
CONNECT
...
OK

 if <protocol>=5

Unsolicited response
+WIPFILE: 5,<index>,<mode>,<http status code>,<http status reason>

Read command
AT+WIPFILE?
OK

Test Command
AT+WIPFILE=?
OK

3.3.1.5. Parameters and Defined Values

<protocol>: protocol type

4 FTP

5 HTTP

6 SMTP

7 POP3

8 MMS

4115730 Rev 5.0 March 26, 2015 70

 Extended AT Commands Manual Internet Library Commands

<idx>:
channel identifier
<mode>:
file transfer mode

1 This command switches the UART to data mode and prints the content of the file
on UART. The end of the file is marked by [ETX] character and UART switches
back to AT mode.
This mode is used for downloading file from the FTP server if <protocol>=4.
This mode is used for downloading data of the specified URL using HTTP GET
method if <protocol>=5.
This mode is used for retrieving mail without deleting it from the POP3 server if
<protocol>=7.
This mode is not supported by SMTP protocol.

2 This command switches the UART to data mode and accepts a stream of data
terminated by [ETX] character.
This mode is used for uploading file to the FTP server if <protocol>=4.
This mode is used for uploading data to the specified URL using HTTP PUT
method if <protocol>=5.
This mode is used for sending mail to the SMTP server if <protocol>=6.
This mode is not supported by POP3 protocol.

3 This mode is used for deleting the specified URL using HTTP DELETE method if
<protocol>=5.
This mode is used for retrieving mail and deletion after retrieval from the POP3
server if <protocol>=7.
This mode is not supported by FTP and SMTP protocol.

4 This command switches the UART in data mode and accepts a stream of data
terminated by [ETX] character.
This mode is used for uploading data to the HTTP server using HTTP POST
method if <protocol>=5.
This mode is not supported by FTP, SMTP and POP3 protocol.

5 This command switches the UART to data mode and accepts a stream of data
terminated by [ETX] character.
This mode is used for uploading file using FTP APPEND method server if
<protocol>=4.
This mode is not supported by other protocols

6 This mode is used to upload DATA in Data Offline mode(1) (by using
+WIPDATARW command).
This mode is used for uploading files to the FTP server if <protocol>=4.
This mode is used for sending mail to the SMTP server if <protocol>=6.
This mode is not supported by other protocols.

4115730 Rev 5.0 March 26, 2015 71

 Extended AT Commands Manual Internet Library Commands

7 This mode is used to download and display DATA in Data Offline mode(1) (by
using +WIPDATARW command).
This mode is used for downloading a file from the FTP server if <protocol>=4.
This mode is used for downloading data of the specified URL using HTTP GET
method if <protocol>=5.
This mode is used for retrieving mail without deleting it from the POP3 server if
<protocol>=7.
This mode is not supported by other protocols.

8 This mode is used for retrieving mail and deleting after retrieval from the POP3
server if <protocol>=7 in Data Offline mode(1) (by using +WIPDATARW
command).
This mode is not supported by other protocols.

9 This mode is used for uploading a file using FTP APPEND method server if
<protocol>=4 in Data Offline mode(1) (by using +WIPDATARW command).
This mode is not supported by other protocols
<filename>:
file name
if <protocol>=4: specify the name of the file to upload or download
The maximum file length is limited to 128 characters. The actual filename,
including path name has to be used.
if <protocol>=5: URL of the HTTP request
if <protocol>=7: mail id in string format
if <protocol>=8: the identifier matching the identifier specified in WIPOPT.

Note: For <protocol>=8, <filename> or <content-id> parameter must be

identical to the one specified with AT+WIPOPT for option
WIP_MMS_ADD_FILE or WIP_MMS_ADD_FILE_ANY
<dle_mode>:
Mode to configure continuous/continuous transparent mode
This option specifies whether the file should be uploaded/downloaded using
continuous or continuous transparent mode using FTP protocol. By default the
mode will be set to 0 i.e., continuous mode. If this value is set to 1, data will be
transferred using continuous transparent mode.
Range: 0–1(default value: 0)
<user name>:
user name in string format
<password>:
Password in string format
<header list>:
HTTP header message (name-value pair)
The first string in the message header field is the name of the header and the
second string is the value of the header.
<…>
additional HTTP message header fields
more pairs(name, value) of HTTP message header field can be added
<http status code>:
HTTP 3 digit status code of the response
<http status reason>:
HTTP status reason of the response in string format
<content-id>
MMS Content-id header

4115730 Rev 5.0 March 26, 2015 72

 Extended AT Commands Manual Internet Library Commands

<lastindicator>
Indicates that the file is the last of the files to send.

1
: See the DATA Offline session +WIPDATARW section for more information.

3.3.1.6. Parameter Storage

None

3.3.1.7. Possible Errors

“+CMEE” AT error code Description

800 invalid option

801 invalid option value
803 operation not allowed in the current Internet Library stack state
830 bad index
831 bad state
834 not implemented
836 memory allocation error
837 bad protocol
839 error during channel creation
846 internal error: FCM subscription failure
860 protocol undefined or internal error
867 POP3 email retrieving error
868 POP3 email size error
880 SMTP sender email address rejected by server
881 SMTP recipient email address rejected by server
882 SMTP CC recipient email address rejected by server
883 SMTP BCC recipient email address rejected by server
884 SMTP email body send request rejected by server
890 Service denied
891 Message format corrupt
892 Address unresolved
893 Message not found
894 Network problem
895 Content not accepted
896 Unsupported message
897 Unspecified error

4115730 Rev 5.0 March 26, 2015 73

 Extended AT Commands Manual Internet Library Commands

3.3.1.8. Examples

Command Responses

CONNECT
AT+WIPFILE=4,1,1,”data.bin” <data received terminated by [ETX]
character>

Note: Download file in continuous mode OK

CONNECT
AT+WIPFILE=4,1,2,”report.log”
<data terminated by [ETX] character>

Note: Upload file in continuous mode OK

CONNECT
AT+WIPFILE=4,1,5,”report.log”
<data terminated by [ETX] character>

Note: Upload file in continuous mode; data will be added at the end of
OK
file

CONNECT
AT+WIPFILE=4,1,1,”data.bin”,1 <data>
+++

OK

Note; +++ sequence causes the UART to switch to AT

Note: Download file in continuous transparent mode
mode

CONNECT
AT+WIPFILE=4,1,2,”report.log”,1 <data>
+++

OK

Note; +++ sequence causes the UART to switch to AT

Note: Upload file in continuous transparent mode
mode

CONNECT
AT+WIPFILE=4,1,1,”data.bin”,0 <data received terminated by [ETX]
character>

Note: Download file in continuous mode OK

CONNECT
AT+WIPFILE=4,1,2,”report.log”,0
<data terminated by [ETX] character>

Note: Upload file in continuous mode OK

4115730 Rev 5.0 March 26, 2015 74

 Extended AT Commands Manual Internet Library Commands

Command Responses

CONNECT
<data terminated by [ETX] character>
AT+WIPFILE=5,1,2,”urlForPut” OK
+WIPFILE:5,1,2,<http status
code>,<http status reason>

Note: Send a HTTP PUT request to URL

CONNECT
<data received terminated by [ETX]
character>
AT+WIPFILE=5,1,3,”urlForDelete”
OK
+WIPFILE:5,1,3,<http status
code>,<http status reason>

Note: Send a HTTP DELETE request to URL

CONNECT
<data received terminated by [ETX]
character>
AT+WIPFILE=5,1,4,”urlForPost”
OK
+WIPFILE:5,1,4,<http status
code>,<http status reason>

Note: Send a HTTP POST request to URL

CONNECT
<data sent terminated by [ETX]
AT+WIPFILE=6,1,2
character>
OK

Note: Send data mail content

CONNECT
<data received terminated by [ETX]
AT+WIPFILE=7,1,1,”15”
character >
OK

Note: Retrieve mail ID 15

Note: Retrieve data from the given ID
Mail is not deleted after retrieval

CONNECT
<data received terminated by [ETX]
AT+WIPFILE=7,1,3,”1”
character >
OK

Note: Retrieve data from the given ID Note: Retrieve mail ID 1 and delete it after retrieval

4115730 Rev 5.0 March 26, 2015 75

 Extended AT Commands Manual Internet Library Commands

3.3.1.9. Notes
The [ETX] character is considered as an end of data. Hence, in case [ETX] character needs to be
transmitted, it should be preceded by [DLE] character.
For MMS, when sending file data through AT+WIPFILE command, if data size is greater than the one
specified via WIP_MMS_ADD_FILE or WIP_MMS_ADD_FILE_ANY options, the data will be
truncated to said option’s size, and module will leave the data mode. When going back to AT mode,
+WIPFILE: proto,index,size will be received with the size equal to the size of the data that will be
included in the MMS file.

3.3.2. Socket Data Exchange +WIPDATA

3.3.2.1. Description
The +WIPDATA command is used to read/write from/to a socket. On successful execution of the
command, the UART switches to data mode. The UART can be switched back to AT mode by
sending “+++” with 1 second guard time before and after the sequence. If data is not read using
+WIPDATA command, further data will be delayed.
An unsolicited event is received when there is a data to read on socket.
Data can be sent on the sockets using two modes
 continuous mode
 continuous transparent mode
Note: When using the UDP protocol, consider that you cannot send more than the
WIP_COPT_RCV_BUFSIZE data receiving buffer size. Based on this, be sure that no data will be
lost, as it depends on the bearer "speed".

3.3.2.2. Continuous Mode

3.3.2.2.1. TCP Sockets in Continuous mode

In continuous mode, an [ETX] character is considered as an end of data. When an [ETX] character is
sent on the mapped UART, the TCP socket is shut down and the peer side is informed of this
shutdown with the indication “[CR][LF]SHUTDOWN[CR][LF]” on the mapped UART.
In case an [ETX]/[DLE] character needs to be transmitted as data, it should be preceded by [DLE]
character. Similarly, [ETX]/[DLE] characters received by the TCP/IP stack from the internet are sent to
the host through the serial port preceded by a [DLE] character.
To close sockets, switch the UART to AT command mode and use +WIPCLOSE command.

3.3.2.2.2. UDP Sockets in Continuous Mode

UDP is a connectionless protocol and hence there is no way to detect or cause a shutdown. However,
an [ETX] character is used to mark the boundaries of datagrams.

4115730 Rev 5.0 March 26, 2015 76

 Extended AT Commands Manual Internet Library Commands

All data written on an UDP socket is collected till an [ETX] character is encountered or the maximum
size of the datagram1 is reached and will be sent as a single datagram. Similarly when reading data,
all data will be read till an [ETX] character is encountered which indicates the end of the datagram.
Note that, in this mode, packet segmentation feature is not supported.
In case an [ETX]/[DLE] character needs to be transmitted, it should be preceded by [DLE] character
similar to TCP socket.
When the UART leaves DATA mode, either because of “+++” escape sequence or because of an
AT+WIPDATA=1, index, 0 on another UART, the currently unsent data are sent as a single datagram.

3.3.2.2.3. [ETX] Escaping Mechanism

The above schematic explains how [ETX] characters – which have a special meaning in Internet
Application – are handled on Sierra Wireless embedded module.
On transmitting side, when [ETX] are not escaped (use case: Desktop PC1 sends data towards
embedded module. Data contain a non escaped [ETX] ( no [DLE][ETX] sequence), then [ETX] is
not transmitted but an action is done on embedded module regarding the concerned socket:
 UDP socket: a non escaped [ETX] marks the boundary of the current datagram to be sent.
Datagram is immediately sent and the [ETX] is not sent towards the desktop PC2.
 TCP socket: a non escaped [ETX] causes a TCP shutdown operation on the transmitting
direction: peer is informed that embedded module will not send any more data on that socket.

1
Maximum size of an UDP datagram has been fixed to 8192 bytes. This limit is an arbitrary one. Nevertheless, note that
smaller the datagram is the surer it will reach the aimed destination. Note that UDP is not a reliable transport layer.

4115730 Rev 5.0 March 26, 2015 77

 Extended AT Commands Manual Internet Library Commands

Usually, peer will shutdown the other way (downlink) and this will result in a “peer close event”
on the socket.
On receiving side, when [ETX] are not escaped (use case: embedded module sends data towards
Desktop PC1. Data contain a non escaped [ETX] ( no [DLE][ETX] sequence), then [ETX] means
that a special “IP” event occurred on embedded module regarding the concerned socket:
 UDP socket: a non escaped [ETX] signals the boundary of the current received datagram.
 TCP socket: a non escaped [ETX] signal that the peer TCP connected TCP unit shutdown the
downlink way. Desktop PC1 should then close the uplink socket to totally terminate the TCP
“session”.

Protocol Mapped UART IP Network (active socket)

UDP Data containing [DLE][ETX] sequence. Data containing [ETX].

Mark the boundary of the UDP Datagram

UDP [ETX] alone.
received/to be transmitted.

TCP Data containing [DLE][ETX] sequence. Data containing [ETX].

Causes/signals a shutdown operation on TCP
TCP [ETX] alone.
socket.

Note: The behavior is symmetrical: apply both on transmitting/receiving side of mapped UART.

3.3.2.2.4. [DLE] Escaping Mechanism

A [DLE] character will be sent as data only when it is preceded by another [DLE] character. A single
[DLE] character which is not preceded by a [DLE] character will not be transmitted.

4115730 Rev 5.0 March 26, 2015 78

 Extended AT Commands Manual Internet Library Commands

The above schematic explains how [DLE] characters – which have a special meaning in Internet
Application – are handled on Sierra Wireless embedded module.
On transmitting side, when [DLE] is not escaped (use case: Desktop PC1 sends data towards
embedded module. Data contains a non escaped [DLE] ( no [DLE][DLE] sequence), then [DLE] is
not transmitted.
On transmitting side, when [DLE] is escaped (use case: Desktop PC1 sends data towards embedded
module. Data contain an escaped [DLE] ( [DLE][DLE] sequence) then [DLE] data is transmitted.
On the receiving side (use case: when Desktop PC2 sends data towards embedded module. Data
contains a no escaped [DLE]) the data sent from the embedded module to Desktop PC1 will contain
an escaped [DLE] preceding the [DLE] character (Desktop PC1 receives [DLE][DLE] character from
embedded module).
The scenario is same for both TCP and UDP sockets.

Protocol Mapped UART IP Network (active socket)

UDP Data containing [DLE][DLE] sequence. Data containing [DLE].

UDP [DLE] alone. A single [DLE] is ignored.

TCP Data containing [DLE][DLE] sequence. Data containing [DLE].

TCP [DLE] alone. A single [DLE] is ignored.

4115730 Rev 5.0 March 26, 2015 79

 Extended AT Commands Manual Internet Library Commands

3.3.2.3. Continuous Transparent Mode

3.3.2.3.1. TCP Sockets in Continuous Transparent Mode

In this mode there is no special meaning associated for [DLE]/[ETX] characters. They are considered
as normal data and all the data will be transmitted on the mapped UART.

3.3.2.3.2. UDP Sockets in Continuous Transparent Mode

In this mode there is no special meaning associated for [DLE]/[ETX] characters. They are considered
as normal data and all the data will be transmitted on the mapped UART. In case [ETX]/[DLE]
character is received, it will not be preceded by a [DLE] character before sending it to the mapped
UART.

3.3.2.4. Leaving Continuous/Continuous Transparent Mode

The UART can be switched back to AT mode
 by sending “+++” with 1 second guard time before and after the sequence
 by sending an AT+WIPDATA=<proto.,<index>,0 on another UART in AT mode
When the UART leaves data mode either because of “+++” escape sequence or because of an
unmapping done on another UART, the currently unsent data are sent as a single datagram.
Caution: In case of UDP, if “+++” Escape Sequence is sent after sending [ETX], then the “+++” will be buffered
and sent as data with the next chunks of data bytes.

To avoid sending of this “+++” as data, it is recommended to set the value of option
AT_WIP_NET_OPT_ESC_SEQ_NOT_SENT to 1 using command AT+WIPCFG=2,13,x.

3.3.2.5. Resetting TCP Sockets

A TCP socket is reset when the connection is aborted due to an error on the socket. When the socket
is reset, an [ETX] character is sent on the mapped UART to indicate the end of communication. The
mapped UART switches to AT mode and “+CME ERROR: 843” is displayed on the UART.

3.3.2.6. Syntax

Action Command
AT+WIPDATA=<protocol>,<idx>,<mode>[,<send size>,<wait time>]
CONNECT

Note: Once the +WIPDATA indication has been received, on peer closed, +WPPEERCLOSE indication
won't be received unless AT+WIPDATA has been sent.

Read Command
AT+WIPDATA?
NONE

4115730 Rev 5.0 March 26, 2015 80

 Extended AT Commands Manual Internet Library Commands

Test Command
AT+WIPDATA=?
OK

 if <protocol>=1

Unsolicited response
+WIPDATA: <protocol>,<idx>,<datagram size>,<peer IP>,<peer port>

Caution: Using +WIP AT commands, when receiving several UDP datagrams on an IP bearer, +WIPDATA
indication is sent once for the first received datagram. Next indication (for next remaining UDP
datagram to read) is sent once the first datagram have been read (using +WIPDATA command).

 if <protocol>=2 or 9

Unsolicited response
+WIPDATA: <protocol>,<idx>,<number of readable bytes>

Caution: The value returned by <number of readable bytes> indicates that there is some TCP data ready to be
read but number of bytes returned might not be reliable. Moreover, using +WIPAT commands, when
receiving several TCP packets on an IP bearer, +WIPDATA indication is sent once for the first
received packet. The next indication (for the next remaining TCP packet to read) is sent after the first
packet have been read (using +WIPDATA command).

3.3.2.7. Parameters and Defined Values

<protocol>: socket type

1 UDP

2 TCP client

9 SSL TCP Client

<idx>:
socket identifier

<mode>: mode of operation

0 unmap: switch the UART (mapped to continuous mode) to AT mode.

1 continuous: switch the UART to data mode.

2 continuous transparent: switch the UART to data mode. In this mode,[DLE]/[ETX]

characters are considered as normal data and not special characters.

3 Data Offline: Activate Data Data Offline mode(1) on the specified socket.
In this mode, [DLE]/[ETX] characters are considered as normal data and not special
characters.

4115730 Rev 5.0 March 26, 2015 81

 Extended AT Commands Manual Internet Library Commands

<send size>: data packet size: This parameter specifies the size of the data packet that needs to
be sent to the peer. This parameter is supported only for UDP continuous transparent
mode.
range: 8-1460 (default value: 1020)

<wait time>: timeout for configuring the packet segmentation on IP network side: This parameter
specifies the timeout after which the buffered data will be sent to the peer irrespective
of size of the data packet. This parameter is supported only for UDP continuous
transparent mode.
range: 1-100 (default value: 2)

1
: See the DATA Offline session +WIPDATARW section for more information.

3.3.2.8. Parameter Storage

None

3.3.2.9. Possible Errors

“+CMEE” AT error code Description

831 bad state

836 memory allocation error
837 bad protocol
843 connection reset by peer

3.3.2.10. Examples

Command Responses

CONNECT
<read/write data>
AT+WIPDATA=2,5,1
+++
OK

Note; TCP Client with index 5 can send/read data in

Note; +++ sequence causes the UART to switch to AT mode
continuous mode

CONNECT
<read/write data>
AT+WIPDATA=2,5,1,10,5
+++
OK

Note; TCP Client with index 5 can send/read data in

Note; +++ sequence causes the UART to switch to AT mode
continuous mode

4115730 Rev 5.0 March 26, 2015 82

 Extended AT Commands Manual Internet Library Commands

Command Responses

CONNECT
<read/write data>
AT+WIPDATA=1,5,1
+++
OK

Note; UDP with index 5 can send/read data in continuous

Note; +++ sequence causes the UART to switch to AT mode
mode

CONNECT
<read/write data>
AT+WIPDATA=1,5,1
<ETX>
OK

Note; UDP with index 5 can send/read data in continuous

Note; [ETX] character indicates end of data
mode

CONNECT
<read/write data>
AT+WIPDATA=1,5,2
+++
OK

Note; UDP with index 5 can send/read data in continuous

transparent mode with default value set for <send size> and Note; +++ sequence causes the UART to switch to AT mode
<wait time>

CONNECT
<read/write data>
AT+WIPDATA=1,5,2,20,2
+++
OK

Note; UDP with index 5 can send/read data in continuous

transparent mode with <send size> set to 20 and <wait time> Note; +++ sequence causes the UART to switch to AT mode
set to 2

CONNECT
<read/write data>
AT+WIPDATA=2,5,1,20,10
+++
OK

Note: TCP with index 5 can send/read data in continuous

Note; +++ sequence causes the UART to switch to AT mode
mode with <send size> set to 20 and <wait time> set to 10

CONNECT
<read/write data>
AT+WIPDATA=2,5,2,10,5
+++
OK

Note: TCP with index 5 can send/read data in continuous

transparent mode with <send size> set to 10 and <wait time> Note; +++ sequence causes the UART to switch to AT mode
set to 5

4115730 Rev 5.0 March 26, 2015 83

 Extended AT Commands Manual Internet Library Commands

Command Responses

CONNECT
<read/write data>
AT+WIPDATA=2,5,2
+++
OK

Note: TCP with index 5 can send/read data in continuous

Note; +++ sequence causes the UART to switch to AT mode
transparent mode

3.3.2.11. Notes

3.3.2.11.1. Continuous Mode (Non Transparent) for a TCP Mapped Socket

If the [ETX] character is sent from the peer, it is considered as an end of data transfer. After sending
an [ETX] character, the socket will be shutdown and the peer will be informed of this shutdown by a
“[CR][LF]SHUTDOWN[CR][LF]” indication on its mapped UART and the UART does not switch to AT
mode. This indicates that no more data can be sent from the host socket, but it can receive data. The
below schematic shows the shutdown procedure for a TCP socket:

In the above schematic, a TCP socket is connected. On the transmitting side, data and [ETX] is sent
(use case: Desktop PC1 is an embedded module which sends data to PC2 which is either a PC or a
embedded module), the data is received on PC2 and [ETX] character shutdowns the socket on the
transmitting side and displays a message “[CR][LF]SHUTDOWN[CR][LF]” on the mapped UART of
PC2.
When PC2 is switched back to AT mode, “+WIPPEERCLOSE: <protocol>,<idx>” indication is
received indicating that no more data can be sent by PC1 but can read data sent from PC2.

4115730 Rev 5.0 March 26, 2015 84

 Extended AT Commands Manual Internet Library Commands

There are different indications received for shutdown and reset for a TCP socket. When a TCP socket
is reset, [ETX] character is sent on the mapped UART to indicate the end of communication. The
mapped UART switches to AT mode and “+CME ERROR: 843” is displayed on the UART. The reset
and shutdown can therefore be distinguished by the indications received on the UART.

3.3.2.11.2. Mapping/Unmapping of a Mapped UDP and TCP Socket

When a TCP socket is unmapped and still active, it is possible to map it again in another mode which
is different from the previous one without closing the TCP socket.
The UART switches back to AT mode due to “+++”with 1 second guard time before and after the
sequence or by sending an AT+WIPDATA=<proto>,<index>,0 on another UART in AT mode. This
applies to both UDP and TCP protocols.
When +++ is issued, embedded module switches from DATA mode to AT mode. If ATO command is
used to switch the embedded module back to DATA mode,
 +CME ERROR:3 will be received when GPRS bearer is used
 no response is received when GSM bearer is used
To switch the embedded module back to DATA mode, AT+WIPDATA=x,x,x should be used instead of
ATO. After executing AT+WIPDATA=x,x,x command, “CONNECT” will be received to indicate that the
embedded module is switched back to DATA mode.
Note that un-mapping socket using +WIPDATA command with <send size> and <wait time> specified
results in “ERROR”.

3.3.2.11.3. Time out Mechanism to know the state of the Peer TCP Socket
In a TCP server-client connection between two remote devices if the peer socket is closed down
abruptly (e.g. powered off) the peer TCP socket does not get any indication message. This is a
normal behavior. The TCP protocol uses a timeout mechanism to check the state of the TCP sockets
in a TCP socket connection. According to this mechanism, to know the state of the peer TCP socket
the data needs to be sent and wait for the acknowledgement within a specified time period. If the
acknowledgement is not received within the specified time out period then the data is retransmitted.
But if the time out occurs before receiving acknowledgement then it implies that the peer TCP socket
is closed.

TCP Timeout Period = function (R, N)

Where,
R = Round trip time. This is the time for a TCP packet to go to the
remote TCP socket and the time to receive the acknowledgement
by the transmitter TCP socket. The typical round trip time is 1
seconds for GPRS.
N = Number of retransmission allowed before the time out happens.
Hence, the typical timeout period is 10 minutes depending on the network and also the peer TCP
socket localization.
In Internet Application, to know the state of the peer socket, data needs to be sent. If
acknowledgement is not received within the timeout period then “+CME ERROR: 842” is returned.
This indicates that the peer socket is closed.
Please note that the retransmission of the data to the peer TCP socket within the timeout period is
managed by the Internet Library.

4115730 Rev 5.0 March 26, 2015 85

 Extended AT Commands Manual Internet Library Commands

3.3.2.11.4. Packet Segmentation in TCP Socket

The parameters used for packet segmentation can be configured using +WIPDATA or +WIPCFG
command. In case if it is not configured using +WIPDATA command, then the values already set for
option WIP_NET_OPT_TCP_MIN_MSS and AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE will be
used.
Note that if an attempt is made to set data packet size more than twice the value of
WIP_NET_OPT_TCP_MIN_MSS using +WIPDATA command results in “+CME ERROR: 847”.
The data sent to a mapped TCP socket through UART will be buffered before sending it to the peer.
This buffered data will be sent to the peer when:
 total amount of buffered data is twice or more than the preferred segmentation size. The
preferred segmentation size is configurable through the “AT+WIPCFG = 2, 4, <size>”
(WIP_NET_OPT_TCP_MIN_MSS) or +WIPDATA command.
 internal timer expires. The timeout period is configurable through the “AT+WIPCFG =
2,12,<time>” (AT_WIP_NET_OPT_PREF_TIMEOUT_VALUE) or +WIPDATA command.
 socket is unmapped, shut down or closed
In some scenarios, there might be a segmentation of data packets because of timer expiration,
network problems etc. Thus a single packet of data may be received in more than one packet at the
peer

3.3.2.11.5. Packet Segmentation in UDP Socket

This feature for UDP is supported only in case of continuous transparent mode. If the +WIPDATA
command is executed in continuous mode to use this feature, “ERROR” will be returned. The
parameters used for packet segmentation can be configured using +WIPDATA command. In case if it
is not configured using +WIPDATA command, default value of these parameters will be used.
The data sent to a mapped UDP socket through UART will be buffered before sending it to the peer.
This buffered data will be sent to the peer when:
 the buffered data size is equal to segmentation size. Note that if the buffered data is greater
than segmentation size, then the data will be written to the channel in chunks of segmentation
size.
 the timer expires
 socket is unmapped or closed
In some scenarios, there might be a segmentation of data packets because of timer expiration,
network problems etc. Thus a single packet of data may be received in more than one packet at the
peer.

3.3.3. DATA Offline Session +WIPDATARW

This command is used to upload or download data on UART without switching to DATA mode
(CONNECT/OK Online mode) for +WIPDATA and +WIPFILE commands.
DATA offline session starts when AT+WIPDATA command is used with mode (3) or when
AT+WIPFILE command is used with mode (6, 7, 8 or 9). Otherwise +WIPDATARW command can't be
use and returns +CME ERROR 831 error message.
In this mode,[DLE]/[ETX] characters are considered as normal data and not special characters. Data
read or written are in hexadecimal dump format.

4115730 Rev 5.0 March 26, 2015 86

 Extended AT Commands Manual Internet Library Commands

3.3.3.1. Restrictions
 DATA offline feature is not recommended to send or received quickly high data volume. In
this case, the nominal online mode shall be used.
 DATA offline does not support multisession, meaning if two sockets are created, both sockets
cannot be used simultaneously in DATA offline mode.
 To improve AT command exchange and behavior, the use of USB com port is recommended.
Otherwise, UART com port buffer threshold shall be decrease with +WHCNF command (see
General AT Command User Guide).
 Be careful for TCP socket (+WIPDATA), a maximum of 5840 bytes can be send. Over this
size data are lost but no error is returned.
 +WIDATARW command should not be used to fill TX sender buffer with more than 5840
bytes (4*1460) for TCP socket.

3.3.3.2. Syntax

Action abort : <command>= 0

AT+WIPDATARW=<command>,<idx>
+WIPDATARW: <state>,<idx>
OK

Action write : <command>= 1, 2 or 3

AT+WIPDATARW=<command>,<idx>,"<DATA DUMP>"
OK

Unsolicited message <state> = 0 or 1

+WIPDATARW: <state>,<idx>

Unsolicited message <state> = 3

+WIPDATARW: <state>,<idx>,<size>

Unsolicited message <state> = 2

+WIPDATARW: <state>,<idx>,<nb_block>,<num_block>,"<DATA DUMP>"
+WIPDATARW: <state>,<idx>,<nb_block>,<num_block>,"<DATA DUMP>"

4115730 Rev 5.0 March 26, 2015 87

 Extended AT Commands Manual Internet Library Commands

Read Command
AT+WIPDATARW?
OK

Test Command
AT+WIPDATARW=?
OK

3.3.3.3. Parameters and Defined Values

<command>:

0 Close WIPDATARW session.

1 WRITE and Send: Add DATA in TX buffer then send all data stored in the buffer.

2 WRITE EXT : Add DATA in TX buffer (but buffer is not sent)

3 WRITE, Send and close: Add DATA in TX buffer, send all data stored in the buffer, then
close the current DATA offline session.
This command is only supported for +WIPDATA session.

<idx> channel identifier

<state>:

0 WIPDATARW session Closed for the channel <idx> specified

1 WIPDATARW session Opened for the channel <idx> specified.

Ready to send or received data

2 Data reading

3 Data sent

<DATA DUMP> DATA in hexadecimal format.

To send more than 200 bytes data, use +WIPDATARW with <command> = 2 to add data to buffer
and use for the last block
Data must be written in TX buffer with <command> = 2 by 200 byte block and the last block must be
written with <command> =1 to write it and send the TX buffer.”
Only 200 data bytes can be read or written at a time. DATA received are displayed by 200 byte block
if received data buffer to display is bigger than 200 bytes.

3.3.3.4. Parameter Storage

None

4115730 Rev 5.0 March 26, 2015 88

 Extended AT Commands Manual Internet Library Commands

3.3.3.5. Possible Errors

“+CMEE” AT error code Description

800 Invalid option

801 Invalid option value
830 Bad index
831 Bad state
836 Memory allocation error
853 Data offline buffer full

3.3.3.6. Examples

Command Responses

AT+WIPDATA=1,1,3
+WIPDATARW:1,1
(UDP socket have been previously
OK
created)

Note : exchange data on socket index 1 with AT

Command Note WIPDATARW session ready on channel idx 1.

AT+WIPDATARW=1,1,"30313233343536373839 +WIPDATARW:3,1,10
" OK

Note : send 10 data byte on channel idx 1 Note : 10 data bytes had been sent

+WIPDATA: 1,1,10,"192.168.1.2",1357
+WIPDATARW:2,1,1,1,"3132333435363738"
OK

Note : Data dump received on channel idx 1

AT+WIPDATARW=2,1,"30[…]39"
OK
Note : Write 200 Data bytes in TX Buffer Note : 200 data bytes are stored in TX Buffer

AT+WIPDATARW=2,1,"30[…]39"
OK
Note : Write 200 Data bytes in TX Buffer Note : 200 data bytes are stored in TX Buffer

+WIPDATARW:3,1,402
AT+WIPDATARW=1,1,"3039"
OK
Note : Write 2 Data bytes in TX Buffer and send
buffer. Note : 402 data bytes have been sent

+WIPDATARW:0,1
AT+WIPDATARW=0,1
OK

Note : Close WIPDATARW session on channel idx 1

AT+WIPDATARW=1,1,"30313233343536373839
+CME ERROR: 831
"

Note : try to send 10 bytes on channel index 1 Note : WIPDATARW session is not open in channel idx 1

4115730 Rev 5.0 March 26, 2015 89

 Extended AT Commands Manual Internet Library Commands

Command Responses

AT+WIPFILE=4,2,6,”./filename.txt” +WIPDATARW:1,2
OK

Note : Start data offline session for uploading file

“filename.txt”

AT+WIPDATARW=1,2,"30313233343536373839 +WIPDATARW:4,2,10
" +WIPDATARW:0,2
OK

Note : Upload data Note : 10 bytes uploaded

WIPDATARW session closed on channel idx 2

+WIPDATARW:3,2,2,1,"31[…]"
AT+WIPFILE=4,2,7,”./filename.txt” +WIPDATARW:3,2,2,2,"31[…]"
+WIPDATARW:0,2
OK
Note : More than 200 data downloaded

Note : Download and display “filename.txt” file WIPDATARW session closed on channel idx 2

3.4. Ping Services

3.4.1. PING Command +WIPPING

3.4.1.1. Description
The +WIPPING command is used to configure different PING parameters and to send PING requests.
An unsolicited response is displayed each time a “PING” echo event is received or a timeout expires.

4115730 Rev 5.0 March 26, 2015 90

 Extended AT Commands Manual Internet Library Commands

3.4.1.2. Syntax

Action Command
AT+WIPPING=<host>,[<repeat>,<interval>,[<timeout>,[<nwrite>,[<tt
l>]]]]
OK

Read Command
AT+WIPPING?
OK

Test Command
AT+WIPPING=?
OK

Unsolicited response
+WIPPING:<timeout_expired>,<packet_idx>,<response_time>

3.4.1.3. Parameters and Defined Values

Parameter Defined Value

host name or IP address

<host>:
string
number of packets to send
<repeat>:
range: 1-65535 (default value:1)
number of milliseconds between packets
<interval>:
range: 1-65535 (default value:2000)
number of milliseconds before a packet is considered lost
<timeout>:
range: 1-65535 (default value:2000)
IP packet Time To Live.
<ttl>: Default value is set by WIP_NET_OPT_IP_TTL +WIPCFG option
range : 0-255
size of packets
<nwrite>:
range : 1-1500 (default value:64)
PING result
<timeout_expired>: 0: PING response received before <timeout>
1: <timeout> expired before the response was received
<packet_idx>: packet index in the sequence
<response_time>: PING response time in millisecond

4115730 Rev 5.0 March 26, 2015 91

 Extended AT Commands Manual Internet Library Commands

3.4.1.4. Parameter Storage

None

3.4.1.5. Possible Errors

“+CMEE” AT error code Description

800 invalid option

801 invalid option value
819 error on ping channel

3.4.1.6. Examples

Command Responses

OK
AT+WIPPING=”www.sierrawireless.com”
+WIPPING: 1,0,0

Note: Ping “www.sierrawireless.com failed : timeout

Note: Ping “www.sierrawireless.com”
expired

OK
AT+WIPPING=”192.168.0.1”
+WIPPING: 0,0,224

Note: Ping “192.168.0.1 succeeded. Ping response

Note: Ping ”192.168.0.1”
received in 224 ms

OK
AT+WIPPING=”192.168.0.1”,2,2000,1000 +WIPPING: 0,0,880
+WIPPING: 1,1,xxxx

Note: Ping “192.168.0.1 succeeded. First Ping

Note: Send 2 successive ping requests to ”192.168.0.1”. Each Ping is
response received in 880 ms. Second one was not
every 2000 ms, timeout is set to 1000 ms (if ping responses time is more
received before specified timeout (1000 ms)  timeout
than 1000 ms then timeout expires)
expired

4115730 Rev 5.0 March 26, 2015 92

 Extended AT Commands Manual Internet Library Commands

3.5. Internet Library Application Examples

3.5.1. TCP Socket

3.5.1.1. TCP Server Socket

3.5.1.1.1. Using GPRS bearer

AT+WIPCFG=1 //start IP stack

OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name (<login>)

OK

AT+WIPBR=2,6,1,”passwd” //set password (<password>)

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=3,1,80,5,8 //create the server on port 80, idx = 1. The server //is listening
for connection request on port //80.Spawned sockets will be
OK
given the index 5, //6, 7 and 8. It will accept connection request
//until it has no more socket left.

+WIPACCEPT: 1,5 //unsolicited: the server accepted a connection //resulting TCP

client on idx 5.

AT+WIPDATA=2,5,1 //exchange data on socket index 5

CONNECT

… //read, write

+++ //switch to AT mode

OK

AT+WIPCLOSE=2,5 //close the TCP client socket index 5

OK

3.5.1.1.2. Using GSM bearer

AT+WIPCFG=1 //start IP stack

OK

4115730 Rev 5.0 March 26, 2015 93

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=1,5 //open GSM bearer

OK

AT+WIPBR=2,5,2,”Phone number” //set phone number for GSM bearer

OK

AT+WIPBR=2,5,0,”user name” //set user name

OK

AT+WIPBR=2,5,1,”passwd” //set password

OK

AT+WIPBR=4,5,0 //start GSM bearer

OK

AT+WIPCREATE=3,1,80,5,8 //create the server on port 80, idx = 1. The server //is listening
OK for connection request on port //80.Spawned sockets will be
given the index 5, //6, 7 and 8. It will accept connection request
//until it has no more socket left.

+WIPACCEPT: 1,5 //unsolicited: the server accepted a connection //resulting TCP

client on idx 5

AT+WIPDATA=2,5,1 //exchange data on socket idx 5

CONNECT

… //read, write

+++ //switch to AT mode

OK

AT+WIPCLOSE=2,5 //close the TCP client socket index 5

OK

3.5.1.2. TCP Client Socket

3.5.1.2.1. Using GPRS Bearer

AT+WIPCFG=1 //start IP stack

OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

4115730 Rev 5.0 March 26, 2015 94

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=4,6,0 //start GPRS bearer

OK
AT+WIPCREATE=2,1,”ip addr”,80 //create a TCP client towards peer IP device @ “ip //addr”, port
80.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 2,1 //unsolicited: the TCP client socket is connected //to the peer

AT+WIPDATA=2,1,1 //exchange data on socket idx 1:

CONNECT

… //read, write

+++ //switch to AT mode

OK

AT+WIPCLOSE=2,1 //close the TCP client socket index 1

OK

3.5.1.2.2. Using GSM Bearer

AT+WIPCFG=1 //start IP stack

OK

AT+WIPBR=1,5 //open GSM bearer

OK

AT+WIPBR=2,5,2,”Phone number” //set phone number for GSM bearer

OK

AT+WIPBR=2,5,0,”user name” //set user name

OK

AT+WIPBR=2,5,1,”passwd” //set password

OK

AT+WIPBR=4,5,0 //start GSM bearer

OK

AT+WIPCREATE=2,1,”ip addr”,80 //create a TCP client towards peer IP device @ “ip //addr”, port
80

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,1 //unsolicited: the TCP client socket is connected to //the peer

AT+WIPDATA=2,1,1 //exchange data on socket idx 1

CONNECT

4115730 Rev 5.0 March 26, 2015 95

 Extended AT Commands Manual Internet Library Commands

… //read, write

+++ //switch to AT mode

OK

AT+WIPCLOSE=2,1 //close the TCP client socket index 1

OK

3.5.2. UDP Socket

AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=1,1,80,”www.sierr //create a UDP client towards peer IP device @

awireless.com”,80 //“www.sierrawireless.com” , port 80

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,1 //unsolicited: the UDP client socket is “pseudo” //connected to the
peer (no //real connection is UDP)

AT+WIPDATA=1,1,1 //exchange data on socket idx 1:

CONNECT

… //read, write

+++ //switch to AT mode

OK

AT+WIPCLOSE=1,1 //close the UDP socket index 1

OK

AT+WIPCREATE=1,1,1234 //start a UDP server and listen for datagram on port //1234

4115730 Rev 5.0 March 26, 2015 96

 Extended AT Commands Manual Internet Library Commands

OK //all parameters and IP stack //behavior are OK

+WIPREADY: 1,1 //unsolicited: the UDP client socket is “pseudo” //connected to the
peer (no real connection is UDP)

+WIPDATA: 1,1,25,"192.168.0.2",2397 //one datagram is ready to be read : it was sent from

//192.168.0.2 on port //2397 and is composed of 25 //bytes

AT+WIPDATA=1,1,1

CONNECT

abcedghijklmnopqrstuvwxyz[ETX] //here 25 bytes + the [ETX] character (marking the //bound of the
datagram) have been read.

+++ or AT+WIPDATA=1,1,0 //type on this UART “+++” escape sequence or un //map the
UART on other control port (USB UART)

OK //here UART is back to AT command mode. If some //other

remote IP devices sent some one or more //datagrams while
reading for the first one, then a //new datagram indication is
received

+WIPDATA: 1,1,50,"192.168.0.4",58 //one datagram is ready to be read : it was sent from

//192.168.0.4 on port 58 and is composed of 50 //bytes

AT+WIPDATA=1,1,1

CONNECT

abcedghijklmnopqrstuvwxyzabcedghijklmnopq //here 25 bytes + the [ETX] character (marking the //bound of the
rstuvwxyz [ETX] datagram) have been read.

3.5.3. PING
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

4115730 Rev 5.0 March 26, 2015 97

 Extended AT Commands Manual Internet Library Commands

AT+WIPPING=”192.168.0.1” //start PING session

OK
+WIPPING:0,0,224

3.5.4. FTP
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=4,1,”FTP //create FTP session

server”,21,”username”,”passwd”
OK

AT+WIPFILE=4,1,2,”./filename.txt” CONNECT //upload file “filename.txt”

<data>
[ETX]
OK

AT+WIPFILE=4,1,1,”./filename.txt” CONNECT //download file “filename.txt”

<data>
[ETX]
OK

3.5.5. FTP DATA Offline

AT+WIPCFG=1 //start IP stack
OK

4115730 Rev 5.0 March 26, 2015 98

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=4,1,”FTP //create FTP session

server”,21,”username”,”passwd”
OK

AT+WIPFILE=4,1,6,”./filename.txt” //upload file “filename.txt”

+WIPDATARW: 1,1
OK

AT+WIPDATARW=1,1,"30313233343536373839" //upload data file

+WIPDATARW: 3,1,10 // 10 data bytes sent
+WIPDATARW: 0,1 // WIPDATARW session closes on channel idx 1
OK

AT+WIPFILE=4,1,7,”./filename.txt” +WIPDATARW: //download and dump “filename.txt” file

2,1,2,1,"3132333435[…]"
+WIPDATARW: 2,1,2,2,"3132333435[…]"
+WIPDATARW: 0,1
OK

3.5.6. HTTP
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

4115730 Rev 5.0 March 26, 2015 99

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=5,1,”www.siteaddress //connect to remote HTTP proxy server port 81 //with

.com”,81,”username”,”password”,”h authentication and some header fields
eader name”,” header value”
OK
+WIPREADY: 5,1
//connection and authentication are successful

AT+WIPOPT=5,1,1,51 //get size of the TCP send buffer size

+WIPOPT:5,51,<sender buffer size>
OK
//get option successful

AT+WIPOPT=5,1,2,53,6 //set maximum number of redirects

OK

AT+WIPFILE=5,1,1,”urlForGet”,”username”,”pas //HTTP GET method

sword”,”Accept”,”text/html”,”Transfer-
codings”,”compress”
CONNECT
<user starts getting the mail with the UART
in data mode and ends with an [ETX] >
OK
+WIPFILE: 5,1,1,255,”Found”

//unsolicited string on the HTTP status code //and reason

3.5.7. SMTP
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

4115730 Rev 5.0 March 26, 2015 100

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=6,1,”192.168.1.2”,25 //connect to remote SMTP server

,”user”,”password”
OK
+WIPREADY: 6,1
//connection and authentication are successful

AT+WIPOPT=6,1,2,61,”[email protected]” //set sender mail address

OK

AT+WIPOPT=6,1,2,62,”sender name” //set sender name

OK

AT+WIPOPT=6,1,2,63,” [email protected], //set receiver mail address

[email protected]”
OK

AT+WIPOPT=6,1,2,64,”[email protected], //set CC receiver mail address

[email protected]”
OK

AT+WIPOPT=6,1,2,65,”[email protected], //set BCC mail address

[email protected]”
OK

AT+WIPOPT=6,1,2,66,”mail subject” //set mail subject

OK

AT+WIPFILE=6,1,2 //send mail

CONNECT
<user starts sending mail with the UART in
data mode and ends with an [ETX] character
>
OK

3.5.8. POP3
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

4115730 Rev 5.0 March 26, 2015 101

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=7,1,”192.168.1.2”,11 //connect to remote POP3 server

0,”user”,”password”
OK
+WIPREADY: 7,1
//connection and authentication are successful

AT+WIPOPT=7,1,1,71 //get total number of mails

+WIPOPT: 7,71,10
OK

AT+WIPOPT=7,1,1,72 //get total mail size

+WIPOPT: 7,72,124000
OK

AT+WIPFILE=7,1,1,”5” //retrieve mail id 5

CONNECT
<user starts getting the mail with the UART
in data mode and ends with an [ETX] >
OK

AT+WIPFILE=7,1,3,”1” //retrieve mail id 1 and delete it from the server //after

retrieving
CONNECT
<user starts getting the mail with the UART
in data mode and ends with an [ETX] >
OK

3.5.9. MMS
Example of sending an MMS with multiple recipients and multiple files with the same extensions.
Please note that files are not buffered, but sent directly to the MMS Server.
Detailed information about the files is needed for the headers before and must be set for each file
using WIPOPT before sending the file via WIPFILE.
AT+WIPCFG=1 //start IP stack
OK
AT+WIPBR=1,6 //open GPRS bearer
OK
AT+WIPBR=2,6,11,"orange.fr" //set APN name of GPRS bearer
OK

4115730 Rev 5.0 March 26, 2015 102

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=2,6,0,"user name" //set user name

OK
AT+WIPBR=2,6,1,"passwd" //set password
OK
AT+WIPBR=4,6,0 //start GPRS bearer
OK

AT+WIPCREATE=8,1, //create the connection to the MMS server.

"192.168.10.200",8080,
"http://mms.orange.fr"
OK
AT+WIPOPT=8, 1, 2, 82, "Mr,Smith //add email address to the TO field.
<[email protected]>"
OK

AT+WIPOPT=8,1,2,83,"+33623456789" //add telephone number to the CC field.

OK

AT+WIPOPT=8,1,2,83,"0654321987" //add telephone number to the CC field.

OK

AT+WIPOPT=8,1,2,86, "X <[email protected]>" // add email address to the BCC field.

OK

AT+WIPOPT=8,1,2,92,1, // set the multipart type to Related and specify that the first
"application/smil","<001>" file that should be read is a type SMIL with the content-id
“<001>”
OK

AT+WIPOPT=8,1,2,93,9,100, "1.smil", "<001>" // add a SMIL multimedia presentation file of size 100 Bytes
with filename “1.smil” and content-id “<001>”
OK

AT+WIPOPT=8,1,2,93,2,222,"2.txt", // add a text file of type USC2 of size 222 bytes with the
filename “2.txt” but no content-id.
OK

AT+WIPOPT=8,1,2,93,3,304,,<003>" // add a text file of type ASCII of size 304 Bytes with no
filename but content-id “<003>”.
OK

AT+WIPOPT=8,1,2,93,4,1024,"4.jpeg","<004>" // add a JPEG picture of size 1024 Bytes with the filename
“4.jpeg” and content-id “<004>”.
OK

AT+WIPOPT=8,1,2,93,5,2048,"5.gif", "<005>" // add a GIF picture of size 2048 Bytes with the filename
“5.gif” and content-id “<005>”.
OK

AT+WIPOPT=8,1,2,94,"audio/xyz", // add a file of a content type specified in the string of size

128 Bytes with the filename “6.xyz” and content-id
128,"6.xyz","<XYZ>" “<XYZ>”.
OK

4115730 Rev 5.0 March 26, 2015 103

 Extended AT Commands Manual Internet Library Commands

// NOW SEND THE CONTENT OF THE FILES IN THE

SAME ORDER!

AT+WIPFILE=8,1,2,"1.smil","<001>" // send the SMIL file previously specified by WIPOPT.

CONNECT
<user starts sending the file with the UART
in data mode and ends with an [ETX] character
>
OK

AT+WIPFILE=8,1,2,"2.txt", // send the TXT file previously specified by WIPOPT.

CONNECT
<user starts sending the file with the UART
in data mode and ends with an [ETX] character
>
OK

AT+WIPFILE=8,1,2,,"<003>" // send the TXT file previously specified by WIPOPT.

CONNECT
<user starts sending the file with the UART
in data mode and ends with an [ETX] character
>
OK

AT+WIPFILE=8,1,2,"4.jpeg","<004>" // send the JPEG previously specified by WIPOPT.

CONNECT
<user starts sending the file with the UART
in data mode and ends with an [ETX] character
>
OK

AT+WIPFILE=8,1,2,"5.gif", "<005>" // send the GIF previously specified by WIPOPT.

CONNECT
<user starts sending the file with the UART
in data mode and ends with an [ETX] character
>
OK

AT+WIPFILE=8,1,2,"6.xyz","<XYZ>" // send the XYZ file previously specified by WIPOPT.

CONNECT
<user starts sending the file with the UART
in data mode and ends with an [ETX] character
>
OK

AT+WIPOPT=8,1,2,96 // send WIP_MMS_DONE to signal that the users has sent

the last file. This is to avoid deadlock errors where the user
missed to send a file.

OK //the server accepted a connection and the MMS was sent

successfully

4115730 Rev 5.0 March 26, 2015 104

 Extended AT Commands Manual Internet Library Commands

+WIPPEERCLOSE: 8,1 //unsolicited: the MMS session is closed.

3.5.10. TCP Server Example

The example below depicts creating a TCP server and then spawning the maximum TCP sockets for
the Configured Server.
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=3,1,80,5,6 //create the server on port 80, idx = 1. The //server is

OK listening for connection request on //port 80.Spawned
sockets will be given the //index 5 or 6. It will accept
connection request //until it has no more socket left.

+WIPACCEPT: 1,5 //unsolicited: the server accepted a connection //resulting

TCP client on idx 5.

+WIPACCEPT: 1,6 //unsolicited: the server accepted a connection //resulting

TCP client on idx 6.

AT+WIPCLOSE=2,5 //close the spawned TCP client socket index 5.

OK //now if the peer device try to connect to the //server it shall

receive an accept () immediately ///followed by an
shutdown() (connection reset //by peer)

3.5.11. Server Creation Failure Example

The example below depicts creating a server and trying to create a TCP client/server on a reserved
index (reserved by said server), which will fail.
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

4115730 Rev 5.0 March 26, 2015 105

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=3,2,80,1,2 //create the server on port 80, idx=2. The server //is listening
OK for connection request on port 80. //Spawned sockets will be
given the index 1 or //2.It will accept connection request until
has //nor more socket left.

AT+WIPCREATE=2,3,”198.168.0.1”,80 //create a TCP client towards peer IP device @

//“198.168.0.1”, port 80,

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 2,3 //unsolicited: the TCP client socket is connected //to the
peer.

+WIPACCEPT: 2,1 //unsolicited: the server index accepted a //connection;

resulting TCP client on idx 1

AT+WIPDATA=2,3,1 //exchange data on socket index 3

CONNECT

AT+WIPDATA=2,1,1 //exchange data on socket index 1

CONNECT

[ETX] //send unescaped ETX character

+WIPPEERCLOSE: 2,3 //unsolicited: peer socket is closed

AT+WIPCLOSE=3,1 //close TCP server socket index 1

OK

AT+WIPCREATE=3,2,81,2,3 //create the server on port 81, idx=2 and from_idx=2 and
to_idx=3

+CME ERROR:845 //TCP client socket with idx 2 was reserved by //the previous
server socket and it was not //closed explicitly. Hence error
is returned.

3.5.12. TCP Client Creation Failure Example

The example below depicts creating a TCP client and trying to create a TCP server with an indexes
range containing the TCP client, which will fail.

4115730 Rev 5.0 March 26, 2015 106

 Extended AT Commands Manual Internet Library Commands

AT+WIPCFG=1 //start IP stack

OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=2,1,”198.168.0.1”,80 //create a TCP client towards peer IP device @

//“198.168.0.1”, port 80

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 2,1 //unsolicited: the TCP client socket is connected //to the
peer.

AT+WIPCREATE=3,2,80,1,2 //create the server on port 80, idx=2. Range //requested

+CME ERROR: 845 contains the already used index //“1” and hence error is
returned.

3.5.13. Socket, Client, and Server Creation Example

The example below depicts creating 8 UDP sockets, 8 TCP clients and 4 TCP servers properly.
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=1,1,55,”192.168.0.1” //create a UDP client towards peer IP device @

,75 //“192.168.0.1”, port 75.

4115730 Rev 5.0 March 26, 2015 107

 Extended AT Commands Manual Internet Library Commands

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,1 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,2,56,”192.168.0.1” //create a UDP client towards peer IP device @

,76 //“192.168.0.1”, port 76.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,2 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,3,57,”192.168.0.1” //create a UDP client towards peer IP device @

,77 //“192.168.0.1”, port 77.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,3 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,4,58,”192.168.0.1” //create a UDP client towards peer IP device @

,78 //“192.168.0.1”, port 78.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,4 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,5,59,”192.168.0.1” //create a UDP client towards peer IP device @

,79 //“192.168.0.1”, port 79.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,5 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,6,60,”192.168.0.1” //create a UDP client towards peer IP device @

,80 //“192.168.0.1”, port 80.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,6 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,7,61,”192.168.0.1” //create a UDP client towards peer IP device @

,81 //“192.168.0.1”, port 81

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,7 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,8,62,”192.168.0.1” //create a UDP client towards peer IP device @

,82 //“192.168.0.1”, port 82.

4115730 Rev 5.0 March 26, 2015 108

 Extended AT Commands Manual Internet Library Commands

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,8 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,9,63,”192.168.0.1”
,83
+CME ERROR: 830 th
//8 UDP sockets have been created and hence //9 attempt
fails

AT+WIPCREATE=3,1,80,1,1 //create one server on port 80, idx = 1. One //TCP client
OK socket is reserved on index 1

AT+WIPCREATE=3,2,81,2,2 //create one server on port 81, idx = 2. One //TCP client
OK socket is reserved on index 2

AT+WIPCREATE=3,3,82,3,3 //create one server on port 82, idx = 3. One //TCP client
OK socket is reserved on index 3

AT+WIPCREATE=3,4,83,4,4 //create one server on port 83, idx = 4. One //TCP client
OK socket is reserved on index 4

AT+WIPCREATE=3,5,84,5,5 //4 TCP servers have been created and hence //creation of
th
+CME ERROR: 830 5 TCP server socket fails

AT+WIPCREATE=2,1,”192.168.0.1”,80 //create a TCP client socket towards peer IP //device @

+CME ERROR: 845 “192.168.0.1”, port 80. Index 1 is //reserved by server index
and hence error is //returned.

//4 reserved TCP client sockets have been //spawned by

their TCP server.

+WIPACCEPT: 1,1 //unsolicited: the server index 1 accepted a //connection;

resulting TCP client on idx 1

+WIPACCEPT: 2,2 //unsolicited: the server index 2 accepted a //connection;

resulting TCP client on idx 2

+WIPACCEPT: 3,3 //unsolicited: the server index 3 accepted a //connection;

resulting TCP client on idx 3

+WIPACCEPT: 4,4 //unsolicited: the server index 4 accepted a //connection;

resulting TCP client on idx 4

AT+WIPCREATE=2,5,”192.168.0.1”,80 //create a TCP client towards peer IP device @

//“192.168.0.1”, port 80.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,5 //unsolicited: the TCP client socket is connected //to the
peer.

AT+WIPCREATE=2,6,”192.168.0.1”,80 //create a TCP client towards peer IP device @

//“192.168.0.1”, port 80.

4115730 Rev 5.0 March 26, 2015 109

 Extended AT Commands Manual Internet Library Commands

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,6 //unsolicited: the TCP client socket is connected //to the
peer

AT+WIPCREATE=2,7,”192.168.0.1”,80 //create a TCP client towards peer IP device @

//“192.168.0.1”, port 80

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,7 //unsolicited: the TCP client socket is connected //to the
peer

AT+WIPCREATE=2,8,”192.168.0.1”,80 //create a TCP client towards peer IP device @

//“192.168.0.1”, port 80.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,8 //unsolicited: the TCP client socket is connected //to the
peer

AT+WIPCREATE=2,8,”192.168.0.1”,80 //create a TCP client towards peer IP device @

+CME ERROR: 840 //“192.168.0.1”, port 80. Index 8 is already //used and
corresponds to an active socket.

AT+WIPCREATE=2,9,”192.168.0.1”,80 //create a TCP client towards a peer IP device @

+CME ERROR: 830 //“192.168.0.1”, port 80. Index 9 is forbidden.

3.5.14. MAX_SOCK_NUM Usage Failure Example

The example below depicts changing the MAX_SOCK_NUM option value and trying to create 8 UDP
sockets, 8 TCP Client sockets, and 4 TCP Server sockets, which will fail.
AT+WIPCFG=1 //start IP stack
OK

AT+WIPCFG=2,6,3 //MAX_SOCK_NUM has been changed to 3

OK

AT+WIPCFG=4,1 //save the changed configuration to flash

OK

AT+WIPCFG=0 //close the IP stack

OK

AT+WIPCFG=1 //start IP stack

OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

4115730 Rev 5.0 March 26, 2015 110

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=1,1,55,”192.168.0.1” //create a UDP client towards peer IP device @

,75 //“192.168.0.1”, port 75.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,1 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,2,56,”192.168.0.1” //create a UDP client towards peer IP device @

,76 //“192.168.0.1”, port 76.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,2 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,3,57,”192.168.0.1” //create a UDP client towards peer IP device @

,77 //“192.168.0.1”, port 77.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,3 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,4,58,”192.168.0.1” //create a UDP client towards peer IP device @

,78 //“192.168.0.1”, port 78.

+CME ERROR: 838 //maximum 3 sockets can be created as the

//MAX_SOCK_NUM value has been changed to //3. Hence
an attempt to create a fourth socket //returns error.

3.5.15. Socket, Client, Server, and FTP/HTTP/SMTP/POP3

Creatoin Example
The example below depicts creating 8 UDP sockets, 8 TCP clients, 4 TCP servers and either a
FTP/HTTP/SMTP/POP3 successfully.
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

4115730 Rev 5.0 March 26, 2015 111

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=1,1,55,”192.168.0.1” //create a UDP client towards peer IP device @

,75 //“192.168.0.1”, port 75.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,1 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,2,56,”192.168.0.1” //create a UDP client towards peer IP device @

,76 //“192.168.0.1”, port 76.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,2 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,3,57,”192.168.0.1” //create a UDP client towards peer IP device @

,77 //“192.168.0.1”, port 77.

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 1,3 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,4,58,”192.168.0.1” //create a UDP client towards peer IP device @

,78 //“192.168.0.1”, port 78.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,4 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,5,59,”192.168.0.1” //create a UDP client towards peer IP device @

,79 //“192.168.0.1”, port 79.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,5 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,6,60,”192.168.0.1” //create a UDP client towards peer IP device @

,80 //“192.168.0.1”, port 80.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,6 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,7,61,”192.168.0.1” //create a UDP client towards peer IP device @

,81 //“192.168.0.1”, port 81

4115730 Rev 5.0 March 26, 2015 112

 Extended AT Commands Manual Internet Library Commands

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,7 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,8,62,”192.168.0.1” //create a UDP client towards peer IP device @

,82 //“192.168.0.1”, port 82.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 1,8 //unsolicited: the UDP client socket is “pseudo //”connected

to the peer (no real connection is // UDP)

AT+WIPCREATE=1,9,63,”192.168.0.1”
,83
+CME ERROR: 830 th
//8 UDP sockets have been created and hence //9 attempt
fails

AT+WIPCREATE=3,1,83,1,1 //create one server on port 83, idx = 1. One //TCP client
OK socket is reserved on index 1

AT+WIPCREATE=3,2,84,2,2 //create one server on port 84, idx = 2. One //TCP client
OK socket is reserved on index 2

AT+WIPCREATE=3,3,85,3,3 //create one server on port 85, idx = 3. One //TCP client
OK socket is reserved on index 3

AT+WIPCREATE=3,4,86,4,4 //create one server on port 86, idx = 4. One //TCP client
OK socket is reserved on index 4

AT+WIPCREATE=3,5,84,5,5 //4 TCP servers have been created and hence //creation of
th
+CME ERROR: 830 5 TCP server socket fails

AT+WIPCREATE=2,1,”192.168.0.1”,83 //4 TCP server have been created and each of //them
th
+CME ERROR: 845 reserved 1 TCP client socket and hence //5 attempt of
creating TCP server fails

//4 reserved TCP client sockets have been //spawned by

their TCP server.

+WIPACCEPT: 1,1 //unsolicited: the server index 1 accepted a //connection;

resulting TCP client on idx 1

+WIPACCEPT: 2,2 //unsolicited: the server index 2 accepted a //connection;

resulting TCP client on idx 2

+WIPACCEPT: 3,3 //unsolicited: the server index 3 accepted a //connection;

resulting TCP client on idx 3

+WIPACCEPT: 4,4 //unsolicited: the server index 4 accepted a //connection;

resulting TCP client on idx 4

AT+WIPCREATE=2,5,”192.168.0.2”,80 //create a TCP client towards peer IP device @

//“192.168.0.2”, port 80.

4115730 Rev 5.0 March 26, 2015 113

 Extended AT Commands Manual Internet Library Commands

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,5 //unsolicited: the TCP client socket is connected //to the
peer.

AT+WIPCREATE=2,6,”192.168.0.2”,80 //create a TCP client towards peer IP device @

//“192.168.0.2”, port 80.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,6 //unsolicited: the TCP client socket is connected //to the
peer

AT+WIPCREATE=2,7,”192.168.0.2”,80 //create a TCP client towards peer IP device @

//“192.168.0.2”, port 80

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,7 //unsolicited: the TCP client socket is connected //to the
peer

AT+WIPCREATE=2,8,”192.168.0.2”,80 //create a TCP client towards peer IP device @

//“192.168.0.2”, port 80.

OK //all parameters and IP stack behavior are OK

+WIPREADY: 2,8 //unsolicited: the TCP client socket is connected //to the
peer

AT+WIPCREATE=2,8,”192.168.0.2”,80 //create a TCP client towards peer IP device @

+CME ERROR: 840 //“192.168.0.2”, port 80. Index 8 is already //used and
corresponds to an active socket.

AT+WIPCREATE=2,9,”192.168.0.2”,80 //create a TCP client towards a peer IP device @

+CME ERROR: 830 //“192.168.0.2”, port 80. Index 9 is forbidden.

AT+WIPCREATE=4,1,”ftp //create FTP session using default port 21

server”,,”user name”,”password”
OK //FTP session is created successfully.

AT+WIPCREATE=7,1,”POP3
server”,,”user name”,”mail id”
+CME ERROR: 840
//attempt of creating a OP3 session returns an //error as
already 1 FTP session is active.

AT+WIPCLOSE=4,1 //close FTP session

OK
+WIPPEERCLOSE: 4,1 //unsolicited: FTP session is closed //successfully

AT+WIPCREATE=7,1,”POP3 //create POP3 session using default port 110

server”,,”user name”,”mail id”
OK //all parameters and IP stack behaviors are OK.

+WIPREADY: 7,1 //unsolicited: the POP3 session is created //successfully

4115730 Rev 5.0 March 26, 2015 114

 Extended AT Commands Manual Internet Library Commands

3.5.16. Internet Library API Subscribe/Unsubscribe

Example
The example below depicts subscribing/unsubscribing to Internet Application AT commands using the
Internet Library API.
#include "adl_global.h" // Global includes
#include "wip_atcmd.h" // Internet Library AT command services
#if __OAT_API_VERSION__ >= 400
const u16 wm_apmCustomStackSize = 4096;
#else
u32 wm_apmCustomStack[1024];
const u16 wm_apmCustomStackSize = sizeof(wm_apmCustomStack);
#endif

void adl_main ( adl_InitType_e InitType )

{
TRACE (( 1, "Embedded Application : Main" ));
/* subscribe to the +WIP AT commands set service */
if ( wip_ATCmdSubsrcibe() == 0) {
/* The customer can write here its own application based on other
plug -ins or its specific application target. */
wip_ATCmdUnsubscribe();
}
else
{
/* Error while subscribing to WIPsoft library */
}
}

3.5.17. TCP Client/Server Creation/Simultaneous UART

Mapping Example
The example below depicts creating TCP client and server sockets in the same embedded module, at
the same time mapping or unmapping the UART to exchange the data between the sockets.
AT+WIPCFG=1 //start IP stack
OK

AT+WIPBR=1,6 //open GPRS bearer

OK

4115730 Rev 5.0 March 26, 2015 115

 Extended AT Commands Manual Internet Library Commands

AT+WIPBR=2,6,11,”APN name” //set APN name of GPRS bearer

OK

AT+WIPBR=2,6,0,”user name” //set user name

OK

AT+WIPBR=2,6,1,”passwd” //set password

OK

AT+WIPBR=4,6,0 //start GPRS bearer

OK

AT+WIPCREATE=3,2,80,1,2 //create the server on port 80, idx=2. The server //is listening
OK for connection request on port 80. //Spawned sockets will be
given the index 1 or //2.It will accept connection request until
has //nor more socket left.

AT+WIPCREATE=2,3,”198.168.0.1”,80 //create a TCP client towards peer IP device @

//“198.168.0.1”, port 80,

OK //all parameters and IP stack behavior are OK.

+WIPREADY: 2,3 //unsolicited: the TCP client socket is connected //to the
peer.

+WIPACCEPT: 2,1 //unsolicited: the server index accepted a //connection;

resulting TCP client on idx 1

AT+WIPDATA=2,3,1 //exchange data on socket index 3

CONNECT

abc+++ //data sent to socket index 1 and switched to AT mode by

giving +++
OK

AT+WIPDATA=2,1,1 //exchange data on socket index 1

CONNECT

abc+++ //data received from socket index 3

OK

3.6. Error Codes

3.6.1. General CME Error Codes

“+CMEE” AT
Description
error code

800 invalid option

801 invalid option value
802 not enough memory
803 operation not allowed in the current Internet Library stack state
804 device already open

4115730 Rev 5.0 March 26, 2015 116

 Extended AT Commands Manual Internet Library Commands

“+CMEE” AT
Description
error code

805 network interface not available

806 operation not allowed on the considered bearer
807 bearer connection failure : line busy
808 bearer connection failure : no answer
809 bearer connection failure : no carrier
810 bearer connection failure : no sim card present
811 bearer connection failure : sim not ready (no pin code entered, …)
812 bearer connection failure : GPRS network failure
813 bearer connection failure : PPP LCP negotiation failed
814 bearer connection failure : PPP authentication failed
815 bearer connection failure : PPP IPCP negotiation failed
816 bearer connection failure : PPP peer terminates session
817 bearer connection failure : PPP peer does not answer to echo request
818 incoming call refused
819 error on Ping channel
820 error writing configuration in FLASH memory
821 error reading configuration in FLASH memory
822-829 reserved for future use
830 bad index
831 bad state
832 bad port number
833 bad port state
834 not implemented
835 option not supported
836 memory allocation error
837 bad protocol
838 no more free socket
839 error during channel creation
840 UDP/TCP socket or FTP/HTTP/SMTP/POP3 session is already active
841 peer closed, or error in the FTP connection
destination host unreachable ( whether host unreachable, Network unreachable, response
842
timeout)
843 connection reset by peer
844 stack already started
attempt is made to reserve/create a client socket which is already reserved/opened by TCP
845
server/client
846 internal error: FCM subscription failure
bearer connection failure: WIP_BOPT_GPRS_TIMEOUT time limit expired before GPRS
847
bearer connected
848 impossible to connect to the bearer
connection to the bearer has succeeded but a problem has occurred during the data flow
849
establishment
850 invalid channel option or parameter value (for example, HTTP user name too long)

4115730 Rev 5.0 March 26, 2015 117

 Extended AT Commands Manual Internet Library Commands

“+CMEE” AT
Description
error code

specified parameters to the command is more or less than the maximum number of
851
mandatory parameters
852 IP stack not initialized
853 Data offline buffer filled
854-859 reserved for future use
860 protocol undefined or internal error
861 username rejected by server
862 password rejected by server
863 delete error
864 list error
865 authentication error
866 server not ready error
867 POP3 email retrieving error
868 POP3 email size error
869-879 reserved for future use
880 SMTP sender email address rejected by server
881 SMTP recipient email address rejected by server
882 SMTP CC recipient email address rejected by server
883 SMTP BCC recipient email address rejected by server
884 SMTP email body send request rejected by server
890 Service denied
891 Message format corrupt
892 Address unresolved
893 Message not found
894 Network problem
895 Content not accepted
896 Unsupported message
897 Unspecified error

3.6.2. GPRS CME Error Codes

<error> Meaning Resulting from the following commands

103 Incorrect MS identity.(#3) +CGATT

132 Service option not supported (#32) +CGACT +CGDATA ATD*99
Requested service option not
133 +CGACT +CGDATA ATD*99
subscribed (#33)
Service option temporarily out of order
134 +CGACT +CGDATA ATD*99
(#26, #34, #38)
148 Unspecified GPRS error All GPRS commands
149 PDP authentication failure (#29) +CGACT +CGDATA ATD*99
150 Invalid mobile class +CGCLASS +CGATT

4115730 Rev 5.0 March 26, 2015 118

 4. Location Library Commands

4.1. AT Commands Reference

The following AT commands allow the control of Location Services for basic operation.

4.1.1. Command +GPSHELP

4.1.1.1. Description
This AT Command is used to display the Location AT commands help.
Note: +GPSHELP command syntax is subject to change with application evolution.

4.1.1.2. Syntax

Action command
AT+GPSHELP=[<at_command>]

OK

Test command
AT+GPSHELP=?
+GPSHELP: (list of supported <at_command>s)
OK

4.1.1.3. Parameters and Defined Values

<at_command >: The string parameter specifies the AT command described by help display.

4.1.1.4. Examples

Command Responses

+GPSINIT= <hw>[,<spi>,<cs>,<reset>,<enable>,
AT+GPSHELP <clock32k>]
Note: displays all supported Location …
Services AT command format.
OK

4115730 Rev 5.0 March 26, 2015 119

 Extended AT Commands Manual Location Library Commands

Command Responses

AT+GPSHELP=GPSSTART +GPSSTART=[<starting_mode>]
Note: displays information about the <starting_mode>: 0 [GPS_HOT_START]
+GPSSTART AT command.

<starting_mode>: 1 [GPS_WARM_START]

<starting_mode>: 2 [GPS_COLD_START]

<starting_mode>: 3 [GPS_FACTCOLD_START]
OK

AT+GPSHELP=? +GPSHELP:
Note: displays all supported Location (GPSINIT,GPSNMEA,GPSSTART,GPSSTOP,GPSSTATE,GPSTTFF,GPSS
AT command. AVE, etc.)OK

4.1.2. Command +GPSNMEA

4.1.2.1. Description
This AT command configures the NMEA frames flow, the output port and the NMEA sentences
encode mask.
Note: NMEA sentences are output as unsolicited AT command responses. In consequence, in case the output
port is not dedicated but shared with AT commands, NMEA frames output will be suspended while an AT
command is being processed, and resume once the AT command has returned. In case of significant
delay, some NMEA sentences may be partially or totally lost.

4.1.2.2. Syntax

Action command
AT+GPSNMEA=[<output>][,[<rate>][,<nmea_mask>],[<nmea_profile>]]

OK

Read command
AT+GPSNMEA?
+GPSNMEA: <output>,<rate>,<nmea_mask>,<nmea_profile>
OK

Test command
AT+GPSNMEA=?

4115730 Rev 5.0 March 26, 2015 120

 Extended AT Commands Manual Location Library Commands

+GPSNMEA: (list of supported <output>s),(list of supported <rate>s), (list of

supported <nmea_mask>s), (list of supported NMEA profiles)
OK

4.1.2.3. Parameters and Defined Values

<output>: This parameter specifies the port which is to be used by the application to transmit
the NMEA frames. (Hexadecimal value entered without the prefix “0x”). This port
can also be used simultaneously as the PVT sentences output port if need be.
If omitted: last known value within current session.
Factory default value: 1.

Note: The port has to be different from the port used for the communication
between GPS receiver and the Embedded Module. See +GPSINIT for more
details.
0 NMEA frames are not output.

1 NMEA frames output on UART 1.

2 NMEA frames output on UART 2.

3 NMEA frames output on USB.

4 NMEA frames output on port where the +GPSNMEA command was received.
The supported ports are described above.

5 NMEA frames output on UART 3.

0x1X CMUX virtual port, Logical ports over UART1 where 1 <= X <=4

0x2X CMUX virtual port, Logical ports over UART2 where 1 <= X <=4

0x5X CMUX virtual port, Logical ports over UART3 where 1 <= X <=4

<rate>: This parameter defines the NMEA frames update rate in seconds.
If omitted: last known value within current session.
Factory default value: 1.
Range: 0-65535

Note: If this parameter is equal to 0, the NMEA frames will be sent only once,
on the next occurrence of the NMEA frames update.
Note: This parameter is impacted by the Reduced Rate GPS Navigation.
Please refer to +GPSCONF AT command for more information.
<nmea_mask>: NMEA sentences list encode mask (Hexadecimal value entered without the
prefix “0x”).
This parameter defines the NMEA sentences encode mask as described
hereunder.
If omitted: last known value within current session
Factory default value: 0xFFFF.
Range: 0x0-0xFFFF

Note: [] All NMEA frames may not be supported depending on GPS receiver
type.

4115730 Rev 5.0 March 26, 2015 121

 Extended AT Commands Manual Location Library Commands

0: GPS_NMEA_NONE_EN - All NMEA frames output are disabled

(1 << 0): GPS_NMEA_GGA_EN - NMEA $GPGGA (GPS Fix Data) output enabled

(1 << 1): GPS_NMEA_GGSA_EN - NMEA $--GSA (GNSS DOPS and Active Satellites)
output enabled.

(1 << 2): GPS_NMEA_RMC_EN - NMEA $--RMC (Recommended Minimum GNSS

Sentence) output enabled.

(1 << 3): GPS_NMEA_VTG_EN - NMEA $--VTG (Course Over Ground and Ground
Speed) output enabled.

(1 << 4): GPS_NMEA_GLL_EN - NMEA $--GLL (Geographic Position - Latitude,

Longitude) output enabled.

(1 << 5): GPS_NMEA_GST_EN - NMEA $--GST (GNSS Pseudorange Error Statistics)

output enabled (if supported by GPS receiver).

(1 << 6): GPS_NMEA_GSV_EN - NMEA $--GSV (GNSS Satellites in View) output

enabled.

(1 << 7): GPS_NMEA_ZDA_EN - NMEA $--ZDA (Time & Date) output enabled (if
supported by GPS receiver).

(1 << 8): GPS_NMEA_GNS_EN_NMEA $--GNS (GNSS Fix Data) output enabled

(1 << 15): GPS_NMEA_PROP_EN - NMEA $PXXXX sentences enabled. The GPS

Proprietary diagnostics data output are enabled (if supported by GPS receiver).

0xFFFF: GPS_NMEA_ALL_EN - ALL NMEA frames output supported by the GPS

receiver are enabled.

<nmea_profile>: NMEA profile for the NMEA Mask

This parameter defines the profile on which the parameter <NMEA Mask> will
be applied.
If omitted: last known value within current session.
Factory default value: 0xFF.
Range: 0x0 – 0xFF.

Note: [] All NMEA profiles may not be supported depending on GPS
receiver type.
0: GPS_NMEA_PROFILE_NONE - No NMEA profile.

(1 << 0): GPS_NMEA _PROFILE_GPS - “<nmea_mask> is applied to “$GP” NMEA

frames “

(1 << 1): GPS_NMEA_PROFILE_GLONASS - “<nmea_mask> is applied to “$GL” NMEA

frames “

(1 << 7): GPS_NMEA_PROFILE_GNSS - “<nmea_mask> is applied to “$GN” NMEA

frames “

0xFF : GPS_NMEA_PROFILE_ALL – All NMEA profile.

4115730 Rev 5.0 March 26, 2015 122

 Extended AT Commands Manual Location Library Commands

4.1.2.4. Examples

Command Responses

AT+GPSNMEA=3 OK
or
Note: request NMEA frames output on port 3 +GPS ERROR: X
(USB).
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSNMEA=1,5 OK
or
Note: request NMEA frames output on UART1 (1) +GPS ERROR: X
with an update rate of 5 seconds.
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSNMEA=1,1,FFFF OK
or
Note: request all NMEA frames output on UART1 +GPS ERROR: X
(1) with an update rate of 1 second.
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSNMEA=1,1,FFFF,3 OK
or
Note: request all NMEA frames output on UART1 +GPS ERROR: X
(1) with an update rate of 1 second, only for GPS
and GLONASS constellation ( No GN Note: For more information about X value, please
NMEA sentence will be displayed ). refer to Location AT commands error codes
description.

AT+GPSNMEA=,60,19
OK
or
Note: request VTG+GGA+GLL NMEA sentences +GPS ERROR: X
output on default port with an update rate of 60
seconds. Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSNMEA=,,19 OK
or
Note: request VTG+GGA+GLL NMEA sentences +GPS ERROR: X
output on default port with the default update rate.
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSNMEA=?
+GPSNMEA: (0-5,11-14,21-24,51-54),(0-65535),(0-
FFFF), (0-FF)
OK

4115730 Rev 5.0 March 26, 2015 123

 Extended AT Commands Manual Location Library Commands

Command Responses

AT+GPSNMEA?
+GPSNMEA: 1,1,FFFF,FF

Note: Allow to retrieve the current default OK

configuration.

4.1.3. Command +GPSPVT

4.1.3.1. Description
This AT command configures the PVT sentences flow including the output port, the output rate, and
the PVT sentences output mask.
The PVT sentences include the main GPS information like Fix Status, Position, Velocity, Time and
satellites information.
Note: PVT sentences are output as unsolicited AT command responses. In consequence, in case the output
port is not dedicated but shared with AT commands, PVT sentences output will be suspended while an
AT command is being processed, and resume once the AT command has returned. In case of significant
delay, some PVT sentences may be partially or totally lost.
Note: [] +GPSPVT AT command is not supported for gpsOne.

4.1.3.2. Syntax

Action command
AT+GPSPVT=[<output>][,[<rate>][,<pvt_mask>]]

OK

Read command
AT+GPSPVT?
+GPSPVT: <output>,<rate>,<pvt_mask>
OK

Test command
AT+GPSPVT=?
+GPSPVT: (list of supported <output>s),(list of supported <rate>s), (list of
supported <pvt_mask>s)
OK

4115730 Rev 5.0 March 26, 2015 124

 Extended AT Commands Manual Location Library Commands

4.1.3.3. Parameters and Defined Values

<output>: This parameter specifies the port which is to be used by the application to transmit
the PVT sentences. (Hexadecimal value entered without the prefix “0x”). This port
can also be used simultaneously as the NMEA frames output port if need be.
If omitted: last known value within current session.
Factory default value: 0.

Note: The port has to be different from the port used for the communication
between GPS receiver and the Embedded Module. See +GPSINIT for more
details.
0 PVT sentences are not output.

1 PVT sentences output on UART 1.

2 PVT sentences output on UART 2.

3 PVT sentences output on USB.

4 PVT sentences output on port where the +GPSPVT command was received.

5 PVT sentences output on UART 3.

0x1X CMUX virtual port, Logical ports over UART1 where 1 <= X <=4

0x2X CMUX virtual port, Logical ports over UART2 where 1 <= X <=4

0x5X CMUX virtual port, Logical ports over UART3 where 1 <= X <=4

<rate>: This parameter defines the PVT sentences update rate in seconds.
If omitted: last known value within current session.
Factory default value: 1.
Range: 0-65535

Note: If this parameter is equal to 0, the PVT sentences will be sent only once,
on the next occurrence of the PVT sentences update.
Note: This parameter is impacted by the Reduced Rate GPS Navigation.
Please refer to +GPSCONF AT command for more information.
<pvt_mask>: PVT sentences list encode mask (Hexadecimal value entered without the prefix
“0x”).
This parameter defines the PVT sentences encode mask as described
hereunder.
The PVT sentence includes the header +GPSPVT: X with X defined as the PVT
sentence identifier. All the fields are separated by a comma.
If omitted: last known value within current session.
Factory default value: 0xFFFF.
Range: 0x0-0xFFFF

0: PVT sentence including the main GPS position information. The fields are
described hereunder:
Header: +GPSPVT: 0
1: UTC of position fix in HH:MM:SS format
2: Date in dd/mm/yyyy format

4115730 Rev 5.0 March 26, 2015 125

 Extended AT Commands Manual Location Library Commands

3: GPS position fix state: “NO FIX”, “ES FIX” (Estimated Fix), “2D FIX” or “3D
FIX”
4: Latitude: Direction (‘N’ North or ‘S’ South) and the Latitude in DD MM’SS.SS”
5: Longitude: Direction (‘E’ East or ‘W’ West) and the Longitude in DDD
MM’SS.SS”
6: Altitude above Mean Sea Level in meters in +/-mmmm format
Example:
+GPSPVT: 0,08:17:32,27/04/2010,3D FIX,N 48 34'52.90'',E 002
21'58.65'',+0010m

1: PVT sentence including the Course and the Speed over the ground. The fields
are described hereunder:
Header: +GPSPVT: 1
1: Dimensional Course Over Ground in degrees in ddd.d format [0-359.9].
2: Dimensional Speed Over Ground in meter per second in sss format
Example:
+GPSPVT: 1,087.5deg,021m/s

2: PVT sentence including the main satellites information. The fields are described
hereunder:
Header: +GPSPVT: 2
1: Satellites in View used for Navigation followed by “SV”
2: HDOP (Horizontal Dilution of Precision) followed by “HDOP”
3: Satellites in View Maximum Signal To Noise Ratio [dBHz, integer value]
4: Satellites in View Average Signal To Noise Ratio [dBHz, 1 decimal value]
Example:
+GPSPVT: 2,05SV,1.7HDOP,23,12.0

3: PVT sentence including the detailed satellites information. There are a

maximum of 6 satellites per sentence; therefore there may be several sentences
in one cycle. The fields are described hereunder:
Header: +GPSPVT: 3
1: Total number of messages of this type in this cycle
2: Message number in this cycle
3: Satellites in View SV id number [PRN]
4: Satellite status: “U” for Used for Navigation or “N” for Not used for Navigation
5: Satellites in View Signal To Noise Ratio [dBHz, integer value]
[6–8]: Information about second SV, same format as fields 3–5
[9–11]: Information about third SV, same format as fields 3–5
[12–14]: Information about fourth SV, same format as fields 3–5
[15–17]: Information about fifth SV, same format as fields 3–5
[18–20]: Information about sixth SV, same format as fields 3–5
Example for 7 satellites:
+GPSPVT: 3,2,1,[13,U,36],[18,U,8],[29,U,24],[21,U,14],[03,U,40],[07,U,14]
+GPSPVT: 3,2,2,[08,U,18]

4115730 Rev 5.0 March 26, 2015 126

 Extended AT Commands Manual Location Library Commands

4.1.3.4. Examples

Command Responses

AT+GPSPVT=3 OK
or
Note: request PVT sentences output on port 3 +GPS ERROR: X
(USB).
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSPVT=3,5 OK
or
Note: request PVT sentences output on port 3 +GPS ERROR: X
(USB) with an update rate of 5 seconds.
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSPVT=3,1,FFFF OK
or
Note: request all PVT sentences output on USB +GPS ERROR: X
(3) with an update rate of 1 second.
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSPVT=?
+GPSPVT: (0-5,11-14,21-24,51-54),(0-65535),(0-
FFFF)
OK

AT+GPSPVT?
+GPSPVT: 1,1,FFFF

Note: Allow to retrieve the current default OK

configuration.

4.1.3.5. Example of AT command sequence

AT+GPSINIT=11
OK
+GPSEVINIT: 1
AT+GPSNMEA=0
OK
AT+GPSPVT=1
OK
AT+GPSSTART
OK

+GPSEVSTART: 1

+GPSEVPOS: 0

4115730 Rev 5.0 March 26, 2015 127

 Extended AT Commands Manual Location Library Commands

+GPSPVT: 0,00:00:00,00/00/0000,NO FIX,N 00 00'00.00",E 00 00'00.00",-0047m

+GPSPVT: 1,000.0deg,000m/s

+GPSPVT: 2,06SV,0.0HDOP,04,3.5

+GPSPVT: 3,1,1,[02,U,03],[04,U,04],[09,U,04],[12,U,04],[14,U,03],[32,U,03]

+GPSPVT: 0,00:00:00,00/00/0000,NO FIX,N 00 00'00.00",E 00 00'00.00",-0047m

+GPSPVT: 1,000.0deg,000m/s

+GPSPVT: 2,06SV,0.0HDOP,28,19.7

+GPSPVT: 3,1,1,[02,U,11],[04,U,19],[09,U,16],[12,U,23],[14,U,28],[32,U,21]
…

Warning: The +GPSEVSTART: 1 event is sent only if the GPS firmware has been successfully loaded. This
may take several seconds.

4.1.4. Command +GPSSAVE

4.1.4.1. Description
The current setting is stored in FLASH memory as the new default settings when the command
+GPSSAVE=1 is entered. All the parameters of +GPS AT commands are saved. These settings will
be used after each Embedded Module reset as default configuration.
If the user wants the application to retrieve the default factory configuration (refer to each Location AT
command description), the command AT+GPSSAVE = 0 should be given and the Embedded Module
should be reset.
The application state is also saved as default configuration and used at the start (after the Embedded
Module reset) to put the application in this state. This configuration is used for the automatic start.
Note: The AT port where unsolicited Location AT command responses are sent is also saved with +GPSSAVE
AT command.

4.1.4.2. Syntax

Action command
AT+GPSSAVE= <mode>

OK

4115730 Rev 5.0 March 26, 2015 128

 Extended AT Commands Manual Location Library Commands

Read command
AT+GPSSAVE?
+GPSSAVE:<mode>
OK

Test command
AT+GPSSAVE=?
+GPSSAVE: (list of supported <mode>s)
OK

4.1.4.3. Parameters and Defined Values

<mode>: Saving mode.

0 The application should reset all settings to their factory default values for the
next Embedded Module reset.

1 The application should save the current settings as new default settings. If the
Embedded Module is reset, the application uses those settings at restart.

4.1.4.4. Examples

Command Responses

AT+GPSSAVE? +GPSSAVE: 0
OK
Note: 0 if no saved settings or 1 if settings have been saved.

AT+GPSSAVE=1 OK
Note: The current settings are saved. or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSSAVE=?
+GPSSAVE: (0-1)
OK

4.1.4.5. Diagram for settings management

The following diagram describes the Location AT application settings management:

4115730 Rev 5.0 March 26, 2015 129

 Extended AT Commands Manual Location Library Commands

AirPrime Embedded Module Power On / Reset

Location AT application
started

+GPSSAVE?
(Does Location Application +GPSSAVE: 1
+GPSSAVE: 0
Flash Object exist?) (YES)
(NO)

Values of current session

Impact on Location Library Flash object
Factory Default values are saved in Location Library Impact on Last stored values when
next start deleted
applied Flash object next start +GPSSAVE command has
been enterred

Values modified through AT+GPSSAVE=0

Location AT command AT+GPSSAVE=1 Values modified through
Location AT command

Last know values within

current session

Note: The factory default values are described for each field in tables describing Location AT commands.
Note: If +GPSSAVE already equals 1 and a setting is modified through an AT command (for example
+GPSCONF), the modified setting is not saved until the +GPSSAVE=1 command is entered.
Note: The configuration of current session can be retrieved with the read command of each +GPS AT
command, for example “AT+GPSCONF?”.

4.1.5. Command +GPSSTART

4.1.5.1. Description
This AT command starts the GPS or restarts the GPS after the +GPSSTOP or +GPSSLEEP
command. The input parameter specifies the type of START command.
When AT+GPSSTART (without parameter) is entered, the GPS starts with the last known starting mode
value within current session. That starting mode can be retrieved using “+GPSTART?” read command.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.

4.1.5.2. Syntax

Action command
AT+GPSSTART= [<starting_mode>]

OK

4115730 Rev 5.0 March 26, 2015 130

 Extended AT Commands Manual Location Library Commands

Read command
AT+GPSSTART?
+GPSSTART:<starting_mode>
OK

Test command
AT+GPSSTART=?
+GPSSTART: (list of supported <starting_mode>s)
OK

Unsolicited response
+GPSEVSTART: <status>

4.1.5.3. Parameters and Defined Values

<starting_mode>: The parameter specifies the GPS starting mode of the application. These
starting modes are used for test purposes.
If omitted: last known value within current session.
Factory default value: 0.

0 "HOT" start with all previous NV stored data.

1 “WARM" start with previous NV stored data except Broadcasted Ephemeris.

2 "COLD" start with NO previous NV store data except calibration data, updated
Almanac, and Extended Ephemeris if available. Time and last location are
unknown.

3 "FACTCOLD" start with Factory Default Data instead of previous run data.

<status> Event status

0 The action has failed. Application state is unchanged.

1 The action has been successfully completed.

Note: GPS Data are stored to NV memory during specific Location Services Application transition.
Note: [] gpsOne: For WARM, COLD and FACTORY commanded Starting Modes, a HOT Starting Mode
could be performed if the duration between stop and start transitions is too short. In that case, the
“+GPSEVERROR: -23,9” error event will be received. Recommended value for that duration is 80
seconds.

4115730 Rev 5.0 March 26, 2015 131

 Extended AT Commands Manual Location Library Commands

4.1.5.4. Examples

Command Responses

AT+GPSSTART? +GPSSTART: 0
OK
Note: The current starting mode is the “HOT” start.

AT+GPSSTART=1 OK
+GPSEVSTART: 1
Note: Starts GPS in WARM mode. or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSSTART=? +GPSSTART: (0-3)

OK

4.2. Advanced AT Commands Reference

The following specific AT commands are defined to finely control and monitor the Location Services.
These commands can be used to assess performances of the system.

4.2.1. Command +GPSSTATE

4.2.1.1. Description
This AT command returns the current application state.

4.2.1.2. Syntax

Read command
AT+GPSSTATE?
+GPSSTATE:<state>
OK

Test command
AT+GPSSTATE=?
OK

4115730 Rev 5.0 March 26, 2015 132

 Extended AT Commands Manual Location Library Commands

4.2.1.3. Parameters and Defined Values

<state>: Application state as described below

1.

0 Application is in GPS_UNINITIALIZED state

2.

1 Application is in GPS_INITIALIZED state

3.

2 Application is in GPS_RUNNING state

4.

3 Application is in GPS_SLEEP state

4.2.1.4. Examples

Command Responses

AT+GPSSTATE? +GPSSTATE: 0
OK

AT+GPSSTATE=? OK

4.2.2. Command +GPSINIT

4.2.2.1. Description
This AT command initializes the Location Services. It is accepted only if application is in
GPS_UNINITIALIZED state. It allows specifying the hardware setup of the system.
Some predefined setups (Hardware Configuration) are available for ease of use.
If this command is omitted, last saved hardware setup is used. If no hardware setup was saved,
default factory configuration is used.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the request has been processed.

4.2.2.2. Syntax

Action command
AT+GPSINIT= <hw>
[,<bus_type>,<bus_number>,<on_off>,<reset>,<gps_wakeup>,<host_wakeup>,<clock32k>,<a
ppli_led>]

OK

4115730 Rev 5.0 March 26, 2015 133

 Extended AT Commands Manual Location Library Commands

Read command
AT+GPSINIT?
+GPSINIT:<hw>,<bus_type>,<bus_number>,<on_off>,<reset>,<gps_wakeup>,
<host_wakeup>,<clock32k>,<appli_led>
OK

Test command
AT+GPSINIT=?
+GPSINIT: (list of supported <hw>s), (list of supported <bus_type>s), (list of
supported <bus_number>s), (list of supported <on_off>s),(list of supported < reset
>s),(list of supported <gps_wakeup>s),(list of supported <host_wakeup >s),(list of
supported <clock32k>s),(list of supported <appli_led>s)
OK

Unsolicited response
+GPSEVINIT: <status>

4.2.2.3. Parameters and Defined Values

<hw >: Hardware value: Hardware Type or Hardware Configuration for initialization.
If a Hardware Configuration is provided, no other parameter can be specified.
If a Hardware Type is provided, the other hardware settings should be specified or
previously specified parameters apply.
See the Hardware Configuration section for more details on default hardware settings.

1 Hardware Type for XM0110.

[] Only supported for XM0110.

2 Hardware Type for gpsOne.

[] Only supported for gpsOne.

3 Hardware Type for SiRFV.

[] Only supported for SiRFV.

10 Hardware Configuration: Old XM0110 Dev Kit Daughter Board (WM0701201-23-10),

for UART.

[] Only supported for XM0110.

11 Hardware Configuration: XM0110 Dev Kit Daughter Board (WM0701201-23-2X), for

UART.

[] Only supported for XM0110.

4115730 Rev 5.0 March 26, 2015 134

 Extended AT Commands Manual Location Library Commands

12 Obsolete Hardware Configuration for XM0110 Dev Kit Daughter Board

(WM0701201-23-10 ), for UART, for SL6087 Embedded Module.

[] Only supported for XM0110.

13 Hardware Configuration: XM0110 Dev Kit Daughter Board (WM0701201-23-2X), for

I2C.

[] Only supported for XM0110.

30 Hardware Configuration: AR6220-G integrating SiRFV GNSS receiver.

[] Only supported for SiRFV.

<bus_type>: Bus type on which the GPS receiver is connected.

1 UART

2 I2C

<bus_number>: Bus number on which the GPS receiver is connected.

1 Bus number 1

2 Bus number 2, for example UART2 (if a UART bus type is selected)

<on_off>: ON/OFF Command ID / GPIO number

Range: 0-65535
In case the user intends to manage GPS receiver power up/power down on its own
(i.e., independently of +GPSSTART and +GPSSTOP command), then the
parameter shall be set to 65535.

<reset>: Reset Command ID / GPIO number

Range: 0-65535

<gps_wakeup>: GPS receiver Wakeup Command ID / GPIO number

Range: 0-65535
In case GPS receiver wake-up is not to be driven by a dedicated GPIO, parameter
must be set to 65535.

Note: For UART bus type, 65535 is the only accepted value. For I2C, 65535 is
not accepted, a GPIO must be specified.
<host_wakeup>: Host Wakeup external interrupt input ID / External Interrupt number

Range: 0-65535 (0 for INT0, 1 for INT1, etc.).

In case host wake-up is not to be driven by an External Interrupt, parameter must
be set to 65535.

<clock32k>: 32KHz clock management

0 GPS_32K_NONE (No 32kHz clock is provided to GPS receiver).

1 GPS_32K_INTERNAL (32kHz clock is provided by the Embedded Module to the

GPS receiver and managed automatically by the application through AT+WHCNF
command).

4115730 Rev 5.0 March 26, 2015 135

 Extended AT Commands Manual Location Library Commands

2 GPS_32K_EXTERNAL (32kHz clock is provided by an external way to GPS

receiver).

<appli_led>: Application led Command ID / GPIO number

Range: 0-65535
In case application Led is not to be driven by a GPIO, parameter must be set to
65535.
In case application Led GPIO is to be automatically selected by the Location AT
application upon Embedded Module type, parameter must be set to 65534. In this
case the application Led GPIO is forced to GPIO31 for the Q26/WMP Embedded
Modules and GPIO20 for the SL6087 Embedded Module.

<status> Event status

0 The action has failed. Application state is unchanged.

1 The action has been successfully completed.

4.2.2.4. Examples

Command Responses

AT+GPSINIT? +GPSINIT:
1,1,2,22,23,65535,65535,1,65534
OK
Note: [] Default configuration response for XM0110

AT+GPSINIT=1 OK
Note: For default configuration applied on XM0110 +GPSEVINIT: 1
or
+GPS ERROR: X
Note: For more information about X value, please
refer to Location AT commands error codes
description.

AT+GPSINIT=11 OK
Note: [] For XM0110 Dev Kit DB V2 HW settings for UART +GPSEVINIT: 1
or
+GPS ERROR: X
Note: For more information about X value, please
refer to Location AT commands error codes
description.

4115730 Rev 5.0 March 26, 2015 136

 Extended AT Commands Manual Location Library Commands

Command Responses

AT+GPSINIT=2 OK
Note: [] Example for gpsOne +GPSEVINIT: 1
or
+GPS ERROR: X
Note: For more information about X
value, please refer to Location AT
commands error codes description.

AT+GPSINIT=30 OK
Note: [] Example for SiRFV +GPSEVINIT: 1
or
+GPS ERROR: X
Note: For more information about X
value, please refer to Location AT
commands error codes description.

AT+GPSINIT=1,1,2,22,23,65535,0,1,65534 OK
Note: [] XM0110: For same HW settings as Hardware Configuration +GPSEVINIT: 1
11 but with INT0 as host wake-up interrupt.
or
+GPS ERROR: X
Note: For more information about X value, please
refer to Location AT commands error codes
description.

AT+GPSINIT=? +GPSINIT: 1,(1-2),(1-2),(0-

65535),(0-65535),(0-65535),(0-
65535),(0-2),(0-65535)
OK
Note: [] Response for XM0110

4.2.2.5. Hardware Configuration

4.2.2.5.1. XM0110 Hardware Configuration

The default hardware resources settings according to Hardware Type and Hardware Configuration
are described below:

Hardware Type 1
(<hw>=1), or Hardware Hardware
Hardware Configuration 13 Configuration 10
Configuration 11 (<hw>=13) (<hw>=10)
(<hw>=11)

XM0110 Dev Kit DB XM0110 Dev Kit DB Old XM0110 Dev Kit DB
Hardware setup (WM0701201-23-2X) (WM0701201-23-2X) (WM0701201-23-10)
compatibility
for UART. for I2C for UART.
<hw> 1 1 1

4115730 Rev 5.0 March 26, 2015 137

 Extended AT Commands Manual Location Library Commands

Hardware Type 1
(<hw>=1), or Hardware Hardware
Hardware Configuration 13 Configuration 10
Configuration 11 (<hw>=13) (<hw>=10)
(<hw>=11)

<bus_type> 1 2 1
<bus_number> 2 1 2
<on_off> 22 22 22
<reset> 23 23 19
<gps_wakeup> 65535 (Not managed) 24 65535 (Not managed)
<host_wakeup> 65535 (Not managed) 65535 (Not managed) 65535 (Not managed)
<clock32k> 1 1 1
65534 (GPIO
65534 (GPIO automatically
automatically selected
selected depending on
depending on embedded
<appli_led> embedded module type: 20
module type: GPIO31 for
GPIO31 for Q26/WMP and
Q26/WMP and GPIO20
GPIO20 for SL6087).
for SL6087).
Note: The following Hardware Configuration is obsolete:
<hw>=12 (XM0110 Dev Kit DB V2 WM0701201-23-10 + SL6087 Dev Kit + UART config.)
<hw>=11 should now be used for this hardware setup.

4.2.2.5.2. GpsOne Hardware Configuration

The default hardware resources settings according to Hardware Type and Hardware Configuration
are described below:

Hardware Type 2 (<hw>=2)

Hardware setup compatibility gpsOne

<hw> 2
Note: No Hardware Configuration is available for gpsOne. Only Hardware type parameter is used.

4.2.2.5.3. SiRFV Hardware Configuration

The default hardware resources settings according to Hardware Type and Hardware Configuration
are described below:

Hardware Type 3 (<hw>=3), or

Hardware Configuration 30 (<hw>=30)

Hardware setup
AR6220-G Embedded Module
compatibility
<hw> 3
<bus_type> 1
<bus_number> 2
<on_off> 101 (Internal GPIO)
<reset> 100 (Internal GPIO)
<gps_wakeup> 65535 (Not managed)

4115730 Rev 5.0 March 26, 2015 138

 Extended AT Commands Manual Location Library Commands

Hardware Type 3 (<hw>=3), or

Hardware Configuration 30 (<hw>=30)

<host_wakeup> 65535 (Not managed)

<clock32k> 1
<appli_led> 65535 (Not managed)
Note: That configuration is fixed for AR6220-G Embedded Module.

4.2.3. Command +GPSSTOP

4.2.3.1. Description
This AT command stops the Location Services.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.
GPS Data are stored to NV memory during specific Location Services Application transitions.

4.2.3.2. Syntax

Action command
AT+GPSSTOP

OK

Test command
AT+GPSSTOP=?
OK

Unsolicited response
+GPSEVSTOP: <status>

4.2.3.3. Parameters and Defined Values

<status> Event status

0 The action has failed. Application state is unchanged.

1 The action has been successfully completed.

4115730 Rev 5.0 March 26, 2015 139

 Extended AT Commands Manual Location Library Commands

4.2.3.4. Examples

Command Responses

AT+GPSSTOP OK
+GPSEVSTOP: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSSTOP=?
OK

4.2.4. Command +GPSSLEEP

4.2.4.1. Description
This AT command puts the GPS receiver into the specified GPS sleep mode.
This command stops the GPS processing and put the GPS receiver in a low power mode. This
consumes slightly more power than complete off mode, but allows faster restarts when the GPS is
restarted with the +GPSSTART command.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.
GPS Data are stored to NV memory during specific Location Services Application transitions.
Note: [] gpsOne: +GPSSLEEP AT command is supported but without effect on power consumption.

4.2.4.2. Syntax

Action command
AT+GPSSLEEP = [<sleep_mode>]

OK

Read command
AT+GPSSLEEP?
+GPSSLEEP:<sleep_mode>
OK

Test command
AT+GPSSLEEP=?

4115730 Rev 5.0 March 26, 2015 140

 Extended AT Commands Manual Location Library Commands

+GPSSLEEP: (list of supported <sleep_mode>s)

OK

Unsolicited response
+GPSEVSLEEP: <status>

4.2.4.3. Parameters and Defined Values

<sleep_mode>: GPS sleep mode

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 1.
5.

0 GPS Idle mode

6.

1 GPS Hibernate mode

7.

2 GPS Deep Sleep mode

<status> Event status

0 The action has failed. Application state is unchanged.

1 The action has been successfully completed.

Note: [] For XM0110 and SiRFV: GPS 3D fix is needed to switch in IDLE mode. If 20 seconds after the
command was sent, if the GPS receiver has not been capable to switch to IDLE mode, the event
+GPSEVSLEEP: 0 will be received.

4.2.4.4. Examples

Command Responses

AT+GPSSLEEP OK
+GPSEVSLEEP: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSSLEEP=? +GPSSLEEP: (0-2)

OK

4115730 Rev 5.0 March 26, 2015 141

 Extended AT Commands Manual Location Library Commands

4.2.5. Command +GPSTTFF

4.2.5.1. Description
This command reports the calculated TTFF (2-Dimensional Position Fix and 3-Dimensional Position
Fix) of the last run if no new run has started, an error if the current run has no fix yet, or the calculated
TTFF of this run if it has fixed.
Note: 2D TTFF value can be equal to 3D TTFF value if 3-Dimensional Position is directly fixed. This is
subjected to GPS conditions.
Note: GPS_ERR_GPS_POS_NOT_FIXED (-30) is returned if the current run is not fixed.

4.2.5.2. Syntax

Read command
AT+GPSTTFF?
+GPSTTFF:<2D_time>,<3D_time>
OK

Test command
AT+GPSTTFF=?
OK

4.2.5.3. Parameters and Defined Values

<2D_time>: 2-Dimensional Position Time To First Fix, defined in ms.

<3D_time>: 3-Dimensional Position Time To First Fix, defined in ms.

4.2.5.4. Examples

Command Responses

AT+GPSTTFF? +GPSTTFF: 32051,32051

OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSTTFF? +GPSTTFF: -30,-30

OK
Note: The current run is not fixed.

4115730 Rev 5.0 March 26, 2015 142

 Extended AT Commands Manual Location Library Commands

Command Responses

AT+GPSTTFF=? OK

4.2.6. Command +GPSRELEASE

4.2.6.1. Description
This AT Command releases the Location Services hardware and software resources.
OK is returned if the request has been processed. The final result will be sent to the associated event
through an unsolicited response after the action has been completed.

4.2.6.2. Syntax

Action command
AT+GPSRELEASE

OK

Test command
AT+GPSRELEASE=?
OK

Unsolicited response
+GPSEVRELEASE: <status>

4.2.6.3. Parameters and Defined Values

<status> Event status

0 The action has failed. Application state is unchanged.

1 The action has been successfully completed.

4115730 Rev 5.0 March 26, 2015 143

 Extended AT Commands Manual Location Library Commands

4.2.6.4. Examples

Command Responses

AT+GPSRELASE OK
+GPSEVRELEASE: 1
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSRELEASE=?
OK

4.2.7. Command +GPSVERS

4.2.7.1. Description
This AT Command reports the Software Version of the Location AT command set.

4.2.7.2. Syntax

Read command
AT+GPSVERS?
+GPSVERS:<version>
OK

Test command
AT+GPSVERS=?
OK

4.2.7.3. Parameters and Defined Values

<version>: Location Services version including:

 AT command set version
 Location Library version
 GPS receiver firmware and/or patch version

Note: [] gpsOne: GPS receiver firmware version is not provided.

4115730 Rev 5.0 March 26, 2015 144

 Extended AT Commands Manual Location Library Commands

4.2.7.4. Examples

Command Responses

AT+GPSVERS? +GPSVERS: “Location Services version string”

OK
or
+GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSVERS=?
OK

4.2.8. Command +GPSCONF

4.2.8.1. Description
This AT command configures the Location service and GPS receiver.

4.2.8.2. Syntax

Action command
AT+GPSCONF= <config_type>,<config_value>
OK

Read command
AT+GPSCONF?
+GPSCONF: <config_type>,<config_value>
[+GPSCONF: <config_type>,<config_value>]
OK

Test command
AT+GPSCONF=?
+GPSCONF:<config_type>,(list of supported <config_value>s)
[+GPSCONF:<config_type>,(list of supported <config_value>s)]
OK

4115730 Rev 5.0 March 26, 2015 145

 Extended AT Commands Manual Location Library Commands

4.2.8.3. Parameters and Defined Values

<config_type>: This parameter specifies the configuration type on which the configuration value is
applied.

0 Sets GPS navigation low power modes. Reduces power consumption while in
GPS_RUNNING state without impacting update rate, but at the expense of GPS
accuracy degradation. Please refer to [2] for more details about the navigation low
power modes.

[] Not supported for gpsOne.

1 Sets the LNA type.

[] Not supported for gpsOne.

2 Specifies the GPS Aiding mode.

Caution: This configuration type is deprecated. Please refer to +GPSAID AT

command for aiding modes configuration.

3 Configures the host Wakeup software mechanism allowing the Location Library to
be compatible with the Embedded Module sleep mode.

[] Not supported for gpsOne.

4 Defines the banking time. This option is used only for debug purpose.

[] Not supported for gpsOne.

5 Defines the targeted Reduced Rate GPS Navigation in seconds.

[] Not supported for gpsOne.

6 Defines Blanking configuration.

[] Not supported for gpsOne.

7 Defines CW Removal configuration.

[] Not supported for gpsOne.

8 Define if GPS feature is enabled.

[] Not supported for XM0110 and SiRFV

<config_value>: Requested value of configuration type.

For <config_type> = 0 If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0: Full power navigation mode.

1: Medium power navigation mode.

2: Low power navigation mode.

3: Very low power navigation mode.

4115730 Rev 5.0 March 26, 2015 146

 Extended AT Commands Manual Location Library Commands

For <config_type> = 1 If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 1.

0: Receive chain optimized for internal LNA, and GPS receiver LNA_EN output signal
is automatically driven.

1: Receive chain optimized for external LNA, and GPS receiver LNA_EN output signal
is automatically driven.

2: Receive chain optimized for internal LNA, and GPS receiver LNA_EN output signal
is always OFF.

3: Receive chain optimized for external LNA, and GPS receiver LNA_EN output signal
is always OFF.

For <config_type> = 2 If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0: The Aiding mode is deactivated.

1: AEE (Autonomous Extended Ephemeris) activated.

For <config_type> = 3 If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0: The host Wakeup software mechanism is disabled.

1: The host Wakeup software mechanism is enabled.

For <config_type> = 4 Specifies the number of seconds to wait before disabling AEE calculation.
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: -1.If -1, the banking time is not taken account.
If 0, the AEE calculation will be stopped immediately.

For <config_type> = 5 Defines the targeted Reduced Rate GPS Navigation in seconds.
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 1.

For <config_type> = 6 Defines Blanking configuration.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0: TX Blanking disabled.

1: TX Blanking activated.

For <config_type> = 7 Defines CW Removal configuration.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.

4115730 Rev 5.0 March 26, 2015 147

 Extended AT Commands Manual Location Library Commands

Factory default value: 0.

0: CW Removal feature disabled

1: CW Removal feature enabled

For <config_type> = 8 Defines if GPS feature is enabled.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information. If value has been changed,
+GPSSAVE=1 AT Command must be send, and reset must be issued after
using this command.
Factory default value: 1.

Note: [] gpsOne: RESET must be issued after this option is configured.

0: GPS feature disabled

1: GPS feature enabled

Note: For <config_type>3 (host Wakeup software mechanism configuration), the host Wakeup external
interrupt input must be specified through the +GPSINIT AT command before the activation of this option,
otherwise the error GPS_ERR_SERVICE (-26) will be returned by the +GPSCONF AT command.
Note: For <config_type>=4, the value is applied at each +GPSSTART AT command. Therefore the banking
time is reinitialized for GPS_INITIALIZED & GPS_SLEEP state to GPS_RUNNING state transition.
Note: For <config_type>=5, <config_value> defines the targeted Reduced Rate GPS Navigation. The applied
Rate GPS Navigation can be lower than targeted value in order to maintain best GPS navigation
conditions. Applied Rate GPS Navigation depends on GPS conditions and could be changed
automatically from minimum value (1 second) to targeted <config_value>.
Note: For <config_type>=5, <config_value> impacts NMEA frames update rate specified by +GPSNMEA AT
command, PVT frames update rate specified by +GPSPVT AT command and Core information update
rate specified by +GPSCORE AT command as those options are based on this Reduced Rate GPS
Navigation. For example, if <config_value> is equal to 2, the NMEA frames update rate and PVT frames
update rate will be typically doubled.
Note: For <config_type>=6, the blanking is automatically disabled every time the state machine goes to
GPS_RUNNING.
Note: For <config_type>=7, for [] XM0110, the setting of CW removal is automatically disabled every time the
state machine goes to GPS_RUNNING. The user has to set it again a few seconds after start event. This
parameter is not restored by the +GPSSAVE AT Command.

4.2.8.4. Location Service Configuration Restrictions

Some options cannot be configured while in GPS_RUNNING state, or in GPS_SLEEP state
depending on the GPS sleep mode. In this case, GPS_ERR_BAD_STATE is returned by the
+GPSCONF AT command.
Restrictions are listed in the table below:

4115730 Rev 5.0 March 26, 2015 148

 Extended AT Commands Manual Location Library Commands

GPS_HIBERNATE_MODE
Option

GPS_INITIALIZED
GPS_IDLE_MODE
GPS_RUNNING

GPS_SLEEP /

GPS_SLEEP /
<config_type> = 0 (Nav mode) Allowed Allowed Allowed Allowed

<config_type> = 1 (LNA type) Not allowed Not allowed Allowed Allowed

<config_type> = 2 (Aiding
Not allowed Not allowed Allowed Allowed
mode)

<config_type> = 3 (Host
Not allowed Not allowed Allowed Allowed
wakeup)

<config_type> = 4 (Banking
Not allowed Not allowed Allowed Allowed
time)

<config_type> = 5 (Reduced
Allowed Allowed Allowed Allowed
Rate)

<config_type> = 6 (Blanking) Allowed Allowed Allowed Allowed

<config_type> = 7 (CW
Allowed Not allowed Not allowed Not allowed
removal) for [] XM0110

<config_type> = 7 (CW
Allowed Allowed Allowed Allowed
removal) for [] SiRFV

<config_type> = 8 (GPS
Allowed Allowed Allowed Not allowed
enabled)

4.2.8.5. Examples

Responses for Responses for

Command
[  ] XM0110 and SiRFV [  ] gpsOne

AT+GPSCONF=0,0 OK OK
or or
Note: request continuous navigation +GPS ERROR: X +GPS ERROR: X
mode.
Note: For more information about X Note: For more information about X
value, please refer to Location AT value, please refer to Location AT
commands error codes description. commands error codes description.

4115730 Rev 5.0 March 26, 2015 149

 Extended AT Commands Manual Location Library Commands

Responses for Responses for

Command
[  ] XM0110 and SiRFV [  ] gpsOne

AT+GPSCONF=? +GPSCONF: 0,(0-3)

+GPSCONF: 1,(0-1)
+GPSCONF: 2,(0-1)
+GPSCONF: 3,(0-1)
+GPSCONF: 8,(0-1)
+GPSCONF: 4,(0-FFFFFFFF)
OK
+GPSCONF: 5,(1-10)
+GPSCONF: 6,(0-1)
+GPSCONF: 7,(0-1)
OK

AT+GPSCONF? +GPSCONF: 0,0

+GPSCONF: 1,1
Note: Allow to retrieve the current +GPSCONF: 2,0
default configuration.
+GPSCONF: 3,0
+GPSCONF: 8,0
+GPSCONF: 4,-1
OK
+GPSCONF: 5,1
+GPSCONF: 6,0
+GPSCONF: 7,0
OK

4.2.9. Command +GPSDEBUG

4.2.9.1. Description
This AT command configures the debug mode and the output port of the debug data.

Note: [] +GPSDEBUG AT command is not supported for gpsOne.

4.2.9.2. Syntax

Action command
AT+GPSDEBUG= <output>,<debug_data>

OK

4115730 Rev 5.0 March 26, 2015 150

 Extended AT Commands Manual Location Library Commands

Read command
AT+GPSDEBUG?
+GPSDEBUG: <output>,<debug_data>
OK

Test command
AT+GPSDEBUG=?
+GPSDEBUG: (list of supported <output>s),(list of supported <debug_data>s)
OK

4.2.9.3. Parameters and Defined Values

<output>: This parameter specifies the port which is to be used by the application to transmit
the raw data. (Hexadecimal value entered without the prefix “0x”).
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0 Debug data output disabled.

1 Debug data output on UART 1.

2 Debug data output on UART 2.

3 Debug data output on USB.

5 Debug data frames output on UART 3.

0x1X CMUX virtual port, Logical ports over UART1 where 1 <= X <=4

0x2X CMUX virtual port, Logical ports over UART2 where 1 <= X <=4

0x5X CMUX virtual port, Logical ports over UART3 where 1 <= X <=4

<debug_data>: Debug mode configuration.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0 Debug data disabled.

(1<<0) Raw data activated. The raw data are used only for GPS debug purpose.

(1<<1) Debug Core information activated. The debug core information is used only for
debug purposes.
Debug Core information is received through Developer Studio Trace level 2.

(1<<2) Test Mode information activated.

Note: Reserved for future use.

4115730 Rev 5.0 March 26, 2015 151

 Extended AT Commands Manual Location Library Commands

Note: Raw data output, due to its binary format, requires the use of the port in the exclusive online mode. No
AT command can be entered or received on same port The specified port (<output> parameter) must
then be different from the port which is to be used by the application to transmit the NMEA frames
(configured by the +GPSNMEA command).
Note: The production mode must be set to receive consistent Raw Data flow. Consequently, Raw Data and
Debug Core information (received through Developer Studio Trace level 2) cannot be received
simultaneously.

4.2.9.4. Examples

Command Responses

AT+GPSDEBUG=3,1 OK
or
Note: request raw data output on port 3 (USB). +GPS ERROR: X
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSDEBUG=3,0 OK
or
Note: disable raw data output. +GPS ERROR: X
Note: For more information about X value, please refer to Location AT
command error codes description.

AT+GPSDEBUG=0,2 OK
or
Note : Activates Debug Core Information on +GPS ERROR: X
Developer Studio Traces.
Note: For more information about X value, please refer to Location AT
command error codes description.

AT+GPSDEBUG=? +GPSDEBUG: (0-5,11-14,21-24,51-54),(0-7)

OK

AT+GPSDEBUG?
+GPSDEBUG: 0,0

Note: Allow to retrieve the current default OK

configuration.

4.2.10. Command +GPSAID

4.2.10.1. Description of Aiding for XM0110 and SiRFV

This AT command activates and configures the Aiding modes.

4115730 Rev 5.0 March 26, 2015 152

 Extended AT Commands Manual Location Library Commands

4.2.10.1.1. Autonomous Extended Ephemeris

AEE (Autonomous Extended Ephemeris) is a powerful feature available without any extra hardware,
connectivity or cost. If activated, the Autonomous Extended Ephemeris feature will automatically
compute the Extended Ephemeris for each newly received satellite Broadcast Ephemeris.
GPS Data are stored to NV memory during specific Location Services Application transition.

4.2.10.1.2. Downloaded Extended Ephemeris

DEE (Downloaded Extended Ephemeris) improves start-up GPS performance by employing Extended
Ephemeris data. The Extended Ephemeris data can be either downloaded from an Extended
Ephemeris server or stored into file system, then injected in order to outlast a standard broadcast
ephemeris.
The bearer should be managed through the Internet Application AT command interface.
The communication socket is managed by Location Library. Related errors are returned by the
+GPSEVAID and +GPSEVAIDERROR events.
GPS Data are stored to NV memory during specific Location Services Application transition.

4.2.10.2. Description of Aiding for gpsOne

This AT command activates and configures the Aiding modes.

4.2.10.2.1. Foreword
Intention has been to limit as much as possible the Location Library GPS Aiding Service AT
commands changes while porting to gpsOne GPS solution. As a consequence some terminology
may not be as accurate as it could be when considering gpsOne iso XM010/SiRFV GPS solution. For
example, “Assistance data” or “Predicted Orbit data” would have been more appropriate than
Downloaded Extended Ephemeris as in gpsOne case those data are not only Ephemeris.

4.2.10.2.2. Downloaded Extended Ephemeris

DEE (Downloaded Extended Ephemeris) improves start-up GPS performance by employing Extended
Ephemeris data. The Extended Ephemeris data should be downloaded from an Extended Ephemeris
server and outlast a standard broadcast ephemeris.
GpsOne GPS solution supports DEE thru the gpsOne XTRA feature.
In order to compute a position XTRA requires 1°) XTRA servers that provide assistance data so called
XTRA data and 2°) the ability to acquire GPS satellites in order to compute a position (No Satellites
then NO Fix).

4.2.10.2.2.1. Server and Assistance data download

Three servers are provided (URLs set by default) so that the requests are load balanced. XTRA
Servers and XTRA data are fully hosted by QCT and provided as free service.
XTRA Data is downloaded using an http get as a binary file that must be injected into the gpsOne
GPS Engine.

4115730 Rev 5.0 March 26, 2015 153

 Extended AT Commands Manual Location Library Commands

4.2.10.2.2.2. Both bearer and communication socket management are encapsulated

within Location Library. Assistance data validity

XTRA Data is valid for seven days.

4.2.10.2.2.3. Assisted GPS operation using gpsOneXTRA

GpsOneXTRA feature must be enabled on the device.

The assistance data is stored in the NV memory of Embedded Module for later use.
While the XTRA download/injection is in progress, the standalone fix will continue to be processed. If
the XTRA download/injection fails, the standalone fix in progress may still return successful if
satellites are acquired during the standalone search.

Note: []gpsOne – SL3010T: file system is used for gpsOneXTRA feature. When DEE is downloaded, a file
“xtra.bin” is created in “\location” folder. This file should not be removed as it is used in injection process.

4.2.10.3. Syntax
 For <config_type> = 0

Action command
AT+GPSAID=<config_type>,<aee_mode>
OK

 For <config_type> = 1

Action command
AT+GPSAID=<config_type>,<dee_mode>[, [<dee_period>] [,[<dee_server_address>]
[,[<dee_server_port>]
[,[<dee_server_code>][,[<dee_socket_type>][,[<dee_timeout>]]]]]]]
OK

 For <config_type> = 2

Action command
AT+GPSAID=<config_type>,<dee_command>
OK

 For <config_type> = 3 and <dee_server_type>=1

Action command
AT+GPSAID=<config_type>,<dee_server_type>,<dee_secondary_server_addr
ess>,<dee_tertiary_server_address>
OK
 For <config_type> = 3 and <dee_server_type>=2

Action command
AT+GPSAID=<config_type>,<dee_server_type>,<dee_primary_sntp_server_a
ddress>,<dee_secondary_sntp_server_address>,<dee_tertiary_sntp_serve
r_address>
OK

4115730 Rev 5.0 March 26, 2015 154

 Extended AT Commands Manual Location Library Commands

Read command
AT+GPSAID?
+GPSAID: 0,<aee_mode>
+GPSAID: 1,<dee_mode>,
<dee_period>,<dee_server_address>,<dee_server_port>,<dee_server_code>,<dee_socket_t
ype>,<dee_timeout>
+GPSAID: 2,<dee_command>
+GPSAID: 3,1,<dee_secondary_server_address>,<dee_tertiary_server_address>
+GPSAID:
3,2,<dee_primary_sntp_server_address>,<dee_secondary_sntp__server_address>,
<dee_tertiary_sntp_server_address>
OK

Test command
AT+GPSAID=?
+GPSAID: 0,(list of supported <aee_mode>s)
+GPSAID: 1,(list of supported <dee_mode>s),(list of supported <dee_period>s),(list
of supported <dee_server_address>s),(list of supported <dee_server_port>s), (list
of supported <dee_server_code>s),(list of supported <dee_socket_type>s),(list of
supported <dee_timeout>s)
+GPSAID: 2,(list of supported <dee_command>s)
+GPSAID: 3,1,(list of supported <dee_secondary_server_address>s),(list of
supported <dee_tertiary_server_address>s)
+GPSAID: 3,2,(list of supported <dee_primary_sntp__server_address>s),(list
of supported <dee_secondary_sntp_server_address>s),(list of supported
<dee_tertiary_sntp_server_address>s)
OK

4.2.10.4. Parameters and Defined Values

<config_type>: This parameter specifies the configuration type on which the configuration is applied.

0 AEE configuration.

1 DEE configuration.

2 DEE command.

3 DEE server addresses configuration.

<aee_mode>: This parameter specifies the AEE (Autonomous Extended Ephemeris) mode.
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

Note: [] AEE is not supported for gpsOne.

0: AEE is deactivated.

4115730 Rev 5.0 March 26, 2015 155

 Extended AT Commands Manual Location Library Commands

1: AEE is activated.

<dee_mode>: This parameter specifies the DEE (Downloaded Extended Ephemeris) mode.
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

Note: [] gpsOne: RESET must be issued after this option is configured.

0: DEE is deactivated.

1: DEE is activated.

<dee_period> DEE period in day(s).

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: 3.
[] gpsOne: Factory default value: 7.
Note: Note: Returns error “- 4” (GPS_ERR_NOT_AVAILABLE) if requested
value is not supported.

Range: 0-65535

<dee_server_address> DEE server address.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: “”.
[] gpsOne: Factory default value: “http://xtra1.gpsonextra.net/xtra.bin”.

Note: [] gpsOne: URL must be complete, including the “http://”.

Can be either a DNS address, or a numeric one in the form “xxx.xxx.xxx.xxx”.

Maximum 80 bytes string.

<dee_secondary_server DEE secondary server address.

_address>
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: “”.
[] gpsOne: Factory default value: “http://xtra2.gpsonextra.net/xtra.bin”.

Note: [] XM0110 and SiRFV: parameter not supported.

Note: [] gpsOne: URL must be complete, including the “http://”.

Can be either a DNS address, or a numeric one in the form “xxx.xxx.xxx.xxx”.

Maximum 80 bytes string.

<dee_tertiary_server_ad DEE tertiary server address.

dress>
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: “”.
[] gpsOne: Factory default value: “http://xtra3.gpsonextra.net/xtra.bin”.

Note: [] XM0110 and SiRFV: parameter not supported.

Note: [] gpsOne: URL must be complete, including the “http://”.

Can be either a DNS address, or a numeric one in the form “xxx.xxx.xxx.xxx”.

4115730 Rev 5.0 March 26, 2015 156

 Extended AT Commands Manual Location Library Commands

Maximum 80 bytes string.

<dee_server_sntp_addre DEE SNTP server address.

ss>
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: “”.
[] gpsOne: Factory default value: “xtra1.gpsonextra.net”.

Note: [] XM0110 and SiRFV: parameter not supported.

Can be either a DNS address, or a numeric one in the form “xxx.xxx.xxx.xxx”.

Maximum 80 bytes string.

<dee_secondary_sntp_s DEE secondary SNTP server address.

erver_address>
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: “”.
[] gpsOne: Factory default value: “xtra2.gpsonextra.net”.

Note: [] XM0110 and SiRFV: parameter not supported.

Can be either a DNS address, or a numeric one in the form “xxx.xxx.xxx.xxx”.

Maximum 80 bytes string.

<dee_tertiary_sntp_serv DEE tertiary SNTP server address.

er_address>
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV: Factory default value: “”.
[] gpsOne: Factory default value: “xtra3.gpsonextra.net”.

Note: [] XM0110 and SiRFV: parameter not supported.

Can be either a DNS address, or a numeric one in the form “xxx.xxx.xxx.xxx”.

Maximum 80 bytes string.

<dee_server_port> Port of the DEE server socket to connect to.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

Note: [] gpsOne: Not used. Read only parameter. Returns

GPS_ERR_NOT_AVAILABLE (- 4) error if option is configured.
Range: 0 – 65535

<dee_server_code> DEE access authorization code.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: “”.

Note: [] gpsOne: Not used. Read only parameter. Returns

GPS_ERR_NOT_AVAILABLE (- 4) error if option is configured.
DEE access authorization code in the form “XXXXXXXXXX”.
Maximum 80 bytes string.

<dee_socket_type> DEE communication socket type.

If omitted: last known value within current session. Please refer to Diagram for

4115730 Rev 5.0 March 26, 2015 157

 Extended AT Commands Manual Location Library Commands

settings management for more information.

Factory default value: “TCP”.

Note: [] gpsOne: Not used. Read only parameter. Returns

GPS_ERR_NOT_AVAILABLE (- 4) error if option is configured.
“TCP” for TCP communication socket.
Maximum 10 bytes string.

<dee_timeout> Socket connection timeout value in second(s).

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
[] XM0110 and SiRFV factory default value: 10.
[] gpsOne factory default value: 30.
Range: 0 – 65535

<dee_command> DEE command number controlling the EE downloader.

If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0: This command has no effect, but indicates that no command is pending.

1: This command requests EE file download from a remote source and its injection.

2: This command stops EE download/injection if any.

Note: [] gpsOne: That command is not implemented. EE download is not

aborted even if +GPSEVAID event indicating that EE download is
aborted will be received after that command.

3: This command forces EE file download from a remote source and its injection.
This command is used only for test purpose.

Note: [] gpsOne: That command is not supported and result will be similar to
<dee_command>=1.
4 This command forces EE file injection from a local source. The requirements
applied to that file are listed below:
- Files to be injected have to be stored in file system in “\location\fileName” path.
- DEE Validity of the file has to be coherent with parameter <dee_period>.
- In case of multi-constellations solution, there must be at least one DEE file
matching with the active constellations. If not,
GPS_AIDING_DEE_FILE_ERROR (-14) is raised
[] gpsOne – SL3010T: “FileName” must be “xtra.bin”.
[] SiRFV: “FileName” must have this form: XXX_YY.dee, with XXX the
constellation (GPS for GPS constellation and GLO for GLONASS constellation)
and YY the DEE validity in days (always coded on two digits and filled with a
preceding zero for single digit validity). For example, “FileName” can be
“GPS_07.dee”, or “GLO_14.dee”

Note: [] XM0110 and gpsOne – SL808xT, that command is not supported

<dee_server_type>: This parameter specifies the DEE server type on which the configuration is
applied.
Note: The main DEE server address is configured through the
<dee_server_address> parameter.
1: DEE Data Server(s)

2: DEE SNTP Server(s)

Note: If <dee_period> is not supported, the error GPS_ERR_INVALID_PARAMETER (-4) is returned.

Note: Before <dee_command> configuration, <dee_mode> should be activated

4115730 Rev 5.0 March 26, 2015 158

 Extended AT Commands Manual Location Library Commands

Note: [] XM0110 and SiRFV: Before <dee_command> configuration, <dee_server_xxxx> parameters should
be configured.
Note: <dee_command> = 1 allows DEE file update as described hereunder:
Note: <dee_command> is automatically configured to 0 when the DEE file is updated. If the command is
pending, for example in GPS_INITIALIZED state, the read of this parameter returns the last entered DEE
command.
Note: If a newer DEE file is available on DEE server, DEE file download is performed. If no updated DEE file is
available on the DEE server, DEE file download is aborted. Consequently, the following event is
received:
Note: [] XM0110 and SiRFV: +GPSEVAID event will be received informing that DEE download is aborted
with abort cause equal to GPS_AIDING_DEE_NACK_ERROR.
Note: [] gpsOne: +GPSEVAID event will be received informing that DEE download is aborted with abort
cause equal to GPS_AIDING_OK.
Note: Factory start (please refer to GPSSTART section) removes DEE file. To retrieve it, DEE file download
should be requested once again.

4.2.10.5. Aiding Service Configuration Restrictions

Some options cannot be configured while in some state(s). In this case, GPS_ERR_BAD_STATE is
returned by the +GPSAID AT command.
Restrictions are listed in the table below:

GPS_HIBERNATE_MODE
Option

GPS_IDLE_MODE
GPS_NITIALIZED

GPS_RUNNING

GPS_SLEEP /

GPS_SLEEP /
<config_type> = 0 (AEE configuration) Allowed Not allowed Not allowed Allowed

<config_type> = 1 (DEE configuration) Allowed Not allowed Not allowed Allowed

[] For XM0110 and SiRFV:

Authorized (1) Allowed Allowed Authorized (1)
<config_type> = 2 (DEE command)

[] For gpsOne:

Allowed Allowed Allowed Allowed
<config_type> = 2 (DEE command)

[] For XM0110 and SiRFV: <config_type>

= 3 not supported.
Allowed Not allowed Not allowed Allowed
<config_type> = 3 (DEE server addresses
configuration)

(1) In this state that AT command is authorized but the configuration will become effective in “Allowed” state.

4115730 Rev 5.0 March 26, 2015 159

 Extended AT Commands Manual Location Library Commands

4.2.10.6. Examples

Command Responses

AT+GPSAID=0,1 OK
or
Note: activates the AEE mode. +GPS ERROR: X
Note: For more information about X value, please refer to Location AT commands error
codes description.

AT+GPSAID=1,1 OK
or
Note: activates the DEE mode. +GPS ERROR: X
Note: For more information about X value, please refer to
Location AT commands error codes description.

AT+GPSAID=2,1 OK
or
Note: requests EE file download. +GPS ERROR: X
Note: For more information about X value, please refer to
Location AT commands error codes description.

AT+GPSAID=? +GPSAID: 0,(0-1)

+GPSAID: 1,(0-1),(0-65535),””,(0-65535),””,(“TCP”),(0-65535)
+GPSAID: 2,(0-4)
+GPSAID: 3,1,””,””
+GPSAID: 3,2,””,””,””
OK

AT+GPSAID? +GPSAID: 0,0

+GPSAID: 1,1,3,”ServerAddress”,0,”ServerAuthCode”,TCP,10
Note: Allow to retrieve the +GPSAID: 2,0
current configuration.
+GPSAID: 3,1,”SecondaryServerAddress”,
”TertiaryServerAddress”
+GPSAID:
3,2,”PrimarySntpServerAddress”,”SecondarySntpServerAddress”,
”TertiarySntpServerAddress”
OK
Note: Example, values depending on GPS receiver type.

4115730 Rev 5.0 March 26, 2015 160

 Extended AT Commands Manual Location Library Commands

4.2.10.7. Examples of AT Command Sequence

4.2.10.7.1. XM0110 and SiRFV Aiding AT Command Sequence

4.2.10.7.1.1. From GPS_INITIALIZED state

For more information regarding “Authorized” state(s), please refer to Aiding Service Configuration
Restrictions.
AT+GPSINIT=11
OK

+GPSEVINIT: 1

AT+GPSNMEA=0
OK

AT+GPSAID=2,1
OK

AT+GPSSTART=3
OK

+GPSEVAID: 1,1

+GPSEVSTART: 1

+GPSEVPOS: 0

+GPSEVAID: 1,2

+GPSEVPOS: 2

+GPSEVPOS: 3

+GPSEVAID: 1,4,0,3720
…

4.2.10.7.1.2. From GPS_RUNNING state

For more information regarding “Allowed” state(s), please refer to Aiding Service Configuration
Restrictions.
AT+GPSINIT=11
OK

+GPSEVINIT: 1

4115730 Rev 5.0 March 26, 2015 161

 Extended AT Commands Manual Location Library Commands

AT+GPSNMEA=0
OK

AT+GPSSTART=3
OK

+GPSEVSTART: 1

+GPSEVPOS: 0

AT+GPSAID=2,1
OK

+GPSEVAID: 1,1

+GPSEVAID: 1,2

+GPSEVPOS: 2

+GPSEVPOS: 3

+GPSEVAID: 1,4,0,3720
…

4.2.10.7.2. GpsOne Aiding AT Command Sequence

AT+GPSSAVE=0 /* reset the whole of gps settings */

AT+CFUN=1 or HW reset

AT+GPSINIT=2

+GPSEVINIT: 1

AT+GPSAID=1,1

AT+GPSSAVE=1 /* save gps settings */

AT+CFUN=1 (or HW reset)

/* GPRS bearer Configuration / Activation */

AT+GPSAID=2,1

4115730 Rev 5.0 March 26, 2015 162

 Extended AT Commands Manual Location Library Commands

+GPSEVAID: 1,2

+GPSEVAID: 1,4,1,yy/MM/dd,hh:mm:ss,yy/MM/dd,hh:mm:ss

AT+GPSSTART=3
OK

+GPSEVSTART: 1

+GPSEVPOS: 0

+GPSEVPOS: 3
…

4.2.11. Command +GPSCORE

4.2.11.1. Description
This AT command configures core information mode and the output port of the core information.

Note: [] +GPSCORE AT command is not supported for gpsOne.

4.2.11.2. Syntax

Action command
AT+GPSCORE=[<output>][,[<rate>][,<core_info>]]

OK

Read command
AT+GPSCORE?
+GPSCORE: <output>,<rate>,<core_info>
OK

Test command
AT+GPSCORE=?
+GPSCORE: (list of supported <output>s) ,(list of supported <rate>s)
,(list of supported <core_info>s)
OK

4115730 Rev 5.0 March 26, 2015 163

 Extended AT Commands Manual Location Library Commands

4.2.11.3. Parameters and Defined Values

<output>: This parameter specifies the port to be used by the application to transmit the core
information. (Hexadecimal value entered without the prefix “0x”).
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

0 Core information output disabled.

1 Core information output on UART 1.

2 Core information output on UART 2.

3 Core information output on USB.

4 Core information output on port where the +GPSCORE command was received.

5 Core information frames output on UART 3.

0x1X CMUX virtual port, Logical ports over UART1 where 1 <= X <=4

0x2X CMUX virtual port, Logical ports over UART2 where 1 <= X <=4

0x5X CMUX virtual port, Logical ports over UART3 where 1 <= X <=4

<rate>: This parameter defines the core information update rate in seconds.
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 1.
Range: 0-65535

Note: If this parameter equals 0, the core information frames will be sent only
once, on the next occurrence of the core information frames update.
Note: This parameter is impacted by the Reduced Rate GPS Navigation.
Please refer to +GPSCONF AT command for more information.
<core info>: Core information list encode mask. Hexadecimal value entered without the prefix
“0x”.
If omitted: last known value within current session. Please refer to Diagram for
settings management for more information.
Factory default value: 0.

(0<<0): Core information data output disabled.

(1<<0): Information about jammers detection activated.

[]< rate> parameter for this <core info> has no effect on SiRFV.

Note: Core information is received through +GPSEVCORE asynchronous event. Please refer to Asynchronous
Events for more information.

4115730 Rev 5.0 March 26, 2015 164

 Extended AT Commands Manual Location Library Commands

4.2.11.4. Examples

Command Responses

AT+GPSCORE=1,1,1 OK
or
Note: request jammers detection information +GPS ERROR: X
output on port 1.
Note: For more information about X value, please refer to Location AT
commands error codes description.

AT+GPSCORE=1,1,0 OK
or
Note: disable core information output. +GPS ERROR: X
Note: For more information about X value, please refer to Location AT
command error codes description.

AT+GPSCORE=? +GPSCORE: (0-5,11-14,21-24,51-54),(1-65535),(0-

1)
OK

AT+GPSCORE?
+GPSCORE: 0,1,0

Note: Allow to retrieve the current default OK

configuration.

4.2.11.5. Examples of AT Command Sequence

AT+GPSINIT=11
OK

+GPSEVINIT: 1

AT+GPSNMEA=0
OK

AT+GPSCORE=1,1,1
OK

AT+GPSSTART=3
OK

+GPSEVSTART: 1

+GPSEVPOS: 0

4115730 Rev 5.0 March 26, 2015 165

 Extended AT Commands Manual Location Library Commands

+GPSEVCORE: 0,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00,1575,65

+GPSEVCORE: 0,1575,77,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00

+GPSEVCORE: 0,1575,76,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00

+GPSEVCORE: 1,602,73,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00,0000,00

Note: [] +GPSEVCORE event with GLONASS information is only available on SiRFV

4.3. Asynchronous Events

The asynchronous events inform about Location Services events.

4.3.1. Description
The following asynchronous events can be received as unsolicited responses:
+GPSEVABORT: Following error detection, the Location Services are aborted and the application is
stopped. After this event the application state is automatically changed to GPS_INITIALIZED.
+GPSEVERROR: An error has been detected. Please refer to Location AT commands error codes for
more details.
+GPSEVAID: Describes Aiding events and related information.
+GPSEVAIDERROR: An error has been detected for Aiding modes. Please refer to Aiding Event
Error Codes for more details.
The others events are associated to the following AT Commands described in this document:
+GPSINIT, +GPSSTART, +GPSSTOP, +GPSSLEEP and +GPSRELEASE.

4.3.2. Syntax
Unsolicited response
+GPSEVPOS: <pos_event>

Unsolicited response
+GPSEVABORT: <abort_cause>

4115730 Rev 5.0 March 26, 2015 166

 Extended AT Commands Manual Location Library Commands

Unsolicited response
+GPSEVERROR: <error>,<ext_error>

Unsolicited response
+GPSEVINIT: <status>

Unsolicited response
+GPSEVSTART: <status>

Unsolicited response
+GPSEVSTOP: <status>

Unsolicited response
+GPSEVSLEEP: <status>

Unsolicited response
+GPSEVRELEASE: <status>

4115730 Rev 5.0 March 26, 2015 167

 Extended AT Commands Manual Location Library Commands

Unsolicited response
+GPSEVAID: <aid_mode>,<aid_event>

 For <aid_mode> = 0 and <aid_event> = 2

Unsolicited response
+GPSEVAID: <aid_mode>,<aid_event>,<aee_svid>,<aee_svValidity>

 For <aid_mode> = 1 and <aid_event> = 3

Unsolicited response
+GPSEVAID: <aid_mode>,<aid_event>,<dee_abort_cause>

 For <aid_mode> = 1 and <aid_event> = 4 and <dee_validity_format> = 0

Unsolicited response
+GPSEVAID: <aid_mode>,<aid_event>,<dee_validity_format>,<dee_validity_duration>

 For <aid_mode> = 1 and <aid_event> = 4 and <dee_validity_format> = 1

Unsolicited response
+GPSEVAID:
<aid_mode>,<aid_event>,<dee_validity_format>,<dee_validity_start>,<dee_validity_end
>

Unsolicited response
+GPSEVAIDERROR: <aid_error>,<aid_ext_error>

 For <core_info> = 0

Unsolicited response
+GPSEVCORE:
<core_info>,<jam_freq_1>,<jam_lev_1>,<jam_freq_2>,<jam_lev_2>,<jam_freq_3>,<jam_lev
_3>,<jam_freq_4>,<jam_lev_4>,<jam_freq_5>,<jam_lev_5>,<jam_freq_6>,<jam_lev_6>,<jam
_freq_7>,<jam_lev_7>,<jam_freq_8>,<jam_lev_8>

Note: [] +GPSEVCORE event is not supported for gpsOne.

4115730 Rev 5.0 March 26, 2015 168

 Extended AT Commands Manual Location Library Commands

4.3.3. Parameters and Defined Values

<error> Error number (Please refer to Location AT Application error codes)

<ext_error> Extended error code depending on <error> parameter.

This field is equal to 0 if no extended error code is available.

<pos_event>

0 The GPS fix position has been detected lost.

1 GPS fix state has been changed to estimated (i.e. forward predicted) Position.

2 GPS fix state has been changed to 2-Dimensional Position.

3 GPS fix state has been changed to 3-Dimensional Position.

4 GPS fix state has been changed to invalid Position.

<abort_cause> Error number (Please refer to Location AT Application error codes)

<status> Event status

0 The action has failed. Application state is unchanged.

1 The action has been successfully completed.

<aid_mode> GPS Aiding mode

0 Autonomous Extended Ephemeris

Note: [] AEE is not supported for gpsOne.

1 Downloaded Extended Ephemeris

<aid_event>

For <aid_mode>=0

0 AEE calculation is stopped

1 AEE calculation is started

2 AEE information

For <aid_mode>=1

0 DEE is stopped

1 DEE is started

2 DEE is valid

3 DEE is aborted

4 DEE Validity information

<aee_svid> Satellites Identifier of the last calculated Autonomous Extended Ephemeris

4115730 Rev 5.0 March 26, 2015 169

 Extended AT Commands Manual Location Library Commands

<aee_svValidity> AEE validity in minutes.

<aid_error> Error number (Please refer to Aiding event error codes).

<aid_ext_error> Extended error code depending on <aid_error> parameter.

This field is equal to 0 if no extended error code is available.
For <aid_error> = -10 (GPS_AIDING_DEE_SOCKET_ERROR), the extended
error code parameter returns the related Internet Library socket error code.

<dee_validity_format> Defines DEE validity format indicated by <dee_validity_duration> or

<dee_validity_start> / <dee_validity_end> fields.

0 DEE Validity indicated in minutes through <dee_validity_duration> field.

Note: [] Value is not supported for gpsOne.

1 DEE Validity indicated with <dee_validity_start> and <dee_validity_end>

timestamps.

Note: [] Value is not supported for XM0110 and SiRFV.

<dee_validity_duration> DEE validity in minutes.

Note: [] XM0110: That information is available if the DEE is valid and if
GPS position is known.
Note: Available for <dee_validity_format> = 0.
<dee_validity_start> DEE Validity UTC Start timestamp with the format “yy/MM/dd,hh:mm:ss”.

Note: Available for <dee_validity_format> = 1.

<dee_validity_end> DEE Validity UTC End timestamp with the format “yy/MM/dd,hh:mm:ss”.

Note: Available for <dee_validity_format> = 1.

<dee_abort_cause> DEE abort cause (Please refer to Aiding event error codes).

<core_info> Defines the core information data output.

0 Jammers detection event providing the presence of a maximum of 8

interferences detected as a result of the most recent CW scan or monitor.

Note: This event is received by the application depending on jammer(s)

detection.
<jam_freq_x> Frequency of peak “x” in MHz with 1 ≤ x ≤ 8.

<jam_lev_x> Signal to Noise of peak “x” in dB-Hz with 1 ≤ x ≤ 8.

4115730 Rev 5.0 March 26, 2015 170

 Extended AT Commands Manual Location Library Commands

4.4. Location AT Commands Error Codes

The following error codes could be returned from Location AT commands.

Table 1. Location AT commands error codes

Error Error name Description

Code

-1 GPS_ERR_BAD_STATE The function has been called in an unauthorized

application state
-2 GPS_ERR_STATE_ALREADY The requested action has been already performed and the
target application state is currently activated.
-3 GPS_ERR_INVALID_PARAMETER Invalid input parameter.
-4 GPS_ERR_NOT_AVAILABLE This feature or configuration is not available for software
and/or hardware version.
-5 GPS_ERR_STATE_TRANSITION A state transition is in progress.
-10 GPS_ERR_PORTING_LAYER_INIT The initialization of the porting layer failed (Internal error)
-11 GPS_ERR_INIT Application initialization error
-12 GPS_ERR_IO_INIT IO initialization error
-13 GPS_ERR_BUS_INIT Bus initialization error
-14 GPS_ERR_SCHED_INIT Scheduler initialization error
-15 GPS_ERR_CORE_INIT Application core software initialization error
-16 GPS_ERR_NV_MEMORY_INIT Non-Volatile memory initialization error
-20 GPS_ERR_SCHED_TASK Application task schedule error.
-21 GPS_ERR_BUS Bus error
-22 GPS_ERR_IO_MNGT IO management error
-23 GPS_ERR_CORE_LIB Application core software error
-24 GPS_ERR_NV_DATA_ACCESS Non-Volatile store media (Embedded Module FLASH
memory) access error for the GPS Non-Volatile data.
-25 GPS_ERR_INTERNAL Internal error.
-26 GPS_ERR_SERVICE The asked service is not performed.
-27 GPS_ERR_TIMEOUT Timeout error.
-30 GPS_ERR_GPS_POS_NOT_FIXED The current run is not fixed
-40 GPS_ERR_ABORT_INTERNAL Internal abort.
-41 GPS_ERR_ABORT_NMEA NMEA update rate Watchdog.
-42 GPS_ERR_ABORT_RESET Reset Watchdog.
-60 GPS_AT_ERR_INTERNAL Application internal error.
-61 GPS_AT_ERR_INVALID_PARAMETER Application invalid input parameter.
-62 GPS_AT_ERR_FLASH_DATA_ACCESS Application Flash access error.
-63 GPS_AT_ERR_PORT Application port configuration error.
-64 GPS_AT_ERR_APPLI_LED Application Led management error.
-65 GPS_AT_ERR_SCHED_TASK Application task schedule error.

4115730 Rev 5.0 March 26, 2015 171

 Extended AT Commands Manual Location Library Commands

4.5. Aiding Event Error Codes

The following error codes could be returned from Aiding Event.

Table 2. Aiding event Error Codes

Error Error name Description

Code

0 GPS_AIDING_OK No error has been detected.

-1 GPS_AIDING_AEE_ERROR AEE error has been detected.
-10 GPS_AIDING_DEE_SOCKET_ERROR Error from communication socket.
-11 GPS_AIDING_DEE_WRITE_ERROR Write error from DEE downloader.
-12 GPS_AIDING_DEE_READ_ERROR Read error from DEE downloader.
-13 GPS_AIDING_DEE_SERVER_ERROR DEE server error.
-14 GPS_AIDING_DEE_FILE_ERROR DEE file format error.
-15 GPS_AIDING_DEE_TIMEOUT_ERROR DEE timeout error.
The update of DEE file is rejected by the
-16 GPS_AIDING_DEE_NACK_ERROR
Location Library.
-17 GPS_AIDING_DEE_ACK_TIMEOUT_ERROR The DEE file acknowledgment is not received.
-18 GPS_AIDING_DEE_INTERNAL_ERROR DEE internal error has been detected.

Note: The GPS_AIDING_DEE_NACK_ERROR error is received if no updated file is available on the DEE
server. The download procedure is indeed stopped if the DDE file previously downloaded and stored to
the Non-Volatile Store media (Embedded Module FLASH memory) is identical to the available DEE file
from the DEE server.

4115730 Rev 5.0 March 26, 2015 172

 5. Security Library Commands

5.1. AT Commands Reference

The following AT commands allow the control of Security Services for basic operation.

5.1.1. Command +SSLINIT

5.1.1.1. Description
This AT command initializes the Security Library. This command must always be called as the first
command. All values are set to default, as explained in subsection 5.1.2.3.

5.1.1.2. Syntax

Action command
AT+SSLINIT

OK

Read command
AT+SSLINIT?

OK

Test command
AT+SSLINIT=?
OK

5.1.1.3. Parameters and Defined Values

There are no parameters for this AT command.

4115730 Rev 5.0 March 26, 2015 173

 Extended AT Commands Manual Security Library Commands

5.1.1.4. Examples

Command Responses

AT+SSLINIT
OK
Note: Initializes the Security Library.

5.1.2. Command +SSLSET

5.1.2.1. Description
This AT command configures the parameters for TLS/SSL connection before opening the connection.
If a parameter is not explicitly set, the default value will be used. Please note that the default values
are set to a recommended value.

5.1.2.2. Syntax
For <option> values 0, 1 and 2.

Action command
AT+SSLSET=<option>,<optionvalue>[,<password>]

OK

For all other <option> values

Action command
AT+SSLSET=<option>,<optionvalue>

OK

Read command
AT+SSLSET?
+SSLSET: <option>,<optionvalue>
[+SSLSET: <option>,<optionvalue>]
OK

Test command
AT+SSLSET=?
+SSLSET: <option>,(range for <optionvalue>)
OK

4115730 Rev 5.0 March 26, 2015 174

 Extended AT Commands Manual Security Library Commands

5.1.2.3. Parameters and Defined Values

<option> <optionvalue> Default Value

This parameter specifies the option to set. Corresponding The value

optionvalue per default
type and range

0 SSL_COPT_CERT Set the modules local string -

Certificate (local public
key). The local Certificate
file name with path is given
as a string in optionvalue.
The file must already be
present in the file system.
If the directory is protected
with a password, then this
must be provided in the
<password> variable.

1 SSL_COPT_CERT_AUTHORITY Set the Certificate string -

Authority (CA). The CA file
name with path is given as
a string in optionvalue.
The file must already be
present in the file system.
If the directory is protected
with a password, then this
must be provided in the
<password> variable.

2 SSL_COPT_PRIVATE_KEY Set the modules local string -

Private Key. The file name
with path is given as a
string in optionvalue. The
file must already be
present in the file system.
If the directory is protected
with a password, then this
must be provided in the
<password> variable.

3 SSL_COPT_SEED The random seed used for string -

the randomness of the
system.

4 SSL_COPT_VERIFY If the CA presented by the 0: do not check 1

server should be checked
or not. 1: check

5 SSL_COPT_KEY The version of 0: all 0

authentication allowed.
1: RSA
2: Ephemeral
ECDH

4115730 Rev 5.0 March 26, 2015 175

 Extended AT Commands Manual Security Library Commands

<option> <optionvalue> Default Value

6 SSL_COPT_AUTHENTICATION The version of 0: all (except 0

authentication allowed. NULL)
1: RSA
2: DSS
3: NULL

7 SSL_COPT_ENCRYPTION The version of encryption 0: all (except 0

allowed. NULL)
1: DES
2: 3DES
3: RC2
4: RC4
5: AES
6: NULL

8 SSL_COPT_MAC The version of MAC 0: all 0

allowed.
1: MD5
2: SHA1
3: SHA2

9 SSL_COPT_VERSION The version of SSL/TLS 0: all 0

allowed.
1: SSL3.0
2: TLS1.0
3: TLS1.2

10 SSL_COPT_SESSION_MODE SSL Session ID automatic 0: Off 1

usage. When possible the
underlying security 1: On.
framework will try to reuse
session, thus speeding up
the session connection.

<password> Type Default Value

The password needed to access the directory containing the file. string -

4115730 Rev 5.0 March 26, 2015 176

 Extended AT Commands Manual Security Library Commands

5.1.2.4. Examples

Command Responses

AT+SSLSET=0,"/dir/client-cert.pem"

OK

Note: Set the path to the Client Certificate file that is already
present in the file system.

AT+SSLSET=1,"/dir/ca.pem"

OK

Note: Set the path to the CA file that is already present in the file
system.

AT+SSLSET=2,"/dir/client-key.pem"

OK

Note: Set the path to the Client Private Key that is already present
in the file system..

AT+SSLSET=3,"randomstring123456789"
OK

Note: Provide a random string for crypto operations.

AT+SSLSET=4,1
OK

Note: Verify the server certificates against the local CA.

AT+SSLSET=5,0
OK

Note: allow all keys.

AT+SSLSET=6,1
OK

Note: allow only RSA authentication.

AT+SSLSET=7,5
OK

Note: allow only AES authentication.

4115730 Rev 5.0 March 26, 2015 177

 Extended AT Commands Manual Security Library Commands

Command Responses

AT+SSLSET=8,3
OK

Note: allow only SHA2 as MAC algorithm.

AT+SSLSET=9,3
OK

Note: allow only TLS1.2.

AT+SSLSET=10,1
OK

Note:HTTPS Session auto reuse set on.

5.1.3. Command +SSLSETOPTS

5.1.3.1. Description
This AT command sets all parameters previously provided via AT+SSLSET. If the command is
successfully called in state SSL_INITLIALIZED, the state changes to SSL_PARAMETRIZED.

5.1.3.2. Syntax

Action command
AT+SSLSETOPTS

OK

Read command
AT+SSLSETOPTS?
OK

Test command
AT+SSLSETOPTS=?
OK

5.1.3.3. Parameters and Defined Values

There are no parameters for this AT command.

4115730 Rev 5.0 March 26, 2015 178

 Extended AT Commands Manual Security Library Commands

5.1.4. Command +SSLRELEASE

5.1.4.1. Description
This AT command closes the library and frees the associated resources. After this is called all settings
previously set will be reset to default values. State will be SSL_UNINITIALIZED after this command is
successfully called.

5.1.4.2. Syntax

Action command
AT+SSLRELEASE

OK

Read command
AT+SSLRELEASE?
OK

Test command
AT+SSLRELEASE=?
OK

5.1.4.3. Parameters and Defined Values

There are no parameters for this AT command.

5.1.4.4. Examples

Command Responses

AT+SSLRELEASE OK
Note: Frees all resources and resets all parameters.

5.1.5. Command +SSLSTATE

5.1.5.1. Description
This AT command will return the state.

4115730 Rev 5.0 March 26, 2015 179

 Extended AT Commands Manual Security Library Commands

5.1.5.2. Syntax

Action command
AT+SSLSTATE
+SSLSTATE: <state>
OK

Read command
AT+SSLSTATE?
OK

Test command
AT+SSLSTATE=?
OK

5.1.5.3. Parameters and Defined Values

<state>:

0 SSL_UNINITIALIZED

1 SSL_INITIALIZED

2 SSL_CONNECTED

3 SSL_PARAMETRIZED

5.1.5.4. Examples

Command Responses

AT+SSLSTATE 0
OK

5.1.6. Command +SSLBOOST

5.1.6.1. Description
This AT command boosts the system to give extra calculation power during the SSL connection.

4115730 Rev 5.0 March 26, 2015 180

 Extended AT Commands Manual Security Library Commands

More specifically, it takes control of the Varispeed service, boosts the CPU speed, and then disables
the Software watchdog.

5.1.6.2. Syntax

Action command
AT+SSLBOOST=<option>

OK

Read command
AT+SSLBOOST?
+SSLBOOST: <option>
OK

Test command
AT+SSLBOOST=?
+SSLBOOST: (range for <option>)
OK

5.1.6.3. Parameters and Defined Values

<state>:

0 Disable boost mode. This is the default value at startup.

Reset CPU Varispeed speed to normal.
Relase control of the Varispeed service.
Re-enable the Software watchdog.

1 Enable boost mode.

Takes control of the Varispeed service.
Enables CPU Varispeed speed to high.
Disables the Software watchdog for 120 seconds.

5.1.6.4. Examples

Command Responses

AT+SSLBOOST=0 OK
Note: Disables SSL BOOST.

4115730 Rev 5.0 March 26, 2015 181

 Extended AT Commands Manual Security Library Commands

Command Responses

AT+SSLBOOST=1
OK
Note: Enables SSL BOOST.

5.1.7. Command +SSLVERSION

5.1.7.1. Description
This AT command displays the underlying versions of different system.

5.1.7.2. Syntax

Action command
AT+SSLVERSION=<option>
+SSLVERSION: (version string)

OK

Read command
AT+SSLVERSION?
OK

Test command
AT+SSLVERSION=?
+SSLVERSION: (range for <option>)
OK

5.1.7.3. Parameters and Defined Values

<option>:

0 The Security Library version.

1 The underlying OpenSSL version..

2 The highest possible SSL version capability of the current compilation of

the Security library.

4115730 Rev 5.0 March 26, 2015 182

 Extended AT Commands Manual Security Library Commands

5.1.7.4. Examples

Command Responses

AT+SSLVERSION=1 +SSLVERSION: OpenSSL 1.0.1c 10 May 2012

OK

5.2. Asynchronous Events

There are no asynchronous events from the Security Services events.

5.3. Security AT Commands Error Codes

The following error codes could be returned from Security AT commands.

Table 3. Security AT commands error codes

Error Error name Description

Code

901 Invalid option Not correct number of parameters.

902 Invalid option value Bad parameter value..
903 Bad state Calling an AT command when the Security Library is in a bad state.
904 Not enough memory Running out of free memory.
905 File not present File specified is not present in the file system.
906 File access problem File is present but there was an error while accessing it. Bad password will
result in this error.
907 Unknown Error The reason for this error is unknown.
908 Bad CA The content of the CA file was read but not accepted.
909 Bad Client Cert The content of the Client Cert file was read but not accepted.
910 Bad Client Key The content of the Client Key file was read but not accepted.

4115730 Rev 5.0 March 26, 2015 183

 6. Network Scan Command

6.1. Library Description

This network scan sample ADL Library allows applications to perform a network scan and provide
surrounding cells information.
The library has to be subscribed in order to subscribe to the +NWKSCAN command which is
managed by this network scan sample ADL Library.

6.2. Library API

All constants and APIs are defined by the network_scan.h header file, which must be included by any
application to allow it to use the Network Scan Library.
The network scan API is defined below :
networkscan_Subscribe
This API has to be used to subscribe to the Network Scan Library.
s16 networkscan_Subscribe ( void );

Returned value Description

OK in success
ADL_RET_ERR_NOT_SUPPORTED if the Sierra Wireless stack does not support the network scan

networkscan_Unsubscribe
This API has to be used to unsubscribe from the Network Scan Library.
void networkscan_Unsubscribe ( void );

6.3. Command +NWKSCAN

Command Answers

+NWKSCAN: (list of supported <RequestedCellNb>s),(list of supported

AT+NWKSCAN=? <Format>s)
OK

4115730 Rev 5.0 March 26, 2015 184

 Extended AT Commands Manual Network Scan Command

Command Answers

[PLMN:<PlmnName>,MCC:<MCC>,MNC:<MNC>,CellNb:<CellNb>,Mea
nPower:<MeanPower>
1:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,S
tatus:<Status>
[2:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,
Status:<Status>
AT+NWKSCAN
[...]]
Note: <RequestedCellNb> and
[PLMN:<PlmnName>,MCC:<MCC>,MNC:<MNC>,CellNb:<CellNb>,Mea
<Format> parameters are omitted.
nPower:<MeanPower>
Default value: <RequestedCellNb> =
1:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,S
7 and <Format> = 0
tatus:<Status>
[2:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,
Status:<Status>
[...]]
[...]
OK
[PLMN:<PlmnName>,MCC:<MCC>,MNC:<MNC>,CellNb:<CellNb>,Mea
nPower:<MeanPower>
1:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,S
tatus:<Status>
[2:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,
Status:<Status>
AT+NWKSCAN=<RequestedCellNb> [...]]
[,<Format>] [PLMN:<PlmnName>,MCC:<MCC>,MNC:<MNC>,CellNb:<CellNb>,Mea
Note: <Format> parameter = 0 or nPower:<MeanPower>
omitted 1:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,S
tatus:<Status>
[2:Arfcn:<ARFCN>,Bsic:<Bsic>,Lac:<Lac>,Rxlev:<Rxlev>,Qual:<Qual>,
Status:<Status>
[...]]
[...]
OK
[<PlmnName>,<MCC>,<MNC>,<CellNb>,<MeanPower>
<ARFCN>,<Bsic>,<Lac>,<Rxlev>,<Qual>,<Status>
[<ARFCN>,<Bsic>,<Lac>,<Rxlev>,<Qual>,<Status>
[...]]
AT+NWKSCAN=<RequestedCellNb>
[<PlmnName>,<MCC>,<MNC>,<CellNb>,<MeanPower>
[,<Format>]
<ARFCN>,<Bsic>,<Lac>,<Rxlev>,<Qual>,<Status>
Note: <Format> parameter = 1
[<ARFCN>,<Bsic>,<Lac>,<Rxlev>,<Qual>,<Status>
[...]]
[...]
OK
AT+NWKSCAN=<RequestedCellNb> [<PlmnName>,<CellNb>,<MeanPower>
[,<Format>] [<PlmnName>,<CellNb>,<MeanPower>
Note: <Format> parameter = 2 [...]]]
(Synthesis) OK

Values Default
Parameter Description
range value

Cell number on which the scan is launched.

RequestedCellNb 1-7 N/A
If this parameter is omitted, the maximum value is used.
Output format
0: Text
Format 0-2 0
1: Numeric
2: Synthesis

4115730 Rev 5.0 March 26, 2015 185

 Extended AT Commands Manual Network Scan Command

Values Default
Parameter Description
range value

PLMN name (long one)

If the name is not found, the MCC/MNC code will be
returned.
PlmnName 30 characters N/A
The PLMN name search criterion is defined by the
+WOPN command. Please refer to the AT commands
User Guide.
MCC 3 digits Mobile Country Code N/A
MNC 2 or 3 digits Mobile Network Code N/A
cell number which were scanned for one PLMN
CellNb N/A This number could be higher than the <RequestedCellNb> N/A
parameter value
Cell power average
MeanPower 0-63 This is the average RSSI level of the returned cells for the N/A
corresponding PLMN
Absolute Radio Frequency Channel Number
Range:
ARCFN N/A GSM 900E: [0-124] and [975-1023] N/A
DCS 1800: [512-885]
PCS 1900: [1536-1834]
Bsic 1-63 Base Station Identity Code N/A
RSSI level on BCCH channel, in idle mode. This
parameter is empty in dedicated mode
0: -110 dBm or less
1:-110 dBm to -109 dBm
RxLev 0-63 N/A
2: -109 dBm to -108 dBm
3-61: -108 dBm to -49 dBm
62: -49 dBm to -48 dBm
63: -48 dBm and greater
Lac 0-65535 Location Area Code N/A
Rx quality information
0: BER < 0,2%
1: 0,2 % < BER < 0,4 %
2: 0,4 % < BER < 0,8 %
Qual 0-7 3: 0,8 % < BER < 1,6 % N/A
4: 1,6 % < BER < 3,2 %
5: 3,2 % < BER < 6,4 %
6: 6,4 % < BER < 12,8 %
7: 12,8 % < BER
cell status
SUITABLE (0)
NOT SUITABLE (1): low power level (C1 criteria is
negative)
BARRED (2): Cell is barred
Status N/A N/A
LOW PRIORITY (3): Cell is in low priority according to
System Information
BAD PLMN (4): Cell belongs to a forbidden PLMN
BAD LAI (5): Cell belongs to a forbidden LAC
NO STATUS (6): No information received

This command returns OK when the command is proceed correctly.

This command can be treated when an UICC card is absent or when an UICC is inserted and the
CHV1 code is entered.
This command returns +CME ERROR: 3 when a parameter is out of range.This command returns
+CME ERROR: 536 when a PLMN scan (AT+COPS=?) is already under treatment.
This command returns +CME ERROR: 11 when an UICC is inserted and the CHV1 code is required.

4115730 Rev 5.0 March 26, 2015 186

 Extended AT Commands Manual Network Scan Command

The PLMN are returned by decreasing <CellNb> parameter values and, then, by decreasing
<MeanPower> parameter values.
For one PLMN, the returned cells are listed by decreasing <RxLev> parameter values.
The estimated maximum treatment time for this command is around 2 minutes.

6.4. Examples
Command Answers

PLMN:"SFR",MCC:208,MNC:10,CellNb:8,MeanPower:30
1:Arfcn:1020,Bsic:31,Lac:8,RxLev:38,Qual:0,Status:SUITABLE
2:Arfcn:1008,Bsic:32,Lac:9,RxLev:33,Qual:1,Status:SUITABLE
3:Arfcn:1009,Bsic:33,Lac:10,RxLev:32,Qual:2,Status:SUITABLE
4:Arfcn:1003,Bsic:34,Lac:11,RxLev:29,Qual:1,Status:SUITABLE
5:Arfcn:792,Bsic:35,Lac:12,RxLev:27,Qual:1,Status:SUITABLE
6:Arfcn:790,Bsic:36,Lac:13,RxLev:26,Qual:2,Status:SUITABLE
7:Arfcn:1013,Bsic:37,Lac:14,RxLev:26,Qual:1,Status:SUITABLE

PLMN:"Orange F",MCC:208,MNC:01,CellNb:7,MeanPower:26
AT+NWKSCAN
1:Arfcn:32,Bsic:1,Lac:1,RxLev:35,Qual:0,Status:SUITABLE
2:Arfcn:8,Bsic:2,Lac:2,RxLev:35,Qual:1,Status:SUITABLE
3:Arfcn:10,Bsic:3,Lac:3,RxLev:27,Qual:0,Status:SUITABLE
4:Arfcn:17,Bsic:4,Lac:4,RxLev:26,Qual:2,Status:SUITABLE
5:Arfcn:48,Bsic:5,Lac:5,RxLev:24,Qual:0,Status:SUITABLE
6:Arfcn:539,Bsic:6,Lac:6,RxLev:22,Qual:1,Status:SUITABLE
7:Arfcn:550,Bsic:7,Lac:7,RxLev:20,Qual:2,Status:SUITABLE

OK
Note: Request 7 cells per PLMN in text format
PLMN:"SFR",MCC:208,MNC:10,CellNb:8,MeanPower:30
1:Arfcn:1020,Bsic:31,Lac:8,RxLev:38,Qual:0,Status:SUITABLE
2:Arfcn:1008,Bsic:32,Lac:9,RxLev:33,Qual:1,Status:SUITABLE
3:Arfcn:1009,Bsic:33,Lac:10,RxLev:32,Qual:2,Status:SUITABLE
4:Arfcn:1003,Bsic:34,Lac:11,RxLev:29,Qual:1,Status:SUITABLE
5:Arfcn:792,Bsic:35,Lac:12,RxLev:27,Qual:1,Status:SUITABLE
6:Arfcn:790,Bsic:36,Lac:13,RxLev:26,Qual:2,Status:SUITABLE
7:Arfcn:1013,Bsic:37,Lac:14,RxLev:26,Qual:1,Status:SUITABLE

PLMN:"Orange F",MCC:208,MNC:01,CellNb:7,MeanPower:26
AT+NWKSCAN=,1
1:Arfcn:32,Bsic:1,Lac:1,RxLev:35,Qual:0,Status:SUITABLE
2:Arfcn:8,Bsic:2,Lac:2,RxLev:35,Qual:1,Status:SUITABLE
3:Arfcn:10,Bsic:3,Lac:3,RxLev:27,Qual:0,Status:SUITABLE
4:Arfcn:17,Bsic:4,Lac:4,RxLev:26,Qual:2,Status:SUITABLE
5:Arfcn:48,Bsic:5,Lac:5,RxLev:24,Qual:0,Status:SUITABLE
6:Arfcn:539,Bsic:6,Lac:6,RxLev:22,Qual:1,Status:SUITABLE
7:Arfcn:550,Bsic:7,Lac:7,RxLev:20,Qual:2,Status:SUITABLE

OK
Note: Request 7 cells per PLMN in numeric format

4115730 Rev 5.0 March 26, 2015 187

 Extended AT Commands Manual Network Scan Command

Command Answers

"SFR",208,10,8,30
1020,31,8,38,0,0
1008,32,9,33,1,0
1009,33,10,32,2,0
1003,34,11,29,1,0
792,35,12,27,1,0

"Orange F",208,01,7,26
AT+NWKSCAN=5,1
32,1,1,35,0,0
8,2,2,35,1,0
10,3,3,27,0,0
17,4,4,26,2,0
48,5,5,24,0,0

OK
Note: Request 5 cells per PLMN in numeric format
"SFR",8,30
"Orange F",7,26
AT+NWKSCAN=,2
OK
Note: Synthesis

4115730 Rev 5.0 March 26, 2015 188

 7. Jamming Detection Command

7.1. Application Description

This application starts Jamming Detection algorithm and provides unsolicited responses informing the
jamming detection status. The +WJAM command has also to be used to stop or restart the Jamming
Detection algorithm. The mean threshold value can also be configured.

7.1.1. Command +WJAM

Command Answers

+WJAM: <mode>
AT+WJAM?
OK
+WJAM: (list of supported <mode>s),(list of supported <threshold>s)
AT+WJAM=?
OK
ERROR
AT+WJAM=<mode>[,<threshold>] or
OK

Values Default
Parameter Description
range value

0 - stop the jamming detection algorithm.

1 - start the jamming detection algorithm.
mode 0-4 2 - request last final jamming status. 1
3 - get the mean threshold value.
4 - set the mean threshold value.
the value of the mean threshold used in the algorithm.
threshold 0-63 Please see 3GPP spec 05.08 chapter 8.1.4 for exact 40
explaination of the range.

If the jamming detection algorithm is started, each time a PLMN scan is performed the following
unsolicited result is displayed :
+WJAM: <Status Type>: <result>
Where Status Type parameter is equal to "INTERMEDIATE STATUS" or "FINAL STATUS" and result
parameter is
 !!! JAMMED !!!
 HIGH
 MEDIUM
 LOW
 NULL
Note: To execute the sample, Open AT application must be enabled in the embedded module. If it is not
enabled, execute AT+WOPEN=1 command to enable it. Only when Open AT application is enable , the
application provides the desired functionality.

4115730 Rev 5.0 March 26, 2015 189

 8. Audio AT Commands
This audio_at_cmd sample ADL Library allows applications to perform Audio AT commands.
The +AUDIO commands are used for performing the following operations:
 Play & record PCM (.wav format) stored in module File System -
 Stop playing or recording
 Audio can be played to configurable resources (Speaker, Audio Tx ---)
 Transcode AMR file to PCM file

8.1. +AUDIOINIT Audio Initialization Command

This Sierra Wireless proprietary command initializes the audio AT service.
In particular, +AUDIOFILE command is not available until initialization is successfully performed.

Action command
AT+AUDIOINIT
OK

Read command
None

Test command
None

8.1.1. Command Availability

No PIN code required, no SIM card required.

8.1.2. Command Behavior

If the audio AT service initialization is already done, AT+AUDIOINIT returns OK.

8.1.3. Example

Command Response

AT+AUDIOINIT OK

4115730 Rev 5.0 March 26, 2015 190

 Extended AT Commands Manual Audio AT Commands

8.2. +AUDIOEXIT Audio Exit Command

This Sierra Wireless proprietary command stops the audio AT service, then +AUDIOFILE commands
is no more available.

Action command
AT+AUDIOEXIT
OK

Read command
None

Test command
None

8.2.1. Command Availability

No PIN code required, no SIM card required.

8.2.2. Command Behavior

This command stops all operations (play or record) on audio file which are in progress.
If the audio AT service is not initialized, AT+AUDIOEXIT returns OK.

8.2.3. Examples

Examples: Command Answers

AT+AUDIOINIT OK
AT+AUDIOEXIT OK

8.3. +AUDIOFILE Play & Record Audio Files

This Sierra Wireless proprietary command is used to play & record PCM (.wav format) stored in
module File System, and to stop playing or recording.
Audio can be played to configurable resources (Speaker, Audio Tx).
 if <operation>="playstart" or "recordstart"

4115730 Rev 5.0 March 26, 2015 191

 Extended AT Commands Manual Audio AT Commands

Action command
AT+AUDIOFILE=<operation>,<name>,<resource>,<audio processing>[,<loop>]
OK
+AUDIOFILE: <event>,<resource>,<audio processing>

if <operation>="playstop" or "recordstop"

Action command
AT+AUDIOFILE=<operation>,<resource>,<audio processing>
OK
+AUDIOFILE: <event>,<resource>,<audio processing>

if <operation>="playparam"

Action command
AT+AUDIOFILE="playparam",<gain>
OK

if <operation>="recordparam"

Action command
AT+AUDIOFILE="recordparam",<duration>
OK

Read command
AT+AUDIOFILE?
+AUDIOFILE : "playparam",<gain>
+AUDIOFILE : "recordparam",<duration>
OK

Test command
AT+AUDIOFILE=?
+AUDIOFILE : ("playstart","recordstart"),"filename",(list of supported
<resource>),(list of supported <audio processing>)
+AUDIOFILE : ("playstop","recordstop"),(list of supported <resource>),(list of
supported <audio processing>)
+AUDIOFILE : "playparam",(-78-42)
+AUDIOFILE : "recordparam",(1-255)
OK

4115730 Rev 5.0 March 26, 2015 192

 Extended AT Commands Manual Audio AT Commands

Parameter/Defined
Audio Operation
Value

 "playstop": Stop playing

 "playstart": Start playing
 "recordstop": Stop recording
<operation>
 "recordstart": Start recording
 "playparam": Parameter for Playback
 "recordparam": Parameter for Record
Full filename and file path to operate. File path is an absolute path.
<name>
Note: Only mandatory for starting playing & recording
Audio resource: (* See Audio Chain Description figure for resource location)
 "mic": For record operation only: Microphone
 "call": For record operation: Voice Call RX, For play operation: Voice Call Tx
<resource>
 "spk": For play operation: Speaker
* Take a look to the vocoder architecture for point location.
Note: Mandatory for record & play operations and forbidden for stop operations
Audio processing:
<audio processing>  "noproc": Without digital audio processing
 "audioproc": With digital audio processing
<loop> "Loop" for playback in infinite loop (default: no loop)
<gain> Digital gain in dB (default 0) to be applied on PCM samples for playback
<duration> Recording max duration in second (default 20 sec)
Audio event:
 0: Stop playing
 1: Start playing
 2: Stop recording
 3: Start recording
<event>
 4: FS File not found
 5: FS File format not supported
 6: Stop playing because internal fifo underrun (For future use)
 7: Stop record because internal fifo overrun (For future use)
 8: Internal error (see Error description table below)

4115730 Rev 5.0 March 26, 2015 193

 Extended AT Commands Manual Audio AT Commands

8.3.1. Command Availability

This command is available when the audio AT service is initialized (see AT+AUDIOINIT description).

8.3.2. Command Behavior

Some resources require a call to be proceeded correctly.
Some resource combinations are impossible (like recording on the speaker (A)), that"s causes a
+CME ERROR:4.
Record duration is limited to 20 seconds.
Only 1 playback or 1 record is available at the same time. The first operation is stopped before the
second operation starts.
For more details on this command behavior, see the audio feature application note for SL808xT
AirPrime embedded module.
Record operations store .wav files according the following format:

4115730 Rev 5.0 March 26, 2015 194

 Extended AT Commands Manual Audio AT Commands

 Audio format : PCM

 Sample rate : 8KHz
 Bits per sample : 16 bits
 Number of channels: mono
Playback operations are allowed for the following format:
 Audio format: PCM only (no compression)
 Sample rate : 8 KHz only
 Bits per sample : 16 bits only
 Number of channels: mono only

8.3.3. Examples

Command Response

AT+AUDIOFILE="playstart","/dir1/Music1.wav","spk","nopro
c" OK
+AUDIOFILE:1,
Note: Start playing on speaker without digital audio processing (from (1) to "spk","noproc"
(A))

AT+AUDIOFILE="playstop","spk","noproc" OK
+AUDIOFILE:0,
Note: Stop playing on speaker without digital audio processing (from (1) to
"spk","noproc"
(A))

AT+AUDIOFILE="recordstart","/dir3/Music2.wav","mic","aud
ioproc" OK
+AUDIOFILE:3,"mic","audio
Note: Start recording from microphone with digital audio processing (from proc"
(B) to (4))

AT+AUDIOFILE="recordstop","mic","audioproc" OK
+AUDIOFILE:2,"mic","audio
Note: Stop recording from microphone with digital audio processing (from
proc"
(B) to (4))

AT+AUDIOFILE="playstart","/dir1/Music1.wav","mic","nopro
c" +CME ERROR:4
Note: Operation not supported, impossible to play on microphone

AT+AUDIOFILE="playstart","/dir2/Melody.wav","spk","audio
proc" OK
+AUDIOFILE:4,"spk","audio
Note: Start playing on speaker with digital audio processing (from (3) to (A)) proc"
but the file is not found.

AT+AUDIOFILE="playstart","/dir1/Music1.wav","spk","proc"
+CME ERROR:3
Note: Invalid syntax parameter ("proc" is an invalid parameter)

8.3.4. Errors

ERROR Response Definition

+CME ERROR:3 Syntax error

+CME ERROR:4 Operation not supported

4115730 Rev 5.0 March 26, 2015 195

 Extended AT Commands Manual Audio AT Commands

ERROR Response Definition

This event error occurs when an ADL API fails within the AT audio
commands library. This error occurs for :
 memory allocation failure
 file system closing failure
 audio failures like the audio resource is not able to play or record now

ADL APIs which may fail:

 adl_audioSubscribe
 adl_audioUnsubscribe
 adl_audioStop
+AUDIOFILE:  adl_audioStreamplay
8,<resource>,<audioprocessing>  adl_audioStreamListen
 adl_audioGetOption
 adl_memGet
 adl_fsClose

Enabling ADL & HLH traces level 4 provides more information.

Possible process to follow:

Repeating the failed AT command once may solve this issue.
If the failure repeats, use AT+AUDIOEXIT and AT+AUDIOINIT before
repeating the failed AT command.

8.4. +AUDIOCONVERT Transcode AMR File to

PCM File

8.4.1. Command Availability

This command is available without the audio AT service initialization.

8.4.2. Command Behavior

This Sierra Wireless proprietary command is used to transcode AMR file stored in module File
System, to PCM file stored in module File System.
Note: Do not send another AT command until "+AUDIOCONVERT: xxx" message is received.

Action command
AT+AUDIOCONVERT=<amr_file>,<pcm_file>
OK
+AUDIOCONVERT: 0
Note: +AUDIOCONVERT: 0 means the transcoding is successful.

4115730 Rev 5.0 March 26, 2015 196

 Extended AT Commands Manual Audio AT Commands

Read command
AT+AUDIOCONVERT?
OK

Test command
AT+AUDIOCONVERT=?
+AUDIOCONVERT=<amr_file>,<pcm_file>
OK

Parameter Defined Value

<amr_file> Full input filename and file path to operate. File path is an absolute path.
<pcm_file> Full ouptput filename and file path to operate. File path is an absolute path.

8.4.3. Examples

Command Response

AT+AUDIOCONVERT="/dir1/InMusic1.amr","/dir2/OutMusic2.wav" OK
Note: +AUDIOCONVERT: 0 means the transcoding is successful. +AUDIOCONVERT: 0

8.4.4. Errors
Errors are indicated with "+AUDIOCONVERT: xxx" messages.
OK is returned when all AT command parameters are correct and when the first operations on FS &
memory run perfectly.
Thus if an error occurs during the transcoding process, the error is indicated with an unsolicited
message "+AUDIOCONVERT: xxx".
If one parameter is wrong or something wrong occurs with FS & memory management, only the
"+AUDIOCONVERT: xxx" message will occur. In other words, there is no OK.

Error Value Definition

1 Wrong number of parameters

2 Impossible to stat input file
3 Input file size = 0
4 Impossible to open input file
5 Impossible to allocate mem for input file
6 Impossible to read input file
7 Impossible to get size of output file
8 Impossible to allocate mem for ouput file
9 Impossible to open output file

4115730 Rev 5.0 March 26, 2015 197

 Extended AT Commands Manual Audio AT Commands

Error Value Definition

Impossible to convert file

10
Note: This error occurs during the transcoding process.
Impossible to write output file header
11
Note: This error occurs during the transcoding process.
Impossible to write output file data
12
Note: This error occurs during the transcoding process.

4115730 Rev 5.0 March 26, 2015 198

 9. eCall In-Band Modem Library
Commands

9.1. AT Commands Reference

The following AT commands enable the control of eCall In-Band Modem Library Services for basic
operation. They are listed under three different command categories:
1. Library Control commands
2. In-Band Channel Control commands
3. MSD Control commands

9.1.1. Library Control Commands

9.1.1.1. Command +INBMINIT

9.1.1.1.1. Description
This AT Command is used to initialize the eCall In-Band Modem Library.

9.1.1.1.2. Syntax

Action command
AT+INBMINIT=[<SrcType>]

OK

Test command
AT+INBMINIT=?
+INBMINIT: (list of supported <at_command>s)
OK

9.1.1.1.3. Parameters and Defined Values

<SrcType>: This parameter gives the value of the source type

0 If the source specified is GSM, then this value is specified

4115730 Rev 5.0 March 26, 2015 199

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.1.1.4. Examples

Command Responses

AT+INBMINIT=?
+INBMINIT: 0
Note: displays all supported AT
OK
command format.

AT+INBMINIT=0 OK
or
+INBMERROR: <id> (In case the command fails. <id>,
specifies the error cause)

9.1.1.2. Command +INBMEXIT

9.1.1.2.1. Description
This AT command cleans up the eCall In-Band Modem Library.

9.1.1.2.2. Syntax

Action command
AT+INBMEXIT

OK

9.1.1.2.3. Examples

Command Responses

AT+INBMEXIT OK
or
+INBMERROR: <id> (In case the command fails.
<id>, specifies the error cause)

9.1.1.3. Command +INBMGETVER

9.1.1.3.1. Description
This AT command is used to request to get the In-Band Modem Library version

4115730 Rev 5.0 March 26, 2015 200

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.1.3.2. Syntax

Read command
AT+INBMGETVER?
[In-Band Modem Library version information]
OK

9.1.1.3.3. Examples

Command Responses

AT+INBMGETVER? The In-Band Modem Library version information

followed by:
OK
Note: request the version of the In-Band Modem
Library in use or
+INBMERROR: <id> (If the command fails. <id>,
specifies the error cause.)

9.1.1.4. Command +INBMSTATE

9.1.1.4.1. Description
The above command requests for the state of In-Band Modem Library.

9.1.1.4.2. Syntax

Read command
AT+INBMSTATE?
+INBMSTATE:<state>
OK

9.1.1.4.3. Parameters and Defined Values

<state>: State value

0 If the state is uninitialized, then this value is returned.

1 This value is returned when the state is initialized.

4115730 Rev 5.0 March 26, 2015 201

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.1.4.4. Examples

Command Responses

AT+INBMSTATE? +INBMSTATE: 0
OK
OR
Note: 0 if state is not initialized.

+INBMSTATE: 1
OK
Note: 1 if state is initialized.

OR

+INBMERROR: <id> (In case the command fails.

<id>, specifies the error cause)

9.1.2. In-Band Channel Control Commands

9.1.2.1. Command +INBMOPEN

9.1.2.1.1. Description
This AT command is used to activate the In-Band Modem channel.
If “MSD” is not specified along with “AT+INMBOPEN” command, then default MSD value will be sent
as follows:
“0x015C0681D54970D65C3597CA0420C41464583ADE68AC52E9BB8413F149C07414FB414F6010
180813E82181823230"

9.1.2.1.2. Syntax

Action command
AT+INBMOPEN=<mode>,[“MSD”]

OK

Test command
AT+INBMOPEN=?
+INBMOPEN: (list of supported <mode>s),(<”MSD”>)
OK

4115730 Rev 5.0 March 26, 2015 202

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.2.1.3. Parameters and Defined Values

<mode> The mode in which the channel must be opened

0 Pull mode

1 Push mode

<MSD> maximum 140 This is an optional parameter. If the MSD is not provided a default 140 bytes of
byte string MSD would be considered. The MSD should be in double quotes.
permitted

9.1.2.1.4. Examples

Command Responses

AT+INBMOPEN? +INBMOPEN:(0,1),<MSD>
OK

AT+INBMOPEN=0,“MSD”
+INBMOPEN: 0
OK
Note: 0 if mode is pull mode.
+INBMEV: <ev>

AT+INBMOPEN=1,“MSD” +INBMOPEN: 1
OK
+INBMEV: <ev>
OR
Note: 1 if mode is push mode.

+INBMERROR: <id> (In case the command fails.

<id>, specifies the error cause)

AT+INBMOPEN=0,”2541DE22” +INBMOPEN: 0
OK

Note: 0 if mode is pull mode. +INBMEV: <ev>

AT+INBMOPEN=1,”6574FE24DD78” +INBMOPEN: 1
OK

Note: 1 if mode is push mode. +INBMEV: <ev>

OR

+INBMERROR: <id> (In case the command fails.

<id>, specifies the error cause)

4115730 Rev 5.0 March 26, 2015 203

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.2.2. Command +INBMCLOSE

9.1.2.2.1. Description
This AT command is used to de-activate/close the In-Band modem channel. Once the channel is de-
activated, no MSD transaction would occur.

9.1.2.2.2. Syntax

Action command
AT+INBMCLOSE

OK

9.1.2.2.3. Examples

Command Responses

AT+INBMCLOSE OK
or
+INBMERROR: <id> (In case the command fails.
<id>, specifies the error cause)

9.1.2.3. Command +INBMCHSTATE

9.1.2.3.1. Description
This AT command helps in retrieving the channel state.

9.1.2.3.2. Syntax

Read command
AT+INBMCHSTATE?

+INBMCHSTATE:<ch_state>
OK

9.1.2.3.3. Parameters and Defined Values

<ch_state >: Channel state is defined by this variable. It can have following values.

0 INBM_CHANNEL_IDLE

4115730 Rev 5.0 March 26, 2015 204

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

1 INBM_CHANNEL_MSD_REQ_SENDING

2 INBM_CHANNEL_MSD_SENDING

3 INBM_CHANNEL_WAITING_HLACK

9.1.2.3.4. Examples

Command Responses

AT+INBMCHSTATE? +INBMCHSTATE: 0
OK

OR

+INBMERROR: <id> (In case the command fails. <id>, specifies

the error cause)

9.1.3. MSD Control Commands

9.1.3.1. Command +INBMSETMSD

9.1.3.1.1. Description
This AT command is used to provide an updated MSD. Collects the MSD and provides the same the
Library for further processing. The channel will have to be in IDLE State to issue this command

9.1.3.1.2. Syntax

Action command
AT+INBMSETMSD=”MSD”

OK

9.1.3.1.3. Parameters and Defined Values

<MSD >: This defines the length of Minimum Set of Data sent.
 If MSD data is in ASCII format , the maximum data length will be up to 140
bytes.
 If MSD data is in Binary format , the maximum data length will be up to 280
digits.

4115730 Rev 5.0 March 26, 2015 205

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.3.1.4. Examples

Command Responses

AT+INBMSETMSD=? OK
or
+INBMERROR: <id> (In case the
command fails. <id>, specifies the
error cause)

AT+INBMSETMSD=”015C0681D54970D65C359
7CA0420C41464583ADE68AC52E9BB8413F14 OK
9C07414FB414F6010180813E82181823230"

AT+INBMSETMSD=”SIERRA WIRELESS” OK

9.1.3.2. Command +INBMPUSH

9.1.3.2.1. Description
This AT command is used to activate the PUSH mode.

9.1.3.2.2. Syntax

Action command
AT+INBMPUSH

OK

9.1.3.2.3. Examples

Command Responses

AT+INBMPUSH +INBMOPEN: 1
OK
or
+INBMERROR: <id> (In case the command fails.
<id>, specifies the error cause)

4115730 Rev 5.0 March 26, 2015 206

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.3.3. Command +INBMMSDFORMAT

9.1.3.3.1. Description
This AT command is used to set the MSD format either in Binary or ASCII.
Default value is 0 which indicates MSD format is in Binary.

9.1.3.3.2. Syntax

Action command
AT+INBMMSDFORMAT=<MSD_format>

OK

Read command
AT+ INBMMSDFORMAT?

+ INBMMSDFORMAT:<MSD_format>
OK

9.1.3.3.3. Parameters and Defined Values

<MSD_format >: Format of the MSD string being sent. It can have following values.

0 Binary format

1 ASCII format

9.1.3.3.4. Examples

Command Responses

AT+INBMMSDFORMAT=? +INBMMSDFORMAT: (0-1)

OK
or
+INBMERROR: <id> (In case the command fails.
<id>, specifies the error cause)

4115730 Rev 5.0 March 26, 2015 207

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Command Responses

AT+INBMMSDFORMAT? +INBMMSDFORMAT: 0
OK

or
+INBMMSDFORMAT: 1
OK

or
+INBMMSDFORMAT: <id> (If the command fails.
<id>, specifies the error cause)

9.1.3.4. Command +INBMTIMERCFG

9.1.3.4.1. Description
This AT command is used to configure the eCall In-Band Modem HLAP timer values.

9.1.3.4.2. Syntax

Action command: Used to set the timer values. The number of timer values that can be set is minimum of 1
parameter and maximum of 5 parameters.
AT+INBMTIMERCFG =<T2>,<T3>,<T5>,<T6>,<T7>
or
AT+INBMTIMERCFG =<”T2”>,<”T3”>,<”T5”>,<”T6”>,<”T7”>
OK
(Where <T2>,<T3>,<T5>,<T6>,<T7> are timer values to be set.)

Test command: Used to get the valid range of timer values.

AT+INBMTIMERCFG=?
OK

Read command: Used to present the timer values’ settings.

AT+INBMTIMERCFG?

+INBMTIMERCFG: T2 timer value, T3 timer value, T5 timer value, T6 timer value, T7

timer value
OK

4115730 Rev 5.0 March 26, 2015 208

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.3.4.3. Default Timer Values

The default timer values are CEN values as specified in the table below.
Table 4. Default Timer Values

Timer Default values (in seconds)

T2 3600
T3 2
T5 5
T6 5
T7 20

9.1.3.4.4. Valid Ranges of Timer Values

The valid ranges of timer values are specified in the table below.

Table 5. Valid Range of Timer Values

Timer Minimum (in seconds) Maximum (in seconds)

T2 1 3600
T3 1 3600
T5 1 3600
T6 1 3600
T7 1 3600

9.1.3.4.5. Examples

Command – Assuming IVS core is

Description Responses
initialized

AT+INBMTIMERCFG=3600,2,2,5,20 To set all the 5

(Maximum permissible OK
limit is 5) timer values
AT+INBMTIMERCFG=3600,2,2,5
To set few of the timer
OK
values

AT+INBMTIMERCFG=3600,2,2,5, OK (For valid timer

values)
To set few of the timer
or
values +INBMERROR: <id> (For
invalid timer value)
AT+INBMTIMERCFG? This is read command
+INBMTIMERCFG:
used to give the
3600,2,2,5,20
Information on Timer
OK
values set

4115730 Rev 5.0 March 26, 2015 209

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Command – Assuming IVS core is

Description Responses
initialized

AT+INBMTIMERCFG=? This is a test

command used to get +INBMTIMERCFG:(1-
the valid range of 3600),(1-3600),(1-
timer values 3600),(1-3600),(1-3600)

AT+INBMTIMERCFG This is used to test +INBMERROR: <id> (<id>,

syntax of the specifies the error
command cause)
AT+INBMTIMERCFG= This is used to test
syntax of the ERROR
command
AT+INBMTIMERCFG=3600,2,2,5,20,8 To set the timer
values, exceeding the
ERROR
max permissible limit
(5)

9.1.4. CECALL functionality

9.1.4.1. Command +CECALLINIT

9.1.4.1.1. Description
This AT command initialized the AT+CECALL functionality. If the SIM is eCall Only, it enables spy
mode.

9.1.4.1.2. Syntax

Action command
AT+CECALLINIT

OK

9.1.4.1.3. Parameters and Defined Values

No parameters

9.1.4.1.4. Examples

Command Responses

AT+CECALLINIT OK
or
ERROR (if already called)

4115730 Rev 5.0 March 26, 2015 210

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.4.2. Command +CECALL

9.1.4.2.1. Description
This AT command implements the AT command AT+CECALL as described in the corresponding
3GPP standard document.
If the SIM is eCall Only, it disables Spy Mode during the call. It will also stay registered on the network
for the duration of the T10 timer the call has finished, then go back to Spy Mode.

9.1.4.2.2. Syntax

Action command
AT+CECALL=<type_of_eCall>
OK

Test command: Used to get the valid range of <type_of_eCall> values.

AT+CECALL=?
+CECALL: (list of supported <type_of_eCall>s)
OK

Read command: Used to get the current running eCall, if any.

AT+CECALL?
+CECALL: [<type_of_eCall>]
OK

9.1.4.2.3. Parameters and Defined Values

<type_of_eCall>: Format of the MSD string being sent. It can have following values.

0 Test Call. The number must be present on the SIM. If the number is not present
this command will fail.

1 Reconfiguration call eCall. The number must be present on the SIM. If the number
is not present this command will fail.

2 Manually initated eCall

3 Automatically initated eCall.

9.1.4.2.4. Examples

Command Description Responses

AT+CECALL=3 Start an automated OK

eCall.

4115730 Rev 5.0 March 26, 2015 211

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Command Description Responses

AT+CECALL=0
Start an Test Call. OK

9.1.4.2.5. Full Example

Example of a usage of AT+CECALL doing automatic eCall

AT+CECALLINIT
OK

AT+INBMINIT=0
OK

AT+INBMOPEN=1
+INBMOPEN: 1
OK

AT+INBMSETMSD="015C0681D54970D65C3597CA0420C41464583ADE68AC52E9BB8413F149C07414FB41
4F6010180813E82181823230"
OK

AT+CECALL=3
OK

Example of a usage of AT+CECALL doing a reconfiguration eCall.

Please note that the InBand modem should be close during a reconfiguration call.
AT+CECALLINIT
OK

AT+INBMINIT=0
OK

AT+INBMOPEN=1
+INBMOPEN: 1
OK

AT+INBMSETMSD="015C0681D54970D65C3597CA0420C41464583ADE68AC52E9BB8413F149C07414FB41
4F6010180813E82181823230"
OK
...

4115730 Rev 5.0 March 26, 2015 212

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

AT+INBMCLOSE=0
OK

AT+CECALL=3
OK

…
(after call)

AT+INBMOPEN=1
+INBMOPEN: 1
OK

9.1.5. Unified eCall Services Functionality

9.1.5.1. Command +ECALLINIT

9.1.5.1.1. Description
This AT command is used to initializes the Unified eCall Application and provides the vehicle related
information of the MSD.
It will also perform the equivalent of AT+CECALLINIT needed for the AT+CECALL.

9.1.5.1.2. Syntax

Action command
AT+ECALLINIT=<eCallMode>

OK

The read command will only return a value if one is set.

Read command
AT+ECALLINIT?
[+ECALLINIT: <eCallMode>]
OK
or
ERROR

4115730 Rev 5.0 March 26, 2015 213

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Test command
AT+ECALLINIT=?
+ECALLINIT: (0-1)
OK

9.1.5.1.3. Parameters and Defined Values

<eCallMode> Integer value.

This value sets if the eCall Manager should be handle some
cases in according to the PAN EU specifications or the ERA
GLONASS specifications.

0 PAN EU Mode

1 ERA GLONASS Mode

9.1.5.1.4. Examples

Command Responses

AT+ECALLINIT=0 OK
or
ERROR

AT+ECALLINIT? +ECALLINIT: 0
OK

9.1.5.2. Command +ECALLCFG

9.1.5.2.1. Description
There are certain parameters that affect the UNIFIED ECALL Specific behavior.
They all have default values according to [3]. One or several values can be changed via this
command.
Each parameter is optional, so if there is no need to change the default value, it can be left empty.

9.1.5.2.2. Syntax
If <action> = 0. Override Timer values.

4115730 Rev 5.0 March 26, 2015 214

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Action command
AT+ECALLCFG=<action>,[<CCFT_T2>],[<INVITATION_SIGNAL_DURATION_T3>],
[<SEND_MSG_PERIOD_T5>],[<AL_ACK_PERIOD_T6>],
[<MSD_MAX_TRANSMISSION_TIME_T7>],[<ECALL_DIAL_DURATION>],
[<ECALL_AUTO_DIAL_ATTEMPS>],[<ECALL_MANUAL_DIAL_ATTEMPS>],[<ECALL_TIME_BETWEEN_REDI
ALS>]

OK

If <action> = 1. Override SIM numbers. Useful for debug

Action command
AT+ECALLCFG=<action>,<testNbr>,<reconfigurationNbr>

OK

Read command
AT+ECALLCFG?
+ECALLCFG: 0,<CCFT_T2>,<INVITATION_SIGNAL_DURATION_T3>,
<SEND_MSG_PERIOD_T5>,<AL_ACK_PERIOD_T6>,<MSD_MAX_TRANSMISSION_TIME_T7>,
<ECALL_DIAL_DURATION>,<ECALL_AUTO_DIAL_ATTEMPS>,<ECALL_MANUAL_DIAL_ATTEMPS>,<ECALL_
TIME_BETWEEN_REDIALS>
+ECALLCFG: 1,<testNbr>,<reconfigurationNbr>
OK

Test command
AT+ECALLCFG=?
+ECALLCFG: (0-1),(list of supported <CCFT_T2>),
(list of supported <INVITATION_SIGNAL_DURATION_T3>),
(list of supported <SEND_MSG_PERIOD_T5>),
(list of supported <AL_ACK_PERIOD_T6>),
(list of supported <MSD_MAX_TRANSMISSION_TIME_T7>),
(list of supported <ECALL_DIAL_DURATION>),
(list of supported <ECALL_AUTO_DIAL_ATTEMPS>),
(list of supported <ECALL_MANUAL_DIAL_ATTEMPS>)
(list of supported <ECALL_TIME_BETWEEN_REDIALS>)
OK

9.1.5.2.3. Parameters and Defined Values

Parameter name Type The type of option to set Default Values

<action> Integer 0 – set Timer values -

1 – override Test and
Reconfiguration numbers on

4115730 Rev 5.0 March 26, 2015 215

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Parameter name Type The type of option to set Default Values

SIM. Useful for tests with

different PSAP without
reprogramming the chip.

<CCFT_T2 > Integer T2 timer in seconds 3600

<INVITATION_SIGNAL_DURATION_T3 > Integer T3 timer in seconds 2

<SEND_MSG_PERIOD_T5> Integer T5 timer in seconds 5

<AL_ACK_PERIOD_T6> Integer T6 timer in seconds 5

<MSD_MAX_TRANSMISSION_TIME_T7> Integer T7 timer in seconds 20

<ECALL_DIAL_DURATION> Integer The duration of each dial 300

attempt in seconds.

<ECALL_AUTO_DIAL_ATTEMPS> Integer The number of dial attempts 10

for a automatically generated
call.

<ECALL_MANUAL_DIAL_ATTEMPS> Integer The number of dial attempts 10

for a manually generated
call.

<ECALL_MANUAL_DIAL_ATTEMPS> Integer The minimum period 1

between each redial attempt
in seconds.

<testNbr> string The valid telephone number. -

This overrides the testNbr on
the SIM.

<reconfigurationNbr> string The valid telephone number. -

This overrides the
reconfigurationNbr on the
SIM.

9.1.5.2.4. Examples

Command Responses Comment

AT+ECALLCFG=0,,,2 OK Setting the

SEND_MSG_PERIOD_T5 to 2
or seconds. Leaving the
ERROR rest of the parameters
with default values.

AT+ECALLCFG? +ECALLCFG:0, Read the values.

3600,2,2,5,20,300,10,10,1
+ECALLCFG:1,"12345","67890"
OK

4115730 Rev 5.0 March 26, 2015 216

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.5.3. Command +ECALLSETMSD

9.1.5.3.1. Description
This AT command updates the MSD with the values given and returns the encoded MSD in ASN1
PER format. This will be useful for queue handling and eSMS.
If the PSAP calls the IVS, the UNIFIED ECALL Service Manager will return this MSD.
The use case is that if a eCall fails to send the MSD, then the host should try to send a eSMS. This
helps the Host to encode it into ASN1 encoding.

9.1.5.3.2. Syntax
For <action> = 0. Setting the static parameters of the MSD.

Action command
AT+ECALLSETMSD=<action>,<ID>,<vehicleType>,<isowmi>,<isovds>,<isovisModelYear>,<iso
visSeqPlant>,<vehiclePropulsionStorageType>

OK

For <action> = 1. Setting the dynamic parameters of the MSD.

Action command
AT+ECALLSETMSD=<action>,<MsgId>,<control>,<timeStamp>,
<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>
[,[<recentVehicleLocationN1.latitudeDelta>]
[,[<recentVehicleLocationN1.longitudeDelta>]
[,[<recentVehicleLocationN2.latitudeDelta>]
[,[<recentVehicleLocationN2.longitudeDelta>]
[,<numberOfPassengers>
[,<additionalData.oid>,<additionalData.data>]]]]]]
OK
For <action> = 2. Setting an already encoded MSD in hexadecimal string form.

Action command
AT+ECALLSETMSD=<action>,<ASN1encodedMSD>
OK

4115730 Rev 5.0 March 26, 2015 217

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Read command
AT+ECALLSETMSD?
[+ECALLSETMSD: <ASN1encodedMSD>]
[+ECALLSETMSD: <ID>,<vehicleType>,<isowmi>,<isovds>,
<isovisModelYear>,<isovisSeqPlant>,<vehiclePropulsionStorageType>,
<MsgId>,<control>, <timeStamp>,<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>
[,[<recentVehicleLocationN1.latitudeDelta>]
[,[<recentVehicleLocationN1.longitudeDelta>]
[,[<recentVehicleLocationN2.latitudeDelta>]
[,[<recentVehicleLocationN2.longitudeDelta>]
[,<numberOfPassengers>
[,<additionalData.oid>,<additionalData.data>]]]]]]]
OK

Test command
AT+ECALLSETMSD=?

OK

9.1.5.3.3. ISO-fields
Please note that the below mentioned fields accepts only a limited set of characters. Here are the
possible values as stated by ISO 3779 standard:

-- isowmi: World Manufacturer Index (WMI)

-- isovds: Vehicle Type Descriptor (VDS)
-- Vehicle Identifier Section (VIS) consisting of
-- isovisModelyear: Modelyear from Vehicle Identifier Section (VIS)
-- isovisSeqPlant: Plant code + sequential number
-- from Vehicle Identifier Section (VIS)
VIN ::= SEQUENCE {
isowmi PrintableString (SIZE(3))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9")),
isovds PrintableString (SIZE(6))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9")),
isovisModelyear PrintableString (SIZE(1))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9")),
isovisSeqPlant PrintableString (SIZE(7))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9"))

9.1.5.3.4. Parameters and Defined Values

Values with
Field Min Max special
meaning

<action> The action to do - - -

Setting the static parameters
0 of the MSD.

Setting the dynamic

1
parameters of the MSD.

4115730 Rev 5.0 March 26, 2015 218

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Values with
Field Min Max special
meaning

Setting the pre encoded

2
MSD.

<ID> The version ID of the MSD. 1 2 -

<MsgId> Integer for ID. 0 255 -

Bit mask for

automaticActivation, testCall
and positionCanBeTrusted
MSD parameters - - -
bits set to 1 for TRUE
bits set to 0 for FALSE
<control> 0 all parameters set to FALSE
automaticActivation
1 (bit 0) - - -
parameter set to TRUE
testCall parameter set to
2 (bit 1) - - -
TRUE
positionCanBeTrusted
4 (bit 2) - - -
parameter set to TRUE

Integer for timestamp value 4294967295

0: failed to get
<timeStamp> according [3]. Seconds since 0 =
1970:00:00:00. time
0xFFFFFFFF

0x7FFFFFFF=
Integer for location -
+324000000 2147483647:
Latitude value 324000000
<vehicleLocation. locationLatitude> latitude is
according to [3]. (+90°)
(-90°) invalid or
Unit is in mas.
unknown
0x7FFFFFFF
- =
Integer for location +648000000
648000000 2147483647:
<vehicleLocation.PositionLongitude> Longitude value
(+180°) longitude is
according to [3]. (-180°) invalid or
unknown
Integer for vehicle
Direction according 0xFF:
to [3]. direction is
<vehicleDirection> 0 179
Degrees from invalid or
magnetic North, 2- unknown
deg steps.
Integer for location
Latitude value
according to
-512
[3]. – OPTIONAL +511
<recentVehicleLocationN1.latitudeDelta> (51.2''S) -
VALUE (51.1''N)
Unit is 100-mas
steps (latitude
delta).

4115730 Rev 5.0 March 26, 2015 219

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

Values with
Field Min Max special
meaning

Integer for location

Longitude value
according to [3].–
-512 +511
<recentVehicleLocationN1.longitudeDelta> OPTIONAL VALUE -
(51.2''W) (51.1''E)
Unit is 100-mas
steps (longitude
delta)
Integer for location
Latitude value
according to
-512
<recentVehicleLocationN2.latitudeDelta> [3]. – OPTIONAL (51.2''S) +511
-
VALUE (51.1''N)
Unit is 100-mas
steps (latitude
delta).
Integer for location
Longitude value
according to [3]. –
OPTIONAL VALUE -512 +511
<recentVehicleLocationN2.longitudeDelta> -
(51.2''W) (51.1''E)
Unit is 100-mas
steps (longitude
delta)
Integer – 255: invalid or
<numberOfPassengers> OPTIONAL 0 255
Parameter unknown

OID identifier in “dot

notation” –
< additionalData.oid> - - -
OPTIONAL
PARAMETER
ASCII string –
< additionalData.data> OPTIONAL - - -
PARAMETER
ASCII string – The
<ASN1encodedMSD> MSD ASN.1 - - -
encoded in hex.

9.1.5.3.5. Examples

Command Responses

AT+ECALLSETMSD=0,1,1,"WWW","VDSVD
S","Y","A123456",17
OK

AT+ECALLSETMSD=1,1,7,123456789,173
881200,41822520,14,,,,,5
OK

AT+ECALLSETMSD? +ECALLSETMSD:
"01040381D75D70D65C3597CA0420C414675E0EB79A
2B14BA6EE104FC52701C0A "
OK

4115730 Rev 5.0 March 26, 2015 220

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.5.4. Command +ECALLCANCEL

9.1.5.4.1. Description
This AT command cancels the ongoing manual call if it has not yet been established and goes back to
idle. It is up to the Host to verify that the user has rights to cancel corresponding to parameter
ECALL_MANUAL_CAN_CANCEL in the case that this is applicable.

9.1.5.4.2. Syntax

Action command
AT+ECALLCANCEL

OK

Read command
AT+ECALLCANCEL?

OK

Test command
AT+ECALLCANCEL=?

OK

9.1.5.4.3. Examples

Command Responses

AT+ECALLCANCEL OK
or
ERROR
(if the cancel was not allowed)

9.1.5.5. Command +ECALLRELEASE

9.1.5.5.1. Description
This command closes the UNIFIED ECALL Service functionality. All values go back to default. Host
will have to call AT+ECALLINIT to restart.

4115730 Rev 5.0 March 26, 2015 221

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.5.5.2. Syntax

Action command
AT+ECALLRELEASE

OK

Read command
AT+ECALLRELEASE?

OK

Test command
AT+ECALLRELEASE=?

OK

9.1.5.5.3. Examples

Command Responses

AT+ECALLRELEASE OK
or
ERROR

4115730 Rev 5.0 March 26, 2015 222

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.5.6. Command +ECALLGETSTATE

9.1.5.6.1. Description
This command returns the state of the Unified eCall Service manager.

9.1.5.6.2. Syntax

Action command
AT+ECALLGETSTATE
+ECALLGETSTATE: <state>
OK

Read command
AT+ECALLGETSTATE?

OK

Test command
AT+ECALLGETSTATE=?

OK

9.1.5.6.3. Parameters and Defined Values

<state> State of the Unified eCall Service Manager

0 ECALL_STATE_INACTIVE

1 ECALL_STATE_IDLE

2 ECALL_STATE_CALLING

3 ECALL_STATE_CONNECTED

4 ECALL_STATE_SENDING_MSD

5 ECALL_STATE_VOICE_CALL

4115730 Rev 5.0 March 26, 2015 223

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.1.5.7. Command +ECALLVERSION

9.1.5.7.1. Description
This command returns the version of the Unified eCall Service manager.

9.1.5.7.2. Syntax

Action command
AT+ECALLVERSION
+ECALLVERSION: <version>

OK

Read command
AT+ECALLVERSION?

OK

Test command
AT+ECALLVERSION=?

OK

9.1.5.7.3. Parameters and Defined Values

<version> Unified eCall Service Manager version including:

• AT command set version
• Unified eCall Library version

9.1.5.8. Command +ECALLOPTDATA

9.1.5.8.1. Description
The MSD contains optional data. The optional data is an OID, that describes how the data part should
be interpreted and then the data which is ANS.1 encoded.
The ERA GLONASS union has proposed one encoding for the optional data.
This AT command helps encode the data part of the optional data part of the MSD into ASN.1 format.

4115730 Rev 5.0 March 26, 2015 224

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

This is a utility command that permits to encode the optional data part for ERA GLONASS.
It is up to the caller to then paste the encoded ANS.1 string into the AT+ECALLSETMSD command.
Note that the optional part of the MSD is current not used in the PAN European standard.
The ASN.1 specification
ERAAdditionalData ::= SEQUENCE {
crashSeverityASI15 INTEGER(0..2047) OPTIONAL,
diagnosticResult DiagnosticResult OPTIONAL,
crashInfo CrashInfo OPTIONAL,
...
}

DiagnosticResult ::= SEQUENCE {

micConnectionFailure BOOLEAN OPTIONAL,
micFailure BOOLEAN OPTIONAL,
rightSpeakerFailure BOOLEAN OPTIONAL,
leftSpeakerFailure BOOLEAN OPTIONAL,
speakersFailure BOOLEAN OPTIONAL,
ignitionLineFailure BOOLEAN OPTIONAL,
uimFailure BOOLEAN OPTIONAL,
statusIndicatorFailure BOOLEAN OPTIONAL,
batteryFailure BOOLEAN OPTIONAL,
batteryVoltageLow BOOLEAN OPTIONAL,
crashSensorFailure BOOLEAN OPTIONAL,
firmwareImageCorruption BOOLEAN OPTIONAL,
commModuleInterfaceFailure BOOLEAN OPTIONAL,
gnssReceiverFailure BOOLEAN OPTIONAL,
raimProblem BOOLEAN OPTIONAL,
gnssAntennaFailure BOOLEAN OPTIONAL,
commModuleFailure BOOLEAN OPTIONAL,
eventsMemoryOverflow BOOLEAN OPTIONAL,
crashProfileMemoryOverflow BOOLEAN OPTIONAL,
otherCriticalFailires BOOLEAN OPTIONAL,
otherNotCriticalFailures BOOLEAN OPTIONAL
}

CrashInfo ::= SEQUENCE {

crashFront BOOLEAN OPTIONAL,
crashLeft BOOLEAN OPTIONAL,
crashRight BOOLEAN OPTIONAL,
crashRear BOOLEAN OPTIONAL,
crashRollover BOOLEAN OPTIONAL,
crashSide BOOLEAN OPTIONAL,

4115730 Rev 5.0 March 26, 2015 225

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

crashFrontOrSide BOOLEAN OPTIONAL,

crashAnotherType BOOLEAN OPTIONAL

9.1.5.8.2. Syntax

Action command
AT+ECALLOPTDATA= <ID>[,<crashSeverityASI15>]
[,<PresenceMaskDiagnosticResult>,<diagnosticResult>]
[,<PresenceMaskCrashInfo>,<crashInfo>]
OK

Read command
AT+ ECALLOPTDATA?
+ECALLOPTDATA: <ID>,<crashSeverityASI15>
,<PresenceMaskDiagnosticResult>,<diagnosticResult>
,<PresenceMaskCrashInfo>,<crashInfo>
OK

Test command
AT+ECALLOPTDATA=?
OK

9.1.5.8.3. Parameters and Defined Values

<ID> The version of the ASN.1 encoding. Set to 1. For future

upgrades.

<crashSeverityASI15 > Optional integer representing the crash severity. Value range
[0.2047}

<PresenceMaskDiagnosticResult> hex Bitmask entered in hexadecimal.This value is optional.

Each bit corresponds to the presence of the values in the same
bit in the following parameter <diagnosticResult>.

<diagnosticResult> hex Value entered in hexadecimal.

This Value is optional.
Bit mask for different Boolean values of the diagnosticResult
bits set to 1 for TRUE
bits set to 0 for FALSE

bit 0 micConnectionFailure - incorrect connection of microphone

bit 1 micFailure - operational unavailability of microphone

4115730 Rev 5.0 March 26, 2015 226

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

bit 2 rightSpeakerFailure - fault in right speaker

bit 3 leftSpeakerFailure - fault in left speaker

bit 4 speakersFailure - fault in speakers

bit 5 ignitionLineFailure - fault in definition of ignition line status

definition

bit 6 uimFailure - fault in user interface

bit 7 statusIndicatorFailure - fault in status indicator

bit 8 batteryFailure - fault in spare battery

bit 9 batteryVoltageLow - charge in spare battery below allowable

level

bit 10 crashSensorFailure - fault in automatic road accident

identification sensor

bit 11 firmwareImageCorruption - violation of integrity of software

image

bit 12 commModuleInterfaceFailure - no operational availability of

interface with GSM and UMTS communication module

bit 13 gnssReceiverFailure - no operational availability of GNSS

receiver

bit 14 raimProblem - absence of integrity (reliability) of the specified

GNSS receiver navigational and time parameters (RAIM
function)

bit 15 gnssAntennaFailure - no operational availability (incorrect wiring)

of GNSS internal antenna

bit 16 commModuleFailure - no operational availability (incorrect

connection) of external GSM and UMTS antennas.

bit 17 eventsMemoryOverflow - overfilling of internal memory for

events

bit 18 crashProfileMemoryOverflow - overfilling of memory for

recording acceleration profile

bit 19 otherCriticalFailires - other critical errors. Spelling matches

specification.

bit 20 otherNotCriticalFailures – other not critical errors.

<PresenceMaskCrashInfo> Bitmask entered in hexadecimal.This value is optional.

Each bit corresponds to the presence of the values in the same
bit in the following parameter <crashInfo>.

<crashInfo> hex Value entered in hexadecimal.

This Value is optional.
Bit mask for different Boolean values of the CrashType
bits set to 1 for TRUE
bits set to 0 for FALSE

bit 0 crashFront

bit 1 crashLeft

bit 2 crashRight

bit 3 crashRear

4115730 Rev 5.0 March 26, 2015 227

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

bit 4 crashRollover

bit 5 crashSide

bit 6 crashFrontOrSide

bit 7 crashAnotherType

9.1.5.8.4. Examples

Command Responses

AT+ECALLOPTDATA=1,2000,1FFFFF,0
,1F,14

Note:

crashSeverityASI15 – 2000.

PresenceMaskDiagnosticResult – all values present. +ECALLOPTDATA: "7FA1FFFFF000007C14"

diagnosticResult– all values False
OK
PresenceMaskCrashInfo – values in bit 0 to 4 is present in or
the CrashInfo
ERROR
crashInfo– following values are present and set

crashFront FALSE,

crashLeft FALSE,

crashRight TRUE,

crashRear FALSE,

crashRollover TRUE

AT+ECALLOPTDATA? +ECALLOPTDATA: 1,2000,1FFFFF,0,1F,14

OK

9.1.5.9. Command +CECALL

9.1.5.9.1. Description
This AT command is used to call an emergency number, test number or reconfiguration number as
specified by SIM.
Note that this command is specified in 3GPP and could be used apart from the Unified eCall
Manager. But if the Unified eCall manager is initialized, it will handle the retry attempts. The Unified
Ecall Service manager will then handle the call and call retries in accordance to Unified eCall settings
values.
For complete information regarding the +CECALL, see the previous +CECALL section.

4115730 Rev 5.0 March 26, 2015 228

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.2. Asynchronous Events

9.2.1. Asynchronous Library Control Command Events

When the channel is opened, a series of events are generated as the MSD transmission takes place.
These events are unsolicited responses which provide information about the progress of the open
channel.
The events are associated with the +INBMOPEN AT Command described in this document.

9.2.1.1. Syntax

Unsolicited response
+INBMEV: <ev> (Unsolicited events to display the progress on the open channel)

9.2.1.2. Parameters and Defined Values

<ev>: The parameter specifies the value returned to display the progress of the open
channel.
0 INBM_MSD_REQ_RECEIVED. It specifies that the MSD request has been
received.
1 INBM_MSD_REQ_NOT_RECEIVED. It specifies that the MSD request has
not been received.
2 INBM_LLACK_RECEIVED
3 INBM_HLACK_RECEIVED.
4 INBM_LLACK_NOT_RECEIVED
5 INBM_HLACK_NOT_RECEIVED
6 INBM_ABORT_RECEIVED
7 INBM_HLACK_RECEIVED_CLEARDOWN

9.2.2. Asynchronous Unified eCall Service Events

9.2.2.1. Command +ECALLEV

9.2.2.1.1. Description
The following asynchronous events can be received as unsolicited responses:
+ECALLEV: During the Emergency call and sending of the MSD informational indications will be
given, indicating the event that occurred and the state before and after the event was processed.

4115730 Rev 5.0 March 26, 2015 229

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.2.2.1.2. Syntax

Unsolicited response
+ECALLEV: <eventid>,<statebefore>,<stateafter>

9.2.2.1.3. Parameters and Defined Values

<eventid> The event id that arrived corresponding the following values.

Please also see eCall_info_events_e.
0 ECALL_EVENT_INBM_MSD_REQ_RECEIVED
1 ECALL_EVENT_INBM_MSD_REQ_NOT_RECEIVED
2 ECALL_EVENT_INBM_LLACK_RECEIVED
3 ECALL_EVENT_INBM_HLACK_RECEIVED
4 ECALL_EVENT_INBM_LLACK_NOT_RECEIVED
5 ECALL_EVENT_INBM_HLACK_NOT_RECEIVED
6 ECALL_EVENT_INBM_ABORT_RECEIVED
7 ECALL_EVENT_INBM_HLACK_RECEIVED_CLEARDOWN
20 ECALL_EVENT_CALL_CONNECTED
21 ECALL_EVENT_CALL_NOT_CONNECTED
22 ECALL_EVENT_CALL_ENDED
23 ECALL_EVENT_CALL_WILL_RETRY
24 ECALL_EVENT_CALL_ATTEMPT_FAILED
25 ECALL_EVENT_CALL_INCOMING
50 ECALL_EVENT_TIMER_EXPIRED_DIAL_DURATION
51 ECALL_EVENT_TIMER_EXPIRED_T2_CALL_DURATION
<statebefore>, State before and after will have the following numerical values
<stateafter> Also see eCall_states_e.
0 ECALL_STATE_INACTIVE
1 ECALL_STATE_IDLE
2 ECALL_STATE_CALLING
3 ECALL_STATE_CONNECTED
4 ECALL_STATE_SENDING_MSD
5 ECALL_STATE_VOICE_CALL

9.2.2.2. Command +ECALLERROR

9.2.2.2.1. Description
The following asynchronous events can be received as unsolicited responses:
+ECALLERROR: An error has been detected somewhere outside the scope of a normal AT command
call. Not to be confused with the CME Errors.

4115730 Rev 5.0 March 26, 2015 230

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

9.2.2.2.2. Syntax

Unsolicited response
+ECALLERROR: <error>

9.2.2.2.3. Parameters and Defined Values

<error> An error event has occurred, these are the following values and meanings.
Also see eCall_error_event_e.
-100 ECALL_EV_ERROR_NO_SIM
-101 ECALL_EV_ERROR_PIN_NOT_READY
-102 ECALL_EV_ERROR_NO_CARRIER
-103 ECALL_EV_ERROR_SETUP_ERROR
-104 ECALL_EV_ERROR_NO_ANSWER
-105 ECALL_EV_ERROR_BUSY

9.3. Example of AT Command Sequence

The following are the AT command sequences for Pull mode and Push mode.

9.3.1. Pull Mode

1. AT+INBMINIT =0
OK

2. Generate a Voice Call to the PSAP server.

3.AT+INBMOPEN=0,”015C0681D54970D65C3597CA0420C41464583ADE68AC52E9BB8413F149C07414FB414F601018081
3E82181823230"
+INBMOPEN: 0
OK

4. Wait for START messages from the PSAP.

Monitor the MSD transaction progress through the Call back (unsolicited) events
+INBMEV: 0
+INBMEV: 2
+INBMEV: 3

5. AT+INBMCHSTATE?
+INBMCHSTATE: 0
OK

4115730 Rev 5.0 March 26, 2015 231

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

6.
AT+INBMSETMSD=”015C0681D54970D65C3597CA0420C41464583ADE68AC52E9BB8413F149C07414FB414F601018081
3E82181823230"
[Note: Only If the channel State is IDLE]
OK
7. AT+INBMPUSH [ Send the MSD_SEND_REQ to PSAP server to initiate the MSD transaction]
+INBMOPEN: 1
OK

8. AT+INBMCHSTATE?
+INBMCHSTATE: 1
OK

9. AT+INBMCLOSE
OK

10. AT+INBMEXIT
OK
11. Disconnect the Voice call with PSAP Server.

9.3.2. Push Mode

1. AT+INBMINIT =0
OK

2. Generate a Voice Call to the PSAP server.

3.AT+INBMOPEN=1,”015C0681D54970D65C3597CA0420C41464583ADE68AC52E9BB8413F149C07414FB414F601018081
3E82181823230"
+INBMOPEN: 1
OK

4. MSD_SEND_REQ would be sent to PSAP.

Wait for START messages from the PSAP. Monitor the MSD transaction progress through the Call back events
+INBMEV: 0
+INBMEV: 2
+INBMEV: 3

5. AT+INBMCHSTATE?
+INBMCHSTATE: 0
OK

6. AT+INBMCLOSE
OK

4115730 Rev 5.0 March 26, 2015 232

 eCall In-Band Modem Library
Extended AT Commands Manual Commands

7. AT+INBMEXIT
OK

8. Disconnect the Voice call with PSAP Server.

9.4. In-Band AT Command Error Codes

The following error codes could be returned from In-Band AT commands.

Table 6. Location AT Commands Error Codes

Error Error name Description

Code

-1 INBM_ERROR The function has been called in an unauthorized

application state
-21 INBM_ERR_INIT/INBM_ERR_EXIT The requested action has been already
performed and the target application state is
currently activated.
-22 INBM_ERR_INVOPT Invalid input parameter.
-23 INBM_ERR_INTERN This feature or configuration is not available for
software and/or hardware version.
-24 INBM_ERR_BAD_STATE A state transition is in progress.
-25 INBM_ERR_BAD_CHANNEL_STATE The initialization of the porting layer failed
(Internal error)
-26 INBM_ERR_MAX_CHANNEL_ALREADY_OPENED Application initialization error
-27 INBM_ERR_AUDIO IO initialization error
-28 INBM_ERR_CHANNEL Bus initialization error
-29 INBM_ERR_CHANNEL_STILL_OPENED Scheduler initialization error
-30 INBM_ERR_UNKNOWN_HANDLE Application core software initialization error
-31 INBM_ERR_SEMAPHORE Non-Volatile memory initialization error
-32 INBM_ERR_SEMAPHORE_SERVICE_LOCKED Application task schedule error.
-33 INBM_ERR_TIMER Timer error

4115730 Rev 5.0 March 26, 2015 233

 10. ERA GLONASS Service Manager
Commands

10.1. AT Commands Reference

10.1.1. Command +ERAGINIT

10.1.1.1. Description
This AT command is used to initializes the ERA GLONASS Application and provides the vehicle
related information of the MSD.

10.1.1.2. Syntax

Action command
AT+ERAGINIT=<vehicleType>,<isowmi>,<isovds>,<isovisModelYear>,<isovisSeqPlant>,<veh
iclePropulsionStorageType>
OK

Read command
AT+ERAGINIT?
+ERAGINIT: <vehicleType>,<isowmi>,<isovds>,<isovisModelYear>,
<isovisSeqPlant>,<vehiclePropulsionStorageType>
OK

Test command
AT+ERAGINIT=?
OK

10.1.1.3. Parameters and Defined Values

<vehicleType> Int The type of vehicle. Integer value according to

[3]

<isowmi> string[3] World Manufacturer Index according to [3]

4115730 Rev 5.0 March 26, 2015 234

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

<isovds> string[6] Vehicle Type Descriptor according to [3]

<isovisModelyear> string[1] Model Year according to [3]

<isovisSeqPlant> string[7] Plant code and sequential number according to

[3]

<vehiclePropulsionStorageType> Bit mask for vehicleStorageType parameter.

Value entered in Hex.
bits set to 1 for TRUE
bits set to 0 for FALSE

0 all values set to FALSE.

1 (bit 0) gasolineTankPresent parameter set to TRUE

2 (bit 1) dieselTankPresent parameter set to TRUE

4 (bit 2) compressedNaturalGas parameter set to TRUE

8 (bit 3) liquidPropaneGas parameter set to TRUE

10 (bit 4) electricEnergyStorage parameter set to TRUE

20 (bit 5) hydrogenStorage parameter set to TRUE

Please note that the above mentioned fields accepts only a limited set of characters. Here are the
possible values as stated by ISO 3779 standard:

-- isowmi: World Manufacturer Index (WMI)

-- isovds: Vehicle Type Descriptor (VDS)
-- Vehicle Identifier Section (VIS) consisting of
-- isovisModelyear: Modelyear from Vehicle Identifier Section (VIS)
-- isovisSeqPlant: Plant code + sequential number
-- from Vehicle Identifier Section (VIS)
VIN ::= SEQUENCE {
isowmi PrintableString (SIZE(3))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9")),
isovds PrintableString (SIZE(6))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9")),
isovisModelyear PrintableString (SIZE(1))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9")),
isovisSeqPlant PrintableString (SIZE(7))
(FROM("A".."H"|"J".."N"|"P"|"R".."Z"|"0".."9"))

4115730 Rev 5.0 March 26, 2015 235

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.1.4. Examples

Command Responses

AT+ERAGINIT=1,"WM9",
"VDSVDS","Y","A12345
6",A OK
or
ERROR: (In case the command fails)

Note: Car with both Diesel tank and

liquid Propane Gas. 0x2+0x8 = 0xA.

AT+ERAGINIT? +ERAGINIT: 1,"WM9","VDSVDS","Y","A123456",A

OK

4115730 Rev 5.0 March 26, 2015 236

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.2. Command +ERAGSETERA

10.1.2.1. Description
There are certain parameters that affect the ERA GLONASS Specific behavior.
They all have default values according to [3]. One or several values can be changed via this
command.
Each parameter is optional, so if there is no need to change the default value, it can be left empty.

10.1.2.2. Syntax

Action command
AT+ERAGSETERA=[<CCFT_T2>],[<INVITATION_SIGNAL_DURATION_T3>],
[<SEND_MSG_PERIOD_T5>],[<AL_ACK_PERIOD_T6>],
[<MSD_MAX_TRANSMISSION_TIME_T7>],[<ECALL_DIAL_DURATION>],
[<ECALL_AUTO_DIAL_ATTEMPS>],[<ECALL_MANUAL_DIAL_ATTEMPS>],
[<ECALL_TIME_BETWEEN_REDIALS>],[<ECALL_TIME_BEFORE_UNMUTE_AFTER_AL_ACK>]

OK

Read command
AT+ERAGSETERA?
+ERAGSETERA: <CCFT_T2>,<INVITATION_SIGNAL_DURATION_T3>,
<SEND_MSG_PERIOD_T5>,<AL_ACK_PERIOD_T6>,<MSD_MAX_TRANSMISSION_TIME_T7>,
<ECALL_DIAL_DURATION>,<ECALL_AUTO_DIAL_ATTEMPS>,<ECALL_MANUAL_DIAL_ATTEMPS>,<ECALL_
TIME_BETWEEN_REDIALS>,<ECALL_TIME_BEFORE_UNMUTE_AFTER_AL_ACK>
OK

Test command
AT+ERAGSETERA=?
+ERAGSETERA: (list of supported <CCFT_T2>),
(list of supported <INVITATION_SIGNAL_DURATION_T3>),
(list of supported <SEND_MSG_PERIOD_T5>),
(list of supported <AL_ACK_PERIOD_T6>),
(list of supported <MSD_MAX_TRANSMISSION_TIME_T7>),
(list of supported <ECALL_DIAL_DURATION>),
(list of supported <ECALL_AUTO_DIAL_ATTEMPS>),
(list of supported <ECALL_MANUAL_DIAL_ATTEMPS>)
(list of supported <ECALL_TIME_BETWEEN_REDIALS>)
(list of supported <ECALL_TIME_BEFORE_UNMUTE_AFTER_AL_ACK>)

OK

4115730 Rev 5.0 March 26, 2015 237

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.2.3. Parameters and Defined Values

Default
Parameter name Type The type of option to set
Values

<CCFT_T2 > Integer T2 timer in seconds 3600

<INVITATION_SIGNAL_DURATION_T3 > Integer T3 timer in seconds 2
<SEND_MSG_PERIOD_T5> Integer T5 timer in seconds 5
<AL_ACK_PERIOD_T6> Integer T6 timer in seconds 5
<MSD_MAX_TRANSMISSION_TIME_T7> Integer T7 timer in seconds 20
The duration of each dial
<ECALL_DIAL_DURATION> Integer 300
attempt in seconds.
The number of dial attempts
<ECALL_AUTO_DIAL_ATTEMPS> Integer for a automatically generated 10
call.
The number of dial attempts
<ECALL_MANUAL_DIAL_ATTEMPS> Integer for a manually generated 10
call.
The minimum time between
< ECALL_TIME_BETWEEN_REDIALS> Integer 1
redials in seconds.
The time to delay the unmute
and the HLACK event, after
the actual HLACK event has
<ECALL_TIME_BEFORE_UNMUTE_AFTER_AL_ACK> Integer been detected. Value is 20
given in steps of 100ms.
Note that the default value 20
is 2 seconds.

10.1.2.4. Examples

Command Responses Comment

AT+ERAGSETERA=,,2 OK Setting the SEND_MSG_PERIOD_T5

to 2 seconds. Leaving the rest
or of the parameters with default
ERROR values.

AT+ERAGSETERA? +ERAGSETERA: Read the values.

3600,2,2,5,20,300,10,10,1
,20
OK

4115730 Rev 5.0 March 26, 2015 238

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.3. Command +ERAGCALL

10.1.3.1. Description
This AT command is used to call an emergency number or test number. MSD related information
must be provided for it to work.
The ERA GLONASS Service manager will then handle the call and call retries in accordance to ERA
GLONASS settings values.
If the MSD is successfully updated it will result in an unsolicited response +ERAGMSD.

10.1.3.2. Syntax

Action command
AT+ERAGCALL=<number>,<ID>,<MsgId>,<control>,<timeStamp>,
<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>
[,[<recentVehicleLocationN1.latitudeDelta>]
[,[<recentVehicleLocationN1.longitudeDelta>]
[,[<recentVehicleLocationN2.latitudeDelta>]
[,[<recentVehicleLocationN2.longitudeDelta>]
[,<numberOfPassengers>
[,<additionalData.oid>,<additionalData.data>]]]]]]

OK

Read command
AT+ERAGCALL?
OK

Test command
AT+ERAGCALL=?
OK

10.1.3.3. Parameters and Defined Values

Values with
Field Min Max special
meaning

The telephone
<number> number to call. May
specify category.
- - -

4115730 Rev 5.0 March 26, 2015 239

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

Values with
Field Min Max special
meaning

The version ID of the

<ID> 1 2 -
MSD.

<MsgId> Integer for ID. 0 255 -

Bit mask for

automaticActivation,
testCall and
positionCanBeTruste
d MSD parameters - - -
bits set to 1 for TRUE
bits set to 0 for
FALSE
all parameters set to
<control> 0
FALSE
automaticActivation
1 (bit 0) parameter set to - - -
TRUE
testCall parameter
2 (bit 1) - - -
set to TRUE
positionCanBeTruste
4 (bit 2) d parameter set to - - -
TRUE
Integer for timestamp 4294967295
<timeStamp value according [3]. = 0: failed to get
0
> Seconds since 0xFFFFFFF time
1970:00:00:00. F
0x7FFFFFFF
Integer for location - =
Latitude value 32400000 +324000000 2147483647:
<vehicleLocation. locationLatitude> 0
according to [3]. Unit (+90°) latitude is
is in mas. (-90°) invalid or
unknown
0x7FFFFFFF
- =
Integer for location 64800000 +648000000 2147483647:
<vehicleLocation.PositionLongitude> Longitude value 0 (+180°) longitude is
according to [3].
(-180°) invalid or
unknown
Integer for vehicle
Direction according to 0xFF:
[3]. direction is
<vehicleDirection> 0 179
Degrees from invalid or
magnetic North, 2- unknown
deg steps.
Integer for location
Latitude value
according to -512
+511
<recentVehicleLocationN1.latitudeDelta> [3]. – OPTIONAL (51.2''S) -
VALUE (51.1''N)
Unit is 100-mas steps
(latitude delta).

4115730 Rev 5.0 March 26, 2015 240

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

Values with
Field Min Max special
meaning

Integer for location

Longitude value
<recentVehicleLocationN1.longitudeDelta according to [3].– -512 +511
-
> OPTIONAL VALUE (51.2''W) (51.1''E)
Unit is 100-mas steps
(longitude delta)
Integer for location
Latitude value
according to -512
(51.2''S) +511
<recentVehicleLocationN2.latitudeDelta> [3]. – OPTIONAL (51.1''N)
-
VALUE
Unit is 100-mas steps
(latitude delta).
Integer for location
Longitude value
<recentVehicleLocationN2.longitudeDelta according to [3]. – -512 +511
OPTIONAL VALUE -
> (51.2''W) (51.1''E)
Unit is 100-mas steps
(longitude delta)
Integer – OPTIONAL 255: invalid or
<numberOfPassengers> 0 255
Parameter unknown
OID identifier in “dot
notation” –
< additionalData.oid> - - -
OPTIONAL
PARAMETER
ASCII string –
< additionalData.data> OPTIONAL - - -
PARAMETER

10.1.3.4. Examples

Command Responses

AT+ERAGCALL="112",1,0,7,123456,123,4 OK
56,255,,,,,2
Note: any errors will be given
OK through unsolicited +ERAGERROR.

4115730 Rev 5.0 March 26, 2015 241

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.3.5. +ERAGSETMSD

10.1.3.6. Description
This AT command updates the MSD with the values given and returns the encoded MSD in ASN1
PER format. This will be useful for queue handling and eSMS.
If the PSAP calls the IVS, the ERA GLONASS Service Manager will return this MSD.
The use case is that if a eCall fails to send the MSD, then the host should try to send a eSMS. This
helps the Host to encode it into ASN1 encoding.
If the MSD is successfully updated it will result in an unsolicited response +ERAGMSD.

10.1.3.7. Syntax

Action command
AT+ERAGSETMSD=<ID>,<MsgId>,<control>,<timeStamp>,
<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>
[,[<recentVehicleLocationN1.latitudeDelta>]
[,[<recentVehicleLocationN1.longitudeDelta>]
[,[<recentVehicleLocationN2.latitudeDelta>]
[,[<recentVehicleLocationN2.longitudeDelta>]
[,<numberOfPassengers>
[,<additionalData.oid>,<additionalData.data>]]]]]]

OK

Read command
AT+ERAGSETMSD?
+ERAGSETMSD: <ID>,<MsgId>,<control>,<timeStamp>,
<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>,
[<recentVehicleLocationN1.latitudeDelta>],
[<recentVehicleLocationN1.longitudeDelta>],
[<recentVehicleLocationN2.latitudeDelta>],
[<recentVehicleLocationN2.longitudeDelta>],
[<numberOfPassengers>],
[<additionalData.oid>,<additionalData.data>]
OK

Test command
AT+ERAGSETMSD=?
OK

4115730 Rev 5.0 March 26, 2015 242

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.3.8. Parameters and Defined Values

<ID> The version ID of the MSD.

<MsgId> Integer for ID.

<control> Bit mask for automaticActivation, testCall and

positionCanBeTrusted MSD parameters
bits set to 1 for TRUE
bits set to 0 for FALSE

0 all parameters set to FALSE

1 (bit 0) automaticActivation parameter set to TRUE

2 (bit 1) testCall parameter set to TRUE

4 (bit 2) positionCanBeTrusted parameter set to TRUE

<timeStamp> Integer for timestamp value according [3]

< vehicleLocation. Integer for location Latitude value according to [3].

locationLatitude>

<vehicleLocation.PositionLo Integer for location Longitude value according to [3].

ngitude >

<vehicleDirection> Integer for vehicle Direction according to [3].

<recentVehicleLocationN1.l Integer for location Latitude value according to [3]. – OPTIONAL VALUE
atitudeDelta>

<recentVehicleLocationN1.l Integer for location Longitude value according to [3]. – OPTIONAL VALUE
ongitudeDelta>

<recentVehicleLocationN2.l Integer for location Latitude value according to [3]. – OPTIONAL VALUE
atitudeDelta>

<recentVehicleLocationN2.l Integer for location Longitude value according to [3]. – OPTIONAL VALUE
ongitudeDelta>

<numberOfPassengers> Integer – OPTIONAL Parameter

< additionalData.oid> OID identifier in “dot notation” – OPTIONAL PARAMETER

< additionalData.data> ASCII string – OPTIONAL PARAMETER

4115730 Rev 5.0 March 26, 2015 243

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.3.9. Examples

Command Responses

AT+ERAGSETMSD=,1,,123,111,222 +ERAGMSD: <MSD in ASN1>

OK

Note: Updating selected parameters timestamp & current or

position with new values. Also increasing the MSD MsgId
numbering ERROR

AT+ERAGSETMSD? +ERAGSETMSD: 1,1,5,123,111,222,128,,,,,4,,

OK

4115730 Rev 5.0 March 26, 2015 244

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.4. Command +ERAGSETMSD

10.1.4.1. Description
This AT command updates the MSD with the values given and returns the encoded MSD in ASN1
PER format. This will be useful for queue handling and eSMS.
If the PSAP calls the IVS, the ERA GLONASS Service Manager will return this MSD.
The use case is that if a eCall fails to send the MSD, then the host should try to send a eSMS. This
helps the Host to encode it into ASN1 encoding.
If the MSD is successfully updated it will result in an unsolicited response +ERAGMSD.

10.1.4.2. Syntax

Action command
AT+ERAGSETMSD=<ID>,<MsgId>,<control>,<timeStamp>,
<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>
[,[<recentVehicleLocationN1.latitudeDelta>]
[,[<recentVehicleLocationN1.longitudeDelta>]
[,[<recentVehicleLocationN2.latitudeDelta>]
[,[<recentVehicleLocationN2.longitudeDelta>]
[,<numberOfPassengers>
[,<additionalData.oid>,<additionalData.data>]]]]]]

OK

Read command
AT+ERAGSETMSD?
+ERAGSETMSD: <ID>,<MsgId>,<control>,<timeStamp>,
<vehicleLocation.PositionLatitude>,
<vehicleLocation.PositionLongitude>,<vehicleDirection>,
[<recentVehicleLocationN1.latitudeDelta>],
[<recentVehicleLocationN1.longitudeDelta>],
[<recentVehicleLocationN2.latitudeDelta>],
[<recentVehicleLocationN2.longitudeDelta>],
[<numberOfPassengers>],
[<additionalData.oid>,<additionalData.data>]
OK

Test command
AT+ERAGSETMSD=?
OK

4115730 Rev 5.0 March 26, 2015 245

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.4.3. Parameters and Defined Values

Values with
Field Min Max special
meaning

The version ID of the

<ID> 1 2 -
MSD.

<MsgId> Integer for ID. 0 255 -

Bit mask for

automaticActivation,
testCall and
positionCanBeTrusted - - -
MSD parameters
bits set to 1 for TRUE
bits set to 0 for FALSE
all parameters set to
0
<control> FALSE
automaticActivation
1 (bit 0) parameter set to - - -
TRUE
testCall parameter set
2 (bit 1) - - -
to TRUE
positionCanBeTrusted
4 (bit 2) parameter set to - - -
TRUE
Integer for timestamp 4294967295
value according [3]. 0: failed to get
<timeStamp> 0 =
Seconds since time
1970:00:00:00. 0xFFFFFFFF

0x7FFFFFFF=
Integer for location -
+324000000 2147483647:
Latitude value 324000000
<vehicleLocation. locationLatitude> latitude is
according to [3]. Unit (+90°)
(-90°) invalid or
is in mas.
unknown
0x7FFFFFFF
- =
Integer for location +648000000
648000000 2147483647:
<vehicleLocation.PositionLongitude> Longitude value
(+180°) longitude is
according to [3]. (-180°) invalid or
unknown
Integer for vehicle
Direction according to 0xFF:
[3]. direction is
<vehicleDirection> 0 179
Degrees from invalid or
magnetic North, 2-deg unknown
steps.
Integer for location
Latitude value
according to -512
<recentVehicleLocationN1.latitudeDelta +511
[3]. – OPTIONAL (51.2''S) -
> (51.1''N)
VALUE
Unit is 100-mas steps
(latitude delta).

4115730 Rev 5.0 March 26, 2015 246

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

Values with
Field Min Max special
meaning

Integer for location

Longitude value
<recentVehicleLocationN1.longitudeDelt according to [3].– -512 +511
-
a> OPTIONAL VALUE (51.2''W) (51.1''E)
Unit is 100-mas steps
(longitude delta)
Integer for location
Latitude value
according to -512
<recentVehicleLocationN2.latitudeDelta (51.2''S) +511
> [3]. – OPTIONAL (51.1''N)
-
VALUE
Unit is 100-mas steps
(latitude delta).
Integer for location
Longitude value
<recentVehicleLocationN2.longitudeDelt according to [3]. – -512 +511
OPTIONAL VALUE -
a> (51.2''W) (51.1''E)
Unit is 100-mas steps
(longitude delta)
Integer – OPTIONAL 255: invalid or
<numberOfPassengers> 0 255
Parameter unknown
OID identifier in “dot
notation” –
< additionalData.oid> - - -
OPTIONAL
PARAMETER
ASCII string –
< additionalData.data> OPTIONAL - - -
PARAMETER

10.1.4.4. Examples

Command Responses

AT+ERAGSETMSD=,1,,123,111,222 +ERAGMSD: <MSD in ASN1>

OK

Note: Updating selected parameters timestamp & current or

position with new values. Also increasing the MSD MsgId
numbering ERROR

AT+ERAGSETMSD? +ERAGSETMSD: 1,1,5,123,111,222,128,,,,,4,,

OK

4115730 Rev 5.0 March 26, 2015 247

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.5. Command +ERAGCALLCANCEL

10.1.5.1. Description
This AT command cancels the ongoing manual call if it has not yet been established and goes back
to idle. It is up to the Host to verify that the user has rights to cancel corresponding to parameter
ECALL_MANUAL_CAN_CANCEL.

10.1.5.2. Syntax

Action command
AT+ERAGCALLCANCEL

OK

Read command
AT+ERAGCALLCANCEL?
OK

Test command
AT+ERAGCALLCANCEL=?
OK

10.1.5.3. Examples

Command Responses

AT+ERAGCALLCANCEL OK
or
ERROR: (In case the command fails)

4115730 Rev 5.0 March 26, 2015 248

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.6. Command +ERAGRELEASE

10.1.6.1. Description
This command closes the ERA GLONASS Service functionality. All values go back to default. Host
will have to call AT+ERAGINIT to restart.

10.1.6.2. Syntax

Action command
AT+ERAGRELEASE
OK

Read command
AT+ERAGRELEASE?
OK

Test command
AT+ERAGRELEASE=?
OK

10.1.6.3. Examples

Command Responses

AT+ERAGRELEASE OK
or
ERROR: (In case the command fails)

4115730 Rev 5.0 March 26, 2015 249

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.7. Command +ERAGGETSTATE

10.1.7.1. Description
This command returns the state of the ERA GLONASS Service manager.

10.1.7.2. Syntax

Action command
AT+ERAGGETSTATE
+ERAGGETSTATE: <state>
OK

Read command
AT+ERAGGETSTATE?
OK

Test command
AT+ERAGGETSTATE=?
OK

10.1.7.3. Parameters and Defined Values

<state> State of the ERA GLONASS Service Manager

0 ERAG_STATE_INACTIVE

1 ERAG_STATE_IDLE

2 ERAG_STATE_CALLING

3 ERAG_STATE_CONNECTED

4 ERAG_STATE_SENDING_MSD

5 ERAG_STATE_VOICE_CALL

4115730 Rev 5.0 March 26, 2015 250

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.8. Command +ERAGVERSION

10.1.8.1. Description
This command returns the version of the ERA GLONASS Service manager.

10.1.8.2. Syntax

Action command
AT+ERAGVERSION
+ERAGVERSION: <version>
OK

Read command
AT+ERAGVERSION?
OK

Test command
AT+ERAGVERSION=?
OK

10.1.8.3. Parameters and Defined Values

<version> ERA GLONASS Service Manager version including:

• AT command set version
• ERA GLONASS Library version

4115730 Rev 5.0 March 26, 2015 251

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.9. Command +ERAGOPTDATA

10.1.9.1. Description
The MSD contains optional data. The optional data is an OID, that describes how the data part should
be interpreted and then the data which is ANS.1 encoded.
This AT command helps encode the data part of the optional data part of the MSD into ASN.1 format.
The result can is returned in a format directly applicable for the <additionalData.data>
AT+ERAGCALL and AT+ERAGSETMSD setting of the OID and data part.

4115730 Rev 5.0 March 26, 2015 252

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

The ASN.1 specification

ERAAdditionalData ::= SEQUENCE {
crashSeverityASI15 INTEGER(0..2047) OPTIONAL,
diagnosticResult DiagnosticResult OPTIONAL,
crashInfo CrashInfo OPTIONAL,
...
}

DiagnosticResult ::= SEQUENCE {

micConnectionFailure BOOLEAN OPTIONAL,
micFailure BOOLEAN OPTIONAL,
rightSpeakerFailure BOOLEAN OPTIONAL,
leftSpeakerFailure BOOLEAN OPTIONAL,
speakersFailure BOOLEAN OPTIONAL,
ignitionLineFailure BOOLEAN OPTIONAL,
uimFailure BOOLEAN OPTIONAL,
statusIndicatorFailure BOOLEAN OPTIONAL,
batteryFailure BOOLEAN OPTIONAL,
batteryVoltageLow BOOLEAN OPTIONAL,
crashSensorFailure BOOLEAN OPTIONAL,
firmwareImageCorruption BOOLEAN OPTIONAL,
commModuleInterfaceFailure BOOLEAN OPTIONAL,
gnssReceiverFailure BOOLEAN OPTIONAL,
raimProblem BOOLEAN OPTIONAL,
gnssAntennaFailure BOOLEAN OPTIONAL,
commModuleFailure BOOLEAN OPTIONAL,
eventsMemoryOverflow BOOLEAN OPTIONAL,
crashProfileMemoryOverflow BOOLEAN OPTIONAL,
otherCriticalFailires BOOLEAN OPTIONAL,
otherNotCriticalFailures BOOLEAN OPTIONAL
}

CrashInfo ::= SEQUENCE {

crashFront BOOLEAN OPTIONAL,
crashLeft BOOLEAN OPTIONAL,
crashRight BOOLEAN OPTIONAL,
crashRear BOOLEAN OPTIONAL,
crashRollover BOOLEAN OPTIONAL,
crashSide BOOLEAN OPTIONAL,
crashFrontOrSide BOOLEAN OPTIONAL,
crashAnotherType BOOLEAN OPTIONAL
}

4115730 Rev 5.0 March 26, 2015 253

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.1.9.2. Syntax

Action command
AT+ERAGOPTDATA=
<ID>[,<crashSeverityASI15>]ID[,crashSeverityASI15]
[,<PresenceMaskDiagnosticResult>,<diagnosticResult>]
[,<PresenceMaskCrashInfo>,<crashInfo>]
DiagnosticResultdiagnosticResultCrashInfocrashInfoOK

Read command
10.1.9.2.1.1. AT+ ERAGOPTDATA?
+ERAGOPTDATA: <ID>,<crashSeverityASI15>
,<PresenceMaskDiagnosticResult>,<diagnosticResult>
,<PresenceMaskCrashInfo>,<crashInfo>
OK

Test command
AT+ERAGOPTDATA=?
OK

10.1.9.3. Parameters and Defined Values

<ID>ID The version of the ASN.1 encoding. Set to 1. For future
upgrades.

<crashSeverityASI15 > Optional integeri representing the crash severity.severity Value

range [0.2047}

<PresenceMaskDiagnosticResult>Diag hex Bitmask entered in hexadecimal.This value is optional.

nosticResult
Each bit corresponds to the presence of the values in the same
bit in the following parameter <diagnosticResult>.

<diagnosticResult>diagnosticResult hex Value entered in hexadecimal.

This Value is optional.
Bit mask for different Boolean values of the
diagnosticResultdiagnosticResult
bits set to 1 for TRUE
bits set to 0 for FALSE

bit 0 micConnectionFailure - incorrect connection of microphone

bit 1 micFailure - operational unavailability of microphone

4115730 Rev 5.0 March 26, 2015 254

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

bit 2 rightSpeakerFailure - fault in right speaker

bit 3 leftSpeakerFailure - fault in left speaker

bit 4 speakersFailure - fault in speakers

bit 5 ignitionLineFailure - fault in definition of ignition line status

definition

bit 6 uimFailure - fault in user interface

bit 7 statusIndicatorFailure - fault in status indicator

bit 8 batteryFailure - fault in spare battery

bit 9 batteryVoltageLow - charge in spare battery below allowable

level

bit 10 crashSensorFailure - fault in automatic road accident

identification sensor

bit 11 firmwareImageCorruption - violation of integrity of software

image

bit 12 commModuleInterfaceFailure - no operational availability of

interface with GSM and UMTS communication module

bit 13 gnssReceiverFailure - no operational availability of GNSS

receiver

bit 14 raimProblem - absence of integrity (reliability) of the specified

GNSS receiver navigational and time parameters (RAIM
function)

bit 15 gnssAntennaFailure - no operational availability (incorrect wiring)

of GNSS internal antenna

bit 16 commModuleFailure - no operational availability (incorrect

connection) of external GSM and UMTS antennas.

bit 17 eventsMemoryOverflow - overfilling of internal memory for

events

bit 18 crashProfileMemoryOverflow - overfilling of memory for

recording acceleration profile

bit 19 otherCriticalFailires - other critical errors. Spelling matches

specification.

bit 20 otherNotCriticalFailures – other not critical errors.

<PresenceMaskCrashInfo>PresenceMa Bitmask entered in hexadecimal.This value is optional.

skCrashInfo
Each bit corresponds to the presence of the values in the same
bit in the following parameter <crashInfo>.

<crashInfo>crashInfo hex Value entered in hexadecimal.

This Value is optional.
Bit mask for different Boolean values of the CrashType

4115730 Rev 5.0 March 26, 2015 255

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

bits set to 1 for TRUE

bits set to 0 for FALSE

bit 0 crashFront

bit 1 crashLeft

bit 2 crashRight

bit 3 crashRear

bit 44 crashRollovercrashRollover

bit 55 crashSide

bit 66 crashFrontOrSidecrashFrontOrSide

bit 77 crashAnotherType

10.1.10. Examples

Command Responses

AT+ERAGOPTDATA=1,2000,1FFFFF,0,
1F,14

Note:

crashSeverityASI15 – 20002000.

PresenceMaskDiagnosticResult – all values present. +ERAGOPTDATA: "7FA1FFFFF000007C14"

diagnosticResult– all values False

OK
PresenceMaskCrashInfo – values in bit 0 to 4 is present in or
the CrashInfo
ERROR
crashInfo– followingcrashInfofollowing values are present
and set

crashFront FALSE,

crashLeft FALSE,

crashRight TRUE,

crashRear FALSE,

crashRollover TRUE

AT+ERAGOPTDATA? +ERAGOPTDATA: 1,2000,1FFFFF,0,1F,1414

OK

10.2. Asynchronous Events

The asynchronous events inform about the ERA GLONASS Service Managers current state and
actions.

4115730 Rev 5.0 March 26, 2015 256

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.2.1. Command +ERAGEV

10.2.1.1. Description
The following asynchronous events can be received as unsolicited responses:
+ERAGEV: During the Emergency call and sending of the MSD informational indications will be given,
indicating the event that occurred and the state before and after the event was processed.

10.2.1.2. Syntax

Unsolicited response
+ERAGEV: <eventid>,<statebefore>,<stateafter>

10.2.1.3. Parameters and Defined Values

<eventid> The event id that arrived corresponding the following values.

Please also see erag_info_events_e.

0 ERAG_EVENT_INBM_MSD_REQ_RECEIVED

1 ERAG_EVENT_INBM_MSD_REQ_NOT_RECEIVED

2 ERAG_EVENT_INBM_LLACK_RECEIVED

3 ERAG_EVENT_INBM_HLACK_RECEIVED

4 ERAG_EVENT_INBM_LLACK_NOT_RECEIVED

5 ERAG_EVENT_INBM_HLACK_NOT_RECEIVED

6 ERAG_EVENT_INBM_ABORT_RECEIVED

7 ERAG_EVENT_INBM_HLACK_RECEIVED_CLEARDOWN

20 ERAG_EVENT_CALL_CONNECTED

21 ERAG_EVENT_CALL_NOT_CONNECTED

22 ERAG_EVENT_CALL_ENDED

23 ERAG_EVENT_CALL_WILL_RETRY

24 ERAG_EVENT_CALL_ATTEMPT_FAILED

25 ERAG_EVENT_CALL_INCOMING

40 ERAG_EVENT_ERAGINIT

41 ERAG_EVENT_ERAGRELEASE

4115730 Rev 5.0 March 26, 2015 257

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

42 ERAG_EVENT_ERAGCALL

43 ERAG_EVENT_ERAGCALLCANCEL

44 ERAG_EVENT_ERAGSETMSD

45 ERAG_EVENT_ERAGSETERA

50 ERAG_EVENT_TIMER_EXPIRED_DIAL_DURATION

51 ERAG_EVENT_TIMER_EXPIRED_T2_CALL_DURATION

<statebefore>, State before and after will have the following numerical values
Also see erag_states_e.
<stateafter>

0 ERAG_STATE_INACTIVE

1 ERAG_STATE_IDLE

2 ERAG_STATE_CALLING

3 ERAG_STATE_CONNECTED

4 ERAG_STATE_SENDING_MSD

5 ERAG_STATE_VOICE_CALL

10.2.2. Command +ERAGMSD

10.2.2.1. Description
The following asynchronous events can be received as unsolicited responses:
+ERAGMSD: A MSD has just been updated and ANS1-encoded using AT+ERAGCALL or
AT+ERAGSETMSD and the result is shared via this response.

10.2.2.2. Syntax

Unsolicited response
+ERAGMSD: <msd>

10.2.2.3. Parameters and Defined Values

<msd> The MSD as string in ASN1 PER encoded.

4115730 Rev 5.0 March 26, 2015 258

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

10.2.3. Command +ERAGERROR

10.2.3.1. Description
The following asynchronous events can be received as unsolicited responses:
+ERAGERROR: An error has been detected somewhere outside the scope of a normal AT command
call. Not to be confused with the CME Errors.

10.2.3.2. Syntax

Unsolicited response
+ERAGERROR: <error>

10.2.3.3. Parameters and Defined Values

<error> An error event has occurred, these are the following values and meanings.
Also see erag_error_event_e.

-100 ERAG_EV_ERROR_NO_SIM

-101 ERAG_EV_ERROR_PIN_NOT_READY

-102 ERAG_EV_ERROR_NO_CARRIER

-103 ERAG_EV_ERROR_SETUP_ERROR

-104 ERAG_EV_ERROR_NO_ANSWER

-105 ERAG_EV_ERROR_BUSY

10.3. ERA GLONASS Service AT Commands Error

Codes
The following CME error codes could be returned from ERA Glonass Service Manager AT
commands.
The CME errors are not to be confused to unsolicited error events described by +ERAGERROR.

Table 7. ERA Glonass Service Managers AT commands error codes

CME Error name Description

Error
Code

-1
ERAG_CERR_BAD_STATE Function was called when the state when the
function cannot be executed.

4115730 Rev 5.0 March 26, 2015 259

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

CME Error name Description

Error
Code

-2
ERAG_CERR_UNKNOWN_STATE State machine has reached an unknown state.
-3
ERAG_CERR_UNHANDLED_EVENT Unhandled event in this state.
-4
ERAG_CERR_MSD_VALUE_RANGE Updating the MSD values failed. While trying to
encode the MSD with the new values, the ASN1
encoding failed. New values are not taken into
account.
-5
ERAG_CERR_NULL_VALUE Null value found when NULL is not allowed.
-6
ERAG_CERR_INBND_MDM_ERROR Error from InBand Modem.
-7
ERAG_CERR_UNKNOWN_ERROR Unspecified error occurred.
-8
ERAG_CERR_PARAM Bad parameter value. Also see
ERAG_CERR_MSD_VALUE_RANGE and
ERAG_CERR_NULL_VALUE.

10.4. Example of AT Command Sequence

This is an example of MSD sending using the AT commands.

Example of a MSD sending

AT+ERAGINIT=1,"WWW","VDSVDS","Y","A123456",17
OK

+ERAGEV: 40,0,1

AT+ERAGCALL="112",1,0,7,123456789,173881200,41822520,14,,,,,5
OK

+ERAGMSD: 01040381D75D70D65C3597CA0420C414675E0EB79A2B14BA6EE104FC52701C0A

+ERAGEV: 42,1,2

+ERAGEV: 20,2,3

+ERAGEV: 0,3,4

+ERAGEV: 2,4,4

4115730 Rev 5.0 March 26, 2015 260

 ERA GLONASS Service Manager
Extended AT Commands Manual Commands

+ERAGEV: 3,4,5

+ERAGEV: 22,5,1

4115730 Rev 5.0 March 26, 2015 261

 11. File System Commands

11.1. Application Description

This fs_at_cmd sample ADL Library allows applications to perform file system AT commands.
The +FS command is used for performing the following operations:
 Install a DWL file already present on in the file system
 List a directory content
 Create/Remove a directory
 Upload a file (Read file content from module File System) to COM port
 Download a file (Write file content to module File System) from COM port
 Delete a file
 Get information about a file (fstat)
 Get information about File System (free and total size)
Note: Sierra Wireless suggests to use the File System volume as a data storage space, instead of A&D or
Flash Objects.

11.1.1. Command +FSINIT File System Initialization

The +FSINIT command is used to initialize File System Driver

Command Response

AT+FSINIT OK

11.1.2. Command +FSEXIT File System Close

The +FSEXIT command is used to close File System Driver

Command Response

AT+FSEXIT OK

11.1.3. Command +FS File System Management

Command Response

AT+FS=<operation>[,<param1>][,<param2>] OK

if <operation>="install"

Action command
AT+FS="install",<name>

4115730 Rev 5.0 March 26, 2015 262

 Extended AT Commands Manual File System Commands

Note: The module resets if command is successful. So there is no OK final response in the case a valid file is given.

if <operation>="fsstat"

Action command
AT+FS=<operation>
+FS: <free size>,<total size>
OK

if <operation>="mkdir","rmdir"

Action command
AT+FS=<operation>,<directory path>
OK

if <operation>="ls"

Action command
AT+FS=<operation>,<directory path>,<first>
+FS: <name>,<free size>,<creation date>,<type>,<more>
OK

if <operation>="rm"

Action command
AT+FS=<operation>,<name>
OK

if <operation>="fstat"

Action command
AT+FS=<operation>,<name>
+FS: <size>,<creation date>,<creation time>
OK

if <operation>="read"

Action command
AT+FS=<operation>,<name>,<size>
Note: "C" character launches the upload, content of file is uploaded on port where AT+FS was sent, using 1K-X modem
protocol.

if <operation>="write"

Action command
AT+FS=<operation>,<name>,<size>
+FS: 0

4115730 Rev 5.0 March 26, 2015 263

 Extended AT Commands Manual File System Commands

Note: Download mode started. File can be sent using the terminal application.

Read Command
None

Test Command
AT+FS=?
+FS: (list of supported <operation>s)
OK

Parameters Defined Values

"ls": List file and directories at the given path

"mkdir": Create Directory
"rmdir": Remove Directory (must be empty)
"rm": Delete File
"write": Create File with given name and content
<operation>
"read": Open File with given name and read content
"fstat": Get file information
"fsstat": Get file system information
"install": installs a DWL file already present on in the file system. If successful the
module will reboot and install the file
directory path (string format: 124 characters maximum).
<directory path>
Can only be absolute. Syntax is /dir1/sub_dir/
file or directory name (string format: 124 characters maximum).
<name>
Can only be absolute. Syntax is /dir1/sub_dir/file
request for the first or the next element of directory (boolean)
<first>
1 requests for first element
Indicate if there is more element in the directory (Boolean)
<more>
0 indicates no more element
<size> File size, null if directory (integer)
Creation date: MM/DD/YYYY
<creation date>
Not available on SL80 (always 00/00/1980)
Creation time: HH:MM:SS
<creation time>
Not available on SL80 (always 00:00:00)
<type> Indicate if the element is a file (F) or a directory(D)

11.2. Possible Errors

The possible error message is displayed only if "AT+CMEE=1" is activated else "ERROR" is
displayed.

"+CMEE" AT error code Description

3 Operation not allowed

900 Missing parameter
901 Invalid operation

4115730 Rev 5.0 March 26, 2015 264

 Extended AT Commands Manual File System Commands

"+CMEE" AT error code Description

902 Operation failed

903 Bad path or file name
904 Directory not empty
905 Path or file name too long
906 Internal error

11.3. Examples
Command Answers

AT+FSINIT
OK
Note: Initialize File System Driver

AT+FS=? +FS: ( "fsstat", "ls", "mkdir",

"rmdir", "rm", "read", "write",
"fstat", "install" )
OK
AT+FS="install","/installdir/app.dwl"
Note: Installing the app.dwl in the installdir. The module
resets if command is successful. So there is no OK.

AT+FS="fsstat" +FS: 6400, 128000

OK
AT+FS="ls","/",1 +FS: "dir1",0,12/01/2010,D,1
OK
Note: This is the content of root directory

AT+FS="ls","/",0 +FS: "dir2",0,22/03/2010,D,1

OK
Note: This is the content of root directory

AT+FS="ls","/",0 +FS: "file1.bin",512,22/03/2010,F,0

OK
Note: This is the content of root directory

AT+FS="ls","/dir1",1 +FS: "sub_dir1",0,04/01/2010,D,1

OK
Note: This is the content of /dir1 directory

AT+FS="ls","/dir1",0 +FS: "file2.bin",2586,22/03/2010,F,0

OK
Note: This is the content of /dir1 directory

AT+FS="ls","/dir2",1 +FS: "sub_dir2",0,04/08/2010,D,1

OK
Note: This is the content of /dir2 directory

AT+FS="ls","/dir2",0 +FS: "file3.bin",654,22/04/2010,F,1

OK
Note: This is the content of /dir2 directory

AT+FS="ls","/dir2",0 +FS: "file4.txt",874,23/04/2010,F,0

OK
Note: This is the content of /dir2 directory

4115730 Rev 5.0 March 26, 2015 265

 Extended AT Commands Manual File System Commands

Command Answers

AT+FS="ls","/dir2/sub_dir2",1 +FS:
OK
Note: This is the content of /dir2/sub_dir2 directory

AT+FS="rmdir","/dir2/sub_dir2" OK
Note: Remove /dir2/sub_dir2 directory (it must be empty,
except . and .. of course)

AT+FS="ls","/dir2",1 +FS: file3.bin,654,22/04/2010,F,1

OK
Note: This is the content of /dir2 directory

AT+FS="ls","/dir2",0 +FS: "file4.txt",874,23/04/2010,F,0

OK
Note: This is the content of /dir2 directory

AT+FS="rm","/dir2/file4.txt" OK
Note: Deletes /dir2/file4.txt file

AT+FS="ls","/dir2",1 +FS: "file3.bin",654,22/04/2010,F,0

OK
Note: This is the content of /dir2 directory

AT+FS="mkdir","/new_dir" OK
Note: Creates new_dir directory at root

AT+FS="ls","/",1 +FS: "dir1",0,12/01/2010,D,1

OK
AT+FS="ls","/",0 +FS: "dir2",0,22/03/2010,D,1
OK
AT+FS="ls","/",0 +FS: "file1.bin",512,22/03/2010,F,1
OK
AT+FS="ls","/",0 +FS: "new_dir",0,31/08/2012,D,0
OK
Note: /new_dir directory has been created

AT+FS="write","/new_dir/new_file.bin",2014 +FS: 0
Note: /new_dir/new_file.bin file created, download mode
started. File can be sent using X modem

AT+FS="ls","/new_dir",1 +FS: "new_file.bin",2014,31/08/2010,F,0

OK
Note: /new_dir/new_file.bin is created, and 4 bytes long

AT+FS="fstat"," /new_dir/new_file.bin" +FS: 2014,22/03/2010,11:23:12

OK
AT+FS="read","/new_dir/new_file.bin",2014
C <data>
Note: "C" character launches the upload using 1K Xmodem Note: Content of /new_dir/new_file.bin is uploaded on port
protocol. where AT+FS was sent, using 1K-X modem protocol

AT+FS="fstat","/file1.bin" +FS: 512,22/03/2010,11:23:12

OK
AT+FS="read","/file1.bin",512
C <data>
Note: "C" character launches the upload using 1K Note: Content of /file1.bin is uploaded on port where AT+FS
was sent, using 1K-X modem protocol

4115730 Rev 5.0 March 26, 2015 266

 Extended AT Commands Manual File System Commands

Command Answers

AT+FSEXIT
OK
Note: Close File System Driver

4115730 Rev 5.0 March 26, 2015 267

 Index
+CECALL, 211 +GPSSTART, 130
+CECALLINIT, 210 +GPSSTATE, 132
+ECALLCANCEL, 221 +GPSSTOP, 139
+ECALLCFG, 214 +GPSTTFF, 142
+ECALLERROR, 230 +GPSVERS, 144
+ECALLEV, 229 +INBMCHSTATE, 204
+ECALLGETSTATE, 223 +INBMCLOSE, 204
+ECALLINIT, 213 +INBMEXIT, 200
+ECALLRELEASE, 221 +INBMGETVER, 200
+ECALLSETMSD, 217 +INBMINIT, 199
+ECALLVERSION, 224 +INBMMSDFORMAT, 207
+ERAGCALL, 239 +INBMOPEN, 202
+ERAGCALLCANCEL, 248 +INBMPUSH, 206
+ERAGERROR, 259 +INBMSETMSD, 205
+ERAGEV, 257 +INBMSTATE, 201
+ERAGGETSTATE, 250 +INBMTIMERCFG, 208
+ERAGINIT, 234 +NWKSCAN, 184
+ERAGMSD, 258 +SSLBOOST, 180
+ERAGOPTDATA, 224, 252 +SSLINIT, 173
+ERAGRELEASE, 249 +SSLRELEASE, 179
+ERAGSETERA, 237 +SSLSET, 174
+ERAGSETMSD, 242, 245 +SSLSETOPTS, 178
+ERAGVERSION, 251 +SSLSTATE, 179
+FS, 262 +SSLVERSION, 182
+FSEXIT, 262 +WIPBR, 34
+FSINIT, 262 +WIPCFG, 24
+GPSAID, 152 +WIPCLOSE, 52
+GPSCONF, 145 +WIPCREATE, 43
+GPSCORE, 163 +WIPDATA, 76
+GPSDEBUG, 150 +WIPDATARW, 86
+GPSHELP, 119 +WIPFILE, 66
+GPSINIT, 133 +WIPOPT, 55
+GPSNMEA, 120 +WIPPING, 90
+GPSPVT, 124 +WJAM, 189
+GPSRELEASE, 143 Error Codes, 259
+GPSSAVE, 128 FTP DATA Offline Example, 98
+GPSSLEEP, 140 FTP Example, 98

4115730 Rev 5.0 March 26, 2015 268

 Extended AT Commands Manual File System Commands

HTTP Example, 99 SMTP Example, 100

MMS Example, 102 TCP Socket Example, 93
PING Example, 97 UDP Socket Example, 96
POP3 Example, 101

4115730 Rev 5.0 March 26, 2015 269