This repository contains the zephyr/west manifest for a knee tracking device built using the Zephyr RTOS and Nordic Semiconductor's nRF Connect SDK (NCS). The project aims to monitor knee movements and provide real-time feedback for rehabilitation purposes and workout optimization.
The manifest file (west.yml) is used to manage the Git repositories that make up the project using Zephyr's meta tool, west. This allows for easy management and version control of the project's dependencies. This repository structure follows the T3: Forest Topology supported by west, which supports multiple independent repositories without one central repository.
This repository also includes the board definition files for our custom PCB in the boards/ directory, including the device tree source (DTS) files, Kconfig files, and any other necessary hardware configuration files used in the zephyr build system.
You will see our manifest includes version 3.1.0 of the nRF Connect SDK, along with the most recent versions of our primary firmware repository, device-firmware.
To install the necessary tools and set up the development environment, follow steps 1-3 outlined in Nordic's official documentation. For simplicity, I recommend installing using the VSCode extension.
Note: The current toolchain (and SDK) version the project is using is
3.1.0
At this point, you should also install the SDK by clicking the Install SDK button in the VSCode extension. Install it in the default location. We will not be using this instance of the SDK, but the extension requires one to be installed.
The west tool is a meta-tool that manages multiple Git repositories, which is essential for working with Zephyr and NCS projects.
You can install west using pip (Python's package installer).
Warning:
This project requires Python 3.10 or higher. Please ensure you have the correct version installed before proceeding.
Windows
pip3 install westMacOS
brew install westThere are two important things to note regarding where you clone this repository.
-
This repository will not be the top level directory of your workspace. I.e., the project will be structured as follows:
<workspace_root>/ ├── manifest/ <-- This repository ├── ncs/ <-- The nRF Connect SDK (NCS) repository └── ... <-- Other modules (e.g., Zephyr, applications, etc.)>This means that you will want to create a new directory to serve as your workspace root, and then clone this repo inside that directory. To follow zephyr/NCS coventions, I recommend creating a directory
C:\ncs\cgc(on Windows),~/ncs/cgc(on Linux), or/opt/nordic/ncs/cgc(on MacOS) to be the workspace root for this project. -
You will want to clone the repository in a directory close to the root of your filesystem (e.g.,
C:\on Windows or/home/user/on Linux) to avoid path length issues. This may not be an issue on MacOS/Linux, but it is a good practice to follow on all platforms. If you follow the recommendation in point 1, you should be fine.
Navigate to the workspace root (C:\ncs\cgc) and clone the repository. Do not change the name of the cloned directory. It must be cloned as manifest.
Navigate to your workspace root directory (C:\ncs\cgc) and run the following command to initialie the west workspace:
west init -l manifestThen, update the project to fetch all necessary modules:
west updateThe last step in getting the project ready to point the VSCode extension to the correct west workspace.
To do this, open the command palette (Ctrl+Shift+P or Cmd+Shift+P) and search for nRF Connect: Manage west workspace, or select Manage SDKs from the WELCOME tab in the nRF Connect extension, and then select Manage west workspace...
In the dialog that appears, select Set west manifest repository and then select the manifest directory you cloned earlier.
In the following dialog, select the manifest in the manifest directory.
