程序控制
启动任务
启动新任务
串行任务会排队执行,同一时间最多只能运行一个串行任务,需等待前面的任务完成、失败或终止后,才会运行后续任务;
并行任务会立即执行,可以同时运行多个并行任务,环境变量相互独立;
注意
- 当被启动的场景里包含运动相关接口时,务必以串行任务启动(
is_parallel
为false
) - 在串行任务中,务必以并行任务启动(
is_parallel
为true
),否则将阻塞住
task_id = lebai:start_task(scene, params, dir, is_parallel, loop_to)
- 参数
scene
场景 IDparams
传递参数。字符串数组。可选,默认空dir
工作空间名称。可选,默认根目录is_parallel
是否并列执行。可选,默认串行loop_to
重复执行次数。可选,默认 1 次,0 代表无限次
- 返回
task_id
任务 ID
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "start_task", "params": [{"name": "", "params": [""], "dir": "", "is_parallel": false, "loop_to": 1}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {"id": 1}, "id": 1 }
获取全部任务ID
tasks = lebai:get_task_list()
- 返回
tasks
全部未完成的任务的ID
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "load_task_list", "params": [{}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {"ids": []}, "id": 1 }
获取串行任务ID
task = lebai:get_main_task_id()
- 返回
task
串行任务的ID
等待任务完成
stdout = lebai:wait_task(task_id)
- 参数
task_id
start_task 返回的 task_id。可选,默认串行任务
- 返回
stdout
任务的所有print输出
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "wait_task", "params": [{"id": 1}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {"done": true, "stdout": ""}, "id": 1 }
获取任务状态
state = lebai:get_task_state(task_id)
- 参数
task_id
任务 ID。可选,默认串行任务
- 返回
state
任务状态:"NONE"无任务;"WAIT"排队中;"RUNNING"运行中;"PAUSE"暂停中;"SUCCESS"运行成功;"INTERRUPTING"停止中;"INTERRUPT"已停止;"FAIL"运行失败
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "load_task", "params": [{"id": 1}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {"state": ""}, "id": 1 }
停止任务
lebai:cancel_task(task_id)
停止指定任务。当停止串行任务时,会自动调用stop_move停止运动
- 参数
task_id
任务 ID。可选,默认串行任务
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "cancel_task", "params": [{"id": 1}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {}, "id": 1 }
暂停任务
lebai:pause_task(task_id)
暂停指定任务。当暂停串行任务时,会自动调用pause_move暂停运动
- 参数
task_id
任务 ID。可选,默认串行任务
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "pause_task", "params": [{"id": 1}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {}, "id": 1 }
恢复任务
lebai:resume_task(task_id)
恢复指定任务。当恢复串行任务时,会自动调用resume_move恢复运动
- 参数
task_id
任务 ID。可选,默认串行任务
JSON-RPC
// 请求:
{ "jsonrpc": "2.0", "method": "resume_task", "params": [{"id": 1}], "id": 1 }
// 响应:
{ "jsonrpc": "2.0", "result": {}, "id": 1 }