BaudAI

面向 PlatformIO 项目的 MCU 开发辅助工具集。

English README

简介

BaudAI 提供一组面向嵌入式开发工作流的脚本，用于把常见任务标准化：

• 初始化项目级 Copilot 指令和记忆文件
• 编译 PlatformIO 固件
• 以 Mock 模式或真实硬件模式烧录固件
• 模拟启动串口日志，便于流程演练和 AI 分析
• 调整目标项目里的导师人格配置
• 通过交互式 CLI 统一入口执行这些操作

工具本身不写死具体板卡型号，默认读取目标项目自己的 platformio.ini。

环境要求

• Node.js
• npm
• PlatformIO Core
• 一个可以正常构建的 PlatformIO 项目

快速开始

请将 ../your-platformio-project 替换为你自己的 PlatformIO 项目路径。

cd BaudAI
npm install
npx tsx skills/build.ts ../your-platformio-project
npx tsx skills/flash.ts ../your-platformio-project
npx tsx skills/flash.ts ../your-platformio-project --real --port COM5

从 npm 安装

在包发布到 npm 之后，可以全局安装，然后在目标 PlatformIO 项目根目录中使用：

npm install -g baudai
cd ../your-platformio-project
baudai
baudai build
baudai flash --real --port COM5

如果不想全局安装，也可以直接使用：

npx baudai

常用命令

npx tsx skills/init.ts ../your-platformio-project
npx tsx skills/build.ts ../your-platformio-project [environment]
npx tsx skills/flash.ts ../your-platformio-project [environment] [--mock|--real] [--port COM5] [--baud 921600]
npx tsx skills/monitor.ts
npx tsx skills/config.ts ../your-platformio-project

如果想使用交互式 CLI，请在目标 PlatformIO 项目目录中运行：

cd ../your-platformio-project
npx tsx ../BaudAI/skills/cli.ts

说明

• flash.ts 默认是 Mock 模式，只有传入 --real 才会尝试真实烧录。
• monitor.ts 当前输出的是 Mock 启动日志，不会直接连接物理串口。
• build.ts、flash.ts、monitor.ts、init.ts 会输出带边界标记的 JSON，便于自动化工具解析。

发布到 npm

发布前建议先确认：

• npm 上的包名是否可用
• package.json 里的版本号是否已经更新
• 先用 npm run pack:check 检查最终会被发布的文件

发布流程：

npm login
npm run pack:check
npm publish

公开仓库建议

如果这个仓库会长期公开，建议保持这些习惯：

• 不要把本机绝对路径写进 README 或示例命令
• 不要把私有项目名、内部板卡代号或真实设备清单写进文档
• 不要把密钥、令牌、串口清单或带敏感信息的截图提交到仓库