Skip to content

Commit aaaae52

Browse files
flyingcysflyingcys
committed
update README.md
1 parent 5dc1673 commit aaaae52

1 file changed

Lines changed: 107 additions & 5 deletions

File tree

‎apps/tuya.ai/your_chat_bot/RAEDME_zh.md‎

Lines changed: 107 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,116 @@
2020
2. 音频播放
2121

2222
## 已支持硬件
23-
| 型号 | 说明 | 重置方式 |
24-
| --- | --- | --- |
25-
| TUYA T5AI_Board 开发板 | [https://developer.tuya.com/cn/docs/iot-device-dev/T5-E1-IPEX-development-board?id=Ke9xehig1cabj](https://developer.tuya.com/cn/docs/iot-device-dev/T5-E1-IPEX-development-board?id=Ke9xehig1cabj) | 重启(按 RST 按钮) 3 次重置 |
26-
| TUYA T5AI_EVB 开发板 | [https://oshwhub.com/flyingcys/t5ai_evb](https://oshwhub.com/flyingcys/t5ai_evb) | 重启(按 RST 按钮) 3 次重置 |
23+
| 型号 | config | 说明 | 重置方式 |
24+
| --- | --- | --- | ----- |
25+
| TUYA T5AI_Board 开发板 | TUYA_T5AI_BOARD_LCD_3.5.config | [https://developer.tuya.com/cn/docs/iot-device-dev/T5-E1-IPEX-development-board?id=Ke9xehig1cabj](https://developer.tuya.com/cn/docs/iot-device-dev/T5-E1-IPEX-development-board?id=Ke9xehig1cabj) | 重启(按 RST 按钮) 3 次重置 |
26+
| TUYA T5AI_EVB 开发板 | TUYA_T5AI_EVB.config | [https://oshwhub.com/flyingcys/t5ai_evb](https://oshwhub.com/flyingcys/t5ai_evb) | 重启(按 RST 按钮) 3 次重置 |
27+
| moji T5AI 版 | T5AI_MOJI_1.28.config | | 重启(按 RST 按钮) 3 次重置 |
28+
| 正点原子 ESP32S3BOX | DNESP32S3_BOX.config | [https://www.alientek.com/Product_Details/118.html](https://www.alientek.com/Product_Details/118.html) | 重启(按 RST 按钮) 3 次重置 |
29+
| ESP32S3 面包板 | ESP32S3_BREAD_COMPACT_WIFI.config | | 重启(按 RST 按钮) 3 次重置 |
30+
| waveshare ESP32S3 1.8 英寸触摸 AMOLED 开发板 | WAVESHARE_ESP32S3_TOUCH_AMOLED_1_8.config | [https://www.waveshare.net/shop/ESP32-S3-Touch-AMOLED-1.8.htm](https://www.waveshare.net/shop/ESP32-S3-Touch-AMOLED-1.8.htm) | 重启(按 RST 按钮) 3 次重置 |
31+
| ESP32S3 星智 0.96 OLED 开发板 | XINGZHI_Cube_0_96OLED_WIFI.config | [https://www.nologo.tech/product/esp32/esp32s3/esp32s3ai/esp32s3ai.html](https://www.nologo.tech/product/esp32/esp32s3/esp32s3ai/esp32s3ai.html) | 重启(按 RST 按钮) 3 次重置 |
2732

2833

2934
## 编译
3035
1. 运行 `tos config_choice` 命令， 选择当前运行的开发板。
3136
2. 如需修改配置，请先运行 `tos menuconfig` 命令修改配置。
3237
3. 运行 `tos build` 命令，编译工程。
33-
38+
39+
## 配置说明
40+
41+
### 通用配置
42+
43+
- **选择对话模式**
44+
45+
- 长按对话模式
46+
47+
| 宏 | 类型 | 说明 |
48+
| -------------------------------------- | ---- | -------------------------------------- |
49+
| ENABLE_CHAT_MODE_KEY_PRESS_HOLD_SINGEL | 布尔 | 按住按键后说话，一句话说完后松开按键。 |
50+
51+
- 按键对话模式
52+
53+
| 宏 | 类型 | 说明 |
54+
| ---------------------------------- | ---- | ------------------------------------------------------------ |
55+
| ENABLE_CHAT_MODE_KEY_TRIG_VAD_FREE | 布尔 | 按一下按键，设备会进入/退出聆听状态。如果在聆听状态，会开启 vad 检测，此时可以进行对话。 |
56+
57+
- 唤醒对话模式
58+
59+
| 宏 | 类型 | 说明 |
60+
| ---------------------------------- | ---- | ------------------------------------------------------------ |
61+
| ENABLE_CHAT_MODE_ASR_WAKEUP_SINGEL | 布尔 | 需要说出唤醒词才能唤醒设备，设备唤醒后会进入聆听状态，此时可以进行对话。每次唤醒只能进行一轮对话。如果想继续对话，需要再次用唤醒词唤醒。 |
62+
63+
- 随意对话模式
64+
65+
| 宏 | 类型 | 说明 |
66+
| -------------------------------- | ---- | ------------------------------------------------------------ |
67+
| ENABLE_CHAT_MODE_ASR_WAKEUP_FREE | 布尔 | 需要说出唤醒词才能唤醒设备，设备唤醒后会进入聆听状态，此时可以进行随意对话。如果 30S 没有检测到声音，则需要再次唤醒。 |
68+
69+
- **选择唤醒词**
70+
71+
该配置只会在对话模式选择**唤醒对话**和**随意对话**两种模式下才会出现。
72+
73+
| 宏 | 类型 | 说明 |
74+
| ------------------------------------- | ---- | ------------------- |
75+
| ENABLE_WAKEUP_KEYWORD_NIHAO_TUYA | 布尔 | 唤醒词是 “你好涂鸦” |
76+
| ENABLE_WAKEUP_KEYWORD_NIHAO_XIAOZHI | 布尔 | 唤醒词是 “你好小智” |
77+
| ENABLE_WAKEUP_KEYWORD_XIAOZHI_TONGXUE | 布尔 | 唤醒词是 “小智同学” |
78+
| ENABLE_WAKEUP_KEYWORD_XIAOZHI_GUANJIA | 布尔 | 唤醒词是 “小智管家” |
79+
80+
- **是否支持 AEC**
81+
82+
| 宏 | 类型 | 说明 |
83+
| ---------- | ---- | ------------------------------------------------------------ |
84+
| ENABLE_AEC | 布尔 | 这个是根据板子的硬件是否有回声消除功能来配置。<br />如果板子支持回声消除，则把该配置打开。**如果板子不支持回声消除，则需要关闭该功能，否则会影响唤醒对话功能**。<br />该配置没打开，则不支持语音打断的功能。 |
85+
86+
- **喇叭使能引脚**
87+
88+
| 宏 | 类型 | 说明 |
89+
| -------------- | ---- | ------------------------------------ |
90+
| SPEAKER_EN_PIN | 数值 | 该引脚控制喇叭是否使能，范围：0-64。 |
91+
92+
- **对话按键引脚**
93+
94+
| 宏 | 类型 | 说明 |
95+
| --------------- | ---- | -------------------------------- |
96+
| CHAT_BUTTON_PIN | 数值 | 控制对话的按键引脚，范围：0-64。 |
97+
98+
- **指示灯引脚**
99+
100+
| 宏 | 类型 | 说明 |
101+
| --------------------- | ---- | ---------------------------------------------------------- |
102+
| CHAT_INDICATE_LED_PIN | 数值 | 控制指示灯引脚，该指示灯主要用来显示对话状态，范围：0-64。 |
103+
104+
- **使能显示**
105+
106+
| 宏 | 类型 | 说明 |
107+
| ------------------- | ---- | ------------------------------------------------ |
108+
| ENABLE_CHAT_DISPLAY | 布尔 | 使能显示功能，如果板子有带屏幕，可将该功能打开。 |
109+
110+
### 显示配置
111+
112+
显示使能被打开后，以下配置才会出现。
113+
114+
- **选择显示 UI 风格**
115+
116+
| 宏 | 类型 | 说明 |
117+
| ------------------ | ---- | ------------------------ |
118+
| ENABLE_GUI_WECHAT | 布尔 | 类似微信聊天界面式风格 |
119+
| ENABLE_GUI_CHATBOT | 布尔 | 聊天盒子式风格 |
120+
| ENABLE_GUI_OLED | 布尔 | 滑动字幕，适合 oled 小屏 |
121+
122+
- **使能文本流式显示**
123+
124+
| 宏 | 类型 | 说明 |
125+
| ------------------------- | ---- | --------------------------------------------------------- |
126+
| ENABLE_GUI_STREAM_AI_TEXT | 布尔 | AI 回复的文本可进行流式的显示，而不是一下子出现文本内容。 |
127+
128+
- **选择OLED 屏类型**
129+
130+
该配置只有在选择 OLED UI 风格时才会出现。
131+
132+
| 宏 | 类型 | 说明 |
133+
| ------------------- | ---- | --------------------------- |
134+
| OLED_SSD1306_128X32 | 布尔 | oled 屏幕的尺寸大小为128*32 |
135+
| OLED_SSD1306_128X64 | 布尔 | oled 屏幕的尺寸大小为128*64 |

0 commit comments

Comments
 (0)