为自建代码目录补齐 README,建立目录级导航体系
- 新增 26 份目录 README:App/(+log,task,util,protocol)、Drivers/BSP/(+8子系统)、 Src/、Inc/、scripts/、tools/(+6子工具)、test/、MDK-ARM/、simulator/(+sim,tests) - 每份含:定位、文件清单表、关键约束/陷阱、指向 docs 权威文档 - 第三方库与生成代码目录排除(CMSIS/HAL/Middlewares/Lib/SDL2) - docs/文档规范.md 新增 §1.1b 代码目录 README 约定;根 README 目录结构加入说明
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# tools/serial_tool/ — Python 串口助手
|
||||
|
||||
> **常驻 daemon + CLI** 架构的串口工具:后台持续收串口日志,CLI 按需查询/发送,
|
||||
> 避免反复开关串口导致日志丢失(台架与测试的主力观测工具)。
|
||||
|
||||
## 文件一览
|
||||
|
||||
| 文件/目录 | 作用 |
|
||||
|---|---|
|
||||
| `serial_tool.py` | 串口助手主程序(daemon 与 CLI 合一) |
|
||||
| `state/` | **运行时状态目录** |
|
||||
| `state/serial.log` | 串口原始日志(`stack_report.py -s` 的输入之一) |
|
||||
| `state/daemon.log` | daemon 自身运行日志 |
|
||||
| `state/meta.json` | daemon 元数据(端口、状态等) |
|
||||
|
||||
## 使用方式
|
||||
|
||||
```bash
|
||||
# 启动 daemon / 打开串口
|
||||
& '.venv\Scripts\python.exe' tools/serial_tool/serial_tool.py open COM6
|
||||
|
||||
# 查询日志 / 发送命令
|
||||
& '.venv\Scripts\python.exe' tools/serial_tool/serial_tool.py tail
|
||||
& '.venv\Scripts\python.exe' tools/serial_tool/serial_tool.py send "<命令>"
|
||||
|
||||
# 关闭
|
||||
& '.venv\Scripts\python.exe' tools/serial_tool/serial_tool.py close
|
||||
```
|
||||
|
||||
> 具体子命令以 `--help` 为准。
|
||||
|
||||
## ⚠️ 注意
|
||||
|
||||
- **单写者**:串口同一时刻只能被一个进程占用——别同时用本工具和其它串口程序
|
||||
- `state/serial.log` 是 `[STACK]` 运行时水位的来源,`scripts/stack_report.py -s` 直接读它
|
||||
- `state/` 是运行时数据,**不入库**
|
||||
|
||||
## 相关文档
|
||||
|
||||
- `docs/测试说明/串口助手使用指南.md` — 命令用法 / 工作流 / 排障
|
||||
- `docs/测试说明/串口助手设计说明.md` — 契约 / daemon 行为 / 陷阱
|
||||
Reference in New Issue
Block a user