refactor(FOC): 添加Doxygen文档注释并优化SVPWM算法性能
添加了完整的Doxygen文档注释到FOC算法模块的所有函数、类和变量，提升了代码可读性和维护性。同时优化了SVPWM算法实现，将atan2f替换为符号法扇区判断，显著提升计算效率（约15周期vs atan2f 300周期），并改进了arm_sin_cos_f32替代sqrtf提高性能。 feat(FOC): 统一电气角度计算避免重复运算 重构代码以统一电气角度计算，在各个控制循环中只计算一次电气角度并传递给需要的函数，避免了多次重复的fmodf运算和角度归一化操作，提升了实时控制性能。 refactor(Filter): 改进α-β观测器角度处理精度 修改角度卡尔曼滤波器在归一化角度空间[0,360)内工作，避免大累积角度的浮点精度损失问题，确保静止状态下不会产生虚假速度，同时保持与下游代码的兼容性。 refactor: 为算法模块添加完整文档注释 为所有算法模块(FOC、Filter、pid、thermal)添加了详细的Doxygen文档注释，包括函数说明、参数描述、返回值说明等，便于代码理解和API文档生成。
This commit is contained in:
+116
-5
@@ -1,3 +1,9 @@
|
||||
/**
|
||||
* @file Algorithm/FOC.h
|
||||
* @brief 算法模块源文件
|
||||
* @note 本文件仅补充 Doxygen 文档注释，不改变代码逻辑。
|
||||
*/
|
||||
|
||||
// 函数声明
|
||||
#ifndef _FOC_H
|
||||
#define _FOC_H
|
||||
@@ -5,12 +11,19 @@
|
||||
#include "pid.h"
|
||||
#include <cstdint>
|
||||
|
||||
/**
|
||||
* @brief FOC_Controller 类或结构体
|
||||
*/
|
||||
class FOC_Controller {
|
||||
|
||||
public:
|
||||
FOC_Controller();
|
||||
|
||||
// 初始化函数
|
||||
/**
|
||||
* @brief 初始化对象或模块
|
||||
* @return u8 返回值
|
||||
*/
|
||||
u8 init();
|
||||
|
||||
u8 control_mode = 0;
|
||||
@@ -53,22 +66,88 @@ class FOC_Controller {
|
||||
float vel_MIT_p = DEFAULT_vel_MIT_p;
|
||||
float cur_MIT_p = DEFAULT_current_MIT_p;
|
||||
|
||||
/**
|
||||
* @brief velocity_open_loop 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float velocity_open_loop(void);
|
||||
/**
|
||||
* @brief angle_control 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float angle_control(void);
|
||||
/**
|
||||
* @brief angle_control_with_velocity_limit 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float angle_control_with_velocity_limit(void);
|
||||
/**
|
||||
* @brief MIT_Mode 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float MIT_Mode(void);
|
||||
/**
|
||||
* @brief velocity_control 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float velocity_control(void);
|
||||
/**
|
||||
* @brief current_control 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float current_control(void);
|
||||
|
||||
/**
|
||||
* @brief 更新 power 相关状态
|
||||
* @param[in] voltage 参数
|
||||
* @return void
|
||||
*/
|
||||
void update_power(float voltage);
|
||||
/**
|
||||
* @brief DFOC_alignSensor 函数
|
||||
* @param[in] _PP 参数
|
||||
* @return void
|
||||
*/
|
||||
void DFOC_alignSensor(int _PP);
|
||||
/**
|
||||
* @brief shut_down 函数
|
||||
* @return void
|
||||
*/
|
||||
void shut_down(void);
|
||||
/**
|
||||
* @brief resume 函数
|
||||
* @return void
|
||||
*/
|
||||
void resume(void);
|
||||
/**
|
||||
* @brief drv_stop 函数
|
||||
* @return void
|
||||
*/
|
||||
void drv_stop(void);
|
||||
/**
|
||||
* @brief drv_hold 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float drv_hold(void);
|
||||
/**
|
||||
* @brief PWM_out 函数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float PWM_out(void);
|
||||
/**
|
||||
* @brief shut_down_thermal 函数
|
||||
* @return void
|
||||
*/
|
||||
void shut_down_thermal(void); // 过热关机
|
||||
/**
|
||||
* @brief resume_from_thermal 函数
|
||||
* @return void
|
||||
*/
|
||||
void resume_from_thermal(void); // 过热恢复
|
||||
/**
|
||||
* @brief fast_voltage_check 函数
|
||||
* @return void
|
||||
*/
|
||||
void fast_voltage_check(void); // 快速电压检测（100us周期调用）
|
||||
|
||||
// 齿槽转矩补偿
|
||||
@@ -76,13 +155,25 @@ class FOC_Controller {
|
||||
float cogging_comp_scale = COGGING_COMP_SCALE;
|
||||
float cogging_table[COGGING_TABLE_SIZE] = {0}; // 齿槽补偿表-正转 (mA)
|
||||
float cogging_table_rev[COGGING_TABLE_SIZE] = {0}; // 齿槽补偿表-反转 (mA)
|
||||
/**
|
||||
* @brief 获取 get_cogging_compensation 对应的数据或状态
|
||||
* @param[in] angle_el 参数
|
||||
* @return float 返回值
|
||||
*/
|
||||
inline float get_cogging_compensation(float angle_el);
|
||||
|
||||
// === 校准相关（DEBUG，平时不启用）===
|
||||
// 启用方法：config.h 中 FOC_DEBUG 改为 1
|
||||
#if FOC_DEBUG
|
||||
volatile bool cogging_calib_request = false;
|
||||
/**
|
||||
* @brief calibrate_cogging_tick 函数
|
||||
* @return void
|
||||
*/
|
||||
void calibrate_cogging_tick(void);
|
||||
/**
|
||||
* @brief CogCalibState 枚举定义
|
||||
*/
|
||||
enum class CogCalibState : u8 {
|
||||
IDLE = 0,
|
||||
SETTLING,
|
||||
@@ -128,6 +219,10 @@ class FOC_Controller {
|
||||
DEFAULT_current_loop_p * 100 / limit_voltage, current_loop_Ki,
|
||||
current_loop_Kd, 1500, voltage_power_supply}; // 12V
|
||||
|
||||
/**
|
||||
* @brief 更新 pid_limits 相关状态
|
||||
* @return void
|
||||
*/
|
||||
void update_pid_limits() {
|
||||
vel_loop.limit = voltage_power_supply;
|
||||
angle_loop.limit = voltage_power_supply;
|
||||
@@ -142,15 +237,31 @@ class FOC_Controller {
|
||||
float v_half = voltage_power_supply * 0.5f; // 电源电压的一半
|
||||
float startup_ramp_val = 0.0f; // 软启动系数
|
||||
float startup_ramp_step = 0.01f; // 启动斜坡步长，可调节以控制启动速度
|
||||
void setSVPWM_PhaseVoltage(float Uq, float Ud);
|
||||
float cal_Iq_Id(float current_a, float current_b, float current_c);
|
||||
/**
|
||||
* @brief 设置 setSVPWM_PhaseVoltage 对应的参数或状态
|
||||
* @param[in] Uq 参数
|
||||
* @param[in] Ud 参数
|
||||
* @param[in] angle_el 参数
|
||||
* @return void
|
||||
*/
|
||||
void setSVPWM_PhaseVoltage(float Uq, float Ud, float angle_el);
|
||||
/**
|
||||
* @brief cal_Iq_Id 函数
|
||||
* @param[in] current_a 参数
|
||||
* @param[in] current_b 参数
|
||||
* @param[in] current_c 参数
|
||||
* @param[in] angle_el 参数
|
||||
* @return float 返回值
|
||||
*/
|
||||
float cal_Iq_Id(float current_a, float current_b, float current_c, float angle_el);
|
||||
};
|
||||
|
||||
// 定义函数指针类型
|
||||
typedef float (FOC_Controller::*FOCFunctionPtr)(void);
|
||||
|
||||
/**
|
||||
* @brief calibrate_zero_position 函数
|
||||
* @return void
|
||||
*/
|
||||
void calibrate_zero_position(void);
|
||||
inline float _normalizeAngle(float angle);
|
||||
inline float _electricalAngle();
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user