Setting up the Toolchain
1. Install Required Tools
- nRF Util
→ Add to yourPATH - nRF Command Line Tools
→ Add to yourPATH - SEGGER J-Link
2. Set Up VS Code
-
Install the nRF Connect VSCode Extension Pack
-
In the extension:
Manage toolchain → Install Toolchain → Download v3.3.0
The Toolchain version should match the version in app/west.yml. Check the revision field under sdk-nrf, at the time of writing it is v3.3.0-preview1, so install the closest available SDK version (v3.3.0). If the versions don't match, west update or the build may fail.
3. Clone the ZSWatch project
git clone https://github.com/ZSWatch/ZSWatch.git --recursive
Now open the cloned project in VSCode.
4. Initialize the Project
Open an nRF Connect Terminal (not a regular) in VS Code:
(ctrl + shift + p) -> nRF Connect: Create Shell Terminal)
Then run:
west init -l app
west update
Next, install the required Python packages. Both lines are needed. The first installs Zephyr's dependencies, the second installs ZSWatch-specific scripts (image upload tools, etc.).
- Linux / macOS
- Windows
pip install -r zephyr/scripts/requirements.txt
pip install -r app/scripts/requirements.txt
These pip install commands must be run in the nRF Connect Terminal (not a regular terminal), because the nRF Connect extension manages a Python virtual environment with the correct paths.
pip install -r zephyr/scripts/requirements.txt
pip install --no-build-isolation -r app/scripts/requirements.txt
The --no-build-isolation flag on Windows works around a pip build environment issue when compiling pynrfjprog from source.