u-blox LEXI-R5 Series LTE-M Modules Instruction Manual
- August 21, 2024
- u-blox
Table of Contents
LEXI-R5 Series LTE-M Modules
“`html
Product Information
Specifications
- Product Series: SARA-R5 / LEXI-R5
- Chipset: UBX-R5
- Network: LTE-M / NB-IoT
Product Usage Instructions
Applicable Products
This manual applies to the following products:
| Name | Modem Version | Application Version | PCN Reference |
|---|---|---|---|
| LEXI-R520 | 05.11 | A00.01 | UBXDOC-686885345-2017 |
How to Use This Manual
The u-blox Cellular Modules AT Commands Manual provides
information for designing and configuring the u-blox cellular
modules. It is modular, so you can refer to specific sections as
needed. Important symbols in the manual include an index finger for
key information and a warning symbol for potential module
damage.
Summary Table
The summary table provides quick reference information for each
command section. It includes details on PIN requirements and
settings saved.
PIN Required
-
Yes: PIN insertion is necessary before executing set/read
commands. -
No: PIN insertion is not needed for command execution.
Settings Saved
-
Profile: Command settings can be saved in a personal profile or
NVM. -
NVM: Command settings are saved in non-volatile memory.
-
: Parameter values set with the command are volatile, but the
whole profile can be stored in NVM with AT command. -
OP: Command settings can be overwritten by MNO profile set with
+UMNOPROF or +UMNOCONF AT commands.
FAQs (Frequently Asked Questions)
Q: How do I reset the module to factory settings?
A: To reset to factory settings, send the appropriate AT command
specified in the manual.
Q: Can I use these modules with any cellular network
provider?
A: These modules are compatible with networks supporting LTE-M
and NB-IoT technologies. Ensure compatibility with your network
provider.
“`
SARA-R5 / LEXI-R5 series
LTE-M / NB-IoT modules based on UBX-R5 chipset
AT commands manual
Abstract
Description of standard and proprietary AT commands used with u-blox cellular
modules.
UBX-19047455 – R18 C1-Public
www.u-blox.com
SARA-R5 / LEXI-R5 series – AT commands manual
Document information Title Subtitle Document type Document number Revision and date Disclosure restriction
SARA-R5 / LEXI-R5 series
LTE-M / NB-IoT modules based on UBX-R5 chipset
AT commands manual
UBX-19047455
R18
28-Mar-2024
C1-Public
u-blox or third parties may hold intellectual property rights in the products, names, logos, and designs included in this document. Copying, reproduction, or modification of this document or any part thereof is only permitted with the express written permission of u-blox. Disclosure to third parties is permitted for clearly public documents only. The information contained herein is provided “as is” and u-blox assumes no liability for its use. No warranty, either express or implied, is given, including but not limited to, with respect to the accuracy, correctness, reliability, and fitness for a particular purpose of the information. This document may be revised by u-blox at any time without notice. For the most recent documents, visit www.u blox.com. Copyright © u-blox AG.
UBX-19047455 – R18 C1-Public
Page 2 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Preface
Applicable products
This document applies to the following products:
Name LEXI-R520 SARA-R500E SARA-R500S
SARA-R510S
SARA-R510M8S
SARA-R520 SARA-R520M10
Type number LEXI-R520-02B-00 SARA-R500E-01B-00 SARA-R500S-00B-00 SARA-R500S- 00B-01 SARA-R500S-00B-02 SARA-R500S-00B-03 SARA-R500S-01B-00 SARA-R500S-01B-01 SARA-R500S-61B-00 SARA-R500S-61B-01 SARA-R510S-00B-00 SARA-R510S-00B-01 SARA- R510S-00B-02 SARA-R510S-00B-03 SARA-R510S-01B-00 SARA-R510S-01B-01 SARA-R510S- 61B-00 SARA-R510S-61B-01 SARA-R510M8S-00B-00 SARA-R510M8S-00B-01 SARA-R510M8S- 00B-02 SARA-R510M8S-00B-03 SARA-R510M8S-01B-00 SARA-R510M8S-01B-01 SARA- R510M8S-61B-00 SARA-R510M8S-61B-01 SARA-R510M8S-71B-00 SARA-R510M8S-71B-01 SARA-R520-02B-00 SARA-R520M10-02B-00
Modem version 05.11 03.50 02.05 02.06 02.09 02.10 03.15 03.30 03.25 03.25 02.05 02.06 02.09 02.10 03.15 03.30 03.25 03.25 02.05 02.06 02.09 02.10 03.15 03.30 03.25 03.25 03.25 03.25 05.10 05.10
Application version A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.02 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.02 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.01 A00.02 A00.01 A00.04 A00.01 A00.01
PCN reference UBXDOC-686885345-2017 UBXDOC-686885345-1806 UBX-20037360 UBX-20053099 UBX-22003339 UBX-22037376 UBX-21038301 UBX-22038371 UBX-22009525 UBX-22037395 UBX-20037360 UBX-20053099 UBX-22003339 UBX-22037376 UBX-21038301 UBX-22038371 UBX-22009525 UBX-22037395 UBX-20037360 UBX-20053099 UBX-22003339 UBX-22037376 UBX-21038301 UBX-22038371 UBX-22009525 UBX-22037395 UBX-22037644 UBXDOC-686885345-1762 UBXDOC-686885345-2040 UBXDOC-686885345-2040
How to use this manual
The u-blox Cellular Modules AT Commands Manual provides the necessary
information to successfully design in and configure the applicable u-blox
cellular modules. This manual has a modular structure. It is not necessary to
read it from the beginning to the end. The following symbols are used to
highlight important information within the manual:
An index finger points out key information pertaining to module integration
and performance.
A warning symbol indicates actions that could negatively impact or damage the module.
UBX-19047455 – R18 C1-Public
Preface
Page 3 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Summary table
The summary table on the top of each command section is a quick reference for the user.
command_name
Modules
TOBY-L2 MPCI-L2
LISA-U110 LISA-U120 LISA-U130 LISA-U2
LEON-G1 SARA-G3
Attributes
Syntax
PIN required Settings saved
full
No
No
Can be aborted No
Response time Error reference
–
–
It is composed of two sections:
· Modules: lists all the modules that support the command. The modules are
grouped in rows by cellular standard (i.e. L for LTE high data rate (Cat 3 and
above), R for LTE low data rate (Cat 1 and below), U for UMTS/HSPA, G for
GSM/GPRS, N for NB-IoT (LTE Cat NB1 / LTE Cat NB2)). In each row the modules
are grouped by: form factor (i.e. SARA, LISA), platform technology (e.g.
SARA-G), platform generation (e.g. SARA-G3), product name (e.g. SARA-G350) and
ordering code (e.g. SARA-G350-00S). In example: if ‘LISA-U2′ is reported, the
command applies to all the modules having LISA form factor, second chipset
version provided with any release of firmware.
· Attributes o Syntax – full: the command syntax is fully compatible among all
the products listed in the “Modules” section – partial: the products support
different syntaxes (usually backward compatible with respect to previous
cellular standards)
o PIN required – Yes: it is necessary to insert the PIN before the set and/or
read command execution – No: the PIN insertion is not needed to execute the
command
o Settings saved – Profile: the command setting can be saved in a personal
profile as specified in Chapter 1.4 – NVM: the command setting is saved in the
non-volatile memory as specified in Chapter 1.4 –
– OP: the command setting can be overwritten by the Mobile Network Operator
(MNO) profile set with the +UMNOPROF or +UMNOCONF AT commands (if supported)
– No: the current command setting is volatile and cannot be saved o Can be
aborted
– Yes: the command execution can be aborted if a character is sent to the DCE
during the command execution
– No: the command cannot be aborted during the command execution o Response
time: estimated maximum time to get the final result code for the AT command
execution. It
is the time needed to provide the response in the worst case, e.g. when all
the steps that have to be run to carry out the operation take the longest time
to be performed; it is based on a theoretical estimation, derived by the the
3GPP specifications in case of AT commands related to cellular modem features
(e.g. registration, de-registration, PDP context activation). For additional
details on the response time of cellular network related AT command, see
Maximum vs typical response time of cellular network related AT commands. More
precisely, the response time considers the time from the complete acquisition
of the command line to the issuing of the command result code. This kind of
response time is generally lower than the time measured by the application on
the DTE, because the issuing of the command on the DTE is influenced by the AT
interface characteristics (e.g. the synchronous/asynchronous transfer type,
the selected baud rate, etc.), by power saving and flow control, which
introduce a variable latency in the command acquisition by the DCE.
For example, the maximum expected response time shall be extended if the
communication with the module is carried out on a MUX virtual port, because in
this case the command line and the result code
UBX-19047455 – R18 C1-Public
Preface
Page 4 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
are transferred via a specific protocol running on the physical port, that
might introduce additional communication delay due to framing and re-
transmissions.
Similarly, the maximum expected response time of AT commands accessing the SIM
shall be extended if the module is using a remote SIM card via SAP instead of
the local SIM card.
If the response time for a command is left blank (actually “-“), it is an
“immediate” response. It means that the command is executed without
asynchronous requests to the protocol stack or the internal applications,
which usually require time to be answered: the command execution is
synchronous (implying that no long blocking processing is done) and lasts a
negligible time (the command response is issued by the module in typically
less than 10 ms, and in any case less than 1 s).
The response time shall be extended if the issued AT command triggers a
service that cannot be served immediately due to concurrent access to the same
service or resource via AT commands issued on a different communication port
or from internal applications; typical examples are registration commands and
SIM access, that can be also autonomously triggered by the module (e.g. auto-
COPS) and can therefore postpone the execution of the AT commands issued by
the user. o Error reference: reference to the error result codes listed in the
Appendix A
The attributes listed in the summary table apply by default to all u-blox
modules supporting the specific AT command. If a u-blox module or module
series does not comply to the default behavior, the exception is highlighted
in Chapter 1.4 for the saving of settings, in Chapter 1.3.4 for the
abortability, and in a product specific note in the AT command description for
the PIN check.
u-blox technical documentation
As part of our commitment to customer support, u-blox maintains an extensive
volume of technical documentation for our products. In addition to our
product-specific technical data sheets, the following manuals are available to
assist u-blox customers in product design and development.
AT Commands Manual: This document provides the description of the AT commands
supported by u-blox cellular modules.
System Integration Manual: This document describes u-blox cellular modules
from the hardware and the software point of view. It provides hardware design
guidelines for the optimal integration of the cellular module in the
application device and it provides information on how to set up production and
final product tests on application devices integrating the cellular module.
Application Notes: These documents provide guidelines and information on
specific u-blox cellular module hardware or software topics. · For some
guidelines when developing applications for LTE Cat 1 technologies, see the
LARA-R6 series
application development guide [9]. · For some guidelines when developing
applications for LTE Cat M1 technologies, see the SARA-R41
application development guide [31] or the LEXI-R4 / SARA-R42 application
development guide [32] or the SARA-R5 series application development guide
[27]. · For some guidelines when developing applications for NB-IoT
technologies, see the SARA-N3 series application development guide [47] or the
NB-IoT application development guide [44]. · For more examples of typical
scenarios when developing application for LTE Cat 4, LTE Cat 1, UMTS/HSPA and
GSM/GPRS technologies, see the AT commands examples application note [49]. See
Related documentation for application notes related to your cellular module.
Questions
If you have any questions about u-blox Cellular Hardware Integration, please:
· Read this manual carefully · Contact our information service on our homepage
www.u-blox.com · Read the questions and answers on our FAQ database
UBX-19047455 – R18 C1-Public
Preface
Page 5 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Technical Support
Worldwide Web Our website (www.u-blox.com) is a rich pool of information.
Product information, technical documents and helpful FAQ can be accessed 24h a
day. By email If you have technical problems or cannot find the required
information in the provided documents, contact the nearest of the Technical
Support offices by email. Use our service pool email addresses rather than any
personal email address of our staff. This makes sure that your request is
processed as soon as possible. You will find the contact details at the end of
the document. Helpful Information when Contacting Technical Support When
contacting Technical Support please have the following information ready: ·
Module type (e.g. SARA-G350-00S-00) and firmware version (e.g. 08.49) · Module
configuration · Clear description of your question or the problem · A short
description of the application · Your complete contact details
UBX-19047455 – R18 C1-Public
Preface
Page 6 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Contents
1 AT command settings………………………………………………………………………………………… 14
1.1 Definitions…………………………………………………………………………………………………………………………………………14 1.2
Operational mode of the AT interface…………………………………………………………………………………………… 14 1.3
Command description……………………………………………………………………………………………………………………..15 1.4
Storing of AT commands setting………………………………………………………………………………………………….. 19 1.5
S-parameters………………………………………………………………………………………………………………………………….. 19 1.6 +UDCONF
AT command………………………………………………………………………………………………………………….19
2 General operation……………………………………………………………………………………………….. 21
2.1 Start up and initialization………………………………………………………………………………………………………………. 21
2.2 AT commands types………………………………………………………………………………………………………………………22
3 IPC – Inter Processor Communication………………………………………………………………25
3.1 Multiplexing mode +CMUX……………………………………………………………………………………………………………..25
4 General………………………………………………………………………………………………………………….27
4.1 Manufacturer identification +CGMI………………………………………………………………………………………………. 27
4.2 Manufacturer identification +GMI………………………………………………………………………………………………… 27
4.3 Model identification +CGMM………………………………………………………………………………………………………… 28 4.4
Model identification +GMM……………………………………………………………………………………………………………28 4.5
Firmware version identification +CGMR………………………………………………………………………………………. 29 4.6
Firmware version identification +GMR…………………………………………………………………………………………. 29 4.7
Request product serial number identification +CGSN………………………………………………………………….
29 4.8 IMEI identification +GSN……………………………………………………………………………………………………………….. 31
4.9 Identification information I……………………………………………………………………………………………………………. 31
4.10 TE character set configuration +CSCS………………………………………………………………………………………. 33
4.11 International mobile subscriber identification
+CIMI………………………………………………………………….. 34 4.12 Card identification
+CCID……………………………………………………………………………………………………………..34 4.13 Request complete
capabilities list +GCAP…………………………………………………………………………………..35
5 Mobile equipment control and status………………………………………………………………36
5.1 Phone activity status +CPAS………………………………………………………………………………………………………… 36 5.2
Module switch off +CPWROFF………………………………………………………………………………………………………36 5.3 Set
module functionality +CFUN………………………………………………………………………………………………….. 37 5.4
Indicator control +CIND………………………………………………………………………………………………………………….39 5.5
Configuration of indicator control +UCIND………………………………………………………………………………….. 40
5.6 Mobile termination event reporting +CMER………………………………………………………………………………….
41 5.7 Clock +CCLK………………………………………………………………………………………………………………………………….. 43 5.8
Alarm +CALA………………………………………………………………………………………………………………………………….44 5.9 Delete
alarm +CALD……………………………………………………………………………………………………………………… 45 5.10 Set greeting
text +CSGT…………………………………………………………………………………………………………….. 46 5.11 Automatic time
zone update +CTZU……………………………………………………………………………………………46 5.12 Time zone
reporting +CTZR………………………………………………………………………………………………………… 47 5.13 Report mobile
termination error +CMEE……………………………………………………………………………………..48 5.14 Extended
error report +CEER……………………………………………………………………………………………………… 49
6 Call control………………………………………………………………………………………………………….. 52
6.1 Dial command D…………………………………………………………………………………………………………………………….. 52 6.2
Hook control H………………………………………………………………………………………………………………………………. 53 6.3
Automatic answer S0…………………………………………………………………………………………………………………….53
7 Network service…………………………………………………………………………………………………..55
7.1 Network parameters definition……………………………………………………………………………………………………… 55
7.2 Subscriber number +CNUM………………………………………………………………………………………………………….. 58 7.3
Signal quality +CSQ………………………………………………………………………………………………………………………. 59
UBX-19047455 – R18 C1-Public
Contents
Page 7 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
7.4 Extended signal quality +CESQ……………………………………………………………………………………………………..60
7.5 Operator selection +COPS……………………………………………………………………………………………………………..62 7.6
Radio Access Technology (RAT) selection +URAT………………………………………………………………………..67
7.7 Radio manager configuration +URATCONF…………………………………………………………………………………. 69
7.8 Display operator name +UDOPN……………………………………………………………………………………………………. 71 7.9
Coverage enhancement status +CRCES……………………………………………………………………………………….72 7.10
Preferred PLMN list selection +CPLS…………………………………………………………………………………………..73 7.11
Network registration status +CREG……………………………………………………………………………………………..74 7.12
Preferred operator list +CPOL……………………………………………………………………………………………………… 77 7.13
Read operator names +COPN……………………………………………………………………………………………………… 78 7.14
Network selection control +PACSP……………………………………………………………………………………………… 79 7.15
Integrity check on test networks configuration +UDCONF=81…………………………………………………..
80 7.16 Channel and network environment description
+UCGED……………………………………………………………. 81 7.17 Provide cell information
+UCELLINFO………………………………………………………………………………………….84 7.18 Lock on a specific cell
+UCELLLOCK……………………………………………………………………………………………87 7.19 Smart jamming detection
+UJAD………………………………………………………………………………………………..93 7.20 Extended cell information
+UMETRIC…………………………………………………………………………………………94 7.21 Edit Verizon wireless APN
table +VZWAPNE…………………………………………………………………………….. 118 7.22 Read RSRP values
+VZWRSRP………………………………………………………………………………………………….. 119 7.23 Read RSRQ values
+VZWRSRQ………………………………………………………………………………………………… 120 7.24 Signalling connection
status +CSCON……………………………………………………………………………………… 120 7.25 Set Release Assistance
Indication (RAI) +UDCONF=89…………………………………………………………… 122 7.26 Radio Policy
Manager (RPM) activation +URPM………………………………………………………………………..123 7.27 Radio
Policy Manager (RPM) configuration +URPMCONF…………………………………………………………124 7.28
Purging of temporary mobile identities after SIM refresh
+UDCONF=56…………………………………126 7.29 eDRX setting
+CEDRXS………………………………………………………………………………………………………………126 7.30 eDRX read dynamic
parameters +CEDRXRDP………………………………………………………………………….. 128 7.31 Set MNO profile
+UMNOPROF…………………………………………………………………………………………………… 129 7.32 MNO profile items
handling +UDCONF=91……………………………………………………………………………….. 133 7.33 Band selection
bitmask +UBANDMASK…………………………………………………………………………………….135 7.34 Device service
domain configuration +USVCDOMAIN……………………………………………………………….137 7.35 Modem
features customization +UDCONF=92………………………………………………………………………… 138 7.36 CIoT
capabilities configuration +UCFGCIOT……………………………………………………………………………… 141 7.37
CIoT optimization configuration +CCIOTOPT…………………………………………………………………………….142
7.38 Retrieve coverage enhancement mode information
+CEINFO………………………………………………….144 7.39 Periodic search for higher priority PLMN
+UHPPLMN……………………………………………………………… 146 7.40 Active NAS back-off timers Info
+UNASBTIMERS…………………………………………………………………… 147 7.41 Network band scan status
+USCANSTAT………………………………………………………………………………… 148
8 Device lock………………………………………………………………………………………………………… 150
8.1 Enter PIN +CPIN…………………………………………………………………………………………………………………………….150 8.2
Read remaining SIM PIN attempts +UPINCNT…………………………………………………………………………….151 8.3
Facility lock +CLCK……………………………………………………………………………………………………………………….152 8.4
Change password +CPWD…………………………………………………………………………………………………………… 154 8.5 Custom
SIM lock +USIMLCK………………………………………………………………………………………………………. 154
9 Phonebook…………………………………………………………………………………………………………. 157
9.1 Select phonebook memory storage +CPBS…………………………………………………………………………………. 157
9.2 Read phonebook entries +CPBR…………………………………………………………………………………………………..158 9.3
Find phonebook entries +CPBF…………………………………………………………………………………………………… 159 9.4
Write phonebook entry +CPBW…………………………………………………………………………………………………….161
10 Short Messages Service………………………………………………………………………………… 163
10.1 Introduction…………………………………………………………………………………………………………………………………. 163 10.2
Select message service +CSMS………………………………………………………………………………………………… 164 10.3
Preferred message storage +CPMS………………………………………………………………………………………….. 165 10.4
Preferred message format +CMGF…………………………………………………………………………………………….166 10.5
Save settings +CSAS…………………………………………………………………………………………………………………. 166 10.6
Restore settings +CRES…………………………………………………………………………………………………………….. 167 10.7
Show text mode parameters +CSDH…………………………………………………………………………………………. 167 10.8
New message indication +CNMI…………………………………………………………………………………………………168
UBX-19047455 – R18 C1-Public
Contents
Page 8 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
10.9 Select service for MO SMS messages +CGSMS…………………………………………………………………………171
10.10 Read message +CMGR……………………………………………………………………………………………………………… 172 10.11
New message acknowledgement to MT +CNMA………………………………………………………………………175 10.12
List message +CMGL…………………………………………………………………………………………………………………176 10.13 Send
message +CMGS……………………………………………………………………………………………………………… 178 10.14 Write
message to memory +CMGW………………………………………………………………………………………….179 10.15 Send
message from storage +CMSS………………………………………………………………………………………. 180 10.16 Set
text mode parameters +CSMP……………………………………………………………………………………………181 10.17 Delete
message +CMGD…………………………………………………………………………………………………………… 182 10.18 Service
center address +CSCA………………………………………………………………………………………………… 183 10.19 Select
cell broadcast message types +CSCB………………………………………………………………………….. 183 10.20
More messages to send +CMMS……………………………………………………………………………………………..184 10.21 Peek
message +UCMGP…………………………………………………………………………………………………………….185 10.22 Sending of
originating data via the control plane +CSODCP………………………………………………….. 186 10.23
Terminating data reporting via control plane +CRTDCP………………………………………………………… 187
11 V24 control and V25ter……………………………………………………………………………………189
11.1 Introduction………………………………………………………………………………………………………………………………….. 189 11.2
Circuit 109 behavior &C………………………………………………………………………………………………………………..189 11.3
Circuit 108/2 and escape sequence behavior &D……………………………………………………………………….. 189
11.4 DSR override &S…………………………………………………………………………………………………………………………… 191 11.5
Flow control &K…………………………………………………………………………………………………………………………….192 11.6 DTE-
DCE character framing +ICF………………………………………………………………………………………………. 192 11.7 DTE-
DCE local flow control +IFC………………………………………………………………………………………………….193 11.8 Set
flow control Q………………………………………………………………………………………………………………………. 194 11.9 UART
data rate configuration +IPR……………………………………………………………………………………………. 195 11.10
Return to on-line data state O………………………………………………………………………………………………….. 197
11.11 Escape character S2…………………………………………………………………………………………………………………… 197
11.12 Command line termination character
S3…………………………………………………………………………………..199 11.13 Response formatting character
S4……………………………………………………………………………………………199 11.14 Command line editing character
S5………………………………………………………………………………………….200 11.15 Connection completion timeout
S7…………………………………………………………………………………………..200 11.16 Escape prompt delay (EPD)
S12………………………………………………………………………………………………… 201 11.17 Command echo
E………………………………………………………………………………………………………………………. 202 11.18 Result code
suppression Q………………………………………………………………………………………………………..202 11.19 DCE response
format V……………………………………………………………………………………………………………. 203 11.20 Reset to default
configuration Z………………………………………………………………………………………………203 11.21 Set to factory
defined configuration &F……………………………………………………………………………………204 11.22 Store
current configuration &W………………………………………………………………………………………………. 204 11.23
Display current configuration &V…………………………………………………………………………………………….. 205
11.24 Designate a default reset profile &Y………………………………………………………………………………………..
205
12 SIM management…………………………………………………………………………………………… 207
12.1 Generic SIM access +CSIM………………………………………………………………………………………………………… 207 12.2
Restricted SIM access +CRSM…………………………………………………………………………………………………..207 12.3
Read the SIM language +CLAN………………………………………………………………………………………………….209 12.4
Check for UICC card +UUICC……………………………………………………………………………………………………… 210 12.5
Customer service profile +UCSP…………………………………………………………………………………………………210 12.6
SIM hot insertion configuration +UDCONF=50…………………………………………………………………………..211
12.7 UICC application discovery +CUAD……………………………………………………………………………………………..212
12.8 Open logical channel +CCHO……………………………………………………………………………………………………… 213
12.9 Close logical channel +CCHC……………………………………………………………………………………………………… 213
12.10 Generic UICC logical channel access
+CGLA…………………………………………………………………………….214 12.11 Restricted UICC logical channel
access +CRLA……………………………………………………………………….. 215 12.12 SIM states reporting
+USIMSTAT…………………………………………………………………………………………….216 12.13 UICC suspend resume
configuration +UDCONF=250……………………………………………………………… 218 12.14 UICC suspend and
deactivate control +SSRDA………………………………………………………………………..218
13 SIM toolkit………………………………………………………………………………………………………. 220
13.1 Introduction………………………………………………………………………………………………………………………………… 220 13.2
Bearer Independent Protocol status indication +UBIP………………………………………………………………220
UBX-19047455 – R18 C1-Public
Contents
Page 9 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
13.3 Terminal profile +UCATPROF…………………………………………………………………………………………………….. 221
14 Packet switched data services…………………………………………………………………….. 222
14.1 PDP contexts and parameter
definition……………………………………………………………………………………..222 14.2 PPP LCP handshake
behavior…………………………………………………………………………………………………….224 14.3 Printing IP address
format +CGPIAF………………………………………………………………………………………… 224 14.4 PDP context
definition +CGDCONT……………………………………………………………………………………………226 14.5 IPv6
configuration +UDCONF=66……………………………………………………………………………………………… 230 14.6 Packet
switched data configuration +UPSD………………………………………………………………………………231 14.7 Packet
switched network-assigned data +UPSND…………………………………………………………………… 233 14.8
Packet switched data action +UPSDA……………………………………………………………………………………… 234 14.9
Default CID and preferred protocol type configuration
+UDCONF=19………………………………………236 14.10 PS attach or detach
+CGATT………………………………………………………………………………………………….. 236 14.11 PDP context activate
or deactivate +CGACT…………………………………………………………………………… 237 14.12 Enter data state
+CGDATA……………………………………………………………………………………………………… 238 14.13 Enter PPP state/GPRS
dial-up D*……………………………………………………………………………………………..240 14.14 Show PDP address
+CGPADDR………………………………………………………………………………………………… 241 14.15 Packet switched event
reporting +CGEREP……………………………………………………………………………. 242 14.16 Manual deactivation
of a PDP context H………………………………………………………………………………….245 14.17 PDP context modify
+CGCMOD……………………………………………………………………………………………….. 245 14.18 Define secondary PDP
context +CGDSCONT………………………………………………………………………….. 246 14.19 UE modes of
operation for EPS +CEMODE……………………………………………………………………………… 247 14.20 EPS network
registration status +CEREG……………………………………………………………………………… 248 14.21 Delete non-
active PDP contexts +CGDEL……………………………………………………………………………….. 250 14.22 Traffic
flow template read dynamic parameters +CGTFTRDP………………………………………………..251 14.23
Configure the authentication parameters of a PDP/EPS bearer +UAUTHREQ………………………
253 14.24 Send custom packets over a context
+UTGSINK…………………………………………………………………… 255 14.25 Define EPS quality of service
+CGEQOS………………………………………………………………………………….255 14.26 EPS quality of service read
dynamic parameters +CGEQOSRDP…………………………………………… 257 14.27 Secondary PDP context
read dynamic parameters +CGSCONTRDP………………………………………258 14.28 UE’s usage setting
for EPS +CEUS………………………………………………………………………………………….259 14.29 PDP context read
dynamic parameters +CGCONTRDP…………………………………………………………. 259 14.30 Traffic flow
template +CGTFT………………………………………………………………………………………………….261 14.31 Read counters
of sent or received PS data +UGCNTRD…………………………………………………………. 264 14.32
Set/reset counter of sent or received PS data +UGCNTSET………………………………………………….
265 14.33 Uplink user data plane configuration
+UDCONF=9…………………………………………………………………266 14.34 Feature Group Indicators (FGI)
settings +UFGI………………………………………………………………………. 267 14.35 Initial PDP context
activation +CIPCA…………………………………………………………………………………….. 267 14.36 APN rate control
+CGAPNRC………………………………………………………………………………………………….. 268 14.37 Disable data when
roaming +UDCONF=76………………………………………………………………………………269 14.38 APN back-off timer
read dynamic parameters +CABTRDP…………………………………………………….270 14.39 APN back-off
timer status reporting +CABTSR……………………………………………………………………… 271 14.40 APN rate
and CP congestion status reporting +UCIOTSTAT………………………………………………… 273
15 System features………………………………………………………………………………………………275
15.1 Firmware installation +UFWINSTALL…………………………………………………………………………………………275
15.2 Firmware update Over AT (FOAT) +UFWUPD……………………………………………………………………………277
15.3 Antenna detection +UANTR……………………………………………………………………………………………………… 280 15.4
ADC read command +UADC………………………………………………………………………………………………………. 281 15.5
Antenna dynamic tuner configuration +UTEST=4……………………………………………………………………. 281
15.6 Smart temperature supervisor +USTS…………………………………………………………………………………….. 285
15.7 RING line handling +URING…………………………………………………………………………………………………………286 15.8
CTS line state in case of disabled HW flow control +UCTS………………………………………………………
287 15.9 Serial interfaces configuration selection
+USIO………………………………………………………………………. 288 15.10 Restore factory configuration
+UFACTORY…………………………………………………………………………….290 15.11 Cancel/pause/resume FOTA
download +UFOTA……………………………………………………………………….291 15.12 Sets FOTA status URCs
+UFOTASTAT………………………………………………………………………………….. 292 15.13 FOTA LwM2M client
configuration +UFOTACONFIG……………………………………………………………… 294 15.14 Accept/reject
LwM2M FW update request +UFOTAACK………………………………………………………..295 15.15 Last gasp
configuration +ULGASP…………………………………………………………………………………………..296
UBX-19047455 – R18 C1-Public
Contents
Page 10 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
16 Power management……………………………………………………………………………………….. 299
16.1 Power saving control (Power SaVing)
+UPSV…………………………………………………………………………….299 16.2 Power Saving Mode Setting
+CPSMS……………………………………………………………………………………….. 301 16.3 Power Saving Mode assigned
values +UCPSMS……………………………………………………………………….303 16.4 Deep-sleep mode options
configuration +UPSMVER………………………………………………………………. 305 16.5 Deep-sleep mode
indication +UPSMR………………………………………………………………………………………. 307 16.6 Deep-sleep mode
re-entering during PSM or eDRX +USLEEP…………………………………………………. 308 16.7 Power
Preference Indication for EPS +CEPPI…………………………………………………………………………….309
17 GPIO………………………………………………………………………………………………………………….. 310
17.1 Introduction…………………………………………………………………………………………………………………………………. 310 17.2
GPIO select configuration command +UGPIOC…………………………………………………………………………. 317
17.3 GPIO read command +UGPIOR……………………………………………………………………………………………………321 17.4
GPIO set command +UGPIOW…………………………………………………………………………………………………… 322
18 End user test……………………………………………………………………………………………………323
18.1 Entering and exiting test mode +UTEST=0, +UTEST=1……………………………………………………………
323 18.2 Digital pins testing
+UTEST=10…………………………………………………………………………………………………324
19 File System……………………………………………………………………………………………………… 327
19.1 File tags………………………………………………………………………………………………………………………………………. 327 19.2
Download file +UDWNFILE………………………………………………………………………………………………………… 330 19.3 List
files information +ULSTFILE……………………………………………………………………………………………… 332 19.4 Read
file +URDFILE…………………………………………………………………………………………………………………….333 19.5 Partial
read file +URDBLOCK……………………………………………………………………………………………………..333 19.6 Delete
file +UDELFILE……………………………………………………………………………………………………………….. 334 19.7 File
system limits………………………………………………………………………………………………………………………..335
20 DNS…………………………………………………………………………………………………………………..336
20.1 Resolve name / IP number through DNS +UDNSRN………………………………………………………………….336
20.2 Dynamic DNS update +UDYNDNS…………………………………………………………………………………………….338 20.3
Override DNS configuration +UDNSCFG……………………………………………………………………………………341
21 Internet protocol transport layer…………………………………………………………………. 343
21.1 Introduction………………………………………………………………………………………………………………………………… 343 21.2
IPv4/IPv6 addressing…………………………………………………………………………………………………………………..344 21.3
Create Socket +USOCR………………………………………………………………………………………………………………344 21.4
SSL/TLS/DTLS mode configuration on TCP/UDP socket +USOSEC……………………………………….. 345
21.5 Set socket option +USOSO……………………………………………………………………………………………………….. 346
21.6 Get Socket Option +USOGO……………………………………………………………………………………………………… 348 21.7
Close Socket +USOCL……………………………………………………………………………………………………………….. 349 21.8 Get
Socket Error +USOER………………………………………………………………………………………………………….350 21.9 Connect
Socket +USOCO…………………………………………………………………………………………………………… 351 21.10 Write socket
data +USOWR……………………………………………………………………………………………………..352 21.11 SendTo command
(UDP only) +USOST……………………………………………………………………………………. 354 21.12 SendTo command
with flags (UDP only) +USOSTF…………………………………………………………………356 21.13 Read Socket
Data +USORD………………………………………………………………………………………………………358 21.14 Receive From
command (UDP only) +USORF…………………………………………………………………………..359 21.15 Set Listening
Socket +USOLI…………………………………………………………………………………………………… 361 21.16 HEX mode
configuration +UDCONF=1………………………………………………………………………………………362 21.17 Set socket
in Direct Link mode +USODL…………………………………………………………………………………. 362 21.18 Timer
Trigger configuration for Direct Link +UDCONF=5………………………………………………………. 365
21.19 Data Length Trigger configuration for Direct Link
+UDCONF=6……………………………………………. 365 21.20 Character trigger configuration for
Direct Link +UDCONF=7………………………………………………… 366 21.21 Congestion timer
configuration for Direct Link +UDCONF=8…………………………………………………. 367 21.22 Direct
Link disconnect DSR line handling +UDCONF=10…………………………………………………………367 21.23
Socket control +USOCTL………………………………………………………………………………………………………… 368 21.24 IP
Change Notification +UIPCHGN………………………………………………………………………………………….. 369
22 Device and data security………………………………………………………………………………. 375
22.1 Introduction………………………………………………………………………………………………………………………………… 375
UBX-19047455 – R18 C1-Public
Contents
Page 11 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
22.2 Device security……………………………………………………………………………………………………………………………375 22.3 Data security provided by secure connections (SSL/TLS/DTLS)……………………………………………..385 22.4 Data security provided by Secure Element……………………………………………………………………………….409
23 FTP……………………………………………………………………………………………………………………430
23.1 FTP service configuration +UFTP………………………………………………………………………………………………430
23.2 FTP command +UFTPC……………………………………………………………………………………………………………..434 23.3 FTP
error +UFTPER…………………………………………………………………………………………………………………… 437
24 HTTP…………………………………………………………………………………………………………………439
24.1 HTTP control +UHTTP………………………………………………………………………………………………………………..439 24.2
HTTP advanced control+UHTTPAC…………………………………………………………………………………………..443 24.3 HTTP
command +UHTTPC………………………………………………………………………………………………………..444 24.4 HTTP protocol
error +UHTTPER………………………………………………………………………………………………. 448
25 Ping………………………………………………………………………………………………………………….. 449
25.1 Ping command +UPING………………………………………………………………………………………………………………449 25.2
ICMP echo reply configuration +UDCONF=4……………………………………………………………………………..451
26 Positioning……………………………………………………………………………………………………….452
26.1 NMEA…………………………………………………………………………………………………………………………………………..452
26.2 AssistNow services…………………………………………………………………………………………………………………….452
26.3 Positioning server configuration +UGSRV……………………………………………………………………………….. 454
26.4 GNSS…………………………………………………………………………………………………………………………………………..456
26.5 CellLocate® and hybrid positioning…………………………………………………………………………………………… 471
26.6 CellTime………………………………………………………………………………………………………………………………………483
27 I2C…………………………………………………………………………………………………………………….. 489
27.1 27.2 27.3 27.4 27.5 27.6
Introduction………………………………………………………………………………………………………………………………… 489 I2C open logical channel +UI2CO………………………………………………………………………………………………. 489 I2C write to peripheral +UI2CW………………………………………………………………………………………………….490 I2C read from peripheral +UI2CR……………………………………………………………………………………………….. 491 I2C read from peripheral register +UI2CREGR……………………………………………………………………………491 I2C close logical channel +UI2CC………………………………………………………………………………………………. 492
28 Networking………………………………………………………………………………………………………493
28.1 Configure the port forwarding +UPORTFWD…………………………………………………………………………….493
29 Constrained Application Protocol (CoAP)…………………………………………………… 497
29.1 Introduction………………………………………………………………………………………………………………………………… 497 29.2
CoAP profile configuration +UCOAP………………………………………………………………………………………….497 29.3
CoAP command +UCOAPC……………………………………………………………………………………………………….. 501 29.4 CoAP
error reporting +UCOAPER…………………………………………………………………………………………….. 503
30 MQTT………………………………………………………………………………………………………………. 504
30.1 Introduction……………………………………………………………………………………………………………………………….. 504 30.2
MQTT profile configuration +UMQTT……………………………………………………………………………………….505 30.3
Save/Restore MQTT profile from NVM +UMQTTNV………………………………………………………………..509 30.4
MQTT command +UMQTTC…………………………………………………………………………………………………….. 509 30.5 MQTT
error +UMQTTER……………………………………………………………………………………………………………. 514
31 MQTT-SN…………………………………………………………………………………………………………. 515
31.1 Introduction…………………………………………………………………………………………………………………………………. 515 31.2
MQTT-SN profile configuration +UMQTTSN…………………………………………………………………………….. 516 31.3
Save/Restore MQTT-SN profile from NVM +UMQTTSNNV……………………………………………………… 519 31.4
MQTT-SN command +UMQTTSNC………………………………………………………………………………………….. 520 31.5 MQTT-SN
error +UMQTTSNER………………………………………………………………………………………………….524
32 Lightweight M2M……………………………………………………………………………………………526
32.1 LwM2M Objects management………………………………………………………………………………………………….. 526 32.2
LwM2M connectivity…………………………………………………………………………………………………………………..531
33 Smart Connection Manager (SCM)………………………………………………………………544
UBX-19047455 – R18 C1-Public
Contents
Page 12 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
33.1 Introduction…………………………………………………………………………………………………………………………………544 33.2
Smart Connection Manager (SCM) control +USCM………………………………………………………………… 544 33.3
Smart Connection Manager (SCM) configuration +USCMCONF……………………………………………..547
A Appendix: Error result codes…………………………………………………………………………..549
A.1 Mobile termination error result codes +CME ERROR…………………………………………………………………
549 A.2 Message service error result codes +CMS
ERROR…………………………………………………………………….556 A.3 +CEER error result
codes……………………………………………………………………………………………………………. 561 A.4 Firmware install final
result codes………………………………………………………………………………………………567 A.5 FOAT error result
codes………………………………………………………………………………………………………………568 A.6 Dynamic DNS unsolicited
indication codes……………………………………………………………………………….. 568 A.7 Internal TCP/UDP/IP
stack class error codes…………………………………………………………………………….. 569 A.8 Internet suite
error classes………………………………………………………………………………………………………… 572 A.9 IP change
notification error result codes…………………………………………………………………………………… 579 A.10 Ping
error result codes……………………………………………………………………………………………………………….579
B Appendix: AT Commands List………………………………………………………………………… 581
B.1 Parameters stored in profiles……………………………………………………………………………………………………… 609
B.2 Parameters stored in non volatile memory…………………………………………………………………………………
610 B.3 Saving AT commands configuration……………………………………………………………………………………………615
B.4 Estimated maximum command response time…………………………………………………………………………. 615
B.5 Multiple AT command interfaces…………………………………………………………………………………………………617
C Mobile Network Operator profiles…………………………………………………………………..619
C.1 SARA-R5 / LEXI-R5 Introduction…………………………………………………………………………………………………..619
C.2 SARA-R500S-00B / SARA-R510M8S-00B / SARA-R510S-00B Americas MNO and
conformance profiles table……………………………………………………………………………………………………………. 620 C.3
SARA-R500S-00B / SARA-R510M8S-00B / SARA-R510S-00B EMEA MNO profiles
table………..622 C.4 SARA-R500E Americas MNO and conformance profiles
table…………………………………………………. 624 C.5 SARA-R500S-01B / SARA-R500S-61B / SARA-
R500S-71B / SARA-R510M8S-01B /
SARA-R510M8S-61B / SARA-R510M8S-71B / SARA-R510S-01B / SARA-R510S-61B / SARA-
R510S-71B / SARA-R520 / SARA-R520M10 / LEXI-R5 Americas MNO and conformance
profiles table…………………………………………………………………………………………………………………………………… 626 C.6 SARA-
R500S-01B / SARA-R500S-61B / SARA-R500S-71B / SARA-R510M8S-01B / SARA-R510M8S-
61B / SARA-R510M8S-71B / SARA-R510S-01B / SARA-R510S-61B / SARA-R510S-71B /
SARA-R520 / SARA-R520M10 / LEXI-R5 EMEA MNO profiles table……………….632 C.7 SARA-
R500S-01B / SARA-R500S-61B / SARA-R500S-71B / SARA-R510M8S-01B / SARA-R510M8S-
61B / SARA-R510M8S-71B / SARA-R510S-01B / SARA-R510S-61B / SARA-R510S-71B /
SARA-R520 / SARA-R520M10 / LEXI-R5 APAC MNO profiles table………………. 635
D Appendix: glossary………………………………………………………………………………………….. 640
Related documentation…………………………………………………………………………………………644
Revision history…………………………………………………………………………………………………….. 650
Contact………………………………………………………………………………………………………………………………………………… 655
UBX-19047455 – R18 C1-Public
Contents
Page 13 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
1 AT command settings
u-blox cellular modules provide at least one physical serial interface that is
compliant to V.24 [210]. When the module is powered on, it enters the command
mode. For more details on command mode, see Chapter 1.1.
For module and hyper terminal connection and settings see the corresponding
evaluation kit user guide.
1.1 Definitions
In this document the following naming conventions are used: · MT (Mobile
Terminal) or DCE (Data Communications Equipment): u-blox cellular module · TE
(Terminal Equipment) or DTE (Data Terminal Equipment): terminal that issues
the command to the
module · TA (Terminal Adaptor): the function, integrated in the MT, of
supporting AT command interface according
to the applicable standards · ME (Mobile Equipment): equivalent to MT, it is
used to refer to the device itself regardless of the inserted
SIM card
The terms DCE and DTE are used in the serial interface context.
SARA-R5 / LEXI-R5 u-blox cellular modules can implement more than one
interface between the DTE and the DCE, either virtual interfaces (multiplexer
channels) or physical interfaces (UART, USB, SPI, etc., when available). Each
interface works as specified by the followings definitions. If not differently
stated, all the subsequent descriptions are applicable to each interface.
Appendix B.5 describes the different behavior among the interfaces in
reference to the AT command interface. It also describes the limitations (if
any) in the concurrent use of more than one AT command interface.
See the corresponding module data sheet for the list of available AT command
interfaces.
SARA-R5 / LEXI-R5 Where supported, two UART AT interfaces can be used at the
same time (it is not the default behavior). See +USIO command description for
details on how to set such behavior. According to the terminology used in the
data sheet, UART is the main asynchronous serial interface, while AUX UART is
the auxiliary asynchronous interface. For more details on supported serial
interfaces and their characteristics, see the corresponding module data sheet.
The same naming will be used in the rest of the document (when not clearly
specified, the description shall be considered applicable to both the
interfaces).
1.2 Operational mode of the AT interface
The DCE/MT interface can operate in these modes: · Command mode: the DCE waits
for AT command instructions. The DCE interprets all the characters
received as commands to execute. The DCE may send responses back to the DTE
indicating the outcome of the command or further information without having
received any commands by the DTE (e.g. unsolicited response code – URC). Any
communication in the command mode (in both directions) is terminated by the
command line termination character. · Data mode: the DCE transfers data after
having sent the “CONNECT” string; all the characters sent to the DCE are
intended to be transmitted to the remote party. Any further characters
received over the serial link are deemed to be from the remote party, and any
characters sent are transmitted to the remote party. The DCE enters data mode
immediately after it makes a Circuit Switched Data (CSD) or Packet Switched
Data (PSD) connection (PPP or DUN connection). · Online command mode: the DCE
has a data connection established with a remote party, but treats signals from
the DTE as command lines and sends back responses and unsolicited indications
to the DTE.
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 14 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
· Direct link mode: intermediate state where the DCE transfers data
transparently over a connected TCP/ UDP socket (e.g. by means of +USODL),
after reporting the “CONNECT” string.
· SMS mode: AT commands for writing or sending SMSs lead the AT interface into
an intermediate state indicated by the “>” (greater-than sign) where SMS
text/PDU can be entered (DCD signal shall be in ON state during this
operation).
· Raw mode: special AT commands lead the AT interface into intermediate state
where raw data is being exchanged (e.g. during file transfer).
· AT commands over an IP connection: the DCE is accepting a TCP connection on
a specific TCP port. The DTE can connect via TCP protocol to the port and can
send commands over this TCP connection. The DCE may send responses back to the
DTE via the same TCP connection. The communication over IP connection is
denoted by a set of two ports: o AT command port; o binary data port. The
binary data port is used for the exchange of binary data between the DCE and
DTE. For more details, on the configuration of the TCP ports see +UIFCONF.
SARA-R5 / LEXI-R5 The AT commands over IP connection is not supported.
SARA-R500E / SARA-R500S / SARA-R510M8S / SARA-R510S For more details on PSD
connection, see the +UPSD, +UPSDA and +UPSND AT commands description.
SARA-R520 / SARA-R520M10 / LEXI-R5 To establish a PSD connection see the
+CGDCONT and +CGACT AT commands.
1.2.1 Switch from data mode to online command mode
When a data connection is established it is possible to switch from data mode
to online command mode (OLCM) in the following ways: · with the escape
sequence “+++”, which can be configured with the S2 AT command, if supported ·
via a DTR transition: during data mode, the current DTR state is not
important, but only its transition.
Furthermore, only the DTR transition from ON to OFF is detected; it can be
used to control the switch to OLCM, or to command mode (the data connection is
released). For more details, see the &D AT command description
To switch back to data mode from OLCM the O AT command is used. For more
details, see also the &D AT command.
When using the multiplexer and PPP combined, toggling the DTR line (of the
physical serial interface where the multiplexer protocol is started) from ON
to OFF state does not terminate the PPP session and return the device to the
command mode. In this configuration, it is recommended that the host
terminates the PPP session, which can be done by sending LCP_TERM REQ or
deasserting the DTR virtual line (sending of specific MUX MSC command). ·
SARA-R5 / LEXI-R5 – For more details, see the SARA-R5 series application
development guide [27].
1.3 Command description
The AT commands configure and enable the cellular module functionalities
according to 3GPP normative and u-blox specifications. The AT commands are
issued to the module via a hyper terminal through a command line and are
described in the following sections. A general description of each command is
provided including the functionalities, the correct syntax to be provided by
the TE/DTE, the allowed responses and an example. The command description
defines each named parameter with its type, its range (valid / acceptable
values), the default value (when available) and the factory-programmed value
(when applicable).
For default value it is intended the value automatically set if the parameter
is omitted and at the module power-on (if the command setting is not stored in
NVM/profile). For factory-programmed value it is intended
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 15 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
the value set at the module power-on when the setting is not modified respect
with the manufacturer setting; it is valid for the commands that store the
setting in NVM/profile.
The summary table on the top of each command section and the Appendix B lists
all the u-blox cellular modules that support that command.
The example provided in the command description refers only to the handling
provided by the command. It may be not valid for all the products which the
document is applied to. The list of allowed values for a specific product is
provided in the corresponding “Defined values” section.
In this document
If a parameter is omitted, no value will be inserted between the two commas
indicating the interested parameter in the command line sent by the DTE.
1.3.1 Default values
If the command parameters are optional, they can be left out in the command
line. If not otherwise specified, the default values are assumed as follows: ·
For parameters of type Number, the default value is 0 · For parameters of type
String, the default value is an empty string
1.3.2 Command line
The AT commands are typically issued to the cellular modules using a command
line with the following generic syntax:
“AT”
Where: · “AT”: prefix to be set at the beginning of each command line ·
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 16 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
1.3.2.1 Concatenation of AT commands More than one AT command can be entered
on the same command line. The “AT” prefix must be provided only at the
beginning of the command line. Each command must be separated by using a
semicolon as delimiter only if the command has a “+” character as prefix.
Example: ATI;+CGATT?;+COPS?
If a command in the command line causes an error, or is not recognized as a
valid command, then the execution is terminated, the remaining commands in the
command line are ignored and an error result code is returned.
If all the commands are correctly executed, only the “OK” final result code of
the last command is returned.
SARA-R5 / LEXI-R5 Not all the commands can be entered with other commands on
the same command line: +CMGW, +CMGS, +USOWR, +USOST, +UDWNFILE must be used by
themselves.
1.3.3 Notes
SARA-R5 / LEXI-R5 · The maximum length of the command line is 2048 characters.
· String parameter type limitations – The following characters are not allowed
in the parameter string: o 0x00 (NUL) o 0x0D (CR) o 0x15 (NAK) o 0x22 (“) o
0x2C (,)
1.3.4 Information text responses and result codes
The AT command response comprises an optional information text string and a
final result code that can assume the format as follows: · Verbose format:
Information text response(s):
SARA-R5 / LEXI-R5 The V AT command configures the result code in numeric or verbose format. The command line termination character can be set with S3 AT command. The linefeed character can be set with S4 AT command.
Table 1 lists the allowed result codes.
Verbose OK
CONNECT RING NO CARRIER
ERROR
NO DIALTONE
Numeric Result code type
0
Final
1
Intermediate
2
Unsolicited
3
Final
4
Final
6
Final
Description Command line successfully processed and the command is correctly
executed
Data connection established
Incoming call signal from the network
Connection terminated from the remote part or attempt to establish a
connection failed
General failure. The +CMEE AT command configures the error result format
No dialtone detected
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 17 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Verbose BUSY NO ANSWER CONNECT
Numeric Result code type
7
Final
8
Final
9
Intermediate
Description Engaged signal detected (the called number is busy) No hang up detected after a fixed network timeout Same as CONNECT including also the data rate (data call).
SARA-R5 / LEXI-R5 In case of data/fax call, see Circuit 108/2, +++ behavior for the different &D: summarizing table to return in command mode and disconnect the call.
DELAYED NOT SUPPORT INVALID COMMAND LINE CR SIM DROP Command aborted DISCONNECT ABORTED
9 10 11 12 13 3000 14 18
Final Final Final Final Final Final Final Final
Delayed Operation not supported Invalid command line Carriage return SIM not inserted Command execution aborted issuing a character to the DCE Data connection disconnected Aborted terminal
Table 1: Allowed result codes
The following result codes are not supported: · SARA-R5 / LEXI-R5 –
DISCONNECT, DELAYED, ABORTED, NOT SUPPORT, INVALID COMMAND LINE, CR, SIM DROP.
SARA-R5 / LEXI-R5 The result codes CONNECT and NO CARRIER are supported only
in verbose format.
As already stated in the Preface section (see the “Can be aborted” attribute), some AT commands can be aborted after having issued them.
SARA-R5 / LEXI-R5 The attribute abortability means that the command line is always returned, instead the service is really aborted only in case of the PLMN search and PLMN extended search procedures.
Intermediate outputs as well as descriptive outputs of a command are formatted
as information text responses; if more than one string has to be printed out
(see for example the +CGDCONT command description), additional command line
termination and linefeed characters may be inserted for sake of readability.
If the command is not accepted by the MT an error result code will be
displayed. The +CMEE AT command configures the error result code format as
follows: · “+CMS ERROR:
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 18 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
· SARA-R5 / LEXI-R5 – DNS: see the Appendix A.6 and Appendix A.7 · SARA-R5 / LEXI-R5 – TCP and UDP connections: see the Appendix A.7, Appendix A.8 · SARA-R5 / LEXI-R5 – FTP: see the Appendix A.8.1 · SARA-R5 / LEXI-R5 – HTTP: see the Appendix A.8.2 · SARA-R5 / LEXI-R5 – MQTT: see the Appendix A.8.4 · SARA-R5 / LEXI-R5 – MQTT-SN: see the Appendix A.8.5 · SARA-R5 / LEXI-R5 – IP change notification: see the Appendix A.9 · SARA-R5 / LEXI-R5 – CoAP: see the Appendix A.8.6 · SARA-R5 / LEXI-R5 – Ping: see the Appendix A.10 The corresponding sections provide more details for retrieving the error result codes for these operations.
1.4 Storing of AT commands setting
Several user settings may be stored in the cellular module’s memory. Some are
directly stored in the non volatile memory (NVM), while the others are
organized into two personal profiles (where supported).
Appendix B.2 lists the complete settings that can be directly stored in NVM
and the corresponding commands.
Appendix B.1 lists the complete settings stored in the profiles and the
corresponding commands.
SARA-R5 / LEXI-R5 More details about loading, storing and updating profiles
can be found in the command descriptions for: ATZ, AT&F, AT&W, AT&V, and AT&Y.
1.5 S-parameters
The S-parameters, as specified in ITU-T recommendation V250 [206], constitute
a group of commands that begin with the string “ATS”. They are generally
indicated as S registers and are used to configure the way the module
operates. Their syntax is: ATS
ATS
The number following the “ATS” is the referenced S parameter.
u-blox cellular modules support the following set of S-parameters
(
AT command S0 S2 S3 S4 S5 S7 S12
S Number 0 2 3 4 5 7 12
Description Automatic answer setting Escape character setting Command line termination character setting Response formatting character setting Command line editing character setting Connection completion timeout setting Escape prompt delay setting
If a
1.6 +UDCONF AT command
The UDCONF AT commands constitute a group of u-blox proprietary AT commands
that allow to configure some features beloging to i.e network services,
internet suite, etc. They are indicated by the “+UDCONF=” string followed by
an
The generic set command syntax is: AT+UDCONF=
while the generic read command syntax is
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 19 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
AT+UDCONF=
UBX-19047455 – R18 C1-Public
1 AT command settings
Page 20 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
2 General operation
2.1 Start up and initialization
The characteristics of the boot of the cellular device vary from module to
module and are described in the corresponding system integration manual.
During the boot phase the module might not respond to the AT interface until
all necessary SW modules have been installed (e.g. USB drivers). Monitoring of
the greeting text, where supported, can help in detecting the successful end
of the boot phase.
A complete start up including cellular network operation can only take place
with a SIM card.
SARA-R5 / LEXI-R5 If the SIM card has enabled the PIN check, some commands
answer with “+CME ERROR: SIM PIN required” and most cellular functionalities
are not started. After entering the required PIN via the +CPIN command, or if
booting with a SIM with disabled PIN check, SIM initialization is carried out
and a lot of SIM files are read: it is possible that some commands (e.g.
phonebook AT commands) are affected by this preliminary phase, resulting in a
temporary error response.
SARA-R5 / LEXI-R5 If the EFCSP (Customer Service Profile) SIM file is
available, the +PACSP URC is issued at module boot after SIM initialization.
2.1.1 Auto-registration
If the +COPS
SARA-R5 / LEXI-R5 If no SIM is inserted in the module, the module will anyway
select a cell of the cellular network and try to maintain synchronization with
it in limited service.
SARA-R5 / LEXI-R5 During the auto-registration (both at start-up and during
normal operation), any further network request (by means of AT+COPS=0 or
AT+COPS=1) triggers a PLMN selection that can collide with underlying
registration procedures, and in this case the error result code “+CME ERROR:
Temporary failure” can be issued. In these cases the +COPS AT command can be
eventually retried.
SARA-R5 / LEXI-R5 The radio access technology selected by the module at start
up is defined by the <1stAcT> parameter of the +URAT command; afterwards the
module will reselect the RAT based on the requirements of the cellular
standards it complies with and it is not possible to force it to remain in a
given RAT unless it is locked on it via +URAT.
The user can retrieve the result of the auto-registration by polling the
registration status commands (e.g. +CREG/+CGREG/+CEREG/+CIREG) or enabling
their unsolicited notifications. If auto-COPS is running, at boot time or at
SIM insertion, network service commands issued by the user might have a longer
response time than expected; this is particularly visible when the module is
switched on in a jammed condition, or with a roaming SIM card that shall
perform several registration attempts before gaining access to a VPLMN. If the
automatic registration fails and the cause cannot be retrieved via +CEER, it
is suggested to disable auto-COPS starting the module in +COPS: 2 or in
airplane mode +CFUN: 4 and trigger registration with AT commands.
UBX-19047455 – R18 C1-Public
2 General operation
Page 21 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
2.1.2 Operational restrictions
Operational restrictions may derive from several settings: PIN required, SIM
lock, invalidation of the IMEI or SIM credentials by the Mobile Network
Operator (MNO) during the registration procedure, FDN enabled. Restrictions to
access the network are also applied by the module in any one of these
conditions: · In eCall only state (for all modules supporting the eCall
feature) · In minimum functionality power modes (+CFUN: 0, +CFUN: 4, +CFUN:
19, +CFUN: 127), and even if the
module is restarted in +CFUN: 4 or +CFUN: 19 modes, because they are
persistent
If the module is in operational restricted state, it may reject all or
specific service requests (e.g. operator selection, connection establishment).
2.1.3 SARA-R5 / LEXI-R5 Maximum vs typical response time of cellular network
related AT commands
The AT command manual provides the response time as the maximum delay to get
the final result code; the execution of an AT command which requires
interaction with the network (e.g. PDP context activation) or with a remote
server (e.g. connection of a TCP socket) is affected by several aspects, like
the reliability of the radio link, which might introduce packet loss and imply
re-transmissions, and the quality of the network coverage, which can force the
module to look for a better serving cell or even for a different PLMN or Radio
Access Technology. Provided that radio conditions are good (diagnostic
commands like +CESQ, +CGED, +UCGED can report that) and the module is already
registered, the typical response time is really low (e.g. a few seconds); and
if the module is already in RRC connected state (so it does not need to
establish the RRC connection) it is even lower. The response time will
therefore range between the typical response time in good conditions and the
documented maximum response time. The host application usually sets a timer
for each AT command issued on the AT interface, at whose timeout it take
countermeasures like: · aborting the current command (if supported), ·
triggering a registration cycle to restart the cellular protocol stack from a
known state, · triggering a SW reset. Such host application timer can be
configured as the documented maximum response time of the specific AT command
issued, or to a shorter value provided that the module is in a known initial
state (e.g. registered). In the latter case the timer duration can be
theoretically derived from some frequent abnormal cases like the following: ·
loss of one of the module’s messages or network response, · collision between
the service request and some mobility procedure and set to some tens of
seconds. When there is no information on the module registration status, like
at switch on, it is advisable to wait more, because the mobility procedure
might last much longer due to e.g.: · initial PLMN scan on all supported bands
and RATs to find the highest priority PLMN in roaming condition;
if NB-IoT is among the supported RATs, 2 minutes might be required to scan
each NB-IoT band; · registration attempts on several PLMNs rejecting the
module due to subscription limitation; in legacy RATs
(2G, 3G) this occurs within the steering of roaming (SoR) feature and can
extend the registration response time to more than the 3 minutes calculated as
worst case in a single PLMN (at least 4 minutes are suggested in this case).
If the current command is aborted and re-issued, it might be that the module
can never complete the required steps to find a suitable cell and PLMN and
register on it. This holds in particular for the registration commands
AT+COPS=0 issued in +COPS: 2. So it is suggested to use a larger timeout value
at least once, before taking countermeasures like triggering a registration
cycle or a SW reset.
2.2 AT commands types
2.2.1 Action command
An action command forces the DCE to print information text or execute a
specific action for the command. A typical example of this command type is the
provision of the factory-programmed settings of the DCE like manufacturer
name, firmware version, etc.
UBX-19047455 – R18 C1-Public
2 General operation
Page 22 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
2.2.2 Set command
A set command configures the preferred settings for the specified command. The
set command is the only way to set the preferred settings in the DCE. For some
commands it is possible to store the current settings in the profile or in the
non volatile memory and retrieve them in another connection.
2.2.3 Read command
A read command provides the current setting of the command parameters. It is
used to find out the current command configuration.
2.2.4 Test command
A test command provides the list of the values allowed by each parameter of
the command.
2.2.5 Unsolicited Result Code (URC)
An unsolicited result code is a string message (provided by the DCE) that is
not triggered as an information text response to a previous AT command and can
be output, when enabled, at any time to inform the DTE of a specific event or
status change.
The URC can have the same name of the command that enables it or can be
enabled by another command. Generally the AT commands activate the URC on the
present (virtual) AT interface on which they are enabled. If the AT commands
settings are stored in the personal profile, the related URCs are enabled on
all AT interface identifiers once set with AT&W (where supported). If the AT
commands settings are stored to the NVM, at the module boot the related URCs
are enabled on all the AT interfaces.
There are cases where both the AT command setting and the AT interface
identifier is stored to NVM, therefore the URC will be enabled only on a
specific AT interface. These cases are documented in the related AT commands
descriptions.
For more details on the storing of AT command setting, see Storing of AT
commands setting.
2.2.5.1 URCs presentation deferring
Since the URCs are text responses issued by the DCE without being requested by
the DTE, their occurrence is completely uncorrelated to an AT command
execution. Therefore, a collision between a URC and an AT command response
might occur and it may lead the DTE to misunderstand the URC as part of the AT
command’s text response or viceversa.
The module avoids this collision by delaying the URCs presentation if the AT command interface is busy. The AT command interface can be busy in the following cases: · During a data call (data mode) · During the execution of an AT command in command or online command mode
The command execution starts when the command line is completed by the command line termination character and the AT interpreter in the module accepts it; the command execution ends when the final result code for the command is sent out. Inside this period, the module is not allowed to send the not buffered URCs. For most of the messages, the DCE needs to be configured whether or not to send a URC. After enabling, for most of the URCs, if the AT command interface is busy, the pending URCs are buffered and their sending to the DCE is deferred. The RING indication is always generated as an unsolicited result code. The NO CARRIER indication is generated as an unsolicited result code when it has not to be considered the final response for the executing command (e.g.: ATH); if it is handled as an unsolicited result code, it follows the rule of the other URCs.
Generally, the buffered URCs are sent to the terminal as soon as the terminal exits the data mode or the command execution is terminated. An exception to this behavior is implemented for the following URCs classes:
Class Reception of a new SMS related URCs
AT command to configure the class +CNMI AT command
UBX-19047455 – R18 C1-Public
2 General operation
Page 23 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Class +CIEV URCs
AT command to configure the class +CMER AT command
For the above classes, it is possible to select the presentation strategy when
the AT interface is busy, according to the 3GPP TS 27.007 [75]; buffering or
discarding are the two possible choices (URCs are lost in the latter case).
This is done by means of the corresponding AT command (see the AT commands
listed in the table above). If the URCs are enabled or, for the three
described classes of URCs, the buffered URCs are sent out only when the AT
interface is in idle again, then this occurs as soon as: · The data mode is
released (the data call is disconnected) · The final result code for an AT
command is issued
To ensure the DCE can transmit the buffered URCs, the DTE should wait some
time (the recommended value is at least 20 ms) after the reception of an AT
command final result code or URC before issuing a new AT command. Otherwise,
the collision of the URCs with the subsequent AT command is possible.
If multiple AT interfaces are available, it is best to use one of the AT
interfaces to manage all the user-enabled URCs, while using the other ones to
send AT commands and receive their responses. The URCs related to external
causes (e.g., RING) are issued on all interfaces.
2.2.6 Intermediate Result Code (IRC)
An intermediate result code is a string message (provided by the DCE) which
provides to the DTE some information about the processing status of the
pending AT command.
UBX-19047455 – R18 C1-Public
2 General operation
Page 24 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
3 IPC – Inter Processor Communication
3.1 Multiplexing mode +CMUX
+CMUX Modules Attributes
All products Syntax partial
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
3.1.1 Description
Enables the multiplexing protocol control channel as defined in 3GPP TS 27.010 [104]. The command sets the parameters for the control channel. The result code is returned using the old interface speed. The parameters become active only after sending the OK result code.
The usage of +CMUX set command during the multiplexing is not allowed.
The multiplexer configuration is as follows:
Modules SARA-R5 / LEXI-R5
Control channel Channel 0
AT commands / data connection Channel 1 – 3
GNSS tunneling Channel 4
SIM Access Profile (SAP)
Table 2: Multiplexer configuration
3.1.2 Syntax
Type Set Read
Test
Syntax AT+CMUX=
Response OK
Example AT+CMUX=0,0,,1500,50,3,90
OK
+CMUX:
speed>,
OK
OK
+CMUX: (list of supported
+CMUX: (0),(0),,(1-1509),(1-255),(0-
5),(2-255),,
OK
(list of supported
supported
(list of supported
OK
3.1.3 Defined values
Parameter
Type Number
Number
Number
Description Multiplexer transparency mechanism: · 0: basic option The way in
which the multiplexer control channel is set up: · 0 (default value): UIH
frames used only · 1: UI frames used only Allowed values: · SARA-R5 / LEXI-R5
– 0
Transmission rate. The allowed range is 0-7.
UBX-19047455 – R18 C1-Public
3 IPC – Inter Processor Communication
Page 25 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Parameter
Type Number Number Number Number Number Number
Description This parameter is ignored and the value 0 is always displayed in
case of read command. Maximum frame size: · Allowed range is 1-1509. · The
default value is 31. Acknowledgement timer in units of ten milliseconds. The
allowed range is 1-255.
This parameter is ignored and the value 253 is always set. Maximum number of
re-transmissions: · Allowed range is 0-5. · The default value is 3. Response
timer for the multiplexer control channel in units of ten milliseconds. The
allowed range is 2-255.
This parameter is ignored and the value 254 is always set. Wake up response
timer. The allowed range is 0-255.
This parameter is ignored and the value 0 is always displayed in case of the
read command. Window size, for advanced operation with Error Recovery options.
The allowed range is 0-255.
This parameter is ignored and the value 0 is always displayed in case of the
read command.
3.1.4 Notes
· If the multiplexer protocol is not started (the +CMUX set command has not
been issued or returned an error result code) and AT+CMEE is set to 2, the
+CMUX read command returns the following error result code: +CME ERROR:
operation not allowed.
· For complete compatibility between u-blox products, leave the
unsupported/unused parameters blank (which are reported as blank by the +CMUX
test command).
·
SARA-R5 / LEXI-R5 · To enable the GNSS tunneling on the dedicated MUX channel,
configure properly the +UGPRF AT command, otherwise there will be no data flow
on it.
SARA-R5 / LEXI-R5 · After having issued the set command, a timeout of 5 s is
started. The MUX protocol is aborted if the DTE does not initiate the
establishment of the MUX control channel (via a SABM frame on DLCI 0) within
this time. · On the AUX UART interface, the multiplexer protocol is not
supported. · In case the AUX UART interface is configured as AT interface (for
more details, see +USIO AT command,
UBX-19047455 – R18 C1-Public
3 IPC – Inter Processor Communication
Page 26 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4 General
4.1 Manufacturer identification +CGMI
+CGMI Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.1.1 Description
Text string identifying the manufacturer.
4.1.2 Syntax
Type Action
Syntax AT+CGMI
Test
AT+CGMI=?
Response
OK OK
Example u-blox
OK
4.1.3 Defined values
Parameter
Type String
Description Manufacturer name
4.2 Manufacturer identification +GMI
+GMI Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.2.1 Description
Text string identifying the manufacturer.
4.2.2 Syntax
Type Action
Syntax AT+GMI
Response
OK
Example u-blox
OK
4.2.3 Defined values
Parameter
Type String
Description Manufacturer name
UBX-19047455 – R18 C1-Public
4 General
Page 27 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4.3 Model identification +CGMM
+CGMM Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.3.1 Description
Text string identifying the product name.
4.3.2 Syntax
Type Action
Syntax AT+CGMM
Test
AT+CGMM=?
Response
OK OK
Example LISA-U200
OK
4.3.3 Defined values
Parameter
Type String
Description Name of the product
4.3.4 Notes
SARA-R5 / LEXI-R5 · For the model name, see the ATI7 command.
4.4 Model identification +GMM
+GMM Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.4.1 Description
Text string identifying the product name.
4.4.2 Syntax
Type Action
Syntax AT+GMM
Response
OK
Example LISA-U120
OK
4.4.3 Defined values
Parameter
Type String
Description Name of product
4.4.4 Notes
SARA-R5 / LEXI-R5 · For the model name, see the ATI7 command.
UBX-19047455 – R18 C1-Public
4 General
Page 28 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4.5 Firmware version identification +CGMR
+CGMR Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.5.1 Description
Returns the firmware version of the module.
4.5.2 Syntax
Type Action
Syntax AT+CGMR
Test
AT+CGMR=?
Response
OK OK
Example 11.40
OK
4.5.3 Defined values
Parameter
Type String
Description Firmware version
4.6 Firmware version identification +GMR
+GMR Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.6.1 Description
Returns the firmware version of the module.
4.6.2 Syntax
Type Action
Syntax AT+GMR
Response
OK
Example 11.40
OK
4.6.3 Defined values
Parameter
Type String
Description Firmware version
4.7 Request product serial number identification +CGSN
+CGSN Modules Attributes
All products Syntax partial
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.7.1 Description
Returns the International Mobile station Equipment Identity (IMEI) number and
related information to identify the MT that the TE is connected to.
UBX-19047455 – R18 C1-Public
4 General
Page 29 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4.7.2 Syntax
Type
Syntax
Generic syntax
Set
AT+CGSN[=
Serial number request
Set
AT+CGSN[=0]
IMEI request
Set
AT+CGSN=1
IMEISV request
Set
AT+CGSN=2
SVN request
Set
AT+CGSN=3
Full IMEI and SVN request
Set
AT+CGSN=255
Test
AT+CGSN=?
4.7.3 Defined values
Parameter
Type Number
String
String Number
Response
Example
[+CGSN: ]
AT+CGSN=0 357520070120767 OK
AT+CGSN 357520070120767 OK
+CGSN:
AT+CGSN=1 +CGSN: “357520070120767” OK
+CGSN:
AT+CGSN=2 +CGSN: “3575200701207601” OK
+CGSN:
AT+CGSN=3 +CGSN: “01” OK
AT+CGSN=255 35752007012076701 OK +CGSN: (0-3,255) OK
Description
It indicates the requested serial number type. Depending on
UBX-19047455 – R18 C1-Public
4 General
Page 30 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Parameter
Type
Number/ String
Description Type and supported content depend on related
4.8 IMEI identification +GSN
+GSN Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.8.1 Description
The commands handling is the same of +CGSN.
4.8.2 Syntax
Type Action
Syntax AT+GSN[=
Test
AT+GSN=?
Response
OK OK
Example 004999010640000
OK
4.8.3 Defined values
See +CGSN AT command.
4.9 Identification information I
I Modules Attributes
All products Syntax partial
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.9.1 Description
Returns some module information as the module type number and some details
about the firmware version.
The information text response of ATI9 contains the modem version and the
application version of the module where applicable; it returns “Undefined”
where not applicable.
4.9.2 Syntax
Type Action
Syntax
Type number request ATI[0]
Module boot sequence version request ATI6
Model name ATI7
Modem and application version request
ATI9
Response
Example ATI0
OK
SARA-R510M8S-01B-00
OK
OK
1
OK ATI7
OK
SARA-R510M8Sv1
OK ATI9
02.06.A00.01
UBX-19047455 – R18 C1-Public
4 General
Page 31 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Type
Syntax
Response OK
Example OK
SARA-R500S / SARA-R510M8S / SARA-R510S / SARA-R520 / SARA-R520M10
Modem and applications versions are comma separated.
4.9.3 Defined values
Parameter
Type String Number
Number String String
Description Product type number Module boot sequence version. Where not
applicable the module provides “Undefined” Model name. For more details on the
allowed values, see Notes. Module modem version
Module application version. Where not applicable the module provides
“Undefined”
4.9.4 Notes
LEXI-R5 · Table 3 reports the model name of each type number.
Product type number LEXI-R520-02B-00
Model name LEXI-R520
Table 3: Model name (ATI7 response)
SARA-R5 · Table 4 reports the model name of each type number.
Product type number SARA-R500E-01B-00 SARA-R500S-01B-01 SARA-R510S-01B-01 SARA-R510M8S-01B-01 SARA-R500S-01B-00 SARA-R510S-01B-00 SARA-R510M8S-01B-00 SARA-R500S-61B-00 SARA-R510S-61B-00 SARA-R510M8S-61B-00 SARA-R500S-71B-00 SARA-R510S-71B-00 SARA-R510M8S-71B-00 SARA-R520-02B-00 SARA-R520M10-02B-00
Model name SARA-R500E SARA-R500Sv1 SARA-R510Sv1 SARA-R510M8Sv1 SARA-R500Sv1 SARA-R510Sv1 SARA-R510M8Sv1 SARA-R500S-61B SARA-R510S-61B SARA-R510M8S-61B SARA-R500S-71B SARA-R510S-71B SARA-R510M8S-71B SARA-R520-02B SARA-R520M10-02B
Table 4: Model name (ATI7 response)
SARA-R500S-00B / SARA-R510M8S-00B / SARA-R510S-00B · The ATI7 command is not
supported.
UBX-19047455 – R18 C1-Public
4 General
Page 32 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4.10 TE character set configuration +CSCS
+CSCS Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
Profile
No
–
+CME Error
4.10.1 Description
Selects the TE character set.
The selected character set is used for encoding/decoding of only the AT
commands’ string type parameters whose description explicitly references the
+CSCS setting itself.
SARA-R5 / LEXI-R5 The command setting is not stored in the profile and is
volatile.
4.10.2 Syntax
Type Set
Syntax AT+CSCS=
Read
AT+CSCS?
Test
AT+CSCS=?
Response OK
Example AT+CSCS=”IRA”
+CSCS:
OK +CSCS: “IRA”
OK
OK
+CSCS: (list of supported
OK
“8859-1″,”UCS2″,”HEX”, “PCCP936”)
OK
4.10.3 Defined values
Parameter
Type String
Description
Allowed characters set:
· “IRA”: International Reference Alphabet (ITU-T T.50)
· “GSM”: GSM default alphabet (3GPP TS 23.038)
· “PCCP437”: PC character set Code Page 437
· “8859-1”: ISO 8859 Latin 1 character set
· “UCS2”: 16-bit universal multiple-octet coded character set (USO/IEC10646);
UCS2 character strings are converted to hexadecimal numbers from 0000 to FFFF;
e.g. “004100620063” equals three 16-bit characters with decimal values 65, 98
and 99
· “HEX”: character strings consist only of hexadecimal numbers from 00 to FF;
e.g. “032FE6” equals three 8-bit characters with decimal values 3, 47 and 230;
no conversions to the original MT character set shall be done
· “PCCP936”: Chinese character set
· “UTF-8”: octet (8-bit) lossless encoding of UCS characters (see RFC 3629
[205]); UTF-8 encodes each UCS character as a variable number of octets, where
the number of octets depends on the integer value assigned to the UCS
character. The input format shall be a stream of octets. It shall not be
converted to hexadecimal numbers as in “HEX” or “UCS2”. This character set
requires an 8-bit TA – TE interface.
Allowed values:
· SARA-R5 / LEXI-R5 – “IRA” (default value), “GSM”, “PCCP437”, “8859-1”,
“UCS2”, “HEX”
UBX-19047455 – R18 C1-Public
4 General
Page 33 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4.11 International mobile subscriber identification +CIMI
+CIMI Modules Attributes
All products Syntax full
PIN required Yes
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.11.1 Description
Request the IMSI (International Mobile Subscriber Identity).
4.11.2 Syntax
Type Action
Syntax AT+CIMI
Test
AT+CIMI=?
Response
OK OK
Example 222107701772423
OK
4.11.3 Defined values
Parameter
Type Number
Description International Mobile Subscriber Identity
4.12 Card identification +CCID
+CCID Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.12.1 Description
Returns the ICCID (Integrated Circuit Card ID) of the SIM-card. ICCID is a
serial number identifying the SIM.
4.12.2 Syntax
Type Action
Syntax AT+CCID
Read
AT+CCID?
Test
AT+CCID=?
Response +CCID:
OK +CCID:
OK OK
Example +CCID: 8939107800023416395
OK +CCID: 8939107900010087330
OK
4.12.3 Defined values
Parameter
Type String
Description ICCID of the SIM card
4.12.4 Notes
· The command needs of the SIM to correctly work.
UBX-19047455 – R18 C1-Public
4 General
Page 34 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
4.13 Request complete capabilities list +GCAP
+GCAP Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
4.13.1 Description
This command requests the list of capabilities, containing the corresponding
command names. The Complete Capabilities List command indicates the major
capability areas of the MT. Each area is presented by the selection command
name of the specific capability area or some other predefined response.
The first response text (+FCLASS) informs that some fax or voice capabilities
are present while the second supported area presented with +CGSM shows that
all GSM commands of the present document are supported.
4.13.2 Syntax
Type Action
Syntax AT+GCAP
Test
AT+GCAP=?
Response +GCAP: <capability_area 1>[, <capability_area 2>[…]] OK OK
Example +GCAP: +FCLASS, +CGSM
OK
4.13.3 Defined values
Parameter
Type String
Description Command name or predefined response of the specific capability
area
In the example: +FCLASS response text informs that some fax or voice
capabilities are present, while +CGSM response text shows that all GSM
commands of the present document are supported by the MT
UBX-19047455 – R18 C1-Public
4 General
Page 35 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
5 Mobile equipment control and status
5.1 Phone activity status +CPAS
+CPAS Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
5.1.1 Description
Returns the activity status
5.1.2 Syntax
Type Action
Syntax AT+CPAS
Test
AT+CPAS=?
Response +CPAS:
OK +CPAS: (list of supported
OK
Example +CPAS: 0
OK +CPAS: (0-5)
OK
5.1.3 Defined values
Parameter
Type Number
Description MT activity status: · 0: ready (MT allows commands from DTE) · 1:
unavailable (MT does not allow commands from DTE) · 2: unknown (MT is not
guaranteed to respond to instructions) · 3: ringing (MT is ready for commands
from DTE, but the ringer is active) · 4: call in progress (MT is ready for
commands from DTE, but a call is in progress,
e.g. call active, hold, disconnecting) · 5: asleep (ME is unable to process
commands from DTE because it is in a low
functionality state) Allowed values: · SARA-R5 / LEXI-R5 – 0, 1, 2, 3, 4, 5
5.2 Module switch off +CPWROFF
+CPWROFF Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
< 40 s
+CME Error
5.2.1 Description
Switches off the MT. During shutdown current settings are saved in module’s
non-volatile memory.
Using this command can result in the following command line being ignored.
See the corresponding system integration manual for the timing and the electrical details of the module power-off sequence via the AT+CPWROFF command.
5.2.2 Syntax
Type Action
Syntax AT+CPWROFF
Response OK
Example
UBX-19047455 – R18 C1-Public
5 Mobile equipment control and status
Page 36 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Type Test URC
Syntax AT+CPWROFF=?
Response OK +UCPWROFF
Example +UCPWROFF
5.2.3 Notes
SARA-R5 / LEXI-R5 · The +UCPWROFF URC is not supported.
5.3 Set module functionality +CFUN
+CFUN Modules Attributes
All products Syntax partial
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
Appendix B.4 +CME Error
5.3.1 Description
Selects the level of functionality
SARA-R5 / LEXI-R5 If the syntax AT+CFUN=15 or AT+CFUN=16 (resets) or
AT+CFUN=127 is used (where supported), the rest of the command line placed
after that will be ignored.
5.3.2 Syntax
Type Set
Syntax AT+CFUN=
Read
AT+CFUN?
Test
AT+CFUN=?
URC
Response OK
Example AT+CFUN=1
+CFUN:
OK +CFUN: (list of supported
OK +UUFASTSHUTDOWN:
OK +CFUN: 1,0 OK
+CFUN: (0,1,4,6,7,8,9,16),(0-1) OK
+UUFASTSHUTDOWN: 0
5.3.3 Defined values
Parameter
Type Number
Description Selected functionality:
· 0: sets the MT to minimum functionality (disable both transmit and receive
RF circuits by deactivating both CS and PS services)
· 1 (factory-programmed value): sets the MT to full functionality, e.g. from
airplane mode or minimum functionality. Full functionality mode is persistent
between power cycles triggered by AT+CFUN=15, AT+CFUN=16 or AT+CPWROFF (where
supported).
· 4: disables both transmit and receive RF circuits by deactivating both CS
and PS services and sets the MT into airplane mode. Airplane mode is
persistent between power cycles triggered by AT+CFUN=15, AT+CFUN=16 or
AT+CPWROFF (where supported).
· 6: enables the SIM toolkit interface in dedicated mode and fetching of
proactive commands by SIM Application Toolkit from the SIM card
· 7 or 8: disables the SIM toolkit interface and fetching of proactive
commands by SIM Application Toolkit from the SIM card
UBX-19047455 – R18 C1-Public
5 Mobile equipment control and status
Page 37 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Parameter
Type
Number Number Number Number
Description · 9: enables the SIM toolkit interface in raw mode and fetching of
proactive
commands by SIM Application Toolkit from the SIM card
· 10: fast power-off, the command triggers a fast shutdown, without sending a
detach request to the network, with storage of current settings in module’s
nonvolatile memory. The “OK” final result code indicates the command request
was successful, while the +UUFASTSHUTDOWN URC provides the status of the
poweroff process.
· 15: MT silent reset (with detach from network and saving of NVM parameters),
without reset of the SIM card
· 16: MT silent reset (with detach from network and saving of NVM parameters),
with reset of the SIM card
· 19: sets the MT to minimum functionality by deactivating CS and PS services
and the SIM card
· 126: at the exit from deep-sleep mode (PSM or eDRX) by means of PWR_ON input
pin, it triggers the protocol stack activation, if the bit 4 of
· 127: sets the MT in a deep low power state “HALT” (with detach from the
network and saving of the NVM parameters); the only way to wake up the module
is a power cycle or a module reset
Allowed values:
· SARA-R500E / SARA-R500S-01B / SARA-R500S-61B / SARA-R500S-71B / SARA-
R510M8S-01B / SARA-R510M8S-61B / SARA-R510M8S-71B / SARA-R510S-01B / SARA-
R510S-61B / SARA-R510S-71B / SARA-R520 / SARA-R520M10 / LEXI-R5 – 0, 1, 4, 7,
8, 10, 16, 126
· SARA-R500S-00B / SARA-R510M8S-00B / SARA-R510S-00B – 0, 1, 4, 7, 8, 10, 16
Reset mode. This parameter can be used only when
· 0 (default value): do not reset the MT before setting it to the selected
5.3.4 Notes
SARA-R500S-00B / SARA-R510M8S-00B / SARA-R510S-00B · The +UUFASTSHUTDOWN URC
is not issued after AT+CFUN=10 on SARA-R500S-00B-00, SARA-R510S-00B-00 and
SARA-R510M8S-00B-00; see
UBX-19047455 – R18 C1-Public
5 Mobile equipment control and status
Page 38 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
5.4 Indicator control +CIND
+CIND Modules Attributes
All products Syntax partial
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
5.4.1 Description
Provides indication states related to network status, battery information and
so on.
The set command does not allow setting the values for those indications which
are set according to module state (see
The list of indications for set and read commands follows the indexes reported
in the
For more details, see the 3GPP TS 27.007 [75].
5.4.2 Syntax
Type Set
Syntax AT+CIND=[
Read
AT+CIND?
Test
AT+CIND=?
Response OK
+CIND:
Example AT+CIND=
OK +CIND: 5,0,0,0,0,0,0,0,0,0,0,0
OK +CIND: (“battchg”,(0-5)),(“signal”, (0-5)),(“service”,(0,1)),(“sounder”,
(0,1)),(“message”,(0,1)),(“call”,(0,1)),
(“roam”,(0,1)),(“smsfull”,(0,1)),(“gprs”,
(0-2)),(“callsetup”,(0-3)),(“callheld”,(0 ,1)),(“simind”,(0-2))
OK
5.4.3 Defined values
Parameter
Type Number
String
Description Range of corresponding
Reserved by the norm and their
o 0: not registered to any network o 1: registered to the network o 65535:
indication not available · “sounder”: sounder activity, indicating when the
module is generating a sound o 0: no sound o 1: sound is generated ·
“message”: unread message available in
UBX-19047455 – R18 C1-Public
5 Mobile equipment control and status
Page 39 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
Parameter
Type
Description o 65535: indication not available
· “smsfull”: indication that an SMS has been rejected with the cause of SMS
storage full o 0: SMS storage not full o 1: SMS storage full
· “gprs”: PS indication status: o 0: no PS available in the network o 1: PS
available in the network but not registered o 2: registered to PS o 65535:
indication not available
· “callsetup”: call set-up: o 0: no call set-up o 1: incoming call not
accepted or rejected o 2: outgoing call in dialling state o 3: outgoing call
in remote party alerting state
· “callheld”: call on hold: o 0: no calls on hold o 1: at least one call on
hold
· “simind”: SIM detection o 0: no SIM detected o 1: SIM detected o 2: not
available
Allowed
“roam”, “smsfull”, “gprs”, “callsetup”, “callheld”, “simind”
5.4.4 Notes
· If the battery charging is not supported, “battchg” always returns 5 (full
charge). · The
“signal” value 0 1 2 3 4 5
Power level (< -105 dBm or unknown) (< -93 dBm) (< -81 dBm) (< -69 dBm) (< -57 dBm) (>= -57 dBm)
SARA-R5 / LEXI-R5
· To enable the “SIM card detection” feature the SIM_DET pin must be properly
configured (if not already set); for more details, see the GPIO introduction
and +UGPIOC command description (
5.5 Configuration of indicator control +UCIND
+UCIND Modules Attributes
All products Syntax full
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
5.5.1 Description
Allows the configuration of unsolicited results for indications with +CIEV.
UBX-19047455 – R18 C1-Public
5 Mobile equipment control and status
Page 40 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
5.5.2 Syntax
Type Set
Syntax AT+UCIND=[
Read
AT+UCIND?
Test
AT+UCIND=?
Response OK
+UCIND:
Example AT+UCIND=7
OK +UCIND: 7
OK
5.5.3 Defined values
Parameter
Type Number
Description The unsigned integer (0 to 4095) is a bitmask representing the
list of the indications active for +CIEV URC reporting. The bit position
corresponds to the indicator number (see the
The bits corresponding to unused indicator order numbers (greater than 13)
must be set to 0 (setting a
5.6 Mobile termination event reporting +CMER
+CMER Modules Attributes
All products Syntax partial
PIN required No
Settings saved Can be aborted Response time Error reference
No
No
–
+CME Error
5.6.1 Description
Configures sending of URCs from MT to DTE for indications. The
The URC is generated each time an indicator which is defined in +CIND command
changes status. The code is actually submitted to MT according to the +CMER
settings.
SARA-R5 / LEXI-R5 The command +UCIND allows enabling or disabling indicators.
5.6.2 Syntax
Type Set
Syntax AT+CMER=[
Read
AT+CMER?
Test
AT+CMER=?
URC
Response OK
Example AT+CMER=1,0,0,2,1
OK
+CMER:
OK
+CMER: 1,0,0,0,1 OK
+CMER: (list of supported
+CMER: (0-3),(0),(0),(0-2),(0,1)
OK
(list of supported
OK +CIEV:
UBX-19047455 – R18 C1-Public
5 Mobile equipment control and status
Page 41 of 655
SARA-R5 / LEXI-R5 series – AT commands manual
5.6.3 Defined values
Parameter
Type Number
Number Number Number
Number
Number
Description Allowed values: · 0 (default value): buffer URCs in the MT · 1:
discard URCs when the V.24 interface is reserved for data; otherwise directly
display them on the DTE · 2: buffer URCs in MT when the V.24 interface is
reserved and flush them after
reservation; otherwise directly display them on the DTE · 3: same as 1 Allowed
values: · 0: no keypad event reporting Allowed values: · 0: no display event
reporting Allowed values: · 0: no indicator event reporting · 1: indicator
event reporting using the +CIEV URC. Only the indicator events which
are not caused by +CIND shall be indicated by the MT to the DTE. · 2:
indicator event reporting using the +CIEV URC. All the indicator events shall
be
directed from MT to DTE. Allowed values: · 0: MT buffer of URCs defined within
this command is cleared when
entered · 1: MT buffer of URCs defined within this command is flushed to the
DTE when
References
- Roblox
- Apps For College Students: A Complete Guide to Programs You Need
- Current IP Check
- My Dyn Account
- Leshan Server Demo
- Free Dynamic DNS - Managed DNS - Managed Email - Domain Registration - No-IP
- OID repository - 0.9.2342.19200300.100.1.1 = {itu-t(0) data(9) pss(2342) ucl(19200300) pilot(100) pilotAttributeType(1) uid(1)}
- OID repository - 2.5.4.10 = {joint-iso-itu-t(2) ds(5) attributeType(4) organizationName(10)}
- OID repository - 2.5.4.11 = {joint-iso-itu-t(2) ds(5) attributeType(4) organizationalUnitName(11)}
- OID repository - 2.5.4.3 = {joint-iso-itu-t(2) ds(5) attributeType(4) commonName(3)}
- OID repository - 2.5.4.5 = {joint-iso-itu-t(2) ds(5) attributeType(4) serialNumber(5)}
- OID repository - 2.5.4.6 = {joint-iso-itu-t(2) ds(5) attributeType(4) countryName(6)}
- OID repository - 2.5.4.7 = {joint-iso-itu-t(2) ds(5) attributeType(4) localityName(7)}
- somedomain.com
- Test.com is for sale
- ietf.org/rfc/rfc2460.txt
- ietf.org/rfc/rfc5280.txt
- ietf.org/rfc/rfc791.txt
- ietf.org/rfc/rfc8323.txt
- www.openmobilealliance.org - /release/Common/
- Home | u-blox
- Contact u-blox | u-blox
- IETF | Internet Engineering Task Force
- ietf.org/rfc/rfc3629.txt
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>