Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: doc adjustments after zoomin migration #564

Merged
merged 1 commit into from
May 23, 2024
Merged

doc: doc adjustments after zoomin migration #564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions doc/compatibility_matrix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,3 @@ The following table demonstrates the compatibility between the nRF Connect SDK a
- Planned

`*` From the v2.5.0 release, Amazon Sidewalk is a part of the nRF Connect SDK.

.. include:: ncs_links.rst
4 changes: 4 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,7 @@
html_static_path = ['_static']

plantuml = 'java -jar /usr/local/bin/plantuml.jar'

rst_epilog = """
.. include:: /ncs_links.rst
"""
Binary file modified doc/images/board_configurator_nrf54l15_0_3_0.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 1 addition & 6 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This documentation will guide you through the setup of Amazon Sidewalk used with
Browse the content by referring to the following pages:

.. toctree::
:maxdepth: 1
:maxdepth: 2
:glob:
:caption: Subpages:

Expand All @@ -46,8 +46,3 @@ Browse the content by referring to the following pages:
migration_guide.rst
sidewalk_release_notes.rst
additional_resources.rst

.. include:: ncs_links.rst

.. _Amazon license: https://raw.githubusercontent.com/nrfconnect/sdk-sidewalk/main/LICENSE.txt
.. _Amazon Sidewalk Gateways: https://docs.sidewalk.amazon/introduction/sidewalk-gateways.html
4 changes: 0 additions & 4 deletions doc/migration_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,3 @@ To use the deprecated functionalities, you have to enable the relevant Kconfig o
* ``CONFIG_SIDEWALK_LINK_MASK`` -- The option chooses sidewalk link mask to start with.
New Sidewalk libraries support link switch in runtime.
To switch between the full link mask support libraries and Bluetooth LE only libraries, use the ``CONFIG_SIDEWALK_SUBGHZ_SUPPORT`` option.

.. _Application notes: https://docs.sidewalk.amazon/app-notes/
.. _How to manufacture and produce devices: https://docs.sidewalk.amazon/manufacturing/manufacture-provision/
.. _Amazon Sidewalk specification: https://docs.sidewalk.amazon/specifications/
59 changes: 53 additions & 6 deletions doc/ncs_links.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
..
Note: This file was automatically generated.
Please modify in script file: ncs_links_update.sh
.. This file contains all links referenced in sdk-sidewalk documentation.

.. ncs links (all links need to be updated manually **right before** the targeted release)

.. _nRF Connect SDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/index.html
.. _nrf52840 DK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/config_and_build/board_support.html#boards-included-in-sdk-zephyr
Expand All @@ -12,10 +12,10 @@
.. _Getting started with nRF54L Series: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/device_guides/nrf54l.html
.. _Zephyr toolchain: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/gs_installing.html#install-a-toolchain
.. _nRF Connect SDK Getting started: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/getting_started.html
.. _nRF52840dk_nrf52840: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf52840dk_nrf52840/doc/index.html
.. _nrf5340dk_nrf5340: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf5340dk_nrf5340/doc/index.html#nrf5340dk-nrf5340
.. _nRF52840dk: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf52840dk_nrf52840/doc/index.html
.. _nrf5340dk: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf5340dk_nrf5340/doc/index.html#nrf5340dk-nrf5340
.. _thingy53_nrf5340: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/thingy53_nrf5340/doc/index.html#thingy53-nrf5340
.. _nrf54l15pdk_nrf54l15: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf54l15pdk_nrf54l15/doc/index.html
.. _nrf54l15pdk: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/zephyr/boards/arm/nrf54l15pdk_nrf54l15/doc/index.html
.. _Building and programming an application: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/getting_started/programming.html#gs-programming
.. _Testing and debugging an application: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/getting_started/testing.html#gs-testing
.. _Bootloader and DFU solutions for NCS: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/app_bootloaders.html
Expand All @@ -25,3 +25,50 @@
.. _NCS testing applications: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/gs_testing.html
.. _Known issues for the nRF Connect SDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.0/nrf/releases_and_maturity/known_issues.html
.. _Release notes for the nRF Connect SDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/releases/release-notes-2.6.0.html
.. _v2.6.99-cs1: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.6.99-cs1/nrf/releases_and_maturity/releases/release-notes-2.6.99-cs1.html
.. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
.. _Installing the nRF Connect SDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/installation/install_ncs.html

.. nordicsemi.com

.. _Nordic nRF52840 DK: https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK
.. _nRF Command Line Tools: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools/Download#infotabs

.. github.com

.. _Amazon license: https://raw.githubusercontent.com/nrfconnect/sdk-sidewalk/main/LICENSE.txt
.. _Amazon Sidewalk Sample IoT App: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app
.. _sdk-sidewalk repository: https://github.com/nrfconnect/sdk-sidewalk
.. _sdk-sidewalk: https://github.com/nrfconnect/sdk-sidewalk
.. _Install virtual environment: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app#1-install-virtual-environment
.. _sdk-nrf: https://github.com/nrfconnect/sdk-nrf

.. Amazon links

.. _Amazon Sidewalk Gateways: https://docs.sidewalk.amazon/introduction/sidewalk-gateways.html
.. _Application notes: https://docs.sidewalk.amazon/app-notes/
.. _How to manufacture and produce devices: https://docs.sidewalk.amazon/manufacturing/manufacture-provision/
.. _Amazon Sidewalk specification: https://docs.sidewalk.amazon/specifications/
.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html
.. _Installing or updating the latest version of the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
.. _ID users change permissions: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html
.. _Sidewalk Protocol Specification: https://docs.sidewalk.amazon/specifications/
.. _Sidewalk_Handler CloudWatch log group: https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups/log-group/$252Faws$252Flambda$252FSidewalk_Handler
.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html
.. _CloudShell: https://console.aws.amazon.com/cloudshell
.. _Amazon developer account: https://developer.amazon.com/dashboard
.. _Amazon Web Service account: https://console.aws.amazon.com/console/home
.. _AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html
.. _Echo 4th Gen: https://www.amazon.com/All-New-Echo-4th-Gen/dp/B07XKF5RM3
.. _iOS: https://apps.apple.com/us/app/amazon-alexa/id944011620
.. _Android: https://play.google.com/store/apps/details?id=com.amazon.dee.app
.. _Amazon Sidewalk IoT Prerequisites: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app#prerequisites
.. _Onbarding your Sidewalk devices: https://docs.aws.amazon.com/iot/latest/developerguide/sidewalk-gs-workflow.html
.. _Provision your Sidewalk endpoint and flash the binary image: https://docs.sidewalk.amazon/provisioning/iot-sidewalk-provision-endpoint.html
.. _AWS: https://aws.amazon.com/
.. _Setting up a Sidewalk gateway: https://docs.sidewalk.amazon/getting-started/sidewalk-onboard-prereq-gateway.html

.. Other links

.. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/
.. _Semtech SX1262MB2CAS: https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262mb2cas
4 changes: 0 additions & 4 deletions doc/samples/samples_list.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,3 @@ The following table demonstrates the variants' configuration for the supported d
:caption: Subpages:

sid_end_device.rst

.. include:: ../ncs_links.rst

.. _Semtech SX1262MB2CAS: https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262mb2cas
3 changes: 0 additions & 3 deletions doc/samples/sid_end_device.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,3 @@ See the details on running and testing individual variants, as well as enabling
variants/hello.rst
variants/sensor_monitoring.rst
variants/dut.rst

.. include:: ../ncs_links.rst
.. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/
2 changes: 0 additions & 2 deletions doc/samples/variants/dut.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,3 @@ Testing

#. To start testing the application, use the Sidewalk CLI (DUT).
Type ``sid help`` and press enter to get the list of supported commands.

.. include:: ../../ncs_links.rst
10 changes: 0 additions & 10 deletions doc/samples/variants/hello.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,13 +239,3 @@ Receiving message from AWS MQTT


.. include:: ../../includes/include_testing_nordic_dfu.txt

.. include:: ../../ncs_links.rst
.. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/
.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html
.. _Installing or updating the latest version of the AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
.. _ID users change permissions: https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_change-permissions.html
.. _Sidewalk Protocol Specification: https://docs.sidewalk.amazon/specifications/
.. _Sidewalk_Handler CloudWatch log group: https://console.aws.amazon.com/cloudwatch/home?region=us-east-1#logsV2:log-groups/log-group/$252Faws$252Flambda$252FSidewalk_Handler
.. _AWS IoT MQTT client: https://docs.aws.amazon.com/iot/latest/developerguide/view-mqtt-messages.html
.. _CloudShell: https://console.aws.amazon.com/cloudshell
4 changes: 0 additions & 4 deletions doc/samples/variants/sensor_monitoring.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,3 @@ You should see the following output:
[00:00:00.055,480] <inf> sidewalk_app: Sidewalk link switch to BLE

.. include:: ../../includes/include_testing_nordic_dfu.txt

.. include:: ../../ncs_links.rst
.. _SX1262: https://os.mbed.com/components/SX126xMB2xAS/
.. _Amazon Sidewalk Sample IoT App: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app
12 changes: 0 additions & 12 deletions doc/setting_up_sidewalk_environment/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,3 @@ RAM and flash memory requirements
RAM and flash memory requirement values differ depending on the DK and programmed sample.

.. include:: ../includes/memory_requirement.txt

.. include:: ../ncs_links.rst

.. _Amazon developer account: https://developer.amazon.com/dashboard
.. _Amazon Web Service account: https://console.aws.amazon.com/console/home
.. _AWS CLI: https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html
.. _Nordic nRF52840 DK: https://www.nordicsemi.com/Software-and-Tools/Development-Kits/nRF52840-DK
.. _Semtech SX1262MB2CAS: https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262mb2cas
.. _Echo 4th Gen: https://www.amazon.com/All-New-Echo-4th-Gen/dp/B07XKF5RM3
.. _Amazon Sidewalk Gateways: https://docs.sidewalk.amazon/introduction/sidewalk-gateways.html
.. _iOS: https://apps.apple.com/us/app/amazon-alexa/id944011620
.. _Android: https://play.google.com/store/apps/details?id=com.amazon.dee.app
28 changes: 11 additions & 17 deletions doc/setting_up_sidewalk_environment/setting_up_hardware.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,17 +88,17 @@ Connect the Semtech shield to the Arduino-compatible headers on the development
+---------------+-------------+
| NRESET | P0.04 |
+---------------+-------------+

.. tab:: nRF54L15 PDK

The nRF54L15 PDK does not have the Arduino-compatible header.
The connection layout may differ depending on the revision of your PDK.
GPIO assignments are recommended by the Nordic Semiconductor.
The nRF54L15 PDK operates on a lower voltage level (1.8V).
GPIO assignments are recommended by the Nordic Semiconductor.

The nRF54L15 PDK operates on a lower voltage level (1.8V).
The Semtech Shield is compatible with this voltage and can be safely provided to the pin marked as 3.3V.
Due to the lower voltage, the Semtech radio cannot achieve the full transmit power, and it will reach a plateau at 15 dBm gain even when a higher value is configured.
The specification of the Semtech module describes that it is possible to provide a separate, higher voltage source for radio while maintaining the lower voltage for communication.
The specification of the Semtech module describes that it is possible to provide a separate, higher voltage source for radio while maintaining the lower voltage for communication.
However, the recommended shield does not support this configuration.

.. tabs::
Expand All @@ -107,7 +107,7 @@ Connect the Semtech shield to the Arduino-compatible headers on the development

The v0.2.1 PDK revision does not require any hardware modification, but the buttons are reused to connect the Semtech SX126X shield.
Pressing the buttons while working with the Semtech module can lead to malfunctions and undefined behavior.
This issue is caused by the limitation of the v0.2.1 PDK revision.
This issue is caused by the limitation of the v0.2.1 PDK revision.
It is possible to assign different pins for the radio shield, but you might need to disable some of the PDK's functions, or modify connections by cutting or soldering PDK bridges.

+---------------+--------------+
Expand Down Expand Up @@ -137,7 +137,11 @@ Connect the Semtech shield to the Arduino-compatible headers on the development

See a board configuration for the suggested pin layout:

.. figure:: /images/board_configurator_nrf54l15_0_3_0.png
+--------------------------------------------------------------+
| |
| .. figure:: /images/board_configurator_nrf54l15_0_3_0.png |
| |
+--------------------------------------------------------------+

+---------------+--------------+
| SX126X shield | nRF54L15 PDK |
Expand Down Expand Up @@ -172,13 +176,3 @@ For the exact instructions, refer to the `Setting up a Sidewalk gateway`_ docume
.. note::
If you have multiple Echo devices registered under a single Amazon account, only one of those devices will be able to operate as an FSK gateway even if other devices have the same capability.
If you need to operate multiple FSK gateways, we recommend setting them up under separate Amazon accounts.

.. include:: ../ncs_links.rst

.. _Echo: https://www.amazon.com/All-New-Echo-4th-Gen/dp/B07XKF5RM3
.. _iOS: https://apps.apple.com/us/app/amazon-alexa/id94401162
.. _Android: https://play.google.com/store/apps/details?id=com.amazon.dee.app
.. _Amazon Sidewalk gateways: https://docs.sidewalk.amazon/introduction/sidewalk-gateways.html
.. _Setting up a Sidewalk gateway: https://docs.sidewalk.amazon/getting-started/sidewalk-onboard-prereq-gateway.html
.. _Semtech SX1262MB2CAS: https://www.semtech.com/products/wireless-rf/lora-transceivers/sx1262mb2cas
.. _Board Configurator: https://docs.nordicsemi.com/bundle/nrf-connect-board-configurator/page/index.html
8 changes: 1 addition & 7 deletions doc/setting_up_sidewalk_environment/setting_up_sdk.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Follow these steps to download the Sidewalk application for the nRF Connect SDK:

$ pip install -r sidewalk/requirements.txt

#. Set the Sidewalk application manifest and update.
#. Set the Sidewalk application manifest and update repositories.

a. Check the current manifest path:

Expand Down Expand Up @@ -158,9 +158,3 @@ Extracting nRF Command Line Tools
*********************************

To download the nRF Command Line, go to the `nRF command line tools`_ page.

.. include:: ../ncs_links.rst

.. _sdk-sidewalk repository: https://github.com/nrfconnect/sdk-sidewalk
.. _nRF Command Line Tools: https://www.nordicsemi.com/Software-and-Tools/Development-Tools/nRF-Command-Line-Tools/Download#infotabs
.. _Installing the nRF Connect SDK: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/installation/install_ncs.html
11 changes: 0 additions & 11 deletions doc/setting_up_sidewalk_environment/setting_up_sidewalk_product.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,14 +114,3 @@ Use MQTT client
#. Type your MQTT topic in the filter field and click :guilabel:`Subscribe`.

.. figure:: /images/AWSIoTCoreMQTT.png

.. include:: ../ncs_links.rst

.. _sdk-sidewalk: https://github.com/nrfconnect/sdk-sidewalk
.. _Onbarding your Sidewalk devices: https://docs.aws.amazon.com/iot/latest/developerguide/sidewalk-gs-workflow.html
.. _Provision your Sidewalk endpoint and flash the binary image: https://docs.sidewalk.amazon/provisioning/iot-sidewalk-provision-endpoint.html
.. _Amazon Sidewalk Sample IoT App: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app
.. _Amazon Sidewalk IoT Prerequisites: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app#prerequisites
.. _Install virtual environment: https://github.com/aws-samples/aws-iot-core-for-amazon-sidewalk-sample-app#1-install-virtual-environment
.. _AWS: https://aws.amazon.com/
.. _sdk-nrf: https://github.com/nrfconnect/sdk-nrf
Loading