|
| 1 | +## NXP VSCode development |
| 2 | + |
| 3 | +- [NXP VSCode development](#nxp-vscode-development) |
| 4 | + - [Introduction](#introduction) |
| 5 | + - [Setup](#setup) |
| 6 | + - [Import a reference application](#import-a-reference-application) |
| 7 | + - [Build](#build) |
| 8 | + - [Flash and debug](#flash-and-debug) |
| 9 | + |
| 10 | +### Introduction |
| 11 | + |
| 12 | +NXP provides an optimized embedded developer experience for code editing and |
| 13 | +develoment through the |
| 14 | +[MCUXpresso for Visual Studio Code](https://www.nxp.com/products/processors-and-microcontrollers/arm-microcontrollers/general-purpose-mcus/mcx-arm-cortex-m/mcx-a-series-microcontrollers/mcuxpresso-for-visual-studio-code:MCUXPRESSO-VSC) |
| 15 | +extension. |
| 16 | + |
| 17 | +Please refer to |
| 18 | +[MCUXpresso for Visual Studio Code](https://github.com/nxp-mcuxpresso/vscode-for-mcux/wiki) |
| 19 | +for a complete guide of the extension. |
| 20 | + |
| 21 | +### Setup |
| 22 | + |
| 23 | +Currently, Matter support is under development so the extension provides some |
| 24 | +experimental support. Some prerequisite steps are required before having a |
| 25 | +working environment. |
| 26 | + |
| 27 | +1. Define `MCUXPRESSO_VSCODE_MATTER` environment variable |
| 28 | + |
| 29 | + To enable Matter support, the user must define the environment variable |
| 30 | + `MCUXPRESSO_VSCODE_MATTER` with a value of 1. Please note that this step is |
| 31 | + different depending on the host OS. |
| 32 | + |
| 33 | +2. Install the extension |
| 34 | + |
| 35 | + To install the extension, just click |
| 36 | + [here](https://marketplace.visualstudio.com/items?itemName=NXPSemiconductors.mcuxpresso) |
| 37 | + and press the `Install` button. Alternatively, this step can also be done in |
| 38 | + `Visual Studio Code`: |
| 39 | + |
| 40 | + - Open `Extensions Marketplace` |
| 41 | + - Search `NXP` or `MCUXpresso` |
| 42 | + - Click on the blue install button |
| 43 | + |
| 44 | + Once installed, the extension should be visible in the left navigation |
| 45 | + panel:  |
| 46 | + |
| 47 | + This is a full view of the extension panels: |
| 48 | +  |
| 49 | + |
| 50 | + `Quickstart panel` overview: |
| 51 | + |
| 52 | + | Name | Description | |
| 53 | + | ------------------------------ | ---------------------------------------------------------------------------- | |
| 54 | + | Import Repository | Wizard used to import a local/remote Matter repo | |
| 55 | + | Import Example from Repository | Wizard used to import a Matter reference app from an imported Matter repo | |
| 56 | + | Import Project | Not used by Matter | |
| 57 | + | Application Code Hub | Not used by Matter | |
| 58 | + | Flash Programmer | Wizard for custom flashing (interface is different based on the debug probe) | |
| 59 | + | Open MCUXpresso Installer | Wizard for installing prerequisites and additional software | |
| 60 | + |
| 61 | +3. Open `MCUXpresso Installer` to install additional dependencies |
| 62 | + |
| 63 | + This step is required in order to install `Python` and `git` (if not already |
| 64 | + present), alongside debug software such as |
| 65 | + [LinkServer](https://www.nxp.com/design/design-center/software/development-software/mcuxpresso-software-and-tools-/linkserver-for-microcontrollers:LINKERSERVER) |
| 66 | + or [SEGGER J-Link](https://www.segger.com/downloads/jlink/). |
| 67 | + |
| 68 | + After installing the selected tools, a VSCode restart is needed in order to |
| 69 | + apply the new settings. |
| 70 | + |
| 71 | +4. Import NXP Matter repository |
| 72 | + |
| 73 | + There are two options for importing repositories: remote and local. |
| 74 | + |
| 75 | + 1. Remote |
| 76 | + |
| 77 | + The options for remote are: |
| 78 | + |
| 79 | + - [CSA Matter repository](https://github.com/project-chip/connectedhomeip) |
| 80 | + (macOS/Linux only) |
| 81 | + - [NXP Matter repository](https://github.com/NXP/matter) (also with |
| 82 | + Windows support) |
| 83 | + |
| 84 | + Once the repository is cloned, a bootstrap process will start |
| 85 | + automatically. This will take a while. |
| 86 | + |
| 87 | + 2. Local |
| 88 | + |
| 89 | + Importing a local repository implies a manual step: |
| 90 | + |
| 91 | + ``` |
| 92 | + cd connectedhomeip |
| 93 | + git clone https://github.com/NXP/matter-vscode |
| 94 | + ``` |
| 95 | +
|
| 96 | + The |
| 97 | + [NXP VSCode metadata repository](https://github.com/NXP/matter-vscode) |
| 98 | + contains metadata files and additional scripts that are used by the |
| 99 | + extension. This repository should be cloned in the Matter root folder. |
| 100 | +
|
| 101 | + This step will not run bootstrap automatically, so it is recommended to |
| 102 | + run bootstrap before importing an example, to avoid any subsequent |
| 103 | + errors. |
| 104 | +
|
| 105 | +At this point, the environment should be ready for building a reference |
| 106 | +application. |
| 107 | +
|
| 108 | +### Import a reference application |
| 109 | +
|
| 110 | +The extension includes an `Import Example from Repository` wizard that |
| 111 | +simplifies adding a project to the workspace. |
| 112 | +
|
| 113 | +### Build |
| 114 | +
|
| 115 | +To build, select the project from the projects window and press the |
| 116 | +`Build Selected` button: |
| 117 | +
|
| 118 | + |
| 119 | +
|
| 120 | +By default, the build will use the configuration specified through the |
| 121 | +`args.gni` of the application. This means additional gn args should be added |
| 122 | +manually by creating a `gnArgs` field inside the project `tasks.json` file: |
| 123 | +
|
| 124 | + |
| 125 | +
|
| 126 | +### Flash and debug |
| 127 | +
|
| 128 | +For these actions, please refer to the official wiki: |
| 129 | +
|
| 130 | +- [Flash](https://github.com/nxp-mcuxpresso/vscode-for-mcux/wiki/Flash) |
| 131 | +- [Debug](https://github.com/nxp-mcuxpresso/vscode-for-mcux/wiki/Debug) |
0 commit comments