（中文 | English）
本项目为开源智能硬件项目 xiaozhi-esp32
提供后端服务。根据小智通信协议使用Python实现。
本项目需要配合esp32硬件设备使用，如果童鞋们已经购买了esp32相关硬件，且成功对接虾哥部署的后端，并且想自己独立搭建
xiaozhi-esp32后端服务，可学习本项目。
想看使用效果,请猛戳这个视频
要想完整体验本项目，需要以下总体步骤：
- 准备一套兼容
xiaozhi-esp32项目的硬件设备，具体型号可点击这里。 - 拥有一台至少4核CPU 8G内存的普通电脑或服务器，运行本项目。部署后可以在控制台看到本项目服务的接口地址。
- 下载
xiaozhi-esp32项目，把接口地址修改成本项目地址，然后编译，把新固件烧录到硬件设备上。 - 启动设备，查看电脑或服务器的控制台，如果看到日志，说明成功连到本项目的接口了。
本项目成立时间较短，还未通过网络安全测评，请勿在生产环境中使用。
如果您在公网环境中部署学习本项目。请务必在配置文件config.yaml开启防护。
server:
auth:
# 开启防护
enabled: true
开启防护后，你要根据自己的情况，要么校验机器的token，要么校验机器的mac地址，详细可看配置。
xiaozhi-esp32通信 WebSocket 协议- 支持唤醒对话、手动对话、实时打断对话
- 支持国语、粤语、英语、日语、韩语 5 种语言识别（FunASR（默认））
- 自由更换 LLM（openai接口支持ChatGLM（默认）、阿里百炼、DeepSeek等，dify接口支持Dify官方及私有化部署）
- 自由更换 TTS（支持EdgeTTS（默认）、火山引擎豆包TTS）
- 长时间不聊天进入休眠状态
- 对话记忆
- 更换心情模式
| 类型 | 平台名称 | 使用方式 | 收费模式 | 备注 |
|---|---|---|---|---|
| LLM | 阿里百炼 | openai接口调用 | 消耗token | 点击申请密钥 |
| LLM | 深度求索 | openai接口调用 | 消耗token | 点击申请密钥 |
| LLM | 智谱 | openai接口调用 | 免费 | 点击创建密钥 |
| LLM | Dify | dify接口调用 | 消耗token | 本地化部署 |
| TTS | 火山引擎 | 接口调用 | 消耗token | 点击创建密钥 |
| TTS | EdgeTTS | 接口调用 | 免费 | |
| VAD | SileroVAD | 本地使用 | 免费 | |
| ASR | FunASR | 本地使用 | 免费 |
实际上，任何支持openai接口调用的LLM，都可以接入使用。
本项目支持docker快速部署、借助docker环境运行部署和本地源码运行三种方式。三种方式怎么选，每个人的情况不一样，以下是一些推荐。
如果您主要是想快速体验，推荐使用方式一：docker快速部署。
如果您已经安装docker，不想折腾环境，又想对代码进行DIY修改，推荐方式二：借助docker环境运行部署。
如果您对conda的使用得心应手，或想从零开始学习搭建环境，推荐方式三：本地源码运行。
如果你对小智的回答速度非常的敏感，不希望有丝丝的性能损失，推荐方式三：本地源码运行。
docker镜像已支持x86架构、arm64架构的CPU，支持在国产操作系统上运行。
如果您的电脑还没安装docker，可以按照这里的教程安装：docker安装
安装完后，你需要为这个项目找一个安放配置文件的目录，我们暂且称它为项目目录，这个目录最好是一个新建的空的目录。
用浏览器打开这个链接。
在页面的右侧找到名称为RAW按钮，在RAW按钮的旁边，找到下载的图标，点击下载按钮，下载config.yaml文件。 把文件下载到你的
项目目录。
修改刚才你下载的config.yaml文件，配置本项目所需的各种参数。默认的LLM使用的是ChatGLMLLM
，你需要配置密钥，因为他们的模型，虽然有免费的，但是仍要去官网注册密钥，才能启动。
默认的TTS使用的是EdgeTTS，这个无需配置，如果你需要更换成豆包TTS，则需要配置密钥。
配置说明：这里是各个功能使用的默认组件，例如LLM默认使用ChatGLMLLM模型。如果需要切换模型，就是改对应的名称。
本项目的默认配置原则是成本最低配置原则（glm-4-flash和EdgeTTS都是免费的），如果需要更优的更快的搭配，需要自己结合部署环境切换各组件的使用。
selected_module:
ASR: FunASR
VAD: SileroVAD
LLM: ChatGLMLLM
TTS: EdgeTTS
比如修改LLM使用的组件，就看本项目支持哪些LLM API接口，当前支持的是openai、dify。欢迎验证和支持更多LLM平台的接口。
使用时，在selected_module修改成对应的如下LLM配置的名称：
LLM:
AliLLM:
type: openai
...
DeepSeekLLM:
type: openai
...
ChatGLMLLM:
type: openai
...
DifyLLM:
type: dify
...
有些服务，比如如果你使用Dify、豆包的TTS，是需要密钥的，记得在配置文件加上哦！
打开命令行工具，cd 进入到你的项目目录，执行以下命令
#如果你是linux，执行
ls
#如果你是windows，执行
dir
如果你能看到config.yaml文件，确确实实进入到了项目目录，接着执行以下命令：
docker run -d --name xiaozhi-esp32-server --restart always --security-opt seccomp:unconfined -p 8000:8000 -v $(pwd)/config.yaml:/opt/xiaozhi-esp32-server/config.yaml ccr.ccs.tencentyun.com/xinnan/xiaozhi-esp32-server:latest
如果首次执行，可能需要几分钟时间，你要耐心等待他完成拉取。正常拉取完成后，你可以在命令行执行以下命令查看服务是否启动成功
docker ps
如果你能看到xiaozhi-server，说明服务启动成功。那你还可以进一步执行以下命令，查看服务的日志
docker logs -f xiaozhi-esp32-server
如果你能看到，类似以下日志,则是本项目服务启动成功的标志。
2025-xx-xx xx:51:59,492 - core.server - INFO - Server is running at ws://xx.xx.xx.xxx:8000
2025-xx-xx xx:51:59,516 - websockets.server - INFO - server listening on 0.0.0.0:8000
接下来，你就可以开始 编译esp32固件了，请往下翻，翻到编译esp32固件相关章节。那么由于你是用docker部署，你要自己查看自己本机电脑的ip是多少。
正常来说，假设你的ip是192.168.1.25，那么你的接口地址就是：ws://192.168.1.25:8000。这个信息很有用的，后面编译esp32固件
需要用到。
请注意，你的接口地址是websocket协议的地址，你可以使用apifox等工具调试。但是不能直接用浏览器打开访问，如果用浏览器打开，日志会显示错误，会让你怀疑是否部署成功了。
后期如果想升级版本，可以这么操作
1、备份好config.yaml文件，一些关键的配置到时复制到新的config.yaml文件里。
2、执行以下命令
docker stop xiaozhi-esp32-server
docker rm xiaozhi-esp32-server
docker rmi ccr.ccs.tencentyun.com/xinnan/xiaozhi-esp32-server:latest
3.按本教程重新来一遍
这个方法的原理，其实是和第一种方式类似。区别在于，第一种方式只要下载一个配置文件，而本方式要下载项目源码。
优点就是源码在你主机躺着，你可以使用本机的代码编辑器加载项目和修改源码。每次修改完项目，想要看效果，那就要重启docker。
缺点就要下载本项目的代码，还要下载模型文件，如果这个项目不常用，确实会占用您电脑的空间。
下载源码后，需要下载模型文件。 默认使用SenseVoiceSmall模型，进行语音转文字。因为模型较大，需要独立下载，下载后把model.pt
文件放在model/SenseVoiceSmall
目录下。下面两个下载路线任选一个。
- 线路一：阿里魔塔下载SenseVoiceSmall
- 线路二：百度网盘下载SenseVoiceSmall 提取码:
qvna
下载模型后，需要按照方式一：docker快速部署修改配置文件config.yaml
修改完配置后，打开命令行工具，cd进入到你的项目目录下，执行以下命令
docker run -d --name xiaozhi-esp32-server --restart always --security-opt seccomp:unconfined \
-p 8000:8000 \
-v $(pwd):/opt/xiaozhi-esp32-server \
ccr.ccs.tencentyun.com/xinnan/xiaozhi-esp32-server:latest
docker logs -f xiaozhi-esp32-server
如果你能看到，类似以下日志,则是本项目服务启动成功的标志。
2025-xx-xx xx:51:59,492 - core.server - INFO - Server is running at ws://xx.xx.xx.xxx:8000
2025-xx-xx xx:51:59,516 - websockets.server - INFO - server listening on 0.0.0.0:8000
接下来，你就可以开始 编译esp32固件了，请往下翻，翻到编译esp32固件相关章节。那么由于你是用docker部署，你要自己查看自己本机电脑的ip是多少。
正常来说，假设你的ip是192.168.1.25，那么你的接口地址就是：ws://192.168.1.25:8000。这个信息很有用的，后面编译esp32固件
需要用到。
请注意，你的接口地址是websocket协议的地址，你可以使用apifox等工具调试。但是不能直接用浏览器打开访问，如果用浏览器打开，日志会显示错误，会让你怀疑是否部署成功了。
后期，如果你修改了代码，想让新代码跑起来，可以用以下命令让docker容器重启：
docker restart xiaozhi-esp32-server
# 查看日志输出
docker logs -f xiaozhi-esp32-server
本项目使用conda管理依赖环境，安装好后，开始执行以下命令。
conda remove -n xiaozhi-esp32-server --all -y
conda create -n xiaozhi-esp32-server python=3.10 -y
conda activate xiaozhi-esp32-server
执行以上命令后， 如果你的电脑是Windows或Mac，执行下面的语句：
conda activate xiaozhi-esp32-server
conda install conda-forge::libopus
conda install conda-forge::ffmpeg
如果你的电脑是ubuntu，执行下面的语句：
apt-get install libopus0 ffmpeg
# 拉取本项目后进入本项目根目录
cd xiaozhi-esp32-server
conda activate xiaozhi-esp32-server
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
pip install -r requirements.txt
默认使用SenseVoiceSmall模型，进行语音转文字。因为模型较大，需要独立下载，下载后把model.pt文件放在model/SenseVoiceSmall
目录下。下面两个下载路线任选一个。
- 线路一：阿里魔塔下载SenseVoiceSmall
- 线路二：百度网盘下载SenseVoiceSmall 提取码:
qvna
修改config.yaml文件，配置本项目所需的各种参数。默认的LLM使用的是ChatGLMLLM
，你需要配置密钥，因为他们的模型，虽然有免费的，但是仍要去官网注册密钥，才能启动。
默认的TTS使用的是EdgeTTS，这个无需配置，如果你需要更换成豆包TTS，则需要配置密钥。
# 如果您是一名开发者，建议阅读以下内容。如果不是开发者，可以忽略这部分内容。
在开发中，建议将【config.yaml】复制一份，改成【.config.yaml】。 系统会优先读取【.config.yaml】文件的配置。
这样做，可以避免在提交代码的时候，错误地提交密钥信息，保护您的密钥安全。
配置说明：这里是各个功能使用的默认组件，例如LLM默认使用ChatGLMLLM模型。如果需要切换模型，就是改对应的名称。
本项目的默认配置仅是成本最低配置（glm-4-flash和EdgeTTS都是免费的），如果需要更优的更快的搭配，需要自己结合部署环境切换各组件的使用。
selected_module:
ASR: FunASR
VAD: SileroVAD
LLM: ChatGLMLLM
TTS: EdgeTTS
比如修改LLM使用的组件，就看本项目支持哪些LLM API接口，当前支持的是openai、dify。欢迎验证和支持更多LLM平台的接口。
使用时，在selected_module修改成对应的如下LLM配置的名称：
LLM:
DeepSeekLLM:
type: openai
...
ChatGLMLLM:
type: openai
...
DifyLLM:
type: dify
...
有些服务，比如如果你使用Dify、豆包的TTS，是需要密钥的，记得在配置文件加上哦！
启动项目
# 确保在本项目的根目录下执行
conda activate xiaozhi-esp32-server
python app.py
启动后，会看到类似以下日志
2025-xx-xx xx:51:59,492 - core.server - INFO - Server is running at ws://192.168.1.25:8000
2025-xx-xx xx:51:59,516 - websockets.server - INFO - server listening on 0.0.0.0:8000
其中上面的ws://192.168.1.25:8000就是本项目提供的接口地址了，当然你自己的机器和我的是不一样的，记得要找到自己的地址。
请注意，你的接口地址是websocket协议的地址，你可以使用apifox等工具调试。但是不能直接用浏览器打开访问，如果用浏览器打开，日志会显示错误，会让你怀疑是否部署成功了。
-
下载
xiaozhi-esp32项目，按照这个教程配置项目环境《Windows搭建 ESP IDF 5.3.2开发环境以及编译小智》 -
打开
xiaozhi-esp32/main/Kconfig.projbuild文件，找到WEBSOCKET_URL的default的内容，把wss://api.tenclass.net改成你自己的地址，例如，我的接口地址是ws://192.168.1.25:8000，就把内容改成这个。
修改前：
config WEBSOCKET_URL
depends on CONNECTION_TYPE_WEBSOCKET
string "Websocket URL"
default "wss://api.tenclass.net/xiaozhi/v1/"
help
Communication with the server through websocket after wake up.
修改后(示例)：
config WEBSOCKET_URL
depends on CONNECTION_TYPE_WEBSOCKET
string "Websocket URL"
default "ws://192.168.1.25:8000/xiaozhi/v1/"
help
Communication with the server through websocket after wake up.
注意：你的地址是ws://开头，不是wss://开头，一定不要写错了。
注意：你的地址是ws://开头，不是wss://开头，一定不要写错了。
注意：你的地址是ws://开头，不是wss://开头，一定不要写错了。
- 设置编译参数
# 终端命令行进入xiaozhi-esp32的根目录
cd xiaozhi-esp32
# 例如我使用的板子是esp32s3，所以设置编译目标为esp32s3，如果你的板子是其他型号，请替换成对应的型号
idf.py set-target esp32s3
# 进入菜单配置
idf.py menuconfig
进入菜单配置后，再进入Xiaozhi Assistant，将CONNECTION_TYPE设置为Websocket
回退到主菜单，再进入Xiaozhi Assistant，将BOARD_TYPE设置你板子的具体型号
保存退出，回到终端命令行。
- 编译固件
idf.py build
- 打包bin固件
cd scripts
python release.py
编译成功后，会在项目根目录下的build目录下生成固件文件merged-binary.bin。
这个merged-binary.bin就是要烧录到硬件上的固件文件。
注意：如果执行到第二命令后，报了“zip”相关的错误，请忽略这个错误，只要build目录下生成固件文件merged-binary.bin
，对你没有太大影响，请继续。
- 烧录固件 将esp32设备连接电脑，使用chrome浏览器，打开以下网址
https://espressif.github.io/esp-launchpad/
打开这个教程，Flash工具/Web端烧录固件（无IDF开发环境）。
翻到：方式二：ESP-Launchpad 浏览器WEB端烧录，从3. 烧录固件/下载到开发板开始，按照教程操作。
建议：如果EdgeTTS经常失败，先检查一下是否用了梯子，如果用了梯子，请把梯子关了试试。
如果用的是火山引擎的豆包TTS经常失败，最好使用付费版本，因为他们的测试版本只有2个并发。
建议：在配置文件里，将LLM设置成DifyLLM，然后通过Dify编排智能体实现。
建议：在配置文件里，找到这一段，将min_silence_duration_ms值改大一点，比如改成1000。
VAD:
SileroVAD:
threshold: 0.5
model_dir: models/snakers4_silero-vad
min_silence_duration_ms: 700 # 如果说话停顿比较长，可以把这个值设置大一些
本项目的默认配置，是成本最低的配置。建议刚上手的童鞋，使用默认的免费模型，先解决了“跑得动”的问题，再解决“跑得快”的问题。 如果要提高响应速度，需要更换各组件来解决。以下是本项目各组件的响应速度测试Tip。
以下内容和结论仅供参考，不构成任何形式的承诺或保证。
| 排名 | 组件名称 | 响应速度(ms) |
|---|---|---|
| 1 | AliLLM | 630 |
| 2 | ChatGLMLLM | 2000 |
| 3 | DeepSeekLLM | 6800 |
测试地点：广东省佛山市禅城区
测试时间：2025年2月9日 16:12
宽带运营商：中国移动
测试方法：更换配置后，执行core/utils/llm.py文件
| 排名 | 组件名称 | 响应速度(ms) |
|---|---|---|
| 1 | DoubaoTTS | 645 |
| 2 | EdgeTTS | 1019 |
测试地点：广东省佛山市禅城区
测试时间：2025年2月9日 16:12
宽带运营商：中国移动
测试方法：更换配置后，执行core/utils/tts.py文件
2025年2月9日，如果我的电脑在广东省佛山市禅城区，且使用的是中国移动网络，我会优先使用：
- LLM：
AliLLM - TTS：
DoubaoTTS
