samples: cellular: nrf_cloud_rest_fota: Refactor sample to use conn_mgr

Removed JITP and included Zephyr's Connection Manager
Fixed SMP, it was not able to compile as BOOTUTIL library was missing.
Manually tested modem, app and fmfu FOTA on nRF9160 and nRF9151.
Also, tested SMP FOTA using nRF9160.

IRIS-5713

Signed-off-by: Pascal Hernandez <[email protected]>

Author: pascal-nordic

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

@@ -388,6 +388,9 @@ Cellular samples
 * :ref:`nrf_cloud_rest_fota` sample:
 
   * Added support for the Thingy:91 X.
+  * Updated the sample to use Zephyr's :ref:`zephyr:conn_mgr_docs` feature.
+  * Fixed SMP FOTA for the nRF9160 DK.
+  * Removed JITP.
 
 Cryptography samples
 --------------------

samples/cellular/nrf_cloud_rest_fota/Kconfig

@@ -15,28 +15,14 @@ config REST_FOTA_JOB_CHECK_RATE_MIN
 	range 1 10080
 	default 15
 
-config REST_FOTA_ENABLE_LED
-	depends on DK_LIBRARY
-	bool "Turn on LED when connected to network"
-	default y
-
-if REST_FOTA_ENABLE_LED
-config REST_FOTA_LED_NUM
-	int "LED number to use"
+config REST_FOTA_LTE_LED_NUM
+	int "LED number to use for LTE connection status"
 	default 0
-endif
 
 config REST_FOTA_BUTTON_EVT_NUM
 	int "Button number to use for device interactions"
 	default 1
 
-config REST_FOTA_DO_JITP
-	bool "Ask to perform just-in-time provisioning (JITP) via REST on startup"
-	help
-	  If a device has JITP certificates and has not yet been provisioned to
-	  nRF Cloud, enable this option and press the configured button when
-	  prompted after the sample starts.
-
 endmenu
 
 menu "Zephyr Kernel"

samples/cellular/nrf_cloud_rest_fota/README.rst

@@ -7,7 +7,9 @@ Cellular: nRF Cloud REST FOTA
    :local:
    :depth: 2
 
-The REST FOTA sample demonstrates how to use the `nRF Cloud REST API`_ to perform Firmware Over-the-Air (FOTA) updates on your device.
+The REST FOTA sample demonstrates how to use the `nRF Cloud REST API`_ to perform Firmware Over-the-Air (FOTA) updates over REST on your device.
+This covers modem, application, and full modem FOTA updates (FMFU).
+Also, with the nRF9160 DK, it supports SMP FOTA updates.
 
 Requirements
 ************
@@ -18,13 +20,19 @@ The sample supports the following development kits:
 
 .. include:: /includes/tfm.txt
 
-The sample requires an `nRF Cloud`_ account and modem firmware v1.3.x or later for an nRF9160 DK, or modem firmware v2.x.x for the nRF91x1 DKs.
+The sample requires an `nRF Cloud`_ account.
+
+Your device must be onboarded to nRF Cloud.
+If it is not, follow the instructions in `Device on-boarding <nrf_cloud_rest_fota_onboarding_>`_.
 
 .. note::
-   Full modem FOTA requires development kit version 0.14.0 or higher if you are using an nRF9160 DK.
+   This sample requires modem firmware v1.3.x or later for an nRF9160 SiP and v2.0.0 or later for nRF91x1 SiPs.
 
 .. include:: /includes/external_flash_nrf91.txt
 
+.. note::
+   Full modem FOTA requires development kit version 0.14.0 or higher if you are using an nRF9160 DK.
+
 Overview
 ********
 
@@ -40,14 +48,21 @@ Without a valid date and time, the modem cannot generate JWTs with an expiration
 User interface
 **************
 
-If you want to perform an update check immediately, press the button configured by the Kconfig option :ref:`CONFIG_REST_FOTA_BUTTON_EVT_NUM <CONFIG_REST_FOTA_BUTTON_EVT_NUM>`.
+Once the device is onboarded and connected, if you want to perform an update check immediately, press **Button 1**.
 This will bypass the wait time specified by the :ref:`CONFIG_REST_FOTA_JOB_CHECK_RATE_MIN <CONFIG_REST_FOTA_JOB_CHECK_RATE_MIN>` option.
+**Button 1** is configured by the :ref:`CONFIG_REST_FOTA_BUTTON_EVT_NUM <CONFIG_REST_FOTA_BUTTON_EVT_NUM>` option.
+
+The configured LTE LED (**LED 1** by default, :ref:`CONFIG_REST_FOTA_LTE_LED_NUM <CONFIG_REST_FOTA_LTE_LED_NUM>`) is lit once an LTE connection is established.
+
+.. _nrf_cloud_rest_fota_onboarding:
+
+Onboarding your device to nRF Cloud
+***********************************
 
-If you have the option :ref:`CONFIG_REST_FOTA_DO_JITP <CONFIG_REST_FOTA_DO_JITP>` enabled and you press the button configured by the :ref:`CONFIG_REST_FOTA_BUTTON_EVT_NUM <CONFIG_REST_FOTA_BUTTON_EVT_NUM>` option when prompted at startup, it will request just-in-time provisioning (JITP) through REST with nRF Cloud.
-This is useful when initially provisioning and associating a device on nRF Cloud.
+You must onboard your device to nRF Cloud for this sample to function.
 You only need to do this once for each device.
 
-If you have enabled the :ref:`CONFIG_REST_FOTA_ENABLE_LED <CONFIG_REST_FOTA_ENABLE_LED>` option, an LED configured by the :ref:`CONFIG_REST_FOTA_LED_NUM <CONFIG_REST_FOTA_LED_NUM>` option indicates the state of the connection to the LTE network.
+To onboard your device, install `nRF Cloud Utils`_ and follow the instructions in the README.
 
 Configuration
 *************
@@ -61,34 +76,19 @@ Check and configure the following configuration options for the sample:
 .. _CONFIG_REST_FOTA_JOB_CHECK_RATE_MIN:
 
 CONFIG_REST_FOTA_JOB_CHECK_RATE_MIN - Update check rate
-   This configuration option defines how often the sample checks for FOTA updates.
+   Defines how often the sample checks for FOTA updates.
    You can modify this value at runtime by adding or updating the ``"fotaInterval"`` item in the desired config section of the device's shadow.
    Use the `nRF Cloud`_ portal or the REST API to perform the config update.
 
-.. _CONFIG_REST_FOTA_DL_TIMEOUT_MIN:
+.. _CONFIG_REST_FOTA_LTE_LED_NUM:
 
-CONFIG_REST_FOTA_DL_TIMEOUT_MIN - Download timeout value
-   This configuration option defines how long to wait for a download to complete.
-
-.. _CONFIG_REST_FOTA_ENABLE_LED:
-
-CONFIG_REST_FOTA_ENABLE_LED - Enable LED
-   This configuration option defines if the LED will be used to indicate connection to the LTE network.
-
-.. _CONFIG_REST_FOTA_LED_NUM:
-
-CONFIG_REST_FOTA_LED_NUM - Enable LED
-   This configuration option defines if the LED is to be used.
+CONFIG_REST_FOTA_LTE_LED_NUM - LTE LED number
+   Defines the LED used to indicate connection to the LTE network.
 
 .. _CONFIG_REST_FOTA_BUTTON_EVT_NUM:
 
 CONFIG_REST_FOTA_BUTTON_EVT_NUM - Button number
-   This configuration option defines the button to use for device interactions.
-
-.. _CONFIG_REST_FOTA_DO_JITP:
-
-CONFIG_REST_FOTA_DO_JITP - Enable prompt to perform JITP using REST
-   This configuration option defines if the application will prompt the user for just-in-time provisioning on startup.
+   Defines the button to use for manual FOTA update check.
 
 .. include:: /libraries/modem/nrf_modem_lib/nrf_modem_lib_trace.rst
    :start-after: modem_lib_sending_traces_UART_start
@@ -101,7 +101,7 @@ Building and running
 
 .. include:: /includes/build_and_run_ns.txt
 
-The configuration file for this sample is located in :file:`samples/cellular/nrf_cloud_rest_fota`.
+The configuration files for this sample are located in :file:`samples/cellular/nrf_cloud_rest_fota`.
 See :ref:`configure_application` for information on how to configure the parameters.
 
 To create a FOTA test version of this sample, add the following parameter to your build command:
@@ -120,11 +120,13 @@ To enable SMP FOTA (nRF9160 DK only), add the following parameters to your build
 * ``-DEXTRA_CONF_FILE=overlay_smp_fota.conf``
 * ``-DEXTRA_DTC_OVERLAY_FILE=nrf9160dk_mcumgr_client_uart2.overlay``
 
+Once the nRF9160 has been flashed, change the switch **SW10** to the nRF52 position to be able to flash the nRF52840 on the DK.
 The nRF52840 device on your DK must be running an SMP compatible firmware, such as the :ref:`smp_svr` sample.
+Otherwise, the REST FOTA sample will not be able to connect to the nRF52840 and will keep trying to connect.
 Build the :ref:`smp_svr` sample for the ``nrf9160dk/nrf52840`` board with the following parameters:
 
-* ``-DEXTRA_CONF_FILE=overlay_smp_fota.conf``
-* ``-DEXTRA_DTC_OVERLAY_FILE=nrf9160dk_mcumgr_client_uart2.overlay``
+* ``-DEXTRA_CONF_FILE=overlay-serial.conf``
+* ``-DEXTRA_DTC_OVERLAY_FILE=nrf9160dk_nrf52840_mcumgr_svr.overlay``
 
 To change :ref:`smp_svr` sample's application version, set the :kconfig:option:`CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION` Kconfig option.
 

samples/cellular/nrf_cloud_rest_fota/overlay_full_modem_fota.conf

@@ -9,3 +9,13 @@ CONFIG_SPI=y
 CONFIG_SPI_NOR=y
 CONFIG_SPI_NOR_FLASH_LAYOUT_PAGE_SIZE=4096
 CONFIG_PM_OVERRIDE_EXTERNAL_DRIVER_CHECK=y
+
+# FMFU requires additional heap space.
+# If the heap is too small, a boot loop can occur when the full modem image is installed.
+CONFIG_HEAP_MEM_POOL_SIZE=47250
+
+CONFIG_REST_FOTA_DL_TIMEOUT_MIN=30
+CONFIG_REST_FOTA_JOB_CHECK_RATE_MIN=1
+CONFIG_IMG_ERASE_PROGRESSIVELY=n
+CONFIG_SPI_NOR_SFDP_MINIMAL=n
+CONFIG_SPI_NOR_SFDP_DEVICETREE=y

samples/cellular/nrf_cloud_rest_fota/overlay_smp_fota.conf

@@ -9,5 +9,8 @@ CONFIG_MCUMGR_GRP_IMG=y
 CONFIG_MCUMGR_GRP_OS=y
 CONFIG_MCUMGR_TRANSPORT_UART=y
 CONFIG_UART_MCUMGR_RX_BUF_COUNT=4
-CONFIG_BOOT_IMAGE_ACCESS_HOOKS=y
 CONFIG_SMP_CMD_RETRY_TIME=1000
+
+# Enable MCUboot util library
+CONFIG_MCUBOOT_IMG_MANAGER=y
+CONFIG_DFU_TARGET_SMP=y

samples/cellular/nrf_cloud_rest_fota/prj.conf

@@ -1,17 +1,29 @@
 # Sample
-CONFIG_REST_FOTA_DO_JITP=n
 CONFIG_NRF_CLOUD_REST_FOTA_SAMPLE_LOG_LEVEL_INF=y
 
 # nRF Cloud REST
 CONFIG_NRF_CLOUD=y
 CONFIG_NRF_CLOUD_REST=y
 CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI=y
-CONFIG_MODEM_JWT=y
+CONFIG_NRF_CLOUD_CHECK_CREDENTIALS=y
+
+# Networking
 CONFIG_NETWORKING=y
 CONFIG_NET_SOCKETS=y
-CONFIG_POSIX_API=y
-CONFIG_NET_NATIVE=n
-CONFIG_NRF_CLOUD_CHECK_CREDENTIALS=y
+CONFIG_NET_SOCKETS_OFFLOAD=y
+
+# Enable LTE Connectivity using Connection Manager
+CONFIG_NET_IPV4=y
+CONFIG_NET_IPV6=y
+CONFIG_NET_IPV6_NBR_CACHE=n
+CONFIG_NET_IPV6_MLD=n
+CONFIG_NET_CONNECTION_MANAGER=y
+CONFIG_NRF_MODEM_LIB=y
+CONFIG_NRF_MODEM_LIB_NET_IF=y
+CONFIG_NRF_MODEM_LIB_NET_IF_AUTO_DOWN=y
+CONFIG_NRF_MODEM_LIB_NET_IF_DOWN_DEFAULT_LTE_DISCONNECT=y
+CONFIG_NET_CONNECTION_MANAGER_MONITOR_STACK_SIZE=1024
+CONFIG_NET_MGMT_EVENT_STACK_SIZE=2048
 
 # FOTA
 CONFIG_NRF_CLOUD_FOTA_POLL=y
@@ -21,7 +33,7 @@ CONFIG_FOTA_DOWNLOAD=y
 CONFIG_FOTA_DOWNLOAD_PROGRESS_EVT=y
 CONFIG_DFU_TARGET=y
 CONFIG_DOWNLOADER=y
-CONFIG_DOWNLOADER_STACK_SIZE=2048
+CONFIG_DOWNLOADER_STACK_SIZE=3072
 
 # MCUBOOT
 CONFIG_BOOTLOADER_MCUBOOT=y
@@ -44,14 +56,14 @@ CONFIG_MPU_ALLOW_FLASH_WRITE=y
 # Button/LED support
 CONFIG_DK_LIBRARY=y
 
-# Modem/LTE Link
-CONFIG_NRF_MODEM_LIB=y
+# LTE Link
 CONFIG_LTE_LINK_CONTROL=y
 
 # AT Host library - Used to send AT commands directy from an UART terminal and to allow
 #		    integration with nRF Connect for Desktop applications.
 CONFIG_AT_HOST_LIBRARY=y
 # Extended AT host stack size since some nrf_cloud credentials are longer than 1024 bytes.
+CONFIG_AT_MONITOR_HEAP_SIZE=4096
 CONFIG_AT_HOST_STACK_SIZE=2048
 
 # Modem info
@@ -64,14 +76,22 @@ CONFIG_MODEM_INFO_ADD_SIM_IMSI=y
 
 # System
 CONFIG_HEAP_MEM_POOL_SIZE=8192
-CONFIG_MAIN_STACK_SIZE=8192
-CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=8192
+CONFIG_MAIN_STACK_SIZE=3072
+CONFIG_SYSTEM_WORKQUEUE_STACK_SIZE=2048
 CONFIG_ASSERT=y
 CONFIG_REBOOT=y
 CONFIG_FPU=y
 CONFIG_PICOLIBC_IO_FLOAT=y
+CONFIG_EVENTS=y
+CONFIG_POSIX_API=y
 
 # Logging
 CONFIG_LOG=y
 CONFIG_LOG_MODE_IMMEDIATE=y
 CONFIG_UART_INTERRUPT_DRIVEN=y
+
+# Modem key management
+CONFIG_MODEM_KEY_MGMT=y
+CONFIG_MODEM_JWT=y
+CONFIG_NRF_CLOUD_REST_AUTOGEN_JWT=y
+CONFIG_NRF_CLOUD_SEC_TAG=16842753