Skip to content

Commit b6396e1

Browse files
committed
更新小智文档
1 parent d96c88c commit b6396e1

File tree

11 files changed

+103
-57
lines changed

11 files changed

+103
-57
lines changed

projects/Edgi_Talk_M55_XiaoZhi/README.md

Lines changed: 53 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,83 @@
1-
# XiaoZhi Example Project
1+
# XiaoZhi Sample Project
22

3-
[**中文**](./README_zh.md) | **English**
3+
**中文** | [**English**](./README.md)
44

55
## Introduction
66

7-
This example demonstrates the **basic functionality of XiaoZhi voice interaction device** on the **Edgi-Talk platform**, running **RT-Thread RTOS**.
8-
It allows users to quickly test Wi-Fi connection, key wake-up, and voice interaction, serving as a foundation for further application development.
7+
This sample project is based on the **Edgi-Talk platform**, demonstrating the **basic functions of the XiaoZhi voice interaction device**, running on the **RT-Thread real-time operating system**.
8+
With this project, users can quickly verify the device’s **WiFi connection**, **button wake-up**, and **voice interaction** capabilities, providing a fundamental reference for further application development.
99

1010
## Software Description
1111

12-
* Developed on **Edgi-Talk** platform.
13-
* Example features:
12+
* The project is developed based on the **Edgi-Talk** platform.
13+
* The sample includes the following functions:
1414

15-
* Wi-Fi connection and status display
16-
* Key wake-up and voice interaction
17-
* Device state management (standby, listening, sleep)
15+
* WiFi connection and status display
16+
* Button wake-up and voice interaction
17+
* Device state management (standby, listening, sleep, etc.)
1818

19-
## Usage
19+
# Usage
2020

21-
### WIFI Modification
21+
## 1. First-time setup (AP configuration)
2222

23-
1. In `main.c` at line 36, locate the following code:
23+
1. When the development board starts, it will enter **AP mode**.
24+
Connect your phone or computer to the device hotspot (password shown on the screen):
25+
![alt text](figures/4.png)
2426

25-
```c
26-
while (rt_wlan_connect("TEST", "88888888"));
27-
```
27+
2. After a successful connection, open a browser and enter **192.168.169.1** to access the configuration interface:
28+
29+
3. Click **Scan** to search for nearby Wi-Fi hotspots:
30+
![alt text](figures/6.png)
31+
32+
4. After the WiFi connection is successful, the following page will be displayed:
33+
![alt text](figures/7.png)
34+
35+
5. When the device screen shows **“Standby”**, it means voice interaction is ready:
36+
![alt text](figures/8.png)
37+
38+
> **Tip:** Press the **first user button** on the development board to enter voice input. After waiting 1–2 seconds, XiaoZhi will automatically respond.
39+
40+
# XiaoZhi Expression Meaning
41+
42+
## 1. Connecting (please wait)
43+
44+
![alt text](figures/9.png)
45+
46+
## 2. Monitoring (press the button to start talking)
47+
48+
![alt text](figures/10.png)
49+
50+
## 3. Listening (processing your speech)
2851

29-
2. Replace "TEST" with your WiFi name and "88888888" with the password, then recompile and flash.
30-
3. For detailed WiFi usage, refer to: [**WIFI**](../../Edgi-Talk_WIFI/Edgi_Talk_M55_WIFI/README.md)
52+
![alt text](figures/11.png)
3153

32-
### Build and Download
54+
## 4. Speaking (XiaoZhi is responding to you)
3355

34-
1. Open and compile the project.
35-
2. Connect the board USB to PC via **DAP**.
36-
3. Flash the compiled firmware to the device.
56+
![alt text](figures/12.png)
3757

38-
### Running Result
58+
## 5. Sleep mode (low power)
3959

40-
* After power-on, the device runs the example automatically.
60+
![alt text](figures/13.png)
4161

42-
* The screen displays the current status:
62+
> To exit sleep: press the button → wait for “Standby” → interaction becomes available.
4363
44-
* **Connecting** – connecting to Wi-Fi
45-
* **On standby** – idle mode
46-
* **Listening** – ready for voice interaction
47-
* **Sleeping** – low-power sleep mode
64+
### Running Effect
4865

49-
* Hold down the top button to speak and enter the Listening state for voice interaction.
66+
* After flashing, the device will start the sample automatically on power-up.
67+
* Press the top button once to enter the **Listening** state and interact with the device.
68+
![alt text](figures/3.png)
5069

5170
## Notes
5271

53-
* First-time setup requires backend binding via [XiaoZhi Official Website](https://xiaozhi.me/).
72+
* For first-time use, visit the [XiaoZhi official website](https://xiaozhi.me/) to complete backend binding.
5473
![alt text](figures/2.png)
55-
![alt text](figures/1.png)
74+
Press the user button to display the verification code on the screen.
5675

57-
* Ensure Wi-Fi SSID and password are correct and use **2.4 GHz** frequency.
76+
* Please ensure the WiFi SSID and password are correct and that you are using a **2.4GHz network**.
5877

59-
* Device must have internet access.
78+
* The device requires an Internet connection to function properly.
6079

61-
* To modify graphical configurations, use:
80+
* If you need to modify the **graphical configuration**, use the following tools:
6281

6382
```
6483
tools/device-configurator/device-configurator.exe

projects/Edgi_Talk_M55_XiaoZhi/README_zh.md

Lines changed: 50 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -16,36 +16,62 @@
1616
* 按键唤醒与语音交互
1717
* 设备状态管理(待机、监听、休眠等)
1818

19-
## 使用方法
20-
### WIFI修改
21-
1.`main.c` 36行中找到以下代码:
22-
```c
23-
while (rt_wlan_connect("TEST", "88888888"));
24-
```
25-
2. 将 "TEST" 改为你的 WiFi 名称,"88888888" 改为密码,重新编译并烧录。
26-
3. WIFI 详细使用参考 :[**WIFI**](../../Edgi-Talk_WIFI/Edgi_Talk_M55_WIFI/README_zh.md)
27-
### 编译与下载
19+
# 使用方法
20+
21+
## 1. 初次使用(AP 配网)
22+
23+
1. 开发板启动会进入 **AP 模式**
24+
在手机 / 电脑中连接设备的热点(密码见屏幕显示):
25+
![alt text](figures/4.png)
26+
27+
2. 连接成功后,在浏览器中输入 **192.168.169.1** 打开后台界面进行配网:
28+
29+
3. 点击 **Scan** 扫描附近的 Wi-Fi 热点:
30+
![alt text](figures/6.png)
31+
32+
4. Wi-Fi 连接成功后,将显示如下界面:
33+
![alt text](figures/7.png)
34+
35+
5. 当设备屏幕显示 **“待命中”** 时,表示可以正常进行语音对话:
36+
![alt text](figures/8.png)
37+
38+
> **提示**:按一下开发板上的 **第一个用户按键** 进入语音输入,等待 1–2 秒后,小智会自动回复。
39+
40+
# 小智表情含义说明
41+
42+
## 1. 联网中(请稍候)
43+
44+
![alt text](figures/9.png)
2845

29-
1. 打开工程并完成编译。
30-
2. 使用 **板载下载器 (DAP)** 将开发板的 USB 接口连接至 PC。
31-
3. 通过编程工具将生成的固件烧录至设备。
46+
## 2. 监听中(需要按按键开始对话)
47+
48+
![alt text](figures/10.png)
49+
50+
## 3. 聆听中(正在处理对话内容)
51+
52+
![alt text](figures/11.png)
53+
54+
## 4. 对话中(小智正在回复你)
55+
56+
![alt text](figures/12.png)
57+
58+
## 5. 休眠状态(低功耗)
59+
60+
![alt text](figures/13.png)
61+
62+
> 从休眠恢复:按一下按键 → 等待进入“待命中” → 可继续对话。 图片大小缩小一点
3263
3364
### 运行效果
3465

3566
* 烧录完成后,设备上电即可运行示例工程。
36-
* 屏幕会显示当前状态,包括:
37-
38-
* **Connecting**:正在连接 WiFi
39-
* **On standby**:待机中
40-
* **Listening**:监听中,可与设备对话
41-
* **Sleeping**:休眠状态
42-
* **按住**顶部按键对话,可进入 **Listening** 状态进行语音交互。
67+
* **按一下**顶部按键对话,可进入 **聆听中** 状态进行语音交互。
68+
![alt text](figures/3.png)
4369

44-
![alt text](figures/3.png)
4570
## 注意事项
71+
4672
* 第一次需要进入 [小智官网](https://xiaozhi.me/) 进行后台绑定
47-
![alt text](figures/2.png)
48-
![alt text](figures/1.png)
73+
![alt text](figures/2.png)
74+
按下用户按键屏幕显示验证码
4975
* 请确保 WiFi 名称与密码正确,并使用 **2.4GHz 频段**
5076
* 设备需在可访问互联网的环境下使用。
5177
* 如需修改工程的 **图形化配置**,请使用以下工具:
@@ -90,4 +116,5 @@ libs/TARGET_APP_KIT_PSE84_EVAL_EPC2/config/design.modus
90116
```
91117
RT-Thread Settings --> 硬件 --> select SOC Multi Core Mode --> Enable CM55 Core
92118
```
93-
![config](figures/config.png)
119+
120+
![config](figures/config.png)
2.59 MB
Loading
2.56 MB
Loading
2.75 MB
Loading
2.62 MB
Loading
14.4 KB
Loading
421 KB
Loading
158 KB
Loading
2.59 MB
Loading

0 commit comments

Comments
 (0)