diff --git a/libraries/APM_Control/AP_YawController.cpp b/libraries/APM_Control/AP_YawController.cpp index 6d6a67156c..5864668aec 100644 --- a/libraries/APM_Control/AP_YawController.cpp +++ b/libraries/APM_Control/AP_YawController.cpp @@ -16,10 +16,35 @@ extern const AP_HAL::HAL& hal; const AP_Param::GroupInfo AP_YawController::var_info[] PROGMEM = { - AP_GROUPINFO("K_A", 0, AP_YawController, _K_A, 0), - AP_GROUPINFO("K_I", 1, AP_YawController, _K_I, 0), - AP_GROUPINFO("K_D", 2, AP_YawController, _K_D, 0), - AP_GROUPINFO("K_RLL", 3, AP_YawController, _K_FF, 1), + + // @Param: K_A + // @DisplayName: Sideslip control gain + // @Description: This is the gain from measured lateral acceleration to demanded yaw rate. It should be set to zero unless active control of sideslip is desired. This will only work effectively if there is enough fuselage side area to generate a measureable lateral acceleration when the model sideslips. Flying wings and most gliders cannot use this term. This term should only be adjusted after the basic yaw damper gain K_D is tuned and the K_I integrator gain has been set. Set this gain to zero if only yaw damping is required. + // @Range: 0 4 + // @Increment: 0.25 + AP_GROUPINFO("K_A", 0, AP_YawController, _K_A, 0), + + // @Param: K_I + // @DisplayName: Sidelsip control integrator + // @Description: This is the integral gain from lateral acceleration error. This gain should only be non-zero if active control over sideslip is desired. If active control over sideslip is required then this can be set to 1.0 as a first try. + // @Range: 0 2 + // @Increment: 0.25 + AP_GROUPINFO("K_I", 1, AP_YawController, _K_I, 0), + + // @Param: K_D + // @DisplayName: Yaw damping + // @Description: This is the gain from yaw rate to rudder. It acts as a damper on yaw motion. If a basic yaw damper is required, this gain term can be incremented, whilst leaving the K_A and K_I gains at zero. + // @Range: 0 2 + // @Increment: 0.25 + AP_GROUPINFO("K_D", 2, AP_YawController, _K_D, 0), + + // @Param: K_RLL + // @DisplayName: Yaw coordination gain + // @Description: This is the gain term that is applied to the yaw rate offset calculated as required to keep the yaw rate consistent with the turn rate for a coordinated turn. The default value is 1 which will work for all models. Advanced users can use it to correct for any tendency to yaw away from or into the turn once the turn is established. Increase to make the model yaw more initially and decrease to make the model yaw less initially. If values greater than 1.1 or less than 0.9 are required then it normally indicates a problem with the airspeed calibration. + // @Range: 0.8 1.2 + // @Increment: 0.05 + AP_GROUPINFO("K_RLL", 3, AP_YawController, _K_FF, 1), + AP_GROUPEND };