|
1 | | -# vscode-mbed |
2 | | -VSCode Extension for Mbed OS Projects |
| 1 | +# VS Code Mbed |
| 2 | + |
| 3 | +VS Code Extension for Mbed OS Projects. |
| 4 | + |
| 5 | +## Overview |
| 6 | +Mbed for VS Code enables you to work with Mbed OS projects, handling library dependencies, target connection, build, debug and serial output. |
| 7 | + |
| 8 | +## Usage |
| 9 | + |
| 10 | +- Install the extension from within VS Code (search for 'mbed') or from the VS Code Marketplace: |
| 11 | +https://marketplace.visualstudio.com/items?itemName=mbed.mbed |
| 12 | +- This will also install the following extensions: |
| 13 | + - arm.armls - For working with assembly code. |
| 14 | + - arm.device-manager - For detecting and managing connected devices. |
| 15 | + - arm.embedded-debug - For deploying to your device and debugging programs. |
| 16 | + - arm.environment-manager - For setting up a compiler. |
| 17 | + |
| 18 | +- Open an existing Mbed OS project or use the user interface to clone an existing example using git. |
| 19 | +- The user interface will help you recursively clone any dependant libraries (hydration) and install the Arm GNU toolchain (GCC) or Arm Compiler for Embedded toolchains. |
| 20 | +- You can then select your target and profile, build, deploy and debug your application. |
| 21 | + |
| 22 | +## Contribution |
| 23 | + |
| 24 | +This extension is intended to serve as a permissive, open-source reference for working with Mbed after the July 2026 end-of-life, offering an alternative to the standalone Mbed Studio application. |
| 25 | + |
| 26 | +Pull requests may be accepted, but this primarily serves as a reference application for developing your own tools. |
| 27 | + |
| 28 | +## Development |
| 29 | + |
| 30 | +### Prerequisites |
| 31 | + |
| 32 | +A working [Node.js](https://nodejs.org/) environment. |
| 33 | + |
| 34 | +### Clone |
| 35 | + |
| 36 | +```bash |
| 37 | +git clone https://github.com/ARMmbed/vscode-mbed |
| 38 | +``` |
| 39 | + |
| 40 | +### Build |
| 41 | + |
| 42 | +In the `vscode-mbed` folder: |
| 43 | + |
| 44 | +```bash |
| 45 | +## Install node dependencies |
| 46 | +npm install |
| 47 | +``` |
| 48 | + |
| 49 | +```bash |
| 50 | +## Build the extension |
| 51 | +npm run build |
| 52 | +``` |
| 53 | + |
| 54 | +```bash |
| 55 | +## Package the extension |
| 56 | +npm run package |
| 57 | +``` |
| 58 | + |
| 59 | +### Watch |
| 60 | + |
| 61 | +Start the default build task in VS Code. |
| 62 | + |
| 63 | +### Debug |
| 64 | + |
| 65 | +Launch the default debug task in VS Code. |
0 commit comments