inav/docs/development/IDE - Visual Studio Code with Windows 10.md

IDE - Visual Studio Code with Windows 10

Visual Studio Code is probably the best free option for all Windows 10 users. It provides almost seamless integration with WSL running Ubuntu, syntax highlighting, building, and hardware debugging.

Setup

1. Setup build environment using generic WSL guide
2. Download and install Visual Studio Code
3. From the VS Code Extensions download Remote - WSL plugin
4. Open INAV folder
5. Use Ctrl + Shift + P to run option Remote-WSL: Reopen Folder in WSL
6. Allow firewall and other permissions if requested
7. Install plugins in WSL workspace:
   1. C/C++ from Microsoft for C/C++ support
   2. Bookmarks for simpler navigation
8. Configure the environment using the following snippets as a base

C propertiues

Edit file ./.vscode/c_cpp_properties.json to setup enabled defines

{
    "configurations": [
        {
            "name": "Win32",
            "includePath": [
                "${workspaceRoot}",
                "${workspaceRoot}/src/main/**"
            ],
            "browse": {
                "limitSymbolsToIncludedHeaders": false,
                "path": [
                    "${workspaceRoot}/**"
                ]
            },
            "intelliSenseMode": "msvc-x64",
            "cStandard": "c11",
            "cppStandard": "c++17",
            "defines": [,
                "USE_OSD",
                "USE_GYRO_NOTCH_1",
                "USE_GYRO_NOTCH_2",
                "USE_DTERM_NOTCH",
                "USE_ACC_NOTCH",
                "USE_GYRO_BIQUAD_RC_FIR2",
                "USE_D_BOOST",
                "USE_SERIALSHOT",
                "USE_ANTIGRAVITY",
                "USE_ASYNC_GYRO_PROCESSING",
                "USE_RPM_FILTER",
                "USE_GLOBAL_FUNCTIONS",
                "USE_DYNAMIC_FILTERS",
                "USE_DSHOT",
                "FLASH_SIZE 480",
                "USE_I2C_IO_EXPANDER",
                "USE_PCF8574",
                "USE_ESC_SENSOR"
            ]
        }
    ],
    "version": 4
}

Tasks

Edit ./.vscode/tasks.json to enable Building with Ctrl + Shift + B keyboard shortcut and from Command Console.

{
    // See https://go.microsoft.com/fwlink/?LinkId=733558
    // for the documentation about the tasks.json format
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Install/Update CMAKE",
            "type": "shell",
            "command": "mkdir -p build && cd build && cmake ..",
            "group": "build",
            "problemMatcher": [],
            "options": {
                "cwd": "${workspaceFolder}"
            }
        },
        {
			"label": "Compile autogenerated docs",
			"type": "shell",
			"command": "python3 src/utils/update_cli_docs.py",
			"problemMatcher": [],
			"options": {
				"cwd": "${workspaceFolder}"
			}
		},
        // Example of building a single target
       {
            "label": "Build Matek F722-WPX",
            "type": "shell",
            "command": "make MATEKF722WPX",
            "group": "build",
            "problemMatcher": [],
            "options": {
                "cwd": "${workspaceFolder}/build"
            }
        },
        // Example of building multiple targets
        {
            "label": "Build Matek F405-STD & WING",
            "type": "shell",
            "command": "make MATEKF405 MATEKF405SE",
            "group": "build",
            "problemMatcher": [],
            "options": {
                "cwd": "${workspaceFolder}/build"
            }
        }
    ]
}