https://github.com/ziteh/nrf5-sdk-dev
Nordic nRF5 SDK Docker and Dev Containers (not NCS / Zephyr RTOS)
https://github.com/ziteh/nrf5-sdk-dev
dev-container docker nrf52840
Last synced: 9 days ago
JSON representation
Nordic nRF5 SDK Docker and Dev Containers (not NCS / Zephyr RTOS)
- Host: GitHub
- URL: https://github.com/ziteh/nrf5-sdk-dev
- Owner: ziteh
- License: mit
- Created: 2025-08-23T07:42:11.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-30T00:50:37.000Z (about 1 month ago)
- Last Synced: 2025-09-23T19:43:58.758Z (16 days ago)
- Topics: dev-container, docker, nrf52840
- Language: C
- Homepage:
- Size: 33.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nRF5 SDK Development Environment
A Docker-based development environment for Nordic nRF5 SDK projects.
Available on x86-64 and Apple M-series Arm CPU.
## Getting Started
### Prerequisites
On the ***host***:
1. **nRF5 SDK**: [Download](https://www.nordicsemi.com/Products/Development-software/nRF5-SDK/Download#infotabs) and extract it to your preferred location, such as `C:/nordic/nRF5_SDK_17.1.0_ddde560`.
2. **Update SDK Path**: Update the SDK mounting path in `.devcontainer.json` to match the location where you extracted the SDK. For example:
```json
"source=/mnt/c/nordic/nrf5_sdk_17.1.0_ddde560,target=/opt/nrf5-sdk",
// or env
"source=${localEnv:NRF5_SDK_PATH},target=/opt/nrf5-sdk",
```
3. **Debugger**: Install either [J-Link](https://www.segger.com/downloads/jlink/) or [OpenOCD](https://openocd.org/).
4. **Configuration**: Check and modify the values in the [`.env`](./.env) file if necessary.
### GDB Server
Start the GDB server on the ***host***:
```bash
JLinkGDBServer -device nRF52840_xxAA -if SWD -speed 4000
```
### Development
In VS Code, press `Ctrl` + `Shift` + `P`, search for and select `Reopen in Container` to enter the dev container.
On the ***container***:
```bash
# Build firmware
make
# Clean the build folder
make clean
# Flash the firmware
make flash
# Erase the device
make erase
# Reset the device
make reset
# Display help
make help
```
Alternatively, you can use the VS Code Tasks from the menu bar: `Terminal` → `Run Task`.
### Debugging
In the ***container***, use the `Run and Debug` feature in VS Code. This will connect to the GDB server.
## Docker
### Build the Docker Image
On the ***host***:
```bash
docker build -t nrf5-sdk-dev ./.devcontainer
# or
podman build -t nrf5-sdk-dev ./.devcontainer
```
### Build Firmware on the Host
On the ***host***:
```bash
podman run --rm \
-v "${PWD}:/workspace" \
-v "${NRF5_SDK_PATH}:/opt/nrf5-sdk" \
-w /workspace \
nrf5-sdk-dev \
bash -c "make clean && make"
```
## TODO
- [ ] Update the [Arm Ttolchain](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) (`arm-gnu-toolchain-14.3.rel1-aarch64-arm-none-eabi.tar.xz` and `arm-gnu-toolchain-14.3.rel1-x86_64-arm-none-eabi.tar.xz`).
## References
- [nRF5 SDK v17.1.0: Introduction](https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/index.html)
- [J-Link GDB Server Commands](https://kb.segger.com/J-Link_GDB_Server#Supported_remote_(monitor)_commands)
- [GNU Arm Toolchain](https://developer.arm.com/downloads/-/gnu-rm)
- [Marus/cortex-debug: Visual Studio Code extension for Cortex-M Microcontrollers](https://github.com/Marus/cortex-debug)
- [NordicSemiconductor/nRF5-SDK-for-Mesh](https://github.com/NordicSemiconductor/nRF5-SDK-for-Mesh)