Setting up the SDK¶
See the compatibility between the versions of Amazon Sidewalk and the nRF Connect SDK by referring to the Compatibility matrix. Once confirmed, follow the Installing the nRF Connect SDK instructions.
Downloading the Sidewalk repository¶
The Sidewalk distribution model supports the following download methods. Choose the right download method depending on the version of sdk-sidewalk that you are using.
If you are using
v2.5.0
or later releases of sdk-sidewalk and sdk-nrf, follow the steps in Sidewalk as an nRF Connect SDK repository.If you are using the sdk-sidewalk
v1.14.5-dev1
release (with sdk-nrfv2.4.1
), or earlier versions, follow the steps in Sidewalk as an application with manifest repository.
Sidewalk as an nRF Connect SDK repository¶
Follow these steps to download the Sidewalk application for the nRF Connect SDK:
Open a terminal window. Your directory structure should look as follows:
. |___ .west |___ bootloader |___ modules |___ nrf |___ nrfxlib |___ zephyr |___ ...
If you have worked with the Sidewalk application in a previous distribution model (as a manifest repository), check the manifest file.
Make sure the manifest path points to
west.yml
inside thenrf
directory:$ west manifest --path /path-to-ncs-folder/nrf/west.yml
In case your manifest path points to a different file, use the following command:
$ west config manifest.path nrf
Enable the Sidewalk group filter for west.
$ west config manifest.group-filter "+sidewalk"
Check for Sidewalk presence in west:
$ west list | grep sidewalk sidewalk sidewalk <sidewalk_revision> https://github.com/nrfconnect/sdk-sidewalk
Update all repositories:
$ west update
Depending on your connection, the update might take some time.
Install Python requirements for Sidewalk.
$ pip install -r sidewalk/requirements.txt
Sidewalk as an application with manifest repository¶
Follow these steps to download the Sidewalk application for the nRF Connect SDK:
Open a terminal window. Your directory structure should look as follows:
. |___ .west |___ bootloader |___ modules |___ nrf |___ nrfxlib |___ zephyr |___ ...
Clone the Sidewalk application repository from the sdk-sidewalk repository to the nRF Connect SDK folder and name it
sidewalk
:$ git clone --branch <sidewalk_revision> https://github.com/nrfconnect/sdk-sidewalk.git sidewalk
For example:
$ git clone --branch v1.14.4 https://github.com/nrfconnect/sdk-sidewalk.git sidewalk
Note
This method works for Sidewalk revisions up to
v1.14.5-dev1
. For later versions and for themain
branch, follow the steps in Sidewalk as an nRF Connect SDK repository.Install Python requirements for Sidewalk.
$ pip install -r sidewalk/requirements.txt
Set the Sidewalk application manifest and update.
Check the current manifest path:
$ west manifest --path /path-to-ncs-folder/nrf/west.yml
Set the manifest path to the Sidewalk repository:
$ west config manifest.path sidewalk
Update all repositories:
$ west update
Depending on your connection, the update might take some time.
Verify the new manifest path:
$ west manifest --path /path-to-ncs-folder/sidewalk/west.yml
Extracting nRF Command Line Tools¶
To download the nRF Command Line, go to the nRF command line tools page.