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

Device Model Retrieval

Developing
GET
/openapi/v0.1/device/{device_sn}/state
Device model retrieval can be achieved by passing in device_sn to obtain the corresponding device model information.

Request

Path Params
device_sn
string 
required
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}}

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 GET '/openapi/v0.1/device//state' \
--header 'X-Request-Id;' \
--header 'X-Language: zh' \
--header 'X-Project-Uuid: {{X-Project-Uuid}}'

Responses

🟢200Success
application/json
Body
code
integer 
required
Non-zero indicates an exception
message
string 
required
Message prompt
data
object 
required
device_sn
string 
required
Device SN
device_model
object 
required
Device model
device_state
required
Device Model Information
Example
{
  "code": 0,
  "message": "",
  "data": {
    "device_sn": "7CTDM3D00BZNVZ",
    "device_model": {
      "key": "3-2-0",
      "domain": "3",
      "type": "2",
      "sub_type": "0",
      "name": "DJI Dock 2",
      "class": "airport"
    },
    "device_state": {
      "acc_time": 16460425,
      "activation_time": 1711934979,
      "air_conditioner": {
        "air_conditioner_state": "idle_mode",
        "switch_time": 0
      },
      "air_transfer_enable": true,
      "alarm_state": "disable",
      "alternate_land_point": {
        "height": 0,
        "is_configured": "already_set",
        "latitude": 22.793230100434233,
        "longitude": 114.35781502984646,
        "safe_land_height": 30
      },
      "backup_battery": {
        "switch": "enable",
        "temperature": 26.9,
        "voltage": 815
      },
      "battery_store_mode": "standby_mode",
      "compatible_status": "no_consistency_upgrade_required",
      "cover_state": "close",
      "dongle_infos": [],
      "drone_battery_maintenance_info": {
        "batteries": [
          {
            "capacity_percent": 0,
            "index": "left_battery",
            "temperature": 0,
            "voltage": 0
          }
        ],
        "heat_state": "not_heating_or_preserving",
        "maintenance_state": "no_maintenance _equired",
        "maintenance_time_left": 0
      },
      "drone_charge_state": {
        "capacity_percent": 0,
        "state": "idle"
      },
      "drone_in_dock": "outside",
      "emergency_stop_state": "disable",
      "environment_temperature": 27.4,
      "firmware_upgrade_status": "not_upgraded",
      "firmware_version": "10.01.3205",
      "first_power_on": 1631945855969,
      "flighttask_step_code": "mission_idle",
      "heading": 112.00250244140625,
      "height": 49.58319854736328,
      "home_position_is_valid": "valid",
      "humidity": 46,
      "job_number": 3547,
      "latitude": 22.793216926533837,
      "live_capacity": {
        "available_video_number": 1,
        "coexist_video_number_max": 1,
        "device_list": [
          {
            "available_video_number": 1,
            "camera_list": [
              {
                "availabe_camera_positions": [
                  0,
                  1
                ],
                "available_video_number": 1,
                "camera_index": "165-0-7",
                "camera_position": 1,
                "coexist_video_number_max": 1,
                "video_list": [
                  {
                    "switchable_video_types": [
                      "normal"
                    ],
                    "video_index": "normal-0",
                    "video_type": "normal"
                  }
                ]
              }
            ],
            "coexist_video_number_max": 1,
            "sn": "7CTDM3D00BZNVZ"
          }
        ]
      },
      "live_status": [
        {
          "error_status": 0,
          "status": "in_live_streaming",
          "video_id": "7CTDM3D00BZNVZ/165-0-7/normal-0",
          "video_quality": "adaptive",
          "video_type": "normal"
        }
      ],
      "longitude": 114.35782881713465,
      "maintain_status": {
        "maintain_status_array": [
          {
            "last_maintain_time": 0,
            "last_maintain_type": "regular_maintenance_of_dock",
            "last_maintain_work_sorties": 0,
            "state": "no_maintenance"
          },
          {
            "last_maintain_time": 0,
            "last_maintain_type": "deep_maintenance_of_dock",
            "last_maintain_work_sorties": 0,
            "state": "no_maintenance"
          }
        ]
      },
      "media_file_detail": {
        "remain_upload": 0
      },
      "mode_code": "idle",
      "network_state": {
        "quality": "no_signal",
        "rate": 411,
        "type": "ethernet"
      },
      "position_state": {
        "gps_number": 9,
        "is_calibration": "calibrated",
        "is_fixed": "fixing_successful",
        "quality": "gear_5",
        "rtk_number": 44
      },
      "rainfall": "no_rain",
      "rtcm_info": {
        "host": "rtk.ntrip.qxwz.com",
        "mount_point": "AUTO",
        "port": "8002",
        "rtcm_device_type": "dock",
        "source_type": "network_rtk_calibration"
      },
      "silent_mode": "non_silent_mode",
      "storage": {
        "total": 79981124,
        "used": 108476
      },
      "sub_device": {
        "device_online_status": "power_off",
        "device_paired": "paired",
        "device_sn": "1581F6QAD23BU00A5318"
      },
      "supplement_light_state": "close",
      "temperature": 30.5,
      "thing_version": "1.3.1",
      "user_experience_improvement": "agree",
      "wind_speed": 2.4,
      "wireless_link": {
        "4g_freq_band": 2.4,
        "4g_gnd_quality": 0,
        "4g_link_state": "disconnect",
        "4g_quality": 0,
        "4g_uav_quality": 0,
        "dongle_number": 0,
        "link_workmode": "sdr_mode",
        "sdr_freq_band": 2.4,
        "sdr_link_state": "disconnect",
        "sdr_quality": 0
      },
      "wireless_link_topo": {
        "center_node": {
          "sdr_id": 305419896,
          "sn": "1581F6QAD23BU00A5318"
        },
        "leaf_nodes": [
          {
            "control_source_index": 2,
            "sdr_id": 846732036,
            "sn": "7CTDM3D00BZNVZ",
            "valid": true
          }
        ],
        "secret_code": [
          0,
          0,
          0,
          0,
          1,
          0,
          0,
          0,
          15,
          180,
          95,
          38,
          239,
          208,
          217,
          248,
          197,
          110,
          228,
          142,
          73,
          12,
          42,
          85,
          4,
          230,
          84,
          228
        ]
      },
      "working_current": 0,
      "working_voltage": 27863
    }
  }
}
Previous
Device Management Tutorial
Next
HMS Information Retrieval
Built with