c377fc8c15
- 采集与算法层设计说明第 5 节由单段说明拆成 5.1~5.5:为什么需要这一层 (三个缺口 + 两个被否决的替代方案)、设计思想(五条不变量)、环内布局 与 start 推导、API 契约、要点与禁令。 - 新增两张配图(生成器 + 产物同批提交): 采样环缓冲_为什么需要.svg —— 上游 1 kHz 覆盖写只交最新一帧 vs 下游 20 点滑窗,缺口 19 点,以及三个消费者必须同源; 采样环缓冲_环形布局.svg —— 40 格环里哪 20 格是本窗、写指针指「下一格」、 回绕方向与三条设计不变量。 - 5.5 补一条「读者与写者必须同任务」,与故障录波设计说明的取窗竞态口径一致。 - 门禁:doc-links --sections-strict 通过(28 处章节引用全部可判定); id-check 新增行无未登记编号;generated-fresh 21 个生成器 16 一致、0 新漂移。
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_sample_ring_why_svg.py |
采样环缓冲_为什么需要 | 上游 1 kHz 覆盖写只交最新一帧 vs 下游要 20 点滑窗:缺口 19 点与三个消费者 |
gen_sample_ring_layout_svg.py |
采样环缓冲_环形布局 | 40 格环里哪 20 格是本窗、写指针指「下一格」、回绕与三条设计不变量 |
使用方式
& '.venv\Scripts\python.exe' tools/arch_diagram/gen_memory_svg.py
产物统一输出到 docs/images/;脚本与生成的 .svg 一并提交。
⚠️ 约定
- 颜色/字体遵循
docs/架构设计/图形绘制流程.md的规范 - 中文用 SVG
<text>直接写(需注意字体族声明) - 改图改脚本再重跑,不手改 SVG(保证可复现)
相关文档
docs/架构设计/图形绘制流程.md— 配图规范、选型与检查清单