Live Flight Controls

2025-01-07
No Rating

Event

Authorization result notification

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: cloud_control_auth_notify

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error
outputOutputstruct
»statusTask stateenum_string{"canceled":"Authorization request popup was canceled due to another user's request.","failed":"Error or user denied","ok":"User agreed"}

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"output": {
			"status": "ok"
		},
		"result": 0
	},
	"method": "cloud_control_auth_notify",
	"need_reply": 0,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1704038400000
}

Flyto execution result event notification

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: fly_to_point_progress

Data:

ColumnNameTypeconstraintDescription
fly_to_idFlyto target point IDtext{"length":""}
statusStateenum_string{"wayline_cancel":"Cancel flying to target point","wayline_failed":"Execution failed","wayline_ok":"Executed successfully, flown to target point","wayline_progress":"Executing"}
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error
way_point_indexCurrently executing the nth waypointint{"max":"","min":"","step":"","unit_name":null}
remaining_distanceRemaining mission distancefloat{"max":"","min":"","step":0.1,"unit_name":"Meters / m"}
remaining_timeRemaining mission timefloat{"max":"","min":"","step":0.1,"unit_name":"seconds / s"}
planned_path_pointsList of planned trajectory pointsarray{"size": -, "item_type": struct}
»latitudeLatitude of the trajectory pointdouble{"max":90,"min":-90,"step":"","unit_name":null}Latitude of the trajectory point, angle value, negative for south latitude, positive for north latitude, accurate to 6 decimal places.
»longitudeLongitude of the trajectory pointdouble{"max":180,"min":-180,"step":"","unit_name":null}Longitude of the trajectory point, angle value, east longitude is positive, west longitude is negative, precision to 6 decimal places.
»heightTrajectory point heightfloat{"step":0.1,"unit_name":"Meters / m"}Trajectory point height, ellipsoid height

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"fly_to_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
		"planned_path_points": [
			{
				"height": 123.234,
				"latitude": 13.23,
				"longitude": 123.234
			}
		],
		"remaining_distance": 0,
		"remaining_time": 0,
		"result": 0,
		"status": "wayline_progress",
		"way_point_index": 0
	},
	"need_reply": 1,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 16540709686556,
	"method": "fly_to_point_progress"
}

One-key takeoff result event notification

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: takeoff_to_point_progress

Data:

ColumnNameTypeconstraintDescription
statusTask stateenum_string{"task_finish":"One-key takeoff mission completed","task_ready":"Ready for takeoff","wayline_cancel":"Cancel flying to target point","wayline_failed":"Execution failed","wayline_ok":"Executed successfully, flown to target point","wayline_progress":"Executing"}
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}
flight_idOne-key takeoff mission UUIDtext{"length":""}
track_idTrack IDtext{"length":""}
way_point_indexCurrently executing the nth waypointint{"max":"","min":"","step":"","unit_name":null}
remaining_distanceRemaining mission distancefloat{"max":"","min":"","step":0.1,"unit_name":"Meters / m"}
remaining_timeRemaining mission timefloat{"max":"","min":"","step":0.1,"unit_name":"seconds / s"}
planned_path_pointsList of planned trajectory pointsarray{"size": -, "item_type": struct}
»latitudeLatitude of the trajectory pointdouble{"max":90,"min":-90,"step":"","unit_name":null}Latitude of the trajectory point, angle value, negative for south latitude, positive for north latitude, accurate to 6 decimal places.
»longitudeLongitude of the trajectory pointdouble{"max":180,"min":-180,"step":"","unit_name":null}Longitude of the trajectory point, angle value, east longitude is positive, west longitude is negative, precision to 6 decimal places.
»heightTrajectory point heightfloat{"max":"","min":"","step":0.1,"unit_name":"Meters / m"}Trajectory point height, ellipsoid height

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"flight_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
		"planned_path_points": [
			{
				"height": 123.234,
				"latitude": 13.23,
				"longitude": 123.234
			}
		],
		"remaining_distance": 0,
		"remaining_time": 0,
		"result": 0,
		"status": "wayline_ok",
		"track_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
		"way_point_index": 1
	},
	"need_reply": 1,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 16540709686556,
	"method": "takeoff_to_point_progress"
}

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: drc_status_notify

Data:

ColumnNameTypeConstraintDescription
resultReturn codeintNon-zero represents an error
drc_stateDRC statusenum_int{"0":"Not connected","1":"Connecting","2":"Connected"}

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"drc_state": 2,
		"result": 0
	},
	"need_reply": 1,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "drc_status_notify"
}

Notification of DRC - flight control invalidity reasons

The DRC - flight control is an integrated control feature for the aircraft. If it is unavailable, the drone_control capability cannot be used for manual operation.

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: joystick_invalid_notify

Data:

ColumnNameTypeConstraintDescription
reasonTask stateint{"0":"Remote controller lost connection","1":"Low battery return","2":"Low battery landing","3":"Close to the flight restriction zone","4":"Remote controller takeover control authority (for example, triggered return, B control takeover)"}

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"reason": 0
	},
	"need_reply": 1,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "joystick_invalid_notify"
}

Upload capture progress

When the photo-taking action needs to continue, progress will be reported through this event. Currently, only the panoramic photo mode is supported.

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: camera_photo_take_progress

Data:

ColumnNameTypeConstraintDescription
outputOutputstruct
»statusCapturing stateenum_string{"fail":"Failed","in_progress":"In progress","ok":"Finished"}
»progressProgressstruct
»»current_stepExecuting resultenum_int{"3000":"Capturing panorama has not started or is finished","3002":"Capturing panorama","3005":"Generating panorama"}
»»percentPercentint{"max":"100","min":"0","step":"1"}
»extExpanded contentstruct
»»camera_modeCurrent camera modeenum_int{"3":"Panorama"}
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"output": {
			"ext": {
				"camera_mode": 3
			},
			"progress": {
				"current_step": 0,
				"percent": 100
			},
			"status": "ok"
		},
		"result": 0
	},
	"need_reply": 1,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "camera_photo_take_progress"
}

Topic: thing/product/{gateway_sn}/drc/up

Direction: up

Method: delay_info_push

Data:

ColumnNameTypeConstraintDescription
sdr_cmd_delayDelay in the transmission protocol command linkint{"max":"","min":"","step":"","unit_name":"milliseconds / ms"}Delay in the transmission protocol command link
liveview_delay_listVideo transmission video stream delayarray{"size": -, "item_type": struct}
»video_idStream numbertext{"length":""}Stream number
»liveview_delay_timeStream delayint{"max":"","min":"","step":"","unit_name":"milliseconds / ms"}Stream delay

Example:

{
	"data": {
		"liveview_delay_list": [
			{
				"liveview_delay_time": 60,
				"video_id": "1581BN210004555439234/52-0-0/normal-0"
			},
			{
				"liveview_delay_time": 80,
				"video_id": "1581BN210004555439234/53-0-0/normal-0"
			}
		],
		"sdr_cmd_delay": 10
	},
	"timestamp": 1670415891013,
	"method": "delay_info_push"
}

DRC-obstacle avoidance information pushing

Topic: thing/product/{gateway_sn}/drc/up

Direction: up

Method: hsi_info_push

Data:

ColumnNameTypeconstraintDescription
up_distanceUpward obstacle distanceint{"max":"","min":"","step":"","unit_name":"Millimeters / mm"}
down_distanceDownward obstacle distanceint{"max":"","min":"","step":"","unit_name":"Millimeters / mm"}
up_enableUpward obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
up_workUpward obstacle sensing work statebool{"0":"Disable","1":"Enable"}
down_enableDownward obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
down_workDownward obstacle sensing work statebool{"0":"Disable","1":"Enable"}
around_distancesDistances to surrounding obstaclesarray{"size": -, "item_type": int}
left_enableLeft obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
left_workLeft obstacle sensing working statebool{"0":"Disable","1":"Enable"}
right_enableRight obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
right_workRight obstacle sensing working statebool{"0":"Disable","1":"Enable"}
front_enableForward obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
front_workForward obstacle sensing working statebool{"0":"Disable","1":"Enable"}
back_enableBackward obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
back_workBackward obstacle sensing working statebool{"0":"Disable","1":"Enable"}
vertical_enableVertical obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
vertical_workVertical obstacle sensing working statebool{"0":"Disable","1":"Enable"}
horizontal_enableHorizontal obstacle sensing switch statebool{"0":"Disable","1":"Enable"}
horizontal_workHorizontal obstacle sensing work statebool{"0":"Disable","1":"Enable"}

Example:

{
	"data": {
		"around_distance": [
			10,
			8,
			9,
			16,
			2
		],
		"back_enable": true,
		"back_work": true,
		"down_distance": 10,
		"down_enable": true,
		"down_work": true,
		"front_enable": true,
		"front_work": true,
		"horizontal_enable": true,
		"horizontal_work": true,
		"left_enable": true,
		"left_work": true,
		"right_enable": true,
		"right_work": true,
		"up_distance": 10,
		"up_enable": true,
		"up_work": true,
		"vertical_enable": true,
		"vertical_work": true
	},
	"timestamp": 1670415891013,
	"method": "hsi_info_push"
}

Return home information

Topic: thing/product/{gateway_sn}/events

Direction: up

Method: return_home_info

Data:

ColumnNameTypeConstraintDescription
planned_path_pointsList of planned trajectory pointsarray{"size": -, "item_type": struct}
»latitudeLatitude of the trajectory point (angle value)double{"max":90,"min":-90}Latitude of the trajectory point, angle value, negative for south latitude, positive for north latitude, accurate to 6 decimal places.
»longitudeLongitude of the trajectory point (angle value)double{"max":180,"min":-180}Longitude of the trajectory point, angle value, east longitude is positive, west longitude is negative, precision to 6 decimal places.
»heightTrajectory point heightfloat{"max":"","min":"","step":0.1,"unit_name":"Meters / m"}Trajectory point height, ellipsoid height
flight_idMission IDtext{"length":""}

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"flight_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
		"planned_path_points": [
			{
				"height": 107.91999816894531,
				"latitude": 22.591622374020517,
				"longitude": 114.00506408885121
			},
			{
				"height": 107.91999816894531,
				"latitude": 22.591547439806163,
				"longitude": 114.00506366975605
			}
		]
	},
	"gateway": "7XJDLC10010639",
	"method": "return_home_info",
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1734446832046
}

Service

Request cloud control authorization

After the request, a "Request Authorization" pop-up will appear on the remote controller.

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: cloud_control_auth_request

Data:

ColumnNameTypeConstraintDescription
user_idUser IDtext{"length":""}The user ID of the cloud user requesting authorization.
user_callsignUser Callsigntext{"length":""}The nickname of the cloud user requesting authorization.
control_keysControl Keysarray{ "size": 1, "item_type": text }To request flight control authorization, please fill in "flight".

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"control_keys": [
			"flight"
		],
		"user_callsign": "xxxxxxx",
		"user_id": "xxxxxxxxxxx"
	},
	"method": "cloud_control_auth_request",
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1704038400000
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: cloud_control_auth_request

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"output": {
			"status": "ok"
		},
		"result": 0
	},
	"method": "cloud_control_auth_request",
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1704038400000
}

Release cloud control

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: cloud_control_release

Data:

ColumnNameTypeConstraintDescription
control_keysControl key listarray{ "size": 1, "item_type": text }List of control rights to be released. "Flight" represents flight control rights.

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"control_keys": [
			"flight"
		]
	},
	"method": "cloud_control_release",
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1704038400000
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: cloud_control_release

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"output": {
			"status": "ok"
		},
		"result": 0
	},
	"method": "cloud_control_release",
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1704038400000
}

Enter live flight controls mode

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: drc_mode_enter

Data:

ColumnNameTypeconstraintDescription
mqtt_brokerBroker connection informationstructGet the address and authentication information of the MQTT relay service
»addressServer connection addresstextServer connection address, for example, 192.0.2.1:8883, mqtt.dji.com:8883
»client_idClient IDtextCustomizable MQTT client ID.It is recommended to use the device's SN code, or combine it with a semantic prefix, e.g., drc-4J4R101
»usernameUser nametextUsername used when establishing a connection
»passwordPasswordtextPassword required for authentication when establishing a connection
»expire_timeAuthentication information expiration timeint{"unit_name":"Seconds / s"}Authentication information can be reused within the validity period. The expiration of authentication information does not affect devices that have already established a connection.
»enable_tlsWhether to enable TLSboolEnable TLS, i.e., encrypt the MQTT link
osd_frequencyOSD frequencyint{"max":30,"min":1,"unit_name":"Hertz / Hz"}Set OSD reporting frequency
hsi_frequencyHSI frequencyint{"max":30,"min":1,"unit_name":"Hertz / Hz"}Set HSI reporting frequency

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"hsi_frequency": 1,
		"mqtt_broker": {
			"address": "mqtt.dji.com:8883",
			"client_id": "sn_a",
			"enable_tls": true,
			"expire_time": 1672744922,
			"password": "jwt_token",
			"username": "sn_a_username"
		},
		"osd_frequency": 10
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "drc_mode_enter"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: drc_mode_enter

Data:

ColumnNameTypeConstraintDescription
resultReturn codeintNon-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "drc_mode_enter"
}

Exit live flight controls mode

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: drc_mode_exit

Data: null

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "drc_mode_exit"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: drc_mode_exit

Data:

ColumnNameTypeConstraintDescription
resultReturn codeintNon-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "drc_mode_exit"
}

One-key takeoff

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: takeoff_to_point

Data:

ColumnNameTypeConstraintDescription
target_latitudeTarget point latitude (in degree values)double{"max":90,"min":-90,"step":"","unit_name":null}
target_longitudeTarget point longitude (in degree values)double{"max":180,"min":-180,"step":"","unit_name":null}
target_heightTarget point heightfloat{"max":1500,"min":2,"step":0.1,"unit_name":"Meters / m"}
security_takeoff_heightSafe takeoff heightfloat{"max":1500,"min":20,"step":0.1,"unit_name":"Meters / m"}
rth_mode[Required] Return home mode setting valueenum_int{"0":"Intelligent altitude","1":"Preset altitude"}
rth_altitudeReturn home altitudeint{"max":1500,"min":2,"step":1,"unit_name":"Meters / m"}
rc_lost_actionRemote controller lost control actionenum_int{"0":"Hovering","1":"Landing","2":"Returning to home"}
commander_mode_lost_action[Required] FlyTo task signal lost actionenum_int{"0":"Continue with the to-point flight mission","1":"Exit the to-point flight mission and perform normal loss of control behavior"}
commander_flight_mode[Required] FlyTo task mode valueenum_int{"0":"Optimal height flight","1":"Preset height flight"}
commander_flight_height[Required] FlyTo heightfloat{"max":3000,"min":2,"step":0.1,"unit_name":"Meters / m"}
flight_idOne-key takeoff mission UUIDtext{"length":""}
max_speedAchievable maximum speed during one-key takeoffint{"max":15,"min":1,"step":"","unit_name":"meters per second / m/s"}
simulate_missionWhether to execute the mission in the simulatorstruct
»is_enableWhether to enable the simulator missionenum_int{"0":"Do not enable","1":"Enable"}Open or close the simulator for this mission
»latitudeLatitudedouble{"max":"90.0","min":"-90.0"}
»longitudeLongitudedouble{"max":"180.0","min":"-180.0"}
flight_safety_advance_checkPre-check for flight safetybool{"0":"Disable","1":"Enable"}Set to pre-check the flight safety for Take Off and flight route task. This field is optional. The default value is 0, which represents closed. 1 represents open. Checking if the local operating area file is consistent with the cloud side before the task starts. If the files are different, pull file from the cloud side to update.

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"commander_flight_height": 80,
		"commander_mode_lost_action": 1,
		"flight_id": "ABDEAC21DCADDA",
		"flight_safety_advance_check": 1,
		"max_speed": 12,
		"rc_lost_action": 0,
		"rth_altitude": 100,
		"security_takeoff_height": 100,
		"target_height": 100,
		"target_latitude": 12.23,
		"target_longitude": 12.32
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "takeoff_to_point"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: takeoff_to_point

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "takeoff_to_point"
}

Fly to target point

Note: To ensure the flight safety, the min flight altitude of the aircraft is 20 m. If the altitude relative to the takeoff point is below 20 m, the aircraft will first ascend to 20 m.

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: fly_to_point

Data:

ColumnNameTypeConstraintDescription
fly_to_idFlyto target point IDtext
max_speedAchievable maximum speed during flytoint{"max":15,"min":0,"unit_name":"Meters per second / m/s"}
pointsList of flyto target pointsarray{"size": -, "item_type": struct}Only supports 1 target point
»latitudeTarget point latitude (in degree values)double{"max":90,"min":-90}Target point latitude, in degree values. Negative for south, positive for north. Precision up to 6 decimal places
»longitudeTarget point longitude (in degree values)double{"max":180,"min":-180}Target point longitude, in degree values. Positive for east, negative for west. Precision up to 6 decimal places
»heightTarget point heightfloat{"max":10000,"min":2,"step":0.1,"unit_name":"Meters / m"}Target point height (ellipsoid height), using the WGS84 model

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"fly_to_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
		"max_speed": 12,
		"points": [
			{
				"height": 100,
				"latitude": 12.23,
				"longitude": 12.23
			}
		]
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "fly_to_point"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: fly_to_point

Data:

ColumnNameTypeConstraintDescription
resultReturn codeintNon-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "fly_to_point"
}

End Flyto task to target point

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: fly_to_point_stop

Data: null

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "fly_to_point_stop"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: fly_to_point_stop

Data:

ColumnNameTypeConstraintDescription
resultReturn codeintNon-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "fly_to_point_stop"
}

Update the target point of flyto

During the process of one-key takeoff or flyto target point, the target point can be quickly updated through this command.

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: fly_to_point_update

Data:

ColumnNameTypeConstraintDescription
max_speedAchievable maximum speed during the live flight controlsint{"max":"5","min":"-4","step":"","unit_name":"meters per second / m/s"}
pointsUpdated target points listarray{"size": -, "item_type": struct}
»latitudeLongitudedouble{"max":"","min":"","step":"","unit_name":null}
»longitudeLongitudedouble{"max":"","min":"","step":"","unit_name":null}
»heightHeightfloat{"max":"","min":"","step":"","unit_name":null}

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"max_speed": 12,
		"points": [
			{
				"height": 100,
				"latitude": 12.23,
				"longitude": 12.23
			}
		]
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "fly_to_point_update"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: fly_to_point_update

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "fly_to_point_update"
}

One-key return

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: return_home

Data: null

Example:

{
	"bid": "f9f07aad-d1f1-4dc1-8ad0-a3417fd365cc",
	"data": null,
	"method": "return_home",
	"tid": "b103b00a-3fcc-476e-9cb6-bc5e27d2defd",
	"timestamp": 1734425015702
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: return_home

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error

Example:

{
	"bid": "f9f07aad-d1f1-4dc1-8ad0-a3417fd365cc",
	"data": {
		"result": 0
	},
	"method": "return_home",
	"tid": "b103b00a-3fcc-476e-9cb6-bc5e27d2defd",
	"timestamp": 1734425014635
}

Cancel return

After returning home, the aircraft will exit the wayline mode. If return is canceled at this point, the aircraft will hover.

Topic: thing/product/{gateway_sn}/services

Direction: down

Method: return_home_cancel

Data: null

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {},
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "return_home_cancel"
}

Topic: thing/product/{gateway_sn}/services_reply

Direction: up

Method: return_home_cancel

Data:

ColumnNameTypeConstraintDescription
resultReturn codeint{"max":"","min":"","step":"","unit_name":null}Non-zero represents an error

Example:

{
	"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"data": {
		"result": 0
	},
	"need_reply": 1,
	"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
	"timestamp": 1654070968655,
	"method": "return_home_cancel"
}
If you have any comments or confusion about our documentation, you can click here to give feedback and we will get back to you as soon as possible.