API 说明

Dobot 工控机主控支持的 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

机械臂后台发送状态

支持

Dobot 机械臂主控支持的 API

xyzMasterConnect()

连接到工控机服务器

xyzMasterClose()

断开与工控机服务器的连接

xyzSwitchApp(app_name)

切换应用

参数

app_name (string) – 应用名称

返回

error_code

返回类型

number

xyzSwitchFlow(flow_name)

切换流图

参数

flow_name (string) – 流图名称

返回

error_code

返回类型

number

xyzSwitchItem(ws_id, obj_name)

切换工件

参数

  • ws_id (number) – 工作空间 id

  • obj_name (string) – 工件名称

返回

error_code

返回类型

number

xyzSwitchTool(tool_name)

切换工具

参数

tool_name (string) – 工具名称

返回

error_code

返回类型

number

xyzReqCapImg(vision_service_id)

请求拍照

参数

vision_service_id (number) – 需要进行拍照的视觉服务 id

返回

error_code

返回类型

number

Return token

获取拍照结果的凭据

xyzGetCapImg(token)

获取拍照结果

参数

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

返回

error_code

返回类型

number

xyzCapImg(vision_service_id)

拍照

参数

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

返回

error_code

返回类型

number

xyzReqGraspPose(ws_id)

请求抓取位姿

参数

ws_id (number) – 需要获取抓取位姿的工作空间id

返回

error_code

返回类型

number

Return token

获取抓取位姿结果的凭据

xyzGetGraspPose(token)

获取抓取位姿

参数

token (number) – 请求抓取目标位姿时返回的token

返回

error_code

返回类型

number

返回

pose

返回类型

table

返回

pose_num

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

xyzReqObjPose(ws_id)

请求物体位姿

参数

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

返回

error_code

返回类型

number

Return token

获取物体位姿结果的凭据

xyzGetObjPose(token)

获取物体位姿

参数

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

返回

error_code

返回类型

number

返回

pose

返回类型

table

返回

pose_num

返回类型

number

返回

pose_type

返回类型

number

xyzResetTask()

重置视觉

返回

error_code

返回类型

number

xyzSendCurrentJoints()

发送当前关节位姿

返回

error_code

返回类型

number

xyzSendCurrentCartPose()

发送当前笛卡尔空间位姿

返回

error_code

返回类型

number

xyzReqPick()

请求pick动作规划

返回

error_code

返回类型

number

xyzReqPlace()

请求place动作规划

返回

error_code

返回类型

number

xyzReqPickPlace(ws_id)

请求pick和place规划

参数

ws_id (number) – 需要请求pick和place规划的工作空间id

返回

error_code

返回类型

number

xyzGetPickin(ws_id)

获取取料入框轨迹

参数

ws_id (number) – 需要获取pick in轨迹的工作空间id

返回

error_code

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

返回

wp_num

返回类型

number

返回

wp_type

返回类型

array

返回

wp

返回类型

2d-array

xyzGetPickout(ws_id)

获取取料出框轨迹

参数

ws_id (number) – 需要获取pick out轨迹的工作空间id

返回

error_code

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

返回

wp_num

返回类型

number

返回

wp_type

返回类型

array

返回

wp

返回类型

2d-array

xyzGetPlacein(ws_id)

获取放料入框轨迹

参数

ws_id (number) – 需要获取place in轨迹的工作空间id

返回

error_code

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

返回

wp_num

返回类型

number

返回

wp_type

返回类型

array

返回

wp

返回类型

2d-array

xyzGetPlaceout(ws_id)

获取放料出框轨迹(注：该函数不需要传入参数，仅更新全局变量)

参数

ws_id (number) – 需要获取place out轨迹的工作空间id

返回

error_code

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

返回

wp_num

返回类型

number

返回

wp_type

返回类型

array

返回

wp

返回类型

2d-array

xyzSwitchStrat(strat_name)

请求切换策略

参数

strat_name (string) – 策略名称

返回

error_code

返回类型

number

xyzUpdateTotePose()

料箱重定位

参数

V_POSE – 料箱位姿(全局变量)

返回

error_code

返回类型

number

返回

pose

返回类型

table

xyzUpdateObjPoseOnHand()

工件在上手的二次定位

返回

error_code

返回类型

number

xyzUpdateObjPoseToHand()

工件不在手上的二次定位，获取二次抓取的轨迹

返回

error_code

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

返回

wp_num

返回类型

number

返回

wp_type

返回类型

array

返回

wp

返回类型

2d-array

xyzGetObjPoseType()

获取工件姿态类型

返回

error_code

返回类型

number

返回

pose_type

返回类型

number

xyzResetPalletStatus()

重置工业码垛状态

返回

error_code

返回类型

number

xyzExecuteTraj(num_of_waypoints, type_of_waypoints, waypoints)

执行段轨迹

参数

  • num_of_waypoints (number) – 轨迹点的个数

  • type_of_waypoints (array) – 轨迹点类型数组

  • waypoints[] (2d-array) – 轨迹点数组

返回

error_code

返回类型

number

xyzCalculateGraspPose(ws_id)

计算抓取位姿

参数

ws_id (number) – 工作空间 id

返回

error_code

返回类型

number

返回

pose

返回类型

table

返回

pose_num

返回类型

number

返回

pipeline_num

返回类型

number

返回

register_num

返回类型

number

FUNC num xyzCalculateObjectPose(ws_id)

计算物体位姿

参数

ws_id (number) – 工作空间 id

返回

error_code

返回类型

number

返回

pose

返回类型

table

返回

obj_num

返回类型

number

返回

pose_type

返回类型

number