Skip to content

Commit 4a2394c

Browse files
author
dianjixz
committed
[update] clean
1 parent e37c35a commit 4a2394c

File tree

33 files changed

+86
-292
lines changed

33 files changed

+86
-292
lines changed

‎README.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Module-LLM
22

3-
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/4.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/10.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/15.webp"></div>
3+
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/4.webp" width="25%">
44

55
## Description
66

@@ -53,14 +53,11 @@ Plug and play with **M5 hosts**, Module LLM offers an easy-to-use AI interaction
5353
| Button | For entering download mode for firmware upgrade |
5454
| Upgrade Port | SD card / Type-C port |
5555
| Working Temp | 0-40°C |
56-
| Product Size | 54*54*13mm |
57-
| Packaging Size | 133*95*16mm |
56+
| Product Size | 54x54x13mm |
57+
| Packaging Size | 133x95x16mm |
5858
| Product Weight | 17.4g |
5959
| Packaging Weight | 32.0g |
6060

61-
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/11.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/5.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/12.webp"></div>
62-
63-
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/9.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/14.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/7.webp"></div>
6461

6562
## Related Links
6663

@@ -76,7 +73,7 @@ Plug and play with **M5 hosts**, Module LLM offers an easy-to-use AI interaction
7673

7774
>LLM Module Pin Switching| LLM Module has reserved soldering pads for pin switching. In cases of pin multiplexing conflicts, the PCB trace can be cut and reconnected to other sets of pins.
7875
79-
<img alt="module size" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/03.jpg" width="100%" />
76+
<img alt="module size" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/03.jpg" width="25%" />
8077

8178
> Taking `CoreS3` as an example, the first column (left green box) is the TX pin for serial communication, where users can choose one out of four options as needed (from top to bottom, the pins are G18, G7, G14, and G10). The default is set to IO18. To switch to a different pin, cut the connection on the solder pad (at the red line) — it’s recommended to use a blade for this — and then connect to one of the three remaining pins below. The second column (right green box) is for RX pin selection, and, as with the TX pin, it also allows a choice of one out of four options.
8279

‎README_zh.md‎

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Module-LLM
22

3-
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/4.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/10.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/15.webp"></div>
3+
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/4.webp" width="25%">
44

55
## 描述
66

@@ -66,16 +66,11 @@
6666
| 按键 | 用于升级固件进入下载模式 |
6767
| 升级接口 | SD卡/Type C口 |
6868
| 工作温度 | 0-40°C |
69-
| 产品尺寸 | 54*54*13mm |
70-
| 包装尺寸 | 133*95*16mm |
69+
| 产品尺寸 | 54x54x13mm |
70+
| 包装尺寸 | 133x95x16mm |
7171
| 产品重量 | 17.4g |
7272
| 包装重量 | 32.0g |
7373

74-
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/11.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/5.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/12.webp"></div>
75-
76-
<div class="product_pic"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/9.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/14.webp"><img class="pic" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/7.webp"></div>
77-
78-
7974
## 相关链接
8075

8176
- [AX630C](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/AX630C.pdf)
@@ -90,9 +85,9 @@
9085

9186
>LLM Module引脚切换| LLM Module预留了引脚切换焊盘, 一些出现引脚复用冲突的情况下, 可以通过切割PCB线路然后跳线连接至其他组引脚。
9287
93-
<img alt="module size" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/03.jpg" width="100%" />
88+
<img alt="module size" src="https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/products/module/Module%20LLM/03.jpg" width="25%" />
9489

95-
> 以`CoreS3`为例子，第一列（左绿色框）是串口通讯的TX引脚，用户根据需要四选一，（从上到下分别代表引脚G18 G7 G14 G10）,默认是IO18引脚，如需要切换其他引脚，切断焊盘连接线（红线处）（建议使用刀片切割），然后连接下面三个引脚之间的一个即可；第二列（右绿色框）是RX引脚切换，如上所述，也是四选一操作
90+
> 以`CoreS3`为例子，第一列（左绿色框）是串口通讯的TX引脚，用户根据需要四选一，（从上到下分别代表引脚G18 G7 G14 G10）,默认是IO18引脚，如需要切换其他引脚，切断焊盘连接线（红线处）（建议使用刀片切割），然后连接下面三个引脚之间的一个即可；第二列（右绿色框）是RX引脚切换，如上所述，也是四选一操作。
9691
9792

9893

‎doc/component_doc/StackFlow_en.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,7 +406,7 @@ int main(int argc, char *argv[]) {
406406
```
407407
408408
## StackFlowUtil
409-
Provides a convenient API:
409+
Provide some simple and easy-to-use functions:
410410
- sample_json_str_get: Simple function to read key values inside a JSON, used to quickly read JSON keys without parsing the JSON object.
411411
- sample_get_work_id_num: Read the numeric index from the work_id string.
412412
- sample_get_work_id_name: Read the unit name from the work_id string.

‎doc/component_doc/StackFlow_zh.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -406,13 +406,13 @@ int main(int argc, char *argv[]) {
406406
```
407407
408408
## StackFlowUtil
409-
提供一个简便使用的 API：
409+
提供一些简便使用的函数：
410410
- sample_json_str_get: 简单的读取 json 内的键值函数，用于在不解析 json 对象的情况下快速读取 json 键值。
411411
- sample_get_work_id_num： 从 work_id 字符串中读取数字索引。
412412
- sample_get_work_id_name： 从 work_id 字符串中读取单元名。
413413
- sample_get_work_id： 用于合成 work_id 字符串。
414414
- sample_escapeString：简单的对字符串中的转义字符进行编码。
415415
- sample_unescapeString：简单的对字符串中的转义字符串进行解码。
416416
- decode_stream：解析流式数据流。
417-
- decode_base64：解码 base64
418-
- encode_base64：编码 base64
417+
- decode_base64：解码 base64 。
418+
- encode_base64：编码 base64 。

‎doc/projects_llm_framework_doc/llm_asr_en.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ Example:
114114
```
115115

116116
## unlink
117-
Unlink
117+
Unlink.
118118

119119
Send JSON:
120120
```json
@@ -203,7 +203,7 @@ Response JSON:
203203
error::code of 0 indicates successful execution.
204204

205205
## exit
206-
Exit the unit's work.
206+
Exit the unit.
207207

208208
Send JSON:
209209
```json
@@ -233,7 +233,7 @@ error::code of 0 indicates successful execution.
233233

234234
## Task Information
235235

236-
Get task list:
236+
Get task list.
237237

238238
Send JSON:
239239
```json
@@ -261,7 +261,7 @@ Response JSON:
261261
}
262262
```
263263

264-
Get task runtime parameters:
264+
Get task runtime parameters.
265265

266266
Send JSON:
267267
```json

‎doc/projects_llm_framework_doc/llm_asr_zh.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
语音转文字单元，用于提供语音转文字服务，可选择中英文模型，用于提供中英文语音转文字服务。
33

44
## setup
5-
配置单元工作.
5+
配置单元工作。
66

77
发送 json：
88
```json
@@ -36,6 +36,7 @@
3636
- endpoint_config.rule1.min_trailing_silence：唤醒后 2.4 s 后语音产生断点。
3737
- endpoint_config.rule2.min_trailing_silence：识别语音后停顿 1.2 s 后语音产生断点。
3838
- endpoint_config.rule3.min_trailing_silence：最长能够识别 30.1 s 后语音产生断点。
39+
3940
响应 json：
4041

4142
```json
@@ -88,7 +89,7 @@ error::code 为 0 表示执行成功。
8889

8990
将 asr 和 kws 单元链接起来，当 kws 发出唤醒数据时，asr 单元开始识别用户的语音，识别完成后自动暂停，直到下一次的唤醒。
9091

91-
> **link时必须保证 kws 此时已经配置好进入工作状态。link 也可以在 setup 阶段进行。**
92+
> **link 时必须保证 kws 此时已经配置好进入工作状态。link 也可以在 setup 阶段进行。**
9293
9394
示例:
9495

@@ -114,7 +115,7 @@ error::code 为 0 表示执行成功。
114115
```
115116

116117
## unlink
117-
取消链接
118+
取消链接。
118119

119120
发送 json：
120121
```json
@@ -175,7 +176,7 @@ error::code 为 0 表示执行成功。
175176
error::code 为 0 表示执行成功。
176177

177178
## work
178-
恢复单元工作.
179+
恢复单元工作。
179180

180181
发送 json：
181182
```json
@@ -204,7 +205,7 @@ error::code 为 0 表示执行成功。
204205
error::code 为 0 表示执行成功。
205206

206207
## exit
207-
恢复单元工作.
208+
单元退出。
208209

209210
发送 json：
210211
```json
@@ -234,7 +235,7 @@ error::code 为 0 表示执行成功。
234235

235236
## taskinfo
236237

237-
获取任务列表：
238+
获取任务列表。
238239

239240
发送 json：
240241
```json
@@ -263,7 +264,7 @@ error::code 为 0 表示执行成功。
263264
}
264265
```
265266

266-
获取任务运行参数：
267+
获取任务运行参数。
267268

268269
```json
269270
{

‎doc/projects_llm_framework_doc/llm_kws_en.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Response JSON:
107107
error::code of 0 indicates successful execution.
108108

109109
## exit
110-
Resume the unit's work.
110+
Exit the unit.
111111

112112
Send JSON:
113113
```json
@@ -137,7 +137,7 @@ error::code of 0 indicates successful execution.
137137

138138
## Task Information
139139

140-
Get task list:
140+
Get task list.
141141

142142
Send JSON:
143143
```json
@@ -165,7 +165,7 @@ Response JSON:
165165
}
166166
```
167167

168-
Get task runtime parameters:
168+
Get task runtime parameters.
169169

170170
Send JSON:
171171
```json

‎doc/projects_llm_framework_doc/llm_kws_zh.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
语音唤醒单元，用于提供语音唤醒服务，可选择中英文模型，用于提供中英文唤醒服务。
33

44
## setup
5-
配置单元工作.
5+
配置单元工作。
66

77
发送 json：
88
```json
@@ -50,7 +50,7 @@
5050
- work_id：返回成功创建的 work_id 单元。
5151

5252
## pause
53-
暂停单元工作.
53+
暂停单元工作。
5454

5555
发送 json：
5656
```json
@@ -80,7 +80,7 @@
8080
error::code 为 0 表示执行成功。
8181

8282
## work
83-
恢复单元工作.
83+
恢复单元工作。
8484

8585
发送 json：
8686
```json
@@ -110,7 +110,7 @@ error::code 为 0 表示执行成功。
110110
error::code 为 0 表示执行成功。
111111

112112
## exit
113-
恢复单元工作.
113+
单元退出。
114114

115115
发送 json：
116116
```json
@@ -141,7 +141,7 @@ error::code 为 0 表示执行成功。
141141

142142
## taskinfo
143143

144-
获取任务列表：
144+
获取任务列表。
145145

146146
发送 json：
147147
```json
@@ -170,7 +170,7 @@ error::code 为 0 表示执行成功。
170170
}
171171
```
172172

173-
获取任务运行参数：
173+
获取任务运行参数。
174174

175175
```json
176176
{

‎doc/projects_llm_framework_doc/llm_llm_en.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Example:
105105
```
106106

107107
## unlink
108-
Unlink
108+
Unlink.
109109

110110
Send json:
111111
```json
@@ -224,7 +224,7 @@ error::code of 0 indicates successful execution.
224224

225225
## Task Information
226226

227-
Get task list:
227+
Get task list.
228228

229229
Send JSON:
230230
```json
@@ -250,7 +250,7 @@ Response JSON:
250250
}
251251
```
252252

253-
Get task runtime parameters:
253+
Get task runtime parameters.
254254

255255
Send JSON:
256256
```json

‎doc/projects_llm_framework_doc/llm_llm_zh.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
大模型单元，用于提供大模型推理服务。
33

44
## setup
5-
配置单元工作.
5+
配置单元工作。
66

77
发送 json：
88
```json
@@ -30,6 +30,7 @@
3030
- enoutput：是否起用用户结果输出。
3131
- max_token_len：最大输出 token,该值的最大值受到模型的最大限制。
3232
- prompt：模型的提示词。
33+
3334
响应 json：
3435

3536
```json
@@ -82,7 +83,7 @@ error::code 为 0 表示执行成功。
8283

8384
将 llm 和 kws 单元链接起来，当 kws 发出唤醒数据时，llm 单元停止上次未完成的推理，用于重复唤醒功能。
8485

85-
> **link时必须保证 kws 此时已经配置好进入工作状态。link 也可以在 setup 阶段进行。**
86+
> **link 时必须保证 kws 此时已经配置好进入工作状态。link 也可以在 setup 阶段进行。**
8687
8788
示例:
8889

@@ -103,7 +104,7 @@ error::code 为 0 表示执行成功。
103104
```
104105

105106
## unlink
106-
取消链接
107+
取消链接。
107108

108109
发送 json：
109110
```json
@@ -135,7 +136,7 @@ error::code 为 0 表示执行成功。
135136
error::code 为 0 表示执行成功。
136137

137138
## pause
138-
暂停单元工作.
139+
暂停单元工作。
139140

140141
发送 json：
141142
```json
@@ -165,7 +166,7 @@ error::code 为 0 表示执行成功。
165166
error::code 为 0 表示执行成功。
166167

167168
## work
168-
恢复单元工作.
169+
恢复单元工作。
169170

170171
发送 json：
171172
```json
@@ -195,7 +196,7 @@ error::code 为 0 表示执行成功。
195196
error::code 为 0 表示执行成功。
196197

197198
## exit
198-
恢复单元工作.
199+
恢复单元工作。
199200

200201
发送 json：
201202
```json
@@ -226,7 +227,7 @@ error::code 为 0 表示执行成功。
226227

227228
## taskinfo
228229

229-
获取任务列表：
230+
获取任务列表。
230231

231232
发送 json：
232233
```json
@@ -253,7 +254,7 @@ error::code 为 0 表示执行成功。
253254
}
254255
```
255256

256-
获取任务运行参数：
257+
获取任务运行参数。
257258

258259
```json
259260
{

0 commit comments

Comments
 (0)