Properties

2023-09-18
No Rating

Property

  • pushMode:

    • 0:Stable frequency data. Device will report in the frequency of 0.5HZ.
    • 1:State data. It is reported when the statr changes.
  • accessMode:

    • r:Property can only be read
    • rw:Property can be read and written
ColumnNameTypeaccessModepushModeconstraintDescription
payloadsPayload statearrayr1{}
»[array_item]Elements in arraystructr1{}{"size": ""}
»»control_sourcePayload control authoritytext
»»payload_indexPayload indextextPayload index. The format is {type-subtype-gimbalindex}
»»firmware_versionFirmware versiontext
»»snPayload serial number (SN)text
mode_codeAircraft stateenum_intr0{"0":"Standby","1":"Takeoff preparation","2":"Takeoff preparation finished","3":"Manual flight","4":"Automatic takeoff","5":"Wayline flight","6":"Panoramic shooting","7":"Intelligent follow","8":"ADS-B Avoidance","9":"Automatic return","10":"Automatic landing","11":"Forced landing","12":"Three-bladed landing","13":"Upgrading","14":"No connection","15":"Advanced Pilot Assistance System - APAS","16":"Virtual Stick Mode","17":"Live Flight Controls"}
distance_limit_statusDistance restriction state of dronestructrw0
»stateWhether distance restriction is openedenum_int{"0":"Not set","1":"Have been set"}
»distance_limitDistance restrictionint{"max":"8000","min":"15","step":"1","unit":"meter / m"}
»is_near_distance_limitWhether reach the setting distance restrictionenum_intr{"0":"Not reached","1":"Reached"}
wpmz_versionWPMZ version of aircrafttextr1If the firmware version is too low, the search result reports abnormal. The DJI Dock will push WPMZ of 1.0.2 version to cloud server.
rth_altitudeReturn-to-home heightintrw0{"max":500,"min":20,"unit":"meter / m"}
rc_lost_actionRemote controller out of control actionenum_intrw0{"0":"Hovering","1":"Landing","2":"Returning to home"}
exit_wayline_when_rc_lost[Deprecated] Wayline out of control actionenum_intrw0{"0":"Continue to execute the wayline task","1":"Exit the wayline task, and execute the remote controller out of control action."}
camerasCamera information of aircraftarrayr0{}
»[array_item]Elements in arraystructr0{}{"size": ""}
»»remain_photo_numRemaining photo taking numberint
»»remain_record_durationRemaining recording timeint{"unit":"second / s"}
»»record_timeVideo recording timeint{"unit":"second / s"}
»»payload_indexPayload indextextCamera enumeration. It is unofficial device_mode_key. The format is {type-subtype-gimbalindex}. Please read Product Supportedopen in new window
»»camera_modeCamera modeenum_int{"0":"Photo taking","1":"Video recording"}
»»photo_statePhoto taking stateenum_int{"0":"Idle","1":"Taking photo"}
»»screen_split_enableWhether enable the screen splitbool{"true":"Enable","false":"Disable"}
»»recording_stateRecording stateenum_int{"0":"Idle","1":"Recording"}
»»zoom_factorZoom factorfloat{"max":200,"min":2}
»»ir_zoom_factorInfrared zoom factorfloat{"max":20,"min":2}
»»liveview_world_regionThe region of Field of view (FOV) in liveviewstruct[{"accessMode":"r","dataType":{"max":1,"min":0,"type":"float"},"identifier":"left","name":"X axis starting point in the upper left corner","pushMode":0,"required":false},{"accessMode":"r","dataType":{"max":1,"min":0,"type":"float"},"identifier":"top","name":"Y axis starting point in the upper left corner","pushMode":0,"required":false},{"accessMode":"r","dataType":{"max":1,"min":0,"type":"float"},"identifier":"right","name":"X axis starting point in the lower right corner","pushMode":0,"required":false},{"accessMode":"r","dataType":{"max":1,"min":0,"type":"float"},"identifier":"bottom","name":"Y axis starting point in the lower right corner","pushMode":0,"required":false}]The FOV of zoom camera is different from the FOV of wide camera and infrared camera in liveview. 坐标原点为镜头左上角。
{type-subtype-gimbalindex}{{type-subtype-gimbalindex}_AEncSWZTyQ}structr0{{type-subtype-gimbalindex}_XeIeqFlRLP}
»thermal_current_palette_stylePalette styleenum_intrw{"0":"WHITE_HOT","1":"BLACK_HOT","2":"RED_HOT","3":"GREEN_HOT","5":"RAINBOW","6":"IRONBOW1","8":"ICE_FIRE","11":"COLOR1","12":"COLOR2","13":"RAIN"}The infrared camera provides various palette styles. Developers can select different colors according to different scenes for seeing the target more clearly.
»thermal_supported_palette_stylesPalette style set supported by devicearray{"item":{"specs":{"0":"WHITE_HOT","1":"BLACK_HOT","2":"RED_HOT","3":"GREEN_HOT","5":"RAINBOW","6":"IRONBOW1","8":"ICE_FIRE","11":"COLOR1","12":"COLOR2","13":"RAIN"},"type":"enum_int"}}Different devices support different palette styles.
»thermal_gain_modeGain modeenum_intrw{"0":"Automatic","1":"Low gain. Measurement range is 0°C~500°C.","2":"High gain. Measurement range is -20°C~150°C."}Low gaim provides larger thermal measurement range. High gain provides higher thermal measurement precision.
»thermal_isotherm_stateWhether open the isothermenum_intrw{"0":"Closed","1":"Opened"}The isotherm allows developers to focus on the content of their interested thermal range. And the content of their interested thermal range is highlighted.
»thermal_isotherm_upper_limitUpper limit of thermal measurement rangeintrw{"unit":"Celsius / °C"}Only take effect when the isotherm is opened
»thermal_isotherm_lower_limitLower limit of thermal measurement rangeintrw{"unit":"Celsius / °C"}Only take effect when the isotherm is opened
»thermal_global_temperature_minThe minimum temperature measured in global screenfloatr{"unit":"Celsius / °C"}
»thermal_global_temperature_maxThe maximum temperature measured in global screenfloatr{"unit":"Celsius / °C"}
countryCountry and area codetextr0
rid_stateRID working stateboolr0{"true":"Normal","false":"Abnormal"}
commander_mode_lost_action[New] To-point flight mission out of control actionenum_intrw1{"0":"Continue to execute the wayline task","1":"Exit the wayline task, and execute the remote controller out of control action."}
current_commander_flight_mode[New] Current mode of to-point flight missionenumr1{"0":"Optimal height","1":"Preset height"}
commander_flight_height[New] To-point flight mission heightfloatrw1{"unit":"meter / m","min":2,"max":3000,"step":0.1}Relative to (airport) takeoff point altitude. ALT.
mode_code_reasonThe reason why the drone enters current stateenum_intr1{"0":"No meaning","1":"Low battery power (returning to home, landing)","2":"Low battery voltage (returning to home, landing)","3":"Serious low voltage (returning to home, landing)","4":"Request from remote controller button (taking off, returning to home, landing)","5":"App request (taking off, returning to home, landing)","6":"Remote controller signal is lost (returning to home, landing, hovering)","7":"Trrigered by external device like navigation and SDK (taking off, returning to home, landing)","8":"Enter the dock GEO zone (landing)","9":"Trrigered Return to Home but is too closed to the home point (landing)","10":"Trrigered Return to Home but is too far from the home point (landing)","11":"Executing waypoint mission (taking off)","12":"Arrive above the home point in the Return to Home period (landing)","13":"When the drone height is reaching 0.7m (second low limit of landing), the drone height continues to drop. (landing)","14":"Devices like App and SDK forcibly break the low limit protection (landing)","15":"There is plane passing by around the drone (returning, landing)","16":"Fail to control the height (returning, landing)","17":"Return to Home because of critically low battery (landing)","18":"AP control flight mode (manual flight)","19":"Hardware abnormal (returning, landing)","20":"Touching ground avoidance protection is finished (landing)","21":"Cancel the Return to Home (hovering)","22":"Obstacle appears when the drone is Return to Home (landing)","23":"High wind trigger in dock scenario (returning to home)"}
gearGearenum_intr0{"0":"A","1":"P","2":"NAV","3":"FPV","4":"FARM","5":"S","6":"F","7":"M","8":"G","9":"T"}
firmware_versionFirmware versiontextr1{"length":"64"}
compatible_statusFirmware compatible stateenum_intr1{"0":"Don't need compatible upgrade","1":"Need compatible upgrade"}Consistency Upgrade: Refers to a situation where the firmware versions of certain modules on the aircraft do not match the system's compatible version and require an upgrade. Common scenarios include, for example, when the aircraft and remote controller have already been upgraded to the latest version, but upon replacing the battery, it is found that the battery has not been upgraded. In such cases, a consistency upgrade prompt will appear. General Upgrade: Developers upgrade all modules of the aircraft to a specified firmware version.
firmware_upgrade_statusFirmware upgrade stateenum_intr1{"0":"Not upgraded","1":"Upgrading"}
horizontal_speedHorizontal speedfloatr0{"unit":"mter per second / m/s"}
vertical_speedVertical speedfloatr0{"unit":"mter per second / m/s"}
longitudeCurrent longitudefloatr0
latitudeCurrent latitudefloatr0
heightAbsolute heightfloatr0Relative Ellipsoidal Height. Calculation method is relative Height from Takeoff Point + Takeoff Point's Ellipsoidal Height
elevationHeight relative to the takeoff pointfloatr0
attitude_pitchPitch axis anglefloatr0
attitude_rollRoll axis anglefloatr0
attitude_headHead facing angleintr0The angle between the head facing angle and true north (longitude). The angle is positive from 0 to 6 o'clock, and is negative from 6 to 12 o'clock.
home_longitudeLongitude of Home pointfloatr1
home_latitudeLatitude of Home pointfloatr1
home_distanceDistance to Home pointfloatr0
wind_speedWind speedfloatr0Wind speed estimation. The wind speed is estimated by the drone attitude. It can not be used as meteorological data because there might exist some errors.
wind_directionCurrent wind directionenum_intr0{"1":"North","2":"Northeast","3":"East","4":"Southeast","5":"South","6":"Southwest","7":"West","8":"Northwest"}
control_sourceCurrent control sourcetextr1The source can be the device or browser. Device uses A/B to represent control A and control B. The browser uses uuid as identifier.
low_battery_warning_thresholdLow battery warningintr1User-set low battery warning percentage
serious_low_battery_warning_thresholdSerious low battery warningintr1User-set serious low battery warning percentage
total_flight_timeTotal flight time of aircraftintr0{"unit":"second / s"}
total_flight_distanceTotal flight distance of aircraftfloatr0{"unit":"meter / m"}
batteryBattery information of aircraftstructr0
»capacity_percentTotal remaining battery powerint{"max":100,"min":0}
»remain_flight_timeRemaining flight timeint{"unit":"second / s"}
»return_home_powerPercentage of battery required for returnint{"max":100,"min":0}
»landing_powerPercentage of battery of forced landingint{"max":100,"min":0}
»batteriesDetailed information of batteryarray{}
»»[array_item]Elements in arraystruct{}{"size": ""}
»»»capacity_percentRemaining battery powerint{"max":100,"min":0}
»»»indexBattery indexint{"min":"0"}
»»»snBattery serial number (SN)text
»»»typeBattery typeenum_int{}
»»»sub_typeBattery sub typeenum_int{}
»»»firmware_versionFirmware versiontext
»»»loop_timesLoop times of batteryint
»»»voltagevoltageint{"unit":"millivolt / mV"}
»»»temperatureTemperaturefloat{"unit":"Celsius / °C"}保留小数点后一位
»»»high_voltage_storage_daysStorage days of high voltageint{"unit":"day / d"}
storageStorage capacitystructr0kb
»totalTotal capacityint{"unit":"Kilobyte / KB"}
»usedUsed capacityint{"unit":"Kilobyte / KB"}
position_stateStar search statestructr0
»is_fixedWhether is fixedenum_int{"0":"Not start","1":"fixing","2":"fix successfully","3":"fix failed"}
»qualityStar search gearenum_int{"0":"0","1":"1","2":"2","3":"3","4":"4","5":"5","10":"RTK is being usd"}
»gps_numberGPS star search numberint
»rtk_numberRTK star search numberint
track_idTrack IDtextr0{"length":"64"}
{type-subtype-gimbalindex}{{type-subtype-gimbalindex}_XXGoBhzNpQ}structr0{{type-subtype-gimbalindex}_jwYOqxlOgI}
»gimbal_pitchPitch axis angle of gimbaldoubler{"max":"180","min":"-180","step":0.1,"unit":"degree / °"}
»gimbal_rollRoll axis angle of gimbaldoubler{"max":"180","min":"-180","step":0.1,"unit":"degree / °"}
»gimbal_yawYaw axis angle of gimbaldoubler{"max":"180","min":"-180","step":0.1,"unit":"degree / °"}
»measure_target_longitudeTarget longitude of laser measurementdoubler{"max":"180","min":"-180","unit":"degree / °"}
»measure_target_latitudeTarget latitude of laser measurementdoubler{"max":"90","min":"-90","unit":"degree / °"}
»measure_target_altitudeTarget altitude of laser measurementdoubler{"unit":"meter / m"}
»measure_target_distanceMeasurement distancedoubler{"unit":"meter / m"}
»measure_target_error_stateMeasurement stateenum_intr{"0":"NORMAL","1":"TOO_CLOSE","2":"TOO_FAR","3":"NO_SIGNAL"}
»payload_indexPayload indextextrPayload index. The format is {type-subtype-gimbalindex}
»smart_track_pointSmart Track point informationarrayr{}
»»[array_item]Elements in arraystruct{}{"size": ""}
»»»track_target_modeTrack modeenum_int{"1":"Normal tracking","2":"Normal tracking, but low credibility","3":"Target is GPS point, or target is lost but predicted"}
»»»track_latitudeTarget latitudedouble{"max":"90","min":"-90","unit":"degree / °"}
»»»track_longitudeTarget longitudedouble{"max":"180","min":"-180","unit":"degree / °"}
»»»track_altitudeTarget altitudedouble{"unit":"meter / m"}
»zoom_factorZoom factordoubler
total_flight_sortiesTotal flight sorties of aircraftintr0
maintain_statusMaintenance informationstructr0
»maintain_status_arrayMaintenance information arrayarray{}
»»[array_item]Elements in arraystruct{}{"size": ""}
»»»stateMaintenance stateenum_int{"0":"No maintenance","1":"Under maintenance"}
»»»last_maintain_typeLast maintenance typeenum_int{"0":"No maintenance","1":"Drone basic maintenance","2":"Drone routine maintenance","3":"Drone deep maintenance","17":"Dock maintenance"}
»»»last_maintain_timeLast maintenance timedate{"unit":"second / s"}
»»»last_maintain_flight_timeLast maintenance flight timeint{"unit":"小时 / h"}
»»»last_maintain_flight_sortiesLast maintenance flight sortiesint{"max":"2147483647","min":"0","step":"1"}
activation_timeActivation time of drone (unix timestamp)intr0{"unit":"second / s"}
night_lights_stateNight light state of aircraftenum_intrw0{"0":"Close","1":"Open"}
height_limitHeight restriction state of aircraftintrw0{"max":"1500","min":"20","step":"1","unit":"meter / m"}
is_near_height_limitWhether approach the setting height restrictionenum_intr0{"0":"Not reached","1":"Reached"}
is_near_area_limitWhether approach the GEO zoneenum_intr0{"0":"Not reached","1":"Reached"}
obstacle_avoidanceObstacle sensing state of aircraftstructrw0
»horizonHorizontal obstacle sensing stateenum_int{"0":"Close","1":"Open"}
»upsideUpward obstacle sensing stateenum_int{"0":"Close","1":"Open"}
»downsideDownward obstacle sensing stateenum_int{"0":"Close","1":"Open"}
rth_modeRTH height modeenum_intr1{"0":"Optimal height","1":"Preset height"}Under optimal RTH mode, aircraft will automatically plan the optimal return altitude. Currently, the DJI dock does not support setting the return altitude mode. You can only choose the 'Preset height' mode. When the environment and lighting do not meet the requirements of the visual system (such as direct sunlight in the evening or no light at night), the aircraft will perform a straight-line return at the altitude you have set.
current_rth_modeCurrent RTH height modeenum_intr1{"0":"Optimal height","1":"Preset height"}Currently dock only supports preset height mode.
psdk_ui_resourcepsdk ui resource packagearrayr1{}
»[array_item]Elements in arraystructr1{}{"size": ""}
»»psdk_indexpsdk payload device indexint{"min":0}
»»psdk_readypsdk readiness stateenum_int{"0":"Not ready","1":"Ready"}
»»object_keyoss objecttext
psdk_widget_valuespsdk payload device propertyarrayr1{}
»[array_item]Elements in arraystructr1{}{"size": ""}
»»psdk_indexpsdk payload device indexint{"min":0}
»»psdk_nameDevice nametext
»»psdk_snDevice sequence numbertext
»»psdk_versionDevice firmware versiontext
»»psdk_lib_versionpsdk lib versiontext
»»speakerSpeaker statestruct[{"identifier":"work_mode","name":"Speaker working mode","pushMode":1,"accessMode":"r","dataType":{"type":"enum_int","specs":{"0":"TTS payload mode","1":"Record and speak"}}},{"identifier":"play_mode","name":"Speaker play mode","pushMode":1,"accessMode":"r","dataType":{"type":"enum_int","specs":{"0":"Single play","1":"Circle play(one song)"}}},{"identifier":"play_volume","name":"Speaker volume","pushMode":1,"accessMode":"r","dataType":{"type":"int","specs":{"min":0,"max":100,"step":1}}},{"identifier":"system_state","name":"Speaker state","pushMode":1,"accessMode":"r","dataType":{"type":"enum_int","specs":{"0":"Idle","1":"Transmitting (from dock to aircraft)","2":"Playing","3":"under mistake","4":"TTS text transferring","99":"Downloading(from cloud server by dock)"}}},{"identifier":"play_file_name","name":"Last played file name by speaker","pushMode":1,"accessMode":"r","dataType":{"type":"text","specs":{"length":128,"unit":"Byte / B"}}},{"identifier":"play_file_md5","name":"Last played file md5 checksum by speaker","pushMode":1,"accessMode":"r","dataType":{"type":"text"}}]
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.