GD32 Assistant
在 Visual Studio Code 中完成 GD32 开发环境的准备、工程创建，以及日常的编译、烧录与在线调试。
- 环境检查：逐项检测编译工具链与调试环境，缺少的组件可在面板内直接安装
- 创建项目：选择芯片系列与型号，一键创建可直接编译、烧录与调试的工程
- 开箱可用：创建出的工程为标准 CMake 工程，无需安装厂商器件包
- 支持范围：26 个系列 / 666 个型号，型号名与芯片丝印一致（完整订货码）
- 跨平台：Windows、Linux、macOS 使用同一套流程
English
GD32 Assistant helps you set up a GD32 (GigaDevice) development environment in Visual Studio
Code: environment check, project creation, build, flash and debug. Projects are created as standard
CMake projects and can be built without this extension. 26 series / 666 part numbers are supported
on Windows, Linux and macOS.
环境要求
| 项目 |
说明 |
| Visual Studio Code |
1.85 或更高版本 |
| 依赖扩展 |
Cortex-Debug、C/C++、CMake Tools（安装本扩展时自动安装） |
| 编译与调试工具 |
arm-none-eabi-gcc、arm-none-eabi-gdb、cmake、ninja、pyocd |
| Python |
pyOCD 的运行与固件包解压需要 |
上表第三项的组件若尚未安装，可在扩展面板中一键安装。
安装
- 在 VS Code 扩展面板搜索 GD32 Assistant 并安装；
- 打开活动栏的 GD32 面板，在「当前环境」中确认各组件状态，缺少的项点击「安装」；
- 环境就绪后即可创建项目。
使用方法
创建项目
- 在 GD32 面板点击 创建项目，或从命令面板执行
创建项目；
- 选择芯片系列与型号，填写项目名称与存放位置，并选择固件库来源；
- 按需勾选「点灯示例」「初始化 Git 仓库」等选项；
- 点击 创建。扩展会自动准备所需固件库并生成工程，完成后可直接打开。
编译、烧录与调试
创建出的工程会在状态栏显示四个按钮：项目名（点击可切换项目）、编译、烧录、调试。
也可以在命令面板中执行同名命令，或使用「编译当前项目（Release）」做优化构建。
工程目录下的 .gd32-project.json 是项目标记文件：删除它即可不再显示状态栏按钮。
状态栏按钮可用设置项 gd32.statusBar 关闭。
工程可独立使用
创建出的工程是标准 CMake 工程，构建产物位于项目的 build/ 目录。
只要本机具备上表中的工具链，即可脱离本扩展自行编译与调试；固件库与源文件均随工程保存。
创建项目选项
| 选项 |
说明 |
| 项目名称 |
默认按所选型号命名，可自行修改 |
| 存放位置 |
工程目录的上级位置 |
| 芯片系列 / 芯片型号 |
型号为完整订货码，与芯片丝印一致 |
| 固件库来源 |
共享库：各项目共用一个固件库目录；复制进项目：固件库随工程保存，可离线使用与迁移 |
| 库位置 |
共享库目录，默认位于工作区的 gd32-sdk |
| 内存布局 |
勾选后在工程内生成一份链接脚本，便于按需调整存储器划分 |
| 初始化 Git 仓库 |
在工程目录中执行仓库初始化 |
| 点灯示例 |
生成 src/led.c 与 include/led.h，每 500 毫秒翻转一次指示灯 |
支持范围
| 项目 |
说明 |
| 芯片系列 |
26 个系列 / 666 个型号：GD32A10x、GD32A490、GD32A508、GD32C10x、GD32C11x、GD32C2x1、GD32E10x、GD32E11x、GD32E23x、GD32E502、GD32E50x、GD32E51x、GD32F10x、GD32F1x0、GD32F20x、GD32F30x、GD32F3x0、GD32F403、GD32F4xx、GD32F50x、GD32F527、GD32H73x_75x、GD32H75E、GD32L23x、GD32M53x、GD32W51x_F5HC |
| 操作系统 |
Windows、Linux、macOS |
| Visual Studio Code |
1.85 或更高版本 |
部分系列尚不支持，不会出现在创建项目的系列列表中。
常见问题
需要安装厂商器件包吗？
不需要。烧录算法随项目创建时自动准备。
固件库会下载到哪里？
默认下载到工作区的 gd32-sdk 目录，供所有项目共用；也可以在向导中选择随项目保存。
固件库由兆易创新官方发布，版权归其所有。
生成的工程能离开本扩展使用吗？
可以。工程是标准 CMake 工程，使用上表中的工具链即可编译与调试。
怎样让扩展不再处理某个工程？
删除工程目录下的 .gd32-project.json，或使用设置项 gd32.statusBar 关闭状态栏按钮。
反馈问题需要提供什么？
请附上芯片型号、操作系统与 VS Code 版本，以及命令面板中「环境检查」的结果。
许可证
GNU General Public License v3.0 或更新版本（GPL-3.0-or-later），全文见 LICENSE。
可以自由使用、修改与再分发；修改后一旦分发，需同样以 GPL 开源并提供源码。
使用过程中下载的固件库，以及从中提取的寄存器描述文件（SVD），均由兆易创新（GigaDevice）官方发布，版权归兆易创新所有，不适用本项目的许可证；它们不随本扩展分发，仅在用户选定型号后下载至工作区，供编译与调试使用。
Copyright (C) 2026 CuRabbit。
名称与文案中出现的 “GD32” 等仅为标明所支持的芯片产品，商标归兆易创新所有。
