mc_pos_control: shorten parameter descriptions to a readable size

This commit is contained in:
Matthias Grob
2024-12-19 16:12:43 +01:00
parent 1239f0aaed
commit ad799b64b7
3 changed files with 19 additions and 24 deletions
@@ -73,15 +73,13 @@ PARAM_DEFINE_FLOAT(MPC_MAN_Y_TAU, 0.08f);
/** /**
* Altitude reference mode * Altitude reference mode
* *
* Set to 0 to control height relative to the earth frame origin. This origin may move up and down in * Control height
* flight due to sensor drift. * 0: relative earth frame origin which may drift due to sensors
* Set to 1 to control height relative to estimated distance to ground. The vehicle will move up and down * 1: relative to ground (requires distance sensor) which changes with terrain variation.
* with terrain height variation. Requires a distance to ground sensor. The height controller will * It will revert to relative earth frame if the distance to ground estimate becomes invalid.
* revert to using height above origin if the distance to ground estimate becomes invalid as indicated * 2: relative to ground (requires distance sensor) when stationary
* by the local_position.distance_bottom_valid message being false. * and relative to earth frame when moving horizontally.
* Set to 2 to control height relative to ground (requires a distance sensor) when stationary and relative * The speed threshold is MPC_HOLD_MAX_XY
* to earth frame origin when moving horizontally.
* The speed threshold is controlled by the MPC_HOLD_MAX_XY parameter.
* *
* @min 0 * @min 0
* @max 2 * @max 2
@@ -35,12 +35,12 @@
* Position/Altitude mode variant * Position/Altitude mode variant
* *
* The supported sub-modes are: * The supported sub-modes are:
* - "Direct velocity": * Direct velocity:
* Sticks directly map to velocity setpoints without smoothing. * Sticks directly map to velocity setpoints without smoothing.
* Also applies to vertical direction and Altitude mode. * Also applies to vertical direction and Altitude mode.
* Useful for velocity control tuning. * Useful for velocity control tuning.
* - "Acceleration based": * Acceleration based:
* Sticks map to acceleration and there's a virtual brake drag * Sticks map to acceleration and there's a virtual brake drag
* *
* @value 0 Direct velocity * @value 0 Direct velocity
* @value 4 Acceleration based * @value 4 Acceleration based
@@ -114,9 +114,8 @@ PARAM_DEFINE_FLOAT(MPC_ACC_HOR_MAX, 5.f);
/** /**
* Maximum horizontal and vertical jerk in Position/Altitude mode * Maximum horizontal and vertical jerk in Position/Altitude mode
* *
* Limit the maximum jerk of the vehicle (how fast the acceleration can change). * Limit the maximum jerk (acceleration change) of the vehicle.
* A lower value leads to smoother motions but limits agility * A lower value leads to smoother motions but limits agility.
* (how fast it can change directions or break).
* *
* Setting this to the maximum value essentially disables the limit. * Setting this to the maximum value essentially disables the limit.
* *
@@ -75,18 +75,16 @@ PARAM_DEFINE_FLOAT(MPC_MANTHR_MIN, 0.08f);
/** /**
* Thrust curve mapping in Stabilized Mode * Thrust curve mapping in Stabilized Mode
* *
* This parameter defines how the throttle stick input is mapped to collective thrust * Defines how the throttle stick is mapped to collective thrust in Stabilized mode.
* in Stabilized mode.
* *
* In case the default is used ('Rescale to hover thrust'), the stick input is linearly * Rescale to hover thrust:
* rescaled, such that a centered stick corresponds to the hover throttle (see MPC_THR_HOVER). * Stick input is linearly rescaled, such that a centered stick corresponds to the hover throttle (see MPC_THR_HOVER).
* *
* Select 'No Rescale' to directly map the stick 1:1 to the output. This can be useful * No Rescale:
* in case the hover thrust is very low and the default would lead to too much distortion * Directly map the stick 1:1 to the output.
* (e.g. if hover thrust is set to 20%, then 80% of the upper thrust range is squeezed into the * Can be useful with very low hover thrust which leads to much distortion and the upper half getting sensitive.
* upper half of the stick range).
* *
* Note: In case MPC_THR_HOVER is set to 50%, the modes 0 and 1 are the same. * With MPC_THR_HOVER 0.5 both modes are the same.
* *
* @value 0 Rescale to hover thrust * @value 0 Rescale to hover thrust
* @value 1 No Rescale * @value 1 No Rescale