diff --git a/README.md b/README.md index e0446e6..cd3e0b2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,134 @@ # Simba-ELEC-FrameWork +
+ + + + + +
Simba-gitELEC
+ +[![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) + +
+ +## 简介 + +> Simba自己的C板电控框架！ + +本项目的计划是基于 **DJI C型开发板** 的基础上打造一个更适合Simba同学们的代码框架 + +本框架致力于实现不同类型的机器人的代码通用化，只需要选择底盘云台的类型，修改一下对应物理参数即可实现对机器人的适配 + +## 配套套件 + +> 上位机，ROS接口待开发 + +## 模块支持 + +详细信息请参考 [Simba-ELEC-FrameWork文档](./doc/framework.md) + +### 主要模块 + +- **Robot cmd**\ + 机器人控制模块： + - [ ] 大疆电机 + - [ ] 达妙电机 + - [ ] 瓴控电机 + - [ ] 小米电机 + - [ ] 超级电容控制板 + - [ ] 板间通信(CAN) + - [ ] PWM 控制舵机 + - [ ] PWM 控制气泵 +- **Chassis**\ + 底盘模块： + - [ ] 麦轮底盘 + - [ ] 全向轮底盘 + - [ ] 舵轮底盘 + - [ ] 平衡底盘 +- **Gimbal**\ + 云台模块： + - [ ] yaw-pitch 直连云台 + - [ ] yaw直连-pitch丝杆 云台 + - [ ] yaw-pitch 丝杆云台 +- **Shoot**\ + 发射机构模块： + - [ ] 摩擦轮+拨弹盘 + - [ ] 摩擦轮+弹鼓+推杆 +- **Communication**\ + 通信模块： + - [ ] 板间通信(CAN2) + - [ ] 上下位机通信 +- **Music**\ + 音乐模块： + - [ ] 开机声 + - [ ] 报错音 + - [ ] 裁判系统接入提示音 + - [ ] 《卡农》 + - [ ] 《天空之城》 + - [ ] 《恭喜发财》 + - [ ] 《好运来》 + - [ ] 《See You Again》 + - [ ] 《Unity》 + - [ ] 《你》 + +## 开发工具 + +本项目使用HAL库编写，通过CubeMX生成项目，使用FreeRTOS + +使用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)配置好自己的环境 + + + + +## 欢迎贡献 + +如果你发现了本项目中的问题和可优化的点，可用创建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