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

ReturnHomePilotingItf

interface ReturnHomePilotingItf : PilotingItf, Activable

Piloting interface used to make the drone return to home.

This piloting interface can be obtained from a drone using: 

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

See also

com.parrot.drone.groundsdk.device.Drone

Types

Link copied to clipboard
enum EndingBehavior
Describes the drone behavior at the end of the RTH.
Link copied to clipboard
enum Reachability
Describes whether the return point can be reached by the drone or not.
Link copied to clipboard
enum Reason
Reason why return home piloting interface was activated or deactivated.
Link copied to clipboard
enum Target
Return home destination targets.
Link copied to clipboard
enum UnavailabilityReason
Reason why this piloting interface is currently unavailable.

Functions

Link copied to clipboard
abstract fun activate(): Boolean
Activates this piloting interface.
Link copied to clipboard
@NonNull
abstract fun autoTrigger(): BooleanSetting
Gets the return home auto trigger setting.
Link copied to clipboard
abstract fun cancelAutoTrigger()
Cancels any current auto trigger.
Link copied to clipboard
abstract fun deactivate(): Boolean
Deactivates this piloting interface.
Link copied to clipboard
@NonNull
abstract fun getAutoStartOnDisconnectDelay(): IntSetting
Gets the return home automatic activation upon disconnection delay setting (value in seconds).
Link copied to clipboard
@IntRange(from = 0)
abstract fun getAutoTriggerDelay(): Long
Gets delay before an automatic return home planned by the drone.
Link copied to clipboard
@NonNull
abstract fun getCurrentTarget(): ReturnHomePilotingItf.Target
Gets the current return home target.
Link copied to clipboard
@NonNull
abstract fun getEndingBehavior(): EnumSetting<ReturnHomePilotingItf.EndingBehavior>
Gets the return home ending behavior setting.
Link copied to clipboard
@NonNull
abstract fun getEndingHoveringAltitude(): OptionalDoubleSetting
Gets the return home ending hovering altitude setting, above ground level, in meters.
Link copied to clipboard
@Nullable
abstract fun getHomeLocation(): Location
Gets the current home location.
Link copied to clipboard
@NonNull
abstract fun getHomeReachability(): ReturnHomePilotingItf.Reachability
Gets an estimation of the possibility for the drone to reach its return point.
Link copied to clipboard
@NonNull
abstract fun getMinAltitude(): OptionalDoubleSetting
Gets the return home minimum altitude setting, relative to the take off point, in meters.
Link copied to clipboard
@NonNull
abstract fun getPreferredTarget(): EnumSetting<ReturnHomePilotingItf.Target>
Gets the return home target user setting.
Link copied to clipboard
@NonNull
abstract fun getReason(): ReturnHomePilotingItf.Reason
Gets the reason why return home is active or not.
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<ReturnHomePilotingItf.UnavailabilityReason>
Tells why this piloting interface may currently be unavailable.
Link copied to clipboard
abstract fun gpsWasFixedOnTakeOff(): Boolean
Tells whether first GPS fix was obtained before or after take-off.
Link copied to clipboard
abstract fun setCustomLocation(latitude: Double, longitude: Double, altitude: Double)
Sets the custom home location.