Waypoint V2

2023-03-29
No Rating

The header file of waypoint V2 related functions is dji_waypoint_v2.h. This document describes the key information and usage of the structure and function prototypes in the dji_waypoint_v2.h file.

Catalog

Definition, Enum and Struct

typedef function WaypointV2EventCbFunc

typedef T_DjiReturnCode (*WaypointV2EventCbFunc)(T_DjiWaypointV2MissionEventPush eventData);

typedef function WaypointV2StateCbFunc

typedef T_DjiReturnCode (*WaypointV2StateCbFunc)(T_DjiWaypointV2MissionStatePush stateData);

Function

function DjiWaypointV2_Init

Function:Initialise waypoint v2 module, and user should call this function before using waypoint v2 features. product:all
T_DjiReturnCode DjiWaypointV2_Init(void);


Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_Deinit

Function:Deinitialise waypoint v2 module. product:all
T_DjiReturnCode DjiWaypointV2_Deinit(void);


Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_UploadMission

Function:Init waypoint v2 mission settings product:all
T_DjiReturnCode DjiWaypointV2_UploadMission(const T_DjiWayPointV2MissionSettings *info);
Parameter
info:see reference of T_DjiWayPointV2MissionSettings.
Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_Start

Function:Start execute waypoint v2 mission product:all
T_DjiReturnCode DjiWaypointV2_Start(void);


Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_Stop

Function:Stop execute waypoint v2 mission product:all
T_DjiReturnCode DjiWaypointV2_Stop(void);


Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_Pause

Function:Pause execute waypoint v2 mission product:all
T_DjiReturnCode DjiWaypointV2_Pause(void);


Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_Resume

Function:Resume execute waypoint v2 mission product:all
T_DjiReturnCode DjiWaypointV2_Resume(void);


Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_GetGlobalCruiseSpeed

Function:Get the global cruise speed setting from flight controller product:all
T_DjiReturnCode DjiWaypointV2_GetGlobalCruiseSpeed(T_DjiWaypointV2GlobalCruiseSpeed *cruiseSpeed);
Parameter
cruiseSpeed:see references of T_DjiWaypointV2GlobalCruiseSpeed.
Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_SetGlobalCruiseSpeed

Function:Set the global cruise speed setting to flight controller product:all
T_DjiReturnCode DjiWaypointV2_SetGlobalCruiseSpeed(T_DjiWaypointV2GlobalCruiseSpeed cruiseSpeed);
Parameter
cruiseSpeed:see references of T_DjiWaypointV2GlobalCruiseSpeed.
Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_RegisterMissionEventCallback

Function:Subscribe to waypointV2 event with a callback function. product:all
T_DjiReturnCode DjiWaypointV2_RegisterMissionEventCallback(WaypointV2EventCbFunc callback);
Parameter
callback:see references of WaypointV2EventCbFunc.
Return
The details for the return code please refer to: DjiErrorCode

function DjiWaypointV2_RegisterMissionStateCallback

Function:Subscribe to waypointV2 mission state with a callback function. product:all
T_DjiReturnCode DjiWaypointV2_RegisterMissionStateCallback(WaypointV2StateCbFunc callback);
Parameter
callback:see references of WaypointV2StateCbFunc.
Return
The details for the return code please refer to: DjiErrorCode
If you have any comments or confusion about our documentation, you can click here to give feedback and we will get back to you as soon as possible.