From 00298e9bfecb31b37b8f8445d0474135e66dd373 Mon Sep 17 00:00:00 2001 From: NeoZng Date: Fri, 11 Nov 2022 12:32:24 +0800 Subject: [PATCH] mute build output --- HAL_N_Middlewares/Src/main.c | 2 +- Makefile | 10 +- README.md | 218 ++++++++++++++++++------ modules/referee/referee_communication.c | 0 4 files changed, 173 insertions(+), 57 deletions(-) create mode 100644 modules/referee/referee_communication.c diff --git a/HAL_N_Middlewares/Src/main.c b/HAL_N_Middlewares/Src/main.c index 3982e25..c276a02 100644 --- a/HAL_N_Middlewares/Src/main.c +++ b/HAL_N_Middlewares/Src/main.c @@ -158,7 +158,7 @@ int main(void) DJIMotorSetRef(djimotor, get_remote_control_point()->rc.ch[0]); MotorControlTask(); - HAL_Delay(20); + HAL_Delay(10); /* USER CODE BEGIN 3 */ } /* USER CODE END 3 */ diff --git a/Makefile b/Makefile index 51cbaaa..91bc6ec 100644 --- a/Makefile +++ b/Makefile @@ -117,6 +117,8 @@ modules/motor/HT04.c \ modules/motor/LK9025.c \ modules/motor/motor_task.c \ modules/referee/referee.c \ +modules/referee/referee_UI.c \ +modules/referee/referee_communication.c \ modules/remote/remote_control.c \ modules/super_cap/super_cap.c \ modules/master_machine/seasky_protocol.c \ @@ -246,13 +248,13 @@ OBJECTS += $(addprefix $(BUILD_DIR)/,$(notdir $(ASM_SOURCES:.s=.o))) vpath %.s $(sort $(dir $(ASM_SOURCES))) $(BUILD_DIR)/%.o: %.c Makefile | $(BUILD_DIR) - $(CC) -c $(CFLAGS) -Wa,-a,-ad,-alms=$(BUILD_DIR)/$(notdir $(<:.c=.lst)) $< -o $@ + @$(CC) -c $(CFLAGS) -Wa,-a,-ad,-alms=$(BUILD_DIR)/$(notdir $(<:.c=.lst)) $< -o $@ $(BUILD_DIR)/%.o: %.s Makefile | $(BUILD_DIR) - $(AS) -c $(CFLAGS) $< -o $@ + @$(AS) -c $(CFLAGS) $< -o $@ $(BUILD_DIR)/$(TARGET).elf: $(OBJECTS) Makefile - $(CC) $(OBJECTS) $(LDFLAGS) -o $@ + @$(CC) $(OBJECTS) $(LDFLAGS) -o $@ $(SZ) $@ $(BUILD_DIR)/%.hex: $(BUILD_DIR)/%.elf | $(BUILD_DIR) @@ -262,7 +264,7 @@ $(BUILD_DIR)/%.bin: $(BUILD_DIR)/%.elf | $(BUILD_DIR) $(BIN) $< $@ $(BUILD_DIR): - mkdir $@ + @mkdir $@ ####################################### # clean up diff --git a/README.md b/README.md index d63316e..cb2fafb 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,90 @@ -- # 2023 EC-basic-framework（C语言版）说明 +# 2023 EC-basic-framework（C语言版）说明 - 当前版本更新日期：2022.11.03 +当前版本更新日期：2022.11.03 - 本说明仅针对电控组2023赛季框架，如有变动以日期靠后的版本为准 +本说明仅针对电控组2023赛季框架，如有变动以日期靠后的版本为准 - - 开发方式： +- 开发方式： - 本框架使用stm32cubemx生成，基于makefile，使用gcc-arm-none-eabi编译（make命令）。若需使用keil5开发，请在stm32cubemx的`project manager`标签页下将工具链改为MDK，然后在keil中自行添加所需包含的.c文件和头文件。关于如何在keil下添加dsplib，请参考文档。 + 本框架使用stm32cubemx生成，基于makefile，使用gcc-arm-none-eabi编译（make命令）。若需使用keil5开发，请在stm32cubemx的`project manager`标签页下将工具链改为MDK，然后在keil中自行添加所需包含的.c文件和头文件。关于如何在keil下添加dsplib，请参考文档。 - - 分层： + VSCode可通过Cortex-Debug利用OpenOCD进行调试，jlink/stlink/dap-link都支持。 - 本框架主要代码分为BSP、Module、APP三层。三层的代码分别存放在同名的三个文件夹中，这三个文件夹存放在core文件夹下，与Inc、Src文件夹并列。开发过程中主要编写APP层代码，Module层与BSP层不建议修改。如需添加module（如oled屏幕、其他传感器和外设等），请按照规范编写并联系组长提交commit到develop分支。 + 推荐使用 SEGGER ozone进行调试（暂时只支持jlink，提供可视化模块）。 - **main.c的位置在**`HAL_N_Middlewares/Src/main.c` +- 分层： - - 代码格式： + 本框架主要代码分为BSP、Module、APP三层。三层的代码分别存放在同名的三个文件夹中，这三个文件夹存放在根目录下。开发过程中主要编写APP层代码，Module层与BSP层不建议修改。如需添加module（如oled屏幕、其他传感器和外设等），请按照规范编写并联系组长提交commit到dev分支，完善后合并至主分支。 - 在vscode-设置-扩展-C/C++-C_Cpp:style下修改。默认为`Visual Studio`。请手动修改为： - `{ BasedOnStyle: Google, IndentWidth: 4, TabWidth: 4, ColumnLimit: 0 }`。修改完成后可在代码中使用右键-格式化文档(注：请勿对cube生成的文件使用此操作)。此操作不会改变文档的内容，但会改变缩进、空行、符号位置等，使代码更加统一、整洁。 + BSP层构建与HAL之上。HAL库和实时系统、DSP支持等文件都在`HAL_N_Middlewares`文件夹下（包括Cube生成的外设初始化的Inc和Src文件夹）。 - - 面向对象设计： + **main.c的位置在**`HAL_N_Middlewares/Src/main.c` - C语言不存在“成员函数”的概念。为实现类似效果，所有按照这一思想构建的函数都会有一个传入参数，将结构体（对象）传入。 +- 代码格式： - ## BSP层(Board Sopport Package) + 在vscode-设置-扩展-C/C++-C_Cpp:style下修改。默认为`Visual Studio`。请手动修改为： + `{ BasedOnStyle: Google, IndentWidth: 4, TabWidth: 4, ColumnLimit: 0 }`。修改完成后可在代码中使用右键-格式化文档(注：请勿对cube生成的文件使用此操作)。此操作不会改变文档的内容，但会改变缩进、空行、符号位置等，使代码更加统一、整洁。 - - TODO： - 1. 增加SPI和I^2^C的BSP模组以便支持IST384磁力计和Oled显示屏等。 - 2. 增加segger RTT log的支持，方便调试和日志记录 - - 主要功能：实现映射功能。 - - 在本框架中，BSP层与cube高度耦合，对该层的修改往往需要使用cube重新生成工程。该层也是唯一允许直接出现stm32HAL库函数的代码层，**在非BSP层编写代码时，如需使用HAL_...函数，请思考是否有同功能的BSP_...函数**。 - - 最简单的(如gpio)仅是对HAL库函数的封装。较为复杂的则会进行一定程度的处理(如can) - - 补充与修改：某款主控对应的BSP层应保持相同，当认为该层可能缺少部分功能或有错误时，请联系组长确认后解决并更新整个框架，**请勿自行修改**。 - - 代码移植：BSP层也是在不同系列、型号的stm32间执行代码移植时主要需要关注的代码层。向功能更强系列移植一般只需要重配cube并重新组织BSP层的映射关系，而向功能较少的系列移植还需要去掉其不支持的功能。修改BSP后一般不需要对其他两层进行修改。 - - 子文件与文件夹： - - bsp.c/h：该层核心文件，其中.h被include至main.c中，以实现整个代码层的初始化。include了该层所有模块的.h并调用各模块的初始化函数。**注意**，有些外设如串口和CAN不需要在bsp.c中进行模块层的初始化，他们会在module层生成实例（即C语言中的结构体）并注册到bsp层时自动进行初始化。 - - bsp_xxx.c/h：每一个成对的.c/h对应一种外设，当上面两个代码层需要使用某个外设时，这里的文件就是对应的交互接口。 - - 注册回调函数与接收：通信类外设模块有的定义了回调函数类型(函数指针类型)，若调用bsp...h中的回调函数注册函数将其他位置(HAL层)定义的符合形式的函数注册为回调函数，该函数在接收到数据后或其他设定位置会被调用。在module对模块进行初始化的时候需要将对应的协议解析函数进行设置，代码中注释有对应提示。 +- 面向对象设计： - ## Module层 + C语言不存在“成员函数”的概念。为实现类似效果，所有按照这一思想构建的函数都会有一个传入参数，将结构体（对象）传入。 - - TODO： +## BSP层(Board Sopport Package) - 1. 添加pub-sub（订阅-发布消息机制）的支持，以进一步隔离不同的模块完成封装。 - 2. 增加错误检测模块（官方例程中的`deteck_task`）。 - 3. 增加和PC通信协议的支持 - 4. 增加超级电容模块 - 5. 增加舵机模块 - 6. 增加单点激光模块 +- TODO： + 1. 增加SPI和I^2^C的BSP模组以便支持IST384磁力计和Oled显示屏等。 + 2. 增加segger RTT log的支持，方便调试和日志记录 +- 主要功能：实现映射功能。 + - 在本框架中，BSP层与cube高度耦合，对该层的修改往往需要使用cube重新生成工程。该层也是唯一允许直接出现stm32HAL库函数的代码层，**在非BSP层编写代码时，如需使用HAL_...函数，请思考是否有同功能的BSP_...函数**。 + - 最简单的(如gpio)仅是对HAL库函数的封装。较为复杂的则会进行一定程度的处理(如can) +- 补充与修改：某款主控对应的BSP层应保持相同，当认为该层可能缺少部分功能或有错误时，请联系组长确认后解决并更新整个框架，**请勿自行修改**。 +- 代码移植：BSP层也是在不同系列、型号的stm32间执行代码移植时主要需要关注的代码层。向功能更强系列移植一般只需要重配cube并重新组织BSP层的映射关系，而向功能较少的系列移植还需要去掉其不支持的功能。修改BSP后一般不需要对其他两层进行修改。 +- 子文件与文件夹： + - bsp.c/h：该层核心文件，其中.h被include至main.c中，以实现整个代码层的初始化。include了该层所有模块的.h并调用各模块的初始化函数。**注意**，有些外设如串口和CAN不需要在bsp.c中进行模块层的初始化，他们会在module层生成实例（即C语言中的结构体）并注册到bsp层时自动进行初始化。 + - bsp_xxx.c/h：每一个成对的.c/h对应一种外设，当上面两个代码层需要使用某个外设时，这里的文件就是对应的交互接口。 +- 注册回调函数与接收：通信类外设模块有的定义了回调函数类型(函数指针类型)，若调用bsp...h中的回调函数注册函数将其他位置(HAL层)定义的符合形式的函数注册为回调函数，该函数在接收到数据后或其他设定位置会被调用。在module对模块进行初始化的时候需要将对应的协议解析函数进行设置，代码中注释有对应提示。 - - 主要功能：实现对设备的封装 +## Module层 - - 子文件与子文件夹 +- TODO： - - module.c/h:该层核心文件。会对该层所有模块初始化，调用各个模块的init函数，并封装成module层的init函数放到main.c中执行。注意，一些模块会在app层构建对应实例的时候进行初始化，不需要在module.c的init函数中进行初始化。 - - monitor文件夹:实现看门狗功能。提供回调函数和count可选（TODO） - - algorithm:该层软件库存放位置，这些功能与硬件无关，而是提供通用的数据结构和“算子”以供该层的其他部分调用，主要是算法、控制器、底盘和位姿解算等。 + 1. 添加pub-sub（订阅-发布消息机制）的支持，以进一步隔离不同的模块完成封装。 + 2. 增加错误检测模块（官方例程中的`deteck_task`）。 + 3. 增加和PC通信协议的支持 + 4. 增加超级电容模块 + 5. 增加舵机模块 + 6. 增加单点激光模块 - - module要点： +- 主要功能：实现对设备的封装 - - 初始化： +- 子文件与子文件夹 - 根据代码对应的函数说明，传入对应的配置文件。对于某些需要集中设置的参数，一般于模块的头文件中会额外设定一个xxx_config_s的结构体用于初始化的参数传递。如果不需要进行这样的集中设置，则是直接传入对应的参数或module结构体中本就存在的成员变量。 + - module.c/h:该层核心文件。会对该层所有模块初始化，调用各个模块的init函数，并封装成module层的init函数放到main.c中执行。注意，一些模块会在app层构建对应实例的时候进行初始化，不需要在module.c的init函数中进行初始化。 + - monitor文件夹:实现看门狗功能。提供回调函数和count可选（TODO） + - algorithm:该层软件库存放位置，这些功能与硬件无关，而是提供通用的数据结构和“算子”以供该层的其他部分调用，主要是算法、控制器、底盘和位姿解算等。 - - 结构体： +- module要点： - 也就是所说的“实例”，定义一个module结构体，对于app层来说就是拥有某一个功能模块的实例，比如一个特定的电机。在对电机进行操作的时候，传入该实例的结构体指针。 + - 初始化： - - 函数： + 根据代码对应的函数说明，传入对应的配置文件。对于某些需要集中设置的参数，一般于模块的头文件中会额外设定一个xxx_config_s的结构体用于初始化的参数传递。如果不需要进行这样的集中设置，则是直接传入对应的参数或module结构体中本就存在的成员变量。 - .c中存放的相当于这个类的private函数，.h中的则相当于public。相似的driver的public函数应较为统一。由于通信格式，使用方法等的不同，不同通信设备在读取操作、数据格式上可能有所不同，这些不同应该在driver的内部处理。 + - 结构体： - - 封装程度： + 也就是所说的“实例”，定义一个module结构体，对于app层来说就是拥有某一个功能模块的实例，比如一个特定的电机。在对电机进行操作的时候，传入该实例的结构体指针。 - 应尽可能使到上层使用时不考虑下层所需的操作。如在使用电机时，这个电机的数据该和哪些电机的数据在一个数据包中发送，can的过滤器设置，均属于应该自动处理的功能； - 接收类的driver应该封装到只有初始化（`register`和发送控制命令`set_control`两个函数和一个实时更新的用于给app层提供该信息的数据结构体）。 + - 函数： - Module层主要存放的是类型定义和实例指针数组，在该层没有进行实例化（定义或通过malloc分配空间），若在APP层没有实例化，则该模块的存在与否基本不会影响编译后的可执行文件，只会占用初始化和代码区所需的少量内存。因此，基于本框架的其他工程没有必要删除APP层未使用的module文件。 + .c中存放的相当于这个类的private函数，.h中的则相当于public。相似的driver的public函数应较为统一。由于通信格式，使用方法等的不同，不同通信设备在读取操作、数据格式上可能有所不同，这些不同应该在driver的内部处理。 + - 封装程度： - ## APP层(application) + 应尽可能使到上层使用时不考虑下层所需的操作。如在使用电机时，这个电机的数据该和哪些电机的数据在一个数据包中发送，can的过滤器设置，均属于应该自动处理的功能； + 接收类的driver应该封装到只有初始化（`register`和发送控制命令`set_control`两个函数和一个实时更新的用于给app层提供该信息的数据结构体）。 + +Module层主要存放的是类型定义和实例指针数组，在该层没有进行实例化（定义或通过malloc分配空间），若在APP层没有实例化，则该模块的存在与否基本不会影响编译后的可执行文件，只会占用初始化和代码区所需的少量内存。因此，基于本框架的其他工程没有必要删除APP层未使用的module文件。 + +## APP层(application) - TODO： 1. 完成麦克纳姆轮/全向轮底盘的功能 @@ -91,4 +96,113 @@ - APP层按照模块（如云台、发射、底盘）可以建立对应的子文件夹，在其中完成初始化和相关逻辑功能的编写。目前尚未对app层进行开发。 - \ No newline at end of file + + +## 文件树 + +```shell +ROOT:. +│ .gitignore # git版本管理忽略文件 +│ .mxproject # CubeMX项目文件 +│ basic_framework.ioc # CubeMX初始化配置文件 +│ Makefile # 编译管理文件,为make命令的目标 +│ openocd.cfg # 用于OpenOCD调试使用的配置文件 +│ README.md # 本说明文档 +│ startup_stm32f407xx.s # F407汇编启动文件 +│ STM32F407.svd # F407外设地址映射文件,用于调试 +│ STM32F407IGHx_FLASH.ld # F407IGH(C板使用的MCU)的文件目标FLASH地址,用于烧录和调试 +│ +├─.vscode +│ launch.json # 用于VSCode插件CORTEX-DEBUG调试的配置文件 +│ +├─application # 应用层,包括底盘控制,云台控制和发射控制 +│ chassis.c +│ chassis.h +│ gimbal.c +│ gimbal.h +│ shoot.c +│ shoot.h +│ +├─bsp # 板级支持包,提供对硬件的封装,将接口暴露给module层 +│ bsp_buzzer.c +│ bsp_buzzer.h +│ bsp_can.c +│ bsp_can.h +│ bsp_dwt.c +│ bsp_dwt.h +│ bsp_led.c +│ bsp_led.h +│ bsp_log.c +│ bsp_log.h +│ bsp_temperature.c +│ bsp_temperature.h +│ bsp_usart.c +│ bsp_usart.h +│ struct_typedef.h +│ +├─HAL_N_Middlewares # HAL库对寄存器操作的封装,以及FreeRTOS等中间件 +| +└─modules # 模块层,使用BSP提供的接口构建对应的功能模块,将模块实例提供给应用层 + ├─algorithm # 算法 + │ controller.c # 控制器 + │ controller.h + │ crc16.c # 循环冗余校验 + │ crc16.h + │ crc8.c + │ crc8.h + │ kalman_filter.c # KF + │ kalman_filter.h + │ LQR.c # LQR控制器 + │ LQR.h + │ QuaternionEKF.c # 四元数EKF融合 + │ QuaternionEKF.h + │ user_lib.c # 多个模块都会使用到的函数 + │ user_lib.h + │ + ├─imu # 考虑到使用SPI的设备较少,这里没有对SPI提供bsp支持,直接于此实现 + │ BMI088driver.c + │ BMI088driver.h + │ BMI088Middleware.c + │ BMI088Middleware.h + │ BMI088reg.h + │ ins_task.c # 姿态解算任务,在RTOS中以1kHz运行 + │ ins_task.h + │ + ├─led_light + │ led_task.c # 用于指示错误和主控是否正常运行,流水灯任务 + │ led_task.h + │ + ├─master_machine # 和上位机(视觉PC)通信的模块 + │ master_process.c + │ master_process.h + │ seasky_protocol.c # 视觉通信协议 + │ seasky_protocol.h + │ + ├─motor # 电机模块 + │ dji_motor.c # DJI智能电机 + │ dji_motor.h + │ HT04.c # 海泰-04关节电机 + │ HT04.h + │ LK9025.c # 瓴控9025驱动轮电机 + │ LK9025.h + │ motor_def.h # 电机通用定义 + │ motor_task.c # 电机控制任务,1kHz运行在RTOS上 + │ motor_task.h + │ + ├─referee # 裁判系统模块 + │ referee.c # 接收裁判系统信息 + │ referee.h + │ referee_UI.c # UI绘制(发送) + │ + ├─remote # 遥控器模块 + │ remote_control.c + │ remote_control.h + │ + └─super_cap # 超级电容 + super_cap.c + super_cap.h +``` + +## BSP和模块介绍 + +在对应模块和板级支持包文件夹下。 \ No newline at end of file diff --git a/modules/referee/referee_communication.c b/modules/referee/referee_communication.c new file mode 100644 index 0000000..e69de29