d0e73d6553
任务规划 README 顺序表:录波从「当前不排」移到独立行;动态波形验证让位给录波 数据面(段文件是现成的样本出口)。 登记簿:录波与 104 文件传输拆成两行,前者解除暂缓并指向新文档。 产品需求:立项未排行、录波文件存储行、文件传输行、录波采样率行补偏离登记指针。 UI:页面补齐规划第 26 叶与 UI补齐「不做」表改指故障录波立项,旧重开条件已满足。 短板评测记录链行、ADC前端注入验证流程的读数出口注、图形绘制流程与 tools/arch_diagram/README 的生成器清单同步。
42 lines
2.2 KiB
Markdown
42 lines
2.2 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 + 任务心跳位图(置位→判定→喂狗 + 时间轴) |
|
||
| `gen_adc_frontend_svg.py` | ADC 前端电路图 | 端子 → 串阻 → 转换节点 → 转换器引脚;含差分负端与 STM32 侧对照 |
|
||
| `gen_adc_code_scale_svg.py` | ADC 码值刻度图 | 「码」的直观定义:两片转换器的刻度尺对照(16 位双极性 vs 12 位单极性) |
|
||
| `gen_data_trust_ladder_svg.py` | 数据可信台阶图 | 采集数据可信度的五级台阶:现在踩在哪一级、下一级挡什么 |
|
||
| `gen_data_trust_dc_ac_svg.py` | ADC 直流标定与交流验证图 | 上排直流注入链、下排信号发生器正弦验证,中间列只有正弦能证的六件事 |
|
||
| `gen_wave_record_flow_svg.py` | 故障录波数据流图 | 录波段数据的四个所有者与四条「不许」:谁独占写、谁只能读、标志怎么过界 |
|
||
|
||
## 使用方式
|
||
|
||
```bash
|
||
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py
|
||
```
|
||
|
||
产物统一输出到 `docs/images/`;**脚本与生成的 `.svg` 一并提交**。
|
||
|
||
## ⚠️ 约定
|
||
|
||
- 颜色/字体遵循 `docs/架构设计/图形绘制流程.md` 的规范
|
||
- 中文用 SVG `<text>` 直接写(需注意字体族声明)
|
||
- 改图**改脚本再重跑**,不手改 SVG(保证可复现)
|
||
|
||
## 相关文档
|
||
|
||
- `docs/架构设计/图形绘制流程.md` — 配图规范、选型与检查清单
|