chore: 调整项目演示程序目录结构

This commit is contained in:
Del Wang
2025-04-26 21:46:32 +08:00
parent 39febdfe57
commit c3cac9b2b4
54 changed files with 25 additions and 23 deletions
+8 -7
View File
@@ -44,8 +44,9 @@
1. 刷机更新小爱音箱补丁固件,开启并 SSH 连接到小爱音箱 👉 [教程](docs/flash.md) 1. 刷机更新小爱音箱补丁固件,开启并 SSH 连接到小爱音箱 👉 [教程](docs/flash.md)
2. 在你的电脑上编译好 Client 端补丁程序,然后复制到小爱音箱上运行 👉 [教程](packages/client-rust/README.md) 2. 在你的电脑上编译好 Client 端补丁程序,然后复制到小爱音箱上运行 👉 [教程](packages/client-rust/README.md)
3. 在你的电脑上运行 Server 端演示程序,体验小爱音箱的全新能力 ✨ 3. 在你的电脑上运行 Server 端演示程序,体验小爱音箱的全新能力 ✨
- Python Server 演示 👉 [小爱音箱接入小智 AI](packages/server-python/README.md) - 👉 [小爱音箱接入小智 AI](examples/xiaozhi/README.md)
- Node.js Server 演示 👉 [小爱音箱接入 MiGPT-Next](packages/server-node/README.md) - 👉 [小爱音箱接入 MiGPT-Next](examples/migpt/README.md)
- 👉 [小爱音箱接入 Gemini Live API](examples/gemini/README.md)
以上皆为抛砖引玉,你也可以亲手编写自己想要的功能,一切由你定义! 以上皆为抛砖引玉,你也可以亲手编写自己想要的功能,一切由你定义!
@@ -66,18 +67,18 @@
如果你想要了解更多技术细节,下面的链接可能对你有用: 如果你想要了解更多技术细节,下面的链接可能对你有用:
- https://github.com/duhow/xiaoai-patch
- https://github.com/jialeicui/open-lx01
- https://javabin.cn/2021/xiaoai_fm.html
- https://github.com/yihong0618/gitblog/issues/258 - https://github.com/yihong0618/gitblog/issues/258
- https://github.com/jialeicui/open-lx01
- https://github.com/duhow/xiaoai-patch
- https://javabin.cn/2021/xiaoai_fm.html
- https://xuanxuanblingbling.github.io/iot/2022/09/16/mi/ - https://xuanxuanblingbling.github.io/iot/2022/09/16/mi/
## 免责声明 ## 免责声明
1. **适用范围** 1. **适用范围**
本项目为非盈利开源项目,仅限于技术原理研究、安全漏洞验证及非营利性个人使用。严禁用于商业服务、网络攻击、数据窃取、系统破坏等违反《网络安全法》及使用者所在地司法管辖区的法律规定的场景。 本项目为开源非营利项目,仅供学术研究或个人测试用途。严禁用于商业服务、网络攻击、数据窃取、系统破坏等违反《网络安全法》及使用者所在地司法管辖区的法律规定的场景。
2. **非官方声明** 2. **非官方声明**
本项目由第三方开发者独立开发,与小米集团及其关联方(下称"权利方")无任何隶属/合作关系,未获其官方授权/认可或技术支持。项目中涉及的商标、固件、云服务的所有权利归属小米集团。若权利方主张权益,使用者应立即主动停止使用并删除本项目。 本项目由第三方开发者独立开发,与小米集团及其关联方(下称"权利方")无任何隶属/合作关系,未获其官方授权/认可或技术支持。项目中涉及的商标、固件、云服务的所有权利归属小米集团。若权利方主张权益,使用者应立即主动停止使用并删除本项目。
继续下载或运行本项目,即表示您已完整阅读并同意[用户协议](agreement.md),否则请立即终止使用并彻底删除本项目。 继续下载或运行本项目,即表示您已完整阅读并同意[用户协议](agreement.md),否则请立即终止使用并彻底删除本项目。
+2 -2
View File
@@ -4,11 +4,11 @@
## 授权范围 ## 授权范围
本项目授权范围仅限于技术原理研究、安全漏洞验证及非营利性个人使用。严禁用于商业服务、网络攻击、数据窃取、系统破坏等违反《网络安全法》及使用者所在地司法管辖区的法律规定的场景。 本项目仅供学术研究或个人测试用途。严禁用于商业服务、网络攻击、数据窃取、系统破坏等违反《网络安全法》及使用者所在地司法管辖区的法律规定的场景。
## 非官方声明 ## 非官方声明
本项目为非盈利开源项目,由第三方开发者独立开发,与小米集团及其关联方(下称"权利方")无任何隶属/合作关系,未获其官方授权/认可或技术支持。项目中涉及的商标、固件、云服务等知识产权均归属权利方所有。若权利方主张权益,用户应立即终止使用并彻底销毁项目副本。 本项目为开源非营利项目,由第三方开发者独立开发,与小米集团及其关联方(下称"权利方")无任何隶属/合作关系,未获其官方授权/认可或技术支持。项目中涉及的商标、固件、云服务等知识产权均归属权利方所有。若权利方主张权益,用户应立即终止使用并彻底销毁项目副本。
## 风险告知 ## 风险告知
@@ -30,4 +30,4 @@ uv run main.py
该演示暂不支持中断 AI 的回复,需要等待 AI 回答完毕后才能重新响应用户的语音输入。 该演示暂不支持中断 AI 的回复,需要等待 AI 回答完毕后才能重新响应用户的语音输入。
> [!NOTE] > [!NOTE]
> 本项目只是一个简单的演示程序,抛砖引玉。如果你要更多的功能,比如唤醒词识别、语音转文字、连续对话等,可以参考开源的 [xiaozhi-esp32-server](https://github.com/xinnan-tech/xiaozhi-esp32-server) 项目,借助 Python 丰富的 AI 生态自行实现想要的功能 > 本项目只是一个简单的演示程序,抛砖引玉。如果你要更多的功能,可以借助 Python 丰富的 AI 生态自行实现。
@@ -1,7 +1,7 @@
[project] [project]
name = "open-xiaoai-gemini" name = "open-xiaoai-gemini"
version = "1.0.0" version = "1.0.0"
description = "小爱音箱接入 Gemini Live" description = "小爱音箱接入 Gemini Live API"
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
dependencies = [ dependencies = [
@@ -10,7 +10,7 @@ crate-type = ["cdylib"]
[dependencies] [dependencies]
neon = { version = "1.1.0-alpha.1", features = ["napi-6", "futures", "tokio"] } neon = { version = "1.1.0-alpha.1", features = ["napi-6", "futures", "tokio"] }
open-xiaoai = { path = "../client-rust" } open-xiaoai = { path = "../../packages/client-rust" }
tokio = { version = "1.32.0", features = ["full"] } tokio = { version = "1.32.0", features = ["full"] }
tokio-tungstenite = "0.26.2" tokio-tungstenite = "0.26.2"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
@@ -1,4 +1,4 @@
# Node.js Server # Open-XiaoAI x MiGPT-Next
[Open-XiaoAI](https://github.com/idootop/open-xiaoai) 的 Node.js 版 Server 端,用来演示小爱音箱接入[MiGPT-Next](https://github.com/idootop/migpt-next)。 [Open-XiaoAI](https://github.com/idootop/open-xiaoai) 的 Node.js 版 Server 端,用来演示小爱音箱接入[MiGPT-Next](https://github.com/idootop/migpt-next)。
@@ -12,7 +12,7 @@
## 编译运行 ## 编译运行
> [!NOTE] > [!NOTE]
> 请先确认你已经将小爱音箱刷机成功,并安装运行了 Rust 补丁程序 [👉 教程](../client-rust/README.md) > 请先确认你已经将小爱音箱刷机成功,并安装运行了 Rust 补丁程序 [👉 教程](../../packages/client-rust/README.md)
```bash ```bash
# 启用 PNPM 包管理工具 # 启用 PNPM 包管理工具
@@ -60,7 +60,7 @@ main();
1. 默认 Server 服务端口为 `4399`(比如 ws://192.168.31.227:4399),运行前请确保该端口未被其他程序占用。 1. 默认 Server 服务端口为 `4399`(比如 ws://192.168.31.227:4399),运行前请确保该端口未被其他程序占用。
2. 默认 Rust Server 在启动时,并没有开启小爱音箱的录音能力。 2. 默认 Rust Server 在启动时,并没有开启小爱音箱的录音能力。
如果你需要在 Node.js 端正常接收音频输入流,或者播放音频输出流,请将 `src/server.rs` 文件中被注释掉的 `start_recording``start_play` 代码加回来,然后重新编译运行。 如果你需要在 Node.js 端正常接收音频输入流,或者播放音频输出流,请将 `src/server.rs` 文件中被注释掉的 `start_recording``start_play` 代码加回来,然后重新编译运行。
> [!NOTE] > [!NOTE]
> 本项目只是一个简单的演示程序,抛砖引玉。如果你要更多的功能,比如唤醒词识别、语音转文字、连续对话等(甚至是对接 OpenAI 的 [Realtime API](https://platform.openai.com/docs/guides/realtime)),可参考本项目代码自行实现想要的功能 > 本项目只是一个简单的演示程序,抛砖引玉。如果你要更多的功能,比如唤醒词识别、语音转文字、连续对话等(甚至是对接 OpenAI 的 [Realtime API](https://platform.openai.com/docs/guides/realtime)),可参考本项目代码自行实现。
@@ -1,6 +1,7 @@
{ {
"name": "open-xiaoai-node", "name": "open-xiaoai-migpt",
"version": "1.0.0", "version": "1.0.0",
"description": "小爱音箱接入 MiGPT-Next",
"private": true, "private": true,
"type": "module", "type": "module",
"scripts": { "scripts": {
@@ -13,7 +13,7 @@ pyo3-async-runtimes = { version = "0.24", features = [
"attributes", "attributes",
"tokio-runtime", "tokio-runtime",
] } ] }
open-xiaoai = { path = "../client-rust" } open-xiaoai = { path = "../../packages/client-rust" }
tokio = { version = "1.32.0", features = ["full"] } tokio = { version = "1.32.0", features = ["full"] }
tokio-tungstenite = "0.26.2" tokio-tungstenite = "0.26.2"
serde = { version = "1.0", features = ["derive"] } serde = { version = "1.0", features = ["derive"] }
@@ -1,4 +1,4 @@
# Python Server # Open-XiaoAI x 小智 AI
[Open-XiaoAI](https://github.com/idootop/open-xiaoai) 的 Python 版 Server 端,用来演示小爱音箱接入[小智 AI](https://github.com/78/xiaozhi-esp32)。 [Open-XiaoAI](https://github.com/idootop/open-xiaoai) 的 Python 版 Server 端,用来演示小爱音箱接入[小智 AI](https://github.com/78/xiaozhi-esp32)。
@@ -17,7 +17,7 @@
## 编译运行 ## 编译运行
> [!NOTE] > [!NOTE]
> 请先确认你已经将小爱音箱刷机成功,并安装运行了 Rust 补丁程序 [👉 教程](../client-rust/README.md),否则该 Python Server 端启动后收不到音频输入,将无法正常工作。 > 请先确认你已经将小爱音箱刷机成功,并安装运行了 Rust 补丁程序 [👉 教程](../../packages/client-rust/README.md),否则该 Python Server 端启动后收不到音频输入,将无法正常工作。
```bash ```bash
# 安装 Python 依赖 # 安装 Python 依赖
@@ -42,4 +42,4 @@ uv run main.py --mode xiaozhi
请按照提示注册你的小智 AI 账号,然后创建 Agent 绑定设备即可开始体验。 请按照提示注册你的小智 AI 账号,然后创建 Agent 绑定设备即可开始体验。
> [!NOTE] > [!NOTE]
> 本项目只是一个简单的演示程序,抛砖引玉。如果你要更多的功能,比如唤醒词识别、语音转文字、连续对话等,可以参考开源的 [xiaozhi-esp32-server](https://github.com/xinnan-tech/xiaozhi-esp32-server) 项目,借助 Python 丰富的 AI 生态自行实现想要的功能 > 本项目只是一个简单的演示程序,抛砖引玉。如果你要更多的功能,比如唤醒词识别、语音转文字、连续对话等,可以参考开源的 [xiaozhi-esp32-server](https://github.com/xinnan-tech/xiaozhi-esp32-server) 项目,借助 Python 丰富的 AI 生态自行实现。
@@ -1,5 +1,5 @@
[project] [project]
name = "open-xiaoai-python" name = "open-xiaoai-xiaozhi"
version = "1.0.0" version = "1.0.0"
description = "小爱音箱接入小智 AI" description = "小爱音箱接入小智 AI"
readme = "README.md" readme = "README.md"
+1 -1
View File
@@ -191,7 +191,7 @@ wheels = [
] ]
[[package]] [[package]]
name = "open-xiaoai-python" name = "open-xiaoai-xiaozhi"
version = "1.0.0" version = "1.0.0"
source = { editable = "." } source = { editable = "." }
dependencies = [ dependencies = [