390 lines
10 KiB
Plaintext
390 lines
10 KiB
Plaintext
[{
|
||
"api_name":"实例化无人机",
|
||
"api_function":"init_position",
|
||
"api_parameters":[{
|
||
"parameter_name":"point",
|
||
"parameter_type":"[float,float]",
|
||
"parameter_description":"坐标"
|
||
}],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"定义返航点坐标,并在返航点坐标初始化生成机器人",
|
||
"api_return_values":[{
|
||
"return_value_name":"uav_instance",
|
||
"return_value_type":"UAV",
|
||
"return_value_description":"无人机实例"
|
||
}]
|
||
},{
|
||
"api_name":"设置无人机名称",
|
||
"api_function":"set_name",
|
||
"api_parameters":[{
|
||
"parameter_name":"name",
|
||
"parameter_type":"string",
|
||
"parameter_description":"无人机名称"
|
||
}],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"设置无人机名称",
|
||
"api_return_values":[]
|
||
},{
|
||
"api_name":"设置无人机颜色",
|
||
"api_function":"set_color",
|
||
"api_parameters":[{
|
||
"parameter_name":"color",
|
||
"parameter_type":"string",
|
||
"parameter_description":"无人机颜色,16进制RGB字符串"
|
||
}],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"设置无人机颜色",
|
||
"api_return_values":[]
|
||
},{
|
||
"api_name":"启动无人机",
|
||
"api_function":"start_engine",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"启动无人机引擎",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"关闭无人机",
|
||
"api_function":"shut_down_engine",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"关闭无人机引擎",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"设置各旋翼动力",
|
||
"api_function":"set_rotor_power",
|
||
"api_parameters":[
|
||
{
|
||
"parameter_name":"power",
|
||
"parameter_type":"[float, float, float, float]",
|
||
"parameter_description":"无人机四旋翼各旋翼动力输出,对应关系如下:{0,1}{2,3}"
|
||
}
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"设置无人机各旋翼输出",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"控制无人机飞行方向与速度",
|
||
"api_function":"fly_by_3d_direction",
|
||
"api_parameters":[
|
||
{
|
||
"parameter_name":"duration",
|
||
"parameter_type":"float",
|
||
"parameter_description":"飞行时间,单位:秒若时间值为负数,则会一直飞行直到收到下一次行为控制消息"
|
||
}
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"以固定方向,固定速度飞行对应时间",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"固定时间内飞至目标点",
|
||
"api_function":"fly_to_point_by_time",
|
||
"api_parameters":[
|
||
{
|
||
"parameter_name":"duration",
|
||
"parameter_type":"float",
|
||
"parameter_description":"固定时间,单位:秒"
|
||
}
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"无人机在不超过最大速度的情况下,在给定的时间内从当前位置飞至指定目标点",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"无人机悬停",
|
||
"api_function":"hovering",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"无人机进入悬停状态",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"启用自动避障",
|
||
"api_function":"enable_obstacle_avoidance",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"启用自动避障功能,启用后在无人机即将发生碰撞前会停止动作并悬停",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"关闭自动避障",
|
||
"api_function":"disable_obstacle_avoidance",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"关闭自动避障功能",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"编队控制",
|
||
"api_function":"formation_control",
|
||
"api_parameters":[
|
||
{
|
||
"parameter_name":"formation_data",
|
||
"parameter_type":"[str]",
|
||
"parameter_description":"自定义编队数据Json字符串"
|
||
}
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"以Json数据的形式进行无人机编队控制",
|
||
"api_return_values":[
|
||
{
|
||
"return_value_name":"result",
|
||
"return_value_type":"string",
|
||
"return_value_description":"编队运行成功"
|
||
}
|
||
]
|
||
},
|
||
{
|
||
"api_name":"打开并设置灯光",
|
||
"api_function":"open_lighter",
|
||
"api_parameters":[
|
||
{
|
||
"parameter_name":"intensity",
|
||
"parameter_type":" float",
|
||
"parameter_description":"无人机的灯光强度,范围[1,10]"
|
||
}
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"打开无人机灯光",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"关闭灯光",
|
||
"api_function":"close_lghter",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"关闭无人机灯光",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"开启轨迹渲染",
|
||
"api_function":"open_trail_render",
|
||
"api_parameters":[
|
||
{
|
||
"parameter_name":"thickness",
|
||
"parameter_type":"float",
|
||
"parameter_description":"轨迹渲染厚度"
|
||
}
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"从当前位置启动无人机轨迹渲染,若已开启渲染,则根据参数更新轨迹渲染颜色及厚度",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"关闭轨迹渲染",
|
||
"api_function":"close_trail_render",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"关闭无人机轨迹渲染",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"获取当前高度",
|
||
"api_function":"get_current_height",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"获取并在三维场景中展示当前无人机实时高度",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"获取当前水平距离",
|
||
"api_function":"get_current_distance",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"获取并在三维场景中实时展示当前无人机与返航点水平距离",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"20.获取姿态角",
|
||
"api_function":"get_current_attitude_angle",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"获取并在三维场景中展示当前无人机实时三周姿态角",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"获取当前水平速度",
|
||
"api_function":"get_current_horizontal_speed",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"获取并在三维场景中展示当前无人机的实时水平速度",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"获取当前垂直速度",
|
||
"api_function":"get_current_vertical_speed",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"获取并在三维场景中展示当前无人机的实时垂直速度",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"打开图传",
|
||
"api_function":"open_hd",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"打开无人机高清图传",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"关闭高清图传",
|
||
"api_function":"close_hd",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"关闭无人机高清图传",
|
||
"api_return_values":[
|
||
|
||
]
|
||
},
|
||
{
|
||
"api_name":"关闭高清图传",
|
||
"api_function":"switch_environment",
|
||
"api_parameters":[
|
||
|
||
],
|
||
"api_class":"UAV",
|
||
"api_version":"0.1",
|
||
"api_type":"无人机",
|
||
"api_url":"",
|
||
"api_description":"切换环境显示",
|
||
"api_return_values":[
|
||
|
||
]
|
||
}
|
||
] |