Skip to content

Commit f5dc3b2

Browse files
committed
update readme
1 parent 2590f60 commit f5dc3b2

5 files changed

Lines changed: 105 additions & 3 deletions

File tree

README.en.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,36 @@ The table below shows the most representative UI views in a compact GitHub-frien
7474
| TCP | **Host/Port** remembered locally; **last 3** successful connects as quick chips. |
7575
| Link state | **WebSocket** plus periodic **GET `/api/status`** keep UI in sync so a broken WS alone does not show “connected” incorrectly. |
7676

77+
## Roadmap
78+
79+
The currently implemented protocols in this repository are still **Serial (COM) / TCP / UDP**. The roadmap below highlights the likely next steps so readers can quickly see what already exists and what may be added later.
80+
81+
### Supported today
82+
83+
- **Serial (COM)**: local serial connection, logging, sending, and parsing
84+
- **TCP client**: device bring-up, message sending, logs, and live charts
85+
- **UDP**: send, optional local listen, logging, and parsed data flow
86+
- **Unified UI experience**: logs, charts, send history, HEX, line endings, checksum options, and multilingual UI
87+
88+
### Planned
89+
90+
- **MQTT**: connect to a broker, publish/subscribe to topics, inspect message logs, and feed numeric payloads into live charts
91+
- **Bluetooth (BLE first)**: likely starting with **Bluetooth Low Energy (BLE)**, with classic Bluetooth serial-style scenarios considered later
92+
- **More protocol adapters**: extending beyond the current TCP / UDP set with transports better suited to device messaging workflows
93+
- **Further transport unification**: reusing the same logging, sending, history, checksum, parsing, and charting experience across protocols
94+
95+
### Ideas
96+
97+
- **Protocol plug-in model**: a cleaner extension point for adding future transports
98+
- **More chart types**: exploring bar charts, area charts, gauges, status cards, and other visualizations beyond the current line chart for different data patterns
99+
- **Extended chart capabilities**: more flexible series mapping, chart configuration, field grouping, and multi-panel layouts for different protocols or data models
100+
- **Custom JavaScript parsers**: allowing user-defined JavaScript scripts to parse device-specific protocols and turn raw payloads into structured fields, log text, or chart data
101+
- **Script-based protocol adapters**: defining a stable input/output contract for user scripts so new device protocols can be integrated quickly without changing the built-in backend parser every time
102+
- **More device-debugging workflows**: such as richer session panels, message templates, and protocol presets
103+
- **Cross-protocol consistency**: keeping Serial, TCP, UDP, MQTT, Bluetooth, and future transports as similar as practical in daily use
104+
105+
> Note: items under `Planned` and `Ideas` are roadmap directions, not currently implemented features.
106+
77107
## Tech stack
78108

79109
- Python **3.10+** (3.11+ recommended)

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,36 @@
8080
| TCP | **Host/Port** 本地记忆;**最近 3 条**成功连接以胶囊一键填入 |
8181
| 链路状态 | WebSocket 与定时 **GET `/api/status`** 双通道对齐连接态,避免仅断 WS 时 UI 仍显示已连 |
8282

83+
## 开发路线图
84+
85+
当前仓库的已实现能力仍以 **Serial(COM)/ TCP / UDP** 为准。下面的路线图用于说明后续演进方向,便于了解项目接下来可能支持的协议与能力。
86+
87+
### 已支持
88+
89+
- **Serial(COM)**:本地串口连接、日志查看、发送与解析
90+
- **TCP Client**:设备联调、日志查看、发送与实时图表
91+
- **UDP**:发送、可选本地监听、日志与数据解析
92+
- **统一前端体验**:日志、曲线、发送历史、HEX、行尾、校验算法、多语言界面
93+
94+
### 计划中
95+
96+
- **MQTT**:连接 Broker、发布 / 订阅 Topic、查看消息日志,并将数值型消息接入实时曲线
97+
- **蓝牙(BLE 优先)**:优先考虑 **Bluetooth Low Energy(BLE)**,后续再评估经典蓝牙串口类场景
98+
- **更多协议适配层**:在现有 TCP / UDP 之外扩展更适合设备消息通信的连接方式
99+
- **统一连接抽象持续完善**:让更多协议复用相同的日志、发送、历史、校验、解析与图表能力
100+
101+
### 想法池
102+
103+
- **协议插件化**:为未来新增协议保留更清晰的扩展入口
104+
- **更多图表类型**:除当前折线图外,探索柱状图、面积图、仪表盘、状态卡片等更适合不同数据场景的可视化方式
105+
- **图表能力扩展**:为不同协议或数据模型提供更灵活的系列映射、图表配置、字段分组与多面板展示能力
106+
- **自定义 JS 解析脚本**:允许通过自定义 JavaScript 脚本解析不同设备协议,将原始报文转换为结构化字段、日志文本或图表数据
107+
- **脚本化协议适配**:为用户脚本约定统一输入输出接口,使不同设备协议可以通过脚本快速接入,而不必每次都改动后端内置解析器
108+
- **更多设备调试工作流**:例如更细粒度的会话面板、消息模板、协议预设
109+
- **跨协议一致性增强**:尽量让 Serial、TCP、UDP、MQTT、蓝牙等协议共享相似的操作体验
110+
111+
> 说明:`计划中``想法池` 仅代表当前 roadmap,不代表这些功能已经在仓库中实现。
112+
83113

84114
## 技术栈
85115

static/i18n.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@
6161
footerAppMetaAria: "版本与作者信息",
6262
footerVersionLabel: "版本",
6363
footerAuthorAbout: "作者:Allen Liao · SerialNet Debug Studio",
64+
footerRepoLink: "GitHub",
65+
footerRepoLinkTitle: "在 GitHub 打开 SerialNet Debug Studio 仓库",
6466
lblMode: "通信方式",
6567
lblUiLang: "界面语言",
6668
uiLangAria: "界面语言",
@@ -179,6 +181,8 @@
179181
footerAppMetaAria: "Version and author",
180182
footerVersionLabel: "Version",
181183
footerAuthorAbout: "Author: Allen Liao · SerialNet Debug Studio",
184+
footerRepoLink: "GitHub",
185+
footerRepoLinkTitle: "Open SerialNet Debug Studio on GitHub",
182186
lblMode: "Connection",
183187
lblUiLang: "Language",
184188
uiLangAria: "Interface language",
@@ -297,6 +301,8 @@
297301
footerAppMetaAria: "バージョンと作者",
298302
footerVersionLabel: "バージョン",
299303
footerAuthorAbout: "作者:Allen Liao · SerialNet Debug Studio",
304+
footerRepoLink: "GitHub",
305+
footerRepoLinkTitle: "GitHub で SerialNet Debug Studio のリポジトリを開く",
300306
lblMode: "接続方式",
301307
lblUiLang: "表示言語",
302308
uiLangAria: "表示言語",
@@ -415,6 +421,8 @@
415421
footerAppMetaAria: "버전 및 작성자",
416422
footerVersionLabel: "버전",
417423
footerAuthorAbout: "작성자: Allen Liao · SerialNet Debug Studio",
424+
footerRepoLink: "GitHub",
425+
footerRepoLinkTitle: "GitHub에서 SerialNet Debug Studio 저장소 열기",
418426
lblMode: "연결 방식",
419427
lblUiLang: "언어",
420428
uiLangAria: "인터페이스 언어",
@@ -533,6 +541,8 @@
533541
footerAppMetaAria: "Version und Autor",
534542
footerVersionLabel: "Version",
535543
footerAuthorAbout: "Autor: Allen Liao · SerialNet Debug Studio",
544+
footerRepoLink: "GitHub",
545+
footerRepoLinkTitle: "SerialNet Debug Studio auf GitHub öffnen",
536546
lblMode: "Verbindung",
537547
lblUiLang: "Sprache",
538548
uiLangAria: "Oberflächensprache",
@@ -651,6 +661,8 @@
651661
footerAppMetaAria: "Version et auteur",
652662
footerVersionLabel: "Version",
653663
footerAuthorAbout: "Auteur : Allen Liao · SerialNet Debug Studio",
664+
footerRepoLink: "GitHub",
665+
footerRepoLinkTitle: "Ouvrir SerialNet Debug Studio sur GitHub",
654666
lblMode: "Connexion",
655667
lblUiLang: "Langue",
656668
uiLangAria: "Langue de l’interface",
@@ -769,6 +781,8 @@
769781
footerAppMetaAria: "Versión y autor",
770782
footerVersionLabel: "Versión",
771783
footerAuthorAbout: "Autor: Allen Liao · SerialNet Debug Studio",
784+
footerRepoLink: "GitHub",
785+
footerRepoLinkTitle: "Abrir SerialNet Debug Studio en GitHub",
772786
lblMode: "Conexión",
773787
lblUiLang: "Idioma",
774788
uiLangAria: "Idioma de la interfaz",
@@ -887,6 +901,8 @@
887901
footerAppMetaAria: "Versão e autor",
888902
footerVersionLabel: "Versão",
889903
footerAuthorAbout: "Autor: Allen Liao · SerialNet Debug Studio",
904+
footerRepoLink: "GitHub",
905+
footerRepoLinkTitle: "Abrir SerialNet Debug Studio no GitHub",
890906
lblMode: "Conexão",
891907
lblUiLang: "Idioma",
892908
uiLangAria: "Idioma da interface",

static/index.html

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<meta charset="UTF-8" />
1010
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
1111
<title></title>
12-
<link rel="stylesheet" href="/style.css?v=23" />
12+
<link rel="stylesheet" href="/style.css?v=24" />
1313
<script src="https://cdn.jsdelivr.net/npm/echarts@5.5.0/dist/echarts.min.js"></script>
1414
</head>
1515
<body>
@@ -20,7 +20,18 @@
2020
<span id="appVersion" class="app-version-num"></span>
2121
</span>
2222
<span class="app-meta-sep" aria-hidden="true">·</span>
23-
<span class="app-meta-author" data-i18n="footerAuthorAbout"></span>
23+
<span class="app-meta-author">
24+
<span data-i18n="footerAuthorAbout"></span>
25+
<span class="app-meta-sep" aria-hidden="true">·</span>
26+
<a
27+
class="app-meta-repo-link"
28+
href="https://github.com/xiayus/SerialNet-Debug-Studio"
29+
target="_blank"
30+
rel="noopener noreferrer"
31+
data-i18n="footerRepoLink"
32+
data-i18n-title="footerRepoLinkTitle"
33+
>GitHub</a>
34+
</span>
2435
</div>
2536
</aside>
2637

@@ -172,7 +183,7 @@ <h2 data-i18n="panelChart"></h2>
172183
</div>
173184
</footer>
174185

175-
<script src="/i18n.js?v=8"></script>
186+
<script src="/i18n.js?v=9"></script>
176187
<script src="/app.js?v=32"></script>
177188
</body>
178189
</html>

static/style.css

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,24 @@ body {
159159
}
160160

161161
.app-meta-author {
162+
display: inline-flex;
163+
align-items: baseline;
164+
flex-wrap: wrap;
165+
gap: 0 4px;
166+
justify-content: center;
162167
text-align: center;
163168
}
164169

170+
.app-meta-repo-link {
171+
color: var(--accent);
172+
text-decoration: none;
173+
font-weight: 500;
174+
}
175+
176+
.app-meta-repo-link:hover {
177+
text-decoration: underline;
178+
}
179+
165180
.cfg-block {
166181
margin-top: 8px;
167182
padding-top: 8px;

0 commit comments

Comments
 (0)