From f8384b57f55bd5559e94cf1c0bffc6b472902813 Mon Sep 17 00:00:00 2001 From: Del Date: Fri, 14 Jun 2024 20:23:25 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B7=BB=E5=8A=A0=E5=B8=B8=E8=A7=81?= =?UTF-8?q?=E5=B0=8F=E7=88=B1=E9=9F=B3=E7=AE=B1=E5=9E=8B=E5=8F=B7=E7=9A=84?= =?UTF-8?q?=E6=94=AF=E6=8C=81=E6=83=85=E5=86=B5=E5=92=8C=E5=8F=82=E6=95=B0?= =?UTF-8?q?=E5=88=97=E8=A1=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 8 +++++++ docs/compatibility.md | 41 ++++++++++++++++++++++++++++++++++++ docs/faq.md | 4 +++- docs/roadmap.md | 2 +- docs/todo.md | 3 ++- src/services/speaker/base.ts | 2 +- 6 files changed, 56 insertions(+), 4 deletions(-) create mode 100644 docs/compatibility.md diff --git a/README.md b/README.md index ddceeee..426b7e9 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,14 @@ - **🔊 自定义 TTS**。厌倦了小爱同学的语音？帮你解锁[「豆包」](https://doubao.com)同款音色，就像真人在回你的消息。 - **🤖️ 智能家居 Agent**。心情不好？小爱立刻懂你，自动帮你播放喜欢的音乐，调节灯光，逗你开心。_TODO_ +## 🔊 设备要求 + +本项目支持大部分的小爱音箱型号，推荐使用小爱音箱 Pro（完美运行） + +👉 [查看更多兼容的小爱音箱型号和配置参数](https://github.com/idootop/mi-gpt/blob/main/docs/compatibility.md) + +> 注意：本项目暂不支持小度音箱、天猫精灵、HomePod 等智能音箱设备，亦无相关适配计划。 + ## ⚡️ 快速开始 `MiGPT` 有两种启动方式: [Docker](#docker) 和 [Node.js](#nodejs)。 diff --git a/docs/compatibility.md b/docs/compatibility.md new file mode 100644 index 0000000..45dfe85 --- /dev/null +++ b/docs/compatibility.md @@ -0,0 +1,41 @@ +# 🔊 支持的小爱音箱型号 + +## ✅ 完美运行 + +已知可以完美运行 `MiGPT` 的小爱音箱型号有： + +| 名称 | 型号 | ttsCommand | wakeUpCommand | playingCommand | streamResponse | 反馈来源 | +| ------------ | --------------------------------------------------------------------------------------------------- | ---------- | ------------- | -------------- | -------------- | -------------------------------------- | +| 小爱音箱 Pro | [LX06](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:speaker:0000A015:xiaomi-lx06:2) | `[5, 1]` | `[5, 3]` | - | true | [@idootop](https://github.com/idootop) | + +## 🚗 正常运行 + +> 部分机型的 MIoT 接口不支持查询设备播放状态或查询状态异常，比如小米音箱 Play 增强版（L05C），将会导致 `MiGPT` 部分功能异常，无法使用连续对话等，此时需要关闭 `streamResponse`。相关 [issue](https://github.com/idootop/mi-gpt/issues/14) + +可以正常运行 `MiGPT`，但不支持连续对话的小爱音箱型号有： + +| 名称 | 型号 | ttsCommand | wakeUpCommand | playingCommand | streamResponse | 反馈来源 | +| ----------------------------- | --------------------------------------------------------------------------------------------------- | ---------- | ------------- | -------------- | -------------- | ---------------------------------------------------------- | +| 小爱音箱 | [L06A](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:speaker:0000A015:xiaomi-l06a:2) | `[5, 1]` | `[5, 2]` | - | false | [@zhanglc](https://github.com/idootop/mi-gpt/issues/42) | +| 小爱音箱 Play | [L05B](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:speaker:0000A015:xiaomi-l05b:1) | `[5, 3]` | `[5, 1]` | - | false | [@BiuBiu2323](https://github.com/idootop/mi-gpt/issues/48) | +| 小米小爱音箱 Play 增强版 | [L05C](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:speaker:0000A015:xiaomi-l05c:1) | `[5, 3]` | `[5, 1]` | - | false | [@lyddias](https://github.com/idootop/mi-gpt/issues/14) | +| Xiaomi 智能家庭屏 6 | [X6A](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:speaker:0000A015:xiaomi-x6a:1) | `[7, 3]` | `[7, 1]` | - | false | [@Hongwing](https://github.com/idootop/mi-gpt/issues/80) | +| Redmi 小爱触屏音箱 Pro 8 英寸 | [X08E](https://home.miot-spec.com/spec?type=urn:miot-spec-v2:device:speaker:0000A015:xiaomi-x08e:1) | `[7, 3]` | `[7, 1]` | - | false | [@shangjiyu](https://github.com/idootop/mi-gpt/issues/20) | + +## ❌ 不支持 + +完全不支持 `MiGPT` 的小爱音箱型号有： + +| 名称 | 型号 | 反馈来源 | +| --------------- | -------------------------------------------------------------- | --------------------------------------------------------- | +| 小米小爱音箱 HD | [SM4](https://home.miot-spec.com/spec/onemore.wifispeaker.sm4) | [@romantech](https://github.com/idootop/mi-gpt/issues/91) | + +## 🔥 型号分享 + +如果你是其他型号的小爱音箱，欢迎把你的型号和配置参数分享给大家，谢谢。分享格式如下： + +- 型号：小爱音箱 Pro【LX06】 +- ttsCommand：[5, 1] +- wakeUpCommand：[5, 3] +- playingCommand：未设置 +- streamResponse：true（支持唤醒模式） diff --git a/docs/faq.md b/docs/faq.md index 5397a7b..c90049b 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,7 +2,9 @@ ### Q：支持哪些型号的小爱音箱？ -大部分型号的小爱音箱都支持，推荐小爱音箱 Pro（完美运行）。部分机型的 MioT 接口开放能力并不完整，比如小米音箱 Play 增强版（L05C），将会导致 `MiGPT` 部分功能异常（比如流式响应和唤醒模式等），相关 [issue](https://github.com/idootop/mi-gpt/issues/14)。 +大部分型号的小爱音箱都支持，推荐小爱音箱 Pro（完美运行） + +👉 [查看兼容的小爱音箱型号和配置参数](https://github.com/idootop/mi-gpt/blob/main/docs/compatibility.md) > 注意：本项目暂不支持小度音箱、天猫精灵、HomePod 等智能音箱设备，亦无相关适配计划。 diff --git a/docs/roadmap.md b/docs/roadmap.md index 6ebe6a0..c96b03e 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -20,7 +20,7 @@ - 增强对话系统 - 添加是否启用对话模式的开关 - 支持通过语音命令清除上下文 -- MioT AI Agents +- MIoT AI Agents - 支持小爱音箱控制米家设备 - 通过 Agent 机制自动调用合适的工具（设备） - RAG diff --git a/docs/todo.md b/docs/todo.md index 7786f84..442d0c2 100644 --- a/docs/todo.md +++ b/docs/todo.md @@ -24,5 +24,6 @@ - ✅ 添加“小爱同学”唤醒词的相关说明 https://github.com/idootop/mi-gpt/issues/84 - ✅ 添加进入唤醒模式时小爱莫名开始播放歌曲的说明 https://github.com/idootop/mi-gpt/issues/71 - ✅ 添加部署和接入本地大语言模型的教程 https://github.com/idootop/mi-gpt/issues/82 -- 添加常见小爱音箱型号的支持情况和参数列表 +- ✅ 添加常见小爱音箱型号的支持情况和参数列表 - 添加更详细的使用和配置视频教程 +- 添加 302.AI Sponsor 链接 diff --git a/src/services/speaker/base.ts b/src/services/speaker/base.ts index c059ab0..b7e9e45 100644 --- a/src/services/speaker/base.ts +++ b/src/services/speaker/base.ts @@ -332,7 +332,7 @@ export class BaseSpeaker { } if (!this.streamResponse) { // 非流式响应，直接返回，不再等待设备播放完毕 - // todo 考虑后续通过 MioT 通知事件，接收设备播放状态变更通知。 + // todo 考虑后续通过 MIoT 通知事件，接收设备播放状态变更通知。 return; } // 等待一段时间，确保本地设备状态已更新