ThingBoot Studio
芯步设备开发的一站式 VSCode 工具：免配置工具链、产品与 ENV 管理、编译烧录、设备调试、固件发布，以及面向 Kimi Code 等 AI 智能体的开发接口。
One-stop ThingBoot device development — zero-config toolchain, guided project setup, firmware debugging and publishing, plus local APIs for AI coding agents.
你能用它做什么
从空目录开始新产品
- 安装托管开发环境，不依赖本机已有 Python、PlatformIO 或 ESP-IDF。
- 通过新建工程向导选择 SDK、芯片、联网方式、功能扩展和 Flash。
- 创建芯步产品并维护物模型，关联 ENV 后生成规范化工程。
- 编译、烧录、串口监视，验证设备启动与平台接入。
- 打包并发布到芯步 OTA 固件库。
支持 ThingBoot Arduino SDK、ESP-IDF SDK 和 STM32 SDK。覆盖 ESP32、ESP8266/8285 及 STM32F407 等目标。
把成熟产品迁移到芯步 SDK
- 评估现有工程类型、ENV、SDK 引用和
setProduct 写法。
- 对照官方 SDK 能力与真实示例，分模块迁移业务代码。
- 检查宏参数、联网 addon、分区表、脚本编码和构建配置。
- 用结构化 GCC 诊断定位文件、行、列，再迭代编译验证。
原有产品可以保留业务逻辑，不需要先重写成另一套应用。
让 Kimi Code 等智能体协助开发
插件提供 CLI + 本机回环 HTTP API，适用于能够执行 Bash/curl 的 Agent：
- 查询工程、ENV、面板状态和 SDK 能力。
- 创建/替换 ENV，创建产品，维护产品定义与物模型。
- 创建和查询接入码；固件列表不包含下载令牌。
- 异步构建、打包、烧录、监视、清理、擦除与发布。
- 查询任务、完整日志、产物和结构化编译诊断。
- 执行项目评估、静态重构检查，读取官方 SDK 示例。
调试卡片可生成 THINGBOOT_AGENT.md 和工作区本地 CLI 启动器，Agent 读完即可按指引工作。
核心能力
托管开发环境
- Python、PlatformIO、工具链和框架包独立托管，不污染用户现有环境。
- 芯步官方 ZIP 优先，GitHub/Gitee 回退，支持多源测速、断点续传和超时处理。
- 环境自检、包完整性检查、损坏修复和版本对齐提示。
- 严格隔离继承的
PLATFORMIO_*、MSys/Python 串扰变量。
产品与物模型
- 产品创建、模板复制、选择和基本信息维护。
- 属性、指令、事件、配置、规格五类定义管理。
- 接入码创建、查询和删除；新接入码仅在创建响应中完整返回一次。
- 固件版本登记、变体管理和下载信息查询。
ENV 与构建配置
platformio.ini 管理 ENV 存在性，thingboot.ini 管理产品信息。- 每个 ENV 独立产品、SDK、MCU、板型、Flash、联网方式和固件版本。
- 编译期自动写入
thingboot_product.h，产品 Secret 不交给 Agent。
- 支持 PIO 工程和自定义命令工程（例如 maker 固件）。
- ENV 名称、ProductKey、完整编译版本一键复制。
编译、烧录与串口
- 任务制构建，错误进入 VSCode Problems。
- 自动识别串口，支持烧录、烧录+监视、擦除、Clean/Full Clean。
- 串口监视复用异常解码器；同串口任务自动互斥和替换。
- IDF 已有产物时烧录使用
nobuild，避免每次重复编译。
- 修改源码后应先重新编译，再烧录。
设备控制与发布
- 设备列表、在线状态、属性控制、系统指令和配置。
- 实时设备消息与调试链路。
- ESP32 三件套 tar 打包、ESP8266 单 bin gzip 打包。
- 发布前检查魔数、板型标记、版本字符串和包完整性，直传芯步 OTA 固件库。
界面与文档
调试与发布卡片提供“生成 AI 接入文档”，同时生成工作区 CLI 启动器，不修改全局 PATH。
插件包内附真实界面截图：media/screenshots/agent-guide.png。
快速开始
- 点击活动栏 ThingBoot Studio 图标。
- 在「环境」页选择托管目录，点击 一键安装环境。
- 在「调试」页新建工程，或打开已有 PlatformIO/自定义工程。
- 添加并完善 ENV，然后执行 编译 → 烧录 → 串口监视。
- 点击头像登录芯步帐号，使用产品、设备和发布功能。
- 需要 Agent 时，点击 生成 AI 接入文档，把文档交给 Agent。
Agent 快速示例
在工程根目录（Git Bash）：
TB=.thingboot/agent/bin/thingboot-studio
"$TB" environments --json
"$TB" capabilities --sdk esp-idf --mcu esp32s3 --json
"$TB" check --json
"$TB" build --env default_esp32s3_4M --wait --json
"$TB" diagnostics --id <任务ID> --json
HTTP 仅监听 127.0.0.1，除 health 外均要求 Bearer 令牌。完整协议见 docs/智能体接口.md。
权限与安全
Agent 权限默认全部开启，可在 VSCode 设置中逐项关闭：
| 配置 |
控制范围 |
thingboot.agent.allowEnvWrites |
创建、替换和删除 ENV |
thingboot.agent.allowPlatformWrites |
产品、产品定义与物模型写入 |
thingboot.agent.allowAccessCodeWrites |
接入码创建与删除 |
thingboot.agent.allowDeviceOperations |
烧录、擦除、监视 |
thingboot.agent.allowClean |
Clean / Full Clean |
thingboot.agent.allowPublish |
固件发布 |
thingboot.agent.confirmation 控制执行前确认：
dangerous（默认）：危险任务、云端修改、接入码和 ENV 删除需要用户确认。always：所有写操作都需要确认。never：不弹确认，但权限和 confirm:true 校验仍生效。
所有 Agent 写操作都有界面提示；任务可从 VSCode 通知中取消。只读查询不弹提示。
常用配置
| 配置 |
默认值 |
说明 |
thingboot.platform.apiBase |
空 |
默认 https://app.thingboot.com；私有化部署时填写 |
thingboot.env.rootDir |
Windows：C:\ThingBoot；其他：~/.thingboot/core |
托管环境根目录，建议英文短路径 |
thingboot.env.proxy |
空 |
下载代理，留空读取系统设置 |
thingboot.flash.port |
auto |
默认烧录串口，ENV 的 ini 配置优先 |
thingboot.flash.baud |
921600 |
默认烧录波特率 |
thingboot.monitor.baud |
115200 |
默认监视波特率 |
thingboot.ui.language |
auto |
跟随 VSCode，也可指定 zh/en |
调试日志：头像菜单底部版本号连点 3 次，开启/关闭 ThingBoot API（调试） Output 通道。调试模式只控制日志，不切换平台地址。
常用命令
| 命令 |
用途 |
ThingBoot: 新建工程 |
按 SDK、芯片、联网和 Flash 创建工程 |
ThingBoot: 检查并修复开发环境 |
检查并修复托管环境 |
ThingBoot: 冒烟验证（编译官方示例） |
验证工具链端到端可用 |
ThingBoot: 登录芯步帐号 / 退出登录 |
管理芯步 OAuth 登录态 |
ThingBoot: 使用手册 |
在编辑器中打开使用手册 |
相关链接
- 芯步 SDK 使用手册
- 设备私有化部署手册
- 开发者中心与接入码
- Arduino SDK：https://github.com/ThingBoot/thingboot-device-esp-arduino-sdk
- ESP-IDF SDK：https://github.com/ThingBoot/thingboot-device-esp-idf-sdk
- STM32 SDK：https://github.com/ThingBoot/thingboot-device-stm32-sdk
License
Copyright © ThingBoot. All rights reserved.
