NEW FlightHub 2 OpenAPI V1.0
  1. Device Management
NEW FlightHub 2 OpenAPI V1.0
  • Root Directory
    • authentication
      • Authentication Tutorial
    • System Service
      • Query FlightHub 2 system status
    • Organize Projects
      • Organize Project Tutorial
      • Get the list of projects under the organization
      • Get the list of devices under the organization
      • Obtain the list of devices under the project
      • Obtain storage upload credentials for the project
      • Add personnel to the project
    • Device Management
      • Device Management Tutorial
      • Device Model Retrieval
        GET
      • HMS Information Retrieval
        GET
      • Real-time control command distribution
        POST
      • Dock camera switch
        POST
      • Aircraft Lens Switching
        POST
      • Control acquisition
        POST
      • Release control
        DELETE
      • Video transmission clarity settings
        PUT
      • Custom Network RTK Calibration
        POST
    • Livestream Management
      • Livestream Management Tutorial
      • Livestream Push
        • Start livestream
      • Bypass Streaming
        • Stream forwarding error code
        • Create Stream Forwarder
        • Enable/Disable stream forwarder
        • Get stream transcoder list
        • Delete stream forwarder
    • Task Management
      • Task Management Tutorial
      • Create Flight Task
      • Updated flight task status
      • Obtain flight task list
      • Obtain media resources generated by the Flight task
      • Obtain Flight task trajectory information
      • Obtain Flight task information
    • Flight Route Management
      • Flight Route Management Tutorial
      • Flight Route Upload Completion Notification
      • Get the list of flight routes under the project
      • Get flight route details
    • Model Management
      • Model Management Tutorial
      • Model reconstruction coordinate system
      • Get the list of models under the project
      • Get Model Details
      • Model reconstruction
    • Annotation Management
      • Annotation Management Tutorial
      • Create map annotation
  1. Device Management

Real-time control command distribution

Developing
POST
/openapi/v0.1/device/{device_sn}/command
During the flight route or Manual Flight, this Command can be used for real-time control of the aircraft, such as Return to Home (RTH), cancel RTH, pause, and redone of the flight task.

Request

Path Params
device_sn
string 
required
Aircraft SN
Header Params
X-Request-Id
string <uuid>
required
Request Unique Identifier
X-Language
enum<string> 
optional
Allowed values:
zhen
Default:
zh
X-Project-Uuid
string 
optional
Project Number
Default:
{{X-Project-Uuid}}
Body Params application/json
command
enum<string> 
required
Command Type
Allowed values:
return_homereturn_specific_homereturn_home_cancelflighttask_pauseflighttask_recovery
Example
{
    "device_command": "return_home" 
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/openapi/v0.1/device//command' \
--header 'X-Request-Id;' \
--header 'X-Language: zh' \
--header 'X-Project-Uuid: {{X-Project-Uuid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_command": "return_home" 
}'

Responses

🟢200Success
application/json
Body
code
integer 
required
Non-zero indicates an exception
message
string 
required
Message prompt
Example
{
    "code": 0,
    "message": "success"
}
Previous
HMS Information Retrieval
Next
Dock camera switch
Built with