Skip to content

Commit bf8a78f

Browse files
committed
doc: Add documentation for PPP modem shell sample
Add documentation for PPP modem shell sample and move sample descriptions to own index page. Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
1 parent 2ecec64 commit bf8a78f

8 files changed

Lines changed: 386 additions & 8 deletions

File tree

doc/app/sm_description.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ Connecting with an external MCU
374374
This section does not apply to Thingy:91 X.
375375

376376
If you run your user application on an external MCU (for example, an nRF52 Series development kit), you can control the |SM| application on an nRF91 Series device directly from the application.
377-
See the :ref:`sm_shell_sample` for a sample implementation of such an application.
377+
See the :ref:`sm_at_client_shell` for a sample implementation of such an application.
378378

379379
To connect with an external MCU using UART_2, include the :file:`overlay-external-mcu.overlay` devicetree overlay in your build.
380380
This overlay configures the UART_2 pins, DTR pin, and RI pin for the nRF9151 DK.
@@ -453,7 +453,7 @@ The following table shows how to connect selected development kit to an nRF91 Se
453453
- GPIO GND
454454

455455
.. note::
456-
You must disable the VCOM0 on the nRF54L15 DK to release the UART GPIO pins to use it with the :ref:`sm_shell_sample`.
456+
You must disable the VCOM0 on the nRF54L15 DK to release the UART GPIO pins to use it with the :ref:`sm_samples`.
457457

458458
* For nRF54L15 DK, you can use the `Board Configurator app`_ to disable the `Connect port VCOM0` setting.
459459

@@ -522,7 +522,7 @@ Use the following UART devices:
522522
* nRF91 Series DK - UART2
523523

524524
The UART configuration must match on both sides.
525-
By default the |SM| application and :ref:`sm_shell_sample` use the following settings:
525+
By default the |SM| application and :ref:`sm_samples` use the following settings:
526526

527527
* Hardware flow control: enabled
528528
* Baud rate: 115200

doc/app/sm_dtr_ri.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ The following image illustrates the DTR and RI signal behavior in relation to th
6161

6262
DTR/RI signal diagram
6363

64-
The :ref:`sm_shell_sample` sample and :ref:`lib_sm_at_client` library show an example of how to use DTR and RI signals in an external MCU application.
64+
The :ref:`sm_samples` and :ref:`lib_sm_at_client` library show an example of how to use DTR and RI signals in an external MCU application.

doc/images/samples_overview.svg

Lines changed: 82 additions & 0 deletions
Loading

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It includes host examples in the form of the |SM| AT Client library and the |SM|
1313

1414
gsg_guide
1515
app/README
16-
samples/sm_at_client_shell
16+
samples/README
1717
drivers/dtr_uart
1818
lib/sm_at_client
1919
migration_notes

doc/links.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,12 @@
8282
.. _`Serial Terminal app`: https://docs.nordicsemi.com/bundle/nrf-connect-serial-terminal/page/index.html
8383
.. _`Board Configurator app`: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
8484

85+
.. ### docs.zephyrproject.org/
86+
87+
.. _`Zephyr Networking`: https://docs.zephyrproject.org/latest/connectivity/networking/index.html
88+
.. _`Zephyr Network APIs`: https://docs.zephyrproject.org/latest/connectivity/networking/api/apis.html
89+
.. _`Zephyr Modem modules`: https://docs.zephyrproject.org/latest/services/modem/index.html
90+
8591
.. ### github.com
8692

8793
.. _`github_release`: https://github.com/nrfconnect/ncs-serial-modem/releases
@@ -91,7 +97,6 @@
9197
.. ### others
9298

9399
.. _`Private addresses`: https://en.wikipedia.org/wiki/IP_address#Private_addresses
94-
.. _`Zephyr Network APIs`: https://docs.zephyrproject.org/latest/connectivity/networking/api/apis.html#network-apis
95100

96101
.. _`3GPP TS 27.010`: https://www.etsi.org/deliver/etsi_ts/127000_127099/127010/18.00.00_60/ts_127010v180000p.pdf
97102
.. _`3GPP TS 27.007`: https://www.etsi.org/deliver/etsi_ts/127000_127099/127007/18.06.00_60/ts_127007v180600p.pdf

doc/samples/README.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
.. _sm_samples:
2+
3+
|SM| host samples
4+
#################
5+
6+
The |SM| includes sample applications that demonstrate how to interact with the |SM| application running on an nRF91 Series device.
7+
These samples showcase different integration approaches for controlling the nRF91 Series SiP as a cellular modem.
8+
9+
.. figure:: ../images/samples_overview.svg
10+
:alt: Serial Modem samples overview
11+
12+
Serial Modem running on nRF91 Series DK with a host sample application on an external MCU
13+
14+
Use the :ref:`sm_at_client_shell` when:
15+
16+
* You need direct AT command control
17+
* Your application uses offloaded sockets
18+
* You want to use the |SM| Host library
19+
* You're working with resource-constrained MCUs
20+
* You need to send both standard and proprietary AT commands
21+
22+
Use the :ref:`sm_ppp_shell` when:
23+
24+
* You want to use Zephyr's native networking stack
25+
* You prefer standard POSIX socket APIs
26+
* You need to test network performance
27+
* You're developing on Linux with the native simulator
28+
* You want seamless integration with Zephyr network services
29+
30+
Both samples require the |SM| application to be running on an nRF91 Series device (nRF9160 or nRF9151).
31+
32+
.. toctree::
33+
:maxdepth: 2
34+
:caption: Sample applications:
35+
36+
sm_at_client_shell
37+
sm_ppp_shell

doc/samples/sm_at_client_shell.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _sm_shell_sample:
1+
.. _sm_at_client_shell:
22

33
|SM| AT Client Shell sample
44
###########################
@@ -72,7 +72,7 @@ The following table shows how to connect UART, DTR and RI pins of the DK to the
7272
- GPIO GND
7373

7474
.. note::
75-
You must disable the VCOM0 on the nRF54L15 DK to release the UART GPIO pins to use it with the :ref:`sm_shell_sample`.
75+
You must disable the VCOM0 on the nRF54L15 DK to release the UART GPIO pins to use it with the :ref:`sm_at_client_shell`.
7676

7777
* For nRF54L15 DK, you can use the `Board Configurator app`_ to disable the `Connect port VCOM0` setting.
7878

0 commit comments

Comments
 (0)