Files
STM32F4-Base/tools/arch_diagram
wandering1 513becd61d docs(algo): 新增 adc_health 单文件深设计与三张配图
- 新建 docs/算法/采样有效性校验设计说明.md(15 章):判据推导
  (100 ms 门限的三条独立依据)、电平/锁存/事件三种位语义与
  位号对齐的收益代价、闭锁与 IWDG 兜底责任矩阵、观测盲区、
  主机侧验证分工(11 组 TC / 31 断言映射)、现场判读手册、
  自测问题与改前必读清单
- 配图走 draw-diagram 生成器路线(脚本 + 产物一并提交):
  tools/arch_diagram/gen_adc_health_flow_svg.py 等三个脚本 →
  docs/images/ 下三张 SVG;文内另有 2 张 Mermaid(判定主干
  flowchart、静默位生命周期 stateDiagram-v2,沿用仓内既有方言)
- 登记与指针:docs/README.md §5.2 加一行 + 变更记录;
  docs/算法/采集与算法层设计说明.md §4 与 §13 加深读指针;
  本文只写「为什么」,接口表仍由该文档属主,不重复
- 读码确认并如实登记三项(本提交不改代码,待裁):
  1) adc_task_init() 全库无调用点,adc_health_init() 因此不在
     产品路径,判定正确只依赖 .bss 清零 + 首拍建基线
  2) tgap 计帧点数(d-1 加权),adc1_gap 计次数——两侧单位
     不对称,心跳里不可直接对比
  3) TIM3 停摆时判定层随消费者一起停,最坏约 800 ms + 2498 ms
     窗口内 protectTask 仍以旧相量判据(细节见 §10 / §14)
- 门禁自查:pre-commit 目标集全绿(doc-links / id-check /
  空白 / EOF / 大文件);主机单测 adc_health 31/31 复跑通过;
  9 个新增或改动文件 BOM=无、CR=0、U+FFFD=0
2026-10-22 00:43:31 +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 — 配图规范、选型与检查清单