00.properties
Device Property List
pushMode:
0: Stable frequency data. Device will report in the frequency of 0.5HZ. (Topic:thing/product/{sn}/osd)
1: State data. It is reported when the state changes. (Topic:thing/product/{sn}/state)
accessMode:
r: Property can only be read
rw: Property can be read and written (Topic:thing/product/{sn}/property/set)
longitude
Longitude
double
{"max":"180","min":"-180","step":"0.01"}
Longitude of the gateway device
r
0
latitude
Latitude
double
{"max":"90","min":"-90","step":"0.01"}
r
0
firmware_version
Firmware version
text
{"length":"64"}
r
1
firmware_upgrade_status
Firmware upgrade state
enum_int
{"0":"Not upgraded","1":"Upgrading"}
r
1
mode_code
Dock state
enum_int
{"0":"Idle","1":"On-site debugging","2":"Remote debugging","3":"Firmware upgrade in progress","4":"In operation"}
r
0
flighttask_step_code
Dock mission state
enum_int
{"0":"Operation preparation","1":"In-flight operation","2":"Post-operation state recovery","3":"Custom flight area updating","4":"Terrain obstacle updating","5":"Mission idle","255":"Aircraft is abnormal","256":"Unknown state"}
r
0
sub_device
Sub-device state
struct
r
0
»device_sn
Sub-device serial number (SN)
text
0
»product_type
Sub-device enumeration values
text
Format as {domain-type-subtype}
0
»device_online_status
Aircraft power-on state on the dock
enum_int
{"0":"Power off","1":"Power on"}
0
»device_paired
Aircraft on the dock whether is paired with the dock
enum_int
{"0":"Not paired","1":"Paired"}
0
cover_state
Cover state
enum_int
{"0":"Disable","1":"On","2":"Half open","3":"Cover state abnormal"}
r
0
supplement_light_state
Supplementary light state
enum_int
{"0":"Disable","1":"On"}
r
0
network_state
Network state
struct
r
0
»type
Network type
enum_int
{"1":"4G","2":"Ethernet"}
0
»quality
Network quality
enum_int
{"0":"No signal","1":"Poor","2":"Poor","3":"Moderate","4":"Better","5":"Good"}
0
»rate
Network rate
float
{"unit_name":"Kilobytes per second / KB/s"}
0
drone_in_dock
Is the aircraft in the dock
enum_int
{"0":"Outside the dock","1":"Inside the dock"}
r
0
job_number
Cumulative number of dock operations
int
{"unit_name":"Times / count"}
r
0
media_file_detail
Media file upload details
struct
r
0
»remain_upload
Pending upload quantity
int
0
wireless_link
Image transmission link
struct
r
0
»dongle_number
Number of Dongles on the aircraft
int
0
»4g_link_state
4G link connection state
enum_int
{"0":"Not connected","1":"Connected"}
0
»sdr_link_state
SDR link connection state
enum_int
{"0":"Not connected","1":"Connected"}
0
»link_workmode
Dock's video transmission link mode
enum_int
{"0":"SDR Mode","1":"4G Fusion Mode"}
0
»sdr_quality
SDR signal quality
int
{"max":"5","min":"0","step":"1"}
0
»4g_quality
Overall 4G signal quality
int
{"max":"5","min":"0","step":"1"}
0
»4g_uav_quality
Sky-side 4G signal quality
int
{"max":"5","min":"0","step":"1"}
Signal quality between aircraft and 4G server
0
»4g_gnd_quality
Ground-side 4G signal quality
int
{"max":"5","min":"0","step":"1"}
Signal quality between ground devices (for example, remote controller, DJI Dock, etc.) and 4G server
0
»sdr_freq_band
SDR frequency band
float
0
»4g_freq_band
4G frequency band
float
0
live_status
Gateway's current overall live streaming state push
array
{"size": -, "item_type": struct}
r
1
»video_id
Live streaming identifier
text
Identifier for pushing video streams on a certain route, formatted as {sn}/{camera_index}/{video_index}. {sn} is the serial number of the video source device. {camera_index} is the camera index, using the format {type-subtype-gimbalindex}. {video_index} is the index of the video stream that can be selected at the camera level.
0
»video_type
Video type
text
{"length":"24"}
Indicates the type of video lens, such as normal/wide/zoom/infrared, etc.
0
»video_quality
Quality of the live streaming
enum_int
{"0":"Auto","1":"Smooth","2":"High definition","3":"Ultra-high definition"}
0
»status
Live streaming state
enum_int
{"0":"Not live streaming","1":"In live streaming"}
0
»error_status
Error code
int
{"length":6}
0
live_capacity
Gateway device live streaming capability
struct
r
1
»available_video_number
Number of selectable streaming bitrates
int
0
»coexist_video_number_max
Maximum number of streams that can be simultaneously streamed
int
0
»device_list
Selectable video device sources
array
{"size": -, "item_type": struct}
Selectable video device sources (device layer, such as aircraft)
0
»»sn
Aircraft and other video source device serial number (SN)
text
0
»»available_video_number
Number of streaming bitrates that can be selected for the serial number device
int
0
»»coexist_video_number_max
The maximum number of streams that can be simultaneously streamed by the device with this serial number
int
0
»»camera_list
List of cameras on the device with the specified serial number
array
{"size": -, "item_type": struct}
0
»»»camera_index
Camera index
text
Using the format {type-subtype-gimbalindex}
0
»»»available_video_number
Number of streaming bitrates that can be selected for the camera level video source
int
0
»»»coexist_video_number_max
The maximum number of streams that can be simultaneously streamed for this camera level
int
0
»»»video_list
List of streams that can be selected for this camera-level video source
array
{"size": -, "item_type": struct}
0
»»»»video_index
Index of the stream that can be selected for this camera-level video source
text
0
»»»»video_type
Types of streams that can be selected for this camera-level video source
text
0
»»»»switchable_video_types
Supported video camera types that the video stream can switch to
array
{"size": -, "item_type": text}
0
rainfall
Rainfall
enum_int
{"0":"No rain","1":"Light rain","2":"Moderate rain","3":"Heavy rain"}
r
0
wind_speed
Wind speed
float
{"unit_name":"Meters per second / m/s"}
r
0
environment_temperature
Environment temperature
float
{"unit_name":"Celsius / °C"}
r
0
temperature
Inside dock temperature
float
{"unit_name":"Celsius / °C"}
r
0
humidity
Humidity inside the dock
float
{"max":"100","min":"0","step":"0.1","unit_name":"Relative humidity / %RH"}
r
0
working_voltage
Working voltage
int
{"unit_name":"Millivolts / mV"}
r
0
working_current
Working current
float
{"unit_name":"Milliamps / mA"}
r
0
storage
Storage capacity
struct
r
0
»total
Total capacity
int
{"unit_name":"Kilobytes / KB"}
0
»used
Used capacity
int
{"unit_name":"Kilobytes / KB"}
0
first_power_on
First power-on time
int
{"unit_name":"Milliseconds / ms"}
r
0
acc_time
Cumulative operating time of the aircraft
int
{"unit_name":"Seconds / s"}
r
1
compatible_status
Firmware consistency
enum_int
{"0":"No consistency upgrade required","1":"Consistency upgrade required"}
Consistent firmware update means a consistent firmware update is required when the firmware versions of some modules of the aircraft are inconsistent with the compatible version of the system. For example, the aircraft and RC have been updated to newest version, but the used batteries is not updated. Then the Consistent firmware update will be prompted. Normal firmware update means developers update all modules of aircraft to selected firmware version.
r
1
alternate_land_point
Alternate landing point
struct
r
0
»longitude
Longitude
float
{}
0
»latitude
Latitude
float
{}
0
»safe_land_height
Safe landing height (backup landing transfer height)
float
{}
0
»is_configured
Whether the alternate landing point is set
enum_int
{"0":"Not set","1":"Already set"}
0
height
Ellipsoid height
double
{"unit_name":"Meters / m"}
r
0
activation_time
Dock activation time (Unix timestamp)
int
{"unit_name":"Seconds / s"}
r
0
battery_store_mode
Battery operating mode
enum_int
{"1":"Schedule mode","2":"Standby mode"}
Schedule mode is suitable for regular operation scenes, where the battery level is maintained between 55% to 60% when there is no mission, leading to a longer battery life. Standby mode is suitable for emergency operation scenes, where the battery level is maintained between 90% to 95% when there is no mission, but the battery life is shorter.
r
0
alarm_state
Dock sound and light alarm state
enum_int
{"0":"Disable","1":"Enable"}
r
0
backup_battery
Dock backup battery information
struct
r
0
»switch
Backup battery switch
enum_int
{"0":"Disable","1":"Enable"}
0
»voltage
Voltage of the backup battery
int
{"desc":"Voltage is 0 when the backup battery is turned off","max":"30000","min":"0","step":"1","unit_name":"Millivolts / mV"}
0
»temperature
Backup battery temperature
float
{"step":"0.1","unit_name":"Celsius / °C"}
Retain one decimal place
0
drone_charge_state
Aircraft charging state
struct
Aircraft charging state
r
0
»capacity_percent
Battery percentage
int
{"max":"100","min":"0"}
0
»state
Charging state
enum_int
{"0":"Idle","1":"Charging"}
0
emergency_stop_state
Emergency stop button state
enum_int
{"0":"Disable","1":"Enable"}
r
0
position_state
Satellite search state
struct
r
0
»is_calibration
Whether calibrated
enum_int
{"0":"Not calibrated","1":"Calibrated"}
0
»is_fixed
Whether is Fixed
enum_int
{"0":"Not started","1":"Fixing","2":"Fixing successful","3":"Fixing failed"}
0
»quality
Satellite acquisition mode
enum_int
{"1":"Gear 1","2":"Gear 2","3":"Gear 3","4":"Gear 4","5":"Gear 5","10":"RTK fixed"}
0
»gps_number
Number of GPS satellites
int
0
»rtk_number
Number of RTK satellite acquisitions
int
0
maintain_status
Maintenance information
struct
r
0
»maintain_status_array
Maintenance information array
array
{"size": -, "item_type": struct}
0
»»state
Maintenance state
enum_int
{"0":"No maintenance","1":"With maintenance"}
0
»»last_maintain_type
Last maintenance type
enum_int
{"0":"No maintenance","17":"Regular maintenance of the dock","18":"Deep maintenance of the dock"}
0
»»last_maintain_time
Last maintenance time
date
{"unit_name":"Seconds / s"}
0
»»last_maintain_work_sorties
Last maintenance work sorties
int
{"max":"2147483647","min":"0","step":"1"}
0
air_conditioner
Dock air conditioner working state information
struct
r
0
»air_conditioner_state
Dock air conditioner state
enum_int
{"0":"Idle mode (no cooling, heating, or dehumidification)","1":"Cooling mode","2":"Heating mode","3":"Dehumidification mode","4":"Cooling exit mode","5":"Heating exit mode","6":"Dehumidification exit mode","7":"Cooling ready mode","8":"Heating ready mode","9":"Dehumidification ready mode"}
Dock air conditioner working state information, only one working mode exists for the air conditioner
0
»switch_time
Remaining waiting time for switching.
int
{"unit_name":"Seconds / s"}
The mode switching sequence includes the preparation mode, working mode (cooling, heating, dehumidification), exit mode, and idle mode. This property reports the time remaining for the next mode switch command. For example, if the dock air conditioner is in cooling mode, it must be in cooling for 5 minutes before it can exit the cooling mode. This property reports how long it takes to exit the cooling mode, and 0 indicates that it can exit at any time.
0
drone_battery_maintenance_info
Aircraft battery maintenance information
struct
0
»maintenance_state
Maintenance state
enum_int
{"0":"No maintenance required","1":"Waiting for maintenance","2":"In maintenance"}
0
»maintenance_time_left
Remaining maintenance time for the battery
int
{"unit_name":"Hours / h"}
0
»heat_state
Battery heating and preservation state
enum_int
{"0":"Battery not heating or preserving","1":"Battery in heating","2":"Battery in heat preservation"}
Battery heating and preservation information reported when the aircraft is off on the dock
0
»batteries
Battery details
array
{"size": -, "item_type": struct}
When the aircraft is powered off in the dock, the property will report the aircraft battery information. The basic data is consistent with the battery information in the aircraft thing model.
0
»»capacity_percent
Remaining battery capacity
int
{"max":100,"min":0}
0
»»index
Battery serial number
enum_int
{"0":"Left battery","1":"Right battery"}
0
»»voltage
Voltage
int
{"unit_name":"Millivolts / mV"}
0
»»temperature
Temperature
float
{"unit_name":"Celsius / °C"}
Retain one decimal place. Normal range -40-150°C. Abnormal value when the device cannot retrieve data is 32767
0
dongle_infos
4G Dongle information
array
{"size": -, "item_type": struct}
r
1
»imei
dongle imei
text
Unique identifier for the Dongle
r
0
»dongle_type
Dongle type
enum_int
{"6":"Old Dongle","10":"New Dongle with eSIM support"}
Dongle type
r
0
»eid
dongle eid
text
Unique identifier for eSIM, used for public account query of plans and service purchase
r
0
»esim_activate_state
eSIM activation state
enum_int
{"0":"Not activated","1":"Activated"}
Requires activation to use
r
0
»sim_card_state
SIM card state
enum_int
{"0":"Not inserted","1":"Inserted"}
Insertion state of the physical SIM card in the dongle
r
0
»sim_slot
SIM card slot enable state
enum_int
{"0":"Unknown","1":"Physical SIM card","2":"eSIM"}
Identifies the SIM card slot currently in use by the dongle
r
0
»esim_infos
eSIM information
array
{"size": -, "item_type": struct}
r
0
»»telecom_operator
Supported operators
enum_int
{"0":"Unknown","1":"Mobile","2":"China Unicom","3":"Telecommunications"}
Telecom operators supported by eSIM
r
0
»»enabled
eSIM enable state
bool
{"false":"Not in use","true":"In use"}
Only one eSIM can be enabled at a time
r
0
»»iccid
SIM ICCID
text
Unique identifier for the SIM card, can be used for purchasing packages for physical SIM cards
r
0
»sim_info
SIM card information
struct
Information about the physical SIM card that can be inserted into the dongle
r
0
»»telecom_operator
Supported operators
enum_int
{"0":"Unknown","1":"Mobile","2":"China Unicom","3":"Telecommunications"}
Telecom operator supported by the SIM card
r
0
»»sim_type
SIM card type
enum_int
{"0":"Unknown","1":"Other regular SIM card","2":"Three-network card"}
Type of physical SIM card
r
0
»»iccid
SIM ICCID
text
Unique identifier for the SIM card, can be used for purchasing packages for physical SIM cards
r
0
user_experience_improvement
User experience improvement plan
enum_int
{"0":"Initial state","1":"Refuse to join the user experience improvement plan","2":"Agree to join the user experience improvement plan"}
rw
1
silent_mode
Dock quiet mode
enum_int
{"0":"Not in quiet mode","1":"In quiet mode"}
Opening the quiet mode, you will get some changes. 1. The fan speed decreases, the cooling performance of the air conditioner drops, and the operation interval becomes longer on hot days. 2. The buzzer sound will be turned off. Please be cautious of the surroundings when opening or closing the dock cover. 3. The white indicator light for standby mode at the dock is turned off, while other operation state indicators remain normal.
rw
1
Device Property Push
Topic: thing/product/{device_sn}/state Status data: report when the status changes
Topic: thing/product/{device_sn}/osd Stable frequency data: Device will report in the frequency of 0.5HZ
Direction: up
API Explanation:
The payload property reporting refers to the property reporting of the payload mounted on the aircraft. For example, the property reporting of the camera. One payload is identified by payload index: {type-subtype-gimbalIndex}. The "type” and "subtype" can be referred to Product Type. The "gimbalindex" can be referred to the wpml:payloadPositionIndex of DJI WPML.
Currently, the protocols that involve the reporting of payload property are the Device Property Push of the gateway device and the Livestream ability update of the live streaming function. For Device Property Push, the property reported is mainly about the camera itself. For example, the pitch angle, roll angle, and yaw angle. For Livestream ability update, the property reported is mainly about the live stream ability of the camera. For example, the maximum code stream number of pushing streams at the same time. Please refer to the example below for the specific structure of the payload property. The payload property of the remote controller is sent in one message, but the payload property of the dock is sent by multiple messages.
Data:
data
Data content
text
{}
The contant can refer to the property of device
»camera_index
type-subtype-gimbalIndex
text
{}
gimbalIndex is camera location. For type, sub_type, please refer to Product Supported
Example:
Topic: thing/product/{dock_sn}/state
Topic: thing/product/{dock_sn}/osd
{
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1667220873846,
"data": {
"job_number": 492,
"acc_time": 1859010,
"activation_time": 0,
"maintain_status": {
"maintain_status_array": [
{
"state": 0,
"last_maintain_type": 17,
"last_maintain_time": 0,
"last_maintain_work_sorties": 0
}
]
},
"working_voltage": 25440,
"working_current": 1120,
"backup_battery": {
"voltage": 26631,
"temperature": 27.9,
"switch": 1
},
"drone_battery_maintenance_info": {
"maintenance_state": 0,
"maintenance_time_left": 0
}
},
"gateway": "dock_sn"
} {
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"flighttask_step_code": 255,
"media_file_detail": {
"remain_upload": 0
},
"wireless_link": {
"4g_freq_band": 2.4,
"4g_gnd_quality": 0,
"4g_link_state": 0,
"4g_quality": 0,
"4g_uav_quality": 0,
"dongle_number": 0,
"link_workmode": 0,
"sdr_freq_band": 2.4,
"sdr_link_state": 0,
"sdr_quality": 0
}
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1667220881576,
"gateway": "dock_sn"
}{
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1667220916697,
"data": {
"network_state": {
"type": 2,
"quality": 0,
"rate": 5.0970001220703125
},
"drone_charge_state": {
"state": 0,
"capacity_percent": 100
},
"drone_in_dock": 1,
"rainfall": 0,
"wind_speed": 0,
"environment_temperature": 24,
"temperature": 24.9,
"humidity": 62,
"latitude": 22.907809968,
"longitude": 113.703482143,
"height": 34.174125671386719,
"alternate_land_point": {
"latitude": 22.907898319908661,
"longitude": 113.70347329676635,
"safe_land_height": 0,
"is_configured": 1
},
"first_power_on": 1631945855969,
"position_state": {
"is_calibration": 1,
"is_fixed": 2,
"quality": 5,
"gps_number": 6,
"rtk_number": 25
},
"storage": {
"total": 82045336,
"used": 51772
},
"mode_code": 1,
"cover_state": 0,
"supplement_light_state": 0,
"emergency_stop_state": 0,
"battery_store_mode": 1,
"alarm_state": 0,
"putter_state": 0,
"sub_device": {
"device_sn": "1581F5BKD225D00BP891",
"device_model_key": "0-67-0",
"device_online_status": 0,
"device_paired": 1
}
},
"gateway": "dock_sn"
}Topic: thing/product/{aircraft_sn}/state
Topic: thing/product/{aircraft_sn}/osd
{
"bid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data": {
"52-0-0": {
"measure_target_altitude": 0,
"measure_target_distance": 591.70001220703125,
"measure_target_error_state": 1,
"measure_target_latitude": 0,
"measure_target_longitude": 0,
"payload_index": "52-0-0",
"version": 1
},
"activation_time": 1667935211,
"attitude_head": 41.7,
"attitude_pitch": 2.7,
"attitude_roll": 0,
"battery": {
"batteries": [
{
"capacity_percent": 95,
"firmware_version": "02.00.20.44",
"high_voltage_storage_days": 16,
"index": 0,
"loop_times": 137,
"sn": "4BUPJ99DAD009W",
"sub_type": 0,
"temperature": 33.3,
"type": 0,
"voltage": 24303
},
{
"capacity_percent": 85,
"firmware_version": "02.00.20.44",
"high_voltage_storage_days": 5,
"index": 1,
"loop_times": 82,
"sn": "4BUPJ9EDAD01CE",
"sub_type": 0,
"temperature": 32,
"type": 0,
"voltage": 24311
}
],
"capacity_percent": 90,
"landing_power": 0,
"remain_flight_time": 0,
"return_home_power": 0
},
"distance_limit_status": {
"distance_limit": 5000,
"state": 0
},
"elevation": 0,
"firmware_version": "05.01.0214",
"gear": 1,
"height": 38.417465209960938,
"height_limit": 120,
"home_distance": 0,
"horizontal_speed": 0,
"latitude": 0,
"longitude": 0,
"maintain_status": {
"maintain_status_array": [
{
"last_maintain_flight_time": 0,
"last_maintain_time": 0,
"last_maintain_type": 1,
"state": 0
},
{
"last_maintain_flight_time": 0,
"last_maintain_time": 0,
"last_maintain_type": 2,
"state": 0
},
{
"last_maintain_flight_time": 0,
"last_maintain_time": 0,
"last_maintain_type": 3,
"state": 0
}
]
},
"mode_code": 0,
"night_lights_state": 0,
"obstacle_avoidance": {
"downside": 1,
"horizon": 1,
"upside": 1
},
"position_state": {
"gps_number": 0,
"is_fixed": 0,
"quality": 0,
"rtk_number": 0
},
"storage": {
"total": 0,
"used": 0
},
"total_flight_distance": 0,
"total_flight_sorties": 0,
"total_flight_time": 0,
"track_id": "",
"vertical_speed": 0,
"wind_direction": 0,
"wind_speed": 0
},
"tid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp": 1670422793916,
"gateway": "dock_sn"
}Device Property Set
Topic: thing/product/{gateway_sn}/property/set
Direction: down
Data:
data
Data content
text
{}
The contant can refer to the property of device
Example:
{
"bid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data":{
"distance_limit_status": {"state": 1}
},
"tid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp":1643268212187
}Topic: thing/product/{gateway_sn}/property/set_reply
Direction: up
Data:
data
Data content
text
{}
The contant can refer to the property of device
Example:
{
"bid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data":{
"distance_limit_status": {
"state": {
"result": 0 // 0: Success, 1: Fail, 2: Time Out, 0x123456 Precise error code
}
}
},
"tid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp":1643268212187
}Last updated