Tutorial Reading Guide

2024-09-09
No Rating

Before reading the tutorials, please read this page to understand the structure and content of our tutorial, and to get reading guideline.

Announcement

Tutorial Overview

API Overview

  • Currently only DJI Dock supports the Device Property Set API and the Set livestream lens API.
  • If user's cloud service can not connect to the Internet (that is, the WAN), it is necessary to implement the update configuration function to send the URL of the NTP service which can be accessed by the cloud service in order to synchronize the clock. Otherwise, the wayline task can not work properly.

Functions Set

FunctionPilot Interface RealizationDJI Dock Interface Realization
Pilot access to the Cloud ServerApp API (JSBridge):
Verify License
Load Function Module - API Module
Get Token
Load Function Module - Cloud Module
Set workspace Id
Set platform name
-
DJI Dock access to the Cloud Server-Server API (MQTT):
Get Device Binding Status
Get Organization Information
Bind the Organization
Live streamApp API (JSBridge):
Load Function Module - Live Stream Module

Server API (MQTT):
Update Live Streaming Capacity
Start Live Streaming
Stop Live Streaming
Set Live Streaming Quality

App API (JSBridge):
Manual in App side
Server API (MQTT):
Update Live Streaming Capacity
Start Live Streaming
Stop Live Streaming
Set Livestream Quality
Set Livestream Lens
Wayline ManagementApp API (JSBridge):
Load Function Module - Mission Module

Server API (HTTPS):
Obtain Temporary Credential
Obtain Waypoints List
Obtain Waypoints File Download Address
Obtain Duplicated Waypoints Name
Obtain File Upload Result Report
Batch Favorites Waypoints
Batch Unfavorites Waypoints
Server API (MQTT):
Create wayline task (Deprecated)
Report wayline task progress
Issue wayline task
Execute wayline task
Cancel wayline task
Get the wayline task resource
Map elementsApp API (JSBridge):
Load Function Module - Map Module

Server API (HTTPS):
Obtain Map Elements
Create Map Elements
Update Map Elements
Delete Map Elements

Server API (WebSocket):
Map Elements - Push Element
-
Media libraryApp API (JSBridge):
Load Function Module - Media Module

Server API (HTTPS):
Media Fast Upload
Obtain Exist File Tiny Fingerprint
Obtain Temporary Credential
App Reports File Upload Result
Server API (MQTT):
Obtain Temporary Credential
App Reports File Upload Result
Situation awarenessApp API (JSBridge):
Load Function Module - TSA Module

Server API (HTTPS):
Obtain Device Topology List
Custom Icon
Push Device Status
Update Device Topology

Server API (WebSocket):
Push Message
-
Device ManagementTo be sortedServer API (MQTT):
Device Property Push
Device Topology Update
Device Property Set
Obtain log through JSBridgeApp API (JSBridge):
Obtain the log path
Set the log encryption key
Clear the log encryption key
-
Jump to third-party AppApp API (JSBridge):
Launch the third-party App
-
HMS Function-Server API (MQTT):
Health alarm
Remote Debug-Server API (MQTT):
Mission progress
Command
Mission
Firmware Upgrade-Server API (MQTT):
Firmware upgrade progress
Firmware upgrade
Remote Log-Server API (MQTT):
Get file list of uploadable device
Start the log file uploading
Update the uploding status
Inform of file uploding progress
Live Flight Controls-Server API (MQTT):
Flight control commands (DRC commands)
Payload control commands
flyto commands
One-key taking off commands
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.