ReturnHomePilotingItf

@objc(GSReturnHomePilotingItf)
public protocol ReturnHomePilotingItf : ActivablePilotingItf, PilotingItf

Piloting interface used to make the drone return to home.

This piloting interface can be retrieved by:

drone.getPilotingItf(PilotingItfs.returnHome)
  • Reason why the return home is active or not.

    Declaration

    Swift

    var reason: ReturnHomeReason { get }
  • Current home location, nil if unknown.

    Declaration

    Swift

    var homeLocation: CLLocation? { get }
  • Current return home target. May be different from the one selected by preferredTarget if the requirement of the selected target are not met.

    Declaration

    Swift

    var currentTarget: ReturnHomeTarget { get }
  • If current target is TakeOffPosition, indicates if the first GPS fix was made before or after takeoff. If the first fix was made after take off, the drone will return at this first fix position that may be different from the takeoff position

    Declaration

    Swift

    var gpsWasFixedOnTakeOff: Bool { get }
  • Return home target settings, to select if the drone should return to its take-off position or to the current pilot position.

    Declaration

    Swift

    var preferredTarget: ReturnHomePreferredTarget { get }
  • Minimum return home altitude in meters, relative to the take off point. If the drone is below this altitude when starting its return home, it will first reach the minimum altitude. If it is higher than this minimum altitude, it will operate its return home at its actual. nil if not supported by the drone.

    Declaration

    Swift

    var minAltitude: DoubleSetting? { get }
  • Delay before starting return home when the controller connection is lost, in seconds.

    Declaration

    Swift

    var autoStartOnDisconnectDelay: IntSetting { get }
  • Estimation of the possibility for the drone to reach its return point.

    Declaration

    Swift

    var homeReachability: HomeReachability { get }
  • Delay in seconds before the drone starts an automatic return home when homeReachability is .warning, meaningless otherwise. This delay is computed by the drone to allow it to reach its home position before the battery is empty.

    Declaration

    Swift

    var autoTriggerDelay: TimeInterval { get }
  • Activates this piloting interface.

    If successful, it deactivates the current piloting interface and activate this one.

    Declaration

    Swift

    func activate() -> Bool

    Return Value

    true on success, false if the piloting interface can’t be activated

  • Cancels any current auto trigger. If homeReachability is .warning, this cancels the planned return home.

    Declaration

    Swift

    func cancelAutoTrigger()