restore missing check on CLI setting (agh review comment 1)
[inav.git] / docs / Failsafe.md
blobf9bbfcfde42314babdfa780f63f47480d1e11c9b
1 # Failsafe
3 Failsafe is a state the flight controller is meant to enter when the radio receiver loses the RC link. Any of these of these conditions will trigger it:
5 * Any flight channel (pitch, roll, throttle or yaw) sends no pulses
6 * Any channel is outside the valid range between `rx_min_usec` and `rx_max_usec`
7 * The FAILSAFE aux mode is activated
9 If the failsafe happens while the flight controller is disarmed, it only prevent arming. If it happens while armed, the failsafe policy configured in `failsafe_procedure` is engaged. The available procedures are:
11 * __DROP:__ Just kill the motors and disarm (crash the craft).
12 * __SET-THR:__ Enable auto-level mode (for multirotor) or enter preconfigured roll/pitch/yaw spiral down (for airplanes) and set the throttle to a predefined value (`failsafe_throttle`) for a predefined time (`failsafe_off_delay`). This is meant to get the craft to a safe-ish landing (or more realistically, a controlled crash), it doesn't require any extra sensor other than gyros and accelerometers.
13 * __RTH:__ (Return To Home) One of the key features of inav, it automatically navigates the craft back to the home position and (optionally) lands it. Similarly to all other automated navigation methods, it requires GPS for any type of craft, plus compass and barometer for multicopters.
14 * __NONE:__ Do nothing. This is meant to let the craft perform a fully automated flight (eg. waypoint flight) outside of radio range. Highly unsafe when used with manual flight.
16 Note that:
17 * Should the failsafe disarm the flight controller (**DROP**, **SET-THR** after `failsafe_off_delay` or **RTH** with `nav_disarm_on_landing` ON), the flight controller will be disarmed and re-arming will be locked until the signal from the receiver is restored for 30 seconds AND the arming switch is in the OFF position (when an arm switch is in use).
19 * Prior to starting failsafe it is checked if the throttle position has been below `min_throttle` for the last `failsafe_throttle_low_delay` seconds. If it was, the craft is assumed to be on the ground and is simply disarmed. This feature can be disabled completely by setting `failsafe_throttle_low_delay` to zero, which may be necessary to do if the craft may fly long with zero throttle (eg. gliders).
21 ## Notes about safety
23 * If the craft is landed but armed, the failsafe may make the motors and props spin again and even make the craft take off (in case of **RTH** failsafe). Take expecially care of this when using `MOTOR_STOP` feature. **Props will spin up without warning**. Have a look at the `failsafe_throttle_low_delay` setting explained above to learn when this could happen.
25 * If any required navigation sensor becomes unavailable during a Return to Home (eg. loss of GPS fix), an emergency landing similar to **SET-THR** but with barometer support will be performed after a short timeout. An emergency landing would also be performed right when the failsafe is triggered if any required sensor is reported as unavailable.
27 * **SET-THR** doesn't control the descend in any other way than setting a fixed throttle. Thus, appropriate testing must be performed to find the right throttle value. Consider that a constant throttle setting will yield different thrusts depending on battery voltage, so when you evaluate the throttle value do it with a loaded battery. Failure to do so may cause a flyaway.
29 * When the failsafe mode is aborted (RC signal restored/failsafe switch set to OFF), the current stick positions will be enforced immediately. Be ready to react quickly.
31 ## RX configuration
33 In order to engage failsafe mode correctly, you must configure your receiver to do one of the following on signal loss:
35 * Send no signal/pulses over the channels
36 * Send an invalid signal over the channels (for example, send values lower than `rx_min_usec`)
37 * Set an aux channel to engage FAILSAFE mode.
39 and
41 * Ensure your receiver does not set any aux channel so that the craft would disarm.
43 ## Failsafe Settings
45 Failsafe delays are configured in 0.1 second units. Distances are in centimeters (1/100 of a meter).
47 ### Parameters relevant to all failsafe procedures
49 #### `failsafe_procedure`
51 Selects the failsafe procedure. Valid procedures are **DROP**, **SET-THR**, **RTH** and **NONE**. See above for a description of each one.
53 #### `failsafe_delay`
55 Guard time for failsafe activation when rx channel data is lost or invalid.  This is the amount of time the flight controller waits to see if it begins receiving a valid signal again before activating failsafe. Does not apply when activating the FAILSAFE aux mode.
57 #### `failsafe_recovery_delay`
59 Guard time for failsafe de-activation after signal is recovered.  This is the amount of time the flight controller waits to see if the signal is consistent before turning off failsafe procedure. Usefull to avoid swithing in and out of failsafe RTH. Does not apply when disactivating the FAILSAFE aux mode.
61 #### `failsafe_stick_threshold`
63 This parameter defines recovery from failsafe by stick motion. When set to zero failsafe procedure will be cleared as soon as RC link is recovered. When this is set to a non-zero value - failsafe won't clear immediately when if RC link is recovered, you will have to move any of Roll/Pitch/Yaw sticks more than this value to exit failsafe.
65 The use-case is the Return To Home failsafe: when on the edge of radio coverage you may end up entering and exiting failsafe if radio link is sporadic - happens a lot with long-range pilots. Setting `failsafe_stick_threshold` to a certain value (i.e. 100) RTH will be initiated on first signal loss and will continue as long as pilots want it to continue. When RC link is solid (based on RSSI etc) pilot will move sticks and regain control.
67 #### `failsafe_throttle_low_delay`
69 Time throttle level must have been below 'min_throttle' to _only disarm_ instead of _full failsafe procedure_. Set to zero to disable.
71 #### `failsafe_min_distance`
73 If failsafe happens when craft is closer than this distance in centimeters from home, failsafe will not execute regular failsafe_procedure, but will execute procedure specified in failsafe_min_distance_procedure instead. 0 = Normal failsafe_procedure always taken.
75 #### `failsafe_min_distance_procedure`
77 What failsafe procedure to initiate in Stage 2 when craft is closer to home than failsafe_min_distance.
79 #### `rx_min_usec`
81 The lowest channel value considered valid.
83 #### `rx_max_usec`
85 The highest channel value considered valid.
87 ### Parameters relevant to **RTH** failsafe procedure
89 #### `nav_min_rth_distance`
91 If the failsafe happens while the craft is within this distance from the home position, the home position is considered immediately reached.
93 #### `nav_rth_climb_first`
95 If ON the craft rises to `nav_rth_altitude` before heading to home position. if OFF the craft climbs on the way to home position.
97 #### `nav_rth_climb_ignore_emerg`
99 When this option is OFF (default) and when you initiate RTH without GPS fix - aircraft will initiate emergency descent and go down. If you set this option to ON - aircraft will reach the RTH target altitude before initiating emergency descent. This is done for cases where GPS coverage is poor (i.e. in the mountains) - allowing UAV to climb up might improve GPS coverage and allow safe return instead of landing in a place where UAV might be impossible to recover.
101 #### `nav_rth_tail_first`
103 Only relevant for multirotors. If this is OFF the craft will head to home position head first, if ON it'll be tail first
105 #### `nav_rth_altitude`
107 The altitude used as reference for the RTH procedure.
109 #### `nav_rth_alt_mode`
111 How and when to reach `nav_rth_altitude`. Please read [the page on the wiki](https://github.com/iNavFlight/inav/wiki/Navigation-modes#rth-altitude-control-modes) for a description of the available modes.
113 #### `nav_rth_abort_threshold`
115 If the craft increases its distance from the point the failsafe was triggered first by this amount, RTH procedure is aborted and an emergency landing is initiated. It's meant to avoid flyaways due to navigation issues, like strong winds.
117 #### `nav_rth_allow_landing`
119 Enables landing when home position is reached. If OFF the craft will hover indefinitely over the home position.
121 #### `nav_disarm_on_landing`
123 Instructs the flight controller to disarm the craft when landing is detected
125 ### Parameters relevant to **SET-THR** failsafe procedure
127 #### `failsafe_off_delay`
129 Delay after failsafe activates before motors finally turn off.  This is the amount of time 'failsafe_throttle' is active.  If you fly at higher altitudes you may need more time to descend safely. Set to zero to keep `failsafe_throttle` active indefinitely.
131 #### `failsafe_throttle`
133 Throttle level used for landing.  Specify a value that causes the aircraft to descend at about 1M/sec. Default is set to 1000 which should correspond to throttle off.
135 #### `failsafe_fw_roll_angle`
137 This parameter defines amount of roll angle (in 1/10 deg units) to execute on failsafe. Negative = LEFT
139 #### `failsafe_fw_pitch_angle`
141 This parameter defines amount of pitch angle (in 1/10 deg units) to execute on `SET-THR` failsafe for an airplane. Negative = CLIMB
143 #### `failsafe_fw_yaw_rate`
145 This parameter defines amount of yaw rate (in deg per second units) to execute on `SET-THR` failsafe for an airplane. Negative = LEFT