From 0585ddab725f180105e26060a3e1c8be623f2f7d Mon Sep 17 00:00:00 2001 From: Del Wang Date: Wed, 9 Apr 2025 22:47:15 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0=E4=BD=BF=E7=94=A8?= =?UTF-8?q?=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 20 ++++++++++++++++---- packages/client-rust/README.md | 11 ++++++----- 2 files changed, 22 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 17e2106..941a46e 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,6 @@ **未来由你定义!** -> [!TIP] -> 技术的意义在于分享与共创。如果你打算或正在用本项目做些有趣的事情， -> 欢迎提交 PR 或 issue 分享你的项目和创意。✨ - ## 你的声音 + 小爱音箱 = 无限可能 👉 [小爱音箱接入小智 AI 演示视频](https://www.bilibili.com/video/BV1NBXWYSEvX) @@ -43,6 +39,22 @@ 整理中，敬请期待 :) +## 使用说明 + +本项目由 Client 端 + Server 端两部分组成，你可以按照以下顺序运行该项目： + +1. 按照刷机教程更新小爱音箱固件，开启 SSH 并连接到小爱音箱（整理教程中…… +2. 在你的电脑上编译好 Rust 补丁程序（Client 端），然后复制到小爱音箱上运行 👉 [教程](packages/client-rust/README.md) +3. 在你的电脑上运行 Server 端演示程序，体验小爱音箱的全新能力 ✨ + - Python Server 演示 👉 [小爱音箱接入小智 AI](packages/server-python/README.md) + - Node.js Server 演示 👉 [小爱音箱接入 MiGPT-Next](packages/server-node/README.md) + +以上皆为抛砖引玉，你也可以自己亲手编写想要的功能，一切由你定义！ + +> [!TIP] +> 技术的意义在于分享与共创。如果你打算或正在用本项目做些有趣的事情， +> 欢迎提交 PR 或 issue 分享你的项目和创意。✨ + ## 免责声明 1. **适用范围** diff --git a/packages/client-rust/README.md b/packages/client-rust/README.md index 813adc8..99275a2 100644 --- a/packages/client-rust/README.md +++ b/packages/client-rust/README.md @@ -7,6 +7,9 @@ - 转发小爱音箱上的事件到 Server 端（语音识别结果、播放状态等） - 响应来自 Server 端的指令调用（执行脚本、播放音频流、系统升级等） +> [!TIP] +> 本项目 Rust 端通过 binding 与 Python 和 Node.js 端双向互调，实现了网络通信模块的共享复用。当然你也可以参考 Rust 端通信协议源码，在其他 Server 端重新实现 WebSocket 通信过程。 + ## 编译运行 > [!IMPORTANT] @@ -69,7 +72,7 @@ chmod +x /data/client > [!TIP] > 旧版小爱音箱 Pro 的可用 RAM 和 ROM 均为 10MB 左右 -> +> > 新版 Xiaomi 智能音箱 Pro 约为 100MB（升级为旧版的 10 倍！） 当前 Client 端使用 Rust 编写，只负责转发和被动响应 Server 端的调用，不实现具体的业务逻辑。 @@ -81,12 +84,10 @@ chmod +x /data/client > [!CAUTION] > 当你在公网上运行本项目时，应当提高警惕。🚨 - 本项目只是一个基础的演示程序，抛砖引玉。诸如多设备连接管理、身份认证、通信数据加密、音频压缩传输等均未做处理。 -其默认提供了执行任意脚本的能力演示，虽然在启动 Client 端时需要由你本人指定可信的 Server 端连接地址，但还是要务必小心！ +其默认提供了**执行任意脚本**的能力演示，虽然在启动 Client 端时需要由你本人指定可信的 Server 端连接地址，但还是要务必小心！ 毕竟再怎么小心都不为过 :) -你也可以 Fork 本项目，在此基础上将 MiGPT 和小智 AI 等业务逻辑完全放在 Client 端运行，不需要将数据转发到 Server 端处理，这样就不存在隐私数据泄露的风险了，也不需要额外的服务器或 NAS 设备去部署运行。 - +你也可以 Fork 本项目，在此基础上将 MiGPT 和小智 AI 等业务逻辑完全放在 Client 端运行，这样就不需要额外的服务器或 NAS 设备来部署运行了。