Skip to content

Commit 76d2f60

Browse files
divipillairlubos
authored andcommitted
doc: Add references to Serial Modem Add-on
Add references to Serial Modem Add-on. Signed-off-by: divya pillai <[email protected]>
1 parent 256275d commit 76d2f60

File tree

8 files changed

+41
-5
lines changed

8 files changed

+41
-5
lines changed

CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828

2929
# Applications
3030
/applications/asset_tracker_template/README.rst @nrfconnect/ncs-cia-doc
31+
/applications/serial_modem/README.rst @nrfconnect/ncs-modem-doc
3132
/applications/connectivity_bridge/ @nrfconnect/ncs-cia @nordic-auko
3233
/applications/ipc_radio/ @nrfconnect/ncs-si-muffin
3334
/applications/machine_learning/ @nrfconnect/ncs-si-muffin

applications/asset_tracker_template/README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _asset_tracker_template_redirect:
22

3-
Asset Tracker Template Add-on
4-
#############################
3+
Asset Tracker Template
4+
######################
55

66
For asset tracking applications, it is recommended to use the `Asset Tracker Template <Asset Tracker Template_>`_.
77

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. _serial_modem_addon:
2+
3+
Serial Modem
4+
############
5+
6+
The Serial Modem contains the Serial Modem application for nRF91-based devices, and is built on `nRF Connect SDK`_.
7+
It includes host examples in the form of the `Serial Modem Host`_ library and the `Serial Modem Host Shell`_ sample.
8+
9+
The Serial Modem is an add-on and released separately from the `ncs-serial-modem`_ repository.
10+
To learn more about the Serial Modem application, refer to the `Serial Modem`_ documentation.

doc/nrf/applications.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,16 @@ Applications are also available through the `nRF Connect SDK Add-ons`_, a curate
1717
.. toctree::
1818
:maxdepth: 1
1919
:glob:
20-
:caption: Subpages:
20+
:caption: nRF Connect SDK add-on applications:
2121

2222
../../applications/asset_tracker_template/README
23+
../../applications/serial_modem/README
24+
25+
.. toctree::
26+
:maxdepth: 1
27+
:glob:
28+
:caption: nRF Connect SDK applications:
29+
2330
../../applications/connectivity_bridge/README
2431
../../applications/ipc_radio/README
2532
../../applications/matter_bridge/README

doc/nrf/links.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,6 @@
119119
.. _`Changelog for nrfx 2.4.0`: https://github.com/NordicSemiconductor/nrfx/blob/master/CHANGELOG.md#user-content-240---2020-11-13
120120
.. _`Changelog for nrfx 2.5.0`: https://github.com/NordicSemiconductor/nrfx/blob/master/CHANGELOG.md#250---2021-05-05
121121

122-
.. _`nRF52 client for serial LTE modem application`: https://github.com/NordicPlayground/nRF52-clients-for-serial-LTE-modem
123122

124123
.. _`HIDAPI library`: https://github.com/libusb/hidapi
125124
.. _`HIDAPI releases`: https://github.com/libusb/hidapi/releases
@@ -296,6 +295,7 @@
296295
.. ### Source: www.nordicsemi.com
297296

298297
.. _`Nordic Semiconductor website`: https://www.nordicsemi.com/
298+
.. _`nRF Connect SDK`: https://www.nordicsemi.com/Products/Development-software/nRF-Connect-SDK
299299

300300
.. _`Nordic nRF9161 DK`:
301301
.. _`nRF9161 DK product page`: https://www.nordicsemi.com/Products/Development-hardware/nRF9161-DK
@@ -490,6 +490,9 @@
490490
.. _`Zigbee R23`: https://docs.nordicsemi.com/bundle/addon-zigbee-r23-latest/page/index.html
491491

492492
.. _`Asset Tracker Template`: https://docs.nordicsemi.com/bundle/asset-tracker-template-latest/page/index.html
493+
.. _`Serial Modem`: https://docs.nordicsemi.com/bundle/addon-serial_modem-latest/page/index.html
494+
.. _`Serial Modem Host`: https://docs.nordicsemi.com/bundle/addon-serial_modem-latest/page/lib/sm_host.html
495+
.. _`Serial Modem Host Shell`: https://docs.nordicsemi.com/bundle/addon-serial_modem-latest/page/samples/sm_host_shell.html
493496

494497
.. _`known issues page on the main branch`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html
495498
.. _`known issues for nRF Connect SDK v3.1.1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v3-1-1

doc/nrf/releases_and_maturity/known_issues.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2165,6 +2165,7 @@ Serial LTE modem
21652165
================
21662166

21672167
The issues in this section are related to the Serial LTE modem application.
2168+
This application has been removed in the |NCS| v3.2.0 and replaced by `Serial Modem`_, an |NCS| add-on application.
21682169

21692170
.. rst-class:: wontfix v3-1-1 v3-1-0 v3-0-2 v3-0-1 v3-0-0 v2-9-0-nRF54H20-1 v2-9-2 v2-9-1 v2-9-0 v2-8-0 v2-7-0 v2-6-4 v2-6-3 v2-6-2 v2-6-1 v2-6-0 v2-5-3 v2-5-2 v2-5-1 v2-5-0 v2-4-4 v2-4-3 v2-4-2 v2-4-1 v2-4-0
21702171

doc/nrf/releases_and_maturity/migration/migration_guide_3.2.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,14 @@ Matter
8989

9090
To build your custom board with Wi-Fi support, set both the :kconfig:option:`CONFIG_CHIP_WIFI` and :kconfig:option:`CONFIG_WIFI_NRF70` Kconfig options to ``y``.
9191

92+
Serial LTE modem
93+
----------------
94+
95+
.. toggle::
96+
97+
* The Serial LTE modem application has been removed.
98+
Instead, use `Serial Modem`_, an |NCS| add-on application.
99+
92100
Libraries
93101
=========
94102

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,8 @@ Wi-Fi®
214214
Applications
215215
============
216216

217-
|no_changes_yet_note|
217+
* Removed the Serial LTE modem application.
218+
Instead, use `Serial Modem`_, an |NCS| add-on application.
218219

219220
Connectivity bridge
220221
-------------------
@@ -461,6 +462,9 @@ Cellular samples
461462
* The :ref:`nrf_cloud_coap_device_message` sample to demonstrate how to use the `nRF Cloud CoAP API`_ for device messages.
462463
* The :ref:`nrf_cloud_mqtt_device_message` sample to demonstrate how to use the `nRF Cloud MQTT API`_ for device messages.
463464

465+
* Removed the SLM Shell sample.
466+
Use the `Serial Modem Host Shell`_ sample instead.
467+
464468
* :ref:`nrf_cloud_rest_cell_location` sample:
465469

466470
* Added runtime setting of the log level for the nRF Cloud logging feature.
@@ -728,6 +732,8 @@ Modem libraries
728732
* The AT command parser library.
729733
Use the :ref:`at_parser_readme` library instead.
730734
* The AT parameters library.
735+
* The Modem SLM library.
736+
Use the `Serial Modem Host`_ library instead.
731737

732738
* :ref:`lte_lc_readme` library:
733739

0 commit comments

Comments
 (0)