|
| 1 | +# An MCP-based Chatbot |
| 2 | + |
| 3 | +(中文 | [English](README.md) | [日本語](README_ja.md)) |
| 4 | + |
| 5 | +## 介绍 |
| 6 | + |
| 7 | +👉 [人类:给 AI 装摄像头 vs AI:当场发现主人三天没洗头【bilibili】](https://www.bilibili.com/video/BV1bpjgzKEhd/) |
| 8 | + |
| 9 | +👉 [手工打造你的 AI 女友,新手入门教程【bilibili】](https://www.bilibili.com/video/BV1XnmFYLEJN/) |
| 10 | + |
| 11 | +小智 AI 聊天机器人作为一个语音交互入口,利用 Qwen / DeepSeek 等大模型的 AI 能力,通过 MCP 协议实现多端控制。 |
| 12 | + |
| 13 | +<img src="docs/mcp-based-graph.jpg" alt="通过MCP控制万物" width="320"> |
| 14 | + |
| 15 | +### 版本说明 |
| 16 | + |
| 17 | +当前 v2 版本与 v1 版本分区表不兼容,所以无法从 v1 版本通过 OTA 升级到 v2 版本。分区表说明参见 [partitions/v2/README.md](partitions/v2/README.md)。 |
| 18 | + |
| 19 | +使用 v1 版本的所有硬件,可以通过手动烧录固件来升级到 v2 版本。 |
| 20 | + |
| 21 | +v1 的稳定版本为 1.9.2,可以通过 `git checkout v1` 来切换到 v1 版本,该分支会持续维护到 2026 年 2 月。 |
| 22 | + |
| 23 | +### 已实现功能 |
| 24 | + |
| 25 | +- Wi-Fi / ML307 Cat.1 4G |
| 26 | +- 离线语音唤醒 [ESP-SR](https://github.com/espressif/esp-sr) |
| 27 | +- 支持两种通信协议([Websocket](docs/websocket.md) 或 MQTT+UDP) |
| 28 | +- 采用 OPUS 音频编解码 |
| 29 | +- 基于流式 ASR + LLM + TTS 架构的语音交互 |
| 30 | +- 声纹识别,识别当前说话人的身份 [3D Speaker](https://github.com/modelscope/3D-Speaker) |
| 31 | +- OLED / LCD 显示屏,支持表情显示 |
| 32 | +- 电量显示与电源管理 |
| 33 | +- 支持多语言(中文、英文、日文) |
| 34 | +- 支持 ESP32-C3、ESP32-S3、ESP32-P4 芯片平台 |
| 35 | +- 通过设备端 MCP 实现设备控制(音量、灯光、电机、GPIO 等) |
| 36 | +- 通过云端 MCP 扩展大模型能力(智能家居控制、PC桌面操作、知识搜索、邮件收发等) |
| 37 | +- 自定义唤醒词、字体、表情与聊天背景,支持网页端在线修改 ([自定义Assets生成器](https://github.com/78/xiaozhi-assets-generator)) |
| 38 | + |
| 39 | +## 硬件 |
| 40 | + |
| 41 | +### 面包板手工制作实践 |
| 42 | + |
| 43 | +详见飞书文档教程: |
| 44 | + |
| 45 | +👉 [《小智 AI 聊天机器人百科全书》](https://ccnphfhqs21z.feishu.cn/wiki/F5krwD16viZoF0kKkvDcrZNYnhb?from=from_copylink) |
| 46 | + |
| 47 | +面包板效果图如下: |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | +### 支持 70 多个开源硬件(仅展示部分) |
| 52 | + |
| 53 | +- <a href="https://oshwhub.com/li-chuang-kai-fa-ban/li-chuang-shi-zhan-pai-esp32-s3-kai-fa-ban" target="_blank" title="立创·实战派 ESP32-S3 开发板">立创·实战派 ESP32-S3 开发板</a> |
| 54 | +- <a href="https://github.com/espressif/esp-box" target="_blank" title="乐鑫 ESP32-S3-BOX3">乐鑫 ESP32-S3-BOX3</a> |
| 55 | +- <a href="https://docs.m5stack.com/zh_CN/core/CoreS3" target="_blank" title="M5Stack CoreS3">M5Stack CoreS3</a> |
| 56 | +- <a href="https://docs.m5stack.com/en/atom/Atomic%20Echo%20Base" target="_blank" title="AtomS3R + Echo Base">M5Stack AtomS3R + Echo Base</a> |
| 57 | +- <a href="https://gf.bilibili.com/item/detail/1108782064" target="_blank" title="神奇按钮 2.4">神奇按钮 2.4</a> |
| 58 | +- <a href="https://www.waveshare.net/shop/ESP32-S3-Touch-AMOLED-1.8.htm" target="_blank" title="微雪电子 ESP32-S3-Touch-AMOLED-1.8">微雪电子 ESP32-S3-Touch-AMOLED-1.8</a> |
| 59 | +- <a href="https://github.com/Xinyuan-LilyGO/T-Circle-S3" target="_blank" title="LILYGO T-Circle-S3">LILYGO T-Circle-S3</a> |
| 60 | +- <a href="https://oshwhub.com/tenclass01/xmini_c3" target="_blank" title="虾哥 Mini C3">虾哥 Mini C3</a> |
| 61 | +- <a href="https://oshwhub.com/movecall/cuican-ai-pendant-lights-up-y" target="_blank" title="Movecall CuiCan ESP32S3">璀璨·AI 吊坠</a> |
| 62 | +- <a href="https://github.com/WMnologo/xingzhi-ai" target="_blank" title="无名科技Nologo-星智-1.54">无名科技 Nologo-星智-1.54TFT</a> |
| 63 | +- <a href="https://www.seeedstudio.com/SenseCAP-Watcher-W1-A-p-5979.html" target="_blank" title="SenseCAP Watcher">SenseCAP Watcher</a> |
| 64 | +- <a href="https://www.bilibili.com/video/BV1BHJtz6E2S/" target="_blank" title="ESP-HI 超低成本机器狗">ESP-HI 超低成本机器狗</a> |
| 65 | + |
| 66 | +<div style="display: flex; justify-content: space-between;"> |
| 67 | + <a href="docs/v1/lichuang-s3.jpg" target="_blank" title="立创·实战派 ESP32-S3 开发板"> |
| 68 | + <img src="docs/v1/lichuang-s3.jpg" width="240" /> |
| 69 | + </a> |
| 70 | + <a href="docs/v1/espbox3.jpg" target="_blank" title="乐鑫 ESP32-S3-BOX3"> |
| 71 | + <img src="docs/v1/espbox3.jpg" width="240" /> |
| 72 | + </a> |
| 73 | + <a href="docs/v1/m5cores3.jpg" target="_blank" title="M5Stack CoreS3"> |
| 74 | + <img src="docs/v1/m5cores3.jpg" width="240" /> |
| 75 | + </a> |
| 76 | + <a href="docs/v1/atoms3r.jpg" target="_blank" title="AtomS3R + Echo Base"> |
| 77 | + <img src="docs/v1/atoms3r.jpg" width="240" /> |
| 78 | + </a> |
| 79 | + <a href="docs/v1/magiclick.jpg" target="_blank" title="神奇按钮 2.4"> |
| 80 | + <img src="docs/v1/magiclick.jpg" width="240" /> |
| 81 | + </a> |
| 82 | + <a href="docs/v1/waveshare.jpg" target="_blank" title="微雪电子 ESP32-S3-Touch-AMOLED-1.8"> |
| 83 | + <img src="docs/v1/waveshare.jpg" width="240" /> |
| 84 | + </a> |
| 85 | + <a href="docs/v1/lilygo-t-circle-s3.jpg" target="_blank" title="LILYGO T-Circle-S3"> |
| 86 | + <img src="docs/v1/lilygo-t-circle-s3.jpg" width="240" /> |
| 87 | + </a> |
| 88 | + <a href="docs/v1/xmini-c3.jpg" target="_blank" title="虾哥 Mini C3"> |
| 89 | + <img src="docs/v1/xmini-c3.jpg" width="240" /> |
| 90 | + </a> |
| 91 | + <a href="docs/v1/movecall-cuican-esp32s3.jpg" target="_blank" title="CuiCan"> |
| 92 | + <img src="docs/v1/movecall-cuican-esp32s3.jpg" width="240" /> |
| 93 | + </a> |
| 94 | + <a href="docs/v1/wmnologo_xingzhi_1.54.jpg" target="_blank" title="无名科技Nologo-星智-1.54"> |
| 95 | + <img src="docs/v1/wmnologo_xingzhi_1.54.jpg" width="240" /> |
| 96 | + </a> |
| 97 | + <a href="docs/v1/sensecap_watcher.jpg" target="_blank" title="SenseCAP Watcher"> |
| 98 | + <img src="docs/v1/sensecap_watcher.jpg" width="240" /> |
| 99 | + </a> |
| 100 | + <a href="docs/v1/esp-hi.jpg" target="_blank" title="ESP-HI 超低成本机器狗"> |
| 101 | + <img src="docs/v1/esp-hi.jpg" width="240" /> |
| 102 | + </a> |
| 103 | +</div> |
| 104 | + |
| 105 | +## 软件 |
| 106 | + |
| 107 | +### 固件烧录 |
| 108 | + |
| 109 | +新手第一次操作建议先不要搭建开发环境,直接使用免开发环境烧录的固件。 |
| 110 | + |
| 111 | +固件默认接入 [xiaozhi.me](https://xiaozhi.me) 官方服务器,个人用户注册账号可以免费使用 Qwen 实时模型。 |
| 112 | + |
| 113 | +👉 [新手烧录固件教程](https://ccnphfhqs21z.feishu.cn/wiki/Zpz4wXBtdimBrLk25WdcXzxcnNS) |
| 114 | + |
| 115 | +### 开发环境 |
| 116 | + |
| 117 | +- Cursor 或 VSCode |
| 118 | +- 安装 ESP-IDF 插件,选择 SDK 版本 5.4 或以上 |
| 119 | +- Linux 比 Windows 更好,编译速度快,也免去驱动问题的困扰 |
| 120 | +- 本项目使用 Google C++ 代码风格,提交代码时请确保符合规范 |
| 121 | + |
| 122 | +### 开发者文档 |
| 123 | + |
| 124 | +- [自定义开发板指南](docs/custom-board.md) - 学习如何为小智 AI 创建自定义开发板 |
| 125 | +- [MCP 协议物联网控制用法说明](docs/mcp-usage.md) - 了解如何通过 MCP 协议控制物联网设备 |
| 126 | +- [MCP 协议交互流程](docs/mcp-protocol.md) - 设备端 MCP 协议的实现方式 |
| 127 | +- [MQTT + UDP 混合通信协议文档](docs/mqtt-udp.md) |
| 128 | +- [一份详细的 WebSocket 通信协议文档](docs/websocket.md) |
| 129 | + |
| 130 | +## 大模型配置 |
| 131 | + |
| 132 | +如果你已经拥有一个小智 AI 聊天机器人设备,并且已接入官方服务器,可以登录 [xiaozhi.me](https://xiaozhi.me) 控制台进行配置。 |
| 133 | + |
| 134 | +👉 [后台操作视频教程(旧版界面)](https://www.bilibili.com/video/BV1jUCUY2EKM/) |
| 135 | + |
| 136 | +## 相关开源项目 |
| 137 | + |
| 138 | +在个人电脑上部署服务器,可以参考以下第三方开源的项目: |
| 139 | + |
| 140 | +- [xinnan-tech/xiaozhi-esp32-server](https://github.com/xinnan-tech/xiaozhi-esp32-server) Python 服务器 |
| 141 | +- [joey-zhou/xiaozhi-esp32-server-java](https://github.com/joey-zhou/xiaozhi-esp32-server-java) Java 服务器 |
| 142 | +- [AnimeAIChat/xiaozhi-server-go](https://github.com/AnimeAIChat/xiaozhi-server-go) Golang 服务器 |
| 143 | + |
| 144 | +使用小智通信协议的第三方客户端项目: |
| 145 | + |
| 146 | +- [huangjunsen0406/py-xiaozhi](https://github.com/huangjunsen0406/py-xiaozhi) Python 客户端 |
| 147 | +- [TOM88812/xiaozhi-android-client](https://github.com/TOM88812/xiaozhi-android-client) Android 客户端 |
| 148 | +- [100askTeam/xiaozhi-linux](http://github.com/100askTeam/xiaozhi-linux) 百问科技提供的 Linux 客户端 |
| 149 | +- [78/xiaozhi-sf32](https://github.com/78/xiaozhi-sf32) 思澈科技的蓝牙芯片固件 |
| 150 | +- [QuecPython/solution-xiaozhiAI](https://github.com/QuecPython/solution-xiaozhiAI) 移远提供的 QuecPython 固件 |
| 151 | + |
| 152 | +## 关于项目 |
| 153 | + |
| 154 | +这是一个由虾哥开源的 ESP32 项目,以 MIT 许可证发布,允许任何人免费使用,修改或用于商业用途。 |
| 155 | + |
| 156 | +我们希望通过这个项目,能够帮助大家了解 AI 硬件开发,将当下飞速发展的大语言模型应用到实际的硬件设备中。 |
| 157 | + |
| 158 | +如果你有任何想法或建议,请随时提出 Issues 或加入 QQ 群:1011329060 |
| 159 | + |
| 160 | +## Star History |
| 161 | + |
| 162 | +<a href="https://star-history.com/#78/xiaozhi-esp32&Date"> |
| 163 | + <picture> |
| 164 | + <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=78/xiaozhi-esp32&type=Date&theme=dark" /> |
| 165 | + <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=78/xiaozhi-esp32&type=Date" /> |
| 166 | + <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=78/xiaozhi-esp32&type=Date" /> |
| 167 | + </picture> |
| 168 | +</a> |
0 commit comments