Push Message

2024-09-09
No Rating

Message deviceOsd

Situation Awarness

The server side pushes the telemetry information of all devices in the same workspace to the DJI Pilot 2 side at a fixed frequency, and DJI Pilot 2 will update the device status and location in the map in real time according to the received data.

Payload

NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
biz_codestring---
versionstring---
timestampintegerunit: ms---
dataobject---additional properties are allowed
data.hostobject---additional properties are allowed
data.snstringdevice sn--additional properties are allowed
data.host.latitudenumber---
data.host.longitudenumber---
data.host.heightinteger---
data.host.attitude_headnumber---
data.host.elevationnumberRelative take-off altitude---
data.host.horizontal_speednumber---
data.host.vertical_speednumber---

Examples of payload

{
  "biz_code": "device_osd",
  "version": "1.0",
  "timestamp": 146052438362,
  "data": {
    "host": {
      "latitude": 113.44444,
      "longitude": 23.45656,
      "height": 44.35,
      "attitude_head": 90,
      "elevation": 40,
      "horizontal_speed": 0,
      "vertical_speed": 2.3
    },
    "sn": "string"
  }
}

Message deviceOnline

device online

When the server receives a request for any device in the same workspace to come online, it also broadcasts a push to DJI Pilot 2 via WebSocket, and when DJI Pilot 2 receives the push, it will trigger the "Obtain Device Topology List".

Payload

NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
biz_codestring---
versionstring---
timestampintegerunit: ms---
dataobject---additional properties are allowed

Examples of payload

{
  "biz_code": "device_online",
  "version": "1.0",
  "timestamp": 146052438362,
  "data": {}
}

Message deviceOffline

device offline

When the server receives a request to take any device offline in the same workspace, it also broadcasts a device offline push to DJI Pilot 2 via WebSocket, and when DJI Pilot 2 receives the push, it will trigger the "Obtain Device Topology List".

Payload

NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
biz_codestring---
versionstring---
timestampintegerunit: ms---
dataobject---additional properties are allowed

Examples of payload

{
  "biz_code": "device_offline",
  "version": "1.0",
  "timestamp": 146052438362,
  "data": {}
}

Message deviceUpdateTopo

update device topology

When the Server receivesa request for updating the device topology of any device in the same workspace, a push of updating the device topology is also broadcast by WebSocket to the Pilot. After the Pilot receives the push, Obtain Device Topology List API will be triggered.

Payload

NameTypeDescriptionValueConstraintsNotes
(root)object---additional properties are allowed
biz_codestring---
versionstring---
timestampintegerunit: ms---
dataobject---additional properties are allowed

Examples of payload

{
  "biz_code":"device_update_topo",
  "version":"1.0",
  "timestamp":146052438362,
  "data":{}
}
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.