1.安装MySQL数据库
#下载并执行Docker官方安装脚本
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
#启动Docker服务
sudo systemctl start docker
sudo systemctl enable docker
如果本机已经安装了MySQL,可以直接在数据库中创建名为xiaozhi_esp32_server的数据库。
sudo docker exec -it xiaozhi-esp32-server-db mysql -u root -p
CREATE DATABASE xiaozhi_esp32_server CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
如果还没有MySQL,你可以通过docker安装mysql
docker run --name xiaozhi-esp32-server-db -e MYSQL_ROOT_PASSWORD=123456 -p 3306:3306 -e MYSQL_DATABASE=xiaozhi_esp32_server -e MYSQL_INITDB_ARGS="--character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci" -e TZ=Asia/Shanghai -d mysql:latest
2.安装redis
vim /etc/docker/daemon.json
增加
{
"registry-mirrors":["https://docker.1ms.run","https://docker.1panel.live/"]
}
如果还没有Redis,你可以通过docker安装redis
docker run --name xiaozhi-esp32-server-redis -d -p 6379:6379 redis
3.运行manager-api程序
3.1 安装JDK21,设置JDK环境变量
sudo apt install openjdk-21-jdk
java -version
3.2 安装Maven,设置Maven环境变量
sudo apt install maven
3.3 使用Vscode编程工具,安装好Java环境相关插件
3.4 使用Vscode编程工具加载manager-api模块
在src/main/resources/application-dev.yml中配置数据库连接信息
spring:
datasource:
username: root
password: 123456
在src/main/resources/application-dev.yml中配置Redis连接信息
spring:
data:
redis:
host: localhost
port: 6379
password:
database: 0
3.5 运行主程序
本项目为SpringBoot项目,启动方式为: 打开Application.java运行Main方法启动
路径地址:
src/main/java/xiaozhi/AdminApplication.java
当你看到输出日志时,说明你的manager-api启动成功了。
2025-xx-xx 22:11:12.445 [main] INFO c.a.d.s.b.a.DruidDataSourceAutoConfigure - Init DruidDataSource
2025-xx-xx 21:28:53.873 [main] INFO xiaozhi.AdminApplication - Started AdminApplication in 16.057 seconds (process running for 17.941)
http://localhost:8002/xiaozhi/doc.html
4.运行manager-web程序
4.1 安装nodejs
4.2 使用Vscode编程工具加载manager-web模块
sudo apt install npm
终端命令进入manager-web目录下
npm install
然后启动
npm run serve
请注意,如果你的manager-api的接口不在http://localhost:8002,请在开发时,修改 main/manager-web/.env.development中的路径
运行成功后,你需要使用浏览器,打开智控台,链接:http://127.0.0.1:8001 ,注册第一个用户。第一个用户即是超级管理员,以后的用户都是普通用户。普通用户只能绑定设备和配置智能体;超级管理员可以进行模型管理、用户管理、参数配置等功能。
重要:注册成功后,使用超级管理员账号,登录智控台,在顶部菜单找到模型配置,然后在左侧栏点击大语言模型,找到第一条数据智谱AI,点击修改按钮, 弹出修改框后,将你注册到的智谱AI的密钥填写到API密钥中。然后点击保存。
重要:注册成功后,使用超级管理员账号,登录智控台,在顶部菜单找到模型配置,然后在左侧栏点击大语言模型,找到第一条数据智谱AI,点击修改按钮, 弹出修改框后,将你注册到的智谱AI的密钥填写到API密钥中。然后点击保存。
重要:注册成功后,使用超级管理员账号,登录智控台,在顶部菜单找到模型配置,然后在左侧栏点击大语言模型,找到第一条数据智谱AI,点击修改按钮, 弹出修改框后,将你注册到的智谱AI的密钥填写到API密钥中。然后点击保存。
5.安装Python环境
本项目使用conda管理依赖环境。如果不方便安装conda,需要根据实际的操作系统安装好libopus和ffmpeg。 如果确定使用conda,则安装好后,开始执行以下命令。
wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh
sudo chmod +x Miniconda3-latest-Linux-x86_64.sh
./Miniconda3-latest-Linux-x86_64.sh
运行之后,如果你能看到命令行窗口前面有一个(base)字样,说明你成功进入了conda环境。那么你就可以执行以下命令了。
conda remove -n xiaozhi-esp32-server --all -y
conda create -n xiaozhi-esp32-server python=3.10 -y
conda activate xiaozhi-esp32-server
添加清华源通道
conda config --add channels https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/main
conda config --add channels https://mirrors.tuna.tsinghua.edu.cn/anaconda/pkgs/free
conda config --add channels https://mirrors.tuna.tsinghua.edu.cn/anaconda/cloud/conda-forge
conda install libopus -y
conda install ffmpeg -y
请注意,以上命令,不是一股脑执行就成功的,你需要一步步执行,每一步执行完后,都检查一下输出的日志,查看是否成功。
6.安装本项目依赖
你先要下载本项目源码,源码可以通过git clone命令下载,如果你不熟悉git clone命令。
你可以用浏览器打开这个地址https://github.com/xinnan-tech/xiaozhi-esp32-server.git
打开完,找到页面中一个绿色的按钮,写着Code的按钮,点开它,然后你就看到Download ZIP的按钮。
点击它,下载本项目源码压缩包。下载到你电脑后,解压它,此时它的名字可能叫xiaozhi-esp32-server-main 你需要把它重命名成xiaozhi-esp32-server,在这个文件里,进入到main文件夹,再进入到xiaozhi-server,好了请记住这个目录xiaozhi-server。
继续使用conda环境
conda activate xiaozhi-esp32-server
进入到你的项目根目录,再进入main/xiaozhi-server
cd main/xiaozhi-server
pip config set global.index-url https://mirrors.aliyun.com/pypi/simple/
pip install -r requirements.txt
7.下载语音识别模型文件
本项目语音识别模型,默认使用SenseVoiceSmall模型,进行语音转文字。因为模型较大,需要独立下载,下载后把model.pt 文件放在models/SenseVoiceSmall 目录下。下面两个下载路线任选一个。
线路一:阿里魔塔下载SenseVoiceSmall
线路二:百度网盘下载SenseVoiceSmall 提取码: qvna
8.配置项目文件
使用超级管理员账号,登录智控台 ,在顶部菜单找到参数管理,找到列表中第一条数据,参数编码是server.secret,复制它到参数值。
server.secret需要说明一下,这个参数值很重要,作用是让我们的Server端连接manager-api。server.secret是每次从零部署manager模块时,会自动随机生成的密钥。
如果你的xiaozhi-server目录没有data,你需要创建data目录。 如果你的data下面没有.config.yaml文件,你可以把xiaozhi-server目录下的config_from_api.yaml文件复制到data,并重命名为.config.yaml
复制参数值后,打开xiaozhi-server下的data目录的.config.yaml文件。此刻你的配置文件内容应该是这样的:
manager-api:
url: http://127.0.0.1:8002/xiaozhi
secret: 你的server.secret值
把你刚才从智控台复制过来的server.secret的参数值复制到.config.yaml文件里的secret里。
类似这样的效果
manager-api:
url: http://127.0.0.1:8002/xiaozhi
secret: 12345678-xxxx-xxxx-xxxx-123456789000
5.运行项目
确保在xiaozhi-server目录下执行
conda activate xiaozhi-esp32-server
python app.py
如果你能看到,类似以下日志,则是本项目服务启动成功的标志。
25-02-23 12:01:09[core.websocket_server] - INFO - Server is running at ws://xxx.xx.xx.xx:8000/xiaozhi/v1/
25-02-23 12:01:09[core.websocket_server] - INFO - =上面的地址是websocket协议地址,请勿用浏览器访问=
25-02-23 12:01:09[core.websocket_server] - INFO - 如想测试websocket请用谷歌浏览器打开test目录下的test_page.html
25-02-23 12:01:09[core.websocket_server] - INFO - =======================================================
由于你是全模块部署,因此你有两个重要的接口。
OTA接口:
http://你电脑局域网的ip:8002/xiaozhi/ota/
Websocket接口:
ws://你电脑局域网的ip:8000/xiaozhi/v1/
请你务必把以上两个接口地址写入到智控台中:他们将会影响websocket地址发放和自动升级功能。
1、使用超级管理员账号,登录智控台,在顶部菜单找到参数管理,找到参数编码是server.websocket,输入你的Websocket接口。
2、使用超级管理员账号,登录智控台,在顶部菜单找到参数管理,找到数编码是server.ota,输入你的OTA接口。