AirspeedSelector: improve/shorten param descriptions

Signed-off-by: Silvan Fuhrer <silvan@auterion.com>
This commit is contained in:
Silvan Fuhrer
2023-09-29 11:07:46 +02:00
parent 700402a031
commit 8bc3785345
@@ -1,6 +1,6 @@
/** /**
* Airspeed Selector: Wind estimator wind process noise noise spectral density * Wind estimator wind process noise spectral density
* *
* Wind process noise of the internal wind estimator(s) of the airspeed selector. * Wind process noise of the internal wind estimator(s) of the airspeed selector.
* When unaided, the wind estimate uncertainty (1-sigma, in m/s) increases by this amount every second. * When unaided, the wind estimate uncertainty (1-sigma, in m/s) increases by this amount every second.
@@ -14,7 +14,7 @@
PARAM_DEFINE_FLOAT(ASPD_WIND_NSD, 1.e-2f); PARAM_DEFINE_FLOAT(ASPD_WIND_NSD, 1.e-2f);
/** /**
* Airspeed Selector: Wind estimator true airspeed scale process noise spectral density * Wind estimator true airspeed scale process noise spectral density
* *
* Airspeed scale process noise of the internal wind estimator(s) of the airspeed selector. * Airspeed scale process noise of the internal wind estimator(s) of the airspeed selector.
* When unaided, the scale uncertainty (1-sigma, unitless) increases by this amount every second. * When unaided, the scale uncertainty (1-sigma, unitless) increases by this amount every second.
@@ -28,7 +28,7 @@ PARAM_DEFINE_FLOAT(ASPD_WIND_NSD, 1.e-2f);
PARAM_DEFINE_FLOAT(ASPD_SCALE_NSD, 1.e-4f); PARAM_DEFINE_FLOAT(ASPD_SCALE_NSD, 1.e-4f);
/** /**
* Airspeed Selector: Wind estimator true airspeed measurement noise * Wind estimator true airspeed measurement noise
* *
* True airspeed measurement noise of the internal wind estimator(s) of the airspeed selector. * True airspeed measurement noise of the internal wind estimator(s) of the airspeed selector.
* *
@@ -41,7 +41,7 @@ PARAM_DEFINE_FLOAT(ASPD_SCALE_NSD, 1.e-4f);
PARAM_DEFINE_FLOAT(ASPD_TAS_NOISE, 1.4f); PARAM_DEFINE_FLOAT(ASPD_TAS_NOISE, 1.4f);
/** /**
* Airspeed Selector: Wind estimator sideslip measurement noise * Wind estimator sideslip measurement noise
* *
* Sideslip measurement noise of the internal wind estimator(s) of the airspeed selector. * Sideslip measurement noise of the internal wind estimator(s) of the airspeed selector.
* *
@@ -54,7 +54,7 @@ PARAM_DEFINE_FLOAT(ASPD_TAS_NOISE, 1.4f);
PARAM_DEFINE_FLOAT(ASPD_BETA_NOISE, 0.3f); PARAM_DEFINE_FLOAT(ASPD_BETA_NOISE, 0.3f);
/** /**
* Airspeed Selector: Gate size for true airspeed fusion * Gate size for true airspeed fusion
* *
* Sets the number of standard deviations used by the innovation consistency test. * Sets the number of standard deviations used by the innovation consistency test.
* *
@@ -66,7 +66,7 @@ PARAM_DEFINE_FLOAT(ASPD_BETA_NOISE, 0.3f);
PARAM_DEFINE_INT32(ASPD_TAS_GATE, 3); PARAM_DEFINE_INT32(ASPD_TAS_GATE, 3);
/** /**
* Airspeed Selector: Gate size for sideslip angle fusion * Gate size for sideslip angle fusion
* *
* Sets the number of standard deviations used by the innovation consistency test. * Sets the number of standard deviations used by the innovation consistency test.
* *
@@ -148,7 +148,6 @@ PARAM_DEFINE_INT32(ASPD_PRIMARY, 1);
* Enable checks on airspeed sensors * Enable checks on airspeed sensors
* *
* Controls which checks are run to check airspeed data for validity. Only applied if ASPD_PRIMARY > 0. * Controls which checks are run to check airspeed data for validity. Only applied if ASPD_PRIMARY > 0.
* Note that the data missing check is enabled if any of the options is set.
* *
* @min 0 * @min 0
* @max 15 * @max 15
@@ -232,7 +231,7 @@ PARAM_DEFINE_INT32(ASPD_FS_T_START, -1);
* Horizontal wind uncertainty threshold for synthetic airspeed. * Horizontal wind uncertainty threshold for synthetic airspeed.
* *
* The synthetic airspeed estimate (from groundspeed and heading) will be declared valid * The synthetic airspeed estimate (from groundspeed and heading) will be declared valid
* as soon and as long the horizontal wind uncertainty drops below this value. * as soon and as long the horizontal wind uncertainty is below this value.
* *
* @unit m/s * @unit m/s
* @min 0.001 * @min 0.001