tirtc-device-builder 0.11.1 → 0.11.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.codex-plugin/plugin.json +1 -1
- package/CHANGELOG.md +16 -0
- package/README.md +178 -20
- package/package.json +1 -1
- package/skills/tirtc-beken-builder/SKILL.md +6 -7
- package/skills/tirtc-beken-builder/VERSION +1 -1
- package/skills/tirtc-beken-builder/references/lckfb-bk7258-lessons.md +6 -7
- package/skills/tirtc-beken-builder/references/tirtc-integration.md +1 -1
- package/skills/tirtc-esp32-builder/VERSION +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
This project follows Semantic Versioning.
|
|
4
4
|
|
|
5
|
+
## 0.11.3
|
|
6
|
+
|
|
7
|
+
- Add a complete Beken onboarding path to the public README: Skill installation,
|
|
8
|
+
official SDK baseline checks, Doctor usage, hardware-probe intake, XiaoTai
|
|
9
|
+
integration flow, update commands and troubleshooting.
|
|
10
|
+
- Separate ESP32 and Beken requirements so users do not mistake `install beken`
|
|
11
|
+
for a managed SDK or Device Kit installation.
|
|
12
|
+
- Add a regression test that keeps the Beken install and Doctor commands in the
|
|
13
|
+
packaged README.
|
|
14
|
+
|
|
15
|
+
## 0.11.2
|
|
16
|
+
|
|
17
|
+
- Make the LCKFB BK7258 XiaoTai development profile default to DEBUG logging,
|
|
18
|
+
with complete HTTP, MQTT and TiRTC/WHIP inputs and results available without
|
|
19
|
+
a separate diagnostic build; INFO remains available to suppress wire payloads.
|
|
20
|
+
|
|
5
21
|
## 0.11.1
|
|
6
22
|
|
|
7
23
|
- Pin the BK7258 public baseline to the official Gitee
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TiRTC Device Builder
|
|
2
2
|
|
|
3
|
-
TiRTC Device Builder 用于把 ESP32-S3/ESP32-P4 开发板接入 TiRTC。输入可以只有开发板型号,也可以包含原理图、BSP、引脚表和外设示例。安装后的 Agent Skill
|
|
3
|
+
TiRTC Device Builder 用于把 ESP32-S3/ESP32-P4 和 BK7258/BK7259 开发板接入 TiRTC。输入可以只有开发板型号,也可以包含原理图、BSP、引脚表和外设示例。安装后的 Agent Skill 会先检查环境、整理有依据的硬件事实,再生成或移植独立工程并完成板级适配和编译。烧录和实机验证只有在开发者明确给出目标串口并授权后才会执行。
|
|
4
4
|
|
|
5
5
|
当前仓库提供两个平台 Skill:
|
|
6
6
|
|
|
@@ -9,10 +9,11 @@ TiRTC Device Builder 用于把 ESP32-S3/ESP32-P4 开发板接入 TiRTC。输入
|
|
|
9
9
|
| `tirtc-esp32-builder` | ESP32-S3 / ESP32-P4、ESP-IDF 5.5.x | 板型识别、Hardware IR、工程生成/移植、H5/AI/设备互呼/微信 VoIP、AEC 门禁、编译烧录和分层验收 |
|
|
10
10
|
| `tirtc-beken-builder` | BK7258 / BK7259、Beken Armino | 运行时硬件探测、显示/触摸/音频/内存能力判定、小钛业务移植与实机验收 |
|
|
11
11
|
|
|
12
|
-
BK7258
|
|
13
|
-
`release/v3.1.1.
|
|
14
|
-
|
|
15
|
-
|
|
12
|
+
BK7258 多媒体项目固定从 Beken 官方 Gitee `bk_avdk_smp` 的
|
|
13
|
+
`release/v3.1.1.8` tag、commit
|
|
14
|
+
`1cfd56af09a3cb6470f35f1e0c604035ed1b6ee7` 开始。本机或厂商交付的
|
|
15
|
+
同名改版目录只能作为参考,不能冒充该公开基准。BK7259 使用前应按官方
|
|
16
|
+
支持矩阵选择对应 release,不把 BK7258 的 BSP、分区或二进制直接套用。
|
|
16
17
|
|
|
17
18
|
H5/AI 的 ESP32-S3 托管模板、协议文档和 TiRTC SDK 已打包在独立的 ESP32 Device Kit 中,安装时会自动下载并校验。ESP32 示例源码由本仓库的 `kit-src/` 维护;设备互呼或微信 VoIP 的移植可参考其中的独立示例。ESP32-P4 使用独立发布的 `tirtc-esp32p4-kit`(小钛 P4 参考固件:hosted C6 Wi-Fi + LVGL UI + 摄像头 + P4 SDK 2.5.0),通过生成器 `--target esp32p4` 复制生成,不能复用 S3 预编译库。
|
|
18
19
|
|
|
@@ -44,7 +45,11 @@ npm --version
|
|
|
44
45
|
|
|
45
46
|
`node --version` 应输出 `v18.x` 或更高版本。如果终端提示找不到 `node` 或 `npm`,先从 [Node.js 官方下载页](https://nodejs.org/en/download) 安装受支持版本,再打开一个新终端。
|
|
46
47
|
|
|
47
|
-
### 2.
|
|
48
|
+
### 2. 安装对应平台的 Skill
|
|
49
|
+
|
|
50
|
+
#### ESP32
|
|
51
|
+
|
|
52
|
+
ESP32 使用托管安装,它会同时准备 Skill、Device Kit、ESP-IDF 和工具链:
|
|
48
53
|
|
|
49
54
|
```bash
|
|
50
55
|
npx --yes tirtc-device-builder@latest setup esp32 --install
|
|
@@ -77,13 +82,43 @@ Start a new Codex session, then ask it to use tirtc-esp32-builder.
|
|
|
77
82
|
|
|
78
83
|
如果看到 `OVERALL: NEEDS_SETUP`、`MISS` 或 `FAIL`,先看[常见问题](#常见问题)。
|
|
79
84
|
|
|
85
|
+
#### Beken
|
|
86
|
+
|
|
87
|
+
BK7258/BK7259 安装 `tirtc-beken-builder`:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
npx --yes tirtc-device-builder@latest install beken
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
默认安装到 Codex。其他客户端使用同一个 `--client` 参数,例如:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
npx --yes tirtc-device-builder@latest install beken --client qwen-code
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Beken 当前没有 `setup beken` 托管环境命令,也没有公开的独立 BK Device
|
|
100
|
+
Kit;上面的命令只安装 Skill。SDK、工具链和板级工程仍由目标项目准备。
|
|
101
|
+
安装后可用固定的官方 SDK checkout 做只读检查:
|
|
102
|
+
|
|
103
|
+
```bash
|
|
104
|
+
npx --yes tirtc-device-builder@latest doctor beken \
|
|
105
|
+
--sdk-root /absolute/path/to/bk_avdk_smp
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
其中 BK7258 的公开基准应是 `release/v3.1.1.8`、commit
|
|
109
|
+
`1cfd56af09a3cb6470f35f1e0c604035ed1b6ee7`。
|
|
110
|
+
|
|
80
111
|
### 3. 重新打开 Agent 客户端
|
|
81
112
|
|
|
82
113
|
Skill 通常在 Agent 会话启动时被发现。安装完成后,关闭当前会话,再打开一个新会话。
|
|
83
114
|
|
|
84
115
|
### 4. 把板卡和目标告诉 Agent
|
|
85
116
|
|
|
86
|
-
|
|
117
|
+
不用先查齐所有硬件参数。先选平台,再把已经掌握的信息交给 Agent;本地路径尽量相对工作区填写,不确定的内容写“未知”。
|
|
118
|
+
|
|
119
|
+
#### ESP32 接入提示词
|
|
120
|
+
|
|
121
|
+
完整模板见 [ESP32 开发板接入提示词](skills/tirtc-esp32-builder/assets/developer-intake-prompt.md)。
|
|
87
122
|
|
|
88
123
|
```text
|
|
89
124
|
请使用 tirtc-esp32-builder Skill 完成这块开发板的 TiRTC 移植。
|
|
@@ -124,6 +159,30 @@ H5 对讲和 AI 双向对讲。
|
|
|
124
159
|
|
|
125
160
|
只有型号时,Skill 会先调查公开资料并列出缺口,不会猜测 GPIO、器件或媒体能力。要进入代码移植,通常还需要准确的板卡版本、原理图,以及能在实物上运行的 BSP 或外设示例。
|
|
126
161
|
|
|
162
|
+
#### Beken 接入提示词
|
|
163
|
+
|
|
164
|
+
完整模板见 [Beken 开发板接入提示词](skills/tirtc-beken-builder/assets/developer-intake-prompt.md)。下面这段可以直接作为起点:
|
|
165
|
+
|
|
166
|
+
```text
|
|
167
|
+
请使用 tirtc-beken-builder Skill 诊断并接入这块开发板。
|
|
168
|
+
|
|
169
|
+
- 厂商、完整型号、PCB 丝印/版本:<填写>
|
|
170
|
+
- SoC:<BK7258/BK7259/未知>
|
|
171
|
+
- 官方 SDK/BSP 路径与 revision:<填写>
|
|
172
|
+
- 原理图、BOM、屏幕/触摸/音频资料:<路径或链接>
|
|
173
|
+
- 已验证的 LCD、触摸、录音、播放示例:<填写>
|
|
174
|
+
- 小钛目标功能:<H5 音视频/对讲、AI 对话、设备互呼、微信 VoIP>
|
|
175
|
+
- 输出工程目录:<填写>
|
|
176
|
+
|
|
177
|
+
请先核验 SDK 基线,再实现并运行只读或低风险的程序探测,输出
|
|
178
|
+
probe-report.json。分别记录 BSP 声明、运行时检出和主动实测结果;检查
|
|
179
|
+
Flash、RAM/PSRAM、显示与触摸、麦克风、扬声器、采集格式、全双工回采
|
|
180
|
+
和 AEC。未知项不要猜。根据探测结果裁剪小钛功能,再完成可安全执行的
|
|
181
|
+
移植和构建。本轮不烧录、不擦除、不改写工厂分区。
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
Beken 的屏幕尺寸通常不能只靠总线扫描可靠识别。Skill 会结合固定 SDK/BSP、驱动清单和主动色块测试;触摸、录音、播放和 AEC 则需要各自的运行时测试。探测结果用于决定 UI 是触摸、按键还是无屏模式,以及哪些小钛能力可以启用。
|
|
185
|
+
|
|
127
186
|
### 示例对话
|
|
128
187
|
|
|
129
188
|
新板卡、先做资料评审:
|
|
@@ -153,9 +212,11 @@ Codex:只有 exact identity 且 safe_registered_reuse=true 才复用板级包
|
|
|
153
212
|
会话切换和重连;旧固件的 HIL 结果不会继承给新固件。
|
|
154
213
|
```
|
|
155
214
|
|
|
156
|
-
##
|
|
215
|
+
## 两个平台的工作流程
|
|
216
|
+
|
|
217
|
+
两种平台都遵循“先取证、再实现、最后实机验收”,但产物和工具链不同。
|
|
157
218
|
|
|
158
|
-
|
|
219
|
+
### ESP32
|
|
159
220
|
|
|
160
221
|
```text
|
|
161
222
|
开发板型号、原理图、BSP、数据手册
|
|
@@ -202,6 +263,26 @@ Skill 负责:
|
|
|
202
263
|
|
|
203
264
|
编译成功只代表构建层通过。只有拿到浏览器画面、实体扬声器声音和双向 AI 音频的实测证据,报告才能把对应能力标为 `PASS`。
|
|
204
265
|
|
|
266
|
+
### Beken
|
|
267
|
+
|
|
268
|
+
```text
|
|
269
|
+
板卡、原理图、BSP 和固定 SDK revision
|
|
270
|
+
│
|
|
271
|
+
▼
|
|
272
|
+
诊断固件 → probe-report.json
|
|
273
|
+
│
|
|
274
|
+
▼
|
|
275
|
+
显示/触摸/音频/Flash/RAM 能力矩阵
|
|
276
|
+
│
|
|
277
|
+
▼
|
|
278
|
+
小钛功能裁剪与 Beken 工程适配
|
|
279
|
+
│
|
|
280
|
+
▼
|
|
281
|
+
构建 → 授权烧录 → HIL
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
Beken Skill 先核验 SDK 来源,再把文档声明和实机探测分开记录。独立诊断固件通过后,还要在最终业务固件中复测资源余量和外设共存;单独示例能运行,不代表小钛业务合入后仍然成立。`probe-report.json`、SDK revision、固件哈希、能力结论和剩余阻塞项共同构成交付证据。
|
|
285
|
+
|
|
205
286
|
## 准备板卡资料
|
|
206
287
|
|
|
207
288
|
板卡资料要和手上的实物版本对应。建议为每块板、每个 PCB 版本单独建目录,避免混入相似型号的文档。
|
|
@@ -281,7 +362,7 @@ board-materials/
|
|
|
281
362
|
|
|
282
363
|
## 依赖和支持范围
|
|
283
364
|
|
|
284
|
-
###
|
|
365
|
+
### ESP32 基线
|
|
285
366
|
|
|
286
367
|
| 项目 | 当前要求 |
|
|
287
368
|
|---|---|
|
|
@@ -299,9 +380,21 @@ board-materials/
|
|
|
299
380
|
|
|
300
381
|
从本仓库 `kit-src/` 直接生成或打包时使用 TiRTC 2.5.0;`setup esp32` 安装固定的 Kit 版本,其 SDK 版本以该 Kit 的 `manifest.json` 为准。
|
|
301
382
|
|
|
383
|
+
### Beken 基线
|
|
384
|
+
|
|
385
|
+
| 项目 | 当前要求 |
|
|
386
|
+
|---|---|
|
|
387
|
+
| 芯片 | BK7258 / BK7259,具体型号必须由板卡资料或运行时证据确认 |
|
|
388
|
+
| BK7258 SDK | Beken 官方 Gitee `bk_avdk_smp` `release/v3.1.1.8`,commit `1cfd56af09a3cb6470f35f1e0c604035ed1b6ee7` |
|
|
389
|
+
| BK7259 SDK | 按官方支持矩阵选择匹配的正式 release;不复用 BK7258 的 BSP、分区或二进制 |
|
|
390
|
+
| 安装范围 | npm 命令安装 Skill;SDK、工具链和板级工程由目标项目准备 |
|
|
391
|
+
| 诊断产物 | `probe-report.json`,包含来源、探测方式、原始值、置信度和能力判定 |
|
|
392
|
+
|
|
393
|
+
同名的本机目录或厂商交付包可能含有私有组件和补丁,不能据此声称它等同于公开 tag。确实要基于改版 SDK 开发时,应把它的远端、commit 和差异清单单独记录,并以官方 Gitee 基线作为比较对象。
|
|
394
|
+
|
|
302
395
|
### 本机软件
|
|
303
396
|
|
|
304
|
-
`setup esp32 --install` 会检查以下基础命令:
|
|
397
|
+
ESP32 的 `setup esp32 --install` 会检查以下基础命令:
|
|
305
398
|
|
|
306
399
|
| 命令 | 用途 |
|
|
307
400
|
|---|---|
|
|
@@ -312,6 +405,8 @@ board-materials/
|
|
|
312
405
|
|
|
313
406
|
Doctor 还会检查 `cmake`、`ninja`、`idf.py` 和 `xtensa-esp32s3-elf-gcc`。安装器不会调用系统包管理器;缺少基础命令时,需要开发者按当前操作系统安装。
|
|
314
407
|
|
|
408
|
+
Beken Doctor 会检查 `python3`、`git`、`make`、`cmake`、`ninja`、SDK 必需目录和 Git revision。厂商交叉编译器及其环境变量仍以所选 SDK 的正式文档和目标工程为准;`install beken` 不会替开发者安装这些组件。
|
|
409
|
+
|
|
315
410
|
Ubuntu、Debian 或 WSL 可以参考:
|
|
316
411
|
|
|
317
412
|
```bash
|
|
@@ -326,6 +421,7 @@ sudo apt-get install -y git python3 python3-venv bash tar
|
|
|
326
421
|
- npm 官方 Registry,用于取得 `tirtc-device-builder`;
|
|
327
422
|
- GitHub Release,用于下载 ESP32 Device Kit;
|
|
328
423
|
- Espressif 的 GitHub 仓库和工具下载地址,用于安装 ESP-IDF 与工具链。
|
|
424
|
+
- Beken 官方 Gitee/GitHub 和文档站,用于取得并核验 Beken SDK 与芯片资料。
|
|
329
425
|
|
|
330
426
|
H5 和 AI 的端到端验收还需要可访问的 ThingConnect 服务、可用账号、设备绑定条件、浏览器和外网。缺少其中一项,不影响工程生成和编译,但对应验收层要记录为 `SKIP`。
|
|
331
427
|
|
|
@@ -340,16 +436,22 @@ ThingConnect 平台和 Web 播放端支持 MJPEG、H.264、H.265;具体开发
|
|
|
340
436
|
### 推荐:用 npx 一次检查并安装
|
|
341
437
|
|
|
342
438
|
```bash
|
|
439
|
+
# ESP32:Skill + Device Kit + ESP-IDF + 工具链
|
|
343
440
|
npx --yes tirtc-device-builder@latest setup esp32 --install
|
|
441
|
+
|
|
442
|
+
# BK7258/BK7259:安装 Skill
|
|
443
|
+
npx --yes tirtc-device-builder@latest install beken
|
|
344
444
|
```
|
|
345
445
|
|
|
346
|
-
`npx` 会临时取得最新 CLI
|
|
446
|
+
`npx` 会临时取得最新 CLI 并运行,不要求全局安装。`setup` 当前只支持
|
|
447
|
+
ESP32;Beken 使用 `install beken`,不会自动下载 SDK 或工具链。
|
|
347
448
|
|
|
348
449
|
### 也可以全局安装
|
|
349
450
|
|
|
350
451
|
```bash
|
|
351
452
|
npm install --global tirtc-device-builder@latest
|
|
352
453
|
tirtc-device-builder setup esp32 --install
|
|
454
|
+
tirtc-device-builder install beken
|
|
353
455
|
```
|
|
354
456
|
|
|
355
457
|
安装命令是 `npm install`,不要写成 `npm --install`。
|
|
@@ -365,13 +467,17 @@ tirtc-device-builder setup esp32 --install
|
|
|
365
467
|
```bash
|
|
366
468
|
npx --yes tirtc-device-builder@latest install esp32
|
|
367
469
|
npx --yes tirtc-device-builder@latest install esp32 --client gemini
|
|
470
|
+
npx --yes tirtc-device-builder@latest install beken
|
|
471
|
+
npx --yes tirtc-device-builder@latest install bk7258 --client gemini
|
|
368
472
|
```
|
|
369
473
|
|
|
370
|
-
|
|
474
|
+
`beken`、`bk`、`bk7258`、`bk7259` 和 `tirtc-beken-builder` 都会解析为同一
|
|
475
|
+
个 Beken Skill。`install` 不安装 SDK、工具链或 Device Kit。ESP32 的完整
|
|
476
|
+
新用户环境仍建议使用 `setup esp32 --install`。
|
|
371
477
|
|
|
372
478
|
### 支持的 Agent 客户端
|
|
373
479
|
|
|
374
|
-
|
|
480
|
+
所选平台的完整 Skill 会复制到客户端的原生目录,不维护客户端专用的内容副本。先用下面的命令查看当前机器解析出的目录:
|
|
375
481
|
|
|
376
482
|
```bash
|
|
377
483
|
npx --yes tirtc-device-builder@latest clients
|
|
@@ -399,7 +505,8 @@ Cline 当前还需要在 `Settings → Features → Enable Skills` 中启用实
|
|
|
399
505
|
|
|
400
506
|
| 内容 | 默认位置 |
|
|
401
507
|
|---|---|
|
|
402
|
-
| Agent Skill | 上表中所选目录下的 `tirtc-esp32-builder` |
|
|
508
|
+
| ESP32 Agent Skill | 上表中所选目录下的 `tirtc-esp32-builder` |
|
|
509
|
+
| Beken Agent Skill | 上表中所选目录下的 `tirtc-beken-builder` |
|
|
403
510
|
| 托管根目录 | `~/.tirtc-device-builder` |
|
|
404
511
|
| Device Kit | `~/.tirtc-device-builder/kits/esp32s3/1.1.7` |
|
|
405
512
|
| ESP-IDF | `~/.tirtc-device-builder/esp-idf-v5.5.4` |
|
|
@@ -456,10 +563,14 @@ npx --yes tirtc-device-builder@latest setup esp32 --install \
|
|
|
456
563
|
默认安装不会覆盖已有 Skill,以免丢失本地修改。确认这些修改不需要保留后,可用最新 npm 包替换:
|
|
457
564
|
|
|
458
565
|
```bash
|
|
566
|
+
# ESP32
|
|
459
567
|
npx --yes tirtc-device-builder@latest setup esp32 --install --force-skill
|
|
568
|
+
|
|
569
|
+
# Beken
|
|
570
|
+
npx --yes tirtc-device-builder@latest install beken --force
|
|
460
571
|
```
|
|
461
572
|
|
|
462
|
-
|
|
573
|
+
这两条命令都只替换对应 Skill。ESP32 已通过校验的 Device Kit 和 ESP-IDF 会继续复用;Beken 的 SDK 和工程不会被改动。自定义脚本或规则请提前备份。
|
|
463
574
|
|
|
464
575
|
## 常用检查和开发命令
|
|
465
576
|
|
|
@@ -480,10 +591,25 @@ npx --yes tirtc-device-builder@latest --help
|
|
|
480
591
|
npx --yes tirtc-device-builder@latest list
|
|
481
592
|
npx --yes tirtc-device-builder@latest clients
|
|
482
593
|
npx --yes tirtc-device-builder@latest setup esp32 --help
|
|
594
|
+
npx --yes tirtc-device-builder@latest doctor beken --help
|
|
483
595
|
```
|
|
484
596
|
|
|
485
597
|
### 生成工程前运行 Doctor
|
|
486
598
|
|
|
599
|
+
Beken 使用已准备好的固定 SDK checkout:
|
|
600
|
+
|
|
601
|
+
```bash
|
|
602
|
+
npx --yes tirtc-device-builder@latest doctor beken \
|
|
603
|
+
--sdk-root /absolute/path/to/bk_avdk_smp
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
输出中的基础工具、SDK 必需路径和 `sdk-revision` 均应为 `PASS`。BK7258
|
|
607
|
+
应另外核对 revision 为
|
|
608
|
+
`1cfd56af09a3cb6470f35f1e0c604035ed1b6ee7`。Doctor 是只读检查,不会下载
|
|
609
|
+
SDK、修改工程或烧录设备。
|
|
610
|
+
|
|
611
|
+
ESP32 使用托管环境:
|
|
612
|
+
|
|
487
613
|
```bash
|
|
488
614
|
source ~/.tirtc-device-builder/env.sh
|
|
489
615
|
|
|
@@ -756,22 +882,33 @@ npm view tirtc-device-builder version
|
|
|
756
882
|
|
|
757
883
|
### `npm login` 提示无法打开浏览器
|
|
758
884
|
|
|
759
|
-
普通使用者不需要登录 npm
|
|
885
|
+
普通使用者不需要登录 npm。按平台直接执行:
|
|
760
886
|
|
|
761
887
|
```bash
|
|
888
|
+
# ESP32
|
|
762
889
|
npx --yes tirtc-device-builder@latest setup esp32 --install
|
|
890
|
+
|
|
891
|
+
# Beken
|
|
892
|
+
npx --yes tirtc-device-builder@latest install beken
|
|
763
893
|
```
|
|
764
894
|
|
|
765
895
|
`npm login` 只供维护者发布包,与安装公开包无关。
|
|
766
896
|
|
|
767
897
|
### 输出 `OVERALL: NEEDS_SETUP`
|
|
768
898
|
|
|
769
|
-
|
|
899
|
+
ESP32 出现这个结果,表示只读检查发现托管环境尚未准备完整。按输出提示执行安装:
|
|
770
900
|
|
|
771
901
|
```bash
|
|
772
902
|
npx --yes tirtc-device-builder@latest setup esp32 --install
|
|
773
903
|
```
|
|
774
904
|
|
|
905
|
+
Beken 没有托管环境安装。先按 Doctor 输出补齐基础工具、SDK 或工程路径,再重新检查:
|
|
906
|
+
|
|
907
|
+
```bash
|
|
908
|
+
npx --yes tirtc-device-builder@latest doctor beken \
|
|
909
|
+
--sdk-root /absolute/path/to/bk_avdk_smp
|
|
910
|
+
```
|
|
911
|
+
|
|
775
912
|
### 提示缺少 `python3`、`git`、`bash` 或 `tar`
|
|
776
913
|
|
|
777
914
|
安装器不会运行 `sudo`。请用当前系统的包管理器补齐这些命令,再执行 `setup esp32 --install`。安装可以续跑,已经完成的部分会被复用。
|
|
@@ -809,6 +946,7 @@ npx --yes tirtc-device-builder@latest setup esp32 --install \
|
|
|
809
946
|
```bash
|
|
810
947
|
npx --yes tirtc-device-builder@latest clients
|
|
811
948
|
ls -l <skills-dir>/tirtc-esp32-builder/SKILL.md
|
|
949
|
+
ls -l <skills-dir>/tirtc-beken-builder/SKILL.md
|
|
812
950
|
```
|
|
813
951
|
|
|
814
952
|
确认安装和启动的是同一个客户端,例如 Qwen Code 要使用 `--client qwen-code`。设置过 `CODEX_HOME`、`XDG_CONFIG_HOME` 或 `--skills-dir` 时,要检查对应目录。项目级目录由客户端自身规则决定,可以用 `--skills-dir` 显式指定。
|
|
@@ -818,10 +956,26 @@ ls -l <skills-dir>/tirtc-esp32-builder/SKILL.md
|
|
|
818
956
|
安装器检测到本地已有 Skill,因此没有直接覆盖。确认可以替换后执行:
|
|
819
957
|
|
|
820
958
|
```bash
|
|
959
|
+
# ESP32 托管安装
|
|
821
960
|
npx --yes tirtc-device-builder@latest setup esp32 --install --force-skill
|
|
961
|
+
|
|
962
|
+
# ESP32 或 Beken 仅替换 Skill
|
|
963
|
+
npx --yes tirtc-device-builder@latest install esp32 --force
|
|
964
|
+
npx --yes tirtc-device-builder@latest install beken --force
|
|
965
|
+
```
|
|
966
|
+
|
|
967
|
+
替换前先确认本地 Skill 没有需要保留的修改。
|
|
968
|
+
|
|
969
|
+
### Beken Skill 已安装,但 Doctor 仍未通过
|
|
970
|
+
|
|
971
|
+
这是两个不同阶段。`install beken` 只把 Skill 放进 Agent 客户端,不下载 Beken SDK,也不配置厂商工具链。请先准备官方 SDK checkout,再运行:
|
|
972
|
+
|
|
973
|
+
```bash
|
|
974
|
+
npx --yes tirtc-device-builder@latest doctor beken \
|
|
975
|
+
--sdk-root /absolute/path/to/bk_avdk_smp
|
|
822
976
|
```
|
|
823
977
|
|
|
824
|
-
|
|
978
|
+
BK7258 应以官方 Gitee `release/v3.1.1.8`、commit `1cfd56af09a3cb6470f35f1e0c604035ed1b6ee7` 为公开基线。如果当前工程来自厂商交付包,应保留差异,但要把它标成改版工程,不能当作官方基准。
|
|
825
979
|
|
|
826
980
|
### Device Kit 下载失败
|
|
827
981
|
|
|
@@ -911,7 +1065,11 @@ Skill、Device Kit 和 ESP-IDF 会写到 npm 包目录之外,也可能占用
|
|
|
911
1065
|
|
|
912
1066
|
### 能支持 ESP32 之外的芯片吗?
|
|
913
1067
|
|
|
914
|
-
|
|
1068
|
+
可以。当前公开提供 `tirtc-beken-builder`,覆盖 BK7258/BK7259 的硬件诊断、
|
|
1069
|
+
能力判定和小钛移植;安装命令是
|
|
1070
|
+
`npx --yes tirtc-device-builder@latest install beken`。Beken 当前只提供
|
|
1071
|
+
Skill,没有 `setup beken` 托管环境或公开 BK Device Kit。ESP32-S3 提供
|
|
1072
|
+
托管一键生成,ESP32-P4 支持在证据完整的已有工程上移植。
|
|
915
1073
|
|
|
916
1074
|
## 给仓库维护者
|
|
917
1075
|
|
package/package.json
CHANGED
|
@@ -139,10 +139,9 @@ and its required active probes pass.
|
|
|
139
139
|
Keep device keys, Wi-Fi passwords, MQTT/WHIP tokens, certificates, calibration
|
|
140
140
|
data, MAC-derived identifiers, captured user audio and captured logs outside
|
|
141
141
|
source control and generated reports. Use the conventional `ERROR`, `WARN`,
|
|
142
|
-
`INFO`, `DEBUG` levels.
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
and publishing a reusable board profile retain separate authorization.
|
|
142
|
+
`INFO`, `DEBUG` levels. The LCKFB XiaoTai development project defaults to
|
|
143
|
+
`DEBUG`, which prints complete HTTP, MQTT and TiRTC/WHIP inputs and results,
|
|
144
|
+
including authorization values. Switching to `INFO` suppresses those complete
|
|
145
|
+
network payloads. Handle DEBUG output as sensitive development data. Downloads,
|
|
146
|
+
account access, flashing, erasing, factory-partition changes and publishing a
|
|
147
|
+
reusable board profile retain separate authorization.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
0.11.
|
|
1
|
+
0.11.3
|
|
@@ -141,12 +141,11 @@ Require a host contract test plus artifact-bound HIL. At minimum verify:
|
|
|
141
141
|
connect/confirmation timeouts and late-callback rejection;
|
|
142
142
|
- minimum/largest internal heap during DTLS, camera and full-duplex overlap.
|
|
143
143
|
|
|
144
|
-
Use conventional `ERROR`, `WARN`, `INFO`, `DEBUG` levels. The checked-in
|
|
145
|
-
configuration defaults to `
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
144
|
+
Use conventional `ERROR`, `WARN`, `INFO`, `DEBUG` levels. The checked-in
|
|
145
|
+
development configuration defaults to `DEBUG` and prints complete HTTP, MQTT
|
|
146
|
+
and TiRTC/WHIP inputs and results, including authorization values, so developers
|
|
147
|
+
can reproduce protocol failures. Switching to `INFO` logs failures, recovery and
|
|
148
|
+
state transitions but not complete network inputs or responses.
|
|
149
149
|
Contract tests must keep those full-payload format strings behind `BK_LOGD` or
|
|
150
150
|
an equivalent DEBUG guard and reject them at INFO/WARN/ERROR. Treat DEBUG logs as
|
|
151
|
-
sensitive development artifacts
|
|
152
|
-
INFO before producing release firmware.
|
|
151
|
+
sensitive development artifacts and keep them out of source control.
|
|
@@ -60,7 +60,7 @@ documentation is context, not a substitute for the binary's build contract.
|
|
|
60
60
|
|
|
61
61
|
Use `ERROR` for failed operations that cannot continue, `WARN` for degraded or
|
|
62
62
|
recoverable behavior, `INFO` for lifecycle/state summaries, and `DEBUG` for wire
|
|
63
|
-
diagnostics.
|
|
63
|
+
diagnostics. The LCKFB development profile defaults to DEBUG. At DEBUG, log complete HTTP method,
|
|
64
64
|
URL, headers, body and response; MQTT connect/subscribe/publish/receive fields and
|
|
65
65
|
payloads; and TiRTC/WHIP descriptors, authorization values, callback results and
|
|
66
66
|
generation identifiers. At INFO and above, do not print those complete network
|
|
@@ -1 +1 @@
|
|
|
1
|
-
0.11.
|
|
1
|
+
0.11.3
|