参数配置
set_tcp({x, y, z, Rz, Ry, Rx})
设置 TCP
设置工具中心点(TCP)坐标,坐标值相对于工具坐标系。
Lua请求参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| x,y,z | number | 在工具坐标系下的 TCP 坐标(m) | 
| Rz,Ry,Rx | number | TCP 相对于坐标轴的旋转角度(rad) | 
设定工具中心点的RPY坐标,坐标值相对于工具坐标系。
JSON请求参数
| 参数名 | 数据类型 | 说明 | 
|---|---|---|
| value | double数组 | [x, y, z, Rz, Ry, Rx],每个元素的单位:m。 注意:这个坐标是在工具坐标系下的坐标 | 
示例
| Lua 命令 | set_tcp({0, 0.04, 0, 0, math.pi, 0}) | 
| Json 请求 | {"cmd":"set_tcp", "data":{"value":[1.002,1.002,1.002,1.002,1.002,1.002]}} | 
| Json 响应 | {"data":{"result":1},"code":0} | 
get_tcp()
获取 TCP
获取当前机器工具中心点(TCP)设置。
Lua返回值
| 返回值 | 类型 | 说明 | 
|---|---|---|
| result | table | 见下 | 
| result[1](x),result[2](y),result[3](z) | number | 在工具坐标系下的 TCP 坐标(m) | 
| result[4](Rz) | number | TCP 相对于 Z 轴的旋转角度(rad) | 
| result[5](Ry) | number | TCP 相对于 Y 轴的旋转角度(rad) | 
| result[6](Rx) | number | TCP 相对于 X 轴的旋转角度(rad) | 
JSON返回值
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| value | double数组 | 每个元素的单位:m,[x, y, z, Rz, Ry, Rx],注意:这个坐标是在工具坐标系下的坐标 | 
示例
| Lua 命令 | get_tcp() | 
| Lua 返回 | {0,0.04,0,0,3.14159,0} | 
| JSON 请求 | {"cmd":"get_tcp"} | 
| JSON 响应 | {"data":{"value":[0,0.04,0,0,3.141592653589793,0]},"code":0} | 
set_velocity_factor(factor)
设置速度因子
设置速度因子,以手臂move命令的速度为基准,设置实际速度为move命令速度的对应百分比,如 100 表示move命令速度的100%,10表示move命令速度的10%。
请求参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| factor | number | 速度因子百分比,范围 0~100 | 
JSON返回值
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| data.task_id | int | 任务ID | 
示例
| Lua 命令 | set_velocity_factor(factor) | 
| JSON 请求 | {"cmd":"set_velocity_factor", "data":{"value":50}} | 
| JSON 响应 | {"data":{"task_id":20},"code":0} | 
get_velocity_factor()
获取速度因子
获取速度因子。
响应结果
| 返回值 | 类型 | 说明 | 
|---|---|---|
| value | number | 速度因子百分比,范围 0~100 | 
示例
| Lua 命令 | get_velocity_factor() | 
| Lua 返回 | number | 
| JSON 请求 | {"cmd":"get_velocity_factor"} | 
| JSON 响应 | {"data":{"value":50},"code":0} | 
set_payload(mass, cog)
设置负载
设置负载的质量和质心,另外也可以使用单独的方法set_payload_mass() 和 set_payload_cog() 来设置。
当负载的重量或者重量分布发生变化时,必须调用该方法更新。比如:当机器人捡起或者放下一个较重的物体时。
cog重心参数是可选的,如果没有提供该参数,则TCP的中心点会被作为负载的中心点;如果cog参数忽略了,后续如果有调用set_tcp(pose)方法则会更新负载的重心到新的的TCP重心。
Lua请求参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| mass | number | 单位:kg | 
| cog.x | number | 质心的 X 方向偏移(m) | 
| cog.y | number | 质心的 Y 方向偏移(m) | 
| cog.z | number | 质心的 Z 方向偏移(m) | 
JSON请求参数
| 参数名 | 数据类型 | 说明 | 
|---|---|---|
| mass | double | 质量 单位:kg | 
| cog | double数组 | [CoGx, CoGy, CoGZ],每个元素的单位:m。 注意:这个坐标是在工具坐标系下的坐标 | 
返回结果
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| result | int | 结果 0:设置失败 1:设置成功 | 
示例
- mass:质量2kg
- cog:负载中心点坐标:x:0,y:0,z:0.5m(工具坐标系下)
| Lua 命令 | set_payload(2.0, {0, 0, 0.5}) | 
| JSON 请求 | {"cmd":"set_payload", "data": {"mass":12, "cog":[1,2,3]}} | 
| JSON 响应 | {"data":{"result":1},"code":0} | 
get_payload()
获取负载
获取当前机器人末端负载的质量和质心。
Lua响应结果
| 返回值 | 类型 | 说明 | 
|---|---|---|
| result | table | 见下 | 
| result.mass | number | 质量(kg) | 
| result.cog.x | number | 质心的 X 方向偏移(m) | 
| result.cog.y | number | 质心的 Y 方向偏移(m) | 
| result.cog.z | number | 质心的 Z 方向偏移(m) | 
JSON返回结果
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| mass | double | 质量 单位:kg | 
| cog | double数组 | [CoGx, CoGy, CoGZ],每个元素的单位:m。 注意:这个坐标是在工具坐标系下的坐标 | 
示例
| Lua 命令 | get_payload() | 
| Lua 返回 | {cog={y=0,x=0,z=0},mass=0} | 
| JSON 请求 | {"cmd":"get_payload"} | 
| JSON 响应 | {"data":{"mass":0,"cog":[0,0,0]},"code":0} | 
set_payload_mass(mass)
设置负载的质量
设置负载的质量。当负载的重量或者重量分布发生变化时,必须调用该方法更新。比如:当机器人捡起或者放下一个较重的物体时。
Lua请求参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| mass | number | 负载质量(kg) | 
JSON请求参数
| 参数名 | 数据类型 | 说明 | 
|---|---|---|
| value | double | 质量 单位:kg | 
返回结果
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| data.result | int | 结果 0:设置失败 1:设置成功 | 
示例
| Lua 命令 | set_payload_mass(2.0) | 
| JSON 请求 | {"cmd":"set_payload_mass", "data":{"value":2.0}} | 
| JSON 响应 | {"data":{"result":1},"code":0} | 
get_payload_mass()
获取负载的质量
获取当前机器人末端负载的质量。
响应结果
| 返回值 | 类型 | 说明 | 
|---|---|---|
| result | number | 负载质量(kg) | 
示例
| Lua 命令 | get_payload_mass() | 
| Lua 返回 | 2 | 
| JSON 请求 | {"cmd":"get_payload_mass"} | 
| JSON 响应 | - | 
set_payload_cog({x, y, z})
设置负载的质心
设置负载的重心,当负载的重量或者重量分布发生变化时,必须调用该方法更新。比如:当机器人捡起或者放下一个较重的物体时。
Lua请求参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| x | number | 质心的 X 方向偏移(m) | 
| y | number | 质心的 Y 方向偏移(m) | 
| z | number | 质心的 Z 方向偏移(m) | 
JSON请求参数
| 参数名 | 数据类型 | 说明 | 
|---|---|---|
| value | double数组 | [CoGx, CoGy, CoGZ],每个元素的单位:m。 注意:这个坐标是在工具坐标系下的坐标 | 
JSON返回结果
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| result | int | 结果 0:设置失败 1:设置成功 | 
示例
- cog:负载中心点坐标:x:0,y:0,z:0.5m(工具坐标系下)
| Lua 命令 | set_payload_cog({0, 0, 0.5}) | 
| JSON 请求 | {"cmd":"set_payload_cog", "data":{"value":[1,2,3]}} | 
| JSON 响应 | {"data":{"result":1},"code":0} | 
get_payload_cog()
获取负载的质心
获取当前机器人末端负载的质心。
Lua响应结果
| 返回值 | 类型 | 说明 | 
|---|---|---|
| result | table | 见下 | 
| result.x | number | 质心的 X 方向偏移(m) | 
| result.y | number | 质心的 Y 方向偏移(m) | 
| result.z | number | 质心的 Z 方向偏移(m) | 
示例
| Lua 命令 | get_payload_cog() | 
| Lua 返回 | {y=0,x=0,z=0} | 
| JSON 请求 | 待实现 | 
| JSON 响应 | - | 
set_gravity({x, y, z})
设置机器人重力方向
设置机器人重力加速度的方向。当机器人固定好后,这个对应的是与地球中心相反的加速方向。该设置会影响拖动示教体验。
Lua命令参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| {x=?, y=?, z=?} | table{number} | 相对于机器人的基座标描述的重力方向,单位 m/s2 | 
JSON请求参数
| 参数 | 类型 | 说明 | 
|---|---|---|
| value | number[] | value[0]对应 X,value[1]对应 Y,value[2]对应 Z | 
JSON响应结果
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| result | int | 结果 0:设置失败 1:设置成功 | 
示例
- 表示在 Z 轴负方向有一个 9.82 m/s2 (1 g) 的加速度(默认)
| Lua 命令 | set_gravity({x=0, y=0, z=-9.82}) | 
| JSON 请求 | {"cmd": "set_gravity", "data": {"value": [0, 0, -9.82]}} | 
| JSON 响应 | {"data":{"result":1},"code":0} | 
get_gravity()
获取机器人重力方向
获取机器人重力加速度的方向。
Lua响应结果
| 返回值 | 类型 | 说明 | 
|---|---|---|
| result | table | 三个方向的重力加速度,见下 | 
| result.x | number | X 方向加速度(m/s2) | 
| result.y | number | Y 方向加速度(m/s2) | 
| result.z | number | Z 方向加速度(m/s2) | 
JSON返回结果
| 返回值 | 数据类型 | 说明 | 
|---|---|---|
| gravity | double数组 | value[0] 对应 X,value[1] 对应 Y,value[2] 对应 Z | 
示例
| Lua 命令 | get_gravity() | 
| Lua 返回 | {y=0,x=0,z=-9.82} | 
| JSON 请求 | {"cmd":"get_gravity"} | 
| JSON 响应 | {"data":{"gravity":[0,0,-9.82]},"code":0} |