Files
STM32F4-Base/tools/arch_diagram
wandering1 fea4cc7502 docs(架构): 项目架构总览全局更新——同步录波/SOE/屏板并订正串口归属
v1.1(2026-10-14)之后主干前进 59 笔,本总览积累系统性偏差,通读全文后
全局更新(含配图生成器数据同步):

- 串口三分定态:USART1=屏板链路 700 kbaud、UART4=RS-485(B2 未接线)、
  UART5=控制台日志 115200(console_log CON_UART=huart5 实证;
  旧文把 USART1 标成调试口是屏板批 0 迁移前的口径)
- 采集主线补齐:adc_cal 标定折算、meas 200ms 遥测快照(adcTask 唯一
  发布者,104 与 UI 共用同一份上游)、录波环三任务交接(adcTask 写入
  冻结 / defaultTask 游标落 /wave / uiTask 单通道回放 / FTP 取回)
- SOE 事件记录链路入图:protectTask 动作/复归边沿投递(纯 RAM 队列)
  → defaultTask 经 syslog_drain 尾部落 /log/soe.log(64B 定长)
- 配置从 [network] 单段改五段注册制(+ftp/adc_cal/run_par/comm),
  另有 /prot_set.bin(B7 原子写)
- UI 一节按注册表驱动重写:菜单树 61 行、16 个 #P 受保护叶、26 个
  #page 绑定、ui_data 三帧契约(写侧唯一填充 ui_data_feed)、录波
  两页、显存一份三出(屏板主出口/:7003 镜像/模拟器)
- §2.1 任务表按 freertos.c 现值逐行核对;protectTask 如实标注
  「未标定闭锁」现状(产品 required_mask 0x1F7)
- 配图:gen_arch_svg.py 顶部数据(层芯片/串口/删悬空图脚注)重跑,
  脚本与产物同一笔提交;check_generated_fresh.py 按「只减不增、
  还清即删整条」把本次还清的 项目架构总览.svg 基线下架(留出处注)

验证:check_doc_links --all --sections-strict 通过;scripts/ci_local.py
全绿;generated-fresh 单跑 rc=0(无 DIFF/NEW);SVG 无头渲染回读目检
两轮(首轮揪出悬空图脚注);md 无 BOM/CR/U+FFFD;#P 计数剔注释行复核。
2026-10-30 06:53:07 +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 — 配图规范、选型与检查清单