groundsdk 7.7.2 API/com.parrot.drone.groundsdk.device.pilotingitf/FlightPlanPilotingItf

FlightPlanPilotingItf

interface FlightPlanPilotingItf : PilotingItf, Activable

Flight Plan piloting interface for drones.

Allows to make the drone execute predefined flight plans. A flight plan is defined using a file in Mavlink format. For further information, please refer to Parrot FlightPlan Mavlink documentation.

This interface remains unavailable until all unavailability reasons are cleared:

  • A Flight Plan file has been uploaded to the drone, and
  • the drone GPS location has been acquired, and
  • the drone is properly calibrated, and
  • the drone can take off (good battery level...).
Then, when all those conditions hold, the interface becomes idle and can be activated to begin or resume Flight Plan execution, which can be paused by deactivating the interface.

This piloting interface can be obtained from a Drone using: 

drone.getPilotingItf(FlightPlan.class)
Content copied to clipboard

See also

PilotingItf.Provider

Types

Link copied to clipboard
enum ActivationError
Activation error.
Link copied to clipboard
enum DisconnectionPolicy
Describes the drone's behaviour upon disconnection.
Link copied to clipboard
enum Interpreter
Defines how a mavlink flight plan file is interpreted by the drone.
Link copied to clipboard
interface RecoveryInfo
Information for flight plan execution recovery.
Link copied to clipboard
abstract class ReturnHomeOnDisconnectSetting : BooleanSetting
Setting for drone behavior upon disconnection during execution of a Flight Plan.
Link copied to clipboard
enum UnavailabilityReason
Reason why this piloting interface is currently unavailable.
Link copied to clipboard
enum UploadState
Flight Plan file upload state.

Functions

Link copied to clipboard
open fun activate(restart: Boolean): Boolean
abstract fun activate(@NonNull interpreter: FlightPlanPilotingItf.Interpreter, restart: Boolean): Boolean
Activates this piloting interface and starts executing the uploaded flight plan.
abstract fun activate(@NonNull interpreter: FlightPlanPilotingItf.Interpreter, restart: Boolean, missionItem: Int): Boolean
abstract fun activate(@NonNull interpreter: FlightPlanPilotingItf.Interpreter, restart: Boolean, missionItem: Int, disconnectionPolicy: FlightPlanPilotingItf.DisconnectionPolicy): Boolean
Activates this piloting interface and starts executing the uploaded flight plan at given mission item.
Link copied to clipboard
abstract fun clearRecoveryInfo()
Clears information about the latest flight plan started by the drone prior to current connection.
Link copied to clipboard
abstract fun deactivate(): Boolean
Deactivates this piloting interface.
Link copied to clipboard
@Nullable
abstract fun getFlightPlanId(): String
Gets identifier of the flight plan currently loaded on the drone.
Link copied to clipboard
@NonNull
abstract fun getLatestActivationError(): FlightPlanPilotingItf.ActivationError
Gets the error raised during the latest activation.
Link copied to clipboard
abstract fun getLatestMissionItemExecuted(): Int
Gets the index of the latest mission item completed.
Link copied to clipboard
@NonNull
abstract fun getLatestUploadState(): FlightPlanPilotingItf.UploadState
Gets the latest Flight Plan file upload state.
Link copied to clipboard
@Nullable
abstract fun getRecoveryInfo(): FlightPlanPilotingItf.RecoveryInfo
Gets information about the latest flight plan started by the drone prior to current connection.
Link copied to clipboard
@NonNull
abstract fun getReturnHomeOnDisconnect(): FlightPlanPilotingItf.ReturnHomeOnDisconnectSetting
Gets current setting for the drone behavior upon disconnection during execution of a Flight Plan.
Link copied to clipboard
@NonNull
abstract fun getState(): Activable.State
Gets the piloting interface's current state.
Link copied to clipboard
@NonNull
abstract fun getUnavailabilityReasons(): Set<FlightPlanPilotingItf.UnavailabilityReason>
Tells why this piloting interface may currently be unavailable.
Link copied to clipboard
abstract fun isActivateAtMissionItemSupported(): Boolean
Tells whether starting a flight plan at a specified mission item is supported.
abstract fun isActivateWithDisconnectionPolicySupported(): Boolean
Tells whether starting a flight plan with a specified disconnection policy is supported.
Link copied to clipboard
abstract fun isFlightPlanFileKnown(): Boolean
Tells whether the current flight plan on the drone is the latest one that has been uploaded from the application.
Link copied to clipboard
abstract fun isPaused(): Boolean
Tells whether the uploaded flight plan is currently paused.
Link copied to clipboard
abstract fun isUploadWithCustomIdSupported(): Boolean
Tells whether uploading a flight plan with an associated custom identifier is supported.
Link copied to clipboard
abstract fun stop(): Boolean
Stops execution of current flight plan, if any.
Link copied to clipboard
abstract fun uploadFlightPlan(@NonNull flightPlanFile: File)
Uploads a Flight Plan file to the drone.
abstract fun uploadFlightPlan(@NonNull flightPlanFile: File, @NonNull customId: String)
Uploads a Flight Plan file, with an associated identifier, to the drone.