Skip to content

doc: app: Misc minor fixes #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trantanen merged 1 commit into from
Dec 1, 2025
Merged

doc: app: Misc minor fixes #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ config SM_PPP_FALLBACK_MTU
int "Fallback MTU to be used by PPP"
default 1280
help
PPP tries to retrieve the cellular link MTU from the modem (using `AT+CGCONTRDP=0`).
PPP tries to retrieve the cellular link MTU from the modem (using `AT+CGCONTRDP`).
If no MTU is returned by the modem, this value will be used as a fallback.
The MTU will be used for sending and receiving of data on both the PPP and cellular links.

Expand Down
42 changes: 21 additions & 21 deletions doc/app/GNSS_AT_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,39 +37,39 @@ Syntax

#XGNSS=<op>,<cloud_assistance>,<interval>[,<timeout>]

The ``<op>`` parameter can have the following integer values:
* The ``<op>`` parameter can have the following integer values:

* ``0`` - Stop the GNSS module.
In this case, no other parameter is allowed.
* ``1`` - Start the GNSS module.
* ``0`` - Stop the GNSS module.
In this case, no other parameter is allowed.
* ``1`` - Start the GNSS module.

``<cloud_assistance>`` is an integer that indicates whether to use the nRF Cloud assistive services that were enabled during compilation.
It is ``0`` for disabled or ``1`` for enabled.
* ``<cloud_assistance>`` parameter is an integer that indicates whether to use the nRF Cloud assistive services that were enabled during compilation.
It is ``0`` for disabled or ``1`` for enabled.

``<interval>`` is an integer that indicates the GNSS fix interval in seconds.
It can have one of the following values:
* ``<interval>`` parameter is an integer that indicates the GNSS fix interval in seconds.
It can have one of the following values:

* ``0`` - Single-fix navigation mode.
* ``1`` - Continuous navigation mode.
The fix interval is set to 1 second.
* Ranging from ``10`` to ``65535`` - Periodic navigation mode.
The fix interval is set to the specified value.
* ``0`` - Single-fix navigation mode.
* ``1`` - Continuous navigation mode.
The fix interval is set to 1 second.
* Ranging from ``10`` to ``65535`` - Periodic navigation mode.
The fix interval is set to the specified value.

``timeout`` is an integer that indicates the maximum time in seconds that the GNSS receiver is allowed to run while trying to produce a valid Position, Velocity, and Time (PVT) estimate.
It can only be specified in single-fix and periodic navigation modes.
* ``timeout`` is an integer that indicates the maximum time in seconds that the GNSS receiver is allowed to run while trying to produce a valid Position, Velocity, and Time (PVT) estimate.
It can only be specified in single-fix and periodic navigation modes, and must be omitted in continuous navigation mode.
If omitted in single-fix or periodic navigation modes, the default value is 60 seconds.

It can be one of the following:
It can be one of the following:

* ``0`` - The GNSS receiver runs indefinitely until a valid PVT estimate is produced.
* Any positive integer - The GNSS receiver is turned off after the specified time is up, even if a valid PVT estimate was not produced.
* Omitted - In single-fix or periodic navigation mode, the timeout defaults to 60 seconds.
* ``0`` - The GNSS receiver runs indefinitely until a valid PVT estimate is produced.
* Any positive integer - The GNSS receiver is turned off after the specified time is up, even if a valid PVT estimate was not produced.

In periodic navigation mode, the ``<interval>`` and ``<timeout>`` parameters are temporarily ignored during the first fix.

.. note::

When ``<cloud_assistance>`` is disabled, no request is made to nRF Cloud for assistance data.
However, if it has been previously enabled and used, such data may remain locally and will be used if still valid.
However, if it has been previously enabled and used, such data may remain locally available and will be used if still valid.

.. note::

Expand Down Expand Up @@ -213,7 +213,7 @@ Example

OK
#XNRFCLOUD: 1,0
AT#XGNSS=1,0,1,30
AT#XGNSS=1,0,1

#XGNSS: 1,1

Expand Down
4 changes: 2 additions & 2 deletions doc/app/Generic_AT_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Generic AT commands

This page describes generic AT commands.

|SM| echo E[0|1]
================
|SM| echo E0/E1
===============

The ``E`` command enables or disables the AT command echo feature of the |SM| application.

Expand Down
31 changes: 27 additions & 4 deletions doc/app/SOCKET_AT_commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -782,7 +782,7 @@ The test command is not supported.
Send data #XSEND
================

The ``#XSEND`` command allows you to send data over TCP and UDP connections.
The ``#XSEND`` command allows you to send data over TCP, UDP, and raw sockets.

Set command
-----------
Expand Down Expand Up @@ -830,6 +830,18 @@ Syntax
When required number of bytes are sent, the data mode is exited.
The termination command :ref:`CONFIG_SM_DATAMODE_TERMINATOR <CONFIG_SM_DATAMODE_TERMINATOR>` is not used in this case.

.. note::

UDP packets that exceed the Maximum Transmission Unit (MTU) of any network segment along their path may be dropped or fragmented, increasing the risk of packet loss.
Ethernet networks have an MTU of 1500 bytes, which allows a maximum UDP payload of 1472 bytes for IPv4 and 1452 bytes for IPv6.
With DTLS sockets, the usable payload size is further reduced due to encryption overhead.

The cellular network MTU can be queried with the ``AT+CGCONTRDP`` command, but some networks may still drop packets smaller than the reported MTU.

A UDP payload size of 1200 bytes is commonly recommended, especially for IPv6, as it ensures the total packet size remains below the IPv6 minimum MTU of 1280 bytes, after accounting for headers and DTLS overhead.
Keeping UDP packet sizes well below the theoretical maximum increases the likelihood of successful transmission.
Even 1024 bytes could be used as a safe size for UDP packets.

Response syntax
~~~~~~~~~~~~~~~

Expand Down Expand Up @@ -902,7 +914,7 @@ The test command is not supported.
Receive data #XRECV
===================

The ``#XRECV`` command allows you to receive data over TCP or UDP connections.
The ``#XRECV`` command allows you to receive data over TCP, UDP, and raw sockets.

Set command
-----------
Expand Down Expand Up @@ -1038,7 +1050,17 @@ Syntax
When required number of bytes are sent, the data mode is exited.
The termination command :ref:`CONFIG_SM_DATAMODE_TERMINATOR <CONFIG_SM_DATAMODE_TERMINATOR>` is not used in this case.

* UDP packets that exceed 1500 bytes, including headers, may be dropped by the network due to MTU (Maximum Transmission Unit) restrictions.
.. note::

UDP packets that exceed the Maximum Transmission Unit (MTU) of any network segment along their path may be dropped or fragmented, increasing the risk of packet loss.
Ethernet networks have an MTU of 1500 bytes, which allows a maximum UDP payload of 1472 bytes for IPv4 and 1452 bytes for IPv6.
With DTLS sockets, the usable payload size is further reduced due to encryption overhead.

The cellular network MTU can be queried with the ``AT+CGCONTRDP`` command, but some networks may still drop packets smaller than the reported MTU.

A UDP payload size of 1200 bytes is commonly recommended, especially for IPv6, as it ensures the total packet size remains below the IPv6 minimum MTU of 1280 bytes, after accounting for headers and DTLS overhead.
Keeping UDP packet sizes well below the theoretical maximum increases the likelihood of successful transmission.
Even 1024 bytes could be used as a safe size for UDP packets.

Response syntax
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1326,7 +1348,8 @@ Example

OK

#XSENDNTF: 2,0,7 // Unsolicited notification for network acknowledged send.
// Unsolicited notification for network acknowledged send.
#XSENDNTF: 2,0,7

#XAPOLL: 2,4

Expand Down
2 changes: 1 addition & 1 deletion doc/app/sm_description.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ CONFIG_SM_UART_TX_BUF_SIZE - Send buffer size for UART.

CONFIG_SM_PPP_FALLBACK_MTU - Control the MTU used by PPP.
This option controls the MTU used by PPP.
PPP tries to retrieve the cellular link MTU from the modem (using ``AT+CGCONTRDP=0``).
PPP tries to retrieve the cellular link MTU from the modem (using ``AT+CGCONTRDP``).
If MTU is not returned by the modem, this value will be used as a fallback.
The MTU will be used for sending and receiving data on both the PPP and cellular links.
The default value is 1280.
Expand Down