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,一处说还有编码器增向与自检位), 已合并为一份准确描述。
This commit is contained in:
@@ -12,11 +12,10 @@
|
||||
* 底盘误判沿会误开小陀螺,勿再使用)
|
||||
* Data[6] bit0=键1 bit1=键2 bit2=小陀螺使能(本工程扩展)
|
||||
* bit7=云台电机故障(本工程扩展)
|
||||
* 0x1A9 云台->底盘:Data[0..3]=云台世界系 yaw(float,LE) Data[4]=att_ready
|
||||
* (双 INS 跟随方案的数据源,2026-09 新增)
|
||||
* 0x1A9 云台->底盘:Data[0..3]=云台世界系 yaw(float,LE)
|
||||
* Data[4] flags:bit0=att_ready bit1=编码器tick增向为CCW
|
||||
* bit2=该位有效(自检完成) [跟随符号自动综合的数据源]
|
||||
* bit2=该位有效(自检完成)
|
||||
* (双 INS 跟随方案 + 跟随符号自动综合的数据源,2026-09)
|
||||
* 0x019 底盘->云台:Data[0]发射机构上电状态 Data[1] bit0=底盘电机故障(本工程扩展)
|
||||
*
|
||||
* 故障位语义:任一侧电机掉线即置位,对侧收到后必须停止自己的输出(整车安全) */
|
||||
|
||||
Reference in New Issue
Block a user