NORA-W36 u-connectXpress AT commands manual

NORA-W36 AT Commands Manual

u-blox short range stand-alone modules

short range
This document provides an overview of the u-connectXpress AT command for NORA-W36 u-blox short range modules and describes how the products can be configured for Wi-Fi and Bluetooth Low Energy.

short rangeshort range

 

Document information

TitleNORA-W36 AT Commands Manual
Subtitleu-blox short range stand-alone modules
Document typeManual
Document numberUBX-23010166
Revision and dateR01 - Feb-02-2024
Disclosure restrictionC1-Public

Document information

This document applies to the following products

Product nameSoftware version
NORA-W36 series1.0.0

How to use this manual
The u-connectXpress AT command for Commands Manual provides the necessary information to successfully design in and configure the applicable u-blox short range 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.

Contents

1 AT command settings

u-blox short range modules provide at least one physical serial interface for configuration and data transport.
At module power on, the module enters the command mode. For more details on the command mode, see

For module and terminal connection and settings, see the corresponding evaluation kit user guide.

1.1 Definitions

In this document, the following naming conventions are used:

  • DCE (Data Communications Equipment): u-blox short range module
  • DTE (Data Terminal Equipment) or TE (Terminal Equipment): The terminal that issues the command to the
    module.

The terms DCE and DTE are used in the serial interface context. The DCE interface can operate in the following
modes:

  • AT 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 command from the DTE (for example,
    unsolicited response code - URC).
  • Transparent mode: The DCE transfers data after having sent the ATO command; all 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.

It is possible to switch from the data mode to command mode in the following ways:
• Using the escape sequence: For more details, see Escape Character S2
• Through a DTR ON to OFF transition: For more details, see Circuit 108/2 (DTR) behavior &D
 

1.1.1 Command description

The AT commands configure and enable the short range module functionality 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
functionalities, correct syntax to be provided by the TE/DTE and allowed responses.
The command description defines each named parameter with its type, range (valid / acceptable values),
default value (when available) and factory default setting (when applicable).
In this document, are intentionally omitted in the command syntax. See Chapter 1.1.2 and
Chapter 1.1.4 for more information.

1.1.2 Command line

The AT commands are typically issued to the short range modules using a command line with the following
generic syntax:
"AT"<command_name><S3_character>
Where:

  • "AT": The prefix to be set at the beginning of each command line
  • <command_name>: The command name string; it can have a "+" character as prefix
  • : The string consisting of the value parameters following the syntax provided in this manual.

The following rules are used when describing the command syntax:

  • <...>: The name in angle brackets is a parameter. The brackets themselves do not appear in the
    command line
  • [...]: The square brackets represent the optional parameters of a command or an optional part of the DCE
    information text response. Brackets themselves do not appear in the command line. When a parameter
    is not given, the value will be set to the default value provided in the command description
  • <S3_character>: The command line termination character; it can be set with Command line termination
    character S3 command; the factory-programmed termination character is
    The command line is not case sensitive.
    The serial interface driver generally does not allow a new command until the previous one has been terminated
    by "OK" or an error message.

1.1.3 Default values

If the command has optional parameters, and default values are not 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.1.4 Information text responses and result codes

The response format is as follows:

  • Information text response(s): <S3_character><S4_character><S3_character><S4_character>
  • Result codes: <S3_character><S4_character><S3_character><S4_character>
    where
  • <S3_character> is the command line termination character; it can be set with S3 command
  • <S4_character> is the linefeed character; it can be set with S4 command
    If the command line is successfully processed and the command is correctly executed, in verbose response
    format the string "OK" is sent as a final result code.
    Intermediate output and descriptive output of a command are formatted as information text responses;
    If more than one string has to be printed out (see for example Scan +UWSCAN command description),
    additional command line termination and linefeed characters can be inserted for the sake of readability.
    If the command is not accepted by the DCE, an error result code will be displayed. The error result has the
    following format:
    • <S3_character><S4_character>ERROR<S3_character><S4_character>
    When using commands in <data_format> Binary, for example &+AT+USPSWB, the formating of the AT command
    differs a bit from regular AT commands.

1.1.5 S-parameters

The S-parameters, as specified in ITU-T recommendation V250, 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<parameter_number>?
ATS<parameter_number>=
The number following the "ATS" is the referenced S parameter.
u-blox short range modules support the following set of S-parameters (<parameter_number>):

  • 2: escape character setting (for more details see the S2)
  • 3: command line termination character setting (for more details see the S3)
  • 4: response formatting character setting (for more details see the S4)
  • 5: command line editing character setting (for more details see the S5)

2 General operation

2.1 Start up

Start up mode is AT mode by default, if Persistant Transparent mode is use see AT+UTMP command.

2.2 AT Command types

2.2.1 Set command

A set command configures preferred settings for the specified command. The set command is the only way to
set the preferred settings in the DCE. Parameters set with a set command will be used immediately and the
parameters can be stored to the start up database using &W.
Some Set commands requires a reboot before using. Store with &W and reset with +CPWROFF.

2.2.2 Read command

A read command provides current setting of the command parameters. It is used to find out the current
command configuration.

2.2.3 Status command

A status command provides current operating status of the module.

2.2.4 Unsolicited result code (URC)

An unsolicited result code is a string message (provided by the DCE) that is not triggered as a 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.

2.3 Data types

The definition of each command specifies the data types used for values associated with the command. The
different data types are listed below and are described in the following subsections:

  • String
  • Integer
  • Enumerator
  • Byte_Array
  • IPv4_Addr
  • IPv6_Addr
  • MAC_Addr
  • Bd_Addr
  • List
  • Binary

2.3.1 String

A string shall consist of a sequence of displayable characters from the ISO 8859-1 character set, except for
characters "", """ and characters below 32 (space). A string constant shall be delimited by two double quote
(""") characters, for example, "Donald Duck". If the double quote character (""") is to be used within a string, for
example, "My friend "Bono" is a singer", they have to be represented as "\22". If the back-slash character ("") is
to be used within a string constant, it has to be represented as "\5C". An empty string is represented by two
adjacent delimiters - "".

2.3.2 Integer

An integer value consists of a sequence of characters, all in the range {0..9} plus a possible minus ("-") sign for
negative values. Numeric constants are expressed in decimal format only.

2.3.3 Enumerator

An enumerator value is actually an integer, where all its possible values are specified in each case. Only the
defined values are accepted for the command in question.

2.3.4 Byte_Array

A Byte_Array consists of a sequence of characters expressed in two digit hexadecimal in the ranges {0..9}, {a..f}
and {A..F}. The hexadecimal values are grouped together without delimiters; an example of Byte_Array (three
values) is "800000" (Bit 23 is set), excluding the double quote characters.

2.3.5 IPv4_Addr

An IPv4_Addr is a special text string in dotted decimal notation form (that is, four numbers in the range 0-255
separated by periods). An example IP address is "192.168.0.1", excluding the double quote characters.

2.3.6 IPv6_Addr

An IPv6_Addr is a special text string represented as eight groups of four hexadecimal digits, each group
representing 16 bits (two octets) and surrounded by brackets. The groups are separated by colons (:). An
example of an IPv6 address is "[2001:0db8:85a3:0000:0000:8a2e:0370:7334]", excluding the double quote
characters.

2.3.7 MAC_Addr

A MAC_Addr is a Byte_Array of fixed length (6 values). An example MAC_Addr is "01A0F7101C08", excluding
the double quote characters.

2.3.8 Bd_Addr

A Bd_Addr is a MAC_Addr followed an optional address type, "r" for random address and "p" for public address.
If the address type is omitted, it will default to public. An example Bd_Addr is "01A0F7101C08p", excluding the
double quote characters.

2.3.9 List

A List is a comma (,) separated list of items, where items can be any of the other data types. For example,
channel list is a list of integers, "1,6,11", excluding the double quote characters.

2.3.10 Binary

The binary data starts with \x01 (SOH - Start Of Heading), following by the length of the data in two bytes format (UINT16) follwed by the binary data.
The binary data shall not be terminated with the normal \x0D (\r - Carriage Return).

The binary header is three bytes:
[0x01(SOH Start Of Header), MSB_datalength, LSB_datalength]

All commands and URC that use binary data are "complete" without the binary data, the binary data is sent directy after the AT command, in most case after the handle.

The AT command follows direcly by the binary data, without any "," or "\r" or anyting in between.

Example:
AT+USOWB=0[0x01,0x00,0x02,0xFF,0xEE]
This command writes to socket 0, 2 bytes data the data is 0xFF 0xEE.

Binary data for Socket, SPS and certicitate upload all use the same Binary data format.

3 General

3.1 AT Commands

AT CommandDescription
ATAttention
AT+CGMIManufacturer identification
AT+GMIManufacturer identification
AT+CGMMModel identification
AT+GMMModel identification
AT+CGMRSoftware version identification
AT+GMRSoftware version identification
AT+CGSNSerial number
AT+GSNSerial number
ATIIdentification information
AT+CSGTGreeting Text

3.1.1 AT - Attention

Attention command that determines the presence of a Data Communication Equipment (DCE).

Syntax

AT Command
Description
ATAttention command.

3.1.2 AT+CGMI - Manufacturer identification

Read a text string that identifies the manufacturer.

Syntax

AT Command
Description
AT+CGMIRead manufacturer text string.
Response
Description
<manufacturer>Successful read response.
Note: The manufacturer string is returned without any response prefix.

Defined values

ParameterTypeDescription
manufacturerstringManufacturer ("u-blox").

3.1.3 AT+GMI - Manufacturer identification

Read a text string that identifies the manufacturer.

Syntax

AT Command
Description
AT+GMIRead manufacturer text string.
Response
Description
<manufacturer>Successful read response.
Note: The manufacturer string is returned without any response prefix.

Defined values

ParameterTypeDescription
manufacturerstringManufacturer ("u-blox").

3.1.4 AT+CGMM - Model identification

Read a text string that identifies the device model.

Syntax

AT Command
Description
AT+CGMMRead device model.
Response
Description
<device_model>Successful read response.
Note: The device_model string is returned without any response prefix.

Defined values

ParameterTypeDescription
device_modelstringDevice model

3.1.5 AT+GMM - Model identification

Read a text string that identifies the device model.

Syntax

AT Command
Description
AT+GMMRead device model.
Response
Description
<device_model>Successful read response.
Note: The device_model string is returned without any response prefix.

Defined values

ParameterTypeDescription
device_modelstringDevice model

3.1.6 AT+CGMR - Software version identification

Read a text string that identifies the software version of the module.

Syntax

AT Command
Description
AT+CGMRRead software version.
Response
Description
<version>Successful read response.
Note: The version string is returned without any response prefix.

Defined values

ParameterTypeDescription
versionstringVersion.

3.1.7 AT+GMR - Software version identification

Read a text string that identifies the software version of the module.

Syntax

AT Command
Description
AT+GMRRead software version.
Response
Description
<version>Successful read response.
Note: The version string is returned without any response prefix.

Defined values

ParameterTypeDescription
versionstringVersion.

3.1.8 AT+CGSN - Serial number

Read the product serial number.

Syntax

AT Command
Description
AT+CGSNRead serial number.
Response
Description
<serial_number>Successful read response.
Note: The serial_number string is returned without any response prefix.

Defined values

ParameterTypeDescription
serial_numberstringSerial number.

3.1.9 AT+GSN - Serial number

Read the product serial number.

Syntax

AT Command
Description
AT+GSNRead serial number.
Response
Description
<serial_number>Successful read response.
Note: The serial_number string is returned without any response prefix.

Defined values

ParameterTypeDescription
serial_numberstringSerial number.

3.1.10 ATI - Identification information

Read identification information.

Syntax

AT Command
Description
ATI9Read identification information.
ATI10Read MCU ID.
ATI0Read type code.
Response
Description
<application_version>,<unique_identifier>Successful read response.
Note: The application_version and unique_identifier strings are returned without any response prefix.
<mcu_id>Successful read response.
Note: The mcu_id string is returned without any response prefix.
<type_code>Successful read response.
Note: The type_code string is returned without any response prefix.

Defined values

ParameterTypeDescription
application_versionstringApplication version.
unique_identifierstringUnique identifier.
mcu_idstringTwo byte hex string representing the MCU ID.
type_codestringType code for the module.

3.1.11 AT+CSGT - Greeting Text

Configures and activates/deactivates the greeting text.
The configuration change in the greeting text will be applied at the subsequent boot.
When active, the greeting text is sent at boot once.

Syntax

AT Command
Description
AT+CSGT=<greeting_mode>[,<text>]Set the greeting text and mode.
AT+CSGT?Read the greeting text.
Response
Description
+CSGT:<greeting_mode>,<text>Successful read response.

Defined values

ParameterTypeDescription
greeting_modeenumeratorValid values:
0: Turn off the greeting text.
1: Turn on the greeting text.
textstringThe greeting text.
Note: Can not be an empty string.

Valid length: 1..49

4 System

System AT commands

4.1 AT Commands

AT CommandDescription
AT+CPWROFFModule switch off
AT&WStore current configuration.
AT+USYLALocal Address
AT+USYFRFactory Restore
AT+USYDSDefault Settings
AT+USYUSUart Settings
AT+USYFWUSFirmware Update using serial port
AT+USYBLStart the boot loader command line interface
AT+USYECError Code
AT+USYEEExtended Error codes on/off
ATEEcho On/Off
ATSS-registers
AT+UTMESTransparent mode escape sequence settings

4.1.1 AT+CPWROFF - Module switch off

Syntax

AT Command
Description
AT+CPWROFFReboot the DCE.

4.1.2 AT&W - Store current configuration.

Store the current configuration to flash

Syntax

AT Command
Description
AT&WWrite the current configuration to flash. The configuration is stored immediately when AT&W is issued.

4.1.3 AT+USYLA - Local Address

Syntax

AT Command
Description
AT+USYLA=<interface_id>Get interface address
AT+USYLA=<interface_id>,<address>Set interface address
Response
Description
+USYLA:<address>Successful read response

Defined values

ParameterTypeDescription
interface_idenumeratorValid values:
0: Bluetooth
1: Wi-Fi station
2: Wi-Fi Access point
addressmac_addrMAC address of the interface id. If the address is set to 000000000000, the local address will be restored to factory-programmed value. A reboot is required The least significant bit of the first octet of the
must be 0.

4.1.4 AT+USYFR - Factory Restore

Syntax

AT Command
Description
AT+USYFRThe module is completely restored to factory defaults. All settings are reset to default values.
All certificates and Bluetooth bonding information will be removed.
A reboot is required before using the new settings.

4.1.5 AT+USYDS - Default Settings

Syntax

AT Command
Description
AT+USYDSReset all settings to default values.
Certificates and Bluetooth bonding information will be left untouched.
A reboot is required before using the new settings.

4.1.6 AT+USYUS - Uart Settings

Syntax

AT Command
Description
AT+USYUS=<baud_rate>[,<flow_control>[,<change_after_confirm>]]Configure new UART settings that will be used after restart. Baudrates above 4000000 bps can be set, but are unsupported.
AT+USYUS?Reads current UART settings from the module
Response
Description
+USYUS:<baud_rate>,<flow_control>Successful read response

Defined values

ParameterTypeDescription
baud_rateintegerBaudrate

Valid values: 110..6000000

Default value: 115200

flow_controlintegerValid values: 0..1
change_after_confirmintegerValid values: 0..1

4.1.7 AT+USYFWUS - Firmware Update using serial port

Start serial port firmware upgrade. The module will indicate that it is ready to receive
the new firmware by regularly sending the XModem start byte C until either an XModem transfer has started,
or a timeout has occurred

Syntax

AT Command
Description
AT+USYFWUS=<baud_rate>[,<flow_control>]Start firmware upgrade on the serial port with provided settings
AT+USYFWUSStart firmware upgrade on the serial port with default settings, baudrate 115200 and no flow control

Defined values

ParameterTypeDescription
baud_rateintegerValid values: 110..6000000

Default value: 115200

flow_controlintegerValid values: 0..1

Default value: 0

4.1.8 AT+USYBL - Start the boot loader command line interface

Force start of the boot loader. The boot loader will start at the defined baud rate.

Syntax

AT Command
Description
AT+USYBL=<baud_rate>[,<flow_control>]Force start of the boot loader.
AT+USYBLForce start of the boot loader with default settings. Baudrate 115200 and flow control off.

Defined values

ParameterTypeDescription
baud_rateintegerValid values: 110..6000000

Default value: 115200

flow_controlintegerValid values: 0..1

Default value: 0

4.1.9 AT+USYEC - Error Code

Syntax

AT Command
Description
AT+USYEC?Read the last error code
Response
Description
+USYEC:<error_code>Latest error code

Defined values

ParameterTypeDescription
error_codeintegerError code

4.1.10 AT+USYEE - Extended Error codes on/off

Syntax

AT Command
Description
AT+USYEE=<extended_errors>Enable or disable extended error codes
AT+USYEE?Read extended error codes enabled/disabled
Response
Description
+USYEE:<extended_errors>Extended error codes setting

Defined values

ParameterTypeDescription
extended_errorsenumeratorExtended error codes setting

Valid values:
0: (Factory default) Extended error codes will not be displayed
1: Extended error code will be displayed on every error

4.1.11 ATE - Echo On/Off

This command configures whether or not the module echoes the characters received from the host.

Syntax

AT Command
Description
ATE0Set echo off
ATE1Set echo on
ATE?Read current echo setting
Response
Description
<echo_on>Current echo setting

Defined values

ParameterTypeDescription
echo_onenumeratorValid values:
0: Module does not echo the characters
1: (Factory default) Module echoes the characters

4.1.12 ATS - S-registers

Used to set different configuration parameters

Syntax

AT Command
Description
ATS2=<escape_char>Write escape character. This settings change the decimal value of the escape character used by some modes, such as transparent mode for example, to detect an escape sequence and exit.
ATS2?Read escape character
ATS3=<line_term>Write line termination character. This setting changes the decimal value of the character recognized by the DCE from the DTE to terminate an incoming command line. It is also generated by the DCE as part of the header, trailer, and terminator for result codes and information text along with the S4 parameter. The previous value of S3 is used to determine the command line termination character for entry of the command line containing the S3 setting command. However, the result code issued shall use the value of S3 as set during the processing of the command line. For example, if S3 was previously set to 13 and the command line "ATS3=30" is issued, the command line shall be terminated with a CR, character (13), but the result code issued will use the character with the ordinal value 30 instead of the CR.
ATS3?Read line termination character
ATS4=<resp_format>Write response format character. This setting changes the decimal value of the character generated by the DCE as part of the header, trailer, and terminator for result codes and information text, along with the S3 parameter. If the value of S4 is changed in a command line, the result code issued in response to that command line will use the new value of S4.
ATS4?Read response format character
ATS5=<backspace>Writes backspace character. This setting changes the decimal value of the character recognized by the DCE as a request to delete from the command line, the immediately preceding character.
ATS5?Read backspace character
Response
Description
<escape_char>Current escape character
<line_term>Current line termination character
<resp_format>Current response format character
<backspace>Current backspace character

Defined values

ParameterTypeDescription
line_termintegerCommand line termination character. Factory default: 13

Valid values: 0..127

resp_formatintegerResponse format character. Factory default: 10

Valid values: 0..127

backspaceintegerBackspace character. Factory default: 8

Valid values: 0..127

escape_charintegerEscape character. Factory default: 43

Valid values: 0..127

4.1.13 AT+UTMES - Transparent mode escape sequence settings

Syntax

AT Command
Description
AT+UTMES=<pre_timeout>,<post_timeout>,<escape_timeout>Configures the transparent mode escape sequence settings.
AT+UTMES?Reads current transparent mode escape sequence settings.
Response
Description
+UTMES:<pre_timeout>,<post_timeout>,<escape_timeout>Successful read response

Defined values

ParameterTypeDescription
pre_timeoutintegerMinimum time (ms) of no data activity required before the escape sequence is sent. Factory default: 1000

Valid values: 50..5000

post_timeoutintegerMinimum time (ms) of no data activity required after the escape sequence is sent. Factory default: 1000

Valid values: 50..5000

escape_timeoutintegerMaximum time interval (ms) between escape characters. Factory default: 200

Valid values: 50..5000

5 Bluetooth

Bluetooth commands

5.1 AT Commands

AT CommandDescription
AT+UBTMBluetooth Mode
AT+UBTCBluetooth Connect
AT+UBTPBluetooth Persistent
AT+UBTPRBluetooth Persistent Remove
AT+UBTPLBluetooth Persistent List
AT+UBTDCBluetooth Disconnect
AT+UBTLNBluetooth Local Name
AT+UBTDBluetooth Discovery
AT+UBTBGDBluetooth Background Discovery
AT+UBTRSSBluetooth RSSI
AT+UBTCLBluetooth Connection List
AT+UBTCSTBluetooth Connection Status
AT+UBTADBluetooth Advertising Data
AT+UBTSDBluetooth Scan Data
AT+UBTABluetooth Advertisements
AT+UBTDABluetooth Directed Advertisement
AT+UBTCSBluetooth Connection Settings
AT+UBTASBluetooth Advertisement Settings.
AT+UBTIOCBluetooth I/O Capabilities
AT+UBTBSMBluetooth Bond Security Mode
AT+UBTPMBluetooth Pairing Mode
AT+UBTUCBluetooth User Confirmation
AT+UBTUPEUser passkey entry
AT+UBTBBluetooth Bond
AT+UBTUBBluetooth Unbond
AT+UBTBDLBluetooth Bonded Devices List
AT+UBTDISBluetooth Device Information Service
AT+UBTPHYRBluetooth PHY Request

5.1.1 AT+UBTM - Bluetooth Mode

Set and read Bluetooth Mode, default Bluetooth Mode is Central and Peripheral. For the mode change to take affect, AT&W and a restart is needed.

Syntax

AT Command
Description
AT+UBTM=<bt_mode>Set Bluetooth Mode.
AT+UBTM?Read Bluetooth Mode.
Response
Description
+UBTM:<bt_mode>Successful read response.

Defined values

ParameterTypeDescription
bt_modeenumeratorValid values:
0: Disabled.
1: Bluetooth Low Energy Central.
In this mode, starting advertisements, direct advertisements and other functions associated
with the Peripheral role is not possible.

2: Bluetooth Low Energy Peripheral.
In this mode, initiating connections, discovery and other functions associated with
the Central role is not possible.

3: Bluetooth Low Energy Simultaneous Central and Peripheral. This is the factory default for NORA-W36.

5.1.2 AT+UBTC - Bluetooth Connect

Make an ACL connection to a remote device with defined protocol type. Unsolicited events +UEBTC or +UEBTDC will be sent out to confirm the connection establishment.

Syntax

AT Command
Description
AT+UBTC=<bd_addr>Initiate connection.

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.

5.1.3 AT+UBTP - Bluetooth Persistent

Syntax

AT Command
Description
AT+UBTP=<bd_addr>,<connect_sps>Configure an ACL link with automatic re-connection. As opposed to AT+UBTC, this command will not initiate
a connection directly but is used for storing a connection configuration persistently so that the link is
automatically setup on boot.
See also AT+USOP
Response
Description
+UBTP:<config_id>Successful write response, returning a configuration id identifying the configuration

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.
connect_spsintegerShould start a SPS connection when ACL link is up.
Integer Boolean flag 0 = No, 1 = Yes

Valid values: 0..1

config_idintegerConfiguration id

Valid values: 200..200

5.1.4 AT+UBTPR - Bluetooth Persistent Remove

Remove a Persistent Bluetooth Connection configuration

Syntax

AT Command
Description
AT+UBTPR=<config_id>Removes a persistent bluetooth connection configuration

Defined values

ParameterTypeDescription
config_idintegerConfiguration id

Valid values: 200..200

Notes

The corresponding link will be automatically disconnected

5.1.5 AT+UBTPL - Bluetooth Persistent List

List all configured persistent bluetooth connections

Syntax

AT Command
Description
AT+UBTPL?List the currently configured Persistent Bluetooth Connections
Response
Description
+UBTPL:<config_id>,<bd_addr>,<connect_sps>Successful read response

Defined values

ParameterTypeDescription
config_idintegerConfiguration id

Valid values: 200..200

bd_addrbd_addrBluetooth device address of the remote device.
connect_spsintegerShould start a SPS connection when ACL link is up.
Integer Boolean flag 0 = No, 1 = Yes

Valid values: 0..1

5.1.6 AT+UBTDC - Bluetooth Disconnect

Used to close an ACL connection.

Syntax

AT Command
Description
AT+UBTDC=<conn_handle>Close an existing ACL connection.

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.

5.1.7 AT+UBTLN - Bluetooth Local Name

Set the local name used as device name for Bluetooth Classic, in the advertising data of the device and in the Device Information service for Bluetooth low energy.

Syntax

AT Command
Description
AT+UBTLN?Reads the local Bluetooth device name.
AT+UBTLN=<device_name>Writes the local Bluetooth device name.
Response
Description
+UBTLN:<device_name>Successful read response.

Defined values

ParameterTypeDescription
device_namestringFor Bluetooth low energy the maximum size is 29 characters.

Valid length: 0..29

5.1.8 AT+UBTD - Bluetooth Discovery

Performs a discovery procedure to find any advertising devices in the vicinity.

Syntax

AT Command
Description
AT+UBTDStart discovery using default parameters
AT+UBTD=<discovery_type>[,<discovery_mode>[,<discovery_length>]]Start discovery.
Response
Description
+UBTD:<bd_addr>,<rssi>,<device_name>,<data_type>,<data>This response is sent for every found device. If no name is found, <device_name> is an empty string, if is set to Active, both Scan responses and Advertisements will be shown.

Defined values

ParameterTypeDescription
discovery_typeenumeratorValid values:
0: All with no filter. Displays all found devices; devices can be displayed multiple times.
1: General inquiry. Displays devices in General or Limited discoverability mode; each device is displayed only once.
discovery_modeenumeratorValid values:
0: Active discovery.
1: Passive, no scan response data will be received.

Default value: 0

discovery_lengthintegerTimeout measured in milliseconds. Time range: 10 ms - 40 s

Valid values: 10..40000

Default value: 5000

device_namestringName of the discovered device.
data_typeenumeratorValid values:
0: Scan response data.
1: Advertise data.
databyte_arrayComplete advertise/scan response data received from the remote device.
bd_addrbd_addrBluetooth device address of the remote device.
rssiintegerReceived signal strength in dBm.

5.1.9 AT+UBTBGD - Bluetooth Background Discovery

Start a background discovery.

Syntax

AT Command
Description
AT+UBTBGD=<background_discovery_mode>Start/Stop background discovery
AT+UBTBGD?Read background discovery mode
Response
Description
+UBTBGD:<background_discovery_mode>Successful read response

Defined values

ParameterTypeDescription
background_discovery_modeenumeratorValid values:
0: Set background discovery off
1: Set background discovery on

5.1.10 AT+UBTRSS - Bluetooth RSSI

Returns the current received RSSI for a specified Bluetooth connection.

Syntax

AT Command
Description
AT+UBTRSS=<conn_handle>Returns the current RSSI for a specified Bluetooth connection.
Response
Description
+UBTRSS:<rssi>Successful response.

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.
rssiintegerReceived signal strength in dBm.

5.1.11 AT+UBTCL - Bluetooth Connection List

List all active Bluetooth low energy ACl connections.

Syntax

AT Command
Description
AT+UBTCLList all Bluetooth low energy ACL connections.
Response
Description
+UBTCL:<conn_handle>,<bd_addr>Sent for every connection.

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.
bd_addrbd_addrBluetooth device address of the remote device.

5.1.12 AT+UBTCST - Bluetooth Connection Status

Read negotiated properties of a Bluetooth low energy ACL connection.
Some of the properties are a result of negotiation when a connections is set up, and this command gives the possibility
to see what properties the connection actually uses.

Syntax

AT Command
Description
AT+UBTCST=<conn_handle>Read all properties of an existing Bluetooth low energy ACL connection.
AT+UBTCST=<conn_handle>,<property_id>Read a specific property of an existing Bluetooth low energy ACL connection.
Response
Description
+UBTCST:<property_id>,<status_val>One response for each property_id.

Defined values

ParameterTypeDescription
status_valintegerValue of the preceding property.
property_idenumeratorValid values:
0: Connection interval used on this connection.
Range: 6 to 3200
Time = status_val * 1.25 ms
Time range: 7.5 ms to 4000 ms

1: Peripheral latency for the connection in number of connection events. Range: 0 to 499
2: Supervision timeout (in ms) for this connections. Range: 100 ms to 32000 ms
3: MTU size for this connections.
4: Data Channel TX PDU Payload Length.
5: Data Channel RX PDU Payload Length.
6: Data Length Extension state. 0: Data Length Extension Off \ 1: Data Length Extension On
7: Local role in this connection. 1: Low Energy Central \ 2: Low Energy Peripheral
8: TX Phy used in this connection
Bit 0: 1 Mbps
Bit 1: 2 Mbps
Bit 2: reserved for future use

9: RX Phy used in this connection
Bit 0: 1 Mbps
Bit 1: 2 Mbps
Bit 2: reserved for future use

conn_handleintegerConnection handle of the Bluetooth low energy connection.

5.1.13 AT+UBTAD - Bluetooth Advertising Data

Command for setting custom advertising data in Bluetooth low energy. Maximum of 28 bytes. Maximum 252 bytes if advertisement extensions are enabled.
Any custom advertising data will be appended to the default mandatory flags field.
Note that the AT command AT+UBTD supports scan modes that can be used to see the complete advertising data.
This is useful when testing the advertising configurations set with the AT+UBTAD. By default, the service UUID for the u-blox Serial Port Service is part of the advertising data.

Syntax

AT Command
Description
AT+UBTAD=<adv_data>Write custom advertising data.
AT+UBTAD?Read custom advertising data.
Response
Description
+UBTAD:<adv_data>Successful read response.

Defined values

ParameterTypeDescription
adv_databyte_arrayValid length: 2..252

5.1.14 AT+UBTSD - Bluetooth Scan Data

Command for setting custom scan response data in Bluetooth low energy. Any custom scan response data will override the default scan response data. By default, the local name is part of the scan response data.

Syntax

AT Command
Description
AT+UBTSD=<scan_rsp_data>Write scan response data.
AT+UBTSD?Read scan response data.
Response
Description
+UBTSD:<scan_rsp_data>Successful read response.

Defined values

ParameterTypeDescription
scan_rsp_databyte_arrayValid length: 1..31

5.1.15 AT+UBTA - Bluetooth Advertisements

Command for enabling and disabling advertisements

Syntax

AT Command
Description
AT+UBTA=<adv_mode>Set advertisements on or off.
AT+UBTA?Read advertisement mode.
Response
Description
+UBTA:<adv_mode>Successful read response.

Defined values

ParameterTypeDescription
adv_modeenumeratorValid values:
0: Set Bluetooth Advertisements off
1: Set Bluetooth Advertisements on

5.1.16 AT+UBTDA - Bluetooth Directed Advertisement

Start a directed advertisement to a given Bluetooth Address

Syntax

AT Command
Description
AT+UBTDA=<bd_addr>[,<timeout>]Starts directed advertisements to Bluetooth Address. If bd_addr is FFFFFFFFFFFF, direct advertisements will be disabled.
By default the timeout is 1280 ms, and uses High Duty Cycle Advertising. A timeout greater than this will result in
Low Duty Cycle Advertising as High Duty Cycle Advertising has a limited use of only 1280 ms. Setting timeout to 0 will let the
device advertise indefinitely in Low Duty Cycle mode.

Defined values

ParameterTypeDescription
timeoutintegerTimeout for Directed Advertisements.

Default value: 1280

bd_addrbd_addrBluetooth device address of the remote device.

5.1.17 AT+UBTCS - Bluetooth Connection Settings

Get and set connection related settings

Syntax

AT Command
Description
AT+UBTCS0=<connection_interval_minimum>Write connection interval minimum.
AT+UBTCS0?Read Connection Interval minium.
AT+UBTCS1=<connection_interval_maximum>Write connection interval maximum.
AT+UBTCS1?Read Connection Interval maximum.
AT+UBTCS2=<connection_peripheral_latency>Write connection peripheral latency.
AT+UBTCS2?Read connection peripheral latency.
AT+UBTCS3=<connection_linkloss_timeout>Write connection linkloss timeout.
AT+UBTCS3?Read connection linkloss timeout.
AT+UBTCS4=<preferred_tx_phy>Write Preferred TX PHY.
AT+UBTCS4?Read Preferred TX PHY.
AT+UBTCS5=<preferred_rx_phy>Write Preferred RX PHY.
AT+UBTCS5?Read Preferred RX PHY.
AT+UBTCS?Read all Bluetooth Configuration param values.
Response
Description
+UBTCS0:<connection_interval_minimum>Successful read of connection interval minimum.
+UBTCS1:<connection_interval_maximum>Successful read of connection interval maximum.
+UBTCS2:<connection_peripheral_latency>Successful read of connection peripheral latency.
+UBTCS3:<connection_linkloss_timeout>Successful read of connection linkloss timeout.
+UBTCS4:<preferred_tx_phy>Successful read of Preferred TX PHY.
+UBTCS5:<preferred_rx_phy>Successful read of Preferred RX PHY.
+UBTCS:<param>,<value>Successful read response for AT+UBTCS.

Defined values

ParameterTypeDescription
connection_interval_minimumintegerConnection interval minimum (must be <= Connection interval maximum). Final results will be a result of negotiation between devices.
Default: 24.
Calculation: connection_interval_minimum * 1.25. ms

Valid values: 6..3200

Default value: 24

connection_interval_maximumintegerConnection interval maximum (must be >= Connection interval minimum). Final results will be a result of negotiation between devices.
Default: 40.
Calculation: connection_interval_maximum * 1.25 ms.

Valid values: 6..3200

Default value: 40

connection_peripheral_latencyintegerConnection peripheral latency.
Default: 0
Calculation: Number of connection events.

Valid values: 0..500

Default value: 0

connection_linkloss_timeoutintegerConnection linkloss timeout.
Default: 2000
Calculation: connection_linkloss_timeout ms

Valid values: 100..32000

Default value: 2000

preferred_tx_phyintegerPreferred Transmitter PHY
0: Let other side decide
OR a bit field with three bits:
Bit 0: 1 Mbps preferred
Bit 1: 2 Mbps preferred
Bit 2: reserved for future use

Valid values: 0..7

Default value: 0

preferred_rx_phyintegerPreferred Receiver PHY
0: Let other side decide
OR a bit field with three bits:
Bit 0: 1 Mbps preferred
Bit 1: 2 Mbps preferred
Bit 2: reserved for future use

Valid values: 0..7

Default value: 0

paramenumeratorConnection parameter.

Valid values:
0: Connection interval minimum.
1: Connection interval maximum.
2: Connection peripheral latency.
3: Connection linkloss timeout.
4: Preferred Transmitter PHY
5: Preferred Receiver PHY

valueintegerValue of connection parameter.

Valid values: 0..65535

5.1.18 AT+UBTAS - Bluetooth Advertisement Settings.

Get and Set Advertisement Settings.

Syntax

AT Command
Description
AT+UBTAS0=<advertisement_interval_minimum>Write advertisement interval minimum.
AT+UBTAS0?Read advertisement Interval miniumum.
AT+UBTAS1=<advertisement_interval_maximum>Write advertisement interval maximum.
AT+UBTAS1?Read advertisement Interval maximum.
AT+UBTAS?Read all Advertising parameter setting values.
Response
Description
+UBTAS0:<advertisement_interval_minimum>Successful read of connection interval minimum.
+UBTAS1:<advertisement_interval_maximum>Successful read of advertisement interval maximum.
+UBTAS:<adv_param>,<value>Successful read response for AT+UBTAS?.

Defined values

ParameterTypeDescription
advertisement_interval_minimumintegerAdvertising interval minimum (must be <= Advertising interval maximum.
Default: 1600.
Calculation: advertisement_interval_minimum * 0.625 ms)

Valid values: 32..16384

Default value: 1600

advertisement_interval_maximumintegerAdvertising interval maximum (must be >= Advertising interval minimum.
Default: 2000.
Calculation: advertisement_interval_maximum * 0.625 ms)

Valid values: 32..16384

Default value: 2000

valueintegerValue of advertisement parameter.

Valid values: 0..65535

adv_paramenumeratorAdvertisement parameter.

Valid values:
0: Advertisement interval minimum.
1: Advertisement interval maximum.

5.1.19 AT+UBTIOC - Bluetooth I/O Capabilities

Set Bluetooth I/O Capabilities, this impacts the possible bonding procedure between devices.

Syntax

AT Command
Description
AT+UBTIOC=<io_capabilities>Set I/O Capabilities
AT+UBTIOC?Read I/O Capabilities
Response
Description
+UBTIOC:<io_capabilities>Successful read response for AT+UBTIOC?.

Defined values

ParameterTypeDescription
io_capabilitiesenumeratorValid values:
0: Set I/O Capabilities to No Input No Output.
1: Set I/O Capabilities to Display Only.
2: Set I/O Capabilities to Display Yes/No
3: Set I/O Capabilities to Keyboard Only.
4: Set I/O Capabilities to Keyboard Display.

Default value: 0

5.1.20 AT+UBTBSM - Bluetooth Bond Security Mode

Set the security mode of the device. This command works together with AT+UBTIOC to determine the bonding procedure used.
If the security mode is higher than unauthenticated, pairing will automatically be enabled.

Syntax

AT Command
Description
AT+UBTBSM=<bt_security_mode>Writes the security mode
AT+UBTBSM?Reads the security mode
Response
Description
+UBTBSM:<bt_security_mode>Successful read response for AT+UBTBSM?

Defined values

ParameterTypeDescription
bt_security_modeenumeratorValid values:
0: Security Disabled.
1: Allow unauthenticated bonding.
2: Only allow authenticated bonding.
3: Only allow authenticated bonding with encrypted Bluetooth link. Fallback to simple pairing if the remote side does not support secure connections.
4: Only allow authenticated bonding with encrypted Bluetooth link. Strictly uses secure connections.

Default value: 0

5.1.21 AT+UBTPM - Bluetooth Pairing Mode

Enable or disable pairing.

Syntax

AT Command
Description
AT+UBTPM=<pairing_mode>Writes the pairing mode.
AT+UBTPM?Read current pairing mode.
Response
Description
+UBTPM:<pairing_mode>Successful read response for AT+UBTPM?

Defined values

ParameterTypeDescription
pairing_modeenumeratorValid values:
0: Disable pairing mode.
1: Enable pairing mode.

Default value: 0

5.1.22 AT+UBTUC - Bluetooth User Confirmation

The user confirmation is used together with IO capability DisplayYesNo to repond to a user confirmation request (+UEBTUC). The command shall be used only after +UEUBTUC has been recieved.

Syntax

AT Command
Description
AT+UBTUC=<bd_addr>,<yes_no>Respond to +UEUBTUC and confirm/deny bonding.

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.
yes_noenumeratorValid values:
0: Deny bonding.
1: Confirm bonding.

5.1.23 AT+UBTUPE - User passkey entry

The user passkey entry is used together with IO capability KeyboardOnly to respond on a user passkey entry request (+UEBTUPE). This command shall be used only after +UEBTUPE has been received.

Syntax

AT Command
Description
AT+UBTUPE=<bd_addr>,<yes_no>[,<passkey>]Respond to +UEBTUPE event and confirm/deny bonding.

Defined values

ParameterTypeDescription
passkeyintegerPasskey used to confirm bonding, if yes_no is set to no, this can be omitted.

Valid values: 0..999999

bd_addrbd_addrBluetooth device address of the remote device.
yes_noenumeratorValid values:
0: Deny bonding.
1: Confirm bonding.

5.1.24 AT+UBTB - Bluetooth Bond

Performs a GAP bond procedure with another Bluetooth device. For some I/O Capabilities, user interaction is required during the bonding procedure. The procedure to use is determined by the I/O Capabilities and security mode.

Syntax

AT Command
Description
AT+UBTB=<bd_addr>Initiate bonding. To perform the bonding, the remote device must be in a pairable and connectable mode. Bond event +UEBTB is genereated once the bond is complete.

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.

5.1.25 AT+UBTUB - Bluetooth Unbond

Unbond from a previously bonded device. Note that this will remove the bond from the local device only.

Syntax

AT Command
Description
AT+UBTUB=<bd_addr>Removes a single previously bonded device.
AT+UBTUBRemoves all previously bonded devices.

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.

5.1.26 AT+UBTBDL - Bluetooth Bonded Devices List

Reads the list of bonded devices.

Syntax

AT Command
Description
AT+UBTBDLRead list of bonded devices.
Response
Description
+UBTBDL:<bd_addr>This response is sent for every found device.

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.

5.1.27 AT+UBTDIS - Bluetooth Device Information Service

Write and read the module's Device Information Service (DIS) characteristics. The settings can be saved using AT&W.

Syntax

AT Command
Description
AT+UBTDIS=<characteristic_id>[,<characteristic_value>]Set a characterstic value.
AT+UBTDIS?Read all individual characterstic of the Device Information Service characteristics.
Response
Description
+UBTDIS:<characteristic_id>,<characteristic_value>Successful read response.

Defined values

ParameterTypeDescription
characteristic_idenumeratorValid values:
0: Manufacturer name string. Maximum length of the custom string is 31 characters.
1: Model name string. Maximum length of the custom string is 20 characters.
2: Firmware revision string. Maximum length of the custom string is 20 characters.
3: Software revision string. Maximum length of the custom string is 20 characters.
characteristic_valuestringValue of Device Information Service characterstic.

5.1.28 AT+UBTPHYR - Bluetooth PHY Request

Request a new PHY configuration for a connection. If tx PHY or rx PHY is 0, the module will select PHYs
based on the peer requirements on that specific direction. If the peer does not support the PHY update procedure,
then the resulting +UEBTPHYU event will have a error status other than success.

Syntax

AT Command
Description
AT+UBTPHYR=<conn_handle>,<tx_phy>,<rx_phy>Requests a Bluetooth Low Energy PHY update.
AT+UBTPHYR=<conn_handle>Reads currect PHYs for a connection.
Response
Description
+UBTPHYR:<conn_handle>,<tx_phy>,<rx_phy>Successful read response.

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.
tx_phyintegerRequested PHY for Transmitter:
0: Let other side decide
OR a bit field with three bits:
Bit 0: 1 Mbps preferred
Bit 1: 2 Mbps preferred
Bit 2: Coded PHY (S=8). Not supported by NORA-W36

Valid values: 0..7

rx_phyintegerRequested PHY for Receiver
0: Let other side decide
OR a bit field with three bits:
Bit 0: 1 Mbps preferred
Bit 1: 2 Mbps preferred
Bit 2: Coded PHY (S=8). Not supported by NORA-W36

Valid values: 0..7

5.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UEBTCBluetooth Connected event
+UEBTDCBluetooth Disconnected event
+UEBTBBluetooth Bond status event
+UEBTUCBluetooth User Confirmation event
+UEBTUPDBluetooth Passkey entry event
+UEBTUPEBluetooth Passkey request event
+UEBTPHYUBluetooth PHY update event

5.2.1 +UEBTC - Bluetooth Connected event

Event indicating successful Bluetooth connection.

Syntax

+UEBTC:<conn_handle>,<bd_addr>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.
bd_addrbd_addrBluetooth device address of the remote device.

5.2.2 +UEBTDC - Bluetooth Disconnected event

Event indicating a disconnected Bluetooth connection.

Syntax

+UEBTDC:<conn_handle>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.

5.2.3 +UEBTB - Bluetooth Bond status event

Event indicates that a bonding procedure is completed.

Syntax

+UEBTB:<bd_addr>,<bond_status>

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.
bond_statusenumeratorBonding status

Valid values:
0: Bonding procedure succeeded.
1: Bonding procedure failed due to page timeout.
2: Bonding failed because of authentication or pairing failed. This could be due to incorrect PIN/passkey.
3: Bonding failed because the protection against Man-In-The-Middle attack could not be guaranteed; the generated link key was too weak.

5.2.4 +UEBTUC - Bluetooth User Confirmation event

This event is used while bonding with IO capability DisplayYesNo. This event indicates that the user confirmation of a numeric value is required.

Syntax

+UEBTUC:<bd_addr>,<numeric_value>

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.
numeric_valueintegerNumeric value.

Valid values: 0..999999

5.2.5 +UEBTUPD - Bluetooth Passkey entry event

This event is used to indicate to the user that a passkey has to be entered on the remote device during a bonding procedure with the IO capability DisplayOnly.

Syntax

+UEBTUPD:<bd_addr>,<numeric_value>

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.
numeric_valueintegerNumeric value.

Valid values: 0..999999

5.2.6 +UEBTUPE - Bluetooth Passkey request event

This event is used during bonding with IO capability KeyboardOnly to indicate that a passkey is required from the user. User should respond to this event with the AT+UBTUPE command.

Syntax

+UEBTUPE:<bd_addr>

Defined values

ParameterTypeDescription
bd_addrbd_addrBluetooth device address of the remote device.

5.2.7 +UEBTPHYU - Bluetooth PHY update event

This event informs the result of a PHY update procedure. It may be generated as a result of the command AT+UBTPHYR or as a successful event, if the operation has been initiated by the remote peer.

Syntax

+UEBTPHYU:<conn_handle>,<phy_status>,<tx_phy>,<rx_phy>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of the Bluetooth low energy connection.
phy_statusintegerBluetooth status codes:
0: Success
0x01-0xFF: Error, see Bluetooth Core Specifications, Vol 2, Part D.

Valid values: 0..255

tx_phyintegerRequested PHY for Transmitter:
0: Let other side decide
OR a bit field with three bits:
Bit 0: 1 Mbps preferred
Bit 1: 2 Mbps preferred
Bit 2: Coded PHY (S=8). Not supported by NORA-W36

Valid values: 0..7

rx_phyintegerRequested PHY for Receiver
0: Let other side decide
OR a bit field with three bits:
Bit 0: 1 Mbps preferred
Bit 1: 2 Mbps preferred
Bit 2: Coded PHY (S=8). Not supported by NORA-W36

Valid values: 0..7

6 GATT Client

GATT Client

6.1 AT Commands

AT CommandDescription
AT+UBTGPSDGATT Primary Services Discover
AT+UBTGPSDUGATT Primary Services Discover by UUID
AT+UBTGSCDGATT Service Characteristics Discover
AT+UBTGCDDGATT Characteristic Descriptors Discover
AT+UBTGRGATT Read
AT+UBTGRUGATT Read characteristic by UUID
AT+UBTGWGATT Write
AT+UBTGCCWGATT Client Configuration Write
AT+UBTGWNRGATT Write with No Response
AT+UBTGWLGATT Write long

6.1.1 AT+UBTGPSD - GATT Primary Services Discover

List all GATT services on the GATT server.

Syntax

AT Command
Description
AT+UBTGPSD=<conn_handle>Discover all primary services on the remote device.
Response
Description
+UBTGPSD:<conn_handle>,<start_handle>,<end_handle>,<uuid>This response is sent for each service found.

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
start_handleintegerService start handle.
end_handleintegerService end handle.
uuidbyte_arrayUUID of attribute. Either 16-bit or 128-bit.

6.1.2 AT+UBTGPSDU - GATT Primary Services Discover by UUID

Discovers all primary services by UUID on the remote device.

Syntax

AT Command
Description
AT+UBTGPSDU=<conn_handle>,<uuid>Start discovery.
Response
Description
+UBTGPSDU:<conn_handle>,<start_handle>,<end_handle>This response is sent for each service found.

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
uuidbyte_arrayUUID of attribute. Either 16-bit or 128-bit.
start_handleintegerService start handle.
end_handleintegerService end handle.

6.1.3 AT+UBTGSCD - GATT Service Characteristics Discover

This command will list all characteristics belonging to a service on the GATT server.

Syntax

AT Command
Description
AT+UBTGSCD=<conn_handle>,<start>,<end>Discover all characteristics of a service.
Response
Description
+UBTGSCD:<conn_handle>,<attr_handle>,<properties>,<value_handle>,<uuid>This response is sent for each characteristic found.

Defined values

ParameterTypeDescription
startintegerService start handle.
endintegerService end handle.
attr_handleintegerAttribute handle of the characteristic
propertiesbyte_arrayBit mask describing the properties of the characteristic
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
uuidbyte_arrayUUID of attribute. Either 16-bit or 128-bit.

6.1.4 AT+UBTGCDD - GATT Characteristic Descriptors Discover

Discover Characteristics Descriptors. This command will list all descriptors of a characteristic on the GATT server.

Syntax

AT Command
Description
AT+UBTGCDD=<conn_handle>,<value_handle>,<characteristic_end_handle>Discover all descriptors of a characteristic.
Response
Description
+UBTGCDD:<conn_handle>,<char_handle>,<desc_handle>,<uuid>This response is sent for each descriptor found.

Defined values

ParameterTypeDescription
char_handleintegerCharacteristic handle.
characteristic_end_handleintegerEnd handle of characteristic to which descriptor discovery is being performed.
desc_handleintegerDescriptor handle.
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
uuidbyte_arrayUUID of attribute. Either 16-bit or 128-bit.

6.1.5 AT+UBTGR - GATT Read

Read a characteristic value.

Syntax

AT Command
Description
AT+UBTGR=<conn_handle>,<value_handle>Reads the characteristic; all bytes included.
Response
Description
+UBTGR:<conn_handle>,<value_handle>,<hex_data>Successful read response.

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

6.1.6 AT+UBTGRU - GATT Read characteristic by UUID

Read GATT characteristic values by UUID.

Syntax

AT Command
Description
AT+UBTGRU=<conn_handle>,<start>,<end>,<uuid>Read all the characteristics by UUID. It will read all the bytes in each characteristic.
Response
Description
+UBTGRU:<conn_handle>,<value_handle>,<hex_data>Successful read response.

Defined values

ParameterTypeDescription
startintegerStart handle.
endintegerEnd handle.
conn_handleintegerBluetooth Low Energy connection handle.
uuidbyte_arrayUUID of attribute. Either 16-bit or 128-bit.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

6.1.7 AT+UBTGW - GATT Write

Write a characteristic value.

Syntax

AT Command
Description
AT+UBTGW=<conn_handle>,<value_handle>,<hex_data>Write the characteristic value.

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

6.1.8 AT+UBTGCCW - GATT Client Configuration Write

Write characteristic configuration to enable notifications or indications.

Syntax

AT Command
Description
AT+UBTGCCW=<conn_handle>,<desc_handle>,<config>Writes the client characteristic configuration.

Defined values

ParameterTypeDescription
desc_handleintegerDescriptor handle.
configenumeratorValid values:
0: None
1: Enable notifications
2: Enable indications
3: Enable notifications and indications
conn_handleintegerBluetooth Low Energy connection handle.

6.1.9 AT+UBTGWNR - GATT Write with No Response

Write the characteristic with no response message from the remote side.

Syntax

AT Command
Description
AT+UBTGWNR=<conn_handle>,<value_handle>,<hex_data>Write characteristic.

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

6.1.10 AT+UBTGWL - GATT Write long

Write a long characteristic.

Syntax

AT Command
Description
AT+UBTGWL=<conn_handle>,<value_handle>,<hex_data>,<reliable>,<flag>,<offset>Write long characteristic.

Defined values

ParameterTypeDescription
reliableenumeratorValid values:
0: Not reliable
1: Reliable
flagenumeratorValid values:
0: Final data
1: More data
2: Cancel
offsetinteger 
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

6.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UEBTGCNGATT Client Notification event
+UEBTGCIGATT Client Indication event

6.2.1 +UEBTGCN - GATT Client Notification event

GATT Client Notification. This event is received when the remote side sends a notification.

Syntax

+UEBTGCN:<conn_handle>,<value_handle>,<hex_data>

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

6.2.2 +UEBTGCI - GATT Client Indication event

GATT Client Indication. This event is received when the remote side sends an indication.

Syntax

+UEBTGCI:<conn_handle>,<value_handle>,<hex_data>

Defined values

ParameterTypeDescription
conn_handleintegerBluetooth Low Energy connection handle.
value_handleintegerAttribute handle of the characteristic value.
hex_databyte_arrayCharacteristic data in hexadecimal form. For example, 070809AABBCC

7 GATT Server

GATT Server

7.1 AT Commands

AT CommandDescription
AT+UBTGSGATT Service define
AT+UBTGCGATT Characteristic define
AT+UBTGHCCGATT Host Controlled Characteristic
AT+UBTGDGATT Descriptor define
AT+UBTGSAGATT Service Activate.
AT+UBTGRRRGATT Read Request Respond
AT+UBTGNSGATT Notification Send
AT+UBTGISGATT Indication Send
AT+UBTGAVGATT Attribute Value
AT+UBTGRRREGATT Read Request Respond with error code
AT+UBTGWREGATT Write Respond with Error code
AT+UBTGWRRGATT Write Request Respond
AT+UBTGSCIGATT Service Changed Indication

7.1.1 AT+UBTGS - GATT Service define

Command to define a GATT service according to a 16-bit Service Assigned Number from Bluetooth SIG or a 128-bit user defined service number.

Syntax

AT Command
Description
AT+UBTGS=<uuid>Defines a service.
Response
Description
+UBTGS:<ser_handle>Successful write response.

Defined values

ParameterTypeDescription
uuidbyte_arrayUUID of service. This can be either 16 bit or 128 bit.
ser_handleintegerHandle of the created service.

7.1.2 AT+UBTGC - GATT Characteristic define

Command to add a GATT characteristic to the most recent GATT service record created with AT+UBTGS.

Syntax

AT Command
Description
AT+UBTGC=<uuid>,<properties>,<security_read>,<security_write>,<value>[,<max_length>]Create a new characteristic in the GATT table for a GATT server. The CCCD for the characteristic, if applicable, is created here. Extended properties such as CPFD, CUDD, and SCCD are not supported.
Response
Description
+UBTGC:<value_handle>,<cccd_handle>Successful write response.

Defined values

ParameterTypeDescription
uuidbyte_arrayUUID of characteristic. This can be either 16 bit or 128 bit.
valuebyte_arrayDefault characteristic value before any value is pushed to it. A characteristic value can be 244 bytes long.
max_lengthintegerMaximum length of the characteristic in bytes. The maximum value is 244 bytes.

Valid values: 1..244

value_handleintegerAdded characteristic handle.
cccd_handleintegerCCCD characteristic handle. This value is zero if there is no CCCD.
propertiesbyte_arrayProperty value (a bit field):
Broadcast: 0x01 - If set, it allows broadcasts of the Characteristic Value using Characteristic Configuration Descriptor.
Read: 0x02 - If set, it allows reads of the Characteristic Value.
Write Without Response: 0x04 - If set, it allows writing of the Characteristic Value without response.
Write: 0x08 - If set, it allows writing of the Characteristic Value with response.
Notify: 0x10 - If set, it allows notifications of a characteristic value.
Indicate: 0x20 - If set, it allows indication of a characteristic value with acknowledgement.
Authenticated Signed Writes: 0x40 - If set, it allows signed writes to the characteristic value.
Reserved Bit: 0x80 - Do not use. Reserved for future use.

Valid length: 1..1

security_readenumeratorValid values:
1: No encryption required.
2: Unauthenticated encryption required.
3: Authenticated encryption required.
security_writeenumeratorValid values:
1: No encryption required.
2: Unauthenticated encryption required.
3: Authenticated encryption required.

7.1.3 AT+UBTGHCC - GATT Host Controlled Characteristic

Create a new host controlled characteristic in the GATT table for a GATT server. The CCCD for the characteristic, if applicable, is created here. Extended properties such as CPFD, CUDD, and SCCD are not supported.

Syntax

AT Command
Description
AT+UBTGHCC=<uuid>,<properties>,<security_read>,<security_write>Define a characteristic.
Response
Description
+UBTGHCC:<value_handle>,<cccd_handle>Successful write response.

Defined values

ParameterTypeDescription
uuidbyte_arrayUUID of characteristic. This can be either 16 bit or 128 bit.
value_handleintegerValue handle of the added characteristic.
cccd_handleintegerClient Characteristic Configuration Descriptor (CCCD) handle of the added characteristic. This value is zero if there is no CCCD.
propertiesbyte_arrayProperty value (a bit field):
Broadcast: 0x01 - If set, it allows broadcasts of the Characteristic Value using Characteristic Configuration Descriptor.
Read: 0x02 - If set, it allows reads of the Characteristic Value.
Write Without Response: 0x04 - If set, it allows writing of the Characteristic Value without response.
Write: 0x08 - If set, it allows writing of the Characteristic Value with response.
Notify: 0x10 - If set, it allows notifications of a characteristic value.
Indicate: 0x20 - If set, it allows indication of a characteristic value with acknowledgement.
Authenticated Signed Writes: 0x40 - If set, it allows signed writes to the characteristic value.
Reserved Bit: 0x80 - Do not use. Reserved for future use.

Valid length: 1..1

security_readenumeratorValid values:
1: No encryption required.
2: Unauthenticated encryption required.
3: Authenticated encryption required.
security_writeenumeratorValid values:
1: No encryption required.
2: Unauthenticated encryption required.
3: Authenticated encryption required.

7.1.4 AT+UBTGD - GATT Descriptor define

Define a vendor defined descriptor. Standard Bluetooth low energy descriptors such as CCCD are created while creating the characteristic in AT+UBTGC command.

Syntax

AT Command
Description
AT+UBTGD=<uuid>,<security_read>,<security_write>,<value>[,<max_length>]Define descriptor.
Response
Description
+UBTGD:<desc_handle>Successful write response.

Defined values

ParameterTypeDescription
uuidbyte_arrayUUID of characteristic. This can be either 16 bit or 128 bit.
valuebyte_arrayDescriptor value. This can be 23 bytes long.
max_lengthintegerMaximum length of the descriptor in bytes. The maximum value is 23 bytes.

Valid values: 1..23

desc_handleintegerHandle of the created descriptor.
security_readenumeratorValid values:
1: No encryption required.
2: Unauthenticated encryption required.
3: Authenticated encryption required.
security_writeenumeratorValid values:
1: No encryption required.
2: Unauthenticated encryption required.
3: Authenticated encryption required.

7.1.5 AT+UBTGSA - GATT Service Activate

Activate the service defined with the AT+UBTGS command. After this command is issued, it is not possible to add more characteristics or descriptors to the service.

Syntax

AT Command
Description
AT+UBTGSAActivate current defined service.

7.1.6 AT+UBTGRRR - GATT Read Request Respond

Respond to an unsolicited request to read (see +UEBTGRR) from a remote GATT client.

Syntax

AT Command
Description
AT+UBTGRRR=<conn_handle>,<value>Responds to read request.

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of the connected device.
valuebyte_arrayCharacteristic value. This can be 244 bytes long.

7.1.7 AT+UBTGNS - GATT Notification Send

Send notifications to a remote client. This also updates the value of the characteristic.

Syntax

AT Command
Description
AT+UBTGNS=<conn_handle>,<char_handle>,<value>Send notification

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of the connected device.
char_handleintegerCharacteristic value handle.
valuebyte_arrayCharacteristic value. The maximum length is the current MTU size - 3.

7.1.8 AT+UBTGIS - GATT Indication Send

Send indication to a remote client. This also updates the value of the characteristic.

Syntax

AT Command
Description
AT+UBTGIS=<conn_handle>,<char_handle>,<value>Send notification

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of the connected device.
char_handleintegerCharacteristic value handle.
valuebyte_arrayCharacteristic value. The maximum length is the current MTU size - 3.

7.1.9 AT+UBTGAV - GATT Attribute Value

Update the value of an attribute. In case of characteristics which allow indications and notifications, this command will update the value without sending any indications or notifications to the remote side.

Syntax

AT Command
Description
AT+UBTGAV=<attr_handle>,<value>Set attribute value.

Defined values

ParameterTypeDescription
attr_handleintegerAttribute handle.
valuebyte_arrayCharacterstic value. This can be 244 bytes long.

7.1.10 AT+UBTGRRRE - GATT Read Request Respond with error code

Respond to read request with application error code.

Syntax

AT Command
Description
AT+UBTGRRRE=<conn_handle>,<error_code>Respond with error code.

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of connected device.
error_codebyte_arrayApplication error code. Allowed value range: 0x80-0x9F

Valid length: 1..1

7.1.11 AT+UBTGWRE - GATT Write Respond with Error code

Respond to write operation with application error code.

Syntax

AT Command
Description
AT+UBTGWRE=<conn_handle>,<error_code>Respond with error code.

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of connected device.
error_codebyte_arrayApplication error code. Allowed value range: 0x80-0x9F

Valid length: 1..1

7.1.12 AT+UBTGWRR - GATT Write Request Respond

Accept write request from GATT client.

Syntax

AT Command
Description
AT+UBTGWRR=<conn_handle>Respond to write request.

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of connected device.

7.1.13 AT+UBTGSCI - GATT Service Changed Indication

Sends an indication to the remote peer client that the attribute table of the local GATT server has changed.

Syntax

AT Command
Description
AT+UBTGSCI=<conn_handle>,<start_handle>,<end_handle>Send Service Changed Indication.

Defined values

ParameterTypeDescription
conn_handleintegerGAP handle of connected device.
start_handleintegerStart of the affected attribute handle range.
end_handleintegerEnd of the affected attribute handle range.

7.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UEBTGCWGATT Client Write event
+UEBTGRRGATT Request to Read event
+UEBTGICGATT Indication Confirmation event

7.2.1 +UEBTGCW - GATT Client Write event

Unsolicited response code for GATT Client. This event occurs when a remote client writes to an attribute.

Syntax

+UEBTGCW:<conn_handle>,<value_handle>,<value>,<options>

Defined values

ParameterTypeDescription
conn_handleintegerGAP connection handle.
value_handleintegerCharacteristic value handle.
valuebyte_arrayThe data as hex string. For example, 070809AABBCC
optionsenumeratorValid values:
0: Write without Response performed
1: Write with Response performed
2: Write long performed

<

7.2.2 +UEBTGRR - GATT Request to Read event

Unsolicited response code for GATT Server. This event occurs when a remote client reads an attribute over the air. The event should be responded with AT+UBTGRR.

Syntax

+UEBTGRR:<conn_handle>,<value_handle>

Defined values

ParameterTypeDescription
conn_handleintegerHandle of the connected device.
value_handleintegerHandle of the characteristic value.

7.2.3 +UEBTGIC - GATT Indication Confirmation event

Unsolicited response code for GATT Server. This event occurs when a remote GATT client acknowledges the receipt of an indication message sent using +UBTGSI.

Syntax

+UEBTGIC:<conn_handle>,<char_handle>

Defined values

ParameterTypeDescription
conn_handleintegerConnected device handle.
char_handleintegerCharacteristic value handle.

8 SPS

SPS - Serial Port Service

8.1 AT Commands

AT CommandDescription
AT+USPSCSPS Connect
AT+USPSSPS - Enable/Disable Service
AT+USPSWSSPS Write String
AT+USPSWBSPS Write Binary
AT+USPSRMSPS Receive Mode
AT+USPSRSSPS Read String
AT+USPSRBSPS Read Binary

8.1.1 AT+USPSC - SPS Connect

SPS connect on connected Bluetooth device

Syntax

AT Command
Description
AT+USPSC=<conn_handle>[,<flow_control>]SPS connect on connected Bluetooth device

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer
flow_controlintegerFlow control: 0 - no flow control, 1 - flow control

8.1.2 AT+USPS - SPS - Enable/Disable Service

Enable or disable the SPS service

Syntax

AT Command
Description
AT+USPS=<sps_service_option>Enables or disable the SPS Service.
AT+USPS?Read if the SPS service is enabled or disabled.
Response
Description
+USPS:<sps_service_option>Successful read response.

Defined values

ParameterTypeDescription
sps_service_optionenumeratorValid values:
0: This option disables the SPS service after saving the configuration and restarting the device. (Default)
1: This option enables the SPS service directly.
If this option is set, and the configuration is saved,
SPS will be enabled after reboot.

8.1.3 AT+USPSWS - SPS Write String

Write to a peer through SPS

Syntax

AT Command
Description
AT+USPSWS=<conn_handle>,<string_data>Write SPS data
Response
Description
+USPSWS:<conn_handle>,<written_length>Successful write response

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer which has SPS enabled
string_datastringData encoded as ascii chars.

Valid length: 1..1000

written_lengthintegerData length that was written.

8.1.4 AT+USPSWB - SPS Write Binary

Syntax

AT Command
Description
AT+USPSWB=<conn_handle><binary_packet>Writes the specified amount of data to the specified SPS connection in binary mode. Max 1000 bytes.
Response
Description
+USPSWB:<conn_handle>,<written_length>Successful write response

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer which has SPS enabled
written_lengthintegerData length that was written.
binary_packetbinaryThe binary packet contains of the binary header (three bytes) and the binary content, see Binary for more information.

8.1.5 AT+USPSRM - SPS Receive Mode

Syntax

AT Command
Description
AT+USPSRM=<read_mode>Set the mode in which to receive SPS data in AT mode.
AT+USPSRM?Read mode set.
Response
Description
+USPSRM:<read_mode>Successful read response.

Defined values

ParameterTypeDescription
read_modeenumeratorModes to read data in AT

Valid values:
0: Buffered mode
1: Direct String mode
2: Direct Binary Mode

8.1.6 AT+USPSRS - SPS Read String

Syntax

AT Command
Description
AT+USPSRS=<conn_handle>,<length>Reads the specified amount of data from given connection handle.
Note that the data should include no null terminator characters.
Response
Description
+USPSRS:<conn_handle>,<length>,<string_data>Successful read response.

Defined values

ParameterTypeDescription
lengthintegerData bytes to read.

Valid values: 0..1000

conn_handleintegerConnection handle of remote peer
string_datastringSPS data in string format

8.1.7 AT+USPSRB - SPS Read Binary

Syntax

AT Command
Description
AT+USPSRB=<conn_handle>,<length>Reads the specified amount of data from the specified connection handle in binary mode.
Response
Description
+USPSRB:<conn_handle>Successful read response.

Defined values

ParameterTypeDescription
lengthintegerData bytes to read.

Valid values: 0..1000

conn_handleintegerConnection handle of remote peer

8.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UESPSCSPS Connection event
+UESPSDCSPS Disconnection event
+UESPSDSSPS Data String event
+UESPSDBSPS Data Binary event
+UESPSDASPS Data Available event

8.2.1 +UESPSC - SPS Connection event

Event response for SPS Connect. Upon a successful SPS connection, conn_handle will contain the connection handle of the remote peer.

Syntax

+UESPSC:<conn_handle>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer

8.2.2 +UESPSDC - SPS Disconnection event

Event response for SPS Connect. Upon a SPS disconnection, conn_handle will contain the connection handle of the remote peer.

Syntax

+UESPSDC:<conn_handle>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer

8.2.3 +UESPSDS - SPS Data String event

Unsolicited event containing SPS data as a string received from remote peer.

Syntax

+UESPSDS:<conn_handle>,<string_data>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer
string_datastringSPS data in string format

8.2.4 +UESPSDB - SPS Data Binary event

Unsolicited event containing SPS data in binary format.

Syntax

+UESPSDB:<conn_handle>

Defined values

ParameterTypeDescription
conn_handleintegerConnection handle of remote peer

8.2.5 +UESPSDA - SPS Data Available event

Unsolicited event containing the number of received bytes to read.

Syntax

+UESPSDA:<conn_handle>,<number_bytes>

Defined values

ParameterTypeDescription
number_bytesintegerNumber of bytes available to read.
conn_handleintegerConnection handle of remote peer

9 Wi-Fi

Wi-Fi Commands

9.1 AT Commands

AT CommandDescription
AT+UWHNWi-Fi Host Name
AT+UWSSEWi-Fi Station Enterprise security
AT+UWSSWi-Fi Security Config
AT+UWSSPWi-Fi Station PEAP security
AT+UWSSWWi-Fi Station Security WPA
AT+UWSSOWi-Fi Station Security Open
AT+UWSCPWi-Fi Station Connection Parameters
AT+UWSIPSWi-Fi Station IP Static configuration
AT+UWSIPDWi-Fi Station IP with DHCP
AT+UWSIPWi-Fi Station IP configuration
AT+UWSCWi-Fi Station Connect
AT+UWSDCWi-Fi Station Disconnect
AT+UWSNSTWi-Fi Station Network Status
AT+UWSSCWi-Fi Station Scan
AT+UWSSTWi-Fi Station Status
AT+UWAPAWi-Fi Access Point Activate
AT+UWAPDWi-Fi Access Point Deactivate
AT+UWAPCPWi-Fi AP Connection Parameters
AT+UWAPSWWi-Fi AP Security WPA
AT+UWAPSOWi-Fi AP Security Open
AT+UWAPSWi-Fi AP Security
AT+UWAPCSWi-Fi Access Point Connected Stations
AT+UWAPNSTWi-Fi Access Point Network Status

9.1.1 AT+UWHN - Wi-Fi Host Name

Set hostname for Wi-Fi interfaces. Note that AP and Station will both use the stored hostname

Syntax

AT Command
Description
AT+UWHN=<host_name>Set the Host Name
AT+UWHN?Reads the current hostname
Response
Description
+UWHN:<host_name>Successful read response

Defined values

ParameterTypeDescription
host_namestringValid length: 0..40

Default value: NORA-W36-xxxxxxxxxxxx where xxxxxxxxxxxx is the Wi-Fi station mac address
If the hostname is set to "" it will be restored to the factory value after reset

9.1.2 AT+UWSSE - Wi-Fi Station Enterprise security

Configure enterprise security. Certificates must be uploaded to the module before being used in this command, see AT+USECUB

Syntax

AT Command
Description
AT+UWSSE=<wlan_handle>,<ca_name>,<client_cert_name>,<client_key_name>Set the EAP-TLS connection parameters to use.

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

ca_namestringName of the certificate authority (CA) certificate to use

Valid length: 1..32

client_cert_namestringName of the client certificate to use

Valid length: 1..32

client_key_namestringName of the private key for client certificate

Valid length: 1..32

9.1.3 AT+UWSS - Wi-Fi Security Config

Read the current security parameter configuration, for Wi-Fi station

Syntax

AT Command
Description
AT+UWSS=<wlan_handle>Get the current Wi-Fi station security config
Response
Description
+UWSS:<wlan_handle>,<security_mode>,<wpa_threshold>Response if security mode is WPA
+UWSS:<wlan_handle>,<security_mode>Response if security mode is Open
+UWSS:<wlan_handle>,<security_mode>,<ca_name>,<client_cert_name>,<client_key_name>Response if security mode is EAP-TLS
+UWSS:<wlan_handle>,<security_mode>,<username>,<ca_name>Response if security mode is PEAP and ca cert is used
+UWSS:<wlan_handle>,<security_mode>,<username>Response if security mode is PEAP and no ca cert is used

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

security_modeenumeratorThe current security mode.

Valid values:
0: Open security
1: WPA security
2: EAP-TLS security
3: PEAP security

wpa_thresholdenumeratorLowest WPA version to connect to

Valid values:
0: Only connect to access points that support WPA2 or up
1: Only connect to access points that support WPA3

Default value: 0

ca_namestringName of the certificate authority (CA) certificate to use

Valid length: 1..32

client_cert_namestringName of the client certificate to use

Valid length: 1..32

client_key_namestringName of the private key for client certificate

Valid length: 1..32

usernamestringUser name for PEAP authentication.

Valid length: 1..31

9.1.4 AT+UWSSP - Wi-Fi Station PEAP security

Configure PEAP security. CA certificate must be uploaded first if used here, see AT+USECUB

Syntax

AT Command
Description
AT+UWSSP=<wlan_handle>,<peap_user>,<peap_password>[,<ca_name>]Set the PEAP connection parameters to use.

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

peap_userstringUser name for PEAP authentication. Could be either only username or username@domain. Use @ as separator

Valid length: 1..31

peap_passwordstringPassword for PEAP authentication.

Valid length: 1..31

ca_namestringName of the certificate authority (CA) certificate to use

Valid length: 1..32

9.1.5 AT+UWSSW - Wi-Fi Station Security WPA

Configure WPA security

Syntax

AT Command
Description
AT+UWSSW=<wlan_handle>,<passphrase>,<wpa_threshold>Set WPA connection parameters to use

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

passphrasestringPassphrase to use for WPA connection

Valid length: 8..63

wpa_thresholdenumeratorLowest WPA version to connect to

Valid values:
0: Only connect to access points that support WPA2 or up
1: Only connect to access points that support WPA3

Default value: 0

9.1.6 AT+UWSSO - Wi-Fi Station Security Open

Configure open security

Syntax

AT Command
Description
AT+UWSSO=<wlan_handle>Sets security to open security

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

9.1.7 AT+UWSCP - Wi-Fi Station Connection Parameters

Syntax

AT Command
Description
AT+UWSCP=<wlan_handle>,<ssid>Sets the connection parameters for the connection.
AT+UWSCP=<wlan_handle>Reads the connection parameters for the connection.
Response
Description
+UWSCP=<wlan_handle>,<ssid>Successful read response

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

ssidstringSSID

Valid length: 0..32

9.1.8 AT+UWSIPS - Wi-Fi Station IP Static configuration

Syntax

AT Command
Description
AT+UWSIPS=<wlan_handle>,<ip_addr>,<subnet_mask>,<gateway>[,<prim_dns>[,<sec_dns>]]Sets ip configuration to use static ip

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

ip_addrip_addrStatic IPv4 address

Default value: 0.0.0.0

subnet_maskip_addrSubnet mask

Default value: 0.0.0.0

gatewayip_addrIPv4 gateway address

Default value: 0.0.0.0

prim_dnsip_addrIPv4 primary dns address

Default value: 0.0.0.0

sec_dnsip_addrIPv4 secondary dns address

Default value: 0.0.0.0

9.1.9 AT+UWSIPD - Wi-Fi Station IP with DHCP

Syntax

AT Command
Description
AT+UWSIPD=<wlan_handle>Sets ip configuration to receive ip address via dhcp

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

9.1.10 AT+UWSIP - Wi-Fi Station IP configuration

Syntax

AT Command
Description
AT+UWSIP=<wlan_handle>Read the current configuration for IP address assignment
Response
Description
+UWSIP:<wlan_handle>,<ip_mode>Response if IP mode is DHCP
+UWSIP:<wlan_handle>,<ip_mode>,<ip_addr>,<subnet_mask>,<gateway>,<prim_dns>,<sec_dns>Response if IP mode is set to be static

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

ip_modeenumeratorIP assignment

Valid values:
0: DHCP
1: Static IP

ip_addrip_addrStatic IPv4 address

Default value: 0.0.0.0

subnet_maskip_addrSubnet mask

Default value: 0.0.0.0

gatewayip_addrIPv4 gateway address

Default value: 0.0.0.0

prim_dnsip_addrIPv4 primary dns address

Default value: 0.0.0.0

sec_dnsip_addrIPv4 secondary dns address

Default value: 0.0.0.0

9.1.11 AT+UWSC - Wi-Fi Station Connect

Syntax

AT Command
Description
AT+UWSC=<wlan_handle>Initiate connection to Wi-Fi network

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

9.1.12 AT+UWSDC - Wi-Fi Station Disconnect

Syntax

AT Command
Description
AT+UWSDCDisconnect from Wi-Fi network

9.1.13 AT+UWSNST - Wi-Fi Station Network Status

Syntax

AT Command
Description
AT+UWSNST=<status_id>Show current status of Wi-Fi station network interface
AT+UWSNST?Show current status of Wi-Fi station network interface
Response
Description
+UWSNST:<status_id>,<status_val>Send for every applicable status

Defined values

ParameterTypeDescription
status_idenumeratorValid values:
0: The current IPv4 address.
1: The current subnet mask
2: The current gateway
3: The current primary DNS server
4: The current secondary DNS server
5: The current IPv6 link local address
status_valip_addrIP address

9.1.14 AT+UWSSC - Wi-Fi Station Scan

Syntax

AT Command
Description
AT+UWSSCInitiate synchronous Wi-Fi scan (will lock AT interface until scan has finished)
AT+UWSSC=<scan_mode>[,<ssid>]Initiate synchronous Wi-Fi scan (will lock AT interface until scan has finished)
Response
Description
+UWSSC:<bssid>,<ssid>,<channel>,<rssi>,<authentication_suites>,<unicast_ciphers>,<group_ciphers>Successful scan response

Defined values

ParameterTypeDescription
scan_modeenumeratorChoose how to scan

Valid values:
0: Active
1: Passive

Default value: Active

bssidmac_addrBSSID
ssidstringSSID

Valid length: 0..32

channelintegerChannel
rssiintegerRSSI
authentication_suitesintegerAuthentication suites. Bit 0 = shared secret, 1 = PSK, 2 = EAP, 3 = WPA, 4 = WPA2, 5 = WPA3
unicast_ciphersintegerunicast ciphers. Bit 0 = WEP64, 1 = WEP128, 2 = TKIP, 3 = AES/CCMP
group_ciphersintegergroup ciphers. Bit 0 = WEP64, 1 = WEP128, 2 = TKIP, 3 = AES/CCMP

9.1.15 AT+UWSST - Wi-Fi Station Status

Syntax

AT Command
Description
AT+UWSST=<wifi_status_id>Read status
AT+UWSSTRead status
Response
Description
+UWSST:<wifi_status_id>,<ssid>Read response for SSID
+UWSST:<wifi_status_id>,<bssid>Read response for BSSID
+UWSST:<wifi_status_id>,<int_val>Read response for Channel, Connection status and RSSI

Defined values

ParameterTypeDescription
ssidstringSSID

Valid length: 0..32

wifi_status_idenumeratorValid values:
0: SSID of the connected AP
1: BSSID of the connected AP
2: Active channel
3: Connection status, 1 = not connected, 2 = Connected
4: RSSI value of the current connection; will return -32768, if not connected.
int_valintegerRSSI, Connection status or Channel
bssidmac_addrBSSID of the connected access point

9.1.16 AT+UWAPA - Wi-Fi Access Point Activate

Syntax

AT Command
Description
AT+UWAPAStart an access point with the current access point configuration.

9.1.17 AT+UWAPD - Wi-Fi Access Point Deactivate

Syntax

AT Command
Description
AT+UWAPDBrings down Wi-Fi access point and disconnect all connected stations

9.1.18 AT+UWAPCP - Wi-Fi AP Connection Parameters

Syntax

AT Command
Description
AT+UWAPCP=<ssid>[,<channel>]Sets connection parameters for the AP configuration
AT+UWAPCP?Read the current connection parameters
Response
Description
+UWAPCP:<ssid>,<channel>Successful read response

Defined values

ParameterTypeDescription
ssidstringSSID

Valid length: 0..32

channelenumeratorchannel

Valid values:
1: 1
2: 2
3: 3
4: 4
5: 5
6: 6
7: 7
8: 8
9: 9
10: 10
11: 11
36: 36
40: 40
44: 44
48: 48

Default value: 6

9.1.19 AT+UWAPSW - Wi-Fi AP Security WPA

Syntax

AT Command
Description
AT+UWAPSW=<passphrase>[,<wpa_version>]Sets WPA parameters for the AP config

Defined values

ParameterTypeDescription
passphrasestringPassphrase to use

Valid length: 8..63

wpa_versionenumeratorValid values:
0: WPA 2

Default value: WPA 2

9.1.20 AT+UWAPSO - Wi-Fi AP Security Open

Syntax

AT Command
Description
AT+UWAPSOSets security level to open for the AP config

9.1.21 AT+UWAPS - Wi-Fi AP Security

Syntax

AT Command
Description
AT+UWAPS?Get the current security configuration for Wi-Fi AP
Response
Description
+UWAPS:<security_mode>,<wpa_version>Response if security mode is WPA
+UWAPS:<security_mode>Response if security mode is Open

Defined values

ParameterTypeDescription
security_modeenumeratorThe current security mode.

Valid values:
0: Open security
1: WPA security
2: EAP-TLS security
3: PEAP security

wpa_versionenumeratorValid values:
0: WPA 2

Default value: WPA 2

9.1.22 AT+UWAPCS - Wi-Fi Access Point Connected Stations

Syntax

AT Command
Description
AT+UWAPCS?Get a list of connected stations. One response will be sent for each connected station
Response
Description
+UWAPCS:<mac>A station that is connected to the access point

Defined values

ParameterTypeDescription
macmac_addrMAC address of the connected Wi-Fi Station

9.1.23 AT+UWAPNST - Wi-Fi Access Point Network Status

Syntax

AT Command
Description
AT+UWAPNST=<status_id>Show current status of Wi-Fi station network interface
AT+UWAPNST?Show current status of Wi-Fi station network interface
Response
Description
+UWAPNST:<status_id>,<status_val>Send for every applicable status

Defined values

ParameterTypeDescription
status_idenumeratorValid values:
0: The current IPv4 address.
1: The current subnet mask
2: The current gateway
3: The current primary DNS server
4: The current secondary DNS server
5: The current IPv6 link local address
status_valip_addrIP address

9.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UEWLUWi-Fi Link Up event
+UEWLDWi-Fi Link Down event
+UEWSNUWi-Fi Station Network Up event
+UEWSNDWi-Fi Station Network Down event
+UEWAPNUWi-Fi Access Point Network Up event
+UEWAPNDWi-Fi Access Point Network Down event
+UEWAPUWi-Fi Access Point Up event
+UEWAPDWi-Fi Access Point Down event
+UEWAPSAWi-Fi AccessPoint Station Associated event
+UEWAPSDAWi-Fi AccessPoint Station Disassociated event

This event is sent when Wi-Fi Link goes up

Syntax

+UEWLU:<wlan_handle>,<bssid>,<channel>

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

channelintegerConnected channel
bssidmac_addrBSSID of the connected access point

This event is sent when Wi-Fi Link goes down

Syntax

+UEWLD:<wlan_handle>,<reason>

Defined values

ParameterTypeDescription
wlan_handleintegerHandle to use for Wi-Fi config and connection

Valid values: 0..0

reasonintegerStandard 802.11 reason codes

9.2.3 +UEWSNU - Wi-Fi Station Network Up event

This event is sent when Wi-Fi Station network is up

Syntax

+UEWSNU

9.2.4 +UEWSND - Wi-Fi Station Network Down event

This event is sent when Wi-Fi Station network is down

Syntax

+UEWSND

9.2.5 +UEWAPNU - Wi-Fi Access Point Network Up event

This event is sent when Wi-Fi Access Point network is up

Syntax

+UEWAPNU

9.2.6 +UEWAPND - Wi-Fi Access Point Network Down event

This event is sent when Wi-Fi Access Point network is down

Syntax

+UEWAPND

9.2.7 +UEWAPU - Wi-Fi Access Point Up event

This event is sent when Wi-Fi Access Point is started

Syntax

+UEWAPU

9.2.8 +UEWAPD - Wi-Fi Access Point Down event

This event is sent when Wi-Fi Access Point is stopped

Syntax

+UEWAPD

9.2.9 +UEWAPSA - Wi-Fi AccessPoint Station Associated event

This event is sent when a Wi-Fi station has associated with the Wi-Fi Access point

Syntax

+UEWAPSA:<mac>

Defined values

ParameterTypeDescription
macmac_addrMac address of the connected Wi-Fi station

9.2.10 +UEWAPSDA - Wi-Fi AccessPoint Station Disassociated event

This event is sent when a Wi-Fi station has disassociated with the Wi-Fi Access point

Syntax

+UEWAPSDA:<mac>

Defined values

ParameterTypeDescription
macmac_addrMAC address of the connected Wi-Fi station

10 Socket

The socket AT commands are used for creating and interfacing TCP/UDP sockets.

10.1 AT Commands

AT CommandDescription
AT+USOCRCreate Socket
AT+USOPCRCreate Persistent Socket
AT+USOTLSSocket TLS
AT+USOCSocket Connect
AT+USOPSocket Persistent
AT+USOPRSocket Persistent Remove
AT+USOPLSocket Persistent List
AT+USORMSocket Receive Mode
AT+USOWSSocket Write String
AT+USOWBSocket Write Binary
AT+USOCLClose socket
AT+USORSRead Socket String
AT+USORBSocket Read Binary
AT+USOESocket Error
AT+USOLSocket Listen
<">AT+USORFSocket Read From
AT+USOPASocket Peer Address
AT+USOSTSocket Status
AT+USOOSocket Options
AT+USOHSocket Host by Name

10.1.1 AT+USOCR - Create Socket

Syntax

AT Command
Description
AT+USOCR=<protocol>[,<preferred_protocol_type>]Creates a socket and associates it with the specified protocol (TCP or UDP).
Response
Description
+USOCR:<socket_handle>Successful creation of socket.

Defined values

ParameterTypeDescription
protocolenumeratorIP protocol.

Valid values:
6: TCP
17: UDP

preferred_protocol_typeenumeratorSelects the IP address type to use.

Valid values:
0: IPv4 address.
1: IPv6 address.

Default value: 0

socket_handleintegerSocket identifier be used for any operation on that socket.

10.1.2 AT+USOPCR - Create Persistent Socket

Syntax

AT Command
Description
AT+USOPCR=<protocol>[,<preferred_protocol_type>]Creates a persistent socket and associates it with the specified protocol (TCP or UDP).
A persistent socket will automatically re-connect when connection is lost.
It can also be stored so that the connection initiated on boot.

Note: Only TCP client supported for persistent sockets.

Response
Description
+USOPCR:<socket_handle>Successful creation of persistent socket.

Defined values

ParameterTypeDescription
protocolenumeratorIP protocol.

Valid values:
6: TCP
17: UDP

preferred_protocol_typeenumeratorSelects the IP address type to use.

Valid values:
0: IPv4 address.
1: IPv6 address.

Default value: 0

socket_handleintegerSocket identifier be used for any operation on that socket.

10.1.3 AT+USOTLS - Socket TLS

Syntax

AT Command
Description
AT+USOTLS=<socket_handle>,<tls_version>[,<ca_name>[,<client_cert_name>,<client_key_name>]]Add a TLS context to a socket. This is only valid for TCP client sockets.

Defined values

ParameterTypeDescription
tls_versionenumeratorMinimum TLS version to use

Valid values:
0: Disable TLS<
1: 1: TLS 1.2 or up

ca_namestringName of the certificate authority (CA) certificate to use

Valid length: 1..32

client_cert_namestringName of the client certificate to use

Valid length: 1..32

client_key_namestringName of the private key for client certificate

Valid length: 1..32

socket_handleintegerSocket identifier be used for any operation on that socket.

10.1.4 AT+USOC - Socket Connect

For a TCP socket, this command will perform the TCP negotiation (3-way handshake) to open a connection and for a UDP socket this command will just declare the remote host address and port for later use with other socket operations.

Syntax

AT Command
Description
AT+USOC=<socket_handle>,<host_address>,<remote_port>Establish a peer-to-peer connection to the specified remote host on the given remote port.

Defined values

ParameterTypeDescription
host_addressstringRemote host IP address or domain name of the remote host.

Valid length: 0..128

socket_handleintegerSocket identifier be used for any operation on that socket.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

Notes

This command is non-blocking by default (can be configured with AT+USOO).

Notes for TCP sockets:
When socket is non-blocking (default), a connection is not fully set up until +UESOC URC is received.

Notes for UDP sockets:
Errors will not be reported prior to an attempt to write or read data on the socket.
Since UDP is connectionless no +UESOC event will be sent, instead as soon as this command return OK the socket is ready for reading/writing data.

10.1.5 AT+USOP - Socket Persistent

Syntax

AT Command
Description
AT+USOP=<socket_handle>,<host_address>,<remote_port>Configure a TCP link with automatic re-connection. As opposed to AT+USOC, this command will not initiate
a connection directly but is used for configuring a link that is automatically setup on boot.

Defined values

ParameterTypeDescription
host_addressstringRemote host IP address or domain name.

Valid length: 0..128

socket_handleintegerSocket identifier be used for any operation on that socket.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

Example

Example of setting up a persistent TCP client connection that is loaded on boot:
AT+USOCR=6,0
AT+USOP=0,192.168.0.10,30123
AT&W
AT+CPWROFF
Please note that WiFi must also be setup.

Notes

In order for the command to have any effect you must execute AT&W after the AT+USOP command.

Only one configuration is supported at the moment.

Only TCP client is supported at the moment.

10.1.6 AT+USOPR - Socket Persistent Remove

Syntax

AT Command
Description
AT+USOPR=<config_id>Removes an persistent socket configuration created by AT+USOPCR.

Defined values

ParameterTypeDescription
config_idintegerConfiguration ID

Notes

The corresponding socket will be automatically closed.

10.1.7 AT+USOPL - Socket Persistent List

Syntax

AT Command
Description
AT+USOPL?List all persistent socket configurations.
Response
Description
+USOPL:<socket_handle>,<host_address>,<remote_port>The response for each persistent configuration.

Defined values

ParameterTypeDescription
config_idintegerConfiguration ID.
host_addressstringRemote host IP address or domain name of the remote host.

Valid length: 0..128

socket_handleintegerSocket identifier be used for any operation on that socket.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

10.1.8 AT+USORM - Socket Receive Mode

Syntax

AT Command
Description
AT+USORM=<read_mode>Set the mode in which you would like to receive data in AT mode.
NOTE: Any created sockets or created persistent sockets will use the same receive mode as was configured when they were created
AT+USORM?Read the current receive mode
Response
Description
+USORM:<read_mode>Successful read response

Defined values

ParameterTypeDescription
read_modeenumeratorModes to read data in AT

Valid values:
0: Buffered mode
1: Direct String mode
2: Direct Binary Mode

10.1.9 AT+USOWS - Socket Write String

Syntax

AT Command
Description
AT+USOWS=<socket_handle>,<string_data>Writes string data to the specified socket.
The command can be used for both TCP and UDP sockets after calling AT+USOC.
If socket is not ready to be written, generic negative error will be returned.
Check BSD errno (see BSD standard) by calling AT+USOE.
Response
Description
+USOWS:<socket_handle>,<written_length>Successful write response.

Defined values

ParameterTypeDescription
written_lengthintegerData length that was written.
socket_handleintegerSocket identifier be used for any operation on that socket.
string_datastringData encoded as ascii chars.

Valid length: 0..1000

Notes

This command is non-blocking.

The command may respond writing less data than what was passed to the command.
This means that the socket transmit buffer is currently full and data not successfully written must be retransmitted later.

10.1.10 AT+USOWB - Socket Write Binary

Syntax

AT Command
Description
AT+USOWB=<socket_handle>Writes binary data to the specified socket in binary mode.
Response
Description
+USOWB:<socket_handle>,<written_length>Successful write response.

Defined values

ParameterTypeDescription
written_lengthintegerData length that was actually written to socket.
socket_handleintegerSocket identifier be used for any operation on that socket.

Notes

This command is non-blocking.

The command may respond writing less data than what was passed to the command.
This means that the socket transmit buffer is currently full and data not successfully written must be retransmitted later.

10.1.11 AT+USOCL - Close socket

Syntax

AT Command
Description
AT+USOCL=<socket_handle>Closes the specified socket.

The command blocks the AT command interface until the completion of the socket close operation.
When this function returns OK the socket is cleaned up and fully closed.

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier to be used for any future operation on that socket.

10.1.12 AT+USORS - Read Socket String

Syntax

AT Command
Description
AT+USORS=<socket_handle>,<length>Reads the specified amount of data from the specified socket.
Note that the data should include no null terminator characters.
Response
Description
+USORS:<socket_handle>,<length>,<string_data>Successful read response.

Defined values

ParameterTypeDescription
lengthintegerNumber of bytes to read.

Valid values: 1..1000

socket_handleintegerSocket identifier be used for any operation on that socket.
string_datastringData encoded as ascii chars.

Valid length: 0..1000

Notes

This command is non-blocking.

10.1.13 AT+USORB - Socket Read Binary

Syntax

AT Command
Description
AT+USORB=<socket_handle>,<length>Reads the specified amount of data from the specified socket in binary mode.
Response
Description
+USORB:<socket_handle>Successful read response.

Defined values

ParameterTypeDescription
lengthintegerNumber of bytes to read.

Valid values: 1..1000

socket_handleintegerSocket identifier be used for any operation on that socket.

10.1.14 AT+USOE - Socket Error

Syntax

AT Command
Description
AT+USOERetrieves the last error that occurred in any socket operation, stored in the socket errno.
Response
Description
+USOE:<error_code>Successful response.

Defined values

ParameterTypeDescription
error_codeintegerBSD error code. See BSD standard for error code definitions.

10.1.15 AT+USOL - Socket Listen

Syntax

AT Command
Description
AT+USOL=<socket_handle>,<port>Sets the specified socket in listening mode on the specified port of service, waiting for incoming connections (TCP) or data (UDP).

Defined values

ParameterTypeDescription
portintegerPort of service, range 1-65535. Port numbers below 1024 are not recommended since they are usually reserved

Valid values: 1..65535

socket_handleintegerSocket identifier be used for any operation on that socket.

Notes

For TCP sockets this command corresponds to BSD bind + listen and for UDP sockets BSD bind.

10.1.16 AT+USORF - Socket Read From

Syntax

AT Command
Description
AT+USORF=<socket_handle>,<length>Reads the specified amount of data from the specified UDP socket.
Response
Description
+USORF:<socket_handle>,<remote_ip>,<remote_port>,<length>,<string_data>Successful read response.

Defined values

ParameterTypeDescription
lengthintegerNumber of bytes to read.

Valid values: 1..900

socket_handleintegerSocket identifier be used for any operation on that socket.
remote_ipip_addrThe ip address of the remote peer.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

string_datastringData encoded as ascii chars.

Valid length: 0..1000

10.1.17 AT+USOPA - Socket Peer Address

Syntax

AT Command
Description
AT+USOPA=<socket_handle>Get the address of remote peer.
Response
Description
+USOPA:<socket_handle>,<remote_ip>,<remote_port>Successful read response.

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.
remote_ipip_addrThe ip address of the remote peer.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

10.1.18 AT+USOST - Socket Status

Syntax

AT Command
Description
AT+USOST?List status for all created sockets.
AT+USOST=<socket_handle>Get the status of a specific socket.
Response
Description
+USOST:<socket_handle>,<protocol>,<socket_status>Response for each created socket.

Defined values

ParameterTypeDescription
socket_statusenumeratorValid values:
0: Not Connected
1: Listening
2: Connected
socket_handleintegerSocket identifier be used for any operation on that socket.
protocolenumeratorIP protocol.

Valid values:
6: TCP
17: UDP

10.1.19 AT+USOO - Socket Options

Syntax

AT Command
Description
AT+USOO=<socket_handle>,<option>,<value>Set a socket option. See available options below.
AT+USOO=<socket_handle>,<option>Read a socket option for a socket
Response
Description
+USOO:<socket_handle>,<option>,<value>Successful read response

Defined values

ParameterTypeDescription
optionenumeratorAvailable options to set

Valid values:
0: Turn on/off No delay feature for TCP sockets.
Integer flag: 0 = off (i.e. Nagle algorithm enabled), 1 = on (i.e. Nagle algorithm disabled)
Default: to 0

1: Set socket to be blocking or non blocking.
Integer flag: 0 = off, 1 = on.
Sockets are non-blocking by default (Note that read/write will always be non-blocking).
Can only be set while the socket is in a non connected state.
Note: Only valid for non-persistent TCP sockets, will have no effect on UDP sockets

2: Keep connections alive by sending keepalive probes.
Integer flag: 0 = off, 1 = on.
To calculate the keepalive time us this formula KeepIdle + (KeepIntvl * KeepCnt).
Defaults to 1.
Note: Only valid for TCP sockets.

3: Set Keep Idle value for the socket.
This specifies the amount of time (in sec) that the connection must be idle before sending keepalive probes (if keepalive is enabled).
Defaults to 3.
Note: Only valid for TCP sockets.

4: Set keep alive interval value for the socket. This is the time in seconds between two successive keepalive retransmissions.
Defaults to 3.
Note: Only valid for TCP sockets.

5: Set keep alive counter value for the socket.
The number of unanswered probes required to force closure of the socket.
Defaults to 3.
Note: Only valid for TCP sockets.

valueintegerSee option parameter
socket_handleintegerSocket identifier be used for any operation on that socket.

10.1.20 AT+USOH - Socket Host by Name

Syntax

AT Command
Description
AT+USOH=<host_name>Does a DNS lookup of a host name and returns the IP address.
Response
Description
+USOH:<host_ip>Successful read response.

Defined values

ParameterTypeDescription
host_namestringName to lookup.

Valid length: 0..128

host_ipip_addrThe ip address of the host.

10.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UESOCSocket Connection event
+UESODASocket Data Available event
+UESODSSocket Data String event
+UESODSFSocket Data String From event
+UESODBSocket Data Binary event
+UESODBFSocket Data Binary From event
+UESOCLSocket Closed event
+UESOICSocket Incoming Connection event

10.2.1 +UESOC - Socket Connection event

Event is sent out after a successful connection to a remote peer.

Syntax

+UESOC:<socket_handle>

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.

Notes

TCP only.

10.2.2 +UESODA - Socket Data Available event

Data is available to be read. This will be sent ou when using the buffered data mode.

Syntax

+UESODA:<socket_handle>,<number_bytes>

Defined values

ParameterTypeDescription
number_bytesintegerNumber of bytes available to read. If socket is a UDP socket this number refers to the size of the next datagram.
socket_handleintegerSocket identifier be used for any operation on that socket.

10.2.3 +UESODS - Socket Data String event

Incoming on TCP socket data represented as a string.

Syntax

+UESODS:<socket_handle>,<string_data>

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.
string_datastringData encoded as ascii chars.

Valid length: 0..1000

10.2.4 +UESODSF - Socket Data String From event

Incoming on UDP socket data represented as a string.

Syntax

+UESODSF:<socket_handle>,<remote_ip>,<remote_port>,<string_data>

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.
remote_ipip_addrThe ip address of the remote peer.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

string_datastringData encoded as ascii chars.

Valid length: 0..1000

10.2.5 +UESODB - Socket Data Binary event

Incoming on TCP socket data represented as binary data.

Syntax

+UESODB:<socket_handle>

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.

10.2.6 +UESODBF - Socket Data Binary From event

Incoming on UDP socket data represented as binary data.

Syntax

+UESODBF:<socket_handle>,<remote_ip>,<remote_port>

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.
remote_ipip_addrThe ip address of the remote peer.
remote_portintegerThe port of the remote peer.

Valid values: 1..65535

10.2.7 +UESOCL - Socket Closed event

Event is sent out either when a socket was closed (by the remote or timed out) or when a connection to a remote peer has failed.
When this event is sent out the socket has been fully closed and the handle can be re-used.

Syntax

+UESOCL:<socket_handle>

Defined values

ParameterTypeDescription
socket_handleintegerSocket identifier be used for any operation on that socket.

Notes

If there are unread data available, this event will not be sent out until all data has been read.

10.2.8 +UESOIC - Socket Incoming Connection event

This event is sent when there is an incoming connection for a server socket.

Syntax

+UESOIC:<socket_handle>,<remote_ip>,<listening_socket_handle>

Defined values

ParameterTypeDescription
listening_socket_handleintegerThe handle of the new connected socket. Use this for any further operations on the connection.
socket_handleintegerSocket identifier be used for any operation on that socket.
remote_ipip_addrThe ip address of the remote peer.

11 MQTT

MQTT Commands

11.1 AT Commands

AT CommandDescription
AT+UMQCPMQTT Connection Parameters
AT+UMQCMQTT Connect to Broker
<">AT+UMQKAMQTT Keep Alive
AT+UMQLWTMQTT Last Will and Testament
AT+UMQTLSMQTT TLS Configuration
AT+UMQDCMQTT Disconnect
AT+UMQPSMQTT Publish String
AT+UMQPBMQTT Publish Binary
AT+UMQSMQTT Subscribe
AT+UMQRSMQTT Read String
AT+UMQRBMQTT Read Binary

11.1.1 AT+UMQCP - MQTT Connection Parameters

Syntax

AT Command
Description
AT+UMQCP=<mqtt_id>,<hostname>,<port>[,<client_id>[,<username>[,<password>]]]Set the MQTT login parameters.
Note that empty strings for username and password mean they will not be used during the connection.
AT+UMQCP=<mqtt_id>Get the MQTT login parameters.
Note that empty strings for username and password mean they will not be used during the connection.
Response
Description
+UMQCP:<mqtt_id>,<hostname>,<port>,<client_id>,<username>Successful read response

Defined values

ParameterTypeDescription
hostnamestringHostname or IP address of the broker

Valid length: 0..128

portintegerThe port of the broker

Valid values: 1..65535

client_idstringClient ID. Can be left empty to let the broker decide

Valid length: 0..128

usernamestringValid length: 0..128
passwordstringValid length: 0..128
mqtt_idintegerMQTT Config ID

Valid values: 0..0

11.1.2 AT+UMQC - MQTT Connect to Broker

Syntax

AT Command
Description
AT+UMQC=<mqtt_id>Connect to a broker using the MQTT config ID.

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

11.1.3 AT+UMQKA - MQTT Keep Alive

Syntax

AT Command
Description
AT+UMQKA=<mqtt_id>,<keep_alive>Set keepalive timeout for MQTT the MQTT config
AT+UMQKA=<mqtt_id>Get keepalive timeout for MQTT config
Response
Description
+UMQKA:<mqtt_id>,<keep_alive>Successful read response

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

keep_aliveintegerMQTT keepalive in seconds. If set to 0, no keepalive is used

Valid values: 0..65535

Default value: 60

11.1.4 AT+UMQLWT - MQTT Last Will and Testament

Syntax

AT Command
Description
AT+UMQLWT=<mqtt_id>,<topic>,<will_msg>[,<qos>[,<retain>]]Add last will and testament configuration for the client
AT+UMQLWT=<mqtt_id>Get last will and testament configuration for the client
Response
Description
+UMQLWT<mqtt_id>,<topic>,<will_msg>,<qos>,<retain>Successful read response

Defined values

ParameterTypeDescription
will_msgstringValid length: 0..256
mqtt_idintegerMQTT Config ID

Valid values: 0..0

topicstringTopic name or filter (wildcard allowed)

Valid length: 0..256

qosenumeratorQuality of Service (QoS) for the message or topic

Valid values:
0: At most once
1: At least once
2: Exactly once

Default value: 0

retainenumeratorRetain flag for message

Valid values:
0: Do not retain message on broker
1: Retain message on broker

Default value: 0

11.1.5 AT+UMQTLS - MQTT TLS Configuration

Syntax

AT Command
Description
AT+UMQTLS=<mqtt_id>,<tls_version>,<ca_name>[,<client_cert_name>,<client_key_name>]Setup MQTT TLS config. Certs do not have to be uploaded until connection.
AT+UMQTLS=<mqtt_id>Get TLS config
Response
Description
+UMQTLS:<mqtt_id>,<tls_version>,<ca_name>,<client_cert_name>,<client_key_name>Successful read response

Defined values

ParameterTypeDescription
tls_versionenumeratorMinimum TLS version to use

Valid values:
0: Disable TLS
1: TLS 1.2 or up

ca_namestringName of the certificate authority (CA) certificate to use

Valid length: 1..32

client_cert_namestringName of the client certificate to use

Valid length: 1..32

client_key_namestringName of the private key for client certificate

Valid length: 1..32

mqtt_idintegerMQTT Config ID

Valid values: 0..0

11.1.6 AT+UMQDC - MQTT Disconnect

Syntax

AT Command
Description
AT+UMQDC=<mqtt_id>Disconnect the MQTT client from the broker.
Note that the disconnection is not complete until the +UEMQDC URC arrives.

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

11.1.7 AT+UMQP - MQTT Publish String

Syntax

AT Command
Description
AT+UMQPS=<mqtt_id>,<qos>,<retain>,<topic>,<message>Publish an MQTT message in string format to the specified topic.

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

qosenumeratorQuality of Service (QoS) for the message or topic

Valid values:
0: At most once
1: At least once
2: Exactly once

Default value: 0

retainenumeratorRetain flag for message

Valid values:
0: Do not retain message on broker
1: Retain message on broker

Default value: 0

topicstringTopic name or filter (wildcard allowed)

Valid length: 0..256

messagestringMQTT message

Valid length: 0..730

11.1.8 AT+UMQPB - MQTT Publish Binary

Syntax

AT Command
Description
AT+UMQPB=<mqtt_id>,<qos>,<retain>,<topic>Publish an MQTT message in binary format to the specified topic.

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

qosenumeratorQuality of Service (QoS) for the message or topic

Valid values:
0: At most once
1: At least once
2: Exactly once

Default value: 0

retainenumeratorRetain flag for message

Valid values:
0: Do not retain message on broker
1: Retain message on broker

Default value: 0

topicstringTopic name or filter (wildcard allowed)

Valid length: 0..256

11.1.9 AT+UMQS - MQTT Subscribe

Syntax

AT Command
Description
AT+UMQS=<mqtt_id>,<subscribe_action>,<topic>[,<qos>]Subscribe or unsubscribe to/from MQTT topic.

Defined values

ParameterTypeDescription
subscribe_actionenumeratorValid values:
0: Subscribe to topic
1: Unsubscribe from topic
mqtt_idintegerMQTT Config ID

Valid values: 0..0

topicstringTopic name or filter (wildcard allowed)

Valid length: 0..256

qosenumeratorQuality of Service (QoS) for the message or topic

Valid values:
0: At most once
1: At least once
2: Exactly once

Default value: 0

11.1.10 AT+UMQRS - MQTT Read String

Syntax

AT Command
Description
AT+UMQRS=<mqtt_id>Read available MQTT message in string format.
Response
Description
+UMQRS:<mqtt_id>,<topic>,<message_len>,<message>Successful read response

Defined values

ParameterTypeDescription
num_unreadintegerNumber of available MQTT messages
mqtt_idintegerMQTT Config ID

Valid values: 0..0

topicstringTopic name or filter (wildcard allowed)

Valid length: 0..256

message_lenintegerLength of the MQTT message
messagestringMQTT message

Valid length: 0..730

11.1.11 AT+UMQRB - MQTT Read Binary

Syntax

AT Command
Description
AT+UMQRB=<mqtt_id>Read available MQTT message in binary format.
Response
Description
+UMQRB:<mqtt_id>,<topic>,<message_len>Successful read response

Defined values

ParameterTypeDescription
num_unreadintegerNumber of available MQTT messages
mqtt_idintegerMQTT Config ID

Valid values: 0..0

topicstringTopic name or filter (wildcard allowed)

Valid length: 0..256

message_lenintegerLength of the MQTT message

11.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UEMQCMQTT Connected event
+UEMQDCMQTT Disconnected event
+UEMQDAMQTT Data Available event

11.2.1 +UEMQC - MQTT Connected event

Connected to MQTT broker

Syntax

+UEMQC:<mqtt_id>

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

11.2.2 +UEMQDC - MQTT Disconnected event

Disconnected from MQTT Broker

Syntax

+UEMQDC:<mqtt_id>,<disconnect_reason>

Defined values

ParameterTypeDescription
disconnect_reasonintegerDisconnection reason
mqtt_idintegerMQTT Config ID

Valid values: 0..0

11.2.3 +UEMQDA - MQTT Data Available event

Syntax

+UEMQDA:<mqtt_id>,<message_len>

Defined values

ParameterTypeDescription
mqtt_idintegerMQTT Config ID

Valid values: 0..0

message_lenintegerLength of the MQTT message

12 Security

Security AT commands

12.1 AT Commands

AT CommandDescription
AT+USECRSecurity Certificate Remove
AT+USECUBSecurity Certificate Upload Binary
AT+USECLSecurity Certificates List
AT+USETESecurity TLS Extensions
AT+USETE0Security TLS Extensions Server Name Indication
AT+USETE1Security TLS Extensions Handshake Fragmentation

12.1.1 AT+USECR - Security Certificate Remove

Syntax

AT Command
Description
AT+USECR=<cert_type>,<name>Remove a single X.509 certificate or private key.
AT+USECRRemove all X.509 certificates and private keys.

Defined values

ParameterTypeDescription
cert_typeenumeratorValid values:
0: Root certificate
1: Client certificate
2: Client private key
namestringValid length: 1..32

12.1.2 AT+USECUB - Security Certificate Upload Binary

Syntax

AT Command
Description
AT+USECUB=<cert_type>,<name>[,<password>]Write an X.509 certificate or private key using binary transfer.

Defined values

ParameterTypeDescription
cert_typeenumeratorValid values:
0: Root certificate
1: Client certificate
2: Client private key
namestringValid length: 1..32
passwordstringDecryption password; applicable only for PKCS8 encrypted client private keys. The maximum length is 64 characters.
NOTE: Supported Encryption method for private keys is AES only

Valid length: 1..64

Notes

Note that the size of the certificate can be maximum 15360 bytes and that maximum 8 certs (or cert chains) can be stored simultaneously

12.1.3 AT+USECL - Security Certificates List

Syntax

AT Command
Description
AT+USECL?Read all uploaded certificate names
Response
Description
+USECL:<cert_type>,<name>Successful read response. Note that there will be one response per certificate

Defined values

ParameterTypeDescription
cert_typeenumeratorValid values:
0: Root certificate
1: Client certificate
2: Client private key
namestringValid length: 1..32

12.1.4 AT+USETE - Security TLS Extensions

Syntax

AT Command
Description
AT+USETE?Read all TLS extension settings
Response
Description
+USETE:<extension>,<enabled>Successful read response

Defined values

ParameterTypeDescription
extensionenumeratorValid values:
0: Server Name Extension
1: Handshake fragmentation
enabledenumeratorValid values:
0: Disabled
1: Enabled

12.1.5 AT+USETE0 - Security TLS Extensions Server Name Indication

Syntax

AT Command
Description
AT+USETE0=<enabled>Turn Server Name Indication TLS extension on and off on a system level
AT+USETE0?Read Server Name Indication setting
Response
Description
+USETE0:<enabled>Successful read response

Defined values

ParameterTypeDescription
enabledenumeratorValid values:
0: Disabled
1: Enabled

12.1.6 AT+USETE1 - Security TLS Extensions Handshake Fragmentation

Syntax

AT Command
Description
AT+USETE1=<enabled>Turn Handshake Fragmentation TLS extension on and off on a system level
AT+USETE1?Read Handshake Fragmentation setting
Response
Description
+USETE1:<enabled>Successful read response

Defined values

ParameterTypeDescription
enabledenumeratorValid values:
0: Disabled
1: Enabled

13 Power

13.1 AT Commands

AT CommandDescription
AT+UPMDSPower Management Deep Sleep
AT+UPMPSLPower Management Power Save Level

13.1.1 AT+UPMDS - Power Management Deep Sleep

Syntax

AT Command
Description
AT+UPMDSEnter Deep Sleep Mode.

13.1.2 AT+UPMPSL - Power Management Power Save Level

Syntax

AT Command
Description
AT+UPMPSL=<level>Set Power Save Level.

Defined values

ParameterTypeDescription
levelintegerPower save level

Valid values: 0..2

14 Transparent

Transparent Mode AT commands. In transparent mode all data that is sent from the host to the UART is
forwarded to the socket or SPS link that is configured for transparent mode, and the all data that arrives
on this link is sent to the UART.
Transparent mode is limited to one link at a time.

14.1 AT Commands

AT CommandDescription
AT+UTMTransparent Mode
AT+UTMPTransparent Mode Persistent
AT+UTMPCTransparent Mode Persistent Clear

14.1.1 AT+UTM - Transparent Mode

Use this command to directly switch to transparent mode for a specific SPS link or a socket.

Syntax

AT Command
Description
AT+UTM=<link_type>,<handle>Enter Transparent Mode

Defined values

ParameterTypeDescription
handleintegerFor SPS links, set this to the connection handle
For sockets, set this to the socket handle
link_typeenumeratorValid values:
0: BLE SPS Link
1: Socket

14.1.2 AT+UTMP - Transparent Mode Persistent

This command is used for automatically setting up a transparent mode connection on boot.

Syntax

AT Command
Description
AT+UTMP=<link_type>,<config_id>Set persistent transparent mode for link
AT+UTMP?Get current persistent transparent mode configuration
Response
Description
+UTMP:<link_type_read>,<config_id>Successful read response.

Defined values

ParameterTypeDescription
config_idintegerFor SPS, set this to the config_id returned by AT+UBTP
For sockets, set this to the config_id returned by AT+USOP
link_typeenumeratorValid values:
0: BLE SPS Link
1: Socket
link_type_readenumeratorValid values:
-1: No link type set
0: BLE SPS Link
1: Socket

14.1.3 AT+UTMPC - Transparent Mode Persistent Clear

Clears the persistent link configuration for transparent mode.

Syntax

AT Command
Description
AT+UTMPCClears persistent transparent mode settings

15 Diagnostics

Diagnostics Tools

15.1 AT Commands

AT CommandDescription
AT+UDGPDiagnostics Ping
AT+UDGSPStop an ongoing Ping
AT+UDGIDiagnostics Iperf

15.1.1 AT+UDGP - Diagnostics Ping

Send a ping command.

Syntax

AT Command
Description
AT+UDGP=<destination>[,<count>]Sends a ping command to a destination address every second, repeating it (count) times.

Defined values

ParameterTypeDescription
destinationstringDestination host to send a ping call to in the form of an IPv4 address (i.e. 192.168.1.10) or hostname (i.e. www.u-blox.com).

Valid length: 4..80

countintegerThe number of pings (or packets) that will be transmitted. 0 means ping continuously.

Valid values: 0..65535

Default value: 4

15.1.2 AT+UDGSP - Stop an ongoing Ping

Syntax

AT Command
Description
AT+UDGSPThis command will stop any ping in progress.
Please note the command is asynchronous, and the ping will not be interrupted immediately,
but right after the next ping packet has a response, which might take a few seconds if the packet response times out.
This command always returns OK and does nothing if there is no ping in progress.

15.1.3 AT+UDGI - Diagnostics Iperf

Syntax

AT Command
Description
AT+UDGI=<iperf_action>,<protocol_type>[,<role>,<port>,<report_interval>[,<time_boundary>,<ip_addr>[,<length>[,<bandwidth>[,<bidirectional>]]]]]Start/stop IPERF 2 server/client

Defined values

ParameterTypeDescription
iperf_actionenumeratorAction

Valid values:
1: Start iperf
2: Stop iperf

protocol_typeenumeratorIP protocol

Valid values:
1: TCP
2: UDP

roleenumeratorRole

Valid values:
1: Server
2: Client

portintegerPort
report_intervalintegerReport interval
time_boundaryintegerTime boundary. Client only. Ignored if role is server
ip_addrip_addrIP address to connect to. Client only. Ignored if role is server
bandwidthintegerBandwidth to be used for UDP
lengthintegerSize of packets.

Valid values: 1..1460

Default value: 1460

bidirectionalenumeratorBidirectional flag. Client only. Ignored if role is server

Valid values:
0: Off
1: On
When starting bidirectional TCP test, start a server on both tester and DUT, then start a client with bidirectional flag on the DUT.
If doing bidirectional UDP test, start a server on both DUT and tester and then start a client with a bidirectional flag on both.

15.2 Unsolicited Response Codes

Unsolicited Response CodeDescription
+UEDGPCPing Complete event
+UEDGPPing Response event
+UEDGIIperf output event

15.2.1 +UEDGPC - Ping Complete event

Event is sent out with a summary of the ping results after all packets are transmitted.

Syntax

+UEDGPC:<transmitted_packets>,<received_packets>,<packet_loss_rate>,<avg_response_time>

Defined values

ParameterTypeDescription
transmitted_packetsintegerTotal number of packets transmitted successfully.
received_packetsintegerTotal number of packets received successfully.
packet_loss_rateintegerPacket loss rate in percentage between transmitted and received packets.
avg_response_timeintegerAverage ping response time in milliseconds.

15.2.2 +UEDGP - Ping Response event

Event is sent out when a single ping has a result.

Syntax

+UEDGP:<ping_response>,<response_time>

Defined values

ParameterTypeDescription
ping_responseenumeratorPing Response result. 0 - ping failed, 1 - ping successful

Valid values:
0: Ping failed.
1: Ping succeeded.

response_timeintegerPing response time in milliseconds.

15.2.3 +UEDGI - Iperf output event

Event is sent out for all output string send by iperf tool

Syntax

+UEDGI:<iperf_output>

Defined values

ParameterTypeDescription
iperf_outputstringIperf readable output string

Valid length: 0..99