Files
STM32F4-Base/tools/arch_diagram
wandering1 2b4c0e97c2 docs: ADC 注入流程 §4 补码值刻度图
§4 的「码」定义表只有文字与数字,台架现场容易把 TPAFE 的
152.59 µV 与 STM32 的 805.66 µV 混着用。新增一张刻度尺对照
图(docs/images/ADC码值刻度.svg),上下两把尺子分别标出
11430 码 ≈ 1.744 V 与 1000 码 ≈ 0.806 V,把"同一整数在两片
转换器上代表不同电压"变成可见的;正文补一句两把尺子差 5.3
倍、§9 每格必须写明所属通道。

生成器 tools/arch_diagram/gen_adc_code_scale_svg.py 沿用图形绘制
流程 §3.2 约定(纯标准库 / html.escape / newline="\n" /
ElementTree 自检 + 文字溢出预检);码制与 LSB 数据集中在
PANELS 常量,换芯片才重画。已登记到 tools/arch_diagram/README.md
与 docs/架构设计/图形绘制流程.md 的生成器表 + 变更记录。

目检用无头 Chrome 截图完成(cairosvg 未装,截图不入库)。
2026-10-27 17:25:51 +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 位单极性)

使用方式

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

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

⚠️ 约定

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

相关文档

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