From e307c7ace8ed3c10b1523effe5a9dd73002e81d9 Mon Sep 17 00:00:00 2001 From: chenyanzhu Date: Fri, 26 Sep 2025 03:47:19 +0000 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0=20Detect.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Detect.md | 127 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 Detect.md diff --git a/Detect.md b/Detect.md new file mode 100644 index 0000000..0b626f2 --- /dev/null +++ b/Detect.md @@ -0,0 +1,127 @@ +# 机器人识别能力接口 + +## 接口列表 +- [识别任务启动](#识别任务启动) +- [识别手中是否有物体任务](#识别手中是否有物体任务) +### task_type +| task_type | 任务说明 | +| ----------------- | ----------- | +| 0 | 识别任务 | +| 1 | 识别手中是否有物体任务 | +## 轮臂机器人识别任务启动 + +### 请求地址 +`POST /api/task/start_task` + +### 请求参数 +| 字段名 | 类型 | 必填 | 默认值 | 说明 | 示例值 | +| ----------------- | ----------- | ---- | ----- |------------ | ------------------- | +| task_type | int64 | 是 | | 任务类型id | 0 | +| payload | object | 是 | | 任务输入参数 | | +| ├─ timeout | int64 | 否 | 10s | 检测超时时间 | 30 | +### 响应参数 +| 字段名 | 类型 | 说明 | 示例值 | +| -------------- | ------ | -------------- | --------------------------------------- | +| task_id | string | 任务id | "e5672a6e-0bc2-4646-a019-dd914034e3ed" | + +示例请求 +``` json +{ + "task_type": 0, + "payload": { + "timeout": 30 + } +} +``` +示例返回 +``` json +{ + "task_id": "e5672a6e-0bc2-4646-a019-dd914034e3ed" +} +``` +需要根据task_id向能力框架查询任务执行情况。 +如果执行成功或执行中,在向能力框架查询到的任务执行情况payload字段如下,status字段为running或finished +``` json +// 执行成功payload +{ + "result": + [ + { + "name": "cardboard_box(4)", + "position": [ + -1.0733862213436471, + -0.9034915533552743, + 0.949744704358564 + ], + "status": "qualified", + "hand": "labeled_part_in_hand" + } + ] +} +``` +如果执行失败,在向能力框架查询到的任务执行情况payload字段,status字段为error +``` json +// 执行失败 +{ + "message": "暂无世界状态数据,请确保场景已正确加载" +} +``` +## 轮臂机器人识别手中是否有物体任务启动 + +### 请求地址 +`POST /api/task/start_task` + +### 请求参数 +| 字段名 | 类型 | 必填 | 默认值 | 说明 | 示例值 | +| ----------------- | ----------- | ---- | ----- |------------ | ------------------- | +| task_type | int64 | 是 | | 任务类型id | 0 | +| payload | object | 是 | | 任务输入参数 | | +| ├─ timeout | int64 | 否 | 10s | 任务超时时间 | 30 | +### 响应参数 +| 字段名 | 类型 | 说明 | 示例值 | +| -------------- | ------ | -------------- | --------------------------------------- | +| task_id | string | 任务id | "e5672a6e-0bc2-4646-a019-dd914034e3ed" | + +示例请求 +``` json +{ + "task_type": 0, + "payload": { + "timeout": 30 + } +} +``` +示例返回 +``` json +{ + "task_id": "e5672a6e-0bc2-4646-a019-dd914034e3ed" +} +``` +需要根据task_id向能力框架查询任务执行情况。 +若检测到手中有物体,则认为执行成功。若超时时间内没有检测到手中有物体,则认为失败。 +如果执行成功或执行中,在向能力框架查询到的任务执行情况payload字段如下,status字段为running或finished +``` json +// 执行成功payload +{ + "result": + [ + { + "name": "cardboard_box(4)", + "position": [ + -1.0733862213436471, + -0.9034915533552743, + 0.949744704358564 + ], + "status": "qualified", + "hand": "labeled_part_in_hand" + } + ] +} +``` +如果执行失败,在向能力框架查询到的任务执行情况payload字段,status字段为error +``` json +// 执行失败 +{ + "message": "暂无世界状态数据,请确保场景已正确加载" +} +``` \ No newline at end of file