DJI Mobile SDK Documentation

      class DJIWaypointV2Mission

      @interface DJIWaypointV2Mission : DJIMission
      Header:DJIWaypointV2Mission.h
      Inherits From:DJIMission
      Description:

      In the waypoint mission, the aircraft will travel between waypoints, execute actions at waypoints, and adjust heading and altitude between waypoints. Waypoints are physical locations to which the aircraft will fly. Creating a series of waypoints, in effect, will program a flight route for the aircraft to follow. Actions can also be added to waypoints, which will be carried out when the aircraft reaches the waypoint. The aircraft travels between waypoints automatically at a base speed. However, the user can change the speed by using the pitch joystick. If the stick is pushed up, the speed will increase. If the stick is pushed down, the speed will slow down. The stick can be pushed down to stop the aircraft and further pushed to start making the aircraft travel back along the path it came. When the aircraft is travelling through waypoints in the reverse order, it will not execute waypoint actions at each waypoint. If the stick is released, the aircraft will again travel through the waypoints in the original order, and continue to execute waypoint actions (even if executed previously). If the aircraft is pulled back along the waypoint mission all the way to the first waypoint, then it will hover in place until the stick is released enough for it to again progress through the mission from start to finish. It is only supported by DJIAircraftModelNameMatrice300RTK.

      Class Members:
      Make Mission
      method
      method initWithMission
      -(instancetype)initWithMission:(DJIWaypointV2Mission *)mission
      Header:DJIWaypointV2Mission.h
      Description:

      Initialize a DJIWaypointV2Mission by copying the parameters from the input mission.

      Input Parameters:
      DJIWaypointV2Mission * missionMission to be copied from.
      Mission Download
      property
      property isComplete
      @property(nonatomic, readonly) BOOL isComplete
      Header:DJIWaypointV2Mission.h
      Description:

      When downloading a waypoint mission, the number of waypoints in allWaypoints will be less than waypointCount until the download is complete. This property is YES when all the information in the waypoint mission is downloaded, and complete in this object.

      Mission ID
      property
      property missionID
      @property(nonatomic, readonly) NSUInteger missionID
      Header:DJIWaypointV2Mission.h
      Description:

      The Mission ID.

      Waypoint Count
      property
      property waypointCount
      @property(nonatomic, readonly) NSUInteger waypointCount
      Header:DJIWaypointV2Mission.h
      Description:

      Number of waypoints in the waypoint mission. Note there are some cases when the waypoint count will be different to the waypoint array length from allWaypoints. This is usually the case when the waypoint mission is still being downloaded from the aircraft and the mission object hasn't existed previously (e.g. when the mobile device is connected to an aircraft with a previously uploaded mission). In these cases, isComplete will return YES.

      Max Flight Speed
      property
      property maxFlightSpeed
      @property(nonatomic, readonly) float maxFlightSpeed
      Header:DJIWaypointV2Mission.h
      Description:

      While the aircraft is travelling between waypoints, you can offset its speed by using the throttle joystick on the remote controller. maxFlightSpeed is this offset when the joystick is pushed to maximum deflection. For example, If maxFlightSpeed is 10 m/s, then pushing the throttle joystick all the way up will add 10 m/s to the aircraft speed, while pushing down will subtract 10 m/s from the aircraft speed. If the remote controller stick is not at maximum deflection, then the offset speed will be interpolated between [0, maxFlightSpeed] with a resolution of 1000 steps. If the offset speed is negative, then the aircraft will fly backwards to previous waypoints. When it reaches the first waypoint, it will then hover in place until a positive speed is applied. maxFlightSpeed has a range of [2,15] m/s.

      Auto Flight Speed
      property
      property autoFlightSpeed
      @property(nonatomic, readonly) float autoFlightSpeed
      Header:DJIWaypointV2Mission.h
      Description:

      The base automatic speed of the aircraft as it moves between waypoints with range [-15, 15] m/s. The aircraft's actual speed is a combination of the base automatic speed, and the speed control given by the throttle joystick on the remote controller. If autoFlightSpeed >0: Actual speed is autoFlightSpeed + Joystick Speed (with combined max of maxFlightSpeed) If autoFlightSpeed =0: Actual speed is controlled only by the remote controller joystick. If autoFlightSpeed <0 and the aircraft is at the first waypoint, the aircraft will hover in place until the speed is made positive by the remote controller joystick.

      End Mission Behavior
      property
      property finishedAction
      @property(nonatomic, readonly) DJIWaypointV2MissionFinishedAction finishedAction
      Header:DJIWaypointV2Mission.h
      Description:

      Action the aircraft will take when the waypoint mission is complete.

      See Also:

      DJIWaypointV2MissionFinishedAction

      Start Mission behavior
      property
      property gotoFirstWaypointMode
      @property(nonatomic, readonly) DJIWaypointV2MissionGotoFirstWaypointMode gotoFirstWaypointMode
      Header:DJIWaypointV2Mission.h
      Description:

      Defines how the aircraft will go to the first waypoint from its current position. Default is DJIWaypointV2MissionGotoFirstWaypointModeSafely.

      See Also:

      DJIWaypointV2MissionGotoFirstWaypointMode

      Exit Mission On RC Signal Lost
      property
      property exitMissionOnRCSignalLost
      @property(nonatomic, readonly) BOOL exitMissionOnRCSignalLost
      Header:DJIWaypointV2Mission.h
      Description:

      Determines whether the mission should stop when connection between the aircraft and remote controller is lost. Default is NO.

      Repeat Times
      property
      property repeatTimes
      @property(nonatomic, readonly) int repeatTimes
      Header:DJIWaypointV2Mission.h
      Description:

      Mission execution can be repeated more than once. A value of 0 means the mission only executes once, and does not repeat. A value of 1 means the mission will execute a total of two times.

      Get Waypoint At Index
      method
      method waypointAtIndex
      - (nullable DJIWaypointV2 *)waypointAtIndex:(NSUInteger)index
      Header:DJIWaypointV2Mission.h
      Description:

      Gets the waypoint at the specified index in the mission waypoint array.

      Input Parameters:
      NSUInteger indexIndex of the waypoint to be retrieved.
      Return:
      nullable DJIWaypointV2 *The DJIWaypointV2 at the specified index.
      Get All Waypoints
      method
      method allWaypoints
      - (NSArray<DJIWaypointV2 *> *)allWaypoints
      Header:DJIWaypointV2Mission.h
      Description:

      Returns an array of all waypoints in the mission.

      Return:
      NSArray<DJIWaypointV2 *> *An array of DJIWaypointV2 instances contained in the mission.
      Get Waypoint
      method
      method mutableCopy
      - (DJIMutableWaypointV2Mission *)mutableCopy
      Header:DJIWaypointV2Mission.h
      Description:

      Creates a mutable copy of the mission.

      Return:
      DJIMutableWaypointV2Mission *A mutable copy of the mission.
      enum DJIWaypointV2MissionGotoFirstWaypointMode
      typedef NS_ENUM (NSInteger, DJIWaypointV2MissionGotoFirstWaypointMode)
      Header:DJIWaypointV2MissionTypes.h
      Description:

      Possible flight mode to executes the mission.

      Enum Members:
      DJIWaypointV2MissionGotoFirstWaypointModeSafelyGo to the waypoint safely. The aircraft will rise to the same altitude of the waypoint if the current altitude is lower then the waypoint altitude. It then goes to the waypoint coordinate from the current altitude, and proceeds to the altitude of the waypoint.
      DJIWaypointV2MissionGotoFirstWaypointModePointToPointGo to the waypoint from the current aircraft point to the waypoint directly.
      enum DJIWaypointV2MissionExecutionState
      typedef NS_ENUM (uint8_t, DJIWaypointV2MissionExecutionState)
      Header:DJIWaypointV2MissionTypes.h
      Description:

      Current waypoint mission executing state.

      Enum Members:
      DJIWaypointV2MissionExecutionStateInitializingWaypoint mission is initializing, which means the mission has started.
      DJIWaypointV2MissionExecutionStateGoToFirstWaypointAircraft is currently is going to the first waypoint.
      DJIWaypointV2MissionExecutionStateMovingAircraft is currently moving.
      DJIWaypointV2MissionExecutionStateInterruptedAircraft is currently interrupted by user.
      DJIWaypointV2MissionExecutionStateFinishedThe aircraft finished the waypoint mission and is leaving from the last waypoint.
      DJIWaypointV2MissionExecutionStateGoHomeAircraft has returned to the home point. This happens when the finishedAction is set to DJIWaypointV2MissionFinishedActionGoHome.
      DJIWaypointV2MissionExecutionStateLandingAircraft has been landing. This happens when the finishedAction is set to DJIWaypointV2MissionFinishedActionAutoLanding.
      DJIWaypointV2MissionExecutionStateReturnToFirstWaypointAircraft has returned to the first waypoint. This happens when the finishedAction is set to DJIWaypointV2MissionFinishedActionGoToFirstWaypoint.
      DJIWaypointV2MissionExecutionStateUnknownUnknown execution state.
      enum DJIWaypointV2ActionExecutionEvent
      typedef NS_ENUM (uint8_t, DJIWaypointV2ActionExecutionEvent)
      Header:DJIWaypointV2MissionTypes.h
      Description:

      Current waypoint mission action executing event.

      Enum Members:
      DJIWaypointV2ActionExecutionEventBeginActionAction begin execute event.
      DJIWaypointV2ActionExecutionEventFinishedActionAction finished execute event.
      DJIWaypointV2ActionExecutionEventUnknownUnknown action event.