Files
STM32F4-Base/tools/arch_diagram
wandering1 b49e226815 docs(配图): 菜单树总览改由生成器画,登记钩子扫不到的图
- 新增 tools/arch_diagram/gen_menu_tree_svg.py → docs/images/菜单树总览
  .svg:43 节点 = 9 菜单 + 34 叶,30 已绑页 / 4 未绑 / 16 叶带密码门,
  最深 4 级;读数由脚本现算,不在文档里另抄一份
- 生成器内嵌 NODE_SRC(= ui_menu_tree.txt 的 43 行节点):在仓库里跑会
  与真值逐行互验、不一致 exit 1;generated-fresh 在临时目录重跑读不到
  真值 → 用内嵌表,输出逐字节一致(实测临时目录产物同 sha256)
- 产品需求 §8.2 原先挂的是级联框显示几何图(画的是示例级联,从来不含
  整棵树的节点),换成这张树图,并删掉「该图仍是 42 节点时代所画」的
  补丁注
- 图形绘制流程新增 §2.1:登记 generated-fresh 扫不到的四张图 —— 两张
  tools/refgraph 产物(引用关系图 / _模块,不在 gen_*.py 命名面里)+
  两张手画稿(级联框总览、级联框几何计算)。钩子只扫
  tools/arch_diagram/gen_*.py,这些图改了不会有人报警;再多一张先说清
  为什么不能用生成器
- arch_diagram README 脚本一览加行
2026-10-30 00:25:03 +08:00
..

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_menu_tree_svg.py 菜单树总览图 43 节点的层级 / 绑页 / 密码门鸟瞰;内嵌 ui_menu_tree.txt 的节点行并与真值互验,防图与树漂移
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」三种写法对照

使用方式

& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py

产物统一输出到 docs/images/;脚本与生成的 .svg 一并提交。

⚠️ 约定

  • 颜色/字体遵循 docs/架构设计/图形绘制流程.md 的规范
  • 中文用 SVG <text> 直接写(需注意字体族声明)
  • 改图改脚本再重跑,不手改 SVG(保证可复现)

相关文档

  • docs/架构设计/图形绘制流程.md — 配图规范、选型与检查清单