diff --git a/xiaozhi-esp32-server-mini/translations/en.yaml b/xiaozhi-esp32-server-mini/translations/en.yaml index 5a0e57c..ff19024 100644 --- a/xiaozhi-esp32-server-mini/translations/en.yaml +++ b/xiaozhi-esp32-server-mini/translations/en.yaml @@ -3,6 +3,9 @@ configuration: timezone: name: "Timezone" description: "Set the server timezone" + host_ip: + name: "Host IP Address" + description: "IP address for WebSocket connection, leave empty to auto-detect LAN IP" log_level: name: "Log Level" description: "Set the verbosity of logs" diff --git a/xiaozhi-esp32-server-mini/translations/zh-Hans.yaml b/xiaozhi-esp32-server-mini/translations/zh-Hans.yaml index aaa801e..4eca806 100644 --- a/xiaozhi-esp32-server-mini/translations/zh-Hans.yaml +++ b/xiaozhi-esp32-server-mini/translations/zh-Hans.yaml @@ -3,6 +3,9 @@ configuration: timezone: name: "时区" description: "设置服务器时区" + host_ip: + name: "主机IP地址" + description: "用于WebSocket连接的IP地址,留空将自动获取内网IP" log_level: name: "日志级别" description: "设置日志详细程度" diff --git a/xiaozhi-esp32-webui/DOCS.md b/xiaozhi-esp32-webui/DOCS.md index 07de791..524ab80 100644 --- a/xiaozhi-esp32-webui/DOCS.md +++ b/xiaozhi-esp32-webui/DOCS.md @@ -1,14 +1,95 @@ # 小智 AI 智控台 -本加载项提供小智 ESP32 语音识别服务器功能,可与 ESP32 设备配合使用实现语音识别功能。 +本加载项提供小智 ESP32 是智控台的docker服务,需配合其它addons一起使用,快速体验本地化小智后端服务全功能版的乐趣。 + +## 安装方法与次序 + 1. 在加载项仓库中,另外安装配套的addons + + mariadb(在core仓库中,HA官方自带) + + redis server(在冬瓜甄选仓库中) + + 小智AI server最简安装版(在冬瓜甄选仓库中) + + 1. "Redis Server" 直接启动 + + 无需任何操作 + + 1. 配置"MariaDB" 并启动 + + (1)在“Databases”里增加下面内容,然后回车 + + ``` + xiaozhi_esp32_server + ``` + + (2)在“Logins”修改数据库密码为root,省事可用下面一行直接替换第一行 + + ``` + - password: root + ``` + + (3)在“Rights”最后增加以下内容 + + ``` + - database: xiaozhi_esp32_server + username: homeassistant + ``` + + (4)保存后启动 + + 1. "小智 AI 智控台" (本addons)直接启动 + + 因为本文档开始,直接默认设置了mariadb的密码为root。redis的服务器直接设置为“冬瓜甄选仓库”中的redis服务器名。所以直接启动就行。 + + (1)自己注册一个管理员并登录 + + (2)进入后,点击上方的“参数管理”,复制第一行开头为“server.secret”里的“参数值”里的字符串 + + (3)模型配置——配置大语音模型(建议豆包) + + (4)模型配置——配置语音合成(建议豆包) + + (5)模型配置——配置语音识别(建议豆包) + + (6)模型配置——配置意图识别(需要控制HA的话,选最后一项“Intent_function_call”,设置为"默认") + + - 然后点击“修改”,在“函数列表”的最后面,加上以下的字符后,保存。 + + ``` + ;hass_get_state;hass_set_state + ``` + +1. 配置 "小智 AI Server最简安装版" + + (1)先启动一次,等默认配置生成,然后停止。 + + (2)使用filebrowser等方式,修改“小智AI Server最简安装版”的,在“addon_configs”目录——“7eca76cc_xiaozhi_esp32_server”目录——“data”目录——编辑“.config.yaml”文件 + + - 把http://127.0.0.1:8002/xiaozhi那一行替换成 + + ``` + url: http://homeassistant.local:8002/xiaozhi + ``` + + - 把刚才复制的“server.secret”,放到最后一行替换掉,注意空格要留好。 + + (3)启动“小智 AI Server最简安装版”服务。 + + 1. 配置"小智 AI 智控台"接口等 + + 上续操作等,己经能正常启动了。但是智控台中“参数管理”中 + + - server.websocket + + ``` + ws://homeassistant.local:8000/xiaozhi/v1/ + ``` -## 安装 - 1. 在 Home Assistant 的加载项商店中添加此仓库地址或复制到本地加载项目录 - 1. 安装 "Redis Server" 并配置 - 1. 安装 "Mysql"或"MariaDB" 并配置 - 1. 安装 "小智 AI 智控台" 加载项 -## 配置 + + 关键己说明,可以直接开始使用,细节配置大家看一下官方的说明 +## 备用的技术参考配置(可忽略) ```yaml mysql_host: core-mariadb #MySQL/MariaDB数据库主机地址,查看方式:Home Assistant → 设置 → 加载项 → MySQL/MariaDB → 信息 → 宿主名 diff --git a/xiaozhi-esp32-webui/README.md b/xiaozhi-esp32-webui/README.md index 0b05dec..22c65d7 100644 --- a/xiaozhi-esp32-webui/README.md +++ b/xiaozhi-esp32-webui/README.md @@ -1,14 +1,13 @@ # 冬瓜甄选addons:小智 AI 智控台 -适用于 Home Assistant 的 小智 AI 智控台 加载项。 +适用于 Home Assistant 的 小智 AI 智控台的加载项。它是不能单独使用的,需要配合mariadb,redis server和“小智AI Server最简版”同时使用。 -## 使用方法 +## 相关说明 -1. 安装加载项 -2. 配置 Mysql 和 Redis 参数 -3. 点击启动,访问 http://homeassistant.local:8002 进入 Web 管理界面 +1. 小智后端服务xiaozhi-esp32-server布署有两种方式。都是采用的docker compose的安装方式,其中有一个全模块安装法。 +2. 此次换种方式,没有全套打包,而是充分体现小型云主机特点,不同的docker形成不同的addons,相互配合使用。 -详细使用说明请参阅 DOCS.md 文档。 +详细使用说明请原项目的帮助文档和网上的一些经验。 ## 支持与反馈 diff --git a/xiaozhi-esp32-webui/config.yaml b/xiaozhi-esp32-webui/config.yaml index c64f14e..115140f 100644 --- a/xiaozhi-esp32-webui/config.yaml +++ b/xiaozhi-esp32-webui/config.yaml @@ -23,8 +23,8 @@ options: mysql_port: 3306 mysql_database: xiaozhi_esp32_server mysql_username: homeassistant - mysql_password: - redis_host: + mysql_password: root + redis_host: 7eca76cc-redis-server redis_port: 6379 timezone: Asia/Shanghai schema: