Merge pull request #8690 from sakisdog/rename_functions
[inav.git] / docs / Controls.md
blobf4013cbaff37eb87431846af734b21f50dd3929b
1 # Controls
3 ## Arming
5 When armed, the aircraft is ready to fly and the motors will spin when throttle is applied.  With multirotors, the motors will spin at a slow speed when armed (this feature may be disabled by setting MOTOR_STOP, but for safety reasons, that is not recommended).
7 Arming and disarming is done using a switch, set up on the modes page.  (NOTE: Stick arming was removed in INAV 2.2)
9 **YAW STICK ARMING OVERRIDE:**
10 Arming is disabled when Nav modes are configured and no GPS lock is available or if a WP mission is loaded but the first WP is farther than the `nav_wp_safe_distance` setting. This Arming block can be bypassed if need be by setting `nav_extra_arming_safety` to `ALLOW_BYPASS` and moving the Yaw stick to the high position when the Arm switch is used. This bypasses GPS Arm blocking pre INAV 4.0.0 and both GPS and "First WP too far" Arm blocking from INAV 4.0.0.
12 ## Stick Positions
14 The three stick positions are:
16 |Position        | Approx. Channel Input|
17 |----------------|----------------------|
18 |LOW             | 1000                 |
19 |CENTER          | 1500                 |
20 |HIGH            | 2000                 |
22 The stick positions are combined to activate different functions:
24 | Function                      | Throttle | Yaw     | Pitch  | Roll   |
25 | ----------------------------- | -------- | ------- | ------ | ------ |
26 | Profile 1                     | LOW      | LOW     | CENTER | LOW    |
27 | Profile 2                     | LOW      | LOW     | HIGH   | CENTER |
28 | Profile 3                     | LOW      | LOW     | CENTER | HIGH   |
29 | Battery profile 1             | HIGH     | LOW     | CENTER | LOW    |
30 | Battery profile 2             | HIGH     | LOW     | HIGH   | CENTER |
31 | Battery profile 3             | HIGH     | LOW     | CENTER | HIGH   |
32 | Calibrate Gyro                | LOW      | LOW     | LOW    | CENTER |
33 | Calibrate Acc                 | HIGH     | LOW     | LOW    | CENTER |
34 | Calibrate Mag/Compass         | HIGH     | HIGH    | LOW    | CENTER |
35 | Trim Acc Left                 | HIGH     | CENTER  | CENTER | LOW    |
36 | Trim Acc Right                | HIGH     | CENTER  | CENTER | HIGH   |
37 | Trim Acc Forwards             | HIGH     | CENTER  | HIGH   | CENTER |
38 | Trim Acc Backwards            | HIGH     | CENTER  | LOW    | CENTER |
39 | Save current waypoint mission | LOW      | CENTER  | HIGH   | LOW    |
40 | Load current waypoint mission | LOW      | CENTER  | HIGH   | HIGH   |
41 | Unload waypoint mission       | LOW      | CENTER  | LOW    | HIGH   |
42 | Increase WP mission index     | LOW      | CENTER  | CENTER | HIGH   |
43 | Decrease WP mission index     | LOW      | CENTER  | CENTER | LOW    |
44 | Bypass Nav Arm disable        | LOW      | HIGH    | CENTER | CENTER |
45 | Save setting                  | LOW      | LOW     | LOW    | HIGH   |
46 | Enter OSD Menu (CMS)          | CENTER   | LOW     | HIGH   | CENTER |
48 For graphical stick position in all transmitter modes, check out [this page](https://www.mrd-rc.com/tutorials-tools-and-testing/inav-flight/inav-stick-commands-for-all-transmitter-modes/).
49 ![Stick Positions](assets/images/StickPositions.png)
51 ## Yaw control
53 While arming/disarming with sticks, your yaw stick will be moving to extreme values. In order to prevent your craft from trying to yaw during arming/disarming while on the ground, your yaw input will not cause the craft to yaw when the throttle is LOW (i.e. below the `min_check` setting).
55 For tricopters, you may want to retain the ability to yaw while on the ground, so that you can verify that your tail servo is working correctly before takeoff. You can do this by setting `tri_unarmed_servo` to `1` on the CLI (this is the default). If you are having issues with your tail rotor contacting the ground during arm/disarm, you can set this to `0` instead. Check this table to decide which setting will suit you:
57 <table>
58     <tr>
59         <th colspan="5">Is yaw control of the tricopter allowed?</th>
60     </tr>
61     <tr>
62         <th></th><th colspan="2">Disarmed</th><th colspan="2">Armed</th>
63     </tr>
64     <tr>
65         <th></th><th>Throttle low</th><th>Throttle normal</th><th>Throttle low</th><th>Throttle normal</th>
66     </tr>
67     <tr>
68         <td rowspan="2">tri_unarmed_servo = 0</td><td>No</td><td>No</td><td>No</td><td>Yes</td>
69     </tr>
70     <tr>
71         <td>No</td><td>No</td><td>No</td><td>Yes</td>
72     </tr>
73     <tr>
74         <td rowspan="2">tri_unarmed_servo = 1</td><td>Yes</td><td>Yes</td><td>Yes</td><td>Yes</td>
75     </tr>
76     <tr>
77         <td>Yes</td><td>Yes</td><td>Yes</td><td>Yes</td>
78     </tr>
79 </table>
81 ## Throttle settings and their interaction
83 *Terminology. After INAV 2.3, the setting `min_throttle` was replaced with `throttle_idle` which is more appropriate to modern hardware. In this document `min_throttle` may be taken as either the older `min_throttle` value, or the throttle value calculated  from the modern `throttle_idle` setting. The way that `throttle_idle` generates a throttle value is described in `Cli.md`.*
85 `min_command` -
86 With motor stop enabled this is the command sent to the esc's when the throttle is below min_check or disarmed. With motor stop disabled, this is the command sent only when the copter is disarmed. This must be set well below motors spinning for safety.
88 `min_check` -
89 With switch arming mode is in use, lowering your throttle below min_check will result in motors spinning at `throttle_idle`  (min_throttle). When using the default stick arming, lowering your throttle below min_check will result in motors spinning at min_throttle and yaw being disabled so that you may arm/disarm. With motor stop enabled, lowering your throttle below min_check will also result in motors off and the esc's being sent min_command. Min_check must be set to a level that is 100% reliably met by the throttle throw. A setting too low may result in a dangerous condition where the copter can’t be disarmed. It is ok to set this below `throttle_idle` (min_throttle) because the FC will automaticly scale the output to the ESCs
91 `throttle_idle` (previously `min_throttle)` -
92 Typically set to just above reliable spin up of all motors. Sometimes this is set slightly higher for prop stall prevention during advanced maneuvers or sometimes considerably higher to produce a desired result. When armed with motor stop off, your motors will spin at this command so keep that in mind from a safety stand point.
94 `max_check` -
95 Throttle positions above this level will send max_command to the ESCs.
97 `max_throttle` -
98 This is the max command to the ESCs from the flight controller.
100 In depth videos explaining these terms are available from Joshua Bardwell here:
102 https://www.youtube.com/watch?v=WFU3VewGbbA
104 https://www.youtube.com/watch?v=YNRl0OTKRGA