From 5c862041c865a7e8c6046b98608078cac852f0d0 Mon Sep 17 00:00:00 2001 From: Pete Skeggs Date: Tue, 11 Jun 2024 18:17:56 -0700 Subject: [PATCH] docs: nrf_cloud: Client id improvements Explain which option is default. Explain Modem JWT prerequisite for using INTERNAL_UUID. Signed-off-by: Pete Skeggs --- doc/nrf/libraries/networking/nrf_cloud.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/nrf/libraries/networking/nrf_cloud.rst b/doc/nrf/libraries/networking/nrf_cloud.rst index f1ae926cabeb..ccc2e1fcb335 100644 --- a/doc/nrf/libraries/networking/nrf_cloud.rst +++ b/doc/nrf/libraries/networking/nrf_cloud.rst @@ -125,6 +125,7 @@ Configuration options for device ID =================================== * :kconfig:option:`CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI` - If you enable this option, the ID is automatically generated using a prefix and the modem's IMEI (````). + This is the default. You can configure the prefix by using :kconfig:option:`CONFIG_NRF_CLOUD_CLIENT_ID_PREFIX`. The default format of the prefix is ``nrf-`` and it is valid only for Nordic devices such as Thingy:91 or an nRF91 Series DK. For custom hardware, use a prefix other than ``nrf-`` by modifying :kconfig:option:`CONFIG_NRF_CLOUD_CLIENT_ID_PREFIX`. @@ -133,6 +134,8 @@ Configuration options for device ID * This option requires modem firmware v1.3.0 or higher. * This option is required when using `auto-onboarding `_. + * This option only takes effect if the :kconfig:option:`CONFIG_MODEM_JWT` Kconfig option is also enabled. + If the :kconfig:option:`CONFIG_MODEM_JWT` Kconfig option is not set to ``y``, the default :kconfig:option:`CONFIG_NRF_CLOUD_CLIENT_ID_SRC_IMEI` Kconfig option will be selected instead. * :kconfig:option:`CONFIG_NRF_CLOUD_CLIENT_ID_SRC_COMPILE_TIME` - If you enable this option, the ID is set at compile time using the value specified by :kconfig:option:`CONFIG_NRF_CLOUD_CLIENT_ID`.