mirror of https://github.com/ArduPilot/ardupilot
353 lines
12 KiB
C++
353 lines
12 KiB
C++
#include "Plane.h"
|
|
|
|
Mode::Mode() :
|
|
ahrs(plane.ahrs)
|
|
#if HAL_QUADPLANE_ENABLED
|
|
, quadplane(plane.quadplane),
|
|
pos_control(plane.quadplane.pos_control),
|
|
attitude_control(plane.quadplane.attitude_control),
|
|
loiter_nav(plane.quadplane.loiter_nav),
|
|
poscontrol(plane.quadplane.poscontrol)
|
|
#endif
|
|
{
|
|
}
|
|
|
|
void Mode::exit()
|
|
{
|
|
// call sub-classes exit
|
|
_exit();
|
|
// stop autotuning if not AUTOTUNE mode
|
|
if (plane.control_mode != &plane.mode_autotune){
|
|
plane.autotune_restore();
|
|
}
|
|
|
|
}
|
|
|
|
bool Mode::enter()
|
|
{
|
|
#if AP_SCRIPTING_ENABLED
|
|
// reset nav_scripting.enabled
|
|
plane.nav_scripting.enabled = false;
|
|
#endif
|
|
|
|
// cancel inverted flight
|
|
plane.auto_state.inverted_flight = false;
|
|
|
|
// cancel waiting for rudder neutral
|
|
plane.takeoff_state.waiting_for_rudder_neutral = false;
|
|
|
|
// don't cross-track when starting a mission
|
|
plane.auto_state.next_wp_crosstrack = false;
|
|
|
|
// reset landing check
|
|
plane.auto_state.checked_for_autoland = false;
|
|
|
|
// zero locked course
|
|
plane.steer_state.locked_course_err = 0;
|
|
plane.steer_state.locked_course = false;
|
|
|
|
// reset crash detection
|
|
plane.crash_state.is_crashed = false;
|
|
plane.crash_state.impact_detected = false;
|
|
|
|
// reset external attitude guidance
|
|
plane.guided_state.last_forced_rpy_ms.zero();
|
|
plane.guided_state.last_forced_throttle_ms = 0;
|
|
|
|
#if AP_PLANE_OFFBOARD_GUIDED_SLEW_ENABLED
|
|
plane.guided_state.target_heading = -4; // radians here are in range -3.14 to 3.14, so a default value needs to be outside that range
|
|
plane.guided_state.target_heading_type = GUIDED_HEADING_NONE;
|
|
plane.guided_state.target_airspeed_cm = -1; // same as above, although an airspeed of -1 is rare on plane.
|
|
plane.guided_state.target_alt_time_ms = 0;
|
|
plane.guided_state.target_location.set_alt_cm(-1, Location::AltFrame::ABSOLUTE);
|
|
#endif
|
|
|
|
#if AP_CAMERA_ENABLED
|
|
plane.camera.set_is_auto_mode(this == &plane.mode_auto);
|
|
#endif
|
|
|
|
// zero initial pitch and highest airspeed on mode change
|
|
plane.auto_state.highest_airspeed = 0;
|
|
plane.auto_state.initial_pitch_cd = ahrs.pitch_sensor;
|
|
|
|
// disable taildrag takeoff on mode change
|
|
plane.auto_state.fbwa_tdrag_takeoff_mode = false;
|
|
|
|
// start with previous WP at current location
|
|
plane.prev_WP_loc = plane.current_loc;
|
|
|
|
// new mode means new loiter
|
|
plane.loiter.start_time_ms = 0;
|
|
|
|
// record time of mode change
|
|
plane.last_mode_change_ms = AP_HAL::millis();
|
|
|
|
// set VTOL auto state
|
|
plane.auto_state.vtol_mode = is_vtol_mode();
|
|
plane.auto_state.vtol_loiter = false;
|
|
|
|
// initialize speed variable used in AUTO and GUIDED for DO_CHANGE_SPEED commands
|
|
plane.new_airspeed_cm = -1;
|
|
|
|
// clear postponed long failsafe if mode change (from GCS) occurs before recall of long failsafe
|
|
plane.long_failsafe_pending = false;
|
|
|
|
#if HAL_QUADPLANE_ENABLED
|
|
quadplane.mode_enter();
|
|
#endif
|
|
|
|
#if AP_TERRAIN_AVAILABLE
|
|
plane.target_altitude.terrain_following_pending = false;
|
|
#endif
|
|
|
|
// disable auto mode servo idle during altitude wait command
|
|
plane.auto_state.idle_mode = false;
|
|
|
|
bool enter_result = _enter();
|
|
|
|
if (enter_result) {
|
|
// -------------------
|
|
// these must be done AFTER _enter() because they use the results to set more flags
|
|
|
|
// start with throttle suppressed in auto_throttle modes
|
|
plane.throttle_suppressed = does_auto_throttle();
|
|
#if HAL_ADSB_ENABLED
|
|
plane.adsb.set_is_auto_mode(does_auto_navigation());
|
|
#endif
|
|
|
|
// set the nav controller stale AFTER _enter() so that we can check if we're currently in a loiter during the mode change
|
|
plane.nav_controller->set_data_is_stale();
|
|
|
|
// reset steering integrator on mode change
|
|
plane.steerController.reset_I();
|
|
|
|
// update RC failsafe, as mode change may have necessitated changing the failsafe throttle
|
|
plane.control_failsafe();
|
|
|
|
#if AP_FENCE_ENABLED
|
|
// pilot requested flight mode change during a fence breach indicates pilot is attempting to manually recover
|
|
// this flight mode change could be automatic (i.e. fence, battery, GPS or GCS failsafe)
|
|
// but it should be harmless to disable the fence temporarily in these situations as well
|
|
plane.fence.manual_recovery_start();
|
|
#endif
|
|
//reset mission if in landing sequence, disarmed, not flying, and have changed to a non-autothrottle mode to clear prearm
|
|
if (plane.mission.get_in_landing_sequence_flag() &&
|
|
!plane.is_flying() && !plane.arming.is_armed_and_safety_off() &&
|
|
!plane.control_mode->does_auto_navigation()) {
|
|
GCS_SEND_TEXT(MAV_SEVERITY_INFO, "In landing sequence: mission reset");
|
|
plane.mission.reset();
|
|
}
|
|
|
|
// Make sure the flight stage is correct for the new mode
|
|
plane.update_flight_stage();
|
|
|
|
#if HAL_QUADPLANE_ENABLED
|
|
if (quadplane.enabled()) {
|
|
float aspeed;
|
|
bool have_airspeed = quadplane.ahrs.airspeed_estimate(aspeed);
|
|
quadplane.assisted_flight = quadplane.assist.should_assist(aspeed, have_airspeed);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
return enter_result;
|
|
}
|
|
|
|
bool Mode::is_vtol_man_throttle() const
|
|
{
|
|
#if HAL_QUADPLANE_ENABLED
|
|
if (plane.quadplane.tailsitter.is_in_fw_flight() &&
|
|
plane.quadplane.assisted_flight) {
|
|
// We are a tailsitter that has fully transitioned to Q-assisted forward flight.
|
|
// In this case the forward throttle directly drives the vertical throttle so
|
|
// set vertical throttle state to match the forward throttle state. Confusingly the booleans are inverted,
|
|
// forward throttle uses 'does_auto_throttle' whereas vertical uses 'is_vtol_man_throttle'.
|
|
return !does_auto_throttle();
|
|
}
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
void Mode::update_target_altitude()
|
|
{
|
|
Location target_location;
|
|
|
|
if (plane.landing.is_flaring()) {
|
|
// during a landing flare, use TECS_LAND_SINK as a target sink
|
|
// rate, and ignores the target altitude
|
|
plane.set_target_altitude_location(plane.next_WP_loc);
|
|
} else if (plane.landing.is_on_approach()) {
|
|
plane.landing.setup_landing_glide_slope(plane.prev_WP_loc, plane.next_WP_loc, plane.current_loc, plane.target_altitude.offset_cm);
|
|
#if AP_RANGEFINDER_ENABLED
|
|
plane.landing.adjust_landing_slope_for_rangefinder_bump(plane.rangefinder_state, plane.prev_WP_loc, plane.next_WP_loc, plane.current_loc, plane.auto_state.wp_distance, plane.target_altitude.offset_cm);
|
|
#endif
|
|
} else if (plane.landing.get_target_altitude_location(target_location)) {
|
|
plane.set_target_altitude_location(target_location);
|
|
#if HAL_SOARING_ENABLED
|
|
} else if (plane.g2.soaring_controller.is_active() && plane.g2.soaring_controller.get_throttle_suppressed()) {
|
|
// Reset target alt to current alt, to prevent large altitude errors when gliding.
|
|
plane.set_target_altitude_location(plane.current_loc);
|
|
plane.reset_offset_altitude();
|
|
#endif
|
|
} else if (plane.reached_loiter_target()) {
|
|
// once we reach a loiter target then lock to the final
|
|
// altitude target
|
|
plane.set_target_altitude_location(plane.next_WP_loc);
|
|
} else if (plane.target_altitude.offset_cm != 0 &&
|
|
!plane.current_loc.past_interval_finish_line(plane.prev_WP_loc, plane.next_WP_loc)) {
|
|
// control climb/descent rate
|
|
plane.set_target_altitude_proportion(plane.next_WP_loc, 1.0f-plane.auto_state.wp_proportion);
|
|
|
|
// stay within the range of the start and end locations in altitude
|
|
plane.constrain_target_altitude_location(plane.next_WP_loc, plane.prev_WP_loc);
|
|
} else {
|
|
plane.set_target_altitude_location(plane.next_WP_loc);
|
|
}
|
|
}
|
|
|
|
// returns true if the vehicle can be armed in this mode
|
|
bool Mode::pre_arm_checks(size_t buflen, char *buffer) const
|
|
{
|
|
if (!_pre_arm_checks(buflen, buffer)) {
|
|
if (strlen(buffer) == 0) {
|
|
// If no message is provided add a generic one
|
|
hal.util->snprintf(buffer, buflen, "mode not armable");
|
|
}
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
// Auto and Guided do not call this to bypass the q-mode check.
|
|
bool Mode::_pre_arm_checks(size_t buflen, char *buffer) const
|
|
{
|
|
#if HAL_QUADPLANE_ENABLED
|
|
if (plane.quadplane.enabled() && !is_vtol_mode() &&
|
|
plane.quadplane.option_is_set(QuadPlane::OPTION::ONLY_ARM_IN_QMODE_OR_AUTO)) {
|
|
hal.util->snprintf(buffer, buflen, "not Q mode");
|
|
return false;
|
|
}
|
|
#endif
|
|
return true;
|
|
}
|
|
|
|
void Mode::run()
|
|
{
|
|
// Direct stick mixing functionality has been removed, so as not to remove all stick mixing from the user completely
|
|
// the old direct option is now used to enable fbw mixing, this is easier than doing a param conversion.
|
|
if ((plane.g.stick_mixing == StickMixing::FBW) || (plane.g.stick_mixing == StickMixing::DIRECT_REMOVED)) {
|
|
plane.stabilize_stick_mixing_fbw();
|
|
}
|
|
plane.stabilize_roll();
|
|
plane.stabilize_pitch();
|
|
plane.stabilize_yaw();
|
|
}
|
|
|
|
// Reset rate and steering controllers
|
|
void Mode::reset_controllers()
|
|
{
|
|
// reset integrators
|
|
plane.rollController.reset_I();
|
|
plane.pitchController.reset_I();
|
|
plane.yawController.reset_I();
|
|
|
|
// reset steering controls
|
|
plane.steer_state.locked_course = false;
|
|
plane.steer_state.locked_course_err = 0;
|
|
|
|
// reset TECS
|
|
plane.TECS_controller.reset();
|
|
}
|
|
|
|
bool Mode::is_taking_off() const
|
|
{
|
|
return (plane.flight_stage == AP_FixedWing::FlightStage::TAKEOFF);
|
|
}
|
|
|
|
// Helper to output to both k_rudder and k_steering servo functions
|
|
void Mode::output_rudder_and_steering(float val)
|
|
{
|
|
SRV_Channels::set_output_scaled(SRV_Channel::k_rudder, val);
|
|
SRV_Channels::set_output_scaled(SRV_Channel::k_steering, val);
|
|
}
|
|
|
|
// Output pilot throttle, this is used in stabilized modes without auto throttle control
|
|
// Direct mapping if THR_PASS_STAB is set
|
|
// Otherwise apply curve for trim correction if configured
|
|
void Mode::output_pilot_throttle()
|
|
{
|
|
if (plane.g.throttle_passthru_stabilize) {
|
|
// THR_PASS_STAB set, direct mapping
|
|
SRV_Channels::set_output_scaled(SRV_Channel::k_throttle, plane.get_throttle_input(true));
|
|
return;
|
|
}
|
|
|
|
// get throttle, but adjust center to output TRIM_THROTTLE if flight option set
|
|
SRV_Channels::set_output_scaled(SRV_Channel::k_throttle, plane.get_adjusted_throttle_input(true));
|
|
}
|
|
|
|
// true if throttle min/max limits should be applied
|
|
bool Mode::use_throttle_limits() const
|
|
{
|
|
#if AP_SCRIPTING_ENABLED
|
|
if (plane.nav_scripting_active()) {
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
if (this == &plane.mode_stabilize ||
|
|
this == &plane.mode_training ||
|
|
this == &plane.mode_acro ||
|
|
this == &plane.mode_fbwa ||
|
|
this == &plane.mode_autotune) {
|
|
// a manual throttle mode
|
|
return !plane.g.throttle_passthru_stabilize;
|
|
}
|
|
|
|
if (is_guided_mode() && plane.guided_throttle_passthru) {
|
|
// manual pass through of throttle while in GUIDED
|
|
return false;
|
|
}
|
|
|
|
#if HAL_QUADPLANE_ENABLED
|
|
if (quadplane.in_vtol_mode()) {
|
|
return quadplane.allow_forward_throttle_in_vtol_mode();
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|
|
|
|
// true if voltage correction should be applied to throttle
|
|
bool Mode::use_battery_compensation() const
|
|
{
|
|
#if AP_SCRIPTING_ENABLED
|
|
if (plane.nav_scripting_active()) {
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
if (this == &plane.mode_stabilize ||
|
|
this == &plane.mode_training ||
|
|
this == &plane.mode_acro ||
|
|
this == &plane.mode_fbwa ||
|
|
this == &plane.mode_autotune) {
|
|
// a manual throttle mode
|
|
return false;
|
|
}
|
|
|
|
if (is_guided_mode() && plane.guided_throttle_passthru) {
|
|
// manual pass through of throttle while in GUIDED
|
|
return false;
|
|
}
|
|
|
|
#if HAL_QUADPLANE_ENABLED
|
|
if (quadplane.in_vtol_mode()) {
|
|
return false;
|
|
}
|
|
#endif
|
|
|
|
return true;
|
|
}
|