Skip to content

Commit

Permalink
doc: samples: lwm2m_carrier: Add overlay and doc for SoftBank and LG U+
Browse files Browse the repository at this point in the history
* Add overlay and improve the Kconfigs and documentation to clarify the
  extra configurations needed to successfully use SoftBank and/or LG U+.
* Add missing entry for shell overlay in the sample.yaml.
* Improve requirement documentation to mention the specific setups.

Signed-off-by: Håvard Vermeer <havard.vermeer@nordicsemi.no>
  • Loading branch information
nordic-hani committed Nov 14, 2024
1 parent 0efd366 commit c1f08f5
Show file tree
Hide file tree
Showing 11 changed files with 105 additions and 18 deletions.
4 changes: 2 additions & 2 deletions applications/serial_lte_modem/doc/slm_description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -311,10 +311,10 @@ The following configuration files are provided:
* :file:`overlay-carrier.conf` - Configuration file that adds |NCS| :ref:`liblwm2m_carrier_readme` support.
See :ref:`slm_carrier_library_support` for more information on how to connect to an operator's device management platform.

* :file:`overlay-carrier-softbank.conf` Configuration file that adds SoftBank configurations for the carrier libray.
* :file:`overlay-carrier-softbank.conf`;:file:`sysbuild-softbank.conf` - Configuration files that adds SoftBank configurations needed by the carrier libray.
Used in conjunction with :file:`overlay-carrier.conf`.
For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation.
* :file:`overlay-carrier-lgu.conf` Configuration file that adds LG U+ configurations for the carrier libray.
* :file:`overlay-carrier-lgu.conf` - Configuration file that adds LG U+ configurations needed by the carrier libray.
Used in conjunction with :file:`overlay-carrier.conf`.
For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation.

Expand Down
7 changes: 0 additions & 7 deletions applications/serial_lte_modem/overlay-carrier-softbank.conf
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,6 @@
CONFIG_LWM2M_CARRIER_SOFTBANK=y
CONFIG_LWM2M_CARRIER_SOFTBANK_DIVIDED_FOTA=y

# Override default PDP context
CONFIG_PDN_DEFAULTS_OVERRIDE=y
CONFIG_PDN_DEFAULT_FAM_NONIP=y

# Set NB-IoT system mode
CONFIG_LTE_NETWORK_MODE_NBIOT=y

# Application FOTA
CONFIG_DFU_TARGET_MCUBOOT=y
CONFIG_IMG_MANAGER=y
Expand Down
19 changes: 19 additions & 0 deletions applications/serial_lte_modem/sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,25 @@ tests:
- nrf9160dk/nrf9160/ns
- nrf9161dk/nrf9161/ns
tags: ci_build sysbuild
applications.serial_lte_modem.lwm2m_carrier.softbank:
sysbuild: true
build_only: true
extra_args: EXTRA_CONF_FILE="overlay-carrier.conf;overlay-carrier-softbank.conf"
SB_EXTRA_CONF_FILE=sysbuild_softbank.conf
platform_allow:
- nrf9160dk/nrf9160/ns
integration_platforms:
- nrf9160dk/nrf9160/ns
tags: ci_build sysbuild
applications.serial_lte_modem.lwm2m_carrier.lgu:
sysbuild: true
build_only: true
extra_args: EXTRA_CONF_FILE="overlay-carrier.conf;overlay-carrier-lgu.conf"
platform_allow:
- nrf9151dk/nrf9151/ns
integration_platforms:
- nrf9151dk/nrf9151/ns
tags: ci_build sysbuild
applications.serial_lte_modem.lwm2m_carrier.thingy91:
sysbuild: true
build_only: true
Expand Down
7 changes: 7 additions & 0 deletions applications/serial_lte_modem/sysbuild-softbank.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#
# Copyright (c) 2024 Nordic Semiconductor
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

SB_CONFIG_LWM2M_CARRIER_DIVIDED_DFU=y
18 changes: 12 additions & 6 deletions doc/nrf/libraries/bin/lwm2m_carrier/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,24 +71,30 @@ In order for your device to comply with the carrier's specifications, the follow

* When in the Verizon network, the LwM2M carrier library uses both the DTLS sessions made available through the modem.
Therefore, the application must expect to fail (or retry) if it attempts to establish a DTLS or TLS session.
The application should never use a DTLS session indefinetly. Since this will block the LwM2M carrier library.
The application should never use a DTLS session indefinetly, since this will block the LwM2M carrier library.

.. group-tab:: SoftBank

* The application must support application FOTA.
* The device must connect using a non-ip APN.
* The device must connect using a non-IP APN.

The :ref:`lwm2m_carrier` sample folder features an extra config file to satisfy these :kconfig:option:`CONFIG_LWM2M_CARRIER_SOFTBANK` dependencies.
The :ref:`serial_lte_modem` application and :ref:`lwm2m_carrier` sample features an extra config files to enable the :kconfig:option:`CONFIG_LWM2M_CARRIER_SOFTBANK` dependencies.

* The device must operate in the NB-IoT system mode.
If the ref:lte_lc_readme: library is used, the Kconfig :kconfig:option:`CONFIG_LTE_NETWORK_MODE_NBIOT` can be used.

* If the :ref:lte_lc_readme: library is used, the Kconfig :kconfig:option:`CONFIG_LTE_NETWORK_MODE_NBIOT`.

* If the :ref:lte_lc_readme: library is not used, see :ref:`nRF91x1 AT Commands Reference Guide` for more information on setting the NB-IoT system mode mode.

* If you are using the :ref:`serial_lte_modem` application, this should be set in the file :file:`slm_auto_connect.h, which is included with :kconfig:option:`CONFIG_SLM_AUTO_CONNECT`.
For more information, see :ref:`CONFIG_SLM_AUTO_CONNECT` in the :ref:`serial_lte_modem` documentation.

.. group-tab:: LG U+

* The application must support application FOTA.
The :ref:`lwm2m_carrier` sample folder features an extra config file to satisfy these :kconfig:option:`CONFIG_LWM2M_CARRIER_LG_UPLUS` dependencies.
The :ref:`serial_lte_modem` application and :ref:`lwm2m_carrier` sample contain extra config files to enable the :kconfig:option:`CONFIG_LWM2M_CARRIER_LG_UPLUS` dependencies.
* The appplication must set the LG U+ specific configurations listed in :c:struct:`lwm2m_carrier_lg_uplus_config_t`.
If you are unsure about wich values to supply during certification, reach out to your carrier or your local Nordic Sales representative.
If you are unsure about which values to supply during certification, reach out to your carrier or your local Nordic Sales representative.

.. _lwm2m_lib_size:

Expand Down
2 changes: 2 additions & 0 deletions lib/bin/lwm2m_carrier/Kconfig
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,8 @@ config LWM2M_CARRIER_T_MOBILE

config LWM2M_CARRIER_SOFTBANK
bool "SoftBank"
depends on DFU_TARGET_MCUBOOT
depends on FLASH_MAP
default y
help
If the Softbank SIM Subscriber ID is detected (device is in the Softbank network),
Expand Down
1 change: 1 addition & 0 deletions samples/cellular/lwm2m_carrier/overlay-softbank.conf
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ CONFIG_LTE_NETWORK_MODE_NBIOT=y

# Application FOTA
CONFIG_DFU_TARGET_MCUBOOT=y
CONFIG_BOOTLOADER_MCUBOOT=y
CONFIG_IMG_MANAGER=y
CONFIG_STREAM_FLASH=y
CONFIG_STREAM_FLASH_ERASE=y
Expand Down
35 changes: 35 additions & 0 deletions samples/cellular/lwm2m_carrier/sample.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,38 @@ tests:
- nrf9160dk/nrf9160/ns
- nrf9161dk/nrf9161/ns
tags: ci_build sysbuild ci_samples_cellular
sample.cellular.lwm2m_carrier.shell:
sysbuild: true
build_only: true
integration_platforms:
- nrf9151dk/nrf9151/ns
- nrf9160dk/nrf9160/ns
platform_allow:
- nrf9151dk/nrf9151/ns
- nrf9160dk/nrf9160/ns
extra_args: EXTRA_CONF_FILE="overlay-shell.conf"
tags: ci_build sysbuild ci_samples_cellular
sample.cellular.lwm2m_carrier.softbank:
sysbuild: true
build_only: true
integration_platforms:
- nrf9151dk/nrf9151/ns
- nrf9160dk/nrf9160/ns
platform_allow:
- nrf9151dk/nrf9151/ns
- nrf9160dk/nrf9160/ns
extra_args: EXTRA_CONF_FILE="overlay-softbank.conf"
SB_EXTRA_CONF_FILE="sysbuild_softbank.conf"
tags: ci_build sysbuild ci_samples_cellular
sample.cellular.lwm2m_carrier.lgu:
sysbuild: true
build_only: true
integration_platforms:
- nrf9151dk/nrf9151/ns
- nrf9160dk/nrf9160/ns
platform_allow:
- nrf9151dk/nrf9151/ns
- nrf9160dk/nrf9160/ns
extra_args: EXTRA_CONF_FILE="overlay-lgu.conf"
SB_EXTRA_CONF_FILE="sysbuild_lgu.conf"
tags: ci_build sysbuild ci_samples_cellular
15 changes: 12 additions & 3 deletions samples/cellular/lwm2m_carrier/sample_description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ The following files are available:

* :file:`prj.conf` - Standard default configuration file.
* :file:`overlay-shell.conf` - Enables the :ref:`lwm2m_carrier_shell` and :ref:`lib_at_shell`.
* :file:`overlay-lgu.conf` Configuration file that adds LG U+ configurations for the carrier libray.
* :file:`overlay-softbank.conf`;:file:`sysbuild-softbank.conf` - Enables configurations for SoftBank.
For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation.
* :file:`overlay-lgu.conf` - Enables configurations for LG U+.
* :file:`overlay-lgu.conf`;:file:`sysbuild-lgu.conf` - Enables configurations for LG U+.
For more information see the :ref:`lwm2m_carrier_dependent` section of the :ref:`liblwm2m_carrier_readme` documentation.

The sample can either be configured by editing the :file:`prj.conf` file and the relevant overlay files, or through menuconfig or guiconfig.
Expand All @@ -124,13 +124,22 @@ Building and running
Building with overlay
=====================

To build with a Kconfig overlay, set :makevar:`EXTRA_CONF_FILE` to the desired overlay file, using the respective :ref:`CMake option <cmake_options>`, as shown in the following example:
To build with a Kconfig overlay, set :makevar:`EXTRA_CONF_FILE` and :makevar:`SB_CONF_FILE` to the desired overlay files, using the respective :ref:`CMake option <cmake_options>`.

Example of building with the shell:

.. parsed-literal::
:class: highlight
west build -b *board_target* -- -DEXTRA_CONF_FILE=overlay-shell.conf
Example of building with the SoftBank configuration:

.. parsed-literal::
:class: highlight
west build -b *board_target* -- -DEXTRA_CONF_FILE=overlay-softbank.conf -DSB_CONF_FILE=sysbuild-softbank.conf
|board_target|

This command builds for your nRF91 Series DK using the configurations found in the :file:`overlay-shell.conf` file, in addition to the configurations found in the :file:`prj.conf` file.
Expand Down
7 changes: 7 additions & 0 deletions samples/cellular/lwm2m_carrier/sysbuild-lgu.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
#
# Copyright (c) 2019 Nordic Semiconductor ASA
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

SB_CONFIG_BOOTLOADER_MCUBOOT=y
8 changes: 8 additions & 0 deletions samples/cellular/lwm2m_carrier/sysbuild-softbank.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#
# Copyright (c) 2019 Nordic Semiconductor ASA
#
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
#

SB_CONFIG_LWM2M_CARRIER_DIVIDED_DFU=y
SB_CONFIG_BOOTLOADER_MCUBOOT=y

0 comments on commit c1f08f5

Please sign in to comment.