Keil Helper Plus

中文 | English

中文

在 VS Code 中选择 Keil 工程与构建目标、查看已保存的仿真器配置，并执行编译和程序下载。

当一个文件夹里包含多个 Keil 工程，尤其是芯片 SDK 中大量同名示例时，Keil Helper Plus 会显示工程名称和部分目录路径，让你更容易找到并确认当前工程。

主要功能

• 区分多个工程：在工程选择列表中显示目录信息，同名工程也能区分。
• 确认当前目标：状态栏同时显示工程和构建目标，悬停查看完整工程路径。
• 支持中文和空格：选择工程与目标时，正确处理中文路径和包含空格的名称。
• 显示仿真器配置：查看当前目标保存的 J-Link、CMSIS-DAP、ST-Link、ULINK 或 Simulator 配置。
• 编译和下载：通过状态栏按钮或命令面板调用 Keil，执行编译、重新编译和程序下载。
• 保存后刷新：工程或选项文件保存后自动更新显示。

环境要求

• Windows。
• VS Code 1.85 或以上。
• 已安装 Keil µVision 5 或以上，并能在 Keil 中正常使用对应工程。
• 已安装工程需要的编译器、器件 Pack、Flash 算法和下载器驱动。

本扩展不附带 Keil 或下载器驱动。代码补全、语法检查等编辑功能可配合 Microsoft C/C++ 扩展使用。

安装与配置

1. 在 VS Code 扩展商店搜索 Keil Helper Plus，确认发布者为 SalHax，然后安装。
2. 在设置中搜索 Keil Helper Plus，填写对应的 UV4.exe 绝对路径。
3. 打开包含 Keil 工程的文件夹。
4. 点击状态栏的工程名称，选择需要的工程和目标。
5. 使用状态栏按钮或命令面板执行编译、重新编译或下载。

也可以在 VS Code 的 settings.json 中填写：

{
  "keil-helper-plus.MDK.Uv4Path": "C:\\Keil_v5\\UV4\\UV4.exe"
}

请将示例路径替换为自己的安装路径。C51 工程对应的设置是 keil-helper-plus.C51.Uv4Path。 从其他 Keil 扩展迁移时，需要在本扩展的设置中重新填写路径。

支持识别 .uvprojx 和 .uvproj 工程。任务日志显示在 输出 → Keil Helper Plus。

切换仿真器后刷新

在 Keil 中切换仿真器并确认后，点击 File → Save All（全部保存），等待状态栏刷新，通常无需关闭 Keil。 选项文件约每 1.2 秒检查一次。

状态栏显示的是已保存的调试器配置，不代表 USB 设备已连接。扩展不会自动切换下载器或修改工程选项。 如果 Keil 的 Utilities 配置使用了其他烧录工具，实际下载工具可能与显示的调试器名称不同。

常见问题

可以使用 J-Link 下载吗？

可以通过 Keil 的下载功能使用 J-Link。实际下载器和 Flash 算法由 Keil 工程配置决定，请先确认同一工程和目标能在 Keil 中正常下载。

Keil 中能下载，VS Code 中失败怎么办？

核对两边的 Keil 路径、工程路径和目标是否一致，并在 Keil 中执行 Save All。 退出占用下载器的调试会话，再查看 输出 → Keil Helper Plus 中的具体错误。

切换了仿真器，状态栏为什么没变化？

确认已执行 Save All，而非只保存当前代码文件；同时核对两边选择的工程和目标。 配置文件缺失或暂时无法解析时，状态栏显示 ?，文件恢复后会重新读取。

能与原 Keil V 一起安装吗？

本扩展使用独立的命令和设置。两个扩展同时启用会显示两套按钮，建议只启用正在使用的一套，避免混淆或同时对同一工程执行任务。

项目来源与许可证

本扩展基于 Keil V / keil-vscode 修改，其上游为 keil-assistant。主要改进包括多工程名称显示、目标选择和仿真器状态显示。

采用 MIT 许可证，保留原版权声明。许可证及第三方声明随扩展提供。 这是独立衍生版本，并非原作者、Arm/Keil 或 SEGGER 的官方发布。

English

Select Keil projects and build targets, view the saved debug adapter configuration, and build or download firmware from VS Code.

When a folder contains several Keil projects, especially SDK samples with identical names, Keil Helper Plus shows project names with directory context so you can identify the project you want to use.

Features

• Distinguish projects: directory context helps you tell similarly named projects apart.
• Confirm the active target: the status bar shows the selected project and target, with the full project path in its tooltip.
• Handle spaces and Chinese paths: project and target selection preserves names containing spaces or non-ASCII characters.
• View adapter settings: see the saved J-Link, CMSIS-DAP, ST-Link, ULINK or Simulator configuration for the selected target.
• Build and download: invoke Keil from status bar buttons or the Command Palette.
• Refresh after saving: project and options file changes update the displayed information.

Requirements

• Windows.
• VS Code 1.85 or later.
• Keil µVision 5 or later, with a working configuration for your project.
• The compiler, device packs, Flash programming algorithms and debug probe drivers required by your project.

Keil and probe drivers are not included. Use an editor extension such as Microsoft C/C++ for code completion and diagnostics.

Install and configure

1. Search for Keil Helper Plus in VS Code Extensions, check that the publisher is SalHax, and install it.
2. Search Settings for Keil Helper Plus and set the absolute path to your UV4.exe.
3. Open a folder containing Keil projects.
4. Click the project name in the status bar to select a project and target.
5. Use the status bar buttons or Command Palette to build, rebuild or download.

Alternatively, add this setting to VS Code's settings.json:

{
  "keil-helper-plus.MDK.Uv4Path": "C:\\Keil_v5\\UV4\\UV4.exe"
}

Replace the example path with your installation path. For C51 projects, use keil-helper-plus.C51.Uv4Path. Settings are independent of other Keil extensions, so configure the path again when switching to this extension.

The extension discovers .uvprojx and .uvproj files. Task logs appear in Output → Keil Helper Plus.

Refresh after changing the adapter

After selecting and confirming a different adapter in Keil, choose File → Save All, then wait for the status bar to refresh. You normally do not need to close Keil. The options file is checked approximately every 1.2 seconds.

The status bar shows the saved debug adapter configuration, not USB connection status. The extension does not switch adapters or modify project options. If Keil's Utilities settings select a separate programming tool, the tool used for downloading may differ from the displayed debug adapter.

Frequently asked questions

Can I download with J-Link?

J-Link can be used through Keil's download function. The programmer and Flash algorithms are determined by the Keil project settings. First confirm that the same project and target download successfully in Keil.

Downloading works in Keil but fails in VS Code. What should I check?

Check the Keil executable path, project path and target in both applications, then use Save All in Keil. End any debug session occupying the probe and read the specific error in Output → Keil Helper Plus.

Why does the status bar still show the previous adapter?

Use Save All rather than saving only the current source file, and check that both applications have the same project and target selected. If the options file is missing or temporarily unreadable, the status bar shows ? and retries when the file changes.

Can I keep the original Keil V installed?

The extensions have independent commands and settings. Enabling both produces two sets of buttons. Enable the one you intend to use to avoid confusion or concurrent tasks on the same project.

Attribution and license

Based on Keil V / keil-vscode, itself derived from keil-assistant. The main improvements cover project naming, target selection and saved debug adapter status.

MIT licensed, with the original copyright notice preserved. License and third-party notices are included with the extension. This is an independent derivative, not an official release by the upstream authors, Arm/Keil or SEGGER.