wandering1
e71d623e60
- 新增配图 采样环缓冲_窗首下标.svg：左侧 40 格圆环走一遍 head = 5、n = 20 的「往回退 19 步」（跨过 0 与 39），右侧把直接减 / 16 位回绕后再取模 / 先加 DEPTH 三种写法的结果并列，只有第三种落在 25。 - 与 5.2 的环形布局图分工：那张讲「窗在哪几格」，这张讲「下标怎么算出来」， 不重复同一张图的语义。 - 生成器 gen_sample_ring_start_svg.py 顺带把 OVERFLOW 明细改到末尾统一打印 （原先只在开头打，折行类告警只报计数、看不出是哪一条）。 - 门禁：doc-links --sections-strict 通过；id-check 新增行无未登记编号； generated-fresh 22 个生成器 17 一致、0 新漂移；产物连跑两次 sha1 不变。
45 lines
2.7 KiB
Markdown
45 lines
2.7 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` | 故障录波数据流图 | 录波段数据的四个所有者与四条「不许」：谁独占写、谁只能读、标志怎么过界 |
|
||
| `gen_sample_ring_why_svg.py` | 采样环缓冲_为什么需要 | 上游 1 kHz 覆盖写只交最新一帧 vs 下游要 20 点滑窗：缺口 19 点与三个消费者 |
|
||
| `gen_sample_ring_layout_svg.py` | 采样环缓冲_环形布局 | 40 格环里哪 20 格是本窗、写指针指「下一格」、回绕与三条设计不变量 |
|
||
| `gen_sample_ring_start_svg.py` | 采样环缓冲_窗首下标 | 窗首 = head − n 的圆周走法，与「直接减 / 16 位回绕 / 先加 DEPTH」三种写法对照 |
|
||
|
||
## 使用方式
|
||
|
||
```bash
|
||
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py
|
||
```
|
||
|
||
产物统一输出到 `docs/images/`；**脚本与生成的 `.svg` 一并提交**。
|
||
|
||
## ⚠️ 约定
|
||
|
||
- 颜色/字体遵循 `docs/架构设计/图形绘制流程.md` 的规范
|
||
- 中文用 SVG `<text>` 直接写（需注意字体族声明）
|
||
- 改图**改脚本再重跑**，不手改 SVG（保证可复现）
|
||
|
||
## 相关文档
|
||
|
||
- `docs/架构设计/图形绘制流程.md` — 配图规范、选型与检查清单
|