程序包 com.rokae.sdk.engine.imps

# 接口 ICobotImp

所有已知实现类:
  `CooperateRobot`, `XMateProRobot`, `XMateRobot`

public interface ICobotImp
协作机器人接口实现

- ## 方法概要

  修饰符和类型
  方法
  说明
  `RobotResult`
  `cancelRecordPath()`
  描述： 取消录制路径
  `RobotResult`
  `disableCollisionDetection()`
  设置碰撞检测相关参数, 关闭碰撞检测功能
  `RobotResult`
  `disableDrag()`
  描述： 机器人停止拖拽模式
  `RobotResult`
  `enableCollisionDetection(double[] sensitivity, RobotT.StopLevel stopLevel, double fallback)`
  设置碰撞检测相关参数, 打开碰撞检测功能
  `RobotResult`
  `enableDrag(RobotT.DragParameterSpace space, RobotT.DragParameterType type)`
  描述： 机器人开启拖拽模式
  `RobotResult`
  `getRtMotionController()`
  创建实时运动控制类(RtMotionControlCobot)实例，通过此实例指针进行实时模式相关的操作。
  `RobotResult`
  `queryPathLists()`
  描述： 查询已保存的所有路径名称
  `RobotResult`
  `removePath(String name, boolean removeAll)`
  描述： 删除已保存的路径
  `RobotResult`
  `replayPath(String name, double rate)`
  描述： 运动指令-路径回放
  `RobotResult`
  `saveRecordPath(String path)`
  描述： 保存录制好的路径
  `RobotResult`
  `saveRecordPath(String path, String name)`
  描述： 保存录制好的路径,并重命名
  `RobotResult`
  `setPanelVOut(int opt)`
  设置xPanel对外供电模式。
  `RobotResult`
  `setRtNetworkTolerance(int percent)`
  设置发送实时运动指令网络延迟阈值，即RobotAssist - RCI设置界面中的”包丢失阈值“。
  `RobotResult`
  `startRecordPath(int duration)`
  描述： 开始录制路径
  `RobotResult`
  `stopRecordPath()`
  描述： 停止录制路径
  `RobotResult`
  `useRciClient(boolean use)`
  兼容RCI客户端设置的接口。

- ## 方法详细资料

  - ### enableDrag

    RobotResult enableDrag(RobotT.DragParameterSpace space, RobotT.DragParameterType type)
    描述： 机器人开启拖拽模式

    注解 : 拖拽模式，只能在手动模式、下电状态打开，且当space为jog时，拖拽方向只能freely

    参数:
      `space` - 拖动空间. 轴空间拖动仅支持自由拖拽类型
      `type` - 拖动类型
    返回:
      RobotResult类，里面包含json数据;

  - ### disableDrag

    RobotResult disableDrag()
    描述： 机器人停止拖拽模式
    返回:
      RobotResult类，里面包含json数据;

  - ### startRecordPath

    RobotResult startRecordPath(int duration)
    描述： 开始录制路径
    参数:
      `duration` - 路径的时长，单位:秒，范围1~1800.此时长只做范围检查用，到时后控制器不会停止录制，需要调用stopRecordPath()来停止
    返回:
      RobotResult类，里面包含json数据;

  - ### stopRecordPath

    RobotResult stopRecordPath()
    描述： 停止录制路径
    返回:
      RobotResult类，里面包含json数据;

  - ### cancelRecordPath

    RobotResult cancelRecordPath()
    描述： 取消录制路径
    返回:
      RobotResult类，里面包含json数据;

  - ### saveRecordPath

    RobotResult saveRecordPath(String path)
    描述： 保存录制好的路径
    参数:
      `path` - 路径名称
    返回:
      RobotResult类，里面包含json数据;

  - ### saveRecordPath

    RobotResult saveRecordPath(String path, String name)
    描述： 保存录制好的路径,并重命名
    参数:
      `path` - 路径名称
      `name` - 如果已录制好一条路径但没有保存，则用该名字保存路径。如果没有未保存的路径，则将已保存的名为"name"的路径重命名为"saveAsName"
    返回:
      RobotResult类，里面包含json数据;

  - ### replayPath

    RobotResult replayPath(String name, double rate)
    描述： 运动指令-路径回放
    参数:
      `name` - 要回放的路径名称
      `rate` - 回放速率, 应小于3.0, 1为路径原始速率。注意当速率大于1时，可能产生驱动器无法跟随错误
    返回:
      RobotResult类，里面包含json数据;

  - ### removePath

    RobotResult removePath(String name, boolean removeAll)
    描述： 删除已保存的路径
    参数:
      `name` - 要删除的路径名称
      `removeAll` - 是否删除所有路径, 可选参数, 默认为否
    返回:
      RobotResult类，里面包含json数据;

  - ### queryPathLists

    RobotResult queryPathLists()
    描述： 查询已保存的所有路径名称
    返回:
      RobotResult类，里面包含json数据;名称列表, 若没有路径则返回空列表

  - ### setPanelVOut

    RobotResult setPanelVOut(int opt)
    设置xPanel对外供电模式。注：仅部分机型支持xPanel功能，不支持的机型会返回错误码
    参数:
      `opt` - 1 off 不输出 2 reserve 保留 3 supply12v 输出12V 4 supply24v 输出24V
    返回:
      RobotResult类，

  - ### setRtNetworkTolerance

    RobotResult setRtNetworkTolerance(int percent)
    设置发送实时运动指令网络延迟阈值，即RobotAssist - RCI设置界面中的”包丢失阈值“。 请在切换到RtCommand模式前进行设置，否则不生效。
    参数:
      `percent` - 允许的范围0 - 100
    返回:
      RobotResult类，

  - ### useRciClient

    RobotResult useRciClient(boolean use)
    兼容RCI客户端设置的接口。通过SDK设置运动控制模式为实时模式之后，无法再使用原RCI客户端控制机器人。 若有使用原版的需求，可在切换到非实时模式后，调用此接口。然后再在RobotAssist上打开RCI功能，即可使用RCI客户端。
    参数:
      `use` - true - 切换到使用第一代
    返回:
      RobotResult类，

  - ### getRtMotionController

    RobotResult getRtMotionController()
    创建实时运动控制类(RtMotionControlCobot)实例，通过此实例指针进行实时模式相关的操作。
    返回:
      RobotResult类；

  - ### enableCollisionDetection

    RobotResult enableCollisionDetection(double[] sensitivity, RobotT.StopLevel stopLevel, double fallback)
    设置碰撞检测相关参数, 打开碰撞检测功能
    参数:
      `sensitivity` - 数组，长度和轴数相同，碰撞检测灵敏度，范围0.01-2.0,
      `stopLevel` - 碰撞后机器人行为, 支持stop1(安全停止, stop0和stop1处理方式相同)和stop2(触发暂停）
      `fallback` - 碰撞后回退距离，单位: 米
    返回:
      RobotResult类；

  - ### disableCollisionDetection

    RobotResult disableCollisionDetection()
    设置碰撞检测相关参数, 关闭碰撞检测功能
    返回:
      RobotResult类；