Setting up the SDK
This page outlines the requirements that you need to fulfill before you start working with Edge AI Add-on.
Get the nRF Edge AI Add-on code
The Edge AI Add-on is distributed as a Git repository, and is managed through its own west manifest.
The compatible nRF Connect SDK version is specified in the west.yml file.
To get the Edge AI Add-on code, you can either:
Use the nRF Connect for Visual Studio Code extension, which provides a convenient way to clone the Add-on and compatible nRF Connect SDK version.
Clone the Add-on repository and initialize west with the local manifest.
Extend your west manifest with Add-on as a project.
Clone the Add-on repository and add the Add-on as a Zephyr module through CMake or environment variable.
Note
Use this method when you wish to specifically evaluate Edge AI capabilities, but do not have the nRF Connect SDK setup yet.
Clone the Edge AI Add-on code, together with the compatible nRF Connect SDK:
Ensure you have installed Visual Studio Code and the nRF Connect for Visual Studio Code extension.
Follow the nRF Connect SDK installation guide to install nRF Connect SDK prerequisites and toolchain v3.4.0.
Note
The compatible version of the nRF Connect SDK will be cloned with the Edge AI Add-on repository in the following steps. The version of nRF Connect SDK is fixed to the version of Edge AI Add-on and is hard-coded in the
west.ymlfile of the Edge AI Add-on.Open the nRF Connect extension in Visual Studio Code by clicking its icon in the Activity Bar.
In the extension’s Welcome View, click on Create a new application. The list of actions appears in the Visual Studio Code’s quick pick.
Click Browse nRF Connect SDK Add-on Index. The list of available nRF Connect SDK Add-ons appears in the Visual Studio Code’s quick pick.
Select Edge AI Add-on.
Select the Add-on version to install. Depending on the speed of your internet connection, the update might take some time.
Note
Use this method when you wish to specifically evaluate Edge AI capabilities, but do not have the nRF Connect SDK setup yet.
Follow the nRF Connect SDK installation guide to install nRF Connect SDK prerequisites and toolchain v3.4.0.
Note
The compatible version of the nRF Connect SDK will be cloned with the Edge AI Add-on repository in the following steps. The version of nRF Connect SDK is fixed to the version of Edge AI Add-on and is hard-coded in the
west.ymlfile of the Edge AI Add-on.Launch installed toolchain:
nrfutil sdk-manager toolchain launch --ncs-version v3.4.0 --terminalnrfutil sdk-manager toolchain launch --ncs-version v3.4.0 --shellnrfutil sdk-manager toolchain launch --ncs-version v3.4.0 --shellInitialize the nRF Edge AI repository, using one of the following methods:
Initialize west with the remote manifest.
west init --manifest-rev v2.2.0 --manifest-url https://github.com/nrfconnect/sdk-edge-ai
Clone the nRF Edge AI repository into the
sdk-edge-aidirectory.git clone --branch v2.2.0 https://github.com/nrfconnect/sdk-edge-ai.git sdk-edge-aiInitialize west with local manifest.
west init --local sdk-edge-ai
Update all repositories, by running the following command:
west updateDepending on the speed of your Internet connection, the update might take some time.
Note
Use this method when running a Workspace application or if you prefer to use a modification of the nRF Connect SDK manifest.
Add Add-on repository as a project in west manifest by including the following lines in your
west.ymlunder theprojectskey:- name: edge-ai url: https://github.com/nrfconnect/sdk-edge-ai revision: v2.2.0 import: true
If you have already included the nRF Connect SDK in your west manifest, remove it or replace the above
importkey with the mapping:import: name-blocklist: - nrf
Your west manifest must specify compatible versions of nRF Connect SDK and Add-on.
Perform
west updateto pull the Add-on repository.
Note
Use this method if you have a prior installation of the nRF Connect SDK and would like to evaluate or use the Edge AI Add-on with that installation. This method will allow you to keep the nRF Connect SDK manifest unmodified.
Before using this approach, ensure that a compatible version of the nRF Connect SDK is installed.
To identify the compatible nRF Connect SDK version, check the west.yml file of the Edge AI Add-on.
Since west does not manage the Add-on in this setup, you are responsible for keeping the versions synchronized.
Clone the Add-on repository:
git clone --branch v2.2.0 https://github.com/nrfconnect/sdk-edge-aiSet the CMake or environment variable
EXTRA_ZEPHYR_MODULESto the Add-on code path. Use absolute path to ensure proper path resolution. Check the Environment Variables documentation for different ways of setting environment variables in Zephyr.Note
If you wish to:
Use Edge Impulse in Zephyr library deployment.
Use Edge Impulse samples from Add-on.
Repeat the steps above for edge-impulse-sdk-zephyr. The
EXTRA_ZEPHYR_MODULESvariable should be set to<path to Add-on>;<path to Edge Impulse SDK>.