Device Attributes
Device Attribute List
-
pushMode：
-
0: The device pushes fixed frequency data, reporting at a frequency of 0.5Hz (Topic:thing/product/
{device_sn}/osd) -
1: The device pushes status data, reporting when the status changes (Topic:thing/product/
{device_sn}/state)
-
-
accessMode：
-
r: Read-only attribute
-
rw: Read and write attribute (Topic:thing/product/
{gateway_sn}/property/set)
-
| Column | Name | Type | constraint | Description | accessMode | pushMode |
|---|---|---|---|---|---|---|
| live_status | Current overall live status of the gateway | array | {"size": -, "item_type": struct} | r | 1 | |
| »video_id | Live stream identifier | text | Identifier for a video stream, formatted as {sn}/{camera_index}/{video_index}. Where {sn} is the video source device serial number, {camera_index} is the camera index in the format {type-subtype-gimbalindex}, and {video_index} is the stream index for the video source. | 0 | ||
| »video_quality | Quality of the live stream | enum_int | {"0":"Auto","1":"Smooth","2":"HD","3":"Ultra HD"} | 0 | ||
| »status | Live status | enum_int | {"0":"Not live","1":"Live"} | 0 | ||
| live_capacity | Live capacity of the gateway device | struct | r | 1 | ||
| »available_video_number | Number of available streams | int | 0 | |||
| »coexist_video_number_max | Maximum number of concurrent streams | int | 0 | |||
| »device_list | Selectable video source devices | array | {"size": -, "item_type": struct} | Selectable video source devices (device level, e.g., aircraft) | 0 | |
| »»sn | Video source device serial number (SN) | text | 0 | |||
| »»available_video_number | Number of streams available for this device | int | 0 | |||
| »»coexist_video_number_max | Maximum number of concurrent streams for this device | int | 0 | |||
| »»camera_list | List of cameras on this device | array | {"size": -, "item_type": struct} | 0 | ||
| »»»camera_index | Camera index | text | In the format {type-subtype-gimbalindex} | 0 | ||
| »»»available_video_number | Number of streams available for this camera | int | 0 | |||
| »»»coexist_video_number_max | Maximum number of concurrent streams for this camera | int | 0 | |||
| »»»video_list | List of available streams for this camera | array | {"size": -, "item_type": struct} | 0 | ||
| »»»»video_index | Stream index for this camera | text | 0 | |||
| »»»»video_type | Stream type for this camera | text | 0 | |||
| longitude | Current longitude | float | {"max":"180","min":"-180","unit_name":"degrees / °"} | r | 0 | |
| latitude | Current latitude | float | {"max":"180","min":"-180","unit_name":"degrees / °"} | r | 0 | |
| height | Absolute height | float | {"unit_name":"meters / m"} | Height relative to the ellipsoid surface | r | 0 |
| capacity_percent | Remaining battery capacity | int | {"max":"100","min":"0","step":"1"} | r | 0 | |
| firmware_version | Firmware version | text | {"length":"64"} | r | 1 | |
| wireless_link | Video transmission link | struct | r | 0 | ||
| »dongle_number | Number of dongles on the aircraft | int | 0 | |||
| »4g_link_state | 4G link connection status | enum_int | {"0":"Not connected","1":"Connected"} | 0 | ||
| »sdr_link_state | SDR link connection status | enum_int | {"0":"Not connected","1":"Connected"} | 0 | ||
| »link_workmode | Transmission link mode of the base | 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 | UAV 4G signal quality | int | {"max":"5","min":"0","step":"1"} | { "biz_code":"device_update_topo", "version":"1.0", "timestamp":146052438362, "data":{}}`json | 0 | |
| »4g_gnd_quality | Ground 4G signal quality | int | {"max":"5","min":"0","step":"1"} | Signal quality between the ground end (e.g., remote controller, AUTEL Dock) and the 4G server | 0 | |
| »sdr_freq_band | SDR frequency band | float | 0 | |||
| »4g_freq_band | 4G frequency band | float | 0 |
Device Attribute Push
Topic: thing/product/{device_sn}/state Status data: Device reports when the status changes
Topic: thing/product/{device_sn}/osd Fixed frequency data: Device reports at a frequency of 0.5Hz
Direction: up
API Description:
Payload attribute reporting refers to the attributes of the payload mounted on the aircraft, such as the attributes of the camera. A payload is uniquely determined by its payload index (payload index: product type - subtype - mounting position {type-subtype-gimbalIndex}), type, and subtype. The values can be found on the product support page, and the corresponding relationship of gimbalindex can be found in the wpml:payloadPositionIndex of the route file format. Currently, the protocols involved in payload attribute reporting include Device Attribute Push for gateway devices and Live Capability Update for live functions. For Device Attribute Push, the reported payload attributes include information about the camera itself, such as the angles of the gimbal pitch, yaw, and roll. For Live Capability Update, the reported payload attributes include more about the camera's capabilities during live streaming, such as the maximum number of concurrent streams. For the specific structure of the payload attributes, please refer to the example below. Note that the remote controller's device attributes are reported in a single message body, while the airport's device attribute push is reported in multiple pushes.
Data:
| Column | Name | Type | constraint | Description |
|---|---|---|---|---|
| data | Message content | text | {} | Content can refer to the device's device attributes |
»{camera_index} | type-subtype-gimbalIndex | text | {} | gimbalIndex is the camera position, type, and subtype refer to the product support page |
Example:
Topic: thing/product/{remote_controller_sn}/state
Topic: thing/product/{remote_controller_sn}/osd
{
"bid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data":`{
"capacity_percent":0,
"latitude":0,
"live_status":`{
"live_time":0,
"live_trendline":0,
"video_id":"",
"video_quality":65535
}`,
"longitude":0,
"transmission_signal_quality":0,
"wireless_link":`{
"4g_freq_band":5.8,
"4g_gnd_quality":65535,
"4g_link_state":0,
"4g_quality":65535,
"4g_uav_quality":65535,
"dongle_number":0,
"link_workmode":1,
"sdr_freq_band":5.8,
"sdr_link_state":0,
"sdr_quality":65535
}`,
"wireless_link_state":`{
"download_quality":0,
"frequency_band":0,
"upward_quality":0
}
},
"tid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp":1676434755031,
"gateway":"4LFCJCC001008S"
}
Topic: thing/product/{aircraft_sn}/state
Topic: thing/product/{aircraft_sn}/osd
{
"bid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"data":{
"43-0-0":{
"gimbal_pitch":0,
"gimbal_roll":0,
"gimbal_yaw":-103.7,
"measure_target_altitude":100,
"measure_target_distance":1256.800049,
"measure_target_error_state":1,
"measure_target_latitude":21.99849,
"measure_target_longitude":112.987933,
"payload_index":"43-0-0",
"version":1
},
"attitude_head":0,
"attitude_pitch":-0.5,
"attitude_roll":-0.1,
"battery":{
"batteries":[
{
"capacity_percent":90,
"firmware_version":"01.02.05.31",
"index":0,
"loop_times":131,
"sn":"xxxx",
"sub_type":0,
"temperature":23.1,
"type":0,
"voltage":49032
}
],
"capacity_percent":45,
"landing_power":5,
"remain_flight_time":0,
"return_home_power":10
},
"elevation":0,
"firmware_version":"04.00.0014",
"gear":1,
"height":100.020332,
"home_distance":0,
"horizontal_speed":0,
"latitude":22,
"longitude":113,
"mode_code":0,
"position_state":`{
"gps_number":15,
"is_fixed":0,
"quality":5,
"rtk_number":0
},
"total_flight_distance":0,
"total_flight_time":0,
"vertical_speed":0,
"wind_direction":0,
"wind_speed":0
},
"tid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxx",
"timestamp":1643268212187,
"gateway":"xxxxx"
}