tirtc-device-builder 0.9.6 → 0.9.7
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 +7 -0
- package/README.md +14 -14
- package/bin/esp32-kit-metadata.js +7 -7
- package/package.json +1 -1
- package/skills/tirtc-esp32-builder/USAGE.md +1 -1
- package/skills/tirtc-esp32-builder/VERSION +1 -1
- package/skills/tirtc-esp32-builder/assets/developer-intake-prompt.md +1 -1
- package/skills/tirtc-esp32-builder/assets/lckfb-szpi-esp32s3-portable-prompt.md +5 -5
- package/skills/tirtc-esp32-builder/references/environment.md +3 -3
- package/skills/tirtc-esp32-builder/references/hardware-ir.md +3 -3
- package/skills/tirtc-esp32-builder/scripts/hardware_ir.py +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
This project follows Semantic Versioning.
|
|
4
4
|
|
|
5
|
+
## 0.9.7
|
|
6
|
+
|
|
7
|
+
- Pin ESP32-S3 Device Kit 1.1.7 with the `XiaoTai-` SoftAP name and the
|
|
8
|
+
provisioning DHCP state fix; keep TiRTC C SDK 2.5.0.
|
|
9
|
+
- Align generated-project instructions, Hardware IR validation, and Kit
|
|
10
|
+
packaging checks with the SoftAP name, and cover DHCP initial states.
|
|
11
|
+
|
|
5
12
|
## 0.9.6
|
|
6
13
|
|
|
7
14
|
- Pin ESP32-S3 Device Kit 1.1.6 with TiRTC C SDK 2.5.0 and verify the
|
package/README.md
CHANGED
|
@@ -12,7 +12,7 @@ H5/AI 的 ESP32-S3 托管模板、协议文档和 TiRTC SDK 已打包在独立
|
|
|
12
12
|
|
|
13
13
|
- npm 包:[tirtc-device-builder](https://www.npmjs.com/package/tirtc-device-builder)
|
|
14
14
|
- GitHub 仓库:[tangeai/tirtc-device-builder](https://github.com/tangeai/tirtc-device-builder)
|
|
15
|
-
- ESP32 Device Kit:[kit-esp32s3-v1.1.
|
|
15
|
+
- ESP32 Device Kit:[kit-esp32s3-v1.1.7](https://github.com/tangeai/tirtc-device-builder/releases/tag/kit-esp32s3-v1.1.7)
|
|
16
16
|
|
|
17
17
|
文档导航:
|
|
18
18
|
|
|
@@ -283,7 +283,7 @@ board-materials/
|
|
|
283
283
|
| ESP-IDF | 5.5.x |
|
|
284
284
|
| 自动安装版本 | ESP-IDF v5.5.4 |
|
|
285
285
|
| 本仓库源码与本地打包使用的 TiRTC SDK | `espressif-esp32s3/2.5.0` |
|
|
286
|
-
| ESP32 Device Kit | 1.1.
|
|
286
|
+
| ESP32 Device Kit | 1.1.7(内含 TiRTC SDK 2.5.0) |
|
|
287
287
|
| Node.js | 18 或更高版本 |
|
|
288
288
|
| 支持自动安装的系统 | Linux、WSL、macOS |
|
|
289
289
|
| 原生 Windows | 使用 Espressif 官方安装器准备 ESP-IDF,再重新运行检查 |
|
|
@@ -394,7 +394,7 @@ Cline 当前还需要在 `Settings → Features → Enable Skills` 中启用实
|
|
|
394
394
|
|---|---|
|
|
395
395
|
| Agent Skill | 上表中所选目录下的 `tirtc-esp32-builder` |
|
|
396
396
|
| 托管根目录 | `~/.tirtc-device-builder` |
|
|
397
|
-
| Device Kit | `~/.tirtc-device-builder/kits/esp32s3/1.1.
|
|
397
|
+
| Device Kit | `~/.tirtc-device-builder/kits/esp32s3/1.1.7` |
|
|
398
398
|
| ESP-IDF | `~/.tirtc-device-builder/esp-idf-v5.5.4` |
|
|
399
399
|
| Espressif 工具 | `~/.tirtc-device-builder/espressif` |
|
|
400
400
|
| 安装记录 | `~/.tirtc-device-builder/config.json` |
|
|
@@ -439,7 +439,7 @@ npx --yes tirtc-device-builder@latest setup esp32 --install \
|
|
|
439
439
|
|
|
440
440
|
```bash
|
|
441
441
|
npx --yes tirtc-device-builder@latest setup esp32 --install \
|
|
442
|
-
--kit-archive /absolute/path/tirtc-esp32s3-kit-1.1.
|
|
442
|
+
--kit-archive /absolute/path/tirtc-esp32s3-kit-1.1.7.tar.gz
|
|
443
443
|
```
|
|
444
444
|
|
|
445
445
|
安装器仍会核对固定的 SHA-256、目录结构、清单和每个资源文件,不接受未经验证的同名压缩包。
|
|
@@ -654,7 +654,7 @@ bootloader、分区表和应用镜像;无需手工维护多条 `esptool.py`
|
|
|
654
654
|
|
|
655
655
|
### Wi-Fi 凭证和设备绑定
|
|
656
656
|
|
|
657
|
-
SoftAP 是可选方案,不是接入前提。Hardware IR 要根据 BSP 的实际能力和产品要求,选择 SoftAP、BLE、SmartConfig、安全工厂/NVS 注入、不纳入版本控制的开发配置,或有文档的自定义方案。若选择 SoftAP,热点名必须以 `
|
|
657
|
+
SoftAP 是可选方案,不是接入前提。Hardware IR 要根据 BSP 的实际能力和产品要求,选择 SoftAP、BLE、SmartConfig、安全工厂/NVS 注入、不纳入版本控制的开发配置,或有文档的自定义方案。若选择 SoftAP,热点名必须以 `XiaoTai-` 开头、使用开放认证(无需密码),AP 网关和配网页面地址固定为 `192.168.6.1`(`http://192.168.6.1`),并通过通配 DNS 和 HTTP 回退启用 captive portal 自动发现。DHCP Option 114 只用于 RFC 8908 HTTPS/JSON API,不能指向本地 HTML 页面。系统没有自动弹窗时仍可手动打开该 HTTP 地址;HTTPS 不能透明重定向。这些值要写入 Hardware IR 并通过门禁;目标 WLAN 的 SSID 和密码仍不得写死在源码中。
|
|
658
658
|
|
|
659
659
|
无论选择哪种方法,都要有当前 PCB/BSP 的支持证据,凭证不能进入 Git、源码或报告,并且要保留清除或重配入口。没有 SoftAP、但支持工厂 NVS 注入的设备同样可以接入。只要工程提交了明文密码,Hardware IR v2 门禁就会判为 `BLOCKED`。
|
|
660
660
|
|
|
@@ -822,7 +822,7 @@ npx --yes tirtc-device-builder@latest setup esp32 --install --force-skill
|
|
|
822
822
|
|
|
823
823
|
```bash
|
|
824
824
|
npx --yes tirtc-device-builder@latest setup esp32 --install \
|
|
825
|
-
--kit-archive /absolute/path/tirtc-esp32s3-kit-1.1.
|
|
825
|
+
--kit-archive /absolute/path/tirtc-esp32s3-kit-1.1.7.tar.gz
|
|
826
826
|
```
|
|
827
827
|
|
|
828
828
|
安装器会校验 SHA-256 和内部文件清单。如果校验不一致,请重新获取官方 Release 附件,不要跳过校验。
|
|
@@ -933,25 +933,25 @@ python3 ~/.codex/skills/.system/plugin-creator/scripts/validate_plugin.py .
|
|
|
933
933
|
|
|
934
934
|
```bash
|
|
935
935
|
npm run pack:esp32-kit -- \
|
|
936
|
-
--kit-version 1.1.
|
|
936
|
+
--kit-version 1.1.7
|
|
937
937
|
```
|
|
938
938
|
|
|
939
939
|
输出位于 `dist/`:
|
|
940
940
|
|
|
941
941
|
```text
|
|
942
|
-
tirtc-esp32s3-kit-1.1.
|
|
943
|
-
tirtc-esp32s3-kit-1.1.
|
|
942
|
+
tirtc-esp32s3-kit-1.1.7.tar.gz
|
|
943
|
+
tirtc-esp32s3-kit-1.1.7.tar.gz.sha256
|
|
944
944
|
```
|
|
945
945
|
|
|
946
946
|
校验后推送独立的 `kit-esp32s3-v<version>` 标签。`publish-kit.yml` 会从 metadata 固定的本仓库源码 commit 重建压缩包、核对 SHA-256,并使用 GitHub Actions token 创建 Release:
|
|
947
947
|
|
|
948
948
|
```bash
|
|
949
949
|
cd dist
|
|
950
|
-
sha256sum -c tirtc-esp32s3-kit-1.1.
|
|
950
|
+
sha256sum -c tirtc-esp32s3-kit-1.1.7.tar.gz.sha256
|
|
951
951
|
cd ..
|
|
952
952
|
|
|
953
|
-
git tag -a kit-esp32s3-v1.1.
|
|
954
|
-
git push origin kit-esp32s3-v1.1.
|
|
953
|
+
git tag -a kit-esp32s3-v1.1.7 -m "TiRTC ESP32-S3 Device Kit 1.1.7"
|
|
954
|
+
git push origin kit-esp32s3-v1.1.7
|
|
955
955
|
```
|
|
956
956
|
|
|
957
957
|
metadata 中的版本、标签、本仓库源码 commit 和期望 SHA-256 必须与本地可复现打包结果一致;工作流不会从浮动的 `main` 取发布内容。
|
|
@@ -962,8 +962,8 @@ metadata 中的版本、标签、本仓库源码 commit 和期望 SHA-256 必须
|
|
|
962
962
|
|
|
963
963
|
```bash
|
|
964
964
|
npm test
|
|
965
|
-
git tag -a v0.9.
|
|
966
|
-
git push origin v0.9.
|
|
965
|
+
git tag -a v0.9.7 -m "v0.9.7"
|
|
966
|
+
git push origin v0.9.7
|
|
967
967
|
```
|
|
968
968
|
|
|
969
969
|
不要重复发布已经存在的 npm 版本。版本变化同步更新 `package.json`、`.codex-plugin/plugin.json` 和发布说明。
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export const ESP32_KIT = Object.freeze({
|
|
2
|
-
archiveName: "tirtc-esp32s3-kit-1.1.
|
|
3
|
-
archiveRoot: "tirtc-esp32s3-kit-1.1.
|
|
4
|
-
releaseTag: "kit-esp32s3-v1.1.
|
|
5
|
-
sha256: "
|
|
2
|
+
archiveName: "tirtc-esp32s3-kit-1.1.7.tar.gz",
|
|
3
|
+
archiveRoot: "tirtc-esp32s3-kit-1.1.7",
|
|
4
|
+
releaseTag: "kit-esp32s3-v1.1.7",
|
|
5
|
+
sha256: "61be93e5b3648c067a581195d2146ac57f748c2f356e9b681a0926f301cf6a8b",
|
|
6
6
|
sdkVersion: "2.5.0",
|
|
7
|
-
sourceCommit: "
|
|
8
|
-
url: "https://github.com/tangeai/tirtc-device-builder/releases/download/kit-esp32s3-v1.1.
|
|
9
|
-
version: "1.1.
|
|
7
|
+
sourceCommit: "50be0b4b6ad83ca376e010ebb7256db4fb6debcd",
|
|
8
|
+
url: "https://github.com/tangeai/tirtc-device-builder/releases/download/kit-esp32s3-v1.1.7/tirtc-esp32s3-kit-1.1.7.tar.gz",
|
|
9
|
+
version: "1.1.7",
|
|
10
10
|
});
|
package/package.json
CHANGED
|
@@ -74,7 +74,7 @@ printf '%s\n' "$TIRTC_THING_CONNECT_ROOT"
|
|
|
74
74
|
python3 <skill-dir>/scripts/doctor.py \
|
|
75
75
|
--expected-idf 5.5 \
|
|
76
76
|
--target esp32s3 \
|
|
77
|
-
--thing-connect-root ~/.tirtc-device-builder/kits/esp32s3/1.1.
|
|
77
|
+
--thing-connect-root ~/.tirtc-device-builder/kits/esp32s3/1.1.7 \
|
|
78
78
|
--require-workspace
|
|
79
79
|
```
|
|
80
80
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
0.9.
|
|
1
|
+
0.9.7
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
|
|
28
28
|
接入方式:
|
|
29
29
|
- Wi-Fi:<选择一种,或写“根据 BSP 选择”>
|
|
30
|
-
- 选择 SoftAP 时:热点名以 `
|
|
30
|
+
- 选择 SoftAP 时:热点名以 `XiaoTai-` 开头、开放认证无需密码,AP 网关和配网页面为 `192.168.6.1` / `http://192.168.6.1`,启用通配 DNS 和 HTTP 重定向进行 captive portal 自动发现,不把 DHCP Option 114 指向本地 HTML 页面,并保留手动打开地址的回退说明
|
|
31
31
|
- 设备绑定:<选择一种,或写“根据平台合同选择”>
|
|
32
32
|
|
|
33
33
|
工程:
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
export TIRTC_AGENT_CLIENT=codex
|
|
11
|
-
npx --yes tirtc-device-builder@0.9.
|
|
11
|
+
npx --yes tirtc-device-builder@0.9.7 setup esp32 --install \
|
|
12
12
|
--client "$TIRTC_AGENT_CLIENT" --force-skill
|
|
13
13
|
```
|
|
14
14
|
|
|
@@ -17,11 +17,11 @@ npx --yes tirtc-device-builder@0.9.6 setup esp32 --install \
|
|
|
17
17
|
本轮第一步先只读运行:
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
|
-
npx --yes tirtc-device-builder@0.9.
|
|
21
|
-
npx --yes tirtc-device-builder@0.9.
|
|
20
|
+
npx --yes tirtc-device-builder@0.9.7 --version
|
|
21
|
+
npx --yes tirtc-device-builder@0.9.7 setup esp32 --client "$TIRTC_AGENT_CLIENT"
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
必须根据命令的实际输出和本机文件确认:npm 包为 0.9.
|
|
24
|
+
必须根据命令的实际输出和本机文件确认:npm 包为 0.9.7、已安装 Skill 的 `VERSION` 为 0.9.7、所选 Device Kit 的 `manifest.json` 中 `kit_version` 为 1.1.7、`tirtc_sdk_version` 为 2.5.0,并且 Doctor 对 `--expected-kit 1.1.7` 输出 `OVERALL: PASS`。Plugin manifest 不属于这种 npm 安装方式的运行时前置条件,不得把不可访问的 Plugin 版本当作阻塞项。如果版本不一致、Skill 是在当前会话启动后才安装,或环境检查未通过,停止并报告前置条件不成立;不要在当前会话中替换 Skill 后继续生成工程。
|
|
25
25
|
|
|
26
26
|
工作区与 clean-room 边界:
|
|
27
27
|
- 将启动 Agent 客户端时的当前目录定义为 `WORKSPACE_ROOT`。
|
|
@@ -60,7 +60,7 @@ npx --yes tirtc-device-builder@0.9.6 setup esp32 --client "$TIRTC_AGENT_CLIENT"
|
|
|
60
60
|
- AI 对讲必须实现全双工和 AEC;构建阶段必须证明同时采集播放、真实播放参考与 `echo_cancellation.enabled=true`,实机结果仍只能在 L2-L7 验证后声明。
|
|
61
61
|
|
|
62
62
|
接入要求:
|
|
63
|
-
- SoftAP 配网:热点名使用 `
|
|
63
|
+
- SoftAP 配网:热点名使用 `XiaoTai-` 前缀、开放认证无需密码,AP 网关和配网页面为 `192.168.6.1` / `http://192.168.6.1`;启用通配 DNS 和 HTTP 重定向进行 captive portal 自动发现,不把 DHCP Option 114 指向本地 HTML 页面;Hardware IR 记录 `captive_portal: true`;目标 Wi-Fi 凭证保存 NVS。
|
|
64
64
|
- 验证码绑定,并复用已有绑定。
|
|
65
65
|
- 分别实现 `wifi-clear` 和 `tirtc-clear`。
|
|
66
66
|
- 平台发现本轮先使用 HTTP;HTTPS 留待独立验收。
|
|
@@ -16,7 +16,7 @@ The automatic branch never runs `sudo` or modifies a persistent shell profile. W
|
|
|
16
16
|
When `<setup-root>/env.sh` exists, use it only as an activation prefix for the current command:
|
|
17
17
|
|
|
18
18
|
```bash
|
|
19
|
-
bash -lc '. "<setup-root>/env.sh" && python3 "<skill-dir>/scripts/doctor.py" --expected-idf 5.5 --expected-kit 1.1.
|
|
19
|
+
bash -lc '. "<setup-root>/env.sh" && python3 "<skill-dir>/scripts/doctor.py" --expected-idf 5.5 --expected-kit 1.1.7 --target esp32s3 --require-workspace'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
The helper contains paths, not device or network credentials. Read `<setup-root>/config.json` when exact managed paths are needed; the environment helper does not authorize unrelated downloads, shell-profile changes, flashing, or credential writes.
|
|
@@ -26,7 +26,7 @@ Run the doctor before generation, build, flash, or monitor:
|
|
|
26
26
|
```bash
|
|
27
27
|
python3 <skill-dir>/scripts/doctor.py \
|
|
28
28
|
--expected-idf 5.5 \
|
|
29
|
-
--expected-kit 1.1.
|
|
29
|
+
--expected-kit 1.1.7 \
|
|
30
30
|
--target esp32s3 \
|
|
31
31
|
--require-workspace
|
|
32
32
|
```
|
|
@@ -47,7 +47,7 @@ For an explicitly selected legacy workspace, omit `--expected-kit`; otherwise re
|
|
|
47
47
|
4. an ancestor whose `kit-src/` or `thing-connect/` child contains that generator.
|
|
48
48
|
|
|
49
49
|
The default managed root is `<setup-root>/kits/esp32s3/<kit-version>`. The `tirtc-device-builder/kit-src` directory is the ESP32 development source; the doctor also accepts an installed Device Kit root. Older `thing-connect/` layouts remain accepted as legacy inputs.
|
|
50
|
-
Resolve the SDK from the selected Kit manifest or generated project. Kit 1.1.
|
|
50
|
+
Resolve the SDK from the selected Kit manifest or generated project. Kit 1.1.7
|
|
51
51
|
and this repository's source generator use the ESP32-S3 SDK 2.5.0.
|
|
52
52
|
|
|
53
53
|
The managed Kit currently contains the ESP32-S3 H5/AI starter. When the requested
|
|
@@ -65,8 +65,8 @@ The selected Wi-Fi method must be available and corroborated, credentials must r
|
|
|
65
65
|
|
|
66
66
|
When the selected method is SoftAP:
|
|
67
67
|
|
|
68
|
-
- generate the SSID as `
|
|
69
|
-
prefix is `
|
|
68
|
+
- generate the SSID as `XiaoTai-<device suffix>` so its exact, case-sensitive
|
|
69
|
+
prefix is `XiaoTai-`; use a stable non-secret suffix and keep the complete SSID
|
|
70
70
|
within the ESP32 32-byte limit;
|
|
71
71
|
- configure an open network (`WIFI_AUTH_OPEN`) with an empty AP password so a
|
|
72
72
|
user can connect directly;
|
|
@@ -81,7 +81,7 @@ When the selected method is SoftAP:
|
|
|
81
81
|
client auto-popup is not guaranteed and HTTPS cannot be transparently
|
|
82
82
|
redirected.
|
|
83
83
|
|
|
84
|
-
Record these values on the selected SoftAP method as `ssid_prefix: "
|
|
84
|
+
Record these values on the selected SoftAP method as `ssid_prefix: "XiaoTai-"`,
|
|
85
85
|
`auth_mode: "open"`, `ipv4_address: "192.168.6.1"`, and
|
|
86
86
|
`captive_portal: true`. The Hardware IR gate returns `NEEDS_CONFIRMATION` when
|
|
87
87
|
one is missing and `BLOCKED` when one differs.
|