DJI Mobile SDK Documentation

      class DJIWaypointV2

      @interface DJIWaypointV2 : NSObject
      Header:DJIWaypointV2.h
      Inherits From:NSObject
      Description:

      The class represents a target point in the waypoint mission. For a waypoint mission, a flight route consists of multiple DJIWaypointV2 objects.

      Class Members:
      Coordinate
      property
      property coordinate
      @property(nonatomic, assign) CLLocationCoordinate2D coordinate
      Header:DJIWaypointV2.h
      Description:

      Waypoint coordinate latitude and longitude in degrees.

      Altitude
      property
      property altitude
      @property(nonatomic, assign) float altitude
      Header:DJIWaypointV2.h
      Description:

      Altitude of the aircraft in meters when it reaches waypoint. The altitude of the aircraft is relative to the ground at the take-off location, has a range of [-200,500], and should not be larger than the aircraft's maximum altitude. If two adjacent waypoints have different altitudes, the altitude will gradually change as the aircraft flies between waypoints.

      Point of Interest
      property
      property pointOfInterest
      @property(nonatomic, assign) CLLocationCoordinate2D pointOfInterest
      Header:DJIWaypointV2.h
      Description:

      Property is used when headingMode is DJIWaypointV2HeadingModeTowardPointOfInterest. Aircraft will always be heading to point while executing mission. Default is "kCLLocationCoordinate2DInvalid".

      Point of Interest Altitude
      property
      property pointOfInterestAltitude
      @property(nonatomic, assign) float pointOfInterestAltitude
      Header:DJIWaypointV2.h
      Description:

      Property is used when headingMode is DJIWaypointV2HeadingModeTowardPointOfInterest. The altitude of the aircraft is relative to the ground at the take-off location, has a range of [-200,500], and should not be larger than the aircraft's maximum altitude.

      Flight Path Mode
      property
      property flightPathMode
      @property(nonatomic, assign) DJIWaypointV2FlightPathMode flightPathMode
      Header:DJIWaypointV2.h
      Description:

      Flight path mode waypoint of the aircraft as it moves between waypoints. Default is DJIWaypointV2FlightPathModeGoToPointAlongACurveAndStop.

      See Also:

      DJIWaypointV2FlightPathMode

      Heading Mode
      property
      property headingMode
      @property(nonatomic, assign) DJIWaypointV2HeadingMode headingMode
      Header:DJIWaypointV2.h
      Description:

      Heading of the aircraft as it moves between waypoints. Default is DJIWaypointV2HeadingModeAuto.

      See Also:

      DJIWaypointV2HeadingMode

      Heading
      property
      property heading
      @property(nonatomic, assign) NSInteger heading
      Header:DJIWaypointV2.h
      Description:

      The heading to which the aircraft will rotate by the time it reaches the waypoint. The aircraft heading will gradually change between two waypoints with different headings if the waypoint mission's DJIWaypointV2HeadingMode is set to DJIWaypointV2HeadingModeWaypointCustom. A heading has a range of [-180, 180] degrees, where 0 represents True North.

      Turn Mode
      property
      property turnMode
      @property(nonatomic, assign) DJIWaypointV2TurnMode turnMode
      Header:DJIWaypointV2.h
      Description:

      Determines whether the aircraft will turn clockwise or anticlockwise when changing its heading.

      See Also:

      DJIWaypointV2TurnMode

      Use Waypoint Max Flight Speed
      property
      property isUsingWaypointMaxFlightSpeed
      @property(nonatomic, assign) BOOL isUsingWaypointMaxFlightSpeed
      Header:DJIWaypointV2.h
      Description:

      Determines whether the aircraft using waypoint max flight speed executing waypoint mission. If YES, the aircraft will use waypoint max flight speed between two waypoints. Otherwise, will use maxFlightSpeed as max flight speed.

      Max Flight Speed
      property
      property maxFlightSpeed
      @property(nonatomic, assign) float maxFlightSpeed
      Header:DJIWaypointV2.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.

      Use Waypoint Auto Flight Speed
      property
      property isUsingWaypointAutoFlightSpeed
      @property(nonatomic, assign) BOOL isUsingWaypointAutoFlightSpeed
      Header:DJIWaypointV2.h
      Description:

      Determines whether the aircraft using waypoint auto flight speed executing waypoint mission. If YES, the aircraft will use waypoint auto flight speed between two waypoints. Otherwise, will use autoFlightSpeed as max flight speed.

      Auto Flight Speed
      property
      property autoFlightSpeed
      @property(nonatomic, assign) float autoFlightSpeed
      Header:DJIWaypointV2.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. In flight controller firmware 3.2.10.0 or above, different speeds between individual waypoints can also be set in waypoint objects which will overwrite autoFlightSpeed.

      Damping Distance
      property
      property dampingDistance
      @property(nonatomic, readwrite) float dampingDistance
      Header:DJIWaypointV2.h
      Description:

      Corner radius of the waypoint. When the flight path mode is DJIWaypointV2FlightPathModeCoordinateTurn the flight path near a waypoint will be acurve (rounded corner) with radius [0.2,1000]. When there is a corner radius, the aircraft will never pass the waypoint. By default, the radius is 0.2 m. If the corner is made of three adjacent waypoints (Short for A,B,C). Then the radius of A(short for Ra) plus radius of B(short for Rb) must be smaller than the distance between A and B. The radius of the first and the last waypoint in a mission does not affect the flight path and it should keep the default value (0.2m). When the flight path mode is DJIWaypointV2FlightPathModeGoToFirstPointAlongAStraightLine When aircraft reaches the first waypoint, The flight path will be a straight flight with this distance. When the flight path mode is DJIWaypointV2FlightPathModeStraightOut The flight path will be a straight flight with this distance before until last waypoint.

      Initialize With Coordinate
      method
      method initWithCoordinate
      - (id)initWithCoordinate:(CLLocationCoordinate2D)coordinate
      Header:DJIWaypointV2.h
      Description:

      Initiate instance with specific waypoint.

      Input Parameters:
      CLLocationCoordinate2D coordinateCoordinate Object.
      Return:
      idA DJIWaypointV2 object initialized with CLLocationCoordinate2D struct.
      enum DJIWaypointV2FlightPathMode
      typedef NS_ENUM (NSUInteger, DJIWaypointV2FlightPathMode)
      Header:DJIWaypointV2.h
      Description:

      Waypoint flight path mode.

      Enum Members:
      DJIWaypointV2FlightPathModeGoToPointAlongACurveIn the mission, the aircraft will go to the waypoint along a curve and fly past the waypoint.
      DJIWaypointV2FlightPathModeGoToPointAlongACurveAndStopIn the mission, the aircraft will go to the waypoint along a curve and stop at the waypoint.
      DJIWaypointV2FlightPathModeGoToPointInAStraightLineAndStopIn the mission, the aircraft will go to the waypoint along a straight line and stop at the waypoint.
      DJIWaypointV2FlightPathModeCoordinateTurnIn the mission, the aircraft will fly from the previous waypoint to the next waypoint along a smooth curve without stopping at this waypoint. the next in a curved motion, adhering to the dampingDistance, which is set in DJIWaypointV2.
      DJIWaypointV2FlightPathModeGoToFirstPointAlongAStraightLineIn the mission, the aircraft will go to the first waypoint along a straight line. This is only valid for the first waypoint.
      DJIWaypointV2FlightPathModeStraightOutStraight exit the Last waypoint, Only valid for last waypoint.
      DJIWaypointV2FlightPathModeUnknownUnknown.
      enum DJIWaypointV2HeadingMode
      typedef NS_ENUM (NSUInteger, DJIWaypointV2HeadingMode)
      Header:DJIWaypointV2.h
      Description:

      Represents current aircraft's heading mode on current waypoint.

      Enum Members:
      DJIWaypointV2HeadingModeAutoAircraft's heading will always be in the direction of flight.
      DJIWaypointV2HeadingModeFixedAircraft's heading will be set to the heading when reaching the first waypoint. Before reaching the first waypoint, the aircraft's heading can be controlled by the remote controller. When the aircraft reaches the first waypoint, its heading will be fixed.
      DJIWaypointV2HeadingModeManualThe aircraft's heading in the mission can be controlled by the remote controller.
      DJIWaypointV2HeadingModeWaypointCustomIn the mission, the aircraft's heading will change dynamically and adapt to the heading set at the next waypoint. See heading to preset the heading.
      DJIWaypointV2HeadingModeTowardPointOfInterestAfter the first waypoint has been reached, aircraft heading will always toward to the point of interest. Using pointOfInterest and pointOfInterestAltitude to set the coordinate of point of interest.
      DJIWaypointV2HeadingModeUnknownUnknown.
      enum DJIWaypointV2TurnMode
      typedef NS_ENUM (NSUInteger, DJIWaypointV2TurnMode)
      Header:DJIWaypointV2.h
      Description:

      The direction when the aircraft changes its heading to adapt to the heading at the waypoint.

      Enum Members:
      DJIWaypointV2TurnModeClockwiseThe aircraft's heading rotates clockwise.
      DJIWaypointV2TurnModeCounterClockwiseThe aircraft's heading rotates counterclockwise.
      DJIWaypointV2TurnModeUnknownChanges the heading of the aircraft by rotating the aircraft anti-clockwise.