乐白机械臂接口文档

• 此文档所有接口都需签名验证

接口列表

1.指定机器人启动手臂

POST: <base_url>/open_v2/start_sys/<device_id>

request json:
{}

reponse json:
{
    "code": 0
}

2.指定机器人停止手臂

POST: <base_url>/open_v2/stop_sys/<device_id>

request json:
{}

reponse json:
{
    "code": 0
}

3.急停指定机器人

POST: <base_url>/open_v2/estop/<device_id>

request json:
{}

reponse json:
{
    "code": 0
}

4.取消指定任务

POST: <base_url>/open_v2/cancel_task/<device_id>

request json:
{
  "taskid": 120                          // 要取消的任务id
}

reponse json:
{
    "code": 0
}

5.查询机器人状态

POST: <base_url>/open_v2/get_robot_state/<device_id>

request json:
{}

reponse json:
{
    "code": 0,
    "data": "IDLE"                          // 状态枚举值 
}
状态说明：
ERROR         机器人软件控制系统异常
DISCONNECTED  机器人硬件通讯故障
ESTOP         机器人处于急停状态，请确认安全性
BOOTING       机器人初始化中
ROBOT_OFF     机器人电源未开启
ROBOT_ON      机器人电源已开启
IDLE          机器人处于空闲状态
PAUSED        机器人处于暂停中状态
MOVING        机器人运动中
UPDATING      机器人系统更新中
STARTING      机器人初始化完成到空闲的启动过程中
STOPPING      机器人空闲状态转到停止状态
TEACHING      机器人处于示教模式中
STOP          机器人处于停止状态，非急停状态

6.查询机器人当前任务id

POST: <base_url>/open_v2/get_main_task_id/<device_id>

request json:
{}

reponse json:
{
    "code": 0,
    "data": 211                          // 任务id 
}

7.查询机器人指定任务状态（结果为场景任务的运行状态，不代表业务执行的结果）

POST: <base_url>/open_v2/get_task_state/<device_id>

request json:
{
  "taskid": 122
}

reponse json:
{
    "code": 0,
    "data": "WAIT"                          // 任务状态
}
任务状态：
NONE             无任务
WAIT             排队中
RUNNING          运行中
PAUSE            暂停中
SUCCESS          运行成功
INTERRUPTING     停止中
INTERRUPT        已停止
FAIL             运行失败

8.指定机器人运行场景

POST: <base_url>/open_v2/task/<device_id>

request json:
{
  "scene": "10010",                       // 场景号
  "params": [],                           // 场景参数，（可选）
}

reponse json:
{
    "code": 0,
    "data": 100                          // 任务id
}