37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# tools/arch_diagram/ — 架构图 SVG 生成器
|
||
|
||
> 用 Python 脚本**精确生成**架构类 SVG 图（分层、内存布局、协议帧、屏障等），
|
||
> 产物放 `docs/images/`。用于"必须精确布局"的图；拓扑图（流程/时序/状态机）改用 Mermaid。
|
||
|
||
## 脚本一览
|
||
|
||
| 脚本 | 产物 | 用途 |
|
||
|---|---|---|
|
||
| `gen_arch_svg.py` | 架构分层图 | 六层分层结构 |
|
||
| `gen_memory_svg.py` | 内存布局图 | RAM / Flash 分区 |
|
||
| `gen_storage_stack_svg.py` | 存储栈图 | FTL / dhara / FatFs 三层栈 |
|
||
| `gen_net_stack_svg.py` | 网络栈图 | BSD 网络栈分层 |
|
||
| `gen_barrier_svg.py` | 就绪屏障图 | Event Flags 屏障模型 |
|
||
| `gen_frame_svg.py` | 协议帧格式图 | RemoDispBus 帧结构 |
|
||
| `gen_cfg_arch_svg.py` | 配置引擎架构图 | 配置分层与持久化 |
|
||
| `gen_partition_svg.py` | 分区图 | 存储分区 |
|
||
| `gen_watchdog_svg.py` | 看门狗心跳模型图 | IWDG + 任务心跳位图（置位→判定→喂狗 + 时间轴） |
|
||
|
||
## 使用方式
|
||
|
||
```bash
|
||
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py
|
||
```
|
||
|
||
产物统一输出到 `docs/images/`；**脚本与生成的 `.svg` 一并提交**。
|
||
|
||
## ⚠️ 约定
|
||
|
||
- 颜色/字体遵循 `docs/架构设计/图形绘制流程.md` 的规范
|
||
- 中文用 SVG `<text>` 直接写（需注意字体族声明）
|
||
- 改图**改脚本再重跑**，不手改 SVG（保证可复现）
|
||
|
||
## 相关文档
|
||
|
||
- `docs/架构设计/图形绘制流程.md` — 配图规范、选型与检查清单
|