params: ensure short description is only a single line

So a UI can display it properly
This commit is contained in:
Beat Küng
2021-03-23 12:55:11 -04:00
committed by Daniel Agar
parent 2ab276f5ca
commit 629f7ba15b
25 changed files with 120 additions and 30 deletions
+24 -3
View File
@@ -41,6 +41,7 @@
/**
* Minimum time of arrival delta between non-IMU observations before data is downsampled.
*
* Baro and Magnetometer data will be averaged before downsampling, other data will be point sampled resulting in loss of information.
*
* @group EKF2
@@ -89,6 +90,7 @@ PARAM_DEFINE_FLOAT(EKF2_GPS_DELAY, 110);
/**
* Optical flow measurement delay relative to IMU measurements
*
* Assumes measurement is timestamped at trailing edge of integration period
*
* @group EKF2
@@ -493,6 +495,7 @@ PARAM_DEFINE_INT32(EKF2_MAG_TYPE, 0);
/**
* Horizontal acceleration threshold used by automatic selection of magnetometer fusion method.
*
* This parameter is used when the magnetometer fusion method is set automatically (EKF2_MAG_TYPE = 0). If the filtered horizontal acceleration is greater than this parameter value, then the EKF will use 3-axis magnetomer fusion.
*
* @group EKF2
@@ -505,6 +508,7 @@ PARAM_DEFINE_FLOAT(EKF2_MAG_ACCLIM, 0.5f);
/**
* Yaw rate threshold used by automatic selection of magnetometer fusion method.
*
* This parameter is used when the magnetometer fusion method is set automatically (EKF2_MAG_TYPE = 0). If the filtered yaw rate is greater than this parameter value, then the EKF will use 3-axis magnetomer fusion.
*
* @group EKF2
@@ -945,7 +949,9 @@ PARAM_DEFINE_FLOAT(EKF2_EV_POS_Y, 0.0f);
PARAM_DEFINE_FLOAT(EKF2_EV_POS_Z, 0.0f);
/**
* Airspeed fusion threshold. A value of zero will deactivate airspeed fusion. Any other positive
* Airspeed fusion threshold.
*
* A value of zero will deactivate airspeed fusion. Any other positive
* value will determine the minimum airspeed which will still be fused. Set to about 90% of the vehicles stall speed.
* Both airspeed fusion and sideslip fusion must be active for the EKF to continue navigating after loss of GPS.
* Use EKF2_FUSE_BETA to activate sideslip fusion.
@@ -1122,6 +1128,7 @@ PARAM_DEFINE_FLOAT(EKF2_EVV_GATE, 3.0f);
/**
* Gate size for vision position fusion
*
* Sets the number of standard deviations used by the innovation consistency test.
* @group EKF2
* @min 1.0
@@ -1132,7 +1139,8 @@ PARAM_DEFINE_FLOAT(EKF2_EVP_GATE, 5.0f);
/**
* Specific drag force observation noise variance used by the multi-rotor specific drag force model.
* Increasing it makes the multi-rotor wind estimates adjust more slowly.
*
* Increasing this makes the multi-rotor wind estimates adjust more slowly.
*
* @group EKF2
* @min 0.5
@@ -1144,6 +1152,7 @@ PARAM_DEFINE_FLOAT(EKF2_DRAG_NOISE, 2.5f);
/**
* X-axis ballistic coefficient used by the multi-rotor specific drag force model.
*
* This should be adjusted to minimise variance of the X-axis drag specific force innovation sequence.
*
* @group EKF2
@@ -1156,6 +1165,7 @@ PARAM_DEFINE_FLOAT(EKF2_BCOEF_X, 25.0f);
/**
* Y-axis ballistic coefficient used by the multi-rotor specific drag force model.
*
* This should be adjusted to minimise variance of the Y-axis drag specific force innovation sequence.
*
* @group EKF2
@@ -1179,6 +1189,7 @@ PARAM_DEFINE_FLOAT(EKF2_ASPD_MAX, 20.0f);
/**
* Static pressure position error coefficient for the positive X axis
*
* This is the ratio of static pressure error to dynamic pressure generated by a positive wind relative velocity along the X body axis.
* If the baro height estimate rises during forward flight, then this will be a negative number.
*
@@ -1191,6 +1202,7 @@ PARAM_DEFINE_FLOAT(EKF2_PCOEF_XP, 0.0f);
/**
* Static pressure position error coefficient for the negative X axis.
*
* This is the ratio of static pressure error to dynamic pressure generated by a negative wind relative velocity along the X body axis.
* If the baro height estimate rises during backwards flight, then this will be a negative number.
*
@@ -1203,6 +1215,7 @@ PARAM_DEFINE_FLOAT(EKF2_PCOEF_XN, 0.0f);
/**
* Pressure position error coefficient for the positive Y axis.
*
* This is the ratio of static pressure error to dynamic pressure generated by a wind relative velocity along the positive Y (RH) body axis.
* If the baro height estimate rises during sideways flight to the right, then this will be a negative number.
*
@@ -1215,6 +1228,7 @@ PARAM_DEFINE_FLOAT(EKF2_PCOEF_YP, 0.0f);
/**
* Pressure position error coefficient for the negative Y axis.
*
* This is the ratio of static pressure error to dynamic pressure generated by a wind relative velocity along the negative Y (LH) body axis.
* If the baro height estimate rises during sideways flight to the left, then this will be a negative number.
*
@@ -1227,6 +1241,7 @@ PARAM_DEFINE_FLOAT(EKF2_PCOEF_YN, 0.0f);
/**
* Static pressure position error coefficient for the Z axis.
*
* This is the ratio of static pressure error to dynamic pressure generated by a wind relative velocity along the Z body axis.
*
* @group EKF2
@@ -1237,7 +1252,9 @@ PARAM_DEFINE_FLOAT(EKF2_PCOEF_YN, 0.0f);
PARAM_DEFINE_FLOAT(EKF2_PCOEF_Z, 0.0f);
/**
* Accelerometer bias learning limit. The ekf delta velocity bias states will be limited to within a range equivalent to +- of this value.
* Accelerometer bias learning limit.
*
* The ekf delta velocity bias states will be limited to within a range equivalent to +- of this value.
*
* @group EKF2
* @min 0.0
@@ -1249,6 +1266,7 @@ PARAM_DEFINE_FLOAT(EKF2_ABL_LIM, 0.4f);
/**
* Maximum IMU accel magnitude that allows IMU bias learning.
*
* If the magnitude of the IMU accelerometer vector exceeds this value, the EKF delta velocity state estimation will be inhibited.
* This reduces the adverse effect of high manoeuvre accelerations and IMU nonlinerity and scale factor errors on the delta velocity bias estimates.
*
@@ -1262,6 +1280,7 @@ PARAM_DEFINE_FLOAT(EKF2_ABL_ACCLIM, 25.0f);
/**
* Maximum IMU gyro angular rate magnitude that allows IMU bias learning.
*
* If the magnitude of the IMU angular rate vector exceeds this value, the EKF delta velocity state estimation will be inhibited.
* This reduces the adverse effect of rapid rotation rates and associated errors on the delta velocity bias estimates.
*
@@ -1275,6 +1294,7 @@ PARAM_DEFINE_FLOAT(EKF2_ABL_GYRLIM, 3.0f);
/**
* Time constant used by acceleration and angular rate magnitude checks used to inhibit delta velocity bias learning.
*
* The vector magnitude of angular rate and acceleration used to check if learning should be inhibited has a peak hold filter applied to it with an exponential decay.
* This parameter controls the time constant of the decay.
*
@@ -1342,6 +1362,7 @@ PARAM_DEFINE_INT32(EKF2_SYNT_MAG_Z, 0);
/**
* Default value of true airspeed used in EKF-GSF AHRS calculation.
*
* If no airspeed measurements are avalable, the EKF-GSF AHRS calculation will assume this value of true airspeed when compensating for centripetal acceleration during turns. Set to zero to disable centripetal acceleration compensation during fixed wing flight modes.
*
* @group EKF2