From dc14f980d6bbc2e9a3a4d64ed6aefa1e9ba985db Mon Sep 17 00:00:00 2001 From: Pete Skeggs Date: Mon, 17 Feb 2025 15:11:06 -0800 Subject: [PATCH] docs: Update nrfcloud multi service sample readme Use the newer name for the output file generated by the device_credentials_installer.py script. Add a note to encourage the user to clone the full utils repository. Signed-off-by: Pete Skeggs --- .../cellular/nrf_cloud_multi_service/README.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/samples/cellular/nrf_cloud_multi_service/README.rst b/samples/cellular/nrf_cloud_multi_service/README.rst index e120c4e8755b..08af55765d76 100644 --- a/samples/cellular/nrf_cloud_multi_service/README.rst +++ b/samples/cellular/nrf_cloud_multi_service/README.rst @@ -1169,6 +1169,12 @@ Then, complete the following steps for each device you wish to onboard: 1. Make sure your device is plugged in and that this sample has been flashed to it. #. Install the device and server credentials using the :file:`device_credentials_installer.py` Python script :ref:`you installed `: + .. note:: + The :file:`device_credentials_installer.py` Python script requires other scripts in the same repository to be present in the same folder on your computer. + Clone this repository in its entirety. + The script does not work by itself without the others. + Also, install the required Python packages as mentioned in the script documentation. + (Select the protocol (MQTT or CoAP) and connectivity technology (LTE or Wi-Fi) you built the sample for) .. tabs:: @@ -1253,17 +1259,17 @@ Then, complete the following steps for each device you wish to onboard: .. code-block:: console - Saving provisioning endpoint CSV file provision.csv... - Provisioning CSV file saved + Saving device onboarding CSV file onboard.csv... + Onboarding CSV file saved, row count: 1 - And a new file, :file:`provision.csv` should be created. + And a new file, :file:`onboard.csv` should be created. This file will be used in the next step. -#. Navigate to the `Bulk Onboard Devices`_ page of the nRF Cloud portal and upload the :file:`provision.csv` file to onboard the device. +#. Navigate to the `Bulk Onboard Devices`_ page of the nRF Cloud portal and upload the :file:`onboard.csv` file to onboard the device. To get there from the :guilabel:`Dashboard`, click :guilabel:`Devices` under :guilabel:`Device Management` in the navigation pane on the left, then click :guilabel:`Add Devices` and select **Bulk Onboard**. - Once the `Bulk Onboard Devices`_ page is open, drag in the :file:`provision.csv` file and click **Onboard**. + Once the `Bulk Onboard Devices`_ page is open, drag in the :file:`onboard.csv` file and click **Onboard**. You should see a message stating that the file was uploaded successfully, and your device should appear in the `Devices `_ page.