Skip to content

在线编程配置projectManagement

本接口包含在线编程文件下发、在线编程文件管理、全局路点管理等相关功能接口。

文件下发rm_send_project()

  • 方法原型:
C
int rm_send_project(rm_robot_handle * handle,rm_send_project_t project,int * errline)

可以跳转rm_robot_handlerm_send_project_t查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
project输入参数文件下发参数配置结构体。
errline输入参数若运行失败,该参数返回有问题的工程行数,err_line 为 0,则代表校验数据长度不对,err_line 为 -1,则代表无错误。
  • 返回值:
参数类型说明处理建议
0int成功。-
1int控制器返回false,传递参数错误或机械臂状态发生错误。- 校验JSON指令
①启用API的DEBUG日志,捕获原始JSON数据。
②检查JSON语法:确保括号、引号、逗号等格式正确(可借助JSON校验工具)。
③对照API文档,验证参数名称、数据类型及取值范围是否符合规范。
④修正问题后重新发送指令,检查控制器返回的状态码及业务数据是否正常。
- 检查机械臂状态: ①查看机械臂控制器或日志中的实时报错信息(如硬件故障、超限等),根据提示复位、校准或排查硬件问题。
②修正问题后重新发送指令,检查控制器返回的状态码及业务数据是否正常。
-1int数据发送失败,通信过程中出现问题。检查网络连通性
使用ping/telnet等工具检测与控制器的通信链路是否正常。
-2int数据接收失败,通信过程中出现问题或者控制器超时没有返回。- 检查网络连通性
使用ping/telnet等工具检测与控制器的通信链路是否正常。
- 校验版本兼容性
①核对控制器固件版本是否支持当前API功能,具体版本配套关系请参考版本变更说明
②若版本过低需升级控制器或使用适配的API版本。
-3int返回值解析失败,接收到的数据格式不正确或不完整。校验版本兼容性
①核对控制器固件版本是否支持当前API功能,具体版本配套关系请参考版本变更说明
②若版本过低需升级控制器或使用适配的API版本。
-4int文件名称校验失败。检查文件路径和格式
检查文件路径是否为空或格式不正确。
-5int文件读取失败。- 检查文件路径
①确保文件路径是正确的,没有拼写错误。
②确认文件确实存在于指定的路径中。
- 检查文件权限:确保用户有权限读取该文件。如果文件位于受保护的目录中,可能需要管理员权限。
- 检查文件是否被占用:确保文件没有被其他程序打开或锁定。如果文件被占用,可能需要关闭占用文件的程序。
- 联系技术支持:如果以上步骤都无法解决问题,用户可以联系技术支持团队,提供详细的错误信息和操作步骤,以便技术支持人员进行进一步的调查和诊断。
- 重试操作:尝试重新执行 rm_send_project 函数,看看问题是否仍然存在。
- 尝试其他文件:如果可能,尝试读取其他文件,看看问题是否与特定文件相关。
  • 使用示例
C
// 将在线编程文件保存到控制器,保存id为10,并以20%的速度运行
rm_send_project_t project;
int errline;
strcpy(project.project_path, "/home/work/realman.txt");
project.project_type = 0;//在线编程文件
project.plan_speed = 20;
project.only_save = 0;// 运行
project.save_id = 10;
project.project_path_len = strlen(project.project_path);
ret = rm_send_project(robot_handle, project, &errline);
printf("send project result: %d, err_line: %d\n", ret, errline);

轨迹规划中改变速度比例系数rm_set_plan_speed()

  • 方法原型:
C
int rm_set_plan_speed(rm_robot_handle * handle,int speed)

可以跳转rm_robot_handlerm_send_project_t查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
speed输入参数当前进度条的速度数据。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
int speed = 20;
ret = rm_set_plan_speed(robot_handle,speed);

获取在线编程列表rm_get_program_trajectory_list()

  • 方法原型:
C
int rm_get_program_trajectory_list(rm_robot_handle * handle,int page_num,int page_size,const char * vague_search,rm_program_trajectorys_t * trajectorys)

可以跳转rm_robot_handlerm_program_trajectorys_t查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
page_num输入参数页码。
page_size输入参数每页大小。
vague_search输入参数模糊搜索的关键词。
trajectorys输出参数在线编程程序列表。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
// 查询第1页10个在线编程文件
int page_num = 1;
int page_size = 10;
const char *vague_search;
rm_program_trajectorys_t program_trajectorys;
int result = rm_get_program_trajectory_list(robot_handle, page_num, page_size, vague_search, &program_trajectorys);
printf("rm_get_program_trajectory_list result : %d\n", result);

开始运行指定轨迹rm_set_program_id_run()

  • 方法原型:
C
int rm_set_program_id_run(rm_robot_handle * handle,int id,int speed,int block)

可以跳转rm_robot_handle查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
id输入参数页码。
speed输入参数1-100,需要运行轨迹的速度,若设置为0,则按照存储的速度运行。
block输入参数阻塞设置:
多线程模式:0,非阻塞模式,发送指令后立即返回;1,阻塞模式,等待机械臂到达目标位置或规划失败后返回。
单线程模式:0,非阻塞模式;其他值,阻塞模式并设置超时时间,根据运动时间设置,单位为秒。

注意

使用单线程阻塞模式时,请设置超时时间确保轨迹在超时时间内运行结束返回。

  • 返回值:
参数类型说明处理建议
0int成功。-
1int控制器返回false,传递参数错误或机械臂状态发生错误。- 校验JSON指令
①启用API的DEBUG日志,捕获原始JSON数据。
②检查JSON语法:确保括号、引号、逗号等格式正确(可借助JSON校验工具)。
③对照API文档,验证参数名称、数据类型及取值范围是否符合规范。
④修正问题后重新发送指令,检查控制器返回的状态码及业务数据是否正常。
- 检查机械臂状态: ①查看机械臂控制器或日志中的实时报错信息(如硬件故障、超限等),根据提示复位、校准或排查硬件问题。
②修正问题后重新发送指令,检查控制器返回的状态码及业务数据是否正常。
-1int数据发送失败,通信过程中出现问题。检查网络连通性
使用ping/telnet等工具检测与控制器的通信链路是否正常。
-2int数据接收失败,通信过程中出现问题或者控制器超时没有返回。- 检查网络连通性
使用ping/telnet等工具检测与控制器的通信链路是否正常。
- 校验版本兼容性
①核对控制器固件版本是否支持当前API功能,具体版本配套关系请参考版本变更说明
②若版本过低需升级控制器或使用适配的API版本。
-3int返回值解析失败,接收到的数据格式不正确或不完整。校验版本兼容性
①核对控制器固件版本是否支持当前API功能,具体版本配套关系请参考版本变更说明
②若版本过低需升级控制器或使用适配的API版本。
-4int运行状态已停止但未接收到运行成功,是否在外部停止了轨迹。判断是否在外部停止了轨迹,例如触发了暂停、停止等按钮。
  • 使用示例
C
// 以默认速度运行id为1的在线编程文件,阻塞运行(默认线程模式为多线程)
ret = rm_set_program_id_run(robot_handle, 1, 0, 1);
printf("rm_set_program_id_run result :%d\n", ret);

查询在线编程运行状态rm_get_program_run_state()

  • 方法原型:
C
int rm_get_program_run_state(rm_robot_handle * handle,rm_program_run_state_t * run_state)

可以跳转rm_robot_handlerm_program_run_state_t查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
run_state输出参数在线编程运行状态结构体。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
rm_program_run_state_t state;
ret = rm_get_program_run_state(robot_handle, &state);

删除指定编号轨迹rm_delete_program_trajectory()

  • 方法原型:
C
int rm_delete_program_trajectory(rm_robot_handle * handle,int id)

可以跳转rm_robot_handlerm_program_run_state_t查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
id输入参数指定轨迹的ID。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
// 删除编号50的在线编程文件
ret = rm_delete_program_trajectory(robot_handle, 50);
printf("delete program trajectory result : %d\n", ret);

修改指定编号的轨迹信息rm_update_program_trajectory()

  • 方法原型:
C
int rm_update_program_trajectory(rm_robot_handle * handle,int id,int speed,const char * name)

可以跳转rm_robot_handle查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
id输入参数指定在线编程轨迹编号。
speed输入参数更新后的规划速度比例 1-100。
name输入参数更新后的文件名称。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
// 更新编号1的在线编程文件,规划速度为50%,文件名称为“test”
ret = rm_update_program_trajectory(robot_handle,1,50,"test");
printf("update program trajectory result : %d\n", ret);

设置IO默认运行编号rm_set_default_run_program()

  • 方法原型:
C
int rm_set_default_run_program(rm_robot_handle * handle,int id)

可以跳转rm_robot_handle查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
id输入参数设置 IO 默认运行的在线编程文件编号,支持 0-100,0 代表取消设置。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
// 设置 IO 默认运行的在线编程文件编号为1
int ret = -1;
ret = rm_set_default_run_program(robot_handle, 1);

获取IO默认运行编号rm_get_default_run_program()

  • 方法原型:
C
int rm_get_default_run_program(rm_robot_handle * handle,int * id)

可以跳转rm_robot_handle查阅结构体详细描述

  • 参数说明:
参数类型说明
handle输入参数机械臂句柄。
id输出参数存储 IO 默认运行的在线编程文件编号,支持 0-100,0 代表取消设置。
  • 返回值:

0代表成功,其他错误码请参考API2错误代码

  • 使用示例
C
int id;
ret = rm_get_default_run_program(robot_handle, id);