Getting Started
Setting up nRF Connect SDK
The nRF Connect SDK (sdk-nrf) uses west to manage a combination of multiple Git repositories and versions.
You should use the west tool to install all components of the nRF Connect SDK including ANT. The required version of west is dictated by sdk-nrf.
Note
From sdk-ant v2.0.0 onwards, ANT support is now being offered as an Add-on repository. This model requires completing a specific setup that differs from previous versions. Add-ons manage and clone their own compatible nRF Connect SDK instance. Please follow the instructions below to set up the development environment.
Getting the ANT for nRF Connect SDK Add-on
The ANT for nRF Connect repository is located here: https://github.com/ant-nrfconnect/sdk-ant
Use of the repository is subject to the ANT+ Adopter agreement: https://developer.garmin.com/ant-program/licensing/adopter-agreement/
You can set up your development environment either manually or through the nRF Connect for Visual Studio Code extension.
Manual Installation
Initialize the ANT repository:
west init -m "https://github.com/ant-nrfconnect/sdk-ant" --mr main
Update all repositories (including the compatible sdk-nrf version) using the following command:
west update
nRF Connect for Visual Studio Code Extension Installation
To set up the ANT Add-On alongside a compatible nRF Connect SDK, follow these steps:
Launch Visual Studio Code and open the nRF Connect extension from the Activity Bar.
In the Welcome View, choose Create a new application to open the action list.
Select Browse nRF Connect SDK Add-on Index to view available SDK Add-Ons.
Locate and select ANT Wireless Add-On.
Choose the desired Add-on version for installation.
The installation process for both the Add-on and the compatible nRF Connect SDK will begin.
See the Integration notes and Samples for details on configuring your nRF Connect SDK project to include ANT.
Updating ANT for nRF Connect SDK
When new releases are available, they will be tagged with a version and appear in the Releases sidebar on GitHub. ANT and sdk-nrf Compatibility information is available for each release.
ANT libraries are tightly coupled to sdk-nrf revisions. It is not recommended to use sdk-ant with any version other than that specified in the west manifest.
Resources
The nRF Connect SDK is available from Nordic Semiconductor: https://github.com/nrfconnect/sdk-nrf
Official documentation for nRF Connect SDK (sdk-nrf) can be found here: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html