状态控制
start_sys()
启动
启动机器人。该操作会给机器人上电并释放刹车。
响应结果
| 返回值 | 数据类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | start_sys() |
| JSON 请求 | {"cmd":"start_sys"} |
stop_sys()
停止
停止机器人。该操作会给机器人下电并对关节刹车。
响应结果
| 返回值 | 数据类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | stop_sys() |
| JSON 请求 | {"cmd":"stop_sys"} |
powerdown()
关机
机器人操作系统关机，并关闭机器人和控制器电源。
响应结果
| 返回值 | 数据类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | powerdown() |
| JSON 请求 | {"cmd":"power_down"} |
stop()
停止
停止机器人动作，并清空当前尚未执行或执行中的任务。
响应结果
| 返回值 | 数据类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | stop() |
| JSON 请求 | {"cmd":"stop"} |
estop()
软急停
机器人软急停，机器人将立刻停止移动，并断电。
软急停后，调用 start_sys() 可恢复。
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | estop() |
| JSON 请求 | {"cmd":"estop"} |
teach_mode()
启用示教模式
该方法可以开启机器人的拖动示教模式。用户此时可以拖动机器人本体进行位置示教。
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | teach_mode() |
| JSON 请求 | {"cmd":"teach_mode"} |
end_teach_mode()
结束示教模式
该方法可以关闭机器人的拖动示教模式，与 teach_mode() 配对使用。
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | end_teach_mode() |
| JSON 请求 | {"cmd":"end_teach_mode"} |
pause_task()
暂停
暂停机器人当前动作。调用 resume_task() 可恢复。
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | 无 |
| JSON 请求 | {"cmd":"pause_task"} |
resume_task()
恢复
恢复机器人当前动作和后续指令。
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | 无 |
| JSON 请求 | {"cmd":"resume_task"} |
wait(time)
等待
机器人将等待一段时间。
请求参数
| 参数 | 类型 | 说明 |
|---|---|---|
time |
number | 休眠时间（毫秒） |
示例
| Lua 命令 | wait(time) |
| JSON 请求 | - |
wait_until(fn)
等待直到
机器人将等待一段时间，直到满足指定条件。
请求参数
| 参数 | 类型 | 说明 |
|---|---|---|
fn |
function | 等待条件，每个周期执行一次判断，直到该 fn() 返回 true。 |
示例程序
wait_until(function ()
return get_robot_mode() == 5 -- 空闲中
end)
function is_started()
return get_dio(2) == 1 -- 数字输入2
end
wait_until(is_started)
stop_task
停止任务
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
示例
| Lua 命令 | 无 |
| JSON 请求 | {"cmd":"stop_task"} |
get_task_status
获取当前任务
响应结果
| 返回值 | 类型 | 说明 |
|---|---|---|
| task_id | int |
任务id |
data.task_status |
int |
任务状态 0：空闲 1：运行中 2：暂停 3：运行成功 4：运行失败 |
示例
| Lua 命令 | 无 |
| JSON 请求 | {"cmd":"get_task_status"} |
| JSON 响应 | {"data":{"task_status":0,"task_id":null},"code":0} |