用于您的 Mbed 项目的 VSCode Intellisense

mbed-vscode-tools专为希望在 vscode 而不是 mbed studio 中开发 mbed 项目的软件工程师而设计。我们的工具提供了一个命令行界面来生成和更新您的 c_cpp_properties.json 以获得正确的 vscode 智能感知。

笔记

• 该工具与mbed-toolsmbed 团队提供的官方 cli 工具 ( ) 配合使用。
• 我们假设用户知道如何使用 mbed-tools 及其工作流程。否则请参阅官方文档。

依赖项

Python解释器：

• python >= 3.6.0（我们的代码中使用了 f 个字符串）

Python 包：

• 8.0.0 > click >= 7.0.0（最新的mbed-tools需要click 7.x）

其他软件：

• mbed 工具 >= 7.0.0
• arm-none-eabi-gcc >= 9.0.0 或 armcc >= 6.0.0
• cmake >= 3.19.0
• 忍者 >= 1.0.0

安装

$ pip install mbed-vscode-tools

运行$ pip uninstall mbed-vscode-tools以卸载 mbed-vscode-tools。

教程

创建 c_cpp_properties.json

准备具有“Mbed”配置条目的 c_cpp_properties.json，如下所示：

{
    "env": {},
    "configurations": [
        {
            // "Mbed" entry will be automatically managed and updated by this tool.
            "name": "Mbed",
            "compilerPath": "/usr/bin/arm-none-eabi-gcc",  // Path to an arm compiler executable to use
            "includePath": [],       // Leave empty
            "defines": [],           // Leave empty
            "cStandard": "c17",      // Set your favorite
            "cppStandard": "c++17",  // Set your favorite
            "intelliSenseMode": "gcc-arm"  // Depends on your compiler
        }
    ],
    "version": 4
}

为您的 mbed 项目配置构建设置

确保您位于 mbed 程序目录根目录下。

运行以下命令：

$ mbed-tools configure -t MBED_TOOLCHAIN -m MBED_TARGET -b MBED_PROFILE

• MBED_TOOLCHAIN（必需）
  如果您喜欢使用 gnu arm 编译器，请设置“GCC_ARM”。如果使用付费的官方 arm c/c++ 编译器，请改为设置“ARM”。
• MBED_TARGET（必需）
  设置启用 mbed 的板标识符。您可以通过 USB 连接您的开发板并运行来轻松找到它$ mbed-tools detect。
  “构建目标”字段就是您要查找的内容。
• MBED_PROFILE（可选）
  从“调试”、“开发”或“发布”中选择一个 mbed 构建配置文件。默认参数是“开发”。

更新你的 c_cpp_properties.json

确保您位于 mbed 程序目录根目录下。

运行以下命令来更新您的 c_cpp_properties.json：

$ mbed-vscode-tools update ./cmake_build/{MBED_TARGET}/{MBED_PROFILE}/{MBED_TOOLCHAIN} VSCODE_CONF_FILE

• VSCODE_CONF_FILE（必需）
  c_cpp_properties.json 的路径。

如果一切顺利，includePath并且defines您的 c_cpp_properties.json 的字段会自动更新，并且您的 vscode 智能感知应该可以正常工作。

每次执行后立即运行此命令$ mbed-tools configure。

文档

update

更新您的 c_cpp_properties.json。

$ mbed-vscode-tools update MBED_BUILD_DIR VSCODE_CONF_FILE [--mbed-program-dir str] [--vscode-conf-entry str] [--verbose store_true] [--help store_true]

位置参数：

• MBED_BUILD_DIR
  设置由$ mbed-tools configure. 一般来说，如果你已经执行了 MBED_BUILD_DIR = {MBED_PROGRAM_DIR}/cmake_build/{MBED_TARGET}/{MBED_PROFILE}/{MBED_TOOLCHAIN $ mbed-tools configure -t MBED_TOOLCHAIN -m MBED_TARGET -b MBED_PROFILE -p MBED_PROGRAM_DIR}
• VSCODE_CONF_FILE
  c_cpp_properties.json 的路径。

选项

• --mbed-program-dir
  mbed 程序目录根的路径。如果未指定，则将其设置为您当前的工作目录。
• --vscode-conf-entry
  指定 c_cpp_properties.json 的目标配置条目。默认参数是“Mbed”。
• --verbose
  显示完整的消息日志。
• --help
  显示帮助信息。