Generic AT commands

The following commands list contains generic AT commands.

SLM version #XSLMVER

The #XSLMVER command requests the SLM version.

Set command

The set command requests the SLM version.

Syntax

#XSLMVER

Response syntax

#XSLMVERSION: <version>

The <version> value returns a string containing the SLM version.

Example

The following command example reads the SLM version:

AT#XSLMVER
#XSLMVER: 1.2
OK

Read command

The read command is not supported.

Test command

The test command is not supported.

SLM proprietary command list #XCLAC

The #XCLAC command requests the list of the proprietary SLM commands.

Set command

The set command requests the list of the proprietary SLM commands. It is an add-on for AT+CLAC, which lists all modem AT commands.

Syntax

#XCLAC

Response syntax

<command list>

The <command list> value returns a list of values representing all the #X* commands followed by <CR><LF>.

Example

at#xclac
AT#XSLMVER
AT#XSLEEP
AT#XCLAC
AT#XSOCKET
AT#XBIND
AT#XCONNECT
AT#XSEND
AT#XRECV
AT#XSENDTO
AT#XRECVFROM
AT#XPING
AT#XGPS
OK

Read command

The read command is not supported.

Test command

The test command is not supported.

Power saving #XSLEEP

The #XSLEEP command makes the nRF9160 System in Package (SiP) enter idle or sleep mode.

If you want to do power measurements on the nRF9160 development kit while running the SLM application, disable unused peripherals.

Set command

The set command makes the nRF9160 SiP enter either Idle or Sleep mode.

Syntax

#XSLEEP=<sleep_mode>

The <sleep_mode> parameter accepts only the following integer values:

  • 0 - Deprecated.

  • 1 - Enter Sleep. In this mode, both the SLM service and the LTE connection are terminated.

    The nRF9160 SiP can be woken up using the CONFIG_SLM_WAKEUP_PIN.

  • 2 - Enter Idle.

    In this mode, both the SLM service and the LTE connection are maintained. The nRF9160 SiP can be made to exit idle using the CONFIG_SLM_WAKEUP_PIN. If the CONFIG_SLM_INDICATE_PIN is defined, SLM toggle this GPIO when there is data for MCU. MCU could in turn make SLM to exit idle by CONFIG_SLM_WAKEUP_PIN. The data is buffered during the idle status and sent to MCU after exiting the idle status.

Note

  • This parameter does not accept 0 anymore.

  • If the modem is on, entering Sleep mode sends a +CFUN=0 command to the modem, which causes a non-volatile memory (NVM) write. Take the NVM wear into account, or put the modem in flight mode by issuing a AT+CFUN=4 before Sleep mode.

Examples

AT#XSLEEP=0
ERROR

AT#XSLEEP=1
OK

See the following for an example of when the modem is on:

AT+CFUN=4
OK

AT#XSLEEP=1
OK

AT#XSLEEP=2
OK

Read command

The read command is not supported.

Test command

The test command tests the existence of the AT command and provides information about the type of its subparameters.

Syntax

#XSLEEP=?

Response syntax

#XSLEEP: <list of shutdown_mode>

Example

#XSLEEP: (1,2)
OK

Power off #XSHUTDOWN

The #XSHUTDOWN command makes the nRF9160 SiP enter System OFF mode, which is the deepest power saving mode.

Set command

The set command makes the nRF9160 SiP enter System OFF mode.

Syntax

#XSHUTDOWN

Note

In this case the nRF9160 SiP cannot be woken up using the CONFIG_SLM_WAKEUP_PIN..

Examples

AT#XSHUTDOWN
OK

Read command

The read command is not supported.

Test command

The test command is not supported.

Reset #XRESET

The #XRESET command performs a soft reset to the nRF9160 SiP.

Set command

The set command resets the nRF9160 SiP.

Syntax

#XRESET

Examples

AT#XRESET
OK
Ready

Read command

The read command is not supported.

Test command

The test command is not supported.

SLM UART #XSLMUART

The #XSLMUART command manages the UART settings.

Set command

The set command changes the UART baud rate and hardware flow control settings. Hardware flow control settings can be changed only if CONFIG_SLM_UART_HWFC_RUNTIME is selected. These settings are stored in the flash memory and applied during the application startup.

Syntax

The following is the syntax when CONFIG_SLM_UART_HWFC_RUNTIME is selected:

#XSLMUART[=<baud_rate>,<hwfc>]

The following is the syntax when CONFIG_SLM_UART_HWFC_RUNTIME is not selected:

#XSLMUART[=<baud_rate>]

The <baud_rate> parameter is an integer. It accepts the following values:

  • 1200 - 1200 bps

  • 2400 - 2400 bps

  • 4800 - 4800 bps

  • 9600 - 9600 bps

  • 14400 - 14400 bps

  • 19200 - 19200 bps

  • 38400 - 38400 bps

  • 57600 - 57600 bps

  • 115200 - 115200 bps

  • 230400 - 230400 bps

  • 460800 - 460800 bps

  • 921600 - 921600 bps

  • 1000000 - 1000000 bps

Its default value is 115200. When not specified, it is set to the last value set for the variable and stored in the flash memory. If there is no value stored for the variable, it is set to its default value. If not specified, the previous value is used.

The <hwfc> parameter accepts the following integer values:

  • 0 - Disable UART hardware flow control.

  • 1 - Enable UART hardware flow control. In this mode, SLM configures both the RTS and the CTS pins according to the device-tree file.

Its default value is 1. When not specified, it is set to the last value set for the variable and stored in the flash memory. If there is no value stored for the variable, it is set to its default value.

Response syntax

There is no response.

Example

AT#XSLMUART=1000000,1
OK

Read command

The read command shows the current UART settings.

Syntax

AT#XSLMUART?

Response syntax

#XSLMUART: <baud_rate>,<hwfc>

Example

AT#XSLMUART?
#XSLMUART: 115200,1
OK

Test command

The test command tests the existence of the AT command and provides information about the type of its subparameters.

Syntax

#XSLMUART=?

Response syntax

The following is the syntax when CONFIG_SLM_UART_HWFC_RUNTIME is selected:

#XSLMUART: (list of the available baud rate options),(disable or enable hwfc)

The following is the syntax when CONFIG_SLM_UART_HWFC_RUNTIME not selected:

#XSLMUART: (list of the available baud rate options)

Example

The following is an example when CONFIG_SLM_UART_HWFC_RUNTIME is selected:

AT#XSLMUART=?
#XSLMUART: (1200,2400,4800,9600,14400,19200,38400,57600,115200,230400,460800,921600,1000000),(0,1)

The following is an example when CONFIG_SLM_UART_HWFC_RUNTIME is not selected:

AT#XSLMUART=?
#XSLMUART: (1200,2400,4800,9600,14400,19200,38400,57600,115200,230400,460800,921600,1000000)

Device UUID #XUUID

The #XUUID command requests the device UUID.

Set command

The set command returns the device UUID.

Syntax

#XUUID

Response syntax

#XUUID: <device-uuid>

The <device-uuid> value returns a string indicating the UUID of the device.

Example

AT#XUUID

#XUUID: 50503041-3633-4261-803d-1e2b8f70111a

OK

Read command

The read command is not supported.

Test command

The test command is not supported.

Native TLS CMNG #XCMNG

The #XCMNG command manages the credentials to support CONFIG_SLM_NATIVE_TLS. This command is similar to the modem %CMNG command.

Set command

The set command is used for credential storage management. The command writes, reads, deletes, and checks the existence of keys and certificates.

Syntax

The following is the syntax when CONFIG_SLM_NATIVE_TLS is selected:

#XCMNG=<opcode>[,<sec_tag>[,<type>[,<content>]]]

The <opcode> parameter is an integer. It accepts the following values:

  • 0 - Write a credential.

  • 1 - List credentials (currently not supported).

  • 2 - Read a credential (currently not supported).

  • 3 - Delete a credential.

The <sec_tag> parameter is an integer ranging between 0 and 2147483647. It is mandatory for write, read, and delete operations. It is optional for list operations.

The <type> parameter is an integer. It accepts the following values:

  • 0 - Root CA certificate (ASCII text)

  • 1 - Certificate (ASCII text)

  • 2 - Private key (ASCII text)

The <content> parameter is a string. It is mandatory if <opcode> is 0 (write a credential). It is the content of a Privacy Enhanced Mail (PEM) file enclosed in double quotes (X.509 PEM entities). An empty string is not allowed.

Response syntax

There is no response.

Example

AT#XCMNG=0,10,0,"-----BEGIN CERTIFICATE-----
MIICpTCCAkugAwIBAgIUS+wVM0VsVmpDIV8NTW8N2KEdRdowCgYIKoZIzj0EAwIw
gacxCzAJBgNVBAYTAlRXMQ8wDQYDVQQIDAZUYWl3YW4xDzANBgNVBAcMBlRhaXBl
aTEWMBQGA1UECgwNTm9yZGljIFRhaXBlaTEOMAwGA1UECwwFU2FsZXMxETAPBgNV
BAMMCExhcnJ5IENBMTswOQYJKoZIhvcNAQkBFixsYXJyeS52ZXJ5bG9uZ2xvbmds
b25nbG9uZ2xvbmdAbm9yZGljc2VtaS5ubzAeFw0yMDExMTcxMTE3MDlaFw0zMDEx
MTUxMTE3MDlaMIGnMQswCQYDVQQGEwJUVzEPMA0GA1UECAwGVGFpd2FuMQ8wDQYD
VQQHDAZUYWlwZWkxFjAUBgNVBAoMDU5vcmRpYyBUYWlwZWkxDjAMBgNVBAsMBVNh
bGVzMREwDwYDVQQDDAhMYXJyeSBDQTE7MDkGCSqGSIb3DQEJARYsbGFycnkudmVy
eWxvbmdsb25nbG9uZ2xvbmdsb25nQG5vcmRpY3NlbWkubm8wWTATBgcqhkjOPQIB
BggqhkjOPQMBBwNCAASvk+LcLXwteWokU1In+FQUWkkbQhkpW61u7d0jV1y/eF3Q
PTDAoEz//SnU1kIZccAqV64fFrrd2nkXknLCrhtxo1MwUTAdBgNVHQ4EFgQUMYSO
cWPI+SQUs1oVatNQvN/F0UowHwYDVR0jBBgwFoAUMYSOcWPI+SQUs1oVatNQvN/F
0UowDwYDVR0TAQH/BAUwAwEB/zAKBggqhkjOPQQDAgNIADBFAiB2IrzpUmQqcUIw
OVqOMNAlzR6v4YHlI9InxU01quIRtQIhAOTITnLNuA0r0571SSBKZyrNGzxJxcPO
FDkGjew9OVov
-----END CERTIFICATE-----"

OK

Read command

The read command is not supported.

Test command

The test command is not supported.

Modem fault #XMODEM

The application monitors the modem status. When the application detects a modem fault, it sends the #XMODEM unsolicited notification.

Unsolicited notification

The application sends the following unsolicited notification when it detects a modem fault:

#XMODEM: FAULT,<reason>,<program_count>

The <reason> value returns a hexadecimal integer indicating the reason of the modem fault. The <program_count> value returns a hexadecimal integer indicating the address of the modem fault.

The application sends the following unsolicited notification when it shuts down libmodem:

#XMODEM: SHUTDOWN,<result>

The <result> value returns an integer indicating the result of the shutdown of libmodem.

The application sends the following unsolicited notification when it re-initializes libmodem:

#XMODEM: INIT,<result>

The <result> value returns an integer indicating the result of the re-initialization of libmodem.

Note

After libmodem is re-initialized, the MCU side must restart the current active service as follows:

  1. Stopping the service. For example, disconnecting the TCP connection and closing the socket.

  2. Connecting again using LTE.

  3. Restarting the service. For example, opening the socket and re-establishing the TCP connection.