https://github.com/islandcontroller/armcm-devcontainer
VSCode Devcontainer for ARM Cortex-M development
https://github.com/islandcontroller/armcm-devcontainer
arm cmake cortex-m gnu-arm-embedded-toolchain jlink openocd vscode-devcontainer
Last synced: about 1 month ago
JSON representation
VSCode Devcontainer for ARM Cortex-M development
- Host: GitHub
- URL: https://github.com/islandcontroller/armcm-devcontainer
- Owner: islandcontroller
- License: mit
- Created: 2023-09-20T20:29:10.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-23T15:31:46.000Z (11 months ago)
- Last Synced: 2025-02-23T16:27:15.588Z (11 months ago)
- Topics: arm, cmake, cortex-m, gnu-arm-embedded-toolchain, jlink, openocd, vscode-devcontainer
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/islandc/armcm-devcontainer
- Size: 184 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# armcm-devcontainer
[](LICENSE) [](https://github.com/islandcontroller/armcm-devcontainer) [](https://hub.docker.com/r/islandc/armcm-devcontainer) 
*Arm Cortex-M development and debugging environment inside a VSCode devcontainer.*
### Packages
* [Arm GNU Toolchain](https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads) Version 14.3rel1
* [SEGGER J-Link Software](https://www.segger.com/downloads/jlink/) Version 8.84
* [xPack OpenOCD](https://github.com/xpack-dev-tools/openocd-xpack) Version 0.12.0-7
* [CMake](https://cmake.org/download) Version 4.1.2
## System Requirements
* VSCode [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension
* [usbipd-win](https://learn.microsoft.com/en-us/windows/wsl/connect-usb) (Windows *and* WSL parts installed!)
## Usage
* Include this repo as `.devcontainer` in the root of your project
* Connect debug probe
* Select `Dev Containers: Reopen in Container`
For CMake projects:
* Upon prompt, select the `Arm GNU Toolchain x.x` CMake Kit.
* The toolchain file is located at [`/opt/gcc-arm-none-eabi/gcc-arm-none-eabi.cmake`](gcc-arm-none-eabi.cmake).
* The CMake kit definition for VS Code is located at [`/opt/devcontainer/cmake-tools-kits.json`](cmake-tools-kits.json).
* Run `CMake: Configure`
* Build using `CMake: Build [F7]`
### CMake+IntelliSense Notes
Upon first run, an error message may appear in Line 1, Column 1. Try re-running CMake configuration, or run a build. If the file is a `.h` header file, it needs to be `#include`'d into a C module.
### UDEV Rules installation
In order to use SEGGER and OpenOCD debug probes within the container, some udev rules need to be installed on the **host** machine. A setup script has been provided to aid with installation.
* Run `setup-devcontainer` inside the **container**
* Close the container, and re-open the work directory on your **host**
* Run the `install-rules` script inside `.vscode/setup/` on your host machine
cd .vscode/setup
sudo ./install-rules
### Serial Monitor
To access a serial port inside the devcontainer, use the `cu` command as shown below:
cu -l -s
e.g. "`cu -l /dev/ttyACM0 -s 115200`".
To close the connection, press RETURN/ESC/Ctrl-C, type "`~.`" (tilde, dot) and wait for 3 seconds.
### SEGGER Ozone
Use the `setup-devcontainer` script to download and install [SEGGER Ozone](https://www.segger.com/products/development-tools/ozone-j-link-debugger/) and its dependencies:
setup-devcontainer --install-ozone
Launch it from a terminal tab using the `ozone` command.
### SEGGER J-Flash other GUI tools
Use the following command to install the GUI dependencies:
setup-devcontainer --install-gui
Then, you can launch J-Flash using the `JFlashExe` command.
## Licensing
If not stated otherwise, the contents of this project are licensed under The MIT License. The full license text is provided in the [`LICENSE`](LICENSE) file.
SPDX-License-Identifier: MIT