Gustice
commented
3 years ago I'm also searching for a well written instruction to configure a sophisticated setup to use VSCode. However, in the meantime I have a solution for me that is quite sufficient in some/many cases.
Perhaps this could also help you for the meantime. However there are still some issues left.
- Intelli-sense complains often when header files appear to be missing because of the ambiguous file structure in the RTOS component.
- In that case the online syntax check fails, and you have to run the compiler to see the syntax errors.
- The links behind the Issues that are collected by problem matcher are not working (i suspect because all components are compiled on their own and are later linked). However, the file navigation works and helps a lot, and the issues are much more cleaner than the messy compiler output. Also if you can spare the RTOS-component in a module, all convenient features work so far.
Preconditions to use
- Start a terminal and run %IDF_PATH%\export.bat (or bash) in order to setup all environment variables
- Navigate to your project (in opend terminal) and type "code ."
- VS Code starts in given path with setup environment.
Calling code that way enables you to use the defined tasks in
tasks.json
My setup is:
c_cpp_properties.json
{ // https://code.visualstudio.com/docs/cpp/c-cpp-properties-schema-reference
"configurations": [
{
"name": "ESP-Win",
// Folder with header to be included -> For intellisens engine
// GoTo-Reference-List and tag database ("browse") relies on same paths if not specified
"includePath": [
"${workspaceRoot}/main/**",
"${workspaceRoot}/components/**", // comes in handy when first components are created
"${env:IDF_PATH}/components/**",
//"${workspaceRoot}/build/include" // After first build, this contains configured defines.
],
"defines": [
"NDEBUG", "__BSD_VISIBLE",
"__XSI_VISIBLE=500",
"LOG_LOCAL_LEVEL=ESP_LOG_VERBOSE",
"CONFIG_LOG_TIMESTAMP_SOURCE_RTOS",
"CONFIG_FREERTOS_HZ=100"
],
// Path to compiler perhaps has to be adjusted
"compilerPath": "C:/espressif/tools/xtensa-lx106-elf/esp-2020r3-49-gd5524c1-8.4.0/xtensa-lx106-elf/bin/xtensa-lx106-elf-g++.exe",
//"browse": { // Tag-Parser for Go-To-Definition-Function or tag-database. This is same as "includePath" if omitted
"cStandard": "c11",
"cppStandard": "c++17",
"intelliSenseMode": "clang-x64"
}
],
"version": 4
}tasks.json
{
"options": {
"env": {}
},
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{ // Init by MenuConfig
"label": "Menuconfig",
"type": "shell",
"command": "idf.py",
"args": [
"menuconfig"
],
"presentation": {
"reveal": "always",
},
"problemMatcher": []
},
{ // Build Environment
"label": "Build Project",
"group": {
"kind": "build",
"isDefault": true
},
"type": "shell",
"command": "idf.py",
"args": [
"build"
],
"presentation": {
"reveal": "always",
"echo": true
},
"options": {
"shell": {}
},
// "problemMatcher": ["$gcc"] // Gcc matcher does't work here
"problemMatcher": {
"owner": "cpp",
"fileLocation": "absolute",
"pattern": {
"regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
"file": 1,
"line": 2,
"column": 3,
"severity": 4,
"message": 5
}
}
},
{ // Flash Environment and Monitor
"label": "Flash & Monitor",
"group": {
"kind": "test",
"isDefault": true
},
"command": "idf.py",
"type": "shell",
"args": [
"-p",
"COM${input:ComPortNum}",
"flash",
"monitor"
],
"presentation": {
"reveal": "always",
},
// "problemMatcher": ["$gcc"] // Gcc matcher does't work here
"problemMatcher": {
"owner": "cpp",
"fileLocation": "absolute",
"pattern": {
"regexp": "^(.*):(\\d+):(\\d+):\\s+(warning|error):\\s+(.*)$",
"file": 1,
"line": 2,
"column": 3,
"severity": 4,
"message": 5
}
}
},
{ // Clean Project
"label": "Clean Project",
"command": "idf.py",
"type": "shell",
"args": [
"clean"
],
"problemMatcher": []
},
{ // Full-Clean Project
"label": "Full-Clean Project",
"command": "idf.py",
"type": "shell",
"args": [
"fullclean"
],
"problemMatcher": []
}
],
"inputs": [
{
"id": "ComPortNum",
"type": "promptString",
"description": "Type the number of used COM port" // this runs obviously only on a windows machine
}
]
}If you are working on a windows machine you can also add a setup script that executes the export.sh script for you:
Create a file in ...msys32\etc\profile.d\export_idf_path.sh
# Generate Environment variable to IDF
export IDF_PATH="<parentPath2Idf>/ESP8266_RTOS_SDK"
# Exectues export.sh in IDF-Path
cd $IDF_PATH
. export.sh
### Note that you must run install.sh first
# Sets Startup initial working directory
cd <parentPath2EspProjects>/Projects
# Adds Compiler to path-variable ## Note: you certainly have to adopt it
PATH=$PATH':/c/espressif/tools/xtensa-lx106-elf/esp-2020r3-49-gd5524c1-8.4.0/xtensa-lx106-elf/bin'
# Adds Editor to path-variable ## Note: you certainly have to adopt it
PATH=$PATH':/c/Users/Jakob/AppData/Local/Programs/Microsoft VS Code'
gbaranski
THKDev
ndunks
Hypnotriod
arduinka55055
Im struggling with a lot of problems with making VSCode usable for ESP8266-RTOS-SDK, it would be nice if there would be some setup instructions for VSCode.