Files
STM32F4-Base/tools/arch_diagram
wandering1 01b9a90f45 docs(net): 同步 docs/网络 之外残留旧函数名(测试说明 + 生成图)
docs/网络/ 主体已在 1a17d73 更新。自查发现两处「现状性」引用
仍用旧函数名(历史记录类保持原样,不改):

- docs/测试说明/链路延迟测试说明.md §8 D10 排障行:
  net_relisten_try/retry_tick → net_listener_try/retry_tick
- tools/arch_diagram/gen_net_pending_svg.py 主循环标签
  net_relisten_retry_tick() → net_listener_retry_tick(),并重跑
  生成 docs/images/Net层阻塞模型.svg(该图被 Net层阻塞模型架构设计.md 内嵌)
2026-10-12 19:18:38 +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 + 任务心跳位图(置位→判定→喂狗 + 时间轴)

使用方式

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

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

⚠️ 约定

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

相关文档

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