docs: 重写 README,新增排障手册,补板级说明
原 README.md 是上游框架模板的拷贝:两棵树内容完全相同,描述的是"计划要做的
模块"(一堆未勾选的 checkbox),且大量链接指向根本不存在的 ./doc/*.md
(framework/注意事项/API/LOG/TODO/reference/appendix/questions 全都没有)。
它没有描述本项目实际重构后的代码。
本次文档落地为三份:
1. README.md(根,详细)
- 项目概览(双板架构、两板同构、QEKF、双 INS 跟随方案)
- 硬件与工具链、快速开始(编译烧录 + 上电前置检查)
- 代码地图(Application/Bsp/Core/modules/MDK-ARM 逐层说明)
- 运行架构(9 个任务的优先级/栈/职责表、控制周期、IWDG 看门狗)
- 数据流与对外接口(CAN 分配、串口分配、CToC 帧表、姿态数据流)
- 模块清单、USB CDC 遥测字段详解、调参入口与三个台架开关
- 上电时序与灯语/蜂鸣器语义
- 已知陷阱(整合了本次排障的全部硬知识)
- 版本管理约定、致谢与联系
2. doc/已知问题与排障.md(新增)
排障总则(先看 ca/cg 而非数值;用算式交叉验证)+ 症状速查表 + 6 个典型
案例详解 + 提交前检查清单。把"踩过的坑"沉淀成可复查的手册。
3. 云台/README.md、底盘/README.md(重写为简短的板级说明)
只讲本板特有的职责、编译宏、独占模块、上电特有行为、蜂鸣器序号,并指回
根 README;顺便去掉指向不存在文件的死链。
另修一处文档缺陷:modules/comms/c_comm.h 里 0x1A9 帧被写了两遍,且两处对
Data[4] 的描述互相矛盾(一处说只有 att_ready,一处说还有编码器增向与自检位),
已合并为一份准确描述。
LSMushui
7c25e06947