Skip to content

Commit facd0de

Browse files
authored
Update README.md
1 parent 95bc5ff commit facd0de

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

README.md

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

3-
No description provided
3+
SharedTopicClient 是一个多 Topic 数据共享与串口转发客户端模块。它用于通过 UART 将多个 Topic 的数据统一打包、发送,实现消息流的串口透明同步转发,适用于分布式系统的多主题数据同步或边缘数据采集。
44

5-
## Required Hardware
6-
uart_name
5+
SharedTopicClient is a client module for multi-topic data sharing and transparent UART forwarding. It subscribes to multiple Topics, packs their updates, and transmits them via UART, enabling efficient and reliable message synchronization over serial connections—ideal for distributed systems or edge data acquisition.
76

7+
---
88

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

0 commit comments

Comments
 (0)