1. Real-time Control
FlightHub 2 OpenAPI V2.0 (Public Cloud)
  • FlightHub 2 OpenAPI V2.0
    • Usage Guide
      • Authentication Tutorial
      • Error Code
    • Common
      • Common Tutorial
      • System Health & Access
        • Query FlightHub 2 System Status
        • Query System Health Status
        • Get Project Storage Upload STS Credentials
      • Security
        • SN Decrypt Echo
    • Organization & Project
      • Organization & Project Tutorial
      • Members & Permissions Management
        • Project Members
          • Add Members to Project
          • Get Project User List
          • Get Project Independent Member List
        • Organization Members
          • Get Organization User List
          • Get Current User's Organization Role
        • Roles & Permissions
          • Get Role List
          • Get Permission List
          • Get Role Permissions
      • Project Management
        • Project Collaboration
          • Get Project Quick-Join Information
        • Project Configuration
          • Get Auto Recording Config
        • Project Basic Info
          • Get Project List Under Organization
      • Organization Management
        • Organization Basic Info
          • Get Organization List
          • Get Organization Details
    • Device Management
      • Device Management Tutorial
      • Device List Management
        • Device List (Organization Scope)
          • Get Device List Under Organization
        • Device List (Project Scope)
          • Get Project Device Details
          • Get Project Device List
          • Update Device's Bound Project
          • Get Project Device History Topology
      • Device Configuration
        • Calibration & Positioning
          • Custom Network RTK Calibration
        • Pairing Management
          • Query Relay Pairing Result
          • Make Device Enter Relay Pairing Mode
      • Get HMS Information
      • Acquire Control Permission
      • Release Control Permission
      • Live View Quality Settings
      • Get Thing Model
    • Real-time Control
      • Real-time Control Tutorial
      • Control Permission Management
        • Device Control Permission
          • Query Device Control Status (Organization Device )
          • Query Device Control Status (Project Device)
        • Cloud Control Permission
          • Get Cloud Control Status
      • Payload Control
        • Camera Control
          • Aircraft Lens Switch
          • Dock Camera Switch
      • Flight Control Commands
        • General Real-time Commands
          • Query Device Command Execution
          • Send Real-time Control Command
      • Takeoff/Landing Coordination
        • Query Takeoff/Landing Coordination Area (TCA) Real-time Status
    • Livestream
      • Livestream Tutorial
      • Query Recording Tasks
        • Get Recording Tasks for Project Device
        • Get Recording Tasks for Organization Device
      • Livestream Sharing & Forwarding
        • Bypass Streaming
          • Create Stream Converter
          • Get Stream Converter List
          • Delete Stream Converter
          • Enable/Disable Stream Converter
        • Livestream Sharing
          • Get Device Livestream Share Details
          • Get Device Livestream Share List
      • Livestream Push
        • Start Livestream
    • Flight Task
      • Flight Task Tutorial
      • AI Flight Alerts
        • Query Flight Task Alert Records
        • Query AI Alert Records
      • Task Creation
        • Check Whether Flight Task Meets Dispatch Conditions
        • Create Flight Task
        • Resumable Immediate Task
      • Task Query
        • Get Recent Flight Task List
        • Get Default Task Name on Creation
        • Get Flight Task List
        • Get Flight Task Track Information
        • Get Wayline Task Details
        • Get Flight Task Information
        • Get Flight Task List
        • Get Media Resources from Flight Task
      • Flight Record
        • Get Export History
        • Get Single Flight Record Download Link
        • Get Wayline Task Operation Log
      • Task Update
        • Update Flight Task Status
    • Wayline
      • Wayline Tutorial
      • Wayline Management
        • Wayline Query
          • Get Wayline Details
          • Get Wayline List Under Project
        • Wayline Upload
          • Wayline Upload Completion Notification
    • Map
      • Map Tutorial
      • Map Annotation
        • Annotation Creation
          • Create Map Annotation
        • Annotation Update
          • Annotation Update
        • Annotation Deletion
          • Annotation Deletion
      • Airspace Safety
        • Terrain Obstacles
          • Get Offline Map URL
          • Get Offline Map Details
        • Custom Flight Area
          • Get Flight Area List (Workspace Scope)
          • Get Flight Area File URL
          • Get Flight Area List (Project Scope)
      • Airspace Warning
        • Airspace Warning
    • Model Reconstruction
      • Model Reconstruction Tutorial
      • Get Project Model List
      • Model Reconstruction
      • Get Model Details
      • Get Model File Download Link
    • Open Modeling
      • Open Modeling Tutorial
      • Start Reconstruction Task
      • Get Model Details
      • Delete Model
      • Stop Reconstruction Task
      • Get Resource Details
      • Delete Resource
      • Get Upload Credentials
      • Upload Callback
      • Get In-Progress Reconstruction Model Details
  1. Real-time Control

Real-time Control Tutorial

Overview#

The Real-time Control module supports real-time operations for device control permission and flight control commands, covering:
Control Permission Management: Query the current ownership of device control permission (holder, whether preemptible) and the cloud control permission status, covering both project and organization scopes.
Flight Control Commands: Issue real-time control commands during wayline or manual flight (return-to-home, pause, resume, etc.), query command execution status, and manage real-time wayline task dispatch and takeoff/landing coordination.
Control permission status query interfaces are read-only displays; acquisition and release of control permission still go through the Device Management module's Acquire Control Permission (POST /openapi/v2.0/device/control) / Release Control Permission (DELETE /openapi/v2.0/device/control) interfaces.
Real-time control command dispatch requires that the corresponding aircraft control permission is currently held.
The Takeoff/Landing Coordination Area (TCA) is used for takeoff/landing conflict detection in multi-dock scenarios. The query interface directly returns real-time occupancy status.

Interface Usage Flow#

Control permission status query:
Real-time control command dispatch and execution status query:
Wayline task real-time control and takeoff/landing coordination:
Call steps:
1.
When displaying the control permission dashboard, call Query Device Control Status (Project Device) (GET /openapi/v2.0/topologies/cmds/control/status), Query Device Control Status (Organization Device Ops) (GET /openapi/v2.0/organizations/{uuid}/manage-devices/cmds/control/status), and Get Cloud Control Status (GET /openapi/v2.0/cloud-controls) as needed to obtain read-only control permission and cloud control status.
2.
When intervention with the aircraft is needed during flight, call Send Real-time Control Command (POST /openapi/v2.0/device/{device_sn}/command) to issue real-time control commands (such as return-to-home / cancel return-to-home / pause / resume), and use Query Device Command Execution (GET /openapi/v2.0/organizations/{uuid}/manage-devices/cmds) to track command execution progress.
3.
When handling wayline real-time control, you can call Get Wayline Task Default Name (GET /openapi/v2.0/flight-tasks/default-name) to pre-generate a task name, and Get Active Wayline Tasks (GET /openapi/v2.0/workspaces/{workspace_id}/flight-tasks/in-flight) to view current active tasks.
4.
In multi-dock coordination scenarios, call Query TCA Real-time Status (GET /openapi/v2.0/workspaces/{workspace_id}/groups/tcas) to query the real-time occupancy of the takeoff/landing coordination area to avoid takeoff/landing conflicts.
Modified at 2026-05-26 14:32:16
Previous
Get Thing Model
Next
Query Device Control Status (Organization Device )
Built with