一个专为绅聚科技Fuxi/spark SDK项目设计的构建插件,支持SCons构建系统。
功能特性
- 🚀 一键构建: 支持快速构建项目,自动切换到正确的构建目录
- 🧹 项目清理: 清理编译生成的文件
- 🔄 重新构建: 清理后重新构建项目
- 🎯 多目标支持: 支持多种构建目标选择
- ⚙️ 配置管理: 可配置构建参数和项目类型
- 📊 构建统计: 显示构建时间和状态
- 🌳 侧边栏视图: 在资源管理器中集成构建工具面板
- ⌨️ 快捷键支持: F7构建,Shift+F7清理
- 🔧 状态栏控制: 底部状态栏快速切换项目类型、构建目标、构建模式和并发任务数
界面截图
插件主界面

主要功能区域说明:
- 状态栏控制: 底部状态栏显示项目类型、构建目标、构建模式、并发任务数等配置
- 侧边栏面板: 在资源管理器中集成的构建工具面板,提供快速操作按钮
- 命令面板: 通过
Ctrl+Shift+P
可访问所有构建相关命令
- 终端输出: 实时显示构建过程和结果
状态栏功能详解
状态栏从左到右包含以下可点击的配置项:
- 项目类型:
MIC
/TWS
/HEADPHONE
- 点击切换不同项目类型
- 构建目标:
2t1r_m
- 点击选择不同的构建目标
- 构建模式:
RELEASE
/DEBUG
- 点击切换构建模式
- 并发任务数:
-j8
- 点击配置并发任务数(1/4/8/16/32/自定义)
- 构建按钮: 点击开始构建项目
- 清理按钮: 点击清理项目文件
侧边栏面板
在VSCode资源管理器中会显示 Fuxi构建
面板,包含:
- 构建项目: 一键开始构建
- 清理项目: 清理编译生成的文件
- 重新构建: 先清理再构建
- 选择构建目标: 快速切换构建目标
支持的项目类型
- mic: 无线mic项目 (默认)
- tws: 真无线耳机项目
- headphone: 头戴式耳机项目
使用方法
快速开始
- 安装插件: 在VSCode扩展市场中搜索"Fuxi Build Tool"并安装
- 打开Fuxi项目: 用VSCode打开包含apps/mic、apps/tws或apps/headphone等目录的Fuxi项目
- 自动检测: 插件会自动检测并激活
- 开始构建: 按F7或使用命令面板执行构建
命令使用
通过命令面板
Ctrl+Shift+P
打开命令面板
- 输入
Fuxi: 构建项目
开始构建
- 输入
Fuxi: 清理项目
清理项目
- 输入
Fuxi: 选择构建目标
切换构建目标
命令面板示例:
Ctrl+Shift+P > 输入 "Fuxi" 可以看到所有相关命令:
- Fuxi: 构建项目
- Fuxi: 清理项目
- Fuxi: 重新构建
- Fuxi: 选择构建目标
- Fuxi: 切换项目类型
- Fuxi: 切换构建模式
- Fuxi: 设置并发任务数
通过快捷键
快捷键使用提示:
- 在任何VSCode窗口中按
F7
即可开始构建
- 按
Shift+F7
快速清理项目文件
- 快捷键会显示在命令面板中对应命令的右侧
通过状态栏
底部状态栏从左到右显示:
- 项目类型 (
MIC
/TWS
/HEADPHONE
) - 点击切换项目类型
- 构建目标 (
2t1r_m
) - 点击选择构建目标
- 构建模式 (
RELEASE
/DEBUG
) - 点击切换构建模式
- 并发任务数 (
-j8
) - 点击配置并发任务数(1/4/8/16/32/自定义)
- 构建按钮 - 点击开始构建
- 清理按钮 - 点击清理项目
状态栏交互说明:
- 点击项目类型会弹出选择菜单:MIC、TWS、HEADPHONE
- 点击构建目标会显示所有可用的构建目标列表
- 点击构建模式会在RELEASE和DEBUG之间切换
- 点击并发任务数可以选择预设值或输入自定义数值
- 构建和清理按钮会立即执行相应操作
通过侧边栏
- 在资源管理器中找到
Fuxi构建
面板
- 点击相应的按钮执行操作
侧边栏面板功能:
- 构建项目: 显示构建进度和结果
- 清理项目: 快速清理编译文件
- 重新构建: 先清理再构建的完整流程
- 选择构建目标: 弹出构建目标选择对话框
配置选项
在VSCode设置中搜索"Fuxi"可以找到以下配置项:
配置界面位置:
- 打开VSCode设置 (
Ctrl+,
)
- 搜索 "Fuxi" 关键字
- 可以看到所有Fuxi相关的配置选项
{
"fuxi.defaultTarget": "ws310_wm_2t1r_m_dongle", // 默认构建目标
"fuxi.buildArgs": "-s", // 构建参数
"fuxi.parallelJobs": 8, // 并发任务数
"fuxi.projectType": "mic", // 项目类型
"fuxi.buildMode": "release", // 构建模式
"fuxi.showBuildTime": true // 显示构建时间
}
配置说明:
- defaultTarget: 设置默认的构建目标,影响新建工作区的初始配置
- buildArgs: SCons构建参数,默认为"-s"(静默模式)
- parallelJobs: 默认并发任务数,影响构建速度
- projectType: 默认项目类型,插件会根据此设置自动检测项目
- buildMode: 默认构建模式,RELEASE或DEBUG
- showBuildTime: 是否在状态栏显示构建时间统计
支持的构建目标
ws310_wm_2t1r_m_dongle
ws310_wm_2t1r_m
ws310_wm_1t1r_m
ws310_wm_2t2r_m
ws310_wm_2t1r_s
工作原理
- 项目检测: 插件启动时检查工作区是否包含
apps/mic
、apps/tws
或apps/headphone
目录
- 路径切换: 根据配置的项目类型自动切换到对应的gcc目录
- 命令执行: 在终端中执行SCons命令:
scons -s -j8 target=ws310_wm_2t1r_m_dongle
- 状态监控: 监控构建进度并显示结果
示例用法
基本构建流程
1. 打开Fuxi项目
2. 按F7或点击"构建项目"
3. 插件自动切换到 apps/mic/gcc 目录
4. 执行: scons -s -j8 target=ws310_wm_2t1r_m_dongle
5. 在终端显示构建输出
详细操作步骤:
- 项目检测: 插件启动时自动检测Fuxi项目结构
- 状态栏显示: 底部状态栏显示当前配置的项目类型、构建目标等
- 开始构建: 点击状态栏的构建按钮或按F7快捷键
- 目录切换: 插件自动切换到对应的gcc构建目录
- 命令执行: 在终端中执行SCons构建命令
- 结果反馈: 构建完成后在状态栏显示构建状态和时间
更改构建目标
1. 使用命令 "Fuxi: 选择构建目标"
2. 从列表中选择新的目标
3. 配置自动保存到工作区设置
4. 下次构建使用新目标
构建目标选择界面:
- 通过命令面板选择 "Fuxi: 选择构建目标"
- 弹出选择对话框显示所有可用目标:
ws310_wm_2t1r_m_dongle
(默认)
ws310_wm_2t1r_m
ws310_wm_1t1r_m
ws310_wm_2t2r_m
ws310_wm_2t1r_s
- 选择后配置自动保存,状态栏显示新的构建目标
项目类型切换
1. 点击状态栏的项目类型 (MIC/TWS/HEADPHONE)
2. 选择新的项目类型
3. 插件自动检测并切换到对应项目
4. 构建目录自动更新
项目类型切换说明:
- MIC项目: 构建目录为
apps/mic/gcc
- TWS项目: 构建目录为
apps/tws/gcc
- HEADPHONE项目: 构建目录为
apps/headphone/gcc
- 切换后插件会验证项目结构并更新相关配置
构建模式切换
1. 点击状态栏的构建模式 (RELEASE/DEBUG)
2. 模式在RELEASE和DEBUG之间切换
3. 下次构建使用新的构建模式
构建模式说明:
- RELEASE模式: 优化编译,生成发布版本
- DEBUG模式: 包含调试信息,便于调试
- 模式切换会立即生效,影响后续所有构建操作
故障排除
常见问题
Q: 插件没有激活?
A: 确保项目根目录包含apps目录,且其中有mic、tws或headphone目录之一
Q: 构建命令没有执行?
A: 检查SCons是否已安装并在PATH中,确保构建目录存在
Q: 如何更改项目类型?
A: 在VSCode设置中修改fuxi.projectType
配置项
Q: 构建失败怎么办?
A: 查看终端输出的错误信息,确认构建环境和依赖是否正确安装
调试信息
开启VSCode开发者工具查看控制台输出:
Help > Toggle Developer Tools
- 查看Console标签页的插件日志
调试步骤:
- 打开VSCode开发者工具 (
Help > Toggle Developer Tools
)
- 切换到Console标签页
- 在过滤器中输入 "Fuxi" 查看插件相关日志
- 执行构建操作,观察日志输出
- 如有错误,日志会显示详细的错误信息和堆栈跟踪
常见日志信息:
[Fuxi Build] 插件激活
- 插件成功加载
[Fuxi Build] 检测到项目类型: mic
- 项目类型检测结果
[Fuxi Build] 切换到构建目录: apps/mic/gcc
- 目录切换信息
[Fuxi Build] 执行构建命令: scons -s -j8 target=...
- 构建命令详情
[Fuxi Build] 构建完成,耗时: X秒
- 构建结果统计
截图调试:
如果遇到界面显示问题,可以:
- 截图保存当前VSCode界面状态
- 记录状态栏显示的具体内容
- 查看侧边栏面板是否正常显示
- 检查命令面板中是否包含Fuxi相关命令
更新日志
v1.0.0
- 初始版本发布
- 支持基本的构建、清理、重新构建功能
- 支持多构建目标选择
- 集成状态栏和侧边栏视图
- 支持快捷键操作
贡献指南
欢迎提交Issue和Pull Request来改善这个插件!
许可证
MIT License