System features

Firmware installation +UFWINSTALL

+UFWINSTALL

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

FW Install Error

Description

Triggers the FW installation procedure, starting from the file (update binary file) stored in the module file system. It could be used as a part of implementation of the FOTA procedure. The command causes a SW system reset with network deregistration.

During the update process, the device cannot be used to make calls, even emergency calls. Do not remove the power supply or reset the module during the installation procedure even if it is fault tolerant! In case of power loss during the install phase, at the next module wake-up a fault is detected and the module remains in Firmware Install Mode until the end of the procedure (install terminated).

The command syntax differs depending on the module: see the corresponding subsection for the correct command handling.

Once the command has been sent correctly, the FW resets and at the next boot-up, the FW install will start.

When the FW update is completed, a +UUFWINSTALL URC will notify the final result of the operation.

At the end of a successful installation, the main firmware software boots up, NVM and profiles data are set to the factory-programmed values of the new firmware version and the SIM is reset (the PIN will be required if enabled).

Syntax

TypeSyntaxResponseExample

Set

AT+UFWINSTALL

OK

AT+UFWINSTALL

OK

Test

AT+UFWINSTALL=?

OK

OK

URC

+UUFWINSTALL: <status_install>

Defined values

ParameterTypeDescription

<status_install>

Number

Provides the update result code (see LEXI-R10 FOAT error result messages).

Notes

  • Store the update file into the module before starting the FW installation with the +UFWINSTALL AT command. The procedure for storing is up to the user (via +NFWUPD or +UHTTPC AT command).

  • The +UFWINSTALL AT command checks for presence and consistency of the update file. If checks fail, a proper URC with the error result code is issued after the final reboot (see Firmware install final result codes).

  • After the command is issued, the module reboots and starts the FW installation process which will take about 2 minutes. At the update process end, the module reboots twice. No intermediate result codes are issued on the terminal during this phase.

  • At the end of the FW update process the module reboots again with the new firmware installed; NVM, profiles and the file system are restored to the factory-programmed values.

  • The final result code will be issued on all the available interfaces after the FW update success or failure.

Antenna detection +UANTR

+UANTR

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

Measures the DC component of load of the cellular antenna. The antenna load is expressed in kOhm.

Syntax

TypeSyntaxResponseExample

Set

AT+UANTR=[<antenna_id>]

+UANTR: <antenna_id>,<antenna_load>

OK

AT+UANTR=0

+UANTR: 0,10

OK

Test

AT+UANTR=?

+UANTR: (list of supported <antenna_id>s)

OK

+UANTR: (0)

OK

Defined values

ParameterTypeDescription

<antenna_id>

Number

Antenna identifier:

  • 0 (default value): cellular antenna

<antenna_load>

Number

Measured value in kOhm of the antenna load with a resolution of 1 kOhm. The range goes from -1 to 53 (only integer values can be assumed), where:

  • -1: open circuit

  • 0: short circuit

  • 1: 1 kOhm (minimum limit of the measurement range)

  • …​

  • 53: 53 kOhm (maximum limit of the measurement range)

Notes

  • The load resistor values below the minimum limit of 1 kOhm are identified as short circuit (<antenna_load>=0), while values above the maximum limit of 53 kOhm are identified as open circuit (<antenna_load>=-1).

  • The reported value could differ from the real resistance value of the diagnostic resistor mounted inside the antenna assembly due to antenna cable length, antenna cable capacity and the measurement method.

Antenna dynamic tuner +UATUN

+UATUN

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

Full

No

NVM

No

< 5 s

+CME Error

Description

Configures two dedicated output pins (RFCTRL1 and RFCTRL2) to control in real time an external antenna tuning IC, changing their output value dynamically according to the current frequency band used by the cellular module. The default and factory-programmed configuration has all zero output values for all bands.The antenna dynamic tuner control setting is stored in the NVM, and its configuration is effective immediately after changing it. See example of the relation between the dedicated pins output and the frequency band in use in the Notes.

Syntax

TypeSyntaxResponseExample

Antenna dynamic tuner control enabling

Set

AT+UATUN=1,<atun_00_num_lte_bands>,<atun_01_num_bands>,<atun_10_num_bands>,<atun_11_num_bands>[,<atun_00_list_band_1>[,<atun_00_list_band_2>[,…​]]][,<atun_01_list_band_1>[,<atun_01_list_band_2>[,…​]]][,<atun_10_list_band_1>[,<atun_10_list_band_2>[,…​]]][,<atun_11_list_band_1>[,<atun_11_list_band_2>[,…​]]]

OK

AT+UATUN=1,5,2,1,0,1,3,7,28,254,5,20,8

OK

Antenna dynamic tuner control disabling

Set

AT+UATUN=0

OK

AT+UATUN=0

OK

Read

AT+UATUN?

+UATUN: <atun_enable>[,<atun_00_num_bands>,<atun_01_num_bands>,<atun_10_num_bands>,<atun_11_num_bands>[,<atun_00_list_band_1>[,<atun_00_list_band_2>[,…​]]][,<atun_01_list_band_1>[,<atun_01_list_band_2>[,…​]]][,<atun_10_list_band_1>[,<atun_10_list_band_2>[,…​]]][,<atun_11_list_band_1>[,<atun_11_list_band_2>[,…​]]]]

OK

+UATUN: 1,5,2,1,0,1,3,7,28,254,5,20,8

OK

Test

AT+UATUN=?

+UATUN: (list of supported <atun_enable>),(list of supported <atun_XY_num_bands>),(list of supported <atun_XY_list_band_x>)

OK

+UATUN: (0-1),(0-14),(1-85,254)

OK

Defined values

ParameterTypeDescription

<atun_enable>

Number

Antenna dynamic tuner control status. Allowed values:

  • 0 (factory-programmed value): antenna dynamic tuner control disabled

  • 1: antenna dynamic tuner control enabled

<atun_XY_num_bands>

Number

Number of bands for which the dedicated pins output values are RFCTRL1=X (0 or 1) and RFCTRL2=Y (0 or 1). The allowed range is 0-14.

<atun_XY_list_band_x>

Number

Band value in decimal format; a list of <atun_XY_num_bands> band values shall be provided. The allowed range of the LTE bands is (1-85) and the value of the WiFi band 2.4 GHz is 254.

Notes

  • The same band cannot be present in more than one list. At least one band shall be configured if the feature is enabled, otherwise an error result code will be returned.

  • No control of the dedicated pins output is provided for the LTE bands, which are not in the list of the supported band configuration by means of the +UBANDCONF AT command. The WiFi band is always handled.

  • The antenna tuner configuration does not persist after updating the FW version.

LEXI-R10001D / LEXI-R10011D / SARA-R10

  • Table 12 shows an example of parameters values when <atun_enable>=1.

Table 12. Example of antenna dynamic tuner configuration. Band 34 and 38 are not included, because the maximum allowed number of bands inside a list is 14.
RFCTRL1 - LEXI-R10 pin 45RFCTRL2 - LEXI-R10 pin 44atun_00_num_bandsatun_01_num_bandsatun_10_num_bandsatun_11_num_bandsatun_00_list_band_xatun_01_list_band_xatun_10_list_band_xatun_11_list_band_x

0

0

14

-

-

-

1,2,3,4,7,12,13,25,28,39,40,41,66,254

-

-

-

0

1

-

2

-

-

-

5,20

-

-

1

0

-

-

1

-

-

-

8

-

1

1

-

-

-

0

-

-

-

-

LEXI-R10401D

  • Table 13 shows an example of parameters values when <atun_enable>=1.

Table 13. Example of antenna dynamic tuner configuration
RFCTRL1 - LEXI-R10 pin 45RFCTRL2 - LEXI-R10 pin 44atun_00_num_bandsatun_01_num_bandsatun_10_num_bandsatun_11_num_bandsatun_00_list_band_xatun_01_list_band_xatun_10_list_band_xatun_11_list_band_x

0

0

7

-

-

-

2,4,12,13,14,66,254

-

-

-

0

1

-

1

-

-

-

5

-

-

1

0

-

-

0

-

-

-

-

-

1

1

-

-

-

1

-

-

-

71

LEXI-R10801D

  • Table 14 shows an example of parameters values when <atun_enable>=1.

Table 14. Example of antenna dynamic tuner configuration
RFCTRL1 - LEXI-R10 pin 45RFCTRL2 - LEXI-R10 pin 44atun_00_num_bandsatun_01_num_bandsatun_10_num_bandsatun_11_num_bandsatun_00_list_band_xatun_01_list_band_xatun_10_list_band_xatun_11_list_band_x

0

0

5

-

-

-

1,3,7,28,254

-

-

-

0

1

-

2

-

-

-

5,20

-

-

1

0

-

-

1

-

-

-

8

-

1

1

-

-

-

0

-

-

-

-

Wi-Fi network scan +UWIFISCAN

+UWIFISCAN

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

< 255 s

+CME Error

Description

Configures and scans the surroundings for wireless networks. The Wi-Fi scan response is provided through IRC based on the configuration set via the set command. The IRC returns one or more lines providing networks in the immediate surroundings.

The set command uses the default configurations and triggers the Wi-Fi scan. The read command returns the current configurations of the Wi-Fi scan parameters. The test command returns the list of supported Wi-Fi scan parameters.

If <channelCount> is set to 1 and the following channel ID is set to 0, Wi-Fi scan procedure will scan all the available frequency channels.

Syntax

TypeSyntaxResponseExample

Action

AT+UWIFISCAN

+UWIFISCAN: <ssid>,<rssi>,<bssid>,<channel>

[…​]

OK

AT+UWIFISCAN=12000,1,5,5,0,280,1,0

+UWIFISCAN: "test1",-49,"FC:EC:DA:3B:EB:FC",6

+UWIFISCAN: "test2",-81,"FC:EC:DA:3B:B5:91,1

+UWIFISCAN: "test3",-81,"78:45:58:34:E4:93",1

+UWIFISCAN: "test4",-84,"FC:EC:DA:3B:BA:3D",11

+UWIFISCAN: "test5",-95,"E4:38:7E:0D:27:E1",1

OK

Set

AT+UWIFISCAN=[<maxTimeout>],[<round>],[<maxBssidNum>],[<scanTimeOut>],[<wifiPriority>],[<channelRecLen>],[<channelCount>],[<channelId1>],…​,[<channelId14>],[<targetBssid>]

+UWIFISCAN: <ssid>,<rssi>,<bssid>,<channel>

[…​]

OK

AT+UWIFISCAN=12000,1,5,5,0,280,1,0

+UWIFISCAN: "test1",-49,"FC:EC:DA:3B:EB:FC",6

+UWIFISCAN: "test2",-81,"FC:EC:DA:3B:B5:91,1

+UWIFISCAN: "test3",-81,"78:45:58:34:E4:93",1

+UWIFISCAN: "test4",-84,"FC:EC:DA:3B:BA:3D",11

+UWIFISCAN: "test5",-95,"E4:38:7E:0D:27:E1",1

OK

Read

AT+UWIFISCAN?

+UWIFISCAN: <maxTimeout>,<round>,<maxBssidNum>,<scanTimeOut>,<wifiPriority>,<channelRecLen>,<channelCount>,<channelId1>[,…​,[<channelId14>],[<targetBssid>]]

OK

+UWIFISCAN: 12000,1,5,5,0,280,2,1,2

OK

Test

AT+UWIFISCAN=?

+UWIFISCAN: (list of supported <maxTimeout>s),(list of supported <round>s),(list of supported <maxBssidNum>s),(list of supported <scanTimeOut>s),(list of supported <wifiPriority>s),(list of supported <channelRecLen>s),(list of supported <channelCount>s),(list of supported <channelId1>s),…​,(list of supported <channelId14>s),(example of <targetBssid>)

OK

+UWIFISCAN: (4000-255000),(1-3),(4-40),(1-255),(0-1),(100-280),(1-14),(0-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),(1-14),"AA:BB:CC:DD:EE:FF"

OK

Defined values

ParameterTypeDescription

<maxTimeout>

Number

Wi-Fi scan timeout value expressed in milliseconds. The range goes from 4000 to 255000 ms. The default value is 12000 ms.

<round>

Number

Wi-Fi scan rounds. The range goes from 1 to 3. The default value is 1.

<maxBssidNum>

Number

Maximum required Wi-Fi SSID number. The range goes from 4 to 40. The default value is 5:

  • The Wi-Fi scan procedure will terminate and report the detected Wi-Fi results if the required Wi-Fi SSID is detected.

  • The Wi-Fi scan procedure will terminate and report the detected Wi-Fi results if the required Wi-Fi SSID is not found within the specified <maxTimeout>.

  • In case the <round> is set to 3 and <maxBssidNum> is set to 10; If the Wi-Fi scan detects five SSIDs in the first round, three SSIDs in the second round, and six SSIDs in the third round, it will remove any duplicate SSIDs, sort the remaining SSIDs in descending order, and report the ten Wi-Fi SSIDs result.

<scanTimeOut>

Number

Maximum search timout for each Wi-Fi scan <round>, expressed in seconds. The range goes from 1 to 255 s. The default value is 5 s.

<wifiPriority>

Number

Priority of Wi-Fi scan over the radio connection:

  • 0 (default value): radio connection is preferred

  • 1: Wi-Fi scan is preferred

<channelRecLen>

Number

Maximum scan timeout for each Wi-Fi scan, expressed in milliseconds. The range goes from 100 to 280 ms. The default value is 280 ms.

<channelCount>

Number

Wi-Fi channel count. The range goes from 1 to 14. The default value is 1.

<channelId1>

Number

Wi-Fi channel id-1. The range goes from 0 to 14, when <channelCount> is set to 1 otherwise the range goes from 1 to 14. The default value is 0.

<channelId2>, …​,<channelId14>

Number

Wi-Fi channel id to scan for a specific channel. The range goes from 1 to 14. The default value is 1.

<ssid>

String

SSID name of external wireless network

<rssi>

String

Received signal strength indication, expressed in dBm.

<bssid>

String

MAC address of the external access point

<channel>

Number

Channel ID of the external wireless network

<targetBssid>

String

MAC address of a specific access point. If specified, the scan will terminate as soon as the desired access point is detected (displaying only it in the scan results) or upon completion without showing any detected access points

  • LEXI-R10401D-00B / LEXI-R10801D-00B - parameter not supported

Notes

  • The Wi-Fi scan can be executed with +CFUN: 0/+CFUN: 4 or without USIM inserted.

  • The Wi-Fi scan procedure is initiated only when the radio connection is in IDLE state. It may be interrupted or delayed by any LTE modem activity (such as SCAN, IDLE paging or radio CONNECTION), even if the <wifiPriority> is set to 1. If the Wi-Fi scan is interrupted because the DUT state changes from IDLE to CONNECTED, the scan will not resume and may result in partial or empty Wi-Fi results even when Wi-Fi access points are available.

  • The <maxTimeout> must be greater than or equal to the product of <round> and <scantimeout> parameters.

RING line handling +URING

+URING

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

-

+CME Error

Description

Configures the RING line handling of the UART interface for other events besides the usual ones, that is the incoming call indication (RING) (linked to the "RING" URC) and the incoming SMS indication (linked to the +CMT and the +CMTI URCs).

The RING line will be asserted when one of the configured events occurs and it remains asserted for 1 s unless another configured event happens (in this case the 1 s timer will be started again). Same behavior will be applied if the events are the incoming call or the incoming SMS.

Syntax

TypeSyntaxResponseExample

Set

AT+URING=<mode>

OK

AT+URING=1

OK

Read

AT+URING?

+URING: <mode>

OK

+URING: 1

OK

Test

AT+URING=?

+URING: (list of the supported <mode>s)

OK

+URING: (0-3)

OK

Defined values

ParameterTypeDescription

<mode>

Number

Configures the RING line handling:

  • 0 (factory-programmed value): feature disabled (RING line is asserted only on incoming call and incoming SMS)

  • 1: RING line asserted for all the URCs

  • 2: RING line asserted for all the incoming data (PPP, sockets in Direct Link mode, FTP in Direct Link mode)

  • 3: RING line asserted for all URCs and all incoming data (PPP, sockets in Direct Link mode, FTP in Direct Link mode)

Notes

  • The physical RING line is powered off when the module enters one of the deep-sleep modes (see +UPSV AT command description), hence its state cannot be considered. To use the ring indicator functionality during deep-sleep modes, the +UGPIOC AT command shall be used with <gpio_mode>=18 to map the functionality on a GPIO that is always powered on. The GPIOs that are always powered on can be found in the system integration manual [54].

  • If the ring indicator GPIO is configured, it is driven instead of the UART RING line.

  • URCs or data notification use the physical pin (UART RING line or ring indicator GPIO) also when the event is for AUX UART, USB or MUX virtual channels.

  • The pulse of the UART RING line (or the ring indicator GPIO) is stretched in case of overlapping events.

  • In Direct Link mode, <mode>=2 and <mode>=3 are supported (via UART RING line or ring indicator GPIO toggling) only with sockets and UHTTP.

  • <mode>=2 and <mode>=3 are supported (via UART RING line or ring indicator GPIO toggling) also with USB network interface (ECM, RNDIS) downlink data.

USB profiles configuration +UUSBCONF

+UUSBCONF

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

partial

No

NVM

No

-

+CME Error

Description

The following terminology will be adopted for the +UUSBCONF command description:

  • USB function: a USB capability such as RNDIS, UMS (USB Mass Storage), CDC-ECM, etc. It is implemented within a device class.

  • USB profile: a set of available USB functions (where available means that the function is presented to the host during the enumeration process), e.g. RNDIS plus CDC-ACM. An identifier (product id, PID) is assigned for each profile.

  • USB product: a set of USB profiles, sharing the same PID, one active at a time. It is possible to switch among USB profiles within the same USB product.

Each u-blox cellular module consists of one or more USB products from the point of view of the USB configuration context. Each USB product includes a certain amount of USB profiles. Each USB profile includes a certain amount of USB endpoints, depending on the overall USB functions of the USB profile.

The command configures the active USB profile. The USB profile selection is performed by the specification of the USB product category, the network USB function (when available), and the audio over USB function configuration (enable/disable, when available).

The USB profile switch is not performed at run-time. The settings are saved in NVM at the module power off. The new configuration will be effective at the subsequent module reboot.

The audio over USB function is not supported by current u-blox modules.

Syntax

TypeSyntaxResponseExample

Set

AT+UUSBCONF=[<id>[,<network>[,<audio>]]]

OK

AT+UUSBCONF=0,"AUTO",0

OK

Read

AT+UUSBCONF?

+UUSBCONF: <id>,<network>,<audio>,<pid>

OK

+UUSBCONF: 0,"RNDIS",0,"0x1144"

OK

Test

AT+UUSBCONF=?

+UUSBCONF: (<id> (Corresponding USB functions (string) for <id>),(list of the supported <network>s for <id>),(list of the supported <audio> values for <id>))[,<id>, (Corresponding USB functions (string) for <id>),(list of the supported <network>s for <id>),(list of the supported <audio> values for <id>)[,…​]]

OK

+UUSBCONF: (0 ("6 CDC-ACM"),(""),()),(2 ("NETWORK, 3 CDC-ACM"),("ECM"),()),(3 ("NETWORK, 1 CDC-ACM"),("RNDIS"),())

OK

Defined values

ParameterTypeDescription

<id>

Number

USB product category number; see Notes for the allowed values and their detailed description.

<network>

String

USB network function:

  • "AUTO": network autodetection

  • "ECM": CDC-ECM device class

  • "NCM": CDC-NCM device class

  • "MBIM": MBIM device class

  • "RNDIS": RNDIS device class

  • "RMNET": RMNET device class

Allowed values:

  • "RNDIS", "ECM"

<audio>

Number

Audio over USB function configuration:

  • 0: audio over USB disabled

  • 1: audio over USB enabled

<pid>

String

String in HEX format with 0x prefix, showing the identifier (PID) of the current profile.

Assigned range for PID is 0x1102-0x1FFF.

Notes

  • <network> value is only considered if the <id> category includes a network USB function.

  • <audio> value is only considered if the <id> category includes an audio over USB function.

  • When the <id> category does not include a network USB function or an audio over USB function, the information text response of the read command is an empty string and an empty value for <network> and <audio> respectively.

  • Table 15 lists the USB product category associated to a <id>.

    Table 15. USB product configuration
    <id>USB product category

    0

    Fairly back-compatible:

    It is a configuration similar to the one implemented in the u-blox LISA-U2 series, where only CDC-ACMs and, if present, a specific USB function for diagnostic log (e.g. CDC-DIAG) are available.

    1

    Fairly back-compatible plus audio:

    It is like the "Fairly back-compatible", but audio over USB function is available; audio over USB function can be enabled or disabled within the same PID.

    2

    Low/Medium throughput:

    It is a configuration including a Network USB function, a certain number of CDCs-ACM and, if present, a specific USB for the diagnostic log (e.g. CDC-DIAG). Audio over USB is available, but it can be enabled or disabled.

    The presence of several USB functions limits the reachable data transfer throughput.

    3

    High throughput:

    It is like the "Low/Medium throughput", but only 1 CDC-ACM is available. High throughput data rate can be reached only if the audio over USB function is disabled.

    4

    High throughput with ethernet over USB:

    It is a configuration including a Network USB function, a certain number of CDCs-ACM and, if present, a specific USB for the diagnostic log (e.g. CDC-DIAG).

    The presence of several USB functions does not limit the reachable data transfer throughput.

    12

    Low/Medium throughput plus SAP:

    It is a configuration including a Network USB function, a certain number of CDCs-ACM and, if present, a specific USB for the diagnostic log (e.g. CDC-DIAG). SAP over USB is available on the first CDC-ACM, but it can be enabled or disabled.

    The presence of several USB functions limits the reachable data transfer throughput.

    13

    High throughput plus SAP:

    It is like the "High throughput", but only 1 CDC-ACM dedicated to SAP communication.

    AT commands can be issued only over the UART interface.

    99

    USB disabled:

    USB stack if fully disabled and there is no USB enumeration.

    AT commands can be issued only over the UART interface.

  • The allowed USB configurations are listed as follows:

    Table 16. Supported USB functions
    CommandPIDAvailable USB functionsRemark

    AT+UUSBCONF=0

    0x1301

    1 DIAG + 2 CDC-ACM

    Default and factory-programmed value

    AT+UUSBCONF=4,"RNDIS"

    0x1302

    RNDIS + 1 DIAG + 2 CDC-ACM

    AT+UUSBCONF=4,"ECM"

    0x1303

    CDC-ECM + 1 DIAG + 2 CDC-ACM

    AT+UUSBCONF=99

    -

    None

    USB stack fully disabled

  • Note: AT+UUSBCONF=99 can be issued only from UART interface.

USB sleep configuration +UUSBSLPCONF

+UUSBSLPCONF

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

Full

No

NVM

No

-

+CME Error

Description

Configures the USB capability to allow module to enter deep-sleep modes. For further details about entering deep-sleep modes, see the system integration manual [54]:

  • When <usb_allow_sleep>=0, the USB must be in suspended state to allow the module to enter deep-sleep mode and the deep-sleep mode is limited to Sleep-1, see the +UPSV AT command.

  • When <usb_allow_sleep>=0, the USB remains enumerated during the module deep-sleep mode and it can be used by host to wake up module.

  • When <usb_allow_sleep>=1, the module can enter deep-sleep regardless of USB state. USB is powered off during deep-sleep mode and the host detects a USB disconnect. USB is re-enumerated at every wake-up.

  • When <usb_allow_sleep>=1, the module can reach the hibernate deep-sleep level, see the +UPSV AT command.

Syntax

TypeSyntaxResponseExample

Set

AT+UUSBSLPCONF=<usb_allow_sleep>

OK

AT+UUSBSLPCONF=1,5000

OK

Read

AT+UUSBSLPCONF?

+UUSBSLPCONF: <usb_allow_sleep>>

OK

+UUSBSLPCONF: 1,5000

OK

Test

AT+UUSBSLPCONF=?

+UUSBSLPCONF: (list of supported <usb_allow_sleep>s)

OK

+UUSBSLPCONF: (0-1)

OK

Defined values

ParameterTypeDescription

<usb_allow_sleep>

Number

It is possible to enter deep-sleep mode when USB is in active state (not suspended nor disconnected state):

  • 0 (factory-programmed value): deep-sleep mode can be entered only if USB is in suspended state.

  • 1: deep-sleep mode can be entered regardless of USB state.

UART baud rate and flow control NVM management +UUARTCONF

+UUARTCONF

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

-

+CME Error

Description

Stores the baud rate and flow control values to NVM (see the +IPR and &K AT commands) for the specified UART interface. The read command returns the NVM setting for all the available UART interfaces.

This command is intended to extend the possibility to have different stored values of +IPR and &K AT commands across the two UART interfaces.

Setting in NVM for AUX UART interface is applied at boot regardless of the +USIO configuration, that is AUX UART mode (AT, binary).

The settings are saved immediately in NVM; the new configuration will be effective at the subsequent module reboot.

Syntax

TypeSyntaxResponseExample

Set

AT+UUARTCONF=<uart_id>[,<rate>[,<fctrl>]]

OK

AT+UUARTCONF=1,115200,3

OK

Read

AT+UUARTCONF?

+UUARTCONF: <uart_id>,<rate>,<fctrl>

[[..]

+UUARTCONF: <uart_id>,<rate>,<fctrl>]

OK

+UUARTCONF: 0,115200,3

+UUARTCONF: 1,115200,3

OK

Test

AT+UUARTCONF=?

+UUARTCONF: (list of supported <uart_id>s),(list of fixed only supported <rate>s),(list of supported <fctrl>s)

OK

+UUARTCONF: 1,(300,600,1200,2400,4800,9600,14400,19200,38400,57600,115200,230400,460800,921600,1000000,1200000,1500000,2000000,3000000),(0-3)

OK

Defined values

ParameterTypeDescription

<uart_id>

Number

UART identification code:

  • 0: main UART identification code

  • 1: auxiliary UART identification code

Allowed values:

  • 0, 1

<rate>

Number

Allowed baud rates expressed in b/s:

  • 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 (default and factory-programmed value), 230400, 460800, 921600, 3000000

<fctrl>

Number

DTE flow control mode (see the &K AT command):

  • 0: disable DTE flow control

  • 3 (default and factory-programmed value): enable the RTS/CTS DTE flow control

Multiplexer protocol deep-sleep mode configuration +UDCONF=201

+UDCONF=201

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

Configures whether the module can enter a deep-sleep mode deeper than Sleep-1 during a multiplexer protocol session (started with +CMUX AT command).

The command is effective only if power saving is enabled (see +UPSV AT command), and no other conditions block the entering into power saving.

The command must be issued before starting a multiplexer session to be effective.

Syntax

TypeSyntaxResponseExample

Set

AT+UDCONF=201,<allow_sleep2>

OK

AT+UDCONF=201,0

OK

Read

AT+UDCONF=201

+UDCONF: 201,<allow_sleep2>

OK

+UDCONF: 201,0

OK

Defined values

ParameterTypeDescription

<allow_sleep2>

Number

Allow Sleep-2 mode during a MUX session. Allowed values:

  • 0 (default value): Sleep-2 or deeper mode is not allowed

  • 1: Sleep-2 or deeper mode is allowed

Notes

  • In case <allow_sleep2> value is set to 1, the multiplexer session is lost when Sleep-2 (or Hibernate) mode is entered. Hence, the multiplexer session must be re-established by the host, at sleep exit.

  • Each multiplexer DLC / virtual channel could impose more restricted conditions to module power saving entering, as it happens in case of UART interface (e.g. PPP dial-up over UART or over a multiplexer DLC limits the allowed deep-sleep mode to Sleep-1).

  • The command configuration is not persistent and hence the command has to be re-issued in case of module reboot or if a deep-sleep level deeper than Sleep-1 is entered.

  • In case the module is configured for entering PSM or eDRX deep-sleep mode with the lowest power consumption, and multiplexer protocol is used, use <allow_sleep2> value 1.

Multiplexer protocol LEXI-R10801D-00B compatibility mode +UDCONF=202

+UDCONF=202

Modules

LEXI-R10801D-01B LEXI-R10401D

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

On LEXI-R10801D-00B, the MUX protocol commands SABM, DISC and CLD with DLC > 0 are replied with another SABM, DISC or CLD request instead of a UA with F bit set reply. +UDCONF=202 allows a backward compatibility between LEXI-R10801D-00B and more recent versions and configures whether the module uses standard MUX protocol or LEXI-R10801D-00B compatibility mode during a multiplexer session (started with +CMUX AT command).

The command must be issued before starting a multiplexer session to be effective.

Syntax

TypeSyntaxResponseExample

Set

AT+UDCONF=202,<enable_compatibility_mode>

OK

AT+UDCONF=202,0

OK

Read

AT+UDCONF=202

+UDCONF: 202,<enable_compatibility_mode>

OK

+UDCONF: 202,0

OK

Defined values

ParameterTypeDescription

<enable_compatibility_mode>

Number

Enable LEXI-R10801D-00B protocol compatibility mode during a MUX session. Allowed values:

  • 0 (default value): standard MUX protocol

  • 1: LEXI-R10801D-00B MUX protocol compatibility mode

Serial interfaces configuration selection +USIO

+USIO

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

-

+CME Error

Description

Selects the serial interfaces' configuration.

The configuration affects how an available (either physical or logical) serial interface is used, i.e. the meaning of the data flowing over it. Possible usages are:

  • Modem interface (AT command)

  • Trace interface (diagnostic log)

  • Raw interface (e.g. GPS/GNSS tunneling or SAP)

  • Digital audio interface

  • None

A set of configurations, that considers all the available serial interfaces' and their associated usage, is called +USIO’s configuration variant.

The serial interfaces' configuration switch is not performed at run-time. The settings are saved in NVM; the new configuration will be effective at the subsequent module reboot.

A serial interface might not support all the usages. For instance, UART cannot be used as digital audio interface.

For the complete list of allowed USIO variants supported by each series modules, see Notes.

Syntax

TypeSyntaxResponseExample

Set

AT+USIO=<requested_variant>

OK

AT+USIO=1

OK

Read

AT+USIO?

+USIO: <requested_variant>, *<active_variant>

OK

+USIO: 1, *1

OK

Test

AT+USIO=?

+USIO: Variant=<requested_variant>: [AT=<AT_interface>;][GNSS=<GNSS_interface>;][TRACE=<Trace_interface>;][DIGITAL AUDIO=<Digital_audio_interface>]

[+USIO: Variant=<requested_variant>: [AT=<AT_interface>;][GNSS=<GNSS_interface>;][TRACE=<Trace_interface>;][DIGITAL AUDIO=<Digital_audio_interface>]

[…​]]

OK

+USIO: Variant=0: AT="UART"; AT="AUX UART"; TRACE="EXT UART"

+USIO: Variant=1: AT="UART"; TRACE="AUX UART"; DIGITAL AUDIO="I2S"

+USIO: Variant=2: AT="UART"; AT="AUX UART"; DIGITAL AUDIO="I2S"

+USIO: Variant=3: AT="UART"; GNSS="AUX UART"; TRACE="EXT UART"

+USIO: Variant=4: AT="UART"; GNSS="AUX UART"; DIGITAL AUDIO="I2S"

OK

Defined values

ParameterTypeDescription

<requested_variant>

Number

  • 0 (default value and factory-programmed value), 1, 5.

<active_variant>

Number

Active (currently used) configuration variant (range 0-255). For the factory-programmed value, see the value in supported USIO variants table in Notes.

<AT_interface>

String

Serial interface configured for AT commands

<GNSS_interface>

String

Serial interface configured for GNSS tunneling

<Trace_interface>

String

Serial interface configured for diagnostic log

<Digital_audio_interface>

String

Serial interface configured for digital audio

Notes

  • Table 17 explains the meaning of <AT_interface>, <GNSS_interface>, <Trace_interface>, <Digital_audio_interface>.

    Table 17. Serial interfaces
    <AT_interface>, <GNSS_interface>, <Trace_interface>, <Digital_audio_interface>Serial interface description

    "UART"

    Main UART:

    It is the full featured UART (9-wire), used as main interface to the host.

    "AUX UART"

    Auxiliary UART:

    It is the general purpose UART (3-wire or 5-wire), with limited v.24 features.

    "EXT UART"

    External UART:

    It is not a real UART, but the SPI interface is used to communicate with an external chip providing SPI to UART conversion. Basically, it is limited to diagnostic log.

    "USB"

    USB CDC-ACM or Network over USB:

    USB CDC-ACM is a virtual UART, providing simulated v.24 features over a USB interface.

    Network over USB is a virtual network interface providing diagnostic logging.

    "I2S"

    I2S interface

    "SPI"

    SPI interface:

    It is limited to diagnostic log.

    "SDIO"

    SDIO interface:

    It is limited to diagnostic log.

  • The allowed configurations are listed as follows:

    Table 18. Supported USIO variants
    <active_variant>AT instance 1AT instance 2AT instance 3AT instance 4Diagnostic log

    0 (factory-programmed value)

    UART (9-wire)

    USB2

    USB3

    Not available

    USB1

    1

    UART (5-wire)

    USB2

    USB3

    AUX UART (5-wire)

    USB1

    5

    UART (5-wire)

    USB2

    USB3

    Not available

    AUX UART (3-wire) or USB1

  • It is possible to route diagnostic log on AUX UART only when <active_variant> is 5 while it is always possible to have diagnostic log on USB port. In any case to enable diagnostic log on USB or AUX UART, it is necessary to use +TRACE AT command; for more details, see the +TRACE AT command.

  • Whenever the +USIO configuration is changed and a reboot is performed, the MUX channels profiles become invalid and shall be restored: when the MUX protocol is established, AT&F followed by the optional custom MUX channel configuration and by AT&W AT command shall be issued on each MUX channel.

Internal temperature monitor +UTEMP

+UTEMP

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

partial

No

No

No

-

+CME Error

Description

Returns the values of internal temperature sensors of the specified unit.

The command handling (sensors position and command syntax) depends on the module series:

  • The AT command returns the value measured by the temperature sensor on the Die.

Syntax

TypeSyntaxResponseExample

Set

AT+UTEMP=<unit>

OK

AT+UTEMP=0

OK

Read

AT+UTEMP?

+UTEMP: <die_temp>[,<unit>]

OK

+UTEMP: 100,1

OK

Test

AT+UTEMP=?

+UTEMP: (list of supported <unit>)

OK

+UTEMP: (0-1)

OK

Defined values

ParameterTypeDescription

<unit>

Number

Select the measurement unit for value representation:

  • 0 (default value): values in tenth of Celsius degrees returned

  • 1: values in tenth of Fahrenheit degrees returned

<die_temp>

Number

Fetched value of Die temperature of the selected measurement unit; the allowed range, expressed in tenth of degrees, depends on the measurement unit:

  • LEXI-R10 / SARA-R10

    • Celsius degrees: [-400; 850]

    • Fahrenheit degrees: [-400; 1850]

Restore factory configuration +UFACTORY

+UFACTORY

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

5 s

+CME Error

Description

Force, at the next module boot, the restore of the factory configuration for FS and/or NVM.

When the command is issued, a flag is written into the NVM: no action is done and it will be triggered to be executed only at the next module boot. If, before the next boot, the triggered operation must be deleted, then it is possible to issue the command with parameter 0,0.

Syntax

TypeSyntaxResponseExample

Set

AT+UFACTORY=<fs_op>,<nvm_op>

OK

AT+UFACTORY=0,1

OK

Read

AT+UFACTORY?

+UFACTORY: <fs_op>,<nvm_op>

OK

+UFACTORY: 0,1

OK

Test

AT+UFACTORY=?

+UFACTORY: (list of supported <fs_op>s),(list of supported <nvm_op>s)

OK

+UFACTORY: (0-2),(0-2)

OK

Defined values

ParameterTypeDescription

<fs_op>

Number

FS factory restore type:

  • 0 (factory-programmed value): no factory restore

  • 1: see Notes

  • 2: all files stored in FS deleted

<nvm_op>

Number

NVM factory restore type:

  • 0 (factory-programmed value): no factory restore

  • 1: NVM flash sectors erased

  • 2: see Notes

Notes

  • <fs_op>=1 deletes all user files and certificates previously downloaded through AT+FWRITE or AT+FWRITEHEX.

  • <fs_op>=2 is identical to <fs_op>=0: no factory restore.

  • <nvm_op>=1 deletes all MNO profiles and all settings, except UART and USB interface configuration.

  • <nvm_op>=2 restores the UART and USB interface to the factory-programmed setting, limited to +USIO, +IPR, +IFC, +ICF, &K, /Q, +UUARTCONF, +UUSBCONF, +UUSBSLPCONF and +UPSV.

  • Restore, if armed, will be triggered at following power down (AT+CPWROFF) or reset (+CFUN AT command), not at the next reboot. Moreover +UFACTORY parameters are volatile, this means that if power is removed no action will be taken.

NVM RAM mode management +UNVMCFG

+UNVMCFG

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

-

+CME Error

Description

Executes the following tasks:

  • Sets the NVM RAM mode for AT command settings stored in NVM.

  • Lists the AT commands whose settings can be stored on NVM and/or in the NVM backup partition.

  • Configures the unsolicited output when an NVM corruption is detected.

Some classes do not support mode change.

AT command settings are stored as UNVM items and are grouped in AT groups. Changing the NVM RAM mode for an AT group will change the behaviour for all AT command settings in that group. The NVM RAM mode is not supported for the UNVM items storable on the NVM backup.

Based on the configured NVM RAM mode the behaviour of UNVM items within an AT group is as follows:

  • RAM mode:

    • Changing the AT command settings changes only the RAM mirror (NVM is intact).

    • +UNVMW commits the AT command settings from RAM mirror to NVM.

    • +UNVMR resets the AT command settings RAM mirror to the setting stored in NVM.

    • +UNVMF works the same in both modes - restores the NVM to factory with deleting the NVM.

  • NVM mode:

    • Changing the AT command settings changes the NVM setting.

    • +UNVMW does nothing as setting is already in NVM.

    • +UNVMR does nothing as setting is coherent with NVM.

    • +UNVMF works the same in both modes - restores the NVM to factory with deleting the NVM.

RAM mode is useful for customer devices not requiring NVM capabilities on u-blox module (example: audio settings are configured at each boot by the application processor).

The AT groups are product-specific.

Reboot the module in order to apply the new NVM RAM mode.

If the NVM Backup is supported, the following AT commands can be issued to manage also the backup storage:

  • +UNVMW commits the settings from NVM to the backup partition.

  • +UNVMR commits the settings from backup partition to NVM and RAM

  • +UNVMF restores the NVM and the backup partition to factory with deleting the NVM.

If a corruption of configuration stored in NVM is detected, the module will attempt to restore it. The restore is done either using a backup or factory-programmed settings. The restore will be indicated by an +UUNVM URC.

Syntax

TypeSyntaxResponseExample

Restore factory

Action

AT+UNVMCFG=

OK

AT+UNVMCFG=

OK

AT group management

Set

AT+UNVMCFG=<at_group>,<mode>

OK

AT+UNVMCFG="audio",1

OK

Read

AT+UNVMCFG=<at_group>

+UNVMCFG: <at_group>,<mode>

OK

AT+UNVMCFG="audio"

+UNVMCFG: "audio",1

OK

URC management

Set

Set setting

AT+UNVMCFG=<setting_name>,<setting_value>

OK

AT+UNVMCFG="urc",1

OK

Read

Read setting

AT+UNVMCFG=<setting_name>

+UNVMCFG: <setting_name>,<setting_value>

OK

AT+UNVMCFG="urc"

+UNVMCFG: "urc",0

OK

Generic syntax

URC

+UUNVM: <id>[,<item_name>]

+UUNVM: 0,"item"

NVM item corrupted

URC

+UUNVM: <id>,<item_name>

+UUNVM: 1,"item"

NVM backup corrupted

URC

+UUNVM: 2

+UUNVM: 2

Test

AT+UNVMCFG=?

+UNVMCFG:(list of supported <at_group>es),(list of commands in the at_group)

OK

+UNVMCFG: "generic","+udconf134"

+UNVMCFG: "gnss","+ugsrv"

+UNVMCFG: "aonnvm","+udcf101,+ugpio,trace,+upsv"

+UNVMCFG: "aonnvmbckp","+usio,#CMUX2,#CMUX1,#CMUX0,#USB3,#USB2,#USB1,#USB0,#UART2,#UART1,#UART0"

OK

Defined values

ParameterTypeDescription

<at_group>

String

AT group:

  • "audio"; the group has factory-programmed value 0 for <mode> parameter.

  • "generic"; the group has factory-programmed value 0 for <mode> parameter.

  • "gnss"; the group has factory-programmed value 0 for <mode> parameter.

  • "aonnvm"; the group has factory-programmed value 0 and cannot be changed.

  • "aonnvmbckp"; the group has factory-programmed value 0 and cannot be changed.

Allowed groups:

  • "generic", "gnss", "aonnvm", "aonnvmbckp"

<mode>

Number

Mode. Allowed values:

  • 0: NVM mode

  • 1: RAM mode

  • 2: reserved

<setting_name>

String

Setting name:

  • "urc"; the URC configuration has factory-programmed value 0 for <setting_value> parameter.

<setting_value>

Number

Setting value. Allowed values for "urc":

  • 0: URCs disabled

  • 1: URCs enabled

<id>

Number

Event type. Allowed values:

  • 0: item restored from backup

  • 1: item restored from factory setting

  • 2: backup was corrupt and consequently deleted

  • 3: reserved

  • 4: raw class item is corrupt

<item_name>

String

Item name for which the event occurred.

Notes

  • <at_group>="aonnvm" and <at_group>="aonnvmbckp" appear in the information text response to the test command. They do not support the RAM NVM mode.

NVM/NVM Backup configuration management commit+UNVMW

+UNVMW

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

Commits RAM configuration changes to NVM or commits NVM configuration changes to NVM backup. The operation done by this command depends on the selected AT group.

The commitment from RAM to NVM has no effect in the NVM operating mode. See +UDCONF=110 or +UNVMCFG for details about the configuration of the mode of operation. In particular for:

Syntax

TypeSyntaxResponseExample

Generic syntax

Set

AT+UNVMW=<at_group>

OK

AT+UNVMW="audio"

OK

Test

AT+UNVMW=?

+UNVMW: (list of supported <at_group>s)

OK

+UNVMW: ("audio","generic","gnss","mqtt","ram_at","nvm_at","nvmbckp_at")

OK

Defined values

ParameterTypeDescription

<at_group>

String

AT group:

  • "audio": audio configuration. The command commits RAM configuration changes to NVM.

  • "generic": generic configuration. The command commits RAM configuration changes to NVM.

  • "gnss": GNSS configuration. The command commits RAM configuration changes to NVM.

  • "mqtt": UNUSED, reserved.

  • "ram_at": UNUSED, reserved.

  • "nvm_at": UNUSED, reserved.

  • "nvmbckp_at": UNUSED, reserved.

  • "aon": UNUSED, reserved.

  • "aonnvm": configuration storable in the NVM file system and cached in always-on RAM.

  • "aonnvmbckp": configuration storable in the NVM backup and cached in always-on RAM. The command commits NVM configuration changes to NVM backup.

Allowed groups:

  • "generic", "gnss", "aonnvm", "aonnvmbckp"

Notes

  • Some <at_group>s do not contain items and will consequently can

NVM configuration management reset +UNVMR

+UNVMR

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

Resets RAM configuration from NVM and applies it or resets RAM and NVM configuration from NVM backup and applies it. The operation done by this command depends on the selected AT group.

The reset of RAM configuration from NVM has no effect in the NVM operating mode. See +UDCONF=110 or +UNVMCFG for details about the configuration of the mode of operation. In particular for:

Syntax

TypeSyntaxResponseExample

Generic syntax

Set

AT+UNVMR=<at_group>

OK

AT+UNVMR="audio"

OK

Test

AT+UNVMR=?

+UNVMR: (list of supported <at_group>s)

OK

+UNVMR: ("audio","nvmbckp")

OK

Defined values

ParameterTypeDescription

<at_group>

String

AT group:

  • "audio": audio configuration. The command resets RAM configuration from NVM.

  • "nvmbckp": configuration storable in the NVM backup. The command resets NVM and RAM configuration from NVM backup.

  • "aonnvmbckp": configuration storable in the NVM backup and cached in always-on RAM. The command resets NVM and RAM configuration from NVM backup.

Allowed groups:

  • "aonnvmbckp"

NVM configuration management factory restore +UNVMF

+UNVMF

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

Restores the factory-programmed configuration.

Reboot the module to apply the new configuration.

Syntax

TypeSyntaxResponseExample

Generic syntax

Set

AT+UNVMF=<at_group>

OK

AT+UNVMF="audio"

OK

Test

AT+UNVMF=?

+UNVMF: (list of supported <at_group>s)

OK

+UNVMF: ("audio","generic","gnss","nvmbckp")

OK

Defined values

ParameterTypeDescription

<at_group>

String

AT group:

  • "audio": audio configuration. The command commits RAM configuration changes to NVM.

  • "generic": generic configuration. The command commits RAM configuration changes to NVM.

  • "gnss": GNSS configuration. The command commits RAM configuration changes to NVM.

  • "mqtt": UNUSED, reserved for MQTT configuration.

  • "ram_at": UNUSED, reserved.

  • "nvm_at": UNUSED, reserved.

  • "nvmbckp_at": UNUSED, reserved.

  • "aon": UNUSED, reserved.

  • "aonnvm": configuration storable in the NVM file system and cached in always-on RAM.

  • "aonnvmbckp": configuration storable in the NVM backup and cached in always-on RAM. The command commits NVM configuration changes to NVM backup.

Allowed groups:

  • "generic", "gnss", "aonnvm", "aonnvmbckp"

Configure AT layer +UDCONF=134

+UDCONF=134

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

-

+CME Error

Description

Configures the platform AT layer.

List of settings:

  • <op_code>=0 - configure the default timeout value for the AT command timer. If a command-specific value is greater than this default, it will be used; otherwise, the default value will apply.

  • <op_code>=1 - reserved

The configuration is stored in NVM and is persistent after the module reboot.

Syntax

TypeSyntaxResponseExample

Set

AT+UDCONF=134,<op_code>,<val>

OK

AT+UDCONF=134,0,5

OK

Read

AT+UDCONF=134[,<op_code>]

+UDCONF=134,<op_code>,<val>

OK

+UDCONF=134,0,10

OK

Defined values

ParameterTypeDescription

<op_code>

Number

Operations:

  • 0: set AT command timer timeout value

  • 1: reserved

0: set AT command timer timeout value

<val>

Number

Configures the AT command timer timeout in seconds. The range goes from 0 to 65535 (factory-programmed value is 10).

Sets FOTA status URCs +UFOTASTAT

+UFOTASTAT

Modules

LEXI-R10401D

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

NVM

No

65

+CME Error

Description

Enables URC reporting status for FOTA downloads and updates.

Syntax

TypeSyntaxResponseExample

Set

AT+UFOTASTAT=<n>

OK

AT+UFOTASTAT=1

OK

Read

AT+UFOTASTAT?

+UFOTASTAT: <n>

OK

+UFOTASTAT: 1

OK

Test

AT+UFOTASTAT=?

+UFOTASTAT: (list of supported<n>s)

OK

+UFOTASTAT: (0,1)

OK

Generic syntax

URC

+UFOTASTAT: <event>,<param1>[,<param2>]

OK

+UFOTASTAT: 3,1,0

OK

Download progress

URC

+UFOTASTAT: 0,<progress_status>[,<percentage>]

OK

+UFOTASTAT: 0,1,10

OK

Download start

URC

+UFOTASTAT: 1,<start_triggered>,<retry_attempt>

OK

+UFOTASTAT: 1,0,0

OK

Download complete

URC

+UFOTASTAT: 2,<status>,<status_details>

OK

+UFOTASTAT: 2,2,100

OK

FOTA status

URC

+UFOTASTAT: 3,<update_result>,<update_state>

OK

+UFOTASTAT: 3,1,0

OK

Registration status

URC

+UFOTASTAT: 4,<registration_result>

OK

+UFOTASTAT: 4,2

OK

Defined values

ParameterTypeDescription

<n>

Number

Enable FOTA status URCs:

  • 0: FOTA status URC disabled

  • 1: FOTA status +UFOTASTAT URC enabled

The factory-programmed value is:

  • LEXI-R10401D-00B - 0

<event>

Number

Event type:

  • 0: download progress

  • 1: download start

  • 2: download complete

  • 3: FOTA status

  • 4: registration status

Allowed values:

  • LEXI-R10401D-00B - 0, 1, 2, 3

<progress_status>

Number

Provides the download status:

  • 1: download in progress

  • 2: download in pause

  • 3: download is waiting for user ack/reject. See +UFOTAACK AT command

Allowed values:

  • LEXI-R10401D-00B - 1

<percentage>

Number

Download completion in percentage

<start_triggered>

Number

Allowed value:

  • 0: download start triggered

<retry_attempt>

Number

Download attempt currently performed:

  • 0: initial attempt

  • 1: first retry attempt

  • 2: second retry attempt

  • 3: third retry attempt

  • 4: fourth retry attempt

Allowed values:

  • LEXI-R10401D-00B - 0, 1, 2, 3, 4

<status>

Number

FOTA completed download status:

  • 2: success

  • 3: fail

<status_details>

Number

Provides more information about FOTA completed download status:

  • 100: success if <status>=2

  • 100: user cancel if <status>=3

  • 101: memory error. This value can be returned only when <status>=3

  • 102: network error. This value can be returned only when <status>=3

  • 103: unknown error.This value can be returned only when <status>=3

  • 104: bad URL.This value can be returned only when <status>=3

  • 105: failure due to connectivity loss.This value can be returned only when <status>=3

Allowed values:

  • LEXI-R10401D-00B - 100, 101, 102, 103, 104

<update_result>

Number

Provides more information about FOTA update result:

  • 0: initial

  • 1: success

  • 2: memory error

  • 3: RAM error

  • 4: connection lost

  • 5: checksum error

  • 6: unsupported package

  • 7: URI error

  • 8: firmware update fail

  • 9: unsupported protocol

<update_state>

Number

Provides more information about FOTA update status:

  • 0: idle

  • 1: downloading

  • 2: downloaded

  • 3: updating

Allowed values:

  • LEXI-R10401D-00B - 0, 1, 2

<registration_result>

Number

Provides more information about registration status:

  • 0: idle

  • 1: bootstrap started

  • 2: bootstrap successful

  • 3: bootstrap failed

  • 4: connect successful

  • 5: connect failed

  • 6: registration successful

  • 7: registration failed

  • 8: registration timeout

  • 9: client life time timeout

  • 10: client halted

  • 11: update successful

  • 12: update failed

  • 13: update timeout

  • 14: response failed

  • 15: notify failed

  • 16: deregistration successful

  • 17: deregistration failed

<param1>

Number

Contains additional information depending on <event> value.

<param2>

Number

Contains additional information depending on <event> and <param1> values.

Firmware update Over AT (FOAT) +NFWUPD

+NFWUPD

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

FW install error

+CME Error

Description

Triggers the firmware update over the AT command interface. The AT command allows the FW package download, validation and installation. The FW package is a binary (.bin) file provided by u-blox.

  • Initialize the system to accept a new FW package (AT+NFWUPD=<cmd>=0).

  • Download the FW package file by means of the package segment download command (AT+NFWUPD=1,<sn>,<len>,<data>,<crc>). If the file size exceeds 1024 bytes then the download command can be issued several times.

  • Validate the FW package file by means of the AT+NFWUPD=<cmd>=2. The validation cannot be aborted, hence do not issue any other command during the package validation.

  • If the validation succeeds, then issue the upgrade firmware command (AT+NFWUPD=<cmd>=5) to complete the FOAT process.

The FW update generally takes two minutes to complete the process. In case of failure during the FW update, the process will be rolled back and an error result code will be provided. At the end of upgrade process the module will be rebooted and the data stored in the NVM are set to the factory-programmed values of the new firmware version.

Syntax

TypeSyntaxResponseExample

Set

AT+NFWUPD=<cmd>[,<sn>,<len>,<data>,<crc>]

OK

AT+NFWUPD=1,0,8,ecdf224000000080,d1

OK

Test

AT+NFWUPD=?

+NFWUPD: (list of supported <cmd>s)

OK

+NFWUPD: (1-5)

OK

Defined values

ParameterTypeDescription

<cmd>

Number

Firmware package process command:

  • 0: initialize a new FW update session, erasing the update partition and resetting internal state.

  • 1: download a FW package segment. The <sn>,<len>,<data>,<crc> parameters are mandatory, <crc> is calculated by XOR8 each <data> byte

  • 2: package validation

  • 3: get the package name

  • 4: get the package version

  • 5: firmware upgrade

  • 6: download phase has to be intended as terminated

Allowed values:

  • 0, 1, 2, 3, 4, 5, 6

<sn>

Number

Sequence number for each package segment, starting with zero, maximum value is 65535

<len>

Number

Data length expressed in bytes, should be multiple of 4 (for the last segment add NULL byte padding, if needed). The maximum length is 1024 bytes, minimum value is 4

<data>

Number

Data to be transmitted, expressed in hexadecimal format, range of each octet is 0x00 - 0xFF, total number of octets is <len>

<crc>

Number

Simple XOR8 of the binary data, expressed as a single hexadecimal byte value with range 0x00 - 0xFF

<length>

Number

Number of bytes to be written in binary mode.

<timeout>

Number

Waiting time from last received data, expressed in seconds. Default value is 1, no limit.

URC reporting behavior configuration +UURCCFG

+UURCCFG

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

No

No

-

+CME Error

Description

Configures the caching and presentation deferring behavior for the URCs on a specific AT terminal.

Syntax

TypeSyntaxResponseExample

Set

AT+UURCCFG=<config_item>,<enable>

OK

AT+UURCCFG=0,1

OK

Read

AT+UURCCFG?

+UURCCFG: 0,<enable>

+UURCCFG: 1,<enable>

OK

+UURCCFG: 0,0

+UURCCFG: 1,1

OK

Test

AT+UURCCFG=?

+UURCCFG: (list of the supported <config_item> values),(list of the supported <enable> values)

OK

+UURCCFG: (0-1),(0-1)

OK

Defined values

ParameterTypeDescription

<config_item>

Number

URC reporting behavior:

  • 0: URC caching. When enabled, all URCs will be cached, up to a maximum of 16 on the terminal. When disabled, the last 16 cached URCs will be displayed.

  • 1: URCs presentation deferring. When enabled, all URCs will be buffered during the execution of other AT commands on the AT terminal. When disabled, URCs can be displayed in between other AT commands execution.

<enable>

Number

Allowed values:

  • 0: Disable (factory-programmed value of <config_item> = 0)

  • 1: Enable (factory-programmed value of <config_item> = 1)

Notes

  • The <config_item> = 0 command setting is not saved in the NVM.

Enable/disable URCs reporting +UURCSTAT

+UURCSTAT

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

full

No

Profile

No

-

+CME Error

Description

Allows to enable/disable simultaneously different URCs based on the given URC set.

Syntax

TypeSyntaxResponseExample

Set

AT+UURCSTAT=<urc_set>,<reporting>

OK

AT+UURCSTAT="all",1

OK

Read

AT+UURCSTAT?

+UURCSTAT: "CREG":<reporting>,"CEREG":<reporting>,"CEDRXP":<reporting>,"CSCON":<reporting>,"CTZEU":<reporting>,"UCESQ":<reporting>,"CGEV":<reporting>,"UPSMR":<reporting>,"UUSIMSTAT":<reporting>,"UUBIP":<reporting>,"UPDPADDR":<reporting>,"UPCFUN":<reporting>,"USMSFULL":<reporting>,"CNEC":<reporting>

OK

+UURCSTAT: "CREG":1,"CEREG":1,"CEDRXP":1,"CSCON":1,"CTZEU":1,"UCESQ":1,"CGEV":1,"UPSMR":1,"UUSIMSTAT":1,"UUBIP":1,"UPDPADDR":1,"UPCFUN":1,"USMSFULL":1,"CNEC":1

OK

Test

AT+UURCSTAT=?

+UURCSTAT:(list of supported <urc_set>s)

OK

+UURCSTAT: "ALL":(0-1),"DEVICE_STATUS":(0-1),"NETWORK":(0-1),"BOOT_AND_WARN":(0-1),"CREG":(0-1),"CEREG":(0-1),"CEDRXP":(0-1),"CSCON":(0-1),"CTZEU":(0-1),"UCESQ":(0-1),"CGEV":(0-1),"UPSMR":(0-1),"UUSIMSTAT":(0-1),"UUBIP":(0-1),"UPDPADDR":(0-1),"UPCFUN":(0-1),"USMSFULL":(0-1),"CNEC":(0-1)

OK

Defined values

ParameterTypeDescription

<urc_set>

String

Command options:

  • "ALL": all URCs reported by the read command (+CREG, +CEREG, +CEDRXP, +CSCON, +CTZEU, +UCESQ, +CGEV, +UUPSMR, +UUSIMSTAT, +UUBIP, +UPDPADDR, +USMSFULL, +CNEC)

  • "DEVICE_STATUS": device status URCs (+CREG, +CEREG, +CEDRXP, +CSCON, +CTZEU, +CGEV, +UUPSMR, +UUSIMSTAT, +UUBIP, +UPDPADDR, +USMSFULL, +CNEC)

  • "NETWORK": network related URCs (+CREG, +CEREG, +CEDRXP, +CSCON, +CGEV, +UUPSMR, +UPDPADDR, +CNEC)

  • "BOOT_AND_WARN": boot and warning related URCs (+UUSIMSTAT, +UPCFUN, +USMSFULL)

  • "CREG": see +CREG URC

  • "CEREG": see +CEREG URC

  • "CEDRXP": see +CEDRXP URC

  • "CSCON": see +CSCON URC

  • "CTZEU": see +CTZEU URC

  • "UCESQ": see +UCESQ URC

  • "CGEV": see +CGEV URC

  • "UPSMR": see +UPSMR AT command

  • "UUSIMSTAT": see +UUSIMSTAT URC

  • "UUBIP": see +UUBIP URC

  • "UPDPADDR": reports +UPDPADDR: <cid>[,<PDP_addr_1>[,<PDP_addr_2>]] URC. If enabled, the URC is issued each time a PDP context is activated, reporting the related <cid> and PDP addresses. This URC has not a dedicated command and can only be enabled/disabled through +UURCSTATUS command.

  • "UPCFUN": reports +UPCFUN: <fun> URC at boot. If enabled, the URC shows the module functionality status at boot (See +CFUN AT command read). This URC has not a dedicated command and can only be enabled/disabled through +UURCSTATUS command.

  • "USMSFULL": reports +USMSFULL: <mem> URC. If enabled, the URC is issued when the SMS used to store memory is full, reporting also which memory type is used. This URC has not a dedicated command and can only be enabled/disabled through +UURCSTATUS command.

  • "CNEC": see +CNEC URC

<reporting>

Number

Enable/disable URC reporting

  • 0: URC reporting disabled

  • 1: URC reporting enabled

<cid>

Number

See <cid>.

<PDP_addr_1>

String

IPV4 or IPV6 PDP address.

<PDP_addr_2>

String

Reports IPV6 PDP address when both IPV4 and IPV6 addresses are assigned.

<fun>

Number

See <fun> parameter.

<mem>

String

See memory types defined in +CPMS AT command.

Maximum RF power customization +UMAXPWR

+UMAXPWR

Modules

All products

Attributes

Syntax

PIN required

Settings saved

Can be aborted

Response time

Error reference

partial

No

No

No

-

+CME Error

Description

Modifies the module’s maximum output power during any voice or data call in all GSM/GPRS and/or UMTS/HSPA and/or LTE radio access modes.

The command allows user to decrease the value of the maximum transmitted power with respect to the factory-programmed nominal value in the radio access technology supported:

  • The power customization is set in steps of 1 dB.

In the set command at least a parameter must be issued.

See the corresponding module data sheet for the list of bands supported by the product.

Use of this AT command is the responsibility of the user, since a change in the maximum Tx power can violate 3GPP specifications and affect the UE behavior both in real networks and during the certification process. See 3GPP TS 45.005 [55], 3GPP TS 51.010-1 [56], 3GPP TS 25.101 [57], 3GPP TS 34.121-1 [28] and FCC online documentation for further information.

u-blox assumes no responsibility for the inappropriate use of the +UMAXPWR AT command.

Syntax

TypeSyntaxResponseExample

Set

AT+UMAXPWR=[<3G_pwr_red>][,[<2G_pwr_red_850>],[<2G_pwr_red_900>],[<2G_pwr_red_1800>],[<2G_pwr_red_1900>][,<4G_pwr_red>[,[<bitmask1>][,<bitmask2>]]]]

OK

AT+UMAXPWR=13

OK

AT+UMAXPWR=,40,40,0,0

OK

Read

AT+UMAXPWR?

+UMAXPWR: <3G_pwr_red>,<2G_pwr_red_850>,<2G_pwr_red_900>,<2G_pwr_red_1800>,<2G_pwr_red_1900>[,<4G_pwr_red>][,<bitmask1>,<bitmask2>]

OK

+UMAXPWR: 0,0,0,0,0

OK

+UMAXPWR: 16,16,16,16,16

OK

Test

AT+UMAXPWR=?

+UMAXPWR: (list of supported <3G_pwr_red>s),(list of supported <2G_pwr_red_850>s),(list of supported <2G_pwr_red_900>s),(list of supported <2G_pwr_red_1800>s),(list of supported <2G_pwr_red_1900>s)[,(list of supported <4G_pwr_red>s)][,(list of supported <bitmask1>s),(list of supported <bitmask2>s)]

OK

+UMAXPWR: (0-32),(0-48),(0-48),(0-48),(0-48),(0-32),(1-0xffffffff),(1-0x000007ff)

OK

Defined values

ParameterTypeDescription

<3G_pwr_red>

Number

UMTS/HSPA power reduction. The parameter meaning depends on the product: see Notes for the specific parameter explanation.

<2G_pwr_red_850>,<2G_pwr_red_900>,<2G_pwr_red_1800>,<2G_pwr_red_1900>

Number

GSM/GPRS power customization, for the specific frequency band. The maximum reduction is 6 dB. The parameter meaning depends on the product: see Notes for the specific parameter explanation.

<4G_pwr_red>

Number

LTE power reduction. The parameter meaning depends on the product: see Notes for the specific parameter explanation.

<bitmask1>,<bitmask2>

Number

Indicated the bandmask for LTE band. The parameter meaning depends on the product: see Notes for the specific parameter explanation.

Notes

  • The <3G_pwr_red> parameter has no impact on modules that do not support UMTS/HSPA radio access technology: the parameter is ignored and it can be left empty.

  • The <2G_pwr_red_850>, <2G_pwr_red_900>, <2G_pwr_red_1800>, <2G_pwr_red_1900> parameters have no impact on modules that do not support related GSM/GPRS bands: related parameter is ignored and it can be left empty.

  • <4G_pwr_red> parameters meaning:

    • The range goes from 0 to 12: the power reduction is calculated as <4G_pwr_red> dB. The range of the reduce maximum power limit is [0:12] dB.

    • Missing parameter is not allowed.

    • 0 (factory-programmed value): reset to the factory-programmed maximum Tx power; no power modification.

  • The <bitmask1> and <bitmask2> parameters are not supported.

  • The command setting is stored in the NVM and will be applied at the next module boot.

  • The command setting doesn’t persist after updating the FW version via EasyFlash.

Last updated: Jan 13, 2025
Need help?Contact Support
Questions?Contact us