DJIFlightController

Constructs a DJIFlightController object.

Starts auto-landing of the aircraft. Landing is considered complete once the aircraft lands on the ground, and powers down propellers to medium throttle.

Stops auto-landing of the aircraft. If called before autoLanding is complete, then the auto landing will be cancelled (autoLanding will return an error) and the aircraft will hover at its current location.

The aircraft will stop going home and will hover in place. The goHome() completion callback will immediately return an error.

Stops aircraft takeoff. If called before takeoff() is complete, the aircraft will cancel takeoff (takeoff will return an error) and hover at the current height.

Confirms to continue the landing action. When the clearance between the aircraft and the ground is less than 0.3m, the aircraft will pause landing and wait for user's confirmation. Can use `isLandingConfirmationNeeded` in `DJIFlightControllerCurrentState` to check if confirmation is needed. It is supported by flight controller firmware 3.2.0.0 or above.

Disable virtual stick control mode. It is not supported by Mavic Pro when using the WiFi connection.

Enables virtual stick control mode. By enabling virtual stick control mode, the aircraft can be controlled using sendVirtualStickFlightControlData(). It is not supported by Mavic Pro when using the WiFi connection.

Compass object.

Gets the control mode of the flight controller. It is only supported by A3.

Returns the current state of flight controller.

Gets the flight controller's firmware version.

Gets the FailSafe action for when the connection between remote controller and aircraft is lost.

FlightLimitation object. This object sets, gets and tracks state of the maximum flight height and radius allowed.

Gets the minimum altitude (relative to the take off location in meters) the aircraft must be at before going home.

Gets the go home battery percentage threshold with range [25, 50].

Gets the home point of the aircraft.

Gets the horizontal control coordinate system.

IntelligentFlightAssistant object.

Gets if the LEDs in the front is enabled or not. It is only supported by Phantom 3 series, Phantom 4, Phantom 4 Pro, Mavic Pro and Inspire 2.

Gets the land immediately battery percentage threshold with range [10, 25].

Landing gear object. For products with movable landing gear only (Inspire 1 and Inspire 1 Pro).

The number of IMU module in the flight controller. Most products have 1 IMU Exceptions: - Phantom 4, Phantom 4 Pro, Mavic Pro and Inspire 2 have 2 IMUs - A3, Matrice 600 and Matrice 600 Pro have 1 inner IMU and can have at most 2 external IMUs. - N3 has 2 inner IMUs and can have 1 external IMU.

Gets the mapping between the flight modes and the flight mode switch positions on the remote controller. Elements 0, 1 and 2 of the returning array to `DJIRemoteControllerFlightModeSwitchPosition.One`, `DJIRemoteControllerFlightModeSwitchPosition.Two` and `DJIRemoteControllerFlightModeSwitchPosition.Three` of the `flightModeSwitch` in `DJIRCHardwareState`. The value of each Enum item is representing the corresponding index of the DJIFlightControllerRemoteControllerFlightMode array representing the flight mode. The mapping is fixed for Phantom series, Inspire series, Mavic Pro and the M100. For N3, A3, Matrice 600, and Matrice 600 Pro the mapping is firmware dependent. With firmware version 3.2.11.0 or above, the mapping can be customized in DJI Assistant 2.

Returns the roll and pitch control mode.

Gets the Roll and Pitch control coordinate system.

Rtk object.

Simulator object.

Gets if terrain follow mode is enabled or not. It is only supported by Mavic Proa nd Phantom 4 Pro.

Gets if tripod mode is enabled or not. It is only supported by Mavic Pro.

Returns the vertical control mode.

Gets abilities of virtual stick advanced mode. true if the advanced mode of Virtual Stick is enabled. By default, it is false. When the advanced mode is enabled, aircraft will have wind compensation ability when it is hover and the GPS signal is good. For Phantom 4, virtual stick mode will have collision avoidance ability when the advanced mode is enabled and the collision avoidance is enabled in DJIIntelligentFlightAssistant. It is only supported by flight controller firmware version 3.1.x.x or above.

Gets the yaw control mode.

The aircraft will start to go home. This method is considered complete once the aircraft has landed at its home position.

true if the product supports IntelligentFlightAssistant.

true if the clearance between the aircraft and the ground is less than 0.3m and confirmation from the user is needed to continue the landing. When the confirmation is needed, user can use `confirmLandingWithCompletion` in DJIFlightController to continue the landing. It is supported by flight controller firmware 3.2.0.0 or above.

true if moving the landing gear is supported for the connected drone.

Checks if the onboard SDK device is available

true if the product supports RTK.

Indicates whether the virtual stick control interface can be used. If there is a mission running in the mission manager, this property will be NO.

Locks the current heading of the aircraft as the Course Lock. Used when Flight Orientation Mode is DJIFlightOrientationModeCourseLock.

If there is a device connected to the aircraft using the Onboard SDK, then this method will send data to that device. The size of the data cannot be greater than 100 bytes, and will be sent in 40 byte increments every 14ms. This method is only supported on products that support the Onboard SDK (Matrice 100).

Sends flight control data using virtual stick commands. The isVirtualStickControlModeAvailable property must be true to use virtual stick commands. Virtual stick commands should be sent to the aircraft between 5 Hz and 25 Hz. If virtual stick commands are not sent frequently enough the aircraft may regard the connection as broken which will cause the aircraft to hover in place until the next command comes through.

Enable/disable Auto Quick Spin. When the gimbal reaches a yaw movement limit, the aircraft will automatically rotate the aircraft 360 degrees to uniwind the gimbal, allowing it to continue moving in the yaw direction. It is only available when the aircraft is flying at least 3m above the ground. Only supported by Inspire 2.

Sets the control mode of the flight controller. By default the value is DJIFlightControllerControlMode.Smart. It is highly recommended to keep the default value. See DJIFlightControllerControlMode for details. It is only supported by stand-alone A3.

Sets the FailSafe action for when the connection between remote controller and aircraft is lost.

Sets the aircraft flight orientation relative to the Aircraft Heading, Course Lock or Home Lock. See the Flight Controller User Guide for more information about flight orientation.

Sets the minimum altitude relative to where the aircraft took off that the aircraft must be at before going home. This can be useful when the user foresees obstacles in the aircraft’s way. If the aircraft’s current altitude is higher than the minimum go home altitude, it will go home at its current altitude. The valid range for the altitude is from 20m to 500m.

Sets the go home battery percentage threshold with range [25, 50].

Sets the home location of the aircraft. The home location is used as the location the aircraft goes to when commanded by goHome(), when the signal to the aircraft is lost or when the battery is below the lowBatteryWarning threshold. The user should be careful where they set a new home point location as in some scenarios the product will not be in control of the user when going to this location.

A home location is valid if it is within 30m of:

Sets the home point of the aircraft with the current location of the aircraft. See setHomeLocation() for details on when the home point is used

Sets the horizontal coordinate system.

Turns on/off the LEDs in the front. The LEDs are used to indicate the status of the aircraft. By default, it is on. It is only supported by Phantom 3 series, Phantom 4, Phantom 4 Pro, Mavic Pro and Inspire 2.

Sets the land immediately battery percentage threshold with range [10, 25].

Set up the IMU State callback which will receive the changed state of the IMU.

Sets the callback function that updates the data received from an external device (e.g. the onboard device). It is only supported for the Matrice 100.

Sets the no fly zone state receiving callback from the flight controller.

Sets the Roll and Pitch control mode.

Enable/disable terrain follow mode. The aircraft uses height information gathered by the onboard ultrasonic system, and its downward facing cameras to keep flying at the same height above the ground. It is only supported by Mavic Pro and Phantom 4 Pro.

Enable/disable tripod mode. Tripod Mode drops the aircraft’s maximum speed to 2.2mph (3.6kph), and significantly reduces the control stick sensitivity of the remote controller to give the user the precision needed for accurate framing. When tripod mode is enabled, missions, terrain follow mode, course lock and home lock are not allowed. Tripod mode is not allowed if the aircraft is running a mission. If GPS or vision positioning isn't available, tripod mode cannot be enabled. If the GPS and/or the vision system is providing the flight controller with velocity information then the aircraft will be able to automatically compensate for wind. If however, position information is not available, then manual intervention will be required, but the user should beware any manual compensation will be limited due to the reduced maximum velocity and sensitivity. If GPS and vision position become unavailable during tripod mode, it is recommended to alert the user and disable tripod mode. It is only supported by Mavic Pro.

Sets the callback function that updates the flight controller's current state data. This method is called 10 times per second.

Sets the vertical control mode.

Sets if Virtual Stick advanced mode is enabled. By default, it is false. When advanced mode is enabled, the aircraft will compensate for wind when hovering and the GPS signal is good. For the Phantom 4, collision avoidance can be enabled for virtual stick control if advanced mode is on, and collision avoidance is enabled in DJIIntelligentFlightAssistant. It is only supported by flight controller firmware versions 3.1.x.x or above.

Sets the yaw control coordinate system.

Start the calibration for IMU with a specific imu ID. For Phantom 4, this method will start the calibration for both IMUs. Please keep the aircraft stationary and horizontal during calibration. The calibration will take 5 - 10 minutes.

Starts the calibration for IMU with a specific index. Please keep stationary and horizontal during calibration. The calibration will take 5 ~ 10 minutes. The completion callback will be called once the calibration is started. Please set up the DJIFlightControllerDelegate.FlightControllerIMUStateChangedCallback to check the execution status of the IMU calibration. Only supported by Matrice 600.

Starts aircraft takeoff. Takeoff is considered complete when the aircraft is hovering 1.2 meters (4 feet) above the ground. DJICompletionCallback is called when the aircraft crosses 0.5 meters (1.6 feet).
If the motors are already on, this command cannot be executed.

Turns off the aircraft's motors. The method can only be called when the aircraft is on the ground.

Turns on the aircraft's motors. Currently this is only supported by the M100.