API 说明

rokae 工控机主控支持的 API

指令号

命令

支持情况

100

获取机械臂程序版本号

支持

101

发送速度数据

支持

102

发送加速度数据

支持

103

发送圆滑过渡参数

支持

104

发送工具坐标系(TCP)参数

支持

105

设置数字量输出

支持

106

SetJointsMovej

支持

107

SetCartMovel

支持

108

SetJoinsMovel

支持

109

SetCartMovej

支持

110

MovejSequence

支持

111

MovelSequence

支持

112

SetJointsMovejDo

不支持

113

SetCartMovelDo

不支持

114

SetJointsMovelDo

不支持

115

SetJointsMovejGroupDo

不支持

116

SetCartMovelGroupDo

不支持

117

SetJointsMovelGroupDo

不支持

118

MovelUntil

不支持

119

获取数字量输入状态

不支持

120

获取数字量输出状态

不支持

121

获取模拟量输入口数值

不支持

122

获取机械臂当前角度

支持

123

获取机械臂当前位姿

支持

200

机械臂后台发送状态

支持

rokae 机械臂主控支持的 API

PROC xyzConnect(string sock)

连接指定socket

参数

sock (VAR string) – socket名称，定义在全局变量中

PROC xyzClose(string sock)

关闭指定socket

参数

sock (VAR string) – socket名称，定义在全局变量中

FUNC int xyzSwitchApp(string app_name)

切换应用

参数

app_name (string) – 应用名称

返回

err_code

返回类型

int

FUNC int xyzSwitchFlow(string flow_name)

切换flow

参数

flow_name (string) – flow名称

返回

err_code

返回类型

int

FUNC int xyzSwitchItem(int ws_id, string item_codename)

切换工件

参数

  • ws_id (int) – 工作空间 id

  • item_codename (string) – 工件名称

返回

err_code

返回类型

int

FUNC int xyzSwitchTool(string tool_name)

切换工具

参数

tool_name (string) – 工具名称

返回

err_code

返回类型

int

FUNC int xyzReqCapImg(int ws_id)

请求拍照

参数

  • ws_id (int) – 工作空间 id

  • Token (int) – 请求拍照结果,全局变量

返回

err_code

返回类型

int

FUNC int xyzGetCapImg(int token)

获取拍照结果

参数

token (int) – 请求拍照时返回的 token

返回

err_code

返回类型

int

FUNC int xyzCapImg(int ws_id)

拍照

参数

ws_id (int) – 需要进行拍照操作的工作空间id

返回

err_code

返回类型

int

FUNC int xyzReqGraspPose(int ws_id)

请求抓取位姿

参数

  • ws_id (INintT) – 需要获取抓取点位的工作空间id

  • Token – 返回的用于获取目标点位时使用的Token,全局变量

返回

err_code

返回类型

int

FUNC int xyzGetGraspPose(int token)

获取抓取位姿

参数

  • token (int) – 求抓取目标点位时返回的token

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • GraspPose (pose) – 抓取位姿

返回

err_code

返回类型

int

FUNC int xyzReqObjPose(int ws_id)

请求物体位姿

参数

  • ws_id (int) – 需要获取物体位姿的工作空间id

  • Token (int) – 物体位姿识别的token

返回

err_code

返回类型

int

FUNC int xyzGetObjPose(int token)

获取物体位姿

参数

  • token (int) – 请求物体位姿时得到的token

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • ObjectPose (pose) – 抓取位姿

返回

err_code

返回类型

int

FUNC int xyzResetVision(int ws_id)

重置视觉

参数

ws_id (int) – 需要重置视觉的工作空间id

返回

err_code

返回类型

int

FUNC int xyzSendCurrentJoints()

发送当前机器人角度

返回

err_code

返回类型

int

FUNC int xyzSendCurrentCartPose()

发送当前机器人位姿

返回

err_code

返回类型

int

FUNC int xyzSendCurrentExtJoints()

发送当前机器人外部角

返回

err_code

返回类型

int

FUNC int xyzReqPick()

请求pick动作规划

返回

err_code

返回类型

int

FUNC int xyzReqPlace()

请求place动作规划

返回

err_code

返回类型

int

FUNC int xyzReqPickPlace(int ws_id)

请求pick和place规划

参数

ws_id (int) – 工作空间id

返回

err_code

返回类型

int

FUNC int xyzGetPickin(int ws_id)

获取取料入框轨迹

参数

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • WaypointType (int array) – 轨迹点类型

  • JointWaypoints (joints array) – joints类型轨迹点

  • CartWaypoints (cart array) – cart类型轨迹点

返回

err_code

返回类型

int

FUNC int xyzGetPickout(int ws_id)

获取取料出框轨迹

参数

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • WaypointType (int array) – 轨迹点类型

  • JointWaypoints (joints array) – joints类型轨迹点

  • CartWaypoints (cart array) – cart类型轨迹点

返回

err_code

返回类型

int

FUNC int xyzGetPlacein(int ws_id)

获取放料入框轨迹

参数

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • WaypointType (int array) – 轨迹点类型

  • JointWaypoints (joints array) – joints类型轨迹点

  • CartWaypoints (cart array) – cart类型轨迹点

返回

err_code

返回类型

int

FUNC int xyzGetPlaceout(int ws_id)

获取放料出框轨迹

参数

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • WaypointType (int array) – 轨迹点类型

  • JointWaypoints (joints array) – joints类型轨迹点

  • CartWaypoints (cart array) – cart类型轨迹点

返回

err_code

返回类型

int

FUNC int xyzSwitchStrat(string strat_name)

请求切换策略

参数

strat_name (string) – 策略名称

返回

err_code

返回类型

int

FUNC int xyzUpdateTotePose()

料箱重定位

参数

TotePose (pose) – 料箱位姿

返回

err_code

返回类型

int

FUNC int xyzUpdateObjPoseOnHand()

工件在上手的二次定位

返回

err_code

返回类型

int

FUNC int xyzUpdateObjPoseToHand()

工件不在手上的二次定位

参数

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • WaypointType (int array) – 轨迹点类型

  • JointWaypoints (joints array) – joints类型轨迹点

  • CartWaypoints (cart array) – cart类型轨迹点

返回

err_code

返回类型

int

FUNC int xyzGetObjPoseType()

获取工件姿态类型

参数

PoseType (int) – 工件姿态类型

返回

err_code

返回类型

int

FUNC int xyzResetPalletStatus()

重置工业码垛状态

返回

err_code

返回类型

int

FUNC int xyzCalculateGraspPose(int ws_id)

计算抓取位姿

参数

  • ws_id (int) – 工作空间 id

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • GraspPose (pose) – 抓取位姿

返回

err_code

返回类型

int

FUNC int xyzCalculateObjectPose(int ws_id)

计算物体位姿

参数

  • ws_id (int) – 工作空间 id

  • PoseNum (int) – 可供抓取的点数量

  • PipeNum (int) – pipeline编号

  • RegNum (int) – 注册编号

  • ObjectPose (pose) – 物体位姿

返回

err_code

返回类型

int