Files
STM32F4-Base/App/algo
wandering1 64d8b052b1 docs(algo): App/algo/README 缩成目录索引,详细设计迁入 docs/算法
拆分层级
- 新建 docs/算法/采集与算法层设计说明.md(413 行、13 节)承接机制、契约、
  判据与设计理由:定位与边界 / 数据流与初始化落点 / adc_input / adc_health /
  sample_ring / phasor / freq(7.1 为什么自适应窗、7.2 判据 J1~J6)/
  prot_set / prot_elm / 关键约定与禁令 / 资源足迹 / 验证与判读 / 相关文档
- App/algo/README.md 360 -> 128 行:只留文件清单、依赖、逐文件"改代码必须
  知道"的红线、构建与测试入口、新增模块动作;深挖改成逐条指针
- README 保留 §3.1-§3.7 原编号,既有"§3.7"引用不失效

索引与引用同步
- 索引:docs/README.md §5.2 新增行;项目架构总览主题表拆成"设计与判据 /
  目录索引"两行;AGENTS.md 与 App/README.md 指向(后者原文还写着 L1/L2)
- 按内容重指(编号仍在但内容已搬走,只核编号会静默指错):App/algo/freq.h、
  test/host/freq/freq_test.c、run_unit_test.py、继电保护规划 L2-4 行、
  pre-commit使用说明 J4 行 -> 指向设计说明
- ADC采样节拍设计说明的两处指向同步改到新文档

修 README 内过时事实
- 挂载写"八个 .c",实际 uvprojx 内 7 个
- SIM_EXEMPT 写"prot_set / freq 才登记豁免",实际七个全在表内
- freq-unit-test 标"待登记",实际已在 .pre-commit-config.yaml
- 定值项数一处 31->40、一处 32->40;blob 144->176 B 证明是 32->40
- 用例与判据数字不再三处复制:属主是 test/host/<模块>/ 与 docs/测试说明/

门禁
- doc-links --all 无新增问题;--sections-strict 覆盖 10 篇文档通过
- id-check 可判定 82.65%(基线 82.6,容差 0.1);TC 双向追溯差异 124 处不变
- registration-check PASS(1 条已知 WARN);freq 单测 46/46;@build 0 错 0 警
- 全部改动文件无 BOM、无 CR、U+FFFD = 0
2026-10-21 11:39:53 +08:00
..

App/algo/ — 采集与算法层(L1 / L2 / L3)

本目录的索引:文件清单、依赖、逐文件的"改代码必须知道"、构建与测试入口、新增模块动作。 详细设计——机制、契约、判据、为什么这样设计 → docs/算法/采集与算法层设计说明.md(本文不复制其内容)。 分层归属与功能项状态 → docs/算法/继电保护功能复现规划.md §2.1; 通道映射唯一权威 → docs/硬件平台/ADC通道映射说明.md;采样节拍 → docs/子系统设计/ADC采样节拍设计说明.md。

1. 文件清单(一眼版)

文件 层 作用(一句话) 主要对外入口 覆盖规划项
adc_input.h / .c L1 统一语义取数:两片转换器的码值按语义(UA…IN / 温度)暴露,并消费 STM32 ADC1 的 DMA 乒乓缓冲 adc_input_init() adc_input_poll() adc_input_raw() L1-2 / L1-3 / L1-4
adc_health.h / .c L1 采样有效性判定:吃计数快照,产出静默 / 丢帧 / 单调性 / 错误增量故障位(判定与告警编排分离) adc_health_check() adc_health_flags() L1-6
sample_ring.h / .c L2 输入 按语义通道存最近 2 周波(40 点),供相量层"以当前时刻为终止"取窗 sample_ring_push_frame() sample_ring_window() L2 输入(为 L2-6 供数)
phasor.h / .c L2 全周傅氏:一周波 20 点 DFT → 基波 / 谐波相量(有效值口径),双区原子切换供无锁读 phasor_run() phasor_get() phasor_calc() L2-1 / L2-2 / L2-3 / L2-6 / L2-7
freq.h / .c L2 派生量 频率测量:相邻两拍基波相量共轭乘积取角 + 自适应窗滑动平均 + 假值钳制 + 幅值门(UA→IA 源回退) freq_run() freq_get() freq_valid() L3-5 测量侧(测频范围 → docs/算法/继电保护功能复现规划.md §4.2)
prot_set.h / .c L3 输入 保护定值模型:Q10 定点 RAM 表 + 范围校验 + 校验和封存 / 自检 / 闭锁 + 持久化 blob 纯逻辑 prot_set_load_raw() prot_set_get_f() prot_set_selfcheck() L5-1 载体
prot_elm.h / .c L3 保护元件框架:通用"越限 + 返回系数滞回 + 定时限"核 + 数据驱动实例表(过流三段 / 过负荷 / 过压 / 欠压 / 零序过压 / 过频 / 低频) prot_elm_run() prot_elm_eval() prot_elm_active_mask() L3-1 / L3-3 / L3-4 / L3-5 / L3-6(软件侧)

依赖(自下而上、无环):adc_input.h(纯枚举 + 声明)← sample_ring ← phasor ← freq; prot_set 独立;prot_elm ← prot_set + phasor + freq。 adc_health 只吃调用方喂进来的计数快照,不反向依赖 L1 实现。

除 adc_input.c 外全部零平台依赖(只用 stdint.h / math.h / stddef.h 与本目录头) → 可被主机单测 #include 原样纳入、免桩跑。adc_input.c 另依赖 adc.h(hadc1)与 tpafe5160.h(快照),主机侧以桩头替身。

2. 一拍的数据流(一眼版)

adc_input_poll() → adc_input_raw() ×9 → sample_ring_push_frame() → phasor_run() → freq_run() → 消费者(adcTask 心跳与 L1 健康判定;protectTask 每 20 ms 取相量 / 频率跑 prot_elm_run())。节拍 = TIM3 1 kHz 更新事件,两片转换器同源触发。 完整数据流图与初始化落点 → docs/算法/采集与算法层设计说明.md §2。

3. 逐文件要点(只留"改代码时必须知道"的;机制与理由见设计文档)

改本目录前先记四条红线:① 取数只经 adc_input_raw(),不写死下标;② 禁止跨转换器做 相位 / 功率 / 矢量运算(N-18);③ 标定未落地,现以原始码值充当工程量,幅值读数不可作精度判据; ④ 本层不建任务、不等事件、不写日志,*_init() 才可在内核前调。 全文 → docs/算法/采集与算法层设计说明.md §10。

3.1 adc_input.c / adc_input.h — L1 语义取数

  • 语义映射表 k_adc_map[] 的内容唯一权威是 docs/硬件平台/ADC通道映射说明.md;V0.2 改版只改表内容,API 不动。
  • adc_input_poll() 仅任务上下文(TPAFE 快照是临界区);STM32 侧固定滞后 1 拍。
  • 四类 STM32 计数(adc1_seq / adc1_gap / adc1_err / adc1_hw)成因不同,勿混读。
  • 本目录唯一允许出现 HAL 调用的文件。→ docs/算法/采集与算法层设计说明.md §3。

3.2 sample_ring.c / .h — L2 输入采样环

  • 整帧写入后才推进写指针 → 取到的窗永远落在整帧边界。
  • 本拍取数失败 → 整拍跳过入环(adc_task.c 的 skip),绝不补 0 点。
  • 不做跨通道运算、不做丢帧判定(只出 frames() 计数)。→ docs/算法/采集与算法层设计说明.md §5。

3.3 phasor.c / .h — L2 相量计算

  • 系数表预乘 √2/N → fAmSQ 直接是有效值(口径 docs/算法/傅氏算法详解.md §2.3)。
  • 实例表 k_inst[] 数据驱动:新增实例只在表尾加一行。
  • 任一实例不足一周波 → 本拍整体不产出(不切使用区);每拍 20 点全部重算(不做增量递推)。
  • → docs/算法/采集与算法层设计说明.md §6。

3.4 adc_health.c / .h — L1 有效性判定

  • 三类位严格分开:电平(可自愈)/ 锁存(必留痕)/ 边沿事件(仅当拍);静默 ≠ 丢帧。
  • gap 不告警(消费者超拍是已知现象);告警编排在 adc_task.c,不在本层。
  • 首拍 check() 只建基线。→ docs/算法/采集与算法层设计说明.md §4。

3.5 prot_set.c / .h — 保护定值模型(L5-1 载体)

  • 装载 all-or-nothing:任一项越界整表不装载,越界项由 prot_set_bad_mask() 指认。
  • 批量 prot_set_set() 后必须 prot_set_seal();单项原子写用 prot_set_set_sealed()。
  • 定值项 / 实例只许尾部追加(枚举序 = 数组序 = 校验和覆盖序)。
  • blob 换代(返回 2)≠ 损坏(返回负):前者打 INFO、不记自检。→ docs/算法/采集与算法层设计说明.md §8、§12.3。

3.6 prot_elm.c / .h — L3 保护元件框架

  • 数据缺失两种处理刻意不同:相量类任一未就绪 → 整拍跳过;频率类无有效读数 → 按方向填"必不启动"值,不整拍跳过。
  • prot_set_locked() 或投退 = 0 → 元件整体复位不判据;跨上下文复归走 prot_elm_request_reset()。
  • 零序过流(IN 走 STM32)故意不在实例表;OF / UF 无独立 104 遥信点,只经 YX15 总聚合可见。
  • prot_elm_init() 须在 phasor_init() 之后。→ docs/算法/采集与算法层设计说明.md §9。

3.7 freq.c / .h — 频率测量(L3-5 的测量输入)

  • freq_run() 仅 adcTask 上下文,须在 phasor_run() 之后同拍调;保护口径 = freq_get() == 0 && freq_valid() == 1。
  • 精度靠自适应窗长(窗长 = 泄漏纹波周期的整数倍);定长平均压不到 0.02 Hz, 换窗长 = 换精度,二者不是独立旋钮。
  • 源切换即废相位基准重建(UA / IA 无共同相位基准,N-18)。
  • 判据 J1~J6 与实测口径 → docs/算法/采集与算法层设计说明.md §7.2(与 test/host/freq/freq_test.c 文件头同源)。

4. 构建与测试

4.1 挂载与模拟器边界

  • 七个 .c 已登记在 MDK-ARM/STM32F407-Demo.uvprojx;../App/algo 已在 <IncludePath> 内。
  • 本层不进 simulator/CMakeLists.txt(UI 模拟器不跑采集链路):七个文件全部登记在 scripts/check_registration.py 的 SIM_EXEMPT(附理由),registration-check 钩子反向校验(N-23)。

4.2 主机侧单测(L0.5)——生产源文件以 #include 原样纳入

模块 命令 pre-commit 钩子
相量 / 采样环 & '.venv\Scripts\python.exe' test/host/phasor/run_unit_test.py phasor-unit-test
ADC 输入层 & '.venv\Scripts\python.exe' test/host/adc_input/run_unit_test.py adc-input-unit-test
有效性校验 & '.venv\Scripts\python.exe' test/host/adc_health/run_unit_test.py adc-health-unit-test
定值模型 & '.venv\Scripts\python.exe' test/host/prot_set/run_unit_test.py prot-set-unit-test
元件框架 & '.venv\Scripts\python.exe' test/host/prot_elm/run_unit_test.py prot-elm-unit-test
频率测量 & '.venv\Scripts\python.exe' test/host/freq/run_unit_test.py freq-unit-test

改本目录任一 .c/.h,提交时对应钩子自动跑。用例清单与判据数字的属主是各 test/host/<模块>/ 与 docs/测试说明/ 下的单测说明,本文不复制(三处抄数字必然打架)。

4.3 板端

@build 0 错误 0 警告 → @test 看 [ADC_TASK] 首拍 / 心跳(phasor(...)、freq(...)、 ring / skip / adc1_* / tgap);健康判据 = 零 [ERR](健康告警全以 [ERR] 开头, 误报会被闭环直接抓住)。→ docs/算法/采集与算法层设计说明.md §12。

5. 新增一个算法模块的固定动作

  1. 在本目录建 xxx.c/h,文件头写模块注释块(规范 V1.0),尽量零平台依赖以便免桩单测。
  2. 用 new-source-file skill 注册到 MDK-ARM/STM32F407-Demo.uvprojx(新建子目录还要补 <IncludePath>)。 模拟器侧二选一:有消费路径 → 加 simulator/CMakeLists.txt;纯算法无消费路径 → 加 scripts/check_registration.py 的 SIM_EXEMPT(照本目录既有七条写理由),否则 registration-check 拦。
  3. 加 test/host/<模块>/ 主机单测 + .pre-commit-config.yaml 钩子(照 phasor-unit-test 抄)。
  4. 消费者写在 App/task/,本层只出"数";跨转换器禁令见 §3 开头四条红线。
  5. 在本 README §1 清单加一行,并在 docs/算法/采集与算法层设计说明.md 里写清该模块的契约与理由。

6. 相关文档

  • 本层设计与判据:docs/算法/采集与算法层设计说明.md
  • 通道映射权威口径:docs/硬件平台/ADC通道映射说明.md
  • 分层与功能项清单:docs/算法/继电保护功能复现规划.md
  • 傅氏算法与有效值口径:docs/算法/傅氏算法详解.md
  • 采样节拍(TIM3 1 kHz + TRGO 触发 ADC1 / DMA):docs/子系统设计/ADC采样节拍设计说明.md
  • 相量层 / ADC 输入层单测细则:docs/测试说明/相量层单元测试说明.md、docs/测试说明/ADC输入层单元测试说明.md
  • RAM 与栈台账:docs/内存管理/RAM使用分析与优化方案.md