From a1509ee665acd004484cfca4167f8f4104f3e2be Mon Sep 17 00:00:00 2001 From: NeoZng Date: Fri, 11 Nov 2022 21:00:02 +0800 Subject: [PATCH] add doc for bsp_usart, bsp_can and dji_motor --- .vscode/settings.json | 3 +- HAL_N_Middlewares/Src/main.c | 2 +- Makefile | 6 +- bsp/bsp_can.c | 2 +- bsp/bsp_can.h | 2 +- bsp/bsp_can.md | 98 ++++++++++ bsp/bsp_usart.c | 2 +- bsp/bsp_usart.md | 69 +++++++ modules/algorithm/controller.h | 11 +- modules/motor/dji_motor.h | 8 +- modules/motor/dji_motor.md | 332 +++++++++++++++++++++++++++++++++ modules/motor/motor_def.h | 3 +- 12 files changed, 519 insertions(+), 19 deletions(-) create mode 100644 bsp/bsp_can.md create mode 100644 bsp/bsp_usart.md create mode 100644 modules/motor/dji_motor.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 46e315a..7bbc271 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -43,6 +43,7 @@ "vofa_protocol.h": "c", "master_process.h": "c", "stdint-gcc.h": "c", - "string.h": "c" + "string.h": "c", + "motor_def.h": "c" } } \ No newline at end of file diff --git a/HAL_N_Middlewares/Src/main.c b/HAL_N_Middlewares/Src/main.c index c276a02..fd640c3 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(10); + HAL_Delay(100); /* USER CODE BEGIN 3 */ } /* USER CODE END 3 */ diff --git a/Makefile b/Makefile index 91bc6ec..434ef8e 100644 --- a/Makefile +++ b/Makefile @@ -255,7 +255,7 @@ $(BUILD_DIR)/%.o: %.s Makefile | $(BUILD_DIR) $(BUILD_DIR)/$(TARGET).elf: $(OBJECTS) Makefile @$(CC) $(OBJECTS) $(LDFLAGS) -o $@ - $(SZ) $@ + @$(SZ) $@ $(BUILD_DIR)/%.hex: $(BUILD_DIR)/%.elf | $(BUILD_DIR) $(HEX) $< $@ @@ -264,13 +264,13 @@ $(BUILD_DIR)/%.bin: $(BUILD_DIR)/%.elf | $(BUILD_DIR) $(BIN) $< $@ $(BUILD_DIR): - @mkdir $@ + mkdir $@ ####################################### # clean up ####################################### clean: - -rm -fR $(BUILD_DIR) + -rm -r $(BUILD_DIR) ####################################### # dependencies diff --git a/bsp/bsp_can.c b/bsp/bsp_can.c index 7cbd0b8..35d30e0 100644 --- a/bsp/bsp_can.c +++ b/bsp/bsp_can.c @@ -4,7 +4,7 @@ #include "memory.h" /* can instance ptrs storage, used for recv callback */ -static can_instance *instance[MX_REGISTER_DEVICE_CNT]; +static can_instance *instance[MX_REGISTER_DEVICE_CNT]={NULL}; /* ----------------two static function called by CANRegister()-------------------- */ diff --git a/bsp/bsp_can.h b/bsp/bsp_can.h index 5627a2d..35f1457 100644 --- a/bsp/bsp_can.h +++ b/bsp/bsp_can.h @@ -6,7 +6,7 @@ #define MX_REGISTER_DEVICE_CNT 12 // maximum number of device can be registered to CAN service // this number depends on the load of CAN bus. -#define MX_CAN_FILTER_CNT (4 * 14) // temporarily useless +#define MX_CAN_FILTER_CNT (2 * 14) // temporarily useless #define DEVICE_CAN_CNT 2 // CAN1,CAN2 diff --git a/bsp/bsp_can.md b/bsp/bsp_can.md new file mode 100644 index 0000000..6e83cb1 --- /dev/null +++ b/bsp/bsp_can.md @@ -0,0 +1,98 @@ +# bsp_can + +

neozng1@hnu.edu.cn

+ +> TODO: +> +> 1. 增加数据帧的长度定义，使得收发更加灵活，而不是固定的8 bytes +> 2. 增加自动检测ID冲突的log输出。 + +## 代码结构 + +.h文件内包括了外部接口和类型定义,以及模块对应的宏。c文件内为私有函数和外部接口的定义。 + +### 类型定义 + +```c + +#define MX_REGISTER_DEVICE_CNT 12 // maximum number of device can be registered to CAN service, this number depends on the load of CAN bus. +#define MX_CAN_FILTER_CNT (4 * 14) // temporarily useless +#define DEVICE_CAN_CNT 2 // CAN1,CAN2 + +/* can instance typedef, every module registered to CAN should have this variable */ +typedef struct _ +{ + CAN_HandleTypeDef* can_handle; + CAN_TxHeaderTypeDef txconf; + uint32_t tx_id; + uint32_t tx_mailbox; + uint8_t tx_buff[8]; + uint8_t rx_buff[8]; + uint32_t rx_id; + void (*can_module_callback)(struct _*); +} can_instance; + +typedef struct +{ + CAN_HandleTypeDef* can_handle; + uint32_t tx_id; + uint32_t rx_id; + void (*can_module_callback)(can_instance*); +} can_instance_config; + +typedef void (*can_callback)(can_instance*); +``` + +- `MX_REGISTER_DEVICE_CNT`是最大的CAN设备注册数量，当每个设备的发送频率都较高时，设备过多会产生总线拥塞从而出现丢包和数据错误的情况。 +- `MX_CAN_FILTER_CNT`是最大的CAN接收过滤器数量，两个CAN共享标号0~27共28个过滤器。这部分内容比较繁杂，暂时不用理解，有兴趣自行参考MCU的数据手册。当前为简单起见，每个过滤器只设置一组规则用于控制一个id的过滤。 +- `DEVICE_CAN_CNT`是MCU拥有的CAN硬件数量。 + +- `can_instance`是一个CAN实例。注意，CAN作为一个总线设备，一条总线上可以挂载多个设备，因此多个设备可以共享同一个CAN硬件。其成员变量包括发送id，发送邮箱（不需要管，只是一个32位变量，CAN收发器会自动设置其值），发送buff以及接收buff，还有接收id和接收协议解析回调函数。**由于目前使用的设备每个数据帧的长度都是8，因此收发buff长度暂时固定为8**。定义该结构体的时候使用了一个技巧，使得在结构体内部可以用结构体自身的指针作为成员，即`can_module_callback`的定义。 + +- `can_instance_config`是用于初始化CAN实例的结构，在调用CAN实例的初始化函数时传入（下面介绍函数时详细介绍）。 + +- `can_module_callback()`是模块提供给CAN接收中断回调函数使用的协议解析函数指针。对于每个需要CAN的模块，需要定义一个这样的函数用于解包数据。 +- 每个使用CAN外设的module，都需要在其内部定义一个`can_instance`。 + + +### 外部接口 + +```c +void CANRegister(can_instance* instance, can_instance_config config); +void CANTransmit(can_instance* _instance); +``` + +`CANRegister`是用于初始化CAN实例的接口，module层的模块对象（也应当为一个结构体）内要包含一个`usart_instance`。调用时传入实例指针，以及用于初始化的config。`CANRegister`应当在module的初始化函数内被调用，推荐config采用以下的方式定义，更加直观明了： + +```c +can_instance_config config={.can_handle=&hcan1, + .tx_id=0x005, + .rx_id=0x200, + can_module_callback=MotorCallback} +``` + +`CANTransmit()`是通过模块通过其拥有的CAN实例发送数据的接口，调用时传入对应的instance。在发送之前，应当给instance内的`send_buff`赋值。 + +### 私有函数和变量 + +在.c文件内设为static的函数和变量 + +```c +static can_instance *instance[MX_REGISTER_DEVICE_CNT]={NULL}; +``` + +这是bsp层管理所有CAN实例的入口。 + +```c +static void CANServiceInit() +static void CANAddFilter(can_instance *_instance) +static void CANFIFOxCallback(CAN_HandleTypeDef *_hcan, uint32_t fifox) +void HAL_CAN_RxFifo0MsgPendingCallback(CAN_HandleTypeDef *hcan) +void HAL_CAN_RxFifo1MsgPendingCallback(CAN_HandleTypeDef *hcan) +``` + +- `CANServiceInit()`会被`CANRegister()`调用，对CAN外设进行硬件初始化并开启接收中断和消息提醒。 + +- `CANAddFilter()`在每次使用`CANRegister()`的时候被调用，用于给当前注册的实例添加过滤器规则并设定处理对应`rx_id`的接收FIFO。过滤器的作用是减小CAN收发器的压力，只接收符合过滤器规则的报文（否则不会产生接收中断）。 + +- `HAL_CAN_RxFifo0MsgPendingCallback()`和`HAL_CAN_RxFifo1MsgPendingCallback()`都是对HAL的CAN回调函数的重定义（原本的callback是`__week`修饰的弱定义），当发生FIFO0或FIFO1有新消息到达的时候，对应的callback会被调用。`CANFIFOxCallback()`随后被前两者调用，并根据接收id和硬件中断来源（哪一个CAN硬件，CAN1还是CAN2）调用对应的instance的回调函数进行协议解析。 \ No newline at end of file diff --git a/bsp/bsp_usart.c b/bsp/bsp_usart.c index 030ab81..765bd20 100644 --- a/bsp/bsp_usart.c +++ b/bsp/bsp_usart.c @@ -13,7 +13,7 @@ /* usart service instance, modules' info would be recoreded here using USARTRegister() */ /* usart服务实例,所有注册了usart的模块信息会被保存在这里 */ -static usart_instance *instance[DEVICE_USART_CNT]; +static usart_instance *instance[DEVICE_USART_CNT]={NULL}; /** * @brief usart service will start automatically, after each module registered diff --git a/bsp/bsp_usart.md b/bsp/bsp_usart.md new file mode 100644 index 0000000..da7f98a --- /dev/null +++ b/bsp/bsp_usart.md @@ -0,0 +1,69 @@ +# bsp_usart + +

neozng1@hnu.edu.cn

+ +> TODO:为初始化定义一个结构体`usart_init_config`用于保存初始化所需的参数从而避免单独赋值，使得整体风格统一。 + +## 代码结构 + +.h文件内包括了外部接口和类型定义,以及模块对应的宏。c文件内为私有函数和外部接口的定义。 + +### 类型定义 + +```c +#define DEVICE_USART_CNT 3 // C板至多分配3个串口 +#define USART_RXBUFF_LIMIT 128 // if your protocol needs bigger buff, modify here + +typedef void (*usart_module_callback)(); + +/* usart_instance struct,each app would have one instance */ +typedef struct +{ + uint8_t recv_buff[USART_RXBUFF_LIMIT]; // 预先定义的最大buff大小,如果太小请修改USART_RXBUFF_LIMIT + uint8_t recv_buff_size; // 模块接收一包数据的大小 + UART_HandleTypeDef *usart_handle; // 实例对应的usart_handle + usart_module_callback module_callback; // 解析收到的数据的回调函数 +} usart_instance; +``` + +- `DEVICE_USART_CNT`是开发板上可用的串口数量。 + +- `USART_RXBUFF_LIMIT`是串口单次接收的数据长度上限，暂时设为128，如果需要更大的buffer容量，修改该值。 + +- `usart_module_callback()`是模块提供给串口接收中断回调函数使用的协议解析函数指针。对于每个需要串口的模块，需要定义一个这样的函数用于解包数据。 + +- 每定义一个`usart_instance`，就代表一个串口的**实例**（对象）。一个串口实例内有接收buffer，单个数据包的大小，该串口对应的`HAL handle`（代表其使用的串口硬件具体是哪一个）以及用于解包数据的回调函数。 + + +### 外部接口 + +```c +void USARTRegister(usart_instance *_instance); +void USARTSend(usart_instance *_instance, uint8_t *send_buf, uint16_t send_size); +``` + +- `USARTRegister`是用于初始化串口对象的接口，module层的模块对象（也应当为一个结构体）内要包含一个`usart_instance`。 + + **在调用该函数之前，需要先对其成员变量`*usart_handle`,`module_callback()`以及`recv_buff_size`进行赋值。** + +- `USARTSend()`是通过模块通过其拥有的串口对象发送数据的接口，调用时传入的参数为串口实例指针，发送缓存以及此次要发送的数据长度（8-bit\*n)。 + +### 私有函数和变量 + +在.c文件内设为static的函数和变量 + +```c +static usart_instance *instance[DEVICE_USART_CNT]; +``` + +这是bsp层管理所有串口实例的入口。 + +```c +static void USARTServiceInit(usart_instance *_instance) +void HAL_UARTEx_RxEventCallback(UART_HandleTypeDef *huart, uint16_t Size) +void HAL_UART_ErrorCallback(UART_HandleTypeDef *huart) +``` + +- `USARTServiceInit()`会被`USARTRegister()`调用，开启接收中断 + +- `HAL_UARTEx_RxEventCallback()`和`HAL_UART_ErrorCallback()`都是对HAL的回调函数的重定义（原本的callback是`__week`修饰的弱定义），前者在发生**IDLE中断**或**单次DMA传输中断**后会被调用（说明收到了完整的一包数据），随后在里面根据中断来源，调用拥有产生了该中断的模块的协议解析函数进行数据解包；后者在串口传输出错的时候会被调用，重新开启接收。 \ No newline at end of file diff --git a/modules/algorithm/controller.h b/modules/algorithm/controller.h index bf51b1f..578a735 100644 --- a/modules/algorithm/controller.h +++ b/modules/algorithm/controller.h @@ -26,7 +26,7 @@ #endif // PID 优化环节使能标志位 -typedef enum pid_Improvement_e +typedef enum { NONE = 0b00000000, // 0000 0000 Integral_Limit = 0b00000001, // 0000 0001 @@ -103,16 +103,15 @@ typedef struct float Ki; float Kd; - float MaxOut; - float IntegralLimit; - float DeadBand; + float MaxOut; // 输出限幅 + float IntegralLimit; // 积分限幅 + float DeadBand; // 死区 float CoefA; // For Changing Integral float CoefB; // ITerm = Err*((A-abs(err)+B)/A) when B<|err|neozng1@hnu.edu.cn

+ +> TODO: +> +> 1. 给不同的电机设置不同的低通滤波器惯性系数而不是统一使用宏 +> 2. 当前电机初始化函数`DJIMotorInit()`稍显凌乱，应设置一个`dji_motor_init_config_s`结构体用于电机初始化，使得风格统一，提高可读性 + + + +## 总览和封装说明 + +> 如果你不需要理解该模块的工作原理，你只需要查看这一小节。 + +dji_motor模块对DJI智能电机，包括M2006，M3508以及GM6020进行了详尽的封装。你不再需要关心PID的计算以及CAN报文的发送和接收解析，你只需要专注于根据应用层的需求，设定合理的期望值，并通过`DJIMotorSetRef()`设置对应电机的输入参考即可。如果你希望更改电机的反馈来源，比如进入小陀螺模式（这时候你想要云台保持静止，使用IMU的yaw角度值作为反馈来源），只需要调用`DJIMotorChangeFeed()`，电机便可立刻切换反馈数据来源至IMU。 + +要获得一个电机，请通过`DJIMotorInit()`并传入一些参数，他就会返回一个电机的指针。你也不再需要查看这些电机和电调的说明书，**只需要设置其电机id**（6020为拨码开关值，2006和3508为电调的闪动次数），该模块会自动为你计算CAN发送和接收ID并搞定所有硬件层的琐事。 + +初始化电机时，你需要传入的参数包括： + +- 电机挂载的总线设置：CAN1 or CAN2，以及电机的id + +- 电机类型： + + ```c + GM6020 = 0 + M3508 = 1 + M2006 = 2 + ``` + +- 闭环类型 + + ```c + OPEN_LOOP + CURRENT_LOOP + SPEED_LOOP + ANGLE_LOOP + CURRENT_LOOP| SPEED_LOOP // 同时对电流和速度闭环 + SPEED_LOOP | ANGLE_LOOP // 同时对速度和位置闭环 + CURRENT_LOOP| SPEED_LOOP |ANGLE_LOOP // 三环全开 + ``` + +- 是否反转 + + ```c + MOTOR_DIRECTION_NORMAL + MOTOR_DIRECTION_REVERSE + ``` + +- 是否其他反馈来源，以及他们对应的数据指针（如果有的话） + + ```c + MOTOR_FEED = 0 + OTHER_FEED = 1 + --- + float *other_angle_feedback_ptr + float *other_speed_feedback_ptr + // 电流只能从电机传感器获得所以无法设置其他来源 + ``` + +- 每个环的PID参数以及是否使用改进功能 + + ```c + typedef struct // config parameter + { + float Kp; + float Ki; + float Kd; + + float MaxOut; // 输出限幅 + // 以下是优化参数 + float IntegralLimit; // 积分限幅 + float DeadBand; // 死区 + float CoefA; // For Changing Integral + float CoefB; // ITerm = Err*((A-abs(err)+B)/A) when B<|err|