Skip to main content

Remote controller class

class AutelRemoteController​

method setConnectStateListener​

void setConnectStateListener
       (CallbackWithOneParam<RemoteControllerConnectState> listener);

Description: Listens for connection of the remote controller.

Input parameter: None

Output parameter: Listens for real-time data changes.

Related parameter: RemoteControllerConnectState

method setRemoteButtonControllerListener​

void setRemoteButtonControllerListener
        (CallbackWithOneParam<RemoteControllerNavigateButtonEvent> listener);

Description: Listens for buttons of the remote controller.

Input parameter: None

Output parameter: Remote controller button event callback

Related parameter: RemoteControllerNavigateButtonEvent

method setInfoDataListener​

void setInfoDataListener
    (CallbackWithOneParam<RemoteControllerInfo> listener);

Description: Listens for real-time state of the remote controller.

Input parameter: None

Output parameter: Real-time data of the remote controller is reported automatically every 1s.

Related parameter: RemoteControllerInfo

method setControlMenuListener​

void setControlMenuListener(CallbackWithOneParam<int[]> listener);

Description: Sets listeners for sticks, gimbal remote control, control buttons, flight mode, and combination buttons to monitor real-time data.

Input parameter: None

Output parameter: API callback representing remote control information. The int array information as follows:

 int[] An array with a length of 6;
 Subscripts 0, 1, 2, and 3 represent the orientation of remote sensing: right and horizontal, right and vertical, left and horizontal, left and vertical.
 The value range of int[0-3] is 359-1689.
 Subscript 4 and 5 represent the control buttons and gimbal rotation angle.

 int[4]:
 359: no data;
 454: auto takeoff/landing;
 549: return to home;
 644: hover;
 739: stop a mission;
 834: customizable button A;
 929: customizable button B;
 1024: a combination of customizable buttons;
 1119: compass calibration;
 1214: exit the virtual command bar;
 1309: mode 2;
 1404: mode 3;
 1499: mode 1;
 1594: customizable mode 1;
 1689: customizable mode 2;
The value range of int[5] is 359-1689. It represents the gimbal rotation angle.

Related parameter: None

method setLanguage​

void setLanguage
    (RemoteControllerLanguage language, CallbackWithNoParam callback);

Description: Sets the language of the remote controller.

Input parameter: Language: English, Chinese

Output parameter: Callback of the setting result

Related parameter: None

method getLanguage​

void getLanguage
    (CallbackWithOneParam<RemoteControllerLanguage> callback);

Description: Obtains the language of the remote controller.

Input parameter: None

Output parameter: Callback of the current remote control language

Related parameter: None

method enterPairing​

void enterPairing(CallbackWithNoParam callback);

Description: Enters the pairing mode.

Input parameter: None

Output parameter: Callback of whether pairing is successful

Related parameter: None

method exitPairing​

void exitPairing();

Description: Exits the pairing mode.

Input parameter: None

Output parameter: None

Related parameter: None

method setRFPower​

void setRFPower
    (RFPower mAutelRFPower, CallbackWithNoParam callback);

Description: Sets the RF power.

Input parameter: RF power enumeration: FCC, CE, UNKNOWN

Output parameter: Callback of the setting result

Related parameter: None

method getRFPower​

 void getRFPower(CallbackWithOneParam<RFPower> callback);

Description: Obtains the RF power.

Input parameter: None

Output parameter: Callback of the RF power result

Related parameter: None

method setTeachingMode​

void setTeachingMode
     (TeachingMode tMode, CallbackWithNoParam callback);

Description: Sets the remote control mode. Note: Only Xstar and Xstar Premium support the teaching mode.

Input parameter: Enumeration value of the remote control mode: DISABLED, TEACHER,STUDENT,UNKNOWN

Output parameter: Callback of the setting result

Related parameter: None

method getTeachingMode​

void getTeachingMode
    (CallbackWithOneParam<TeachingMode> callback);

Description: Obtains the remote control mode. Note: Only Xstar and Xstar Premium support the teaching mode.

Input parameter: None

Output parameter: Callback of the remote control mode result

Related parameter: None

method setStickCalibration​

void setStickCalibration
    (RemoteControllerStickCalibration step,CallbackWithNoParam callback);

Description: Sets the remote controller calibration procedure.

Input parameter: Enumeration values of the remote controller calibration procedure: START ,EXIT, COMPLETE.

Output parameter: Callback of the setting result

Related parameter: None

method setParameterUnit​

void setParameterUnit
    (RemoteControllerParameterUnit unit,CallbackWithNoParam callback);

Description: Sets the unit of remote controller parameters.

Input parameter: Enumeration values of the unit of remote controller parameters: IMPERIAL, METRIC.

Output parameter: Callback of the setting result

Related parameter: None

method getLengthUnit​

void getLengthUnit
     (CallbackWithOneParam<RemoteControllerParameterUnit> callback);

Description: Obtains the unit of remote controller parameters.

Input parameter: None

Output parameter: Callback of the remote controller measurement unit. Enumeration values of the unit: IMPERIAL, METRIC.

Related parameter: None

method setCommandStickMode​

void setCommandStickMode
    (RemoteControllerCommandStickMode model,CallbackWithNoParam callback);

Description: Sets the operation mode of the remote controller.

Input parameter: Enumeration values of the operation mode: USA, CHINA, JAPAN.

Output parameter: Callback of the setting result

Related parameter: None

method getCommandStickMode​

void getCommandStickMode
     (CallbackWithOneParam<RemoteControllerCommandStickMode> callback);

Description: Obtains the operation mode of the remote controller.

Input parameter: None

Output parameter: Callback of the remote controller operation mode

Related parameter: None

method setYawCoefficient​

void setYawCoefficient
    (float yawSenCoe, CallbackWithNoParam callback);

Description: Sets the remote controller sensitivity.

Input parameter: Sensitivity range: 0.2f-0.7f

Output parameter: Callback of the setting result

Related parameter: None

method getYawCoefficient​

void getYawCoefficient
    (CallbackWithOneParam<Float> callback);

Description: Obtains the remote controller sensitivity.

Input parameter: None

Output parameter: Returns the remote controller sensitivity: 0.2f-0.7f

Related parameter: None

method getVersionInfo​

void getVersionInfo
    (CallbackWithOneParam<RemoteControllerVersionInfo> callback);

Description: Obtains the remote controller version information.

Input parameter: None

Output parameter: Callback of the remote controller version information result

Related parameter: RemoteControllerVersionInfo

method setRemoteDeviceSequence​

void setRemoteDeviceSequence
    (String remoteDeviceSequence, final CallbackWithNoParam listener);

Description: Sets the remote controller SN.

Input parameter: ： Remote controller SN

Output parameter: Callback of the setting result

Related parameter: None

method getSerialNumber​

void getSerialNumber(CallbackWithOneParam<String> callback);

Description: Obtains the remote controller SN.

Input parameter: None

Output parameter: Callback of the remote controller SN getting result

Related parameter: None

method getParameterRangeManager​

RemoteControllerParameterRangeManager getParameterRangeManager();

Description: Obtains the remote controller parameter manager.

Input parameter: None

Output parameter: Returns the remote controller parameter management class.

Related parameter: RemoteControllerParameterRangeManager

method setGimbalDialAdjustSpeed​

void setGimbalDialAdjustSpeed
    (int speed, CallbackWithNoParam callback);

Description: Sets the gimbal adjustment speed.

Input parameter: Adjustment speed range: 0-100

Output parameter: Callback of the adjustment result

Related parameter: None

method getGimbalDialAdjustSpeed​

void getGimbalDialAdjustSpeed
    (CallbackWithOneParam<Integer> callback);

Description: Obtains the gimbal adjustment speed.

Input parameter: None

Output parameter: Callback of the adjustment speed result

Related parameter: None

method setRcCustomKey​

void setRcCustomKey
    (CustomKey key, CustomFunction function,CallbackWithNoParam callback);

Description: Sets custom keys.

Input parameters: key: custom key; function: trigger method of the custom key

Output parameter: Callback of the setting result

Related parameters: CustomKey, CustomFunction

method getRcCustomKey​

void getRcCustomKey
    (CallbackWithOneParam<Pair<CustomFunction,CustomFunction>> callback);

Description: Obtains custom keys of the remote controller.

Input parameter: None

Output parameter: Callback of the custom key trigger method

Related parameter: CustomFunction

method getRcCustomKeyInfo​

void getRcCustomKeyInfo
    (CallbackWithOneParam<CustomInfo> callback);

Description: Obtains custom keys A, B, and C of the remote controller.

Input parameter: None

Output parameter: Callback of custom key information

Related parameter: None

method restart​

 void setConnectStateListener
        (CallbackWithOneParam<RemoteControllerConnectState> listener);

Description: Restart

Input parameter: Restart type:0: restart image transmission; 1: restart the MCU; 2: restart image transmission and MCU (MCU: main control chip of remote controller)

Output parameter: Callback of the restarting result

Related parameter: None

method setLandType​

void setLandType(int value, CallbackWithNoParam callback);

Description: Sets the type of the remote controller.

Input parameter: Type: 0 - normal aircraft, 1 - aircraft with a landing platform

Output parameter: Callback of the setting result

Related parameter: None


sidebar_position: 1
title: 
slug: /10/1

class CustomKey​

method getValue​

public String getValue()

Description: Obtains the integer value indicating the enumeration of CustomKey.

Input parameter: None

Output parameter: Returns the integer value indicating the enumeration of CustomKey

Related parameter: None

method find​

CustomKey find(String value);

Description: Returns the CustomKey enumeration based on the imported character.

Input parameter: Key to be found

Output parameter: Returns the enumeration value of the key

Related parameter: CustomKey

/**
* 
Custom key of the remote controller is A.
*/
KEY_A("A"),
/**
* 
Custom key of the remote controller is B.
*/
KEY_B("B"),
/**
* 
Custom key of the remote controller is Roll.
*/
KEY_C("C"),
/**
* 
Custom key of the remote controller is unknown.
*/
UNKNOWN("unknown");

sidebar_position: 1
title: 
slug: /10/1

class CustomFunction​

method getValue​

 int getValue();

Description: Obtains the integer value indicating the enumeration of CustomFunction.

Input parameter: None

Output parameter: Returns the integer value indicating the enumeration of CustomFunction.

Related parameter: None

method find​

 CustomFunction find(int value)

Description: Finds CustomFunction from integer values.

Input parameter: None

Output parameter: Enumeration of CustomFunction

Related parameter: CustomFunction

/**
* 
** The custom key function of the remote controller does not exist.
*/
NONE(0),
/**
The custom key function of the remote controller is OA.
*/
OA(1),
/**
The custom key function of the remote controller is AE.
*/
AE(2),
/**
The custom key function of the remote controller is Gimbal reset.
*/
GIMBAL_RESET(3),
/**
The custom key function of the remote controller is Switch codec to map.
*/
CODEC_SW_MAP(4),
/**
* Zoom
*/
ZOOM(5),
/**
* Exposure
*/
EXPOSURE(6),
/**
* Acceleration mode
*/
HORIZONTAL_SPEED(7),
/**
The custom key function of the remote controller is unknown.
*/
UNKNOWN(-1)

sidebar_position: 1
title: 
slug: /10/1

class RemoteControllerParameterUnit​

method getValue​

 int getValue();

Description: Obtains the integer value that indicates the enumeration of RemoteControllerParameterUnit.

Input parameter: None

Output parameter: Integer value of RemoteControllerParameterUnit

Related parameter: RemoteControllerParameterUnit

/**
*
* The measurement unit for the remote controller is metric m/s.
*/
METRIC(0),
/**
*
* The measurement unit for the remote controller is imperial.
*/
IMPERIAL(1),
/**
*
* The measurement unit for the remote controller is metric km/h.
*/
METRIC_KM_H(2),
/**
*
* The measurement unit for the remote controller is unknown.
*/
UNKNOWN(-1);

method find​

RemoteControllerParameterUnit find(int value);

Description: Finds the remote controller parameter unit (RemoteControllerParameterUnit) from integer values.

Input parameter: None

Output parameter: Parameter unit (RemoteControllerParameterUnit) corresponding to the integer value

Related parameter: None


sidebar_position: 1
title: 
slug: /10/1


class RemoteControllerNavigateButtonEvent​

method getKeyValue​

 int getKeyValue();

Description: Obtains the integer value corresponding to the button event.

Input parameter: None

Output parameter: Returns the integer value corresponding to the button event

Related parameter: RemoteControllerNavigateButtonEvent enumeration

method setKeyValue​

 void setKeyValue(int value);

Description: Set the integer value corresponding to the button event.

Input parameter: RemoteControllerNavigateButtonEvent enumeration : START_VIDEO, START_VIDEO_WITH_FOCUS, TAKEN_PHOTO, TAKEN_PHOTO_WITH_FOCUS, CUSTOM_BUTTON_CLICK, CUSTOM_WHEEL_LEFT_SLIDE, CUSTOM_WHEEL_RIGHT_SLIDE, CUSTOM_WHEEL_CLICK, CUSTOM_BUTTON_SHORT_A, CUSTOM_BUTTON_LONG_A, CUSTOM_BUTTON_SHORT_B, CUSTOM_BUTTON_LONG_B, ZOOM_IN, ZOOM_OUT, UNKNOWN

Output parameter: None

Related parameter: RemoteControllerNavigateButtonEvent enumeration

/**
*
Video recording
*/
START_VIDEO,
/**
*
* Focusing and video recording - Press and hold to adjust the focus, and then start recording video.
*/
START_VIDEO_WITH_FOCUS,
/**
*
* Photo taking
*/
TAKEN_PHOTO,
/**
*
* Focusing and photo taking - Press and hold to adjust the focus, and then start recording video.
*/
TAKEN_PHOTO_WITH_FOCUS,
/**
*
* For Xstar Premium and Xstar, this key is used to switch between IOC, GPS and ATTI modes (item 14 in chart of Xstar user manual).

*
* For EVO, this key is used to switch the screen. This key is used to return to the last option when the user is configuring a setting (item 12 in the chart of EVO user manual).

*/
CUSTOM_BUTTON_CLICK,
/**
*
* For Xstar Premium and Xstar, swipe left for advanced camera settings (item 15 in chart of Xstar user manual).

*
* For EVO, swipe left to select a different option in the remote control settings page (item 11 in the chart of EVO user manual).
*/
CUSTOM_WHEEL_LEFT_SLIDE,
/**
*
* For Xstar Premium and Xstar, swipe left for advanced camera settings (item 15 in chart of Xstar user manual).

*
* For EVO, swipe right to select a different option in the remote control settings page (item 11 in the chart of EVO user manual).
*/
CUSTOM_WHEEL_RIGHT_SLIDE,
/**
*
* Briefly press to select the corresponding option (item 15 in the chart of Xstar user manual, item 11 in the chart of EVO user manual).
*/
CUSTOM_WHEEL_CLICK,
/**
*
* Briefly press custom key A to send a message (item 14 in the chart of EVO user manual).
*/
5. Usage examples
CUSTOM_BUTTON_SHORT_A,
/**
*
* Press and hold custom key A to send a message (item 14 in the chart of EVO user manual).
*/
CUSTOM_BUTTON_LONG_A,
/**
*
* Briefly press custom key A to send a message (item 15 in the chart of EVO user manual).
*/
CUSTOM_BUTTON_SHORT_B,
/**
*
* Press and hold custom key B to send a message (item 15 in the chart of EVO user manual).
*/
CUSTOM_BUTTON_LONG_B,
//Zoom in/out
ZOOM_IN,
//Zoom in/out
ZOOM_OUT,
/**
* The remote controller navigation key event is unknown.
*/
UNKNOWN;