Skip to content

Commit

Permalink
update comment
Browse files Browse the repository at this point in the history
  • Loading branch information
Master Chief committed Dec 23, 2024
1 parent 196f26d commit 8d8f269
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
10 changes: 5 additions & 5 deletions src/lib/mixer_module/params.c
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,16 @@ PARAM_DEFINE_INT32(MC_AIRMODE, 0);
/**
* Multicopter Throttle Reduction for Increased Yaw Actuation
*
* The default behavior for multicopters is to trade altitude (z-thrust) for attitude automatically.
* The default behavior for multicopters is to trade throttle (z-thrust) for attitude automatically.
* This is reasonable for pitch and roll, because it prevents a worsening problem (increasing
* throttle requirements). But this is not always reasonable for yaw actuation.
*
* This gives an alternative to the default behavior where z-thrust is never sacrificed for
* yaw actuation. The idea is to leave it up to the pilot to sacrifice altitude for yaw actuation.
* This gives an alternative to the default behavior, allowing the user to disable sacrificing
* z-thrust for yaw actuation. The idea is to leave it up to the pilot to sacrifice altitude for yaw
* actuation.
*
* If false, Z-thrust is never sacrificed for yaw actuation.
* If true, default behavior. Z-thrust is reduced to make room yaw actuation
* when saturated.
* If true, default behavior. Z-thrust is reduced to make room yaw actuation when saturated.
*
* @boolean
* @group Mixer Output
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,8 +119,7 @@ class ControlAllocationSequentialDesaturation: public ControlAllocationPseudoInv
*
* Desaturation behavior: no airmode, thrust is NEVER increased to meet the demanded
* roll/pitch/yaw. Instead roll/pitch/yaw is reduced as much as needed.
* Thrust can be reduced to unsaturate the upper side, if MC_REDUCE_THRUST is true.
* If MC_REDUCE_THRUST is false, then thrust will not be reduced.
* Thrust can be reduced to unsaturate the upper side.
*
* @see mixYaw() for the exact yaw behavior.
*/
Expand All @@ -135,7 +134,7 @@ class ControlAllocationSequentialDesaturation: public ControlAllocationPseudoInv
* in order to allow some yaw control on the upper end. On the lower end thrust will never
* be increased, but yaw is decreased as much as required.
*
* If MC_REDUCE_THRUST is false, then thrust is not allowed to be decreased for yaw.
* If MC_REDUCE_THRUST is false, then thrust will not be sacrificed for yaw.
*/
void mixYaw();

Expand Down

0 comments on commit 8d8f269

Please sign in to comment.