上云API

设备管理

2023-07-20
暂无评分
Github Edit open in new window

设备拓扑更新

Topic: sys/product/{gateway_sn}/status

Direction: up

Method: update_topo

Data:

ColumnNameTypeconstraintDescription
type网关设备的产品类型int{}参考：产品支持open in new window
sub_type网关子设备的产品子类型int{}参考：产品支持open in new window
device_secret网关设备的密钥text{}
noncenoncetext{}
thing_version网关设备的物模型版本text{}
sub_devices子设备列表array-
»[array_item]数组中的元素struct-{"size": "1"}
»»sn子设备的序列号text{}
»»type子设备的产品类型int{}参考：产品支持open in new window
»»sub_type子设备的产品子类型int{}参考：产品支持open in new window
»»index连接网关设备的通道索引int{}
»»device_secret子设备的密钥text{}
»»noncenoncetext{}
»»thing_version子设备的物模型版本text{}

Example:

## 网关设备+子设备上线
{
	"tid": "tid001",
	"bid": "bid001",
	"method": "update_topo",
	"timestamp": 1234567890123,
	"data": {
		"type": 98,
		"sub_type": 0,
		"device_secret": "secret",
		"nonce": "nonce",
		"thing_version": "1.0.0",
		"sub_devices": [
			{
				"sn": "drone001",
				"type": 116,
				"sub_type": 0,
				"index": "A",
				"device_secret": "secret",
				"nonce": "nonce",
				"thing_version": "1.0.0"
			}
		]
	}
}

## 子设备下线
{
    "tid": "tid001",
    "bid": "bid001",
    "method": "update_topo",
    "timestamp": 1234567890123,
    "data": {
        "type": 98,
        "sub_type": 0,
        "device_secret":"secret",
        "nonce":"nonce",
        "thing_version": "1.0.0",
        "sub_devices":[]
    }
}

设备属性推送

Topic: thing/product/{device_sn}/state 状态数据:设备在状态变化时上报

Topic: thing/product/{device_sn}/osd 定频数据:设备将以 0.5HZ 的频率定时上报

Direction: up

API 说明：
负载属性上报是指飞行器挂载的负载的属性上报，如相机的属性上报。一个负载由负载索引唯一确定（负载索引：产品类型-子类型-挂载位置 {type-subtype-gimbalIndex}），type、subtype数值请参考产品支持open in new window，gimbalindex的对应关系请查看 航线文件格式open in new window中的wpml:payloadPositionIndex。
当前会涉及负载属性上报的协议有 网关设备的设备属性推送以及直播功能的直播能力更新。 对于设备属性推送，负载属性上报的内容为相机本身的信息，如 云台俯仰、偏航、横滚的角度等。对于直播能力更新，负载属性上报的内容更多为相机在直播时的能力，如最大可同时推流的码流数量。负载属性具体结构体请参考下文的example。需要注意遥控器的设备属性在一条消息体中上报，而机场的设备属性推送是分多条推送的。

Data:

ColumnNameTypeconstraintDescription
data消息内容text{}内容可参考设备的设备属性
»camera_indextype-subtype-gimbalIndextext{}gimbalIndex为相机位置，type、sub_type参考：产品支持open in new window

Example:

Topic: thing/product/{dock_sn}/state

Topic: thing/product/{dock_sn}/osd

{
    "tid": "65717bf1-aee7-4abb-8ea3-9b1908548d74",
    "bid": "cf5ad2e6-2f32-4b59-980e-d5c9ee412805",
    "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
                }
            ]
        },
        "electric_supply_voltage": 231,
        "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": "d6cfcea4-c6ca-439b-948f-b17d88fc308f",
    "data": {
        "flighttask_prepare_capacity": 1,
        "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": "e4c15182-776b-4c13-9973-3fc76848ca15",
    "timestamp": 1667220881576,
    "gateway": "dock_sn"
}

{
    "tid": "43d2e632-1558-4c4e-83d2-eeb51b7a377a",
    "bid": "7578f2ac-1f12-4d47-9ab6-5de146ed7b8a",
    "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,
        "air_conditioner_mode": 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": "1bfdfbad-eb5a-4652-a90d-fa4d595d8c71",
    "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": "2d2040eb-23b0-43dc-b7ac-64838276c4ac",
    "timestamp": 1670422793916,
    "gateway": "dock_sn"
}

设备属性设置

Topic: thing/product/{gateway_sn}/property/set

Direction: down

Data:

ColumnNameTypeconstraintDescription
data消息内容text{}内容可参考设备的设备属性

Example:

{
    "bid":"00000000-0000-0000-0000-000000000000",
    "data":{
        "distance_limit_status": {"state": 1}
    },
    "tid":"00000000-0000-0000-0000-000000000000",
    "timestamp":1643268212187
}

Topic: thing/product/{gateway_sn}/property/set_reply

Direction: up

Data:

ColumnNameTypeconstraintDescription
data消息内容text{}内容可参考设备的设备属性

Example:

{
    "bid":"00000000-0000-0000-0000-000000000000",
    "data":{
        "distance_limit_status": {
            "state": {
                "result": 0  // 0: 成功，1：失败，2：超时，0x123456 具体的错误原因码
                }
       }
    },
    "tid":"00000000-0000-0000-0000-000000000000",
    "timestamp":1643268212187
}
请问您的文档阅读体验如何？
若您对文档有意见或疑惑，点击可快速反馈，我们会与您联系。