Skip to content

Commit 1fa1961

Browse files
authored
Update README.md
1 parent 1e4df57 commit 1fa1961

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
# SharedTopic
22

3-
No description provided
3+
SharedTopic 是一个基于 UART 的多 Topic 数据共享与解析服务端模块。
44

5-
## Required Hardware
6-
usart1
5+
SharedTopic is a UART-based multi-topic data sharing and server module.
76

7+
---
88

9+
## 硬件需求 / Required Hardware
10+
11+
- uart_name (如 usart1)
12+
- ramfs
13+
14+
## 构造参数 / Constructor Arguments
15+
16+
- uart_name: 串口设备名 / UART device name (e.g., "usart1")
17+
- task_stack_depth: 任务堆栈大小 / Task stack depth (e.g., 512)
18+
- buffer_size: 接收缓冲区字节数 / RX buffer size (e.g., 256)
19+
- topic_names: 需要注册并分发的 Topic 名称列表 / List of topic names to register (e.g., ["topic1", "topic2"])
20+
21+
## 依赖 / Depends
22+
23+
- 无(No dependencies)

0 commit comments

Comments
 (0)