Skip to content

Commit

Permalink
improved GCS parameter description
Browse files Browse the repository at this point in the history
incoperated feedback

sd
  • Loading branch information
Claudio-Chies committed Jul 12, 2024
1 parent 8221940 commit 186a62c
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ PARAM_DEFINE_INT32(MPC_ALT_MODE, 2);
/**
* Maximum horizontal velocity for which position hold is enabled (use 0 to disable check)
*
* Only used with MPC_POS_MODE 0 or MPC_ALT_MODE 2
* Only used with MPC_POS_MODE Direct velocity or MPC_ALT_MODE 2
*
* @unit m/s
* @min 0
Expand Down
2 changes: 1 addition & 1 deletion src/modules/mc_pos_control/multicopter_autonomous_params.c
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ PARAM_DEFINE_FLOAT(MPC_Z_V_AUTO_DN, 1.5f);
/**
* Acceleration for autonomous and for manual modes
*
* When piloting manually, this parameter is only used in MPC_POS_MODE 4.
* When piloting manually, this parameter is only used in MPC_POS_MODE Acceleration based.
*
* @unit m/s^2
* @min 2
Expand Down
17 changes: 10 additions & 7 deletions src/modules/mc_pos_control/multicopter_position_mode_params.c
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,15 @@
* Position/Altitude mode variant
*
* The supported sub-modes are:
* 0 Sticks directly map to velocity setpoints without smoothing.
* Also applies to vertical direction and Altitude mode.
* Useful for velocity control tuning.
* 3 Sticks map to velocity but with maximum acceleration and jerk limits based on
* jerk optimized trajectory generator (different algorithm than 1).
* 4 Sticks map to acceleration and there's a virtual brake drag
* "Direct velocity"
* Sticks directly map to velocity setpoints without smoothing.
* Also applies to vertical direction and Altitude mode.
* Useful for velocity control tuning.
* "Smoothed velocity"
* Sticks map to velocity but with maximum acceleration and jerk limits based on
* jerk optimized trajectory generator (different algorithm than 1).
* "Acceleration based"
* Sticks map to acceleration and there's a virtual brake drag
*
* @value 0 Direct velocity
* @value 3 Smoothed velocity
Expand Down Expand Up @@ -122,7 +125,7 @@ PARAM_DEFINE_FLOAT(MPC_ACC_HOR_MAX, 5.f);
*
* Setting this to the maximum value essentially disables the limit.
*
* Only used with smooth MPC_POS_MODE 3 and 4.
* Only used with smooth MPC_POS_MODE Smoothed velocity and Acceleration based.
*
* @unit m/s^3
* @min 0.5
Expand Down

0 comments on commit 186a62c

Please sign in to comment.