class WiFiLink

class WiFiLink extends BaseComponent

Package:	dji.sdk.airlink
Inherits From:	`BaseComponent`

Description:

This class provides methods to change the setting of the product's WiFi. Rebooting WiFi is required in order to make new settings take effect.

Class Members:

State Updates

method

setMagneticInterferenceCallback

method setMagneticInterferenceCallback

void setMagneticInterferenceCallback(MagneticInterferenceCallback callback)

Package:

dji.sdk.airlink

Description:

Sets up the callback for WiFi magnetic interference level.

Input Parameters:

MagneticInterferenceCallback callback

The execution callback with the value(s) returned.

method

setChannelInterferenceCallback

method setChannelInterferenceCallback

void setChannelInterferenceCallback(ChannelInterferenceCallback channelInterferenceCallback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.CHANNEL_INTERFERENCE

Description:

Setter for RSSI callback

Input Parameters:

ChannelInterferenceCallback channelInterferenceCallback your implementation of ChannelInterferenceCallback.

Reboot WiFi

method

reboot

method reboot

void reboot(final CompletionCallback callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.REBOOT

Description:

Reboot WiFi to enable new settings to take effect.

Input Parameters:

final CompletionCallback callback

The execution callback with the value(s) returned.

WiFi SSID

method

setSSID

method setSSID

void setSSID(String ssid, final CompletionCallback callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.SSID

Description:

Sets the WiFi SSID. The setting will take effect only after the product reboots.

Input Parameters:

String ssid	The WiFi SSID to change. It should only include alphabetic characters, numbers, spaces, '-' and should not be more than 30 characters.
final CompletionCallback callback	Remote execution result error callback.

method

getSSID

method getSSID

void getSSID(final CompletionCallbackWith<String> callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.SSID

Description:

Gets the WiFi SSID.

Input Parameters:

final CompletionCallbackWith<String> callback

The execution callback with the returned value(s).

WiFi Password

method

setPassword

method setPassword

void setPassword(String password, final CompletionCallback callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.PASSWORD

Description:

Sets the WiFi Password.

Input Parameters:

String password	The new WiFi password. It must be at least 8 characters and can only includes alphabetic characters and numbers.
final CompletionCallback callback	Remote execution result error callback.

method

getPassword

method getPassword

void getPassword(final CompletionCallbackWith<String> callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.PASSWORD

Description:

Get the WiFi Password.

Input Parameters:

final CompletionCallbackWith<String> callback

The execution callback with the returned value(s).

WiFi Frequency Band

method

setFrequencyBand

method setFrequencyBand

void setFrequencyBand(WiFiFrequencyBand frequencyBand, final CompletionCallback callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.WIFI_FREQUENCY_BAND

Description:

It is not supported by Spark, Mavic Air and DJI Mini 2. For these products, set different channel numbers to select the frequency band.

Input Parameters:

WiFiFrequencyBand frequencyBand	WiFi frequency band to change to.
final CompletionCallback callback	The execution callback with the value(s) returned.

method

getFrequencyBand

method getFrequencyBand

void getFrequencyBand(final CompletionCallbackWith<WiFiFrequencyBand> callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.WIFI_FREQUENCY_BAND

Description:

Gets the current WiFi frequency band. It is not supported by Spark or Mavic Air.

Input Parameters:

final CompletionCallbackWith<WiFiFrequencyBand> callback

The execution callback with the returned value(s).

Channel Selection Mode

method

setSelectionMode

method setSelectionMode

void setSelectionMode(WiFiSelectionMode mode, final CompletionCallback callback)

Package:

dji.sdk.airlink

Description:

Sets the channel selection mode. Both channel number and bandwidth can be changed. If the 5 GHz band is available, then channels from that band can also be used. .

Input Parameters:

WiFiSelectionMode mode	Selection mode to set.
final CompletionCallback callback	The execution callback with the returned value(s).

method

getSelectionMode

method getSelectionMode

void getSelectionMode(final CompletionCallbackWith<WiFiSelectionMode> callback)

Package:

dji.sdk.airlink

Description:

Gets the channel selection mode. .

Input Parameters:

final CompletionCallbackWith<WiFiSelectionMode> callback

The execution callback with the returned value(s).

WiFi Channel

method

setChannelNumber

method setChannelNumber

void setChannelNumber(int channelNumber, final CompletionCallback callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.CHANNEL_NUMBER

Description:

Sets the WiFi channel. setChannelNumber must be used to determine which channels are possible to set. When a new channel is set, the WiFi on the product will reboot. The channel can only be changed when the product is not flying. Supported by Mavic Pro, Mavic Mini, DJI Mini SE.

Input Parameters:

int channelNumber	Index of the channel to select.
final CompletionCallback callback	The execution callback with the returned execution result.

method

getChannelNumber

method getChannelNumber

void getChannelNumber(final CompletionCallbackWith<Integer> callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.CHANNEL_NUMBER

Description:

Gets the WiFi channel. Channels 1-13 are in the 2.4 GHz band. Other channels are in the 5 GHz band.

Input Parameters:

final CompletionCallbackWith<Integer> callback

The execution callback with the returned value(s).

Get Available Channels

method

getAvailableChannelNumbers

method getAvailableChannelNumbers

void getAvailableChannelNumbers(final CompletionCallbackWith<Integer[]> callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.AVAILABLE_CHANNEL_NUMBERS

Description:

Gets the channels available for the current frequency band. When FREQUENCY_BAND_DUAL is selected, channels for both 2.4GHz and 5GHz are available. Supported only by Mavic Pro, Mavic Mini, DJI Mini SE.

Input Parameters:

final CompletionCallbackWith<Integer[]> callback

The completion block with the returned execution result.

WiFi Data Rate

method

setDataRate

method setDataRate

void setDataRate(WifiDataRate rate, final CompletionCallback callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.DATA_RATE

Description:

Sets the WiFi data rate (throughput). Higher data rates increase the quality of video transmission, but can only be used at shorter ranges. It is not supported by Spark or Mavic Air.

Input Parameters:

WifiDataRate rate	Data rate (throughput).
final CompletionCallback callback	The execution callback with the value(s) returned.

method

getDataRate

method getDataRate

void getDataRate(final CompletionCallbackWith<WifiDataRate> callback)

Package:	dji.sdk.airlink
SDK Key:	AirLinkKey.DATA_RATE

Description:

Gets the current data rate (throughput). It is not supported by Spark or Mavic Air.

Input Parameters:

final CompletionCallbackWith<WifiDataRate> callback

The execution callback with the returned value(s).

State Updates

class

MagneticInterferenceCallback

class

ChannelInterferenceCallback

Information

enum

WiFiFrequencyBand

enum WiFiFrequencyBand

@EXClassNullAway
 enum WiFiFrequencyBand

Package:	dji.common.airlink
SDK Key:	AirLinkKey.WIFI_FREQUENCY_BAND

Description:

WiFi frequency band.

Enum Members:

FREQUENCY_BAND_ONLY_2_DOT_4	The WiFi Frequency band is 2.4 GHz.
FREQUENCY_BAND_5_GHZ	The WiFi Frequency band is 5 GHz.
FREQUENCY_BAND_DUAL	Dual frequency band mode. The WiFi frequency band can be either 2.4 GHz or 5 GHz.
UNKNOWN	The WiFi Frequency is unknown.

Class Members:

class

WifiChannelInterference

enum

WiFiMagneticInterferenceLevel

enum WiFiMagneticInterferenceLevel

@EXClassNullAway
 enum WiFiMagneticInterferenceLevel

Package:	dji.common.airlink
SDK Key:	AirLinkKey.MAGNETIC_INTERFERENCE

Description:

WiFi magnetic interference - as measured by Osmo, Phantom 3 4K and Phantom 3 Standard.

Enum Members:

LOW	WiFi magnetic interference is low.
MEDIUM	WiFi magnetic interference is medium. At this level, the video quality will be degraded compared to when the signal quality is low.
HIGH	WiFi magnetic interference is high. At this level, the video quality will be degraded compared to when the signal quality is medium.
UNKNOWN	WiFi magnetic interference is Unknown.

Class Members:

enum

WifiDataRate

enum WifiDataRate

@EXClassNullAway
 enum WifiDataRate

Package:	dji.common.airlink
SDK Key:	AirLinkKey.DATA_RATE

Description:

WiFi data rate. Lower rates are used for longer ranges, but will have lower video quality.

Enum Members:

RATE_1_MBPS	1 Mbps.
RATE_2_MBPS	2 Mbps.
RATE_4_MBPS	4 Mbps.
UNKNOWN	Unknown.

Class Members:

Inherited Methods:

dji.sdk.base.BaseComponent

method

setComponentListener

method setComponentListener

void setComponentListener(ComponentListener listener)

Package:

dji.sdk.base

Description:

Sets the listener for the DJI component.

Input Parameters:

ComponentListener listener The callback of ComponentListener.

method

getIndex

method getIndex

int getIndex()

Package:

dji.sdk.base

Description:

Returns the component index. Index is zero based. A component will have an index greater than zero when there are multiple components of the same type on the DJI product, and one of the components already has the index 0. For instance, M210 can have two gimbal mounted cameras, and will therefore have two gimbal components with indices 0 and 1, and two camera components with indices 0 and 1. For Matrice 600, there are printed numbers on the battery boxes. The Battery component instance with index 0 corresponds to battery compartment number 1. For Inspire 2 and M200 series, Battery with index 0 corresponds to the battery on the port (left hand) side of the aircraft. For M210, M210 RTK, M300 RTK and M350 RTK, Camera and Gimbal with index 0 corresponds to the camera and gimbal on the port (left hand) side of the aircraft. Lidar with index 0 corresponds to the lidar(Zenmuse L1) on the port (left hand) side of the aircraft.

Return:

int	An int value of index.

method

isConnected

method isConnected

boolean isConnected()

Package:

dji.sdk.base

Description:

true if the component is connected.

Return:

boolean true if the component is connected.

method

getSerialNumber

method getSerialNumber

void getSerialNumber(@NonNull CompletionCallbackWith<String> callback)

Package:

dji.sdk.base

Description:

Gets the serial number of the component. Depending on the component, this serial number might not match the serial number found on the physical component.

Input Parameters:

@NonNull CompletionCallbackWith<String> callback

The execution callback with the value returned.

method

getFirmwareVersion

method getFirmwareVersion

void getFirmwareVersion(@NonNull CompletionCallbackWith<String> callback)

Package:

dji.sdk.base

Description:

Returns the firmware version of the component. Each component will have a different firmware version, the combination of which will form the package firmware version getFirmwarePackageVersion found in BaseProduct.

Input Parameters:

@NonNull CompletionCallbackWith<String> callback

The execution callback with the value(s) returned.

Mobile SDK

class WiFiLink

Description:

Class Members:

method setMagneticInterferenceCallback

Description:

Input Parameters:

method setChannelInterferenceCallback

Description:

Input Parameters:

method reboot

Description:

Input Parameters:

method setSSID

Description:

Input Parameters:

method getSSID

Description:

Input Parameters:

method setPassword

Description:

Input Parameters:

method getPassword

Description:

Input Parameters:

method setFrequencyBand

Description:

Input Parameters:

method getFrequencyBand

Description:

Input Parameters:

method setSelectionMode

Description:

Input Parameters:

method getSelectionMode

Description:

Input Parameters:

method setChannelNumber

Description:

Input Parameters:

method getChannelNumber

Description:

Input Parameters:

method getAvailableChannelNumbers

Description:

Input Parameters:

method setDataRate

Description:

Input Parameters:

method getDataRate

Description:

Input Parameters:

Related:

enum WiFiFrequencyBand

Description:

Enum Members:

Class Members:

enum WiFiMagneticInterferenceLevel

Description:

Enum Members:

Class Members:

enum WifiDataRate

Description:

Enum Members:

Class Members:

Inherited Methods:

method setComponentListener

Description:

Input Parameters:

method getIndex

Description:

Return:

method isConnected

Description:

Return:

method getSerialNumber

Description:

Input Parameters:

method getFirmwareVersion

Description: