Split autotuning into three docs, currently duplicates (PX4#3279)

edurdag · Jul 10, 2024 · 05699d7 · 05699d7
1 parent 6bf2de7
commit 05699d7
Show file tree

Hide file tree

Showing 23 changed files with 53 additions and 26 deletions.
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -22,6 +22,7 @@
     - [Throw Launch](flight_modes_mc/throw_launch.md)
   - [Assembly](assembly/assembly_mc.md) 
   - [Configuration/Tuning](config_mc/index.md)
+    - [Auto-tune](config/autotune_mc.md)
     - [Filter/Control Latency Tuning](config_mc/filter_tuning.md)
     - [PID Tuning (Manual/Basic)](config_mc/pid_tuning_guide_multicopter_basic.md)
     - [PID Tuning Guide (Manual/Advanced)](config_mc/pid_tuning_guide_multicopter.md)
@@ -54,6 +55,7 @@
 - [Planes (Fixed-Wing)](frames_plane/index.md)
   - [Assembly](assembly/assembly_fw.md)
   - [Config/Tuning](config_fw/index.md)
+    - [Auto-tune](config/autotune_fw.md)
     - [Rate/Attitude Controller Tuning Guide](config_fw/pid_tuning_guide_fixedwing.md)
     - [Altitude/Position Controller Tuning Guide](config_fw/position_tuning_guide_fixedwing.md)
     - [Weight & Altitude Tuning](config_fw/weight_and_altitude_tuning.md)
@@ -80,6 +82,7 @@
 - [VTOL](frames_vtol/index.md)
   - [Assembly](assembly/assembly_vtol.md)
   - [VTOL Config/Tuning](config_vtol/index.md)
+    - [Auto-tune](config/autotune_vtol.md)
     - [QuadPlane Configuration](config_vtol/vtol_quad_configuration.md)
     - [Back-transition Tuning](config_vtol/vtol_back_transition_tuning.md)
     - [VTOL w/o Airspeed Sensor](config_vtol/vtol_without_airspeed_sensor.md)
@@ -364,7 +367,6 @@
   - [Serial Port Configuration](peripherals/serial_configuration.md)
   - [PX4 Ethernet Setup](advanced_config/ethernet_setup.md)
   - [Standard Configuration](config/index.md)
-    - [Autotune](config/autotune.md)
   - [Advanced Configuration](advanced_config/index.md)
     - [ECL/EKF Overview & Tuning](advanced_config/tuning_the_ecl_ekf.md)
     - [Finding/Updating Parameters](advanced_config/parameters.md)

diff --git a/en/config/autotune.md → en/config/_autotune.md b/en/config/autotune.md → en/config/_autotune.md
diff --git a/en/config/autotune_fw.md b/en/config/autotune_fw.md
@@ -0,0 +1,6 @@
+---
+frame: Plane
+newEditLink: en/config/_autotune.md
+---
+
+<!--@include: _autotune.md-->
diff --git a/en/config/autotune_mc.md b/en/config/autotune_mc.md
@@ -0,0 +1,6 @@
+---
+frame: Multicopter
+newEditLink: en/config/_autotune.md
+---
+
+<!--@include: _autotune.md-->
diff --git a/en/config/autotune_vtol.md b/en/config/autotune_vtol.md
@@ -0,0 +1,6 @@
+---
+frame: VTOL
+newEditLink: en/config/_autotune.md
+---
+
+<!--@include: _autotune.md-->
diff --git a/en/config/index.md b/en/config/index.md
@@ -55,7 +55,11 @@ Joystick/GamePad:
 
 ### Tuning
 
-- [Autotune](../config/autotune.md) (Recommended on vehicles and frames that support it)
+Auto-tuning is supported, and recommended, on the following frames:
+
+- [Autotune (Multicopter)](../config/autotune_mc.md) 
+- [Autotune (Fixed Wing)](../config/autotune_fw.md)
+- [Autotune (VTOL)](../config/autotune_vtol.md)
 
 ## Video Guide
 

diff --git a/en/config_fw/index.md b/en/config_fw/index.md
@@ -9,7 +9,7 @@ This topic is the recommended entry point when performing first-time configurati
 The main steps are:
 
 - [Standard Configuration](../config/index.md)
-- [Autotune](../config/autotune.md) - PID Tuning
+- [Autotune](../config/autotune_fw.md) - PID Tuning
 
   ::: info
   Autotune simplifies the manual process described in: [Fixed-wing Rate/Attitude Controller Tuning Guide](../config_fw/pid_tuning_guide_fixedwing.md).

diff --git a/en/config_fw/pid_tuning_guide_fixedwing.md b/en/config_fw/pid_tuning_guide_fixedwing.md
@@ -4,7 +4,7 @@ This guide explains how to manually tune the fixed-wing PID loop.
 It is intended for advanced users / experts, as incorrect PID tuning may crash your aircraft.
 
 ::: info
-[Autotune](../config/autotune.md) is recommended for most users, as it is far faster, easier and provides good tuning for most frames.
+[Autotune](../config/autotune_fw.md) is recommended for most users, as it is far faster, easier and provides good tuning for most frames.
 Manual tuning is recommended for frames where autotuning does not work, or where fine-tuning is essential.
 :::
 

diff --git a/en/config_mc/index.md b/en/config_mc/index.md
@@ -118,16 +118,20 @@ PX4 can be configured to automatically handle conditions such as low battery, lo
 Tuning is the final step, carried out only after most other setup and configuration is complete.
 
 - Rate and attitude controllers:
-- [Autotune](../config/autotune.md) — Automates tuning PX4 rate and attitude controllers (recommended).
+- [Autotune](../config/autotune_mc.md) — Automates tuning PX4 rate and attitude controllers (recommended).
 
   ::: info
   Automatic tuning works on frames that have reasonable authority and dynamics around all the body axes.
   It has primarily been tested on racing quads and X500, and is expected to be less effective on tricopters with a tiltable rotor.
-  The other two guides are only needed if there is a problem with autotune.
+
+  Manual tuning using these guides are only needed if there is a problem with autotune:
+
+  - [MC PID Tuning (Manual/Basic)](../config_mc/pid_tuning_guide_multicopter_basic.md) — Manual tuning basic how to.
+  - [MC PID Tuning Guide (Manual/Detailed)](../config_mc/pid_tuning_guide_multicopter.md) — Manual tuning with detailed explanation.
+
   :::
 
-- [MC PID Tuning (Manual/Basic)](../config_mc/pid_tuning_guide_multicopter_basic.md) — Manual tuning basic how to.
-- [MC PID Tuning Guide (Manual/Detailed)](../config_mc/pid_tuning_guide_multicopter.md) — Manual tuning with detailed explanation.
+
 - [MC Filter/Control Latency Tuning](../config_mc/filter_tuning.md) — Trade off control latency and noise filtering.
 - [MC Setpoint Tuning (Trajectory Generator)](../config_mc/mc_trajectory_tuning.md)
   - [MC Jerk-limited Type Trajectory](../config_mc/mc_jerk_limited_type_trajectory.md)

diff --git a/en/config_mc/pid_tuning_guide_multicopter.md b/en/config_mc/pid_tuning_guide_multicopter.md
@@ -3,7 +3,7 @@
 This topic provides detailed information about PX4 controllers, and how they are tuned.
 
 :::tip
-[Autotune](../config/autotune.md) is recommended for tuning the vehicles _around the hover thrust point_, as the approach described is intuitive, easy, and fast.
+[Autotune](../config/autotune_mc.md) is recommended for tuning the vehicles _around the hover thrust point_, as the approach described is intuitive, easy, and fast.
 This is all that is required for many vehicles.
 :::
 

diff --git a/en/config_mc/pid_tuning_guide_multicopter_basic.md b/en/config_mc/pid_tuning_guide_multicopter_basic.md
@@ -3,7 +3,7 @@
 This tutorial explains how to _manually_ tune the PID loops on PX4 for all [multicopter setups](../airframes/airframe_reference.md#copter) (Quads, Hexa, Octo etc).
 
 :::tip
-[Autotune](../config/autotune.md) is recommended for most users, as it is far faster, easier and provides good tuning for most frames.
+[Autotune](../config/autotune_mc.md) is recommended for most users, as it is far faster, easier and provides good tuning for most frames.
 Manual tuning is recommended for frames where autotuning does not work, or where fine-tuning is essential.
 :::
 

diff --git a/en/dev_airframes/adding_a_new_frame.md b/en/dev_airframes/adding_a_new_frame.md
@@ -316,10 +316,9 @@ If the airframe is for a **new group** you additionally need to:
 
 The following topics explain how to tune the parameters that will be specified in the config file:
 
-- [Autotuning](../config/autotune.md)
-- [Multicopter PID Tuning Guide](../config_mc/pid_tuning_guide_multicopter.md)
-- [Fixed-wing PID Tuning Guide](../config_fw/pid_tuning_guide_fixedwing.md)
-- [VTOL Configuration](../config_vtol/index.md)
+- [Autotuning (Multicopter)](../config/autotune_mc.md) (or [Multicopter PID Tuning Guide](../config_mc/pid_tuning_guide_multicopter.md))
+- [Autotuning (Fixed-wing)](../config/autotune_fw.md) (or [Fixed-wing PID Tuning Guide](../config_fw/pid_tuning_guide_fixedwing.md))
+- [Autotuning (VTOL)](../config/autotune_vtol.md) ([VTOL Configuration](../config_vtol/index.md))
 
 ## Add Frame to QGroundControl
 

diff --git a/en/frames_multicopter/dji_f450_cuav_5nano.md b/en/frames_multicopter/dji_f450_cuav_5nano.md
@@ -217,7 +217,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These may be good enough to fly with, but you should tune each frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
 
 
 ## Video

diff --git a/en/frames_multicopter/dji_f450_cuav_5plus.md b/en/frames_multicopter/dji_f450_cuav_5plus.md
@@ -218,7 +218,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These may be good enough to fly with, but you should tune each frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
 
 ## Video
 

diff --git a/en/frames_multicopter/holybro_qav250_pixhawk4_mini.md b/en/frames_multicopter/holybro_qav250_pixhawk4_mini.md
@@ -241,7 +241,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These may be good enough to fly with, but you should tune each frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
 
 
 ## Acknowledgements

diff --git a/en/frames_multicopter/holybro_s500_v2_pixhawk4.md b/en/frames_multicopter/holybro_s500_v2_pixhawk4.md
@@ -311,7 +311,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These are good enough to fly with, but it is a good idea to tune the parameters for a specific frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
 
 ## Acknowledgements
 

diff --git a/en/frames_multicopter/holybro_x500V2_pixhawk5x.md b/en/frames_multicopter/holybro_x500V2_pixhawk5x.md
@@ -237,7 +237,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These are good enough to fly with, but it is a good idea to tune the parameters for a specific frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
 
 ## Acknowledgements
 

diff --git a/en/frames_multicopter/holybro_x500_pixhawk4.md b/en/frames_multicopter/holybro_x500_pixhawk4.md
@@ -256,7 +256,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These are good enough to fly with, but it is a good idea to tune the parameters for a specific frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
 
 ## Acknowledgements
 

diff --git a/en/frames_multicopter/holybro_x500v2_pixhawk6c.md b/en/frames_multicopter/holybro_x500v2_pixhawk6c.md
@@ -210,7 +210,7 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These are good enough to fly with, but it is a good idea to tune the parameters for a specific frame build.
 
-For instructions on how, start from [Auto-tune](../config/autotune.md).
+For instructions on how, start from [Auto-tune](../config/autotune_mc.md).
 
 
 ## Acknowledgements

diff --git a/en/frames_multicopter/qav_r_5_kiss_esc_racer.md b/en/frames_multicopter/qav_r_5_kiss_esc_racer.md
@@ -274,4 +274,4 @@ Ideally you should also do:
 Airframe selection sets *default* autopilot parameters for the frame.
 These are good enough to fly with, but it is a good idea to tune the parameters for a specific frame build.
 
-For instructions on how, start from [Autotune](../config/autotune.md).
+For instructions on how, start from [Autotune](../config/autotune_mc.md).
diff --git a/en/frames_plane/reptile_dragon_2.md b/en/frames_plane/reptile_dragon_2.md
@@ -380,7 +380,7 @@ In particular you should check:
 You should enable Manual, Acro, and Position modes on your controller (at least for the first flight).
 For instructions see [Flight mode Configuration](../config/flight_mode.md)
 
-We also recommend configuring an [autotuning switch](../config/autotune.md#enable-disable-autotune-switch-fixed-wing) for the first flight, as this makes it easier to enable/disable autotuning while flying.
+We also recommend configuring an [autotuning switch](../config/autotune_fw.md#enable-disable-autotune-switch-fixed-wing) for the first flight, as this makes it easier to enable/disable autotuning while flying.
 
 The channel mappings for this build are included in the supplied [params file](#parameter-config).
 The channel order is throttle, roll, pitch, yaw, (blank), and flight mode
@@ -442,7 +442,7 @@ When throwing any airplane, throw at a slightly nose up attitude with full throt
 
 It's critical to be ready to give aft stick input to prevent the airplane from impacting the ground if it happens to be trimmed nosedown.
 Once the airplane is successfully airborne, cruise up to an altitude of a few hundred feet and switch to [Acro mode](../flight_modes_fw/acro.md).
-This is a good time to use [Autotuning](../config/autotune.md) to tune the airframe.
+This is a good time to use [Autotuning](../config/autotune_fw.md) to tune the airframe.
 
 If the airplane is well behaved in _Acro mode_, switch to [Position mode](../flight_modes_fw/position.md).
 

diff --git a/en/frames_plane/turbo_timber_evolution.md b/en/frames_plane/turbo_timber_evolution.md
@@ -193,7 +193,7 @@ Heatshrink was used to electrically insulate the bare board and the radio was in
 Overall, this build was a success.
 
 Even with the added weight of the Pixhawk 4 Mini installation, the airplane balances well and has plenty of power to retain its original STOL characterisitics.
-PX4 is easily capable of stabilizing the airplane and fine tuning of the rate loops were accomplished using [fixed-wing autotuning](../config/autotune.md).
+PX4 is easily capable of stabilizing the airplane and fine tuning of the rate loops were accomplished using [fixed-wing autotuning](../config/autotune_fw.md).
 The results of tuning can be found in the [parameter file linked below](#parameter-file).
 
 In testing I found takeoffs can be as short as only 10ft (3m) using no flaps.

diff --git a/en/frames_plane/wing_wing_z84.md b/en/frames_plane/wing_wing_z84.md
@@ -87,6 +87,6 @@ Set up the [Actuator Configuration](../config/actuators.md) to match the wiring
 
 ### Other Configuration
 
-Perform all the the other [Basic Configuration](../config/index.md), including [Autotuning](../config/autotune.md).
+Perform all the the other [Basic Configuration](../config/index.md), including [Autotuning](../config/autotune_fw.md).
 
 Advanced tuning is optional - see [Fixed-wing Vehicle Configuration](../config_fw/index.md).