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:
2026-09-12 11:53:50 +08:00
parent e3d432f3b5
commit 7c25e06947
6 changed files with 671 additions and 233 deletions
+40 -114
View File
@@ -1,133 +1,59 @@
# Simba-ELCT-FrameWork
# 云台板固件(Simba-ELCT-FrameWork)
> 步兵机器人**云台板**工程 · STM32F407IGH6 · Keil + FreeRTOS + CMSIS-DSP
<table>
<tr>
<td><img src="https://git.simba-robotics.com/assets/img/logo.svg" width = "200" height = "200" alt="Simba-git" /></td>
<td><img src="https://git.simba-robotics.com/avatars/cd8e5bc7a1039e1cbadabefe03e647af1bbbd8722d659d437479b93c8c6fa799?" width = "200" height = "200" alt="ELEC" /></td>
</tr>
</table>
项目总览、代码地图、任务表、调试与注意事项请先读 **[根 README](../README.md)** 与 **[已知问题与排障](../doc/已知问题与排障.md)**。本文只讲这块板特有的东西。
[![Author](https://img.shields.io/badge/Author-LSMushui-orange.svg)](https://gitee.com/LSMushui)
![language](https://img.shields.io/badge/language-C-blue.svg)
![license](https://img.shields.io/badge/license-GPLv3-green.svg)
---
## 这块板负责什么
## 简介
- **云台控制**:Yaw(GM6020 `0x205`,CAN2)/ Pitch(GM6020 `0x206`,CAN1)双环
- **发射机构**:摩擦轮 M3508 `0x201`/`0x202` + 拨弹 M2006 `0x207`(装与不装由 `GIMBAL_RAMMER_INSTALLED` 决定)
- **图传链路 / 裁判系统**:USART6(3pin 口)
- **DR16 遥控器**:USART3
- **板间通讯主控**:云台把世界系 yaw(`0x1A9`)与摇杆/控制状态(`0x149`/`0x189`)发给底盘
- **视觉上位机接口**:USART1(4pin 口),收发 DMA 已就绪,协议待接入
> Simba自己的C板电控框架!
## 编译宏
本项目的计划是基于 **DJI C型开发板** 的基础上打造一个更适合Simba同学们的代码框架
```
USE_HAL_DRIVER, STM32F407xx, ARM_MATH_CM4, ROBOT_TYPE_GIMBAL
```
本框架致力于实现不同类型的机器人的代码通用化,只需要选择底盘云台的类型,修改一下对应物理参数即可实现对机器人的适配
## 相对底盘板多出来的东西
## 配套套件
| 项 | 位置 |
| --- | --- |
| `gimbal` 云台双环 + 装配符号自检 | `modules/control/gimbal.c` |
| `shoot` 摩擦轮/拨弹 | `modules/control/shoot.c` |
| `gimbal_task` / `shoot_task` | `Application/Task/Src/` |
| DR16 遥控器、视觉串口 | `Bsp/bsp_usart.c` 的 `usart3_init` / `usart1_*` |
| 板间帧 0x149 / 0x189 / 0x1A9 的**发送**侧 | `modules/comms/c_comm.c` |
| IST8310 磁力计与本板 IMU 恒温 | `modules/imu/attitude.c`(双板都有,云台用于云台控制) |
> 上位机,ROS接口待开发
底盘板有的 `control/chassis.c` 与 `chassis_task` 本工程没有(所以两棵树的 `modules/control/` 内容不同,属预期差异)。
## 模块支持
## 上电时本板特有的行为
详细信息请参考 [Simba-ELCT-FrameWork文档](./doc/framework.md)
1. `led_init` 点亮蓝灯 → 各外设初始化
2. IMU 初始化 + **z 轴零偏静止标定(约 0.5~1.5 s,这段时间别碰车)**
3. **Yaw 装配符号自检**:给 Yaw 电机一个正向小电压脉冲,看陀螺 z 轴往哪边转,自动定符号;**云台会轻转几度,不要扶住云台**。失败(被按住 / 电机离线)时回退到 `GIMBAL_YAW_SIGN_FALLBACK`
4. 自检结果经 `0x1A9` 的 flags 下发给底盘,与底盘自测的车身转向相乘完成跟随符号综合
### 主要模块
## 蜂鸣器序号(本板)
- **Robot cmd**\
机器人控制模块:
- [ ] 大疆电机
- [ ] 达妙电机
- [ ] 瓴控电机
- [ ] 小米电机
- [ ] 超级电容控制板
- [ ] 板间通信(CAN)
- [ ] PWM 控制舵机
- [ ] PWM 控制气泵
- **Chassis**\
底盘模块:
- [ ] 麦轮底盘
- [ ] 全向轮底盘
- [ ] 舵轮底盘
- [ ] 平衡底盘
- **Gimbal**\
云台模块:
- [ ] yaw-pitch 直连云台
- [ ] yaw直连-pitch丝杆 云台
- [ ] yaw-pitch 丝杆云台
- **Shoot**\
发射机构模块:
- [ ] 摩擦轮+拨弹盘
- [ ] 摩擦轮+弹鼓+推杆
- **Communication**\
通信模块:
- [ ] 板间通信(CAN2)
- [ ] 上下位机通信
- **Music**\
音乐模块:
- [ ] 开机声
- [ ] 报错音
- [ ] 裁判系统接入提示音
- [ ] 《卡农》
- [ ] 《天空之城》
- [ ] 《恭喜发财》
- [ ] 《好运来》
- [ ] 《See You Again》
- [ ] 《Unity》
- [ ] 《你》
CAN 掉线报警按设备序号响 `n` 下:
## 开发工具
```
0 = 摩擦轮L(0x201) 1 = 摩擦轮R(0x202) 2 = Pitch(0x206)
3 = Yaw(0x205) 4 = 拨弹(0x207) 5 = 底盘回传(0x019)
```
本项目使用HAL库编写,通过CubeMX生成项目,使用FreeRTOS
**响三下 = Pitch 电机掉线。** 台架调试嫌吵时把 `robot_param.h` 的 `DEBUG_BUZZER_MELODY` 置 1(只换声音不换灯语)。
使用VSCode作为代码编辑器,Keil5作为IDE
## 构建
Keil5编译器使用AC6版本
> 虽然keil5老,但在嵌入式调试以及环境配置方面是非常简单易上手的。**千万不要用keil5来编辑代码!!!**
\
\
> VSCode作为现代化代码编辑器 ,通过各种插件即可实现各种提高效率的开发方式,**尤其是Github Copilot**
\
\
> AC6编译器相比古早AC5编译器效率更高,AC5编译空项目就要足足1min47s,非常不中,相比之下AC6只需要6s,遥遥领先
\
\
> 但是CubeMX开启FreeRTOS无法直接使用AC6编译器
\
> 强烈建议通过此[教程](https://bbs.robomaster.com/article/18268)(From COD战队GrassFan Wang)配置好自己的环境
用 Keil 打开 `MDK-ARM/Simba-ELCT-FrameWork.uvprojx`,确认 Define 里是 `ROBOT_TYPE_GIMBAL`,Rebuild → Download。
## 欢迎贡献
如果你发现了本项目中的问题和可优化的点,可用创建issue进行讨论
并且fork本项目后提交pr来贡献你的代码
我们的管理员审核后会将你的代码合并进来
> ***贡献代码时请参照 [注意事项](./doc/注意事项.md/#贡献代码) 中的贡献代码部分。***
>
> 编写代码时参考[API](./doc/API.md)
## 开发日志
[LOG.md](./doc/LOG.md) 记录了大家在开发过程中的各种奇思妙想和经验。多翻一翻或许能发现惊喜哦。大家有什么想法也都可以往里面写
[API.md](./doc/API.md) 为开发过程中所使用的模块接口标准,若在编写代码时发现代码与标准冲突,基于本标准修改代码
## 后续计划
具体要做的事情在[TODO](./doc/TODO.md)中
## 致谢
感谢各个战队的代码开源,所有本框架涉及到的主要的参考资料位于[reference.md](./doc/reference.md)
## 附录
本文的详细补充内容写在 [附录](./doc/appendix.md) 中
如发现本项目中的问题,请添加至[问题列表](./doc/questions.md)并与相关负责人联系,如果有解决方案可以提交pull request
## 通讯信息
- 作者 `连山木水` 微信:18088745066 QQ:1194309310
> ⚠️ 本工程与底盘工程源码高度同构,改一处通常要同步改另一处。动手前请读根 README 的 [§11 已知陷阱](../README.md#11-已知陷阱与注意事项)。
+2 -3
View File
@@ -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=底盘电机故障(本工程扩展)
*
* 故障位语义:任一侧电机掉线即置位,对侧收到后必须停止自己的输出(整车安全) */