Skip to content

Commit

Permalink
doc: Updates to AWS IoT lib docs
Browse files Browse the repository at this point in the history
NCSDK-28995
* Improve commands on how to install
dependencies and usage of the AWS CLI.
* Improve instructions of AWS IoT setup
for nRF70 Series

Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
  • Loading branch information
divipillai committed Sep 27, 2024
1 parent 2499a87 commit 3e01815
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
13 changes: 12 additions & 1 deletion doc/nrf/libraries/networking/aws_iot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,14 @@ If you want to use AWS FOTA, the ``AmazonS3FullAccess`` policy can be used to ob

To complete the steps described in this document, make sure that the following prerequisites are met:

* Install `AWS Command Line Interface`_ on your system and login as a user with appropriate permissions.
* Install `AWS Command Line Interface`_ on your system and configure AWS with the ``aws configure`` command to generate the key pair.
See the `Authentication and access credentials`_ page for more details on AWS configuration.
* To use the ``nrfcredstore`` tool, the dependencies in the :file:`nrf/scripts/requirements-extra.txt` file must be installed.
Enter the following command in a terminal window to install all the dependencies in the file:

.. code-block:: console
pip3 install -r nrf/scripts/requirements-extra.txt
.. rst-class:: numbered-step

Expand Down Expand Up @@ -188,8 +194,13 @@ There are multiple ways to generate and register these certificates:
#. Take note of the certificate ARN, as it will be required later.
#. Download the `Amazon Root CA 1`_ PEM file as :file:`ca-cert.pem`.
If the file is saved as :file:`.txt` file, you need to rename it back to a :file:`.pem` file.
#. Place the PEM files into the folder path specified by the :kconfig:option:`CONFIG_MQTT_HELPER_CERTIFICATES_FOLDER` option, default is :file:`<app_src_dir>/certs/`.
Ensure that the :kconfig:option:`CONFIG_MQTT_HELPER_PROVISION_CERTIFICATES` option is set.

.. note::
It is not necessary to set the :kconfig:option:`CONFIG_MQTT_HELPER_CERTIFICATES_FOLDER` Kconfig option if the file is placed in a folder named :file:`certs` under the application source directory.

#. If the files are placed correctly, the :ref:`lib_mqtt_helper` library finds the certificates and provisions them to the Mbed TLS stack when connecting to AWS IoT.

.. rst-class:: numbered-step
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1127,6 +1127,7 @@
.. _`Security best practices in AWS IoT Core`: https://docs.aws.amazon.com/iot/latest/developerguide/security-best-practices.html
.. _`AWS IoT Core Server Authentication`: https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html
.. _`CA certificates for server authentication in AWS IoT Core`: https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html#server-authentication-certs
.. _`Authentication and access credentials`: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-authentication.html

.. _`AWS IoT console`: https://console.aws.amazon.com/iot/home
.. _`AWS S3 console`: https://console.aws.amazon.com/s3/home
Expand Down

0 comments on commit 3e01815

Please sign in to comment.