xCore-SDK  0.4.1
xCore SDK C# API
rokae::clr::BaseRobot类 参考

机器人通用接口 更多...

#include <robot_cli.hpp>

类 rokae::clr::BaseRobot 继承关系图:
rokae::clr::Cobot rokae::clr::PCB3Robot rokae::clr::PCB4Robot rokae::clr::StandardRobot rokae::clr::xMateCr5Robot rokae::clr::xMateErProRobot rokae::clr::xMateRobot

Public 成员函数

void disconnectFromRobot ([Out] ErrorCode^% ec)
 断开与机器人连接。断开前会停止机器人运动, 请注意安全。 更多...
 
Info robotInfo ([Out] ErrorCode^% ec)
 查询机器人基本信息 更多...
 
String sdkVersion ()
 查询xCoreSDK版本 更多...
 
PowerState powerState ([Out] ErrorCode^% ec)
 查询机器人上下电以及急停状态 更多...
 
void setPowerState (Boolean on, [Out] ErrorCode^% ec)
 机器人上下电。注: 只有无外接使能开关或示教器的机器人才能手动模式上电。 更多...
 
OperateMode operateMode ([Out] ErrorCode^% ec)
 查询机器人当前操作模式 更多...
 
void setOperateMode (OperateMode mode, [Out] ErrorCode^% ec)
 切换手自动模式 更多...
 
OperationState operationState ([Out] ErrorCode^% ec)
 查询机器人当前运行状态 (空闲, 运动中, 拖动开启等) 更多...
 
array< double > posture (CoordinateType ct, [Out] ErrorCode^% ec)
 获取机器人法兰或末端的当前位姿 更多...
 
CartesianPosition cartPosture (CoordinateType ct, [Out] ErrorCode^% ec)
 获取机器人法兰或末端的当前位姿 更多...
 
array< double > baseFrame ([Out] ErrorCode^% ec)
 读取基坐标系, 相对于世界坐标系 更多...
 
Toolset toolset ([Out] ErrorCode^% ec)
 查询当前工具工件组信息. 更多...
 
void setToolset (Toolset^ toolset, [Out] ErrorCode^% ec)
 设置工具工件组信息。 更多...
 
void setToolset (System::String^ toolName, System::String^ wobjName, [Out] ErrorCode^% ec)
 使用已创建的工具和工件,设置工具工件组信息 更多...
 
void setBaseFrame (Frame^ frame, [Out] ErrorCode^% ec)
 设置基坐标系, 设置后仅保存数值,重启控制器后生效 更多...
 
void setMotionControlMode (MotionControlMode mode, [Out] ErrorCode^% ec)
 设置运动控制模式. 更多...
 
void moveReset ([Out] ErrorCode^% ec)
 运动重置, 清空已发送的运动指令, 清除执行信息。 Robot类在初始化时会调用一次运动重置。RL程序和SDK运动指令切换控制,需要先运动重置。 更多...
 
void stop ([Out] ErrorCode^% ec)
 暂停机器人运动; 暂停后可调用moveStart()继续运动。若需要完全停止,不再执行已添加的指令,可调用moveReset() 更多...
 
void executeCommand (MoveCommand::Type type, List< MoveCommand^>^ cmd, [Out] ErrorCode^% ec)
 执行单条或多条运动指令,调用后机器人立刻开始运动 更多...
 
void moveAppend (MoveCommand::Type type, List< MoveCommand^>^ cmd, System::String^% cmdId, [Out] ErrorCode^% ec)
 添加单条或多条运动指令, 添加后调用moveStart()开始运动 更多...
 
void setDefaultSpeed (int speed, [Out] ErrorCode^% ec)
 设定默认运动速度,初始值为100。该数值表示末端最大线速度(单位mm/s), 自动计算对应关节速度。 关节速度百分比划分为5个的范围:

  • < 100 10%
  • 100 ~ 200 30%
  • 200 ~ 500 50%
  • 500 ~ 800 80%
  • > 800 100%

空间旋转速度为200°/s 更多...

 
void setDefaultZone (int zone, [Out] ErrorCode^% ec)
 设定默认转弯区。初始值为为0 (fine, 无转弯区)。该数值表示运动最大转弯区半径(单位:mm), 自动计算转弯百分比 转弯百分比划分4个范围:

  • < 1 0 (fine)
  • 1 ~ 20 10 %
  • 20 ~ 60 30 %
  • > 60 100 %
更多...
 
void setDefaultConfOpt (bool forced, [Out] ErrorCode^% ec)
 设置是否使用轴配置数据(confData)计算逆解。初始值为false 更多...
 
void moveStart ([Out] ErrorCode^% ec)
 开始/继续运动 更多...
 
void setMaxCacheSize (int number, [Out] ErrorCode^% ec)
 设置最大缓存指令个数,指发送到控制器待规划的路径点个数,允许的范围[1,300],初始值为30。 更多...
 
void adjustSpeedOnline (double scale, [Out] ErrorCode^% ec)
 动态调整机器人运动速率,非实时模式时生效。 更多...
 
void getAcceleration (double% acc, double% jerk, [Out] ErrorCode^% ec)
 读取当前加/减速度和加加速度 更多...
 
void adjustAcceleration (double acc, double jerk, [Out] ErrorCode^% ec)
 调节运动加/减速度和加加速度。如果在机器人运动中调用,当前正在执行的指令不生效,下一条指令生效 更多...
 
EventInfo queryEventInfo (Event eventType, [Out] ErrorCode^% ec)
 查询事件信息。 更多...
 
void setEventWatcher (Event eventType, EventCallbackDelegate^ callback, [Out] ErrorCode^% ec)
 设置接收事件的回调函数。 更多...
 
void startJog (JogSpace space, double rate, double step, unsigned index, bool direction, [Out] ErrorCode^% ec)
 开始jog机器人,需要切换到手动操作模式。调用此接口并且机器人开始运动后,无论机器人是否已经自行停止,都必须调用stop()来结束jog操作,否则机器人会一直处于jog的运行状态。 更多...
 
void clearServoAlarm ([Out] ErrorCode^% ec)
 清除伺服报警 更多...
 
List< LogInfo^> queryControllerLog (unsigned count, LogInfo::Level level, [Out] ErrorCode^% ec)
 查询控制器最新的日志 更多...
 
void setDI (unsigned int board, unsigned int port, bool state, [Out] ErrorCode^% ec)
 设置数字量输入信号,仅当输入仿真模式打开时可以设置(见setSimulationMode()) 更多...
 
bool getDI (unsigned int board, unsigned int port, [Out] ErrorCode^% ec)
 查询数字量输入信号值 更多...
 
void setDO (unsigned int board, unsigned int port, bool state, [Out] ErrorCode^% ec)
 设置数字量输出信号值 更多...
 
bool getDO (unsigned int board, unsigned int port, [Out] ErrorCode^% ec)
 查询数字输出量信号值 更多...
 
double getAI (unsigned board, unsigned port, [Out] ErrorCode^% ec)
 读取模拟量输入信号值 更多...
 
void setAO (unsigned board, unsigned port, double value, [Out] ErrorCode^% ec)
 设置模拟量输出信号 更多...
 
void setSimulationMode (bool state, [Out] ErrorCode^% ec)
 设置输入仿真模式 更多...
 
template<typename T >
void readRegister (System::String^ name, List< T >^% value, [Out] ErrorCode^% ec)
 读取寄存器数组。 更多...
 
template<typename T >
void readRegister (System::String^ name, unsigned index, T% value, [Out] ErrorCode^% ec)
 读取寄存器值。可读取单个寄存器,或按索引读取寄存器数组 更多...
 
template<typename T >
void writeRegister (System::String^ name, unsigned index, T value, [Out] ErrorCode^% ec)
 写寄存器值。可写入单个寄存器,或按索引写入寄存器数组中某一元素。 更多...
 
List< RLProjectInfo^> projectsInfo ([Out] ErrorCode^% ec)
 查询工控机中RL工程名称及任务 更多...
 
void loadProject (String^ name, System::Collections::Generic::List< System::String^>^ tasks, [Out] ErrorCode^% ec)
 加载工程 更多...
 
void ppToMain ([Out] ErrorCode^% ec)
 程序指针跳转到main。调用后,等待控制器解析完工程后返回,阻塞时间视工程大小而定,超时时间设定为10秒。 更多...
 
void runProject ([Out] ErrorCode^% ec)
 开始运行当前加载的工程 更多...
 
void pauseProject ([Out] ErrorCode^% ec)
 暂停运行工程 更多...
 
void setProjectRunningOpt (double rate, bool loop, [Out] ErrorCode^% ec)
 更改工程的运行速度和循环模式 更多...
 
List< WorkToolInfo^> toolsInfo ([Out] ErrorCode^% ec)
 查询当前加载工程的工具信息 更多...
 
List< WorkToolInfo^> wobjsInfo ([Out] ErrorCode^% ec)
 查询当前加载工程的工件信息 更多...
 
void recoverState (int item, [Out] ErrorCode^% ec)
 根据选项恢复机器人状态 更多...
 

Protected 成员函数

void _moveEventCallback (const std::unordered_map< std::string, std::any > &info)
 
void _safetyEventCallback (const std::unordered_map< std::string, std::any > &info)
 

Protected 属性

rokae::BaseRobot * robot
 
EventCallbackNativeDelegate _moveNativeDelegate
 
EventCallbackNativeDelegate _safetyNativeDelegate
 

静态 Protected 属性

static EventCallbackDelegate _moveManagedDelegate
 
static EventCallbackDelegate _safetyManagedDelegate
 

详细描述

机器人通用接口

在文件 robot_cli.hpp42 行定义.

构造及析构函数说明

◆ ~BaseRobot()

virtual rokae::clr::BaseRobot::~BaseRobot ( )
inlinevirtual

在文件 robot_cli.hpp53 行定义.

成员函数说明

◆ adjustAcceleration()

void rokae::clr::BaseRobot::adjustAcceleration ( double  acc,
double  jerk,
[Out] ErrorCode^%  ec 
)

调节运动加/减速度和加加速度。如果在机器人运动中调用,当前正在执行的指令不生效,下一条指令生效

参数
acc系统预设加速度的百分比,范围[0.2, 1.5], 超出范围不会报错,自动改为上限或下限值
jerk系统预设的加加速度的百分比,范围[0.1, 2], 超出范围不会报错,自动改为上限或下限值
ec错误码

◆ adjustSpeedOnline()

void rokae::clr::BaseRobot::adjustSpeedOnline ( double  scale,
[Out] ErrorCode^%  ec 
)

动态调整机器人运动速率,非实时模式时生效。

参数
scale运动指令的速度的比例,范围 0.01 - 1。当设置scale为1时,机器人将以路径原本速度运动。
ec错误码

◆ baseFrame()

array< double > rokae::clr::BaseRobot::baseFrame ( [Out] ErrorCode^%  ec)

读取基坐标系, 相对于世界坐标系

参数
ec错误码
返回
坐标系[x, y, z, rx, ry, rz]

◆ cartPosture()

CartesianPosition rokae::clr::BaseRobot::cartPosture ( CoordinateType  ct,
[Out] ErrorCode^%  ec 
)

获取机器人法兰或末端的当前位姿

参数
ct坐标系类型
ec错误码
返回
当前笛卡尔位置

◆ clearServoAlarm()

void rokae::clr::BaseRobot::clearServoAlarm ( [Out] ErrorCode^%  ec)

清除伺服报警

参数
ec错误码,当有伺服报警且清除失败的情况下错误码置为-1

◆ disconnectFromRobot()

void rokae::clr::BaseRobot::disconnectFromRobot ( [Out] ErrorCode^%  ec)

断开与机器人连接。断开前会停止机器人运动, 请注意安全。

参数
ec错误码

◆ executeCommand()

void rokae::clr::BaseRobot::executeCommand ( MoveCommand::Type  type,
List< MoveCommand^>^  cmd,
[Out] ErrorCode^%  ec 
)

执行单条或多条运动指令,调用后机器人立刻开始运动

参数
type指令类型
cmd指令列表, 允许的个数为1-100, 需为同类型指令
ec错误码,仅反馈执行前的错误, 包括:
  1. 网络连接问题;
  2. 指令个数或类型不符

◆ getAcceleration()

void rokae::clr::BaseRobot::getAcceleration ( double%  acc,
double%  jerk,
[Out] ErrorCode^%  ec 
)

读取当前加/减速度和加加速度

参数
acc系统预设加速度的百分比
jerk系统预设的加加速度的百分比
ec错误码

◆ getAI()

double rokae::clr::BaseRobot::getAI ( unsigned  board,
unsigned  port,
[Out] ErrorCode^%  ec 
)

读取模拟量输入信号值

参数
boardIO板序号
port信号端口号
ec错误码
返回
信号值

◆ getDI()

bool rokae::clr::BaseRobot::getDI ( unsigned int  board,
unsigned int  port,
[Out] ErrorCode^%  ec 
)

查询数字量输入信号值

参数
boardIO板序号
port信号端口号
ec错误码
返回
true-开 | false-关

◆ getDO()

bool rokae::clr::BaseRobot::getDO ( unsigned int  board,
unsigned int  port,
[Out] ErrorCode^%  ec 
)

查询数字输出量信号值

参数
boardIO板序号
port信号端口号
ec错误码
返回
true-开 | false-关

◆ loadProject()

void rokae::clr::BaseRobot::loadProject ( String^  name,
System::Collections::Generic::List< System::String^>^  tasks,
[Out] ErrorCode^%  ec 
)

加载工程

参数
name工程名称
tasks
模板参数
System::String要运行的任务。该参数必须指定,不能为空,否则无法执行工程。
ec错误码

◆ moveAppend()

void rokae::clr::BaseRobot::moveAppend ( MoveCommand::Type  type,
List< MoveCommand^>^  cmd,
System::String^%  cmdId,
[Out] ErrorCode^%  ec 
)

添加单条或多条运动指令, 添加后调用moveStart()开始运动

参数
type指令类型
cmd指令列表, 允许的个数为1-100, 需为同类型指令
cmdId本条指令的ID, 可用于查询指令执行信息
ec错误码,仅反馈执行前的错误, 包括:
  1. 网络连接问题;
  2. 指令个数或类型不符

◆ moveReset()

void rokae::clr::BaseRobot::moveReset ( [Out] ErrorCode^%  ec)

运动重置, 清空已发送的运动指令, 清除执行信息。 Robot类在初始化时会调用一次运动重置。RL程序和SDK运动指令切换控制,需要先运动重置。

每次程序开始运行并第一次执行运动指令之前, 调用该函数来重置运动缓存

参数
ec错误码

◆ moveStart()

void rokae::clr::BaseRobot::moveStart ( [Out] ErrorCode^%  ec)

开始/继续运动

参数
ec错误码

◆ operateMode()

OperateMode rokae::clr::BaseRobot::operateMode ( [Out] ErrorCode^%  ec)

查询机器人当前操作模式

参数
ec错误码
返回
手动 | 自动

◆ operationState()

OperationState rokae::clr::BaseRobot::operationState ( [Out] ErrorCode^%  ec)

查询机器人当前运行状态 (空闲, 运动中, 拖动开启等)

参数
ec错误码
返回
运行状态枚举类

◆ pauseProject()

void rokae::clr::BaseRobot::pauseProject ( [Out] ErrorCode^%  ec)

暂停运行工程

参数
ec错误码

◆ posture()

array< double > rokae::clr::BaseRobot::posture ( CoordinateType  ct,
[Out] ErrorCode^%  ec 
)

获取机器人法兰或末端的当前位姿

参数
ct坐标系类型
  1. flangeInBase法兰相对于基坐标系;
  2. endInRef末端相对于外部参考坐标系。例如, 当设置了手持工具及外部工件后,该坐标系类型返回的是工具相对于工件坐标系的坐标。 再例如,若外部参考坐标系与基坐标系重合,那么返回的结果等同于末端相对于基坐标系的位姿。
ec错误码
返回
double数组, [x, y, z, rx, ry, rz].

◆ powerState()

PowerState rokae::clr::BaseRobot::powerState ( [Out] ErrorCode^%  ec)

查询机器人上下电以及急停状态

参数
ec错误码
返回
on-上电 | off-下电 | estop-急停 | gstop-安全门打开

◆ ppToMain()

void rokae::clr::BaseRobot::ppToMain ( [Out] ErrorCode^%  ec)

程序指针跳转到main。调用后,等待控制器解析完工程后返回,阻塞时间视工程大小而定,超时时间设定为10秒。

参数
ec错误码。错误码能提供的信息有限,不能反馈如RL语法错误、变量不存在等错误。可通过queryControllerLog()查询错误日志。

◆ projectsInfo()

List< RLProjectInfo^> rokae::clr::BaseRobot::projectsInfo ( [Out] ErrorCode^%  ec)

查询工控机中RL工程名称及任务

参数
ec错误码
返回
工程信息列表,若没有创建工程则返回空列表

◆ queryControllerLog()

List< LogInfo^> rokae::clr::BaseRobot::queryControllerLog ( unsigned  count,
LogInfo::Level  level,
[Out] ErrorCode^%  ec 
)

查询控制器最新的日志

参数
count查询个数,上限是10条
level指定日志等级
ec错误码
返回
日志信息

◆ queryEventInfo()

EventInfo rokae::clr::BaseRobot::queryEventInfo ( Event  eventType,
[Out] ErrorCode^%  ec 
)

查询事件信息。

参数
eventType事件类型
ec错误码
返回
事件信息

◆ readRegister() [1/2]

template<typename T >
void rokae::clr::BaseRobot::readRegister ( System::String^  name,
List< T >^%  value,
[Out] ErrorCode^%  ec 
)

读取寄存器数组。

模板参数
T读取数值类型
参数
name寄存器名称
value寄存器数值,允许的类型有bool/int/float
ec错误码

◆ readRegister() [2/2]

template<typename T >
void rokae::clr::BaseRobot::readRegister ( System::String^  name,
unsigned  index,
T%  value,
[Out] ErrorCode^%  ec 
)

读取寄存器值。可读取单个寄存器,或按索引读取寄存器数组

模板参数
T读取数值类型
参数
name寄存器名称
index按索引读取寄存器数组中元素,从0开始。下列两种情况会报错:1) 索引超出数组长度; 2) 寄存器不是数组但index大于0
value寄存器数值,允许的类型有bool/int/float
ec错误码

◆ recoverState()

void rokae::clr::BaseRobot::recoverState ( int  item,
[Out] ErrorCode^%  ec 
)

根据选项恢复机器人状态

参数
item恢复选项,1:急停恢复
ec

◆ robotInfo()

Info rokae::clr::BaseRobot::robotInfo ( [Out] ErrorCode^%  ec)

查询机器人基本信息

参数
ec错误码
返回
机器人基本信息

◆ runProject()

void rokae::clr::BaseRobot::runProject ( [Out] ErrorCode^%  ec)

开始运行当前加载的工程

参数
ec错误码

◆ sdkVersion()

String rokae::clr::BaseRobot::sdkVersion ( )

查询xCoreSDK版本

返回
版本号

◆ setAO()

void rokae::clr::BaseRobot::setAO ( unsigned  board,
unsigned  port,
double  value,
[Out] ErrorCode^%  ec 
)

设置模拟量输出信号

参数
boardIO板序号
port信号端口号
value输出值
ec错误码

◆ setBaseFrame()

void rokae::clr::BaseRobot::setBaseFrame ( Frame frame,
[Out] ErrorCode^%  ec 
)

设置基坐标系, 设置后仅保存数值,重启控制器后生效

参数
frame坐标系,默认使用自定义安装方式
ec错误码

◆ setDefaultConfOpt()

void rokae::clr::BaseRobot::setDefaultConfOpt ( bool  forced,
[Out] ErrorCode^%  ec 
)

设置是否使用轴配置数据(confData)计算逆解。初始值为false

参数
forcedtrue - 使用运动指令的confData计算笛卡尔点位逆解, 如计算失败则返回错误; false - 不使用,逆解时会选取机械臂当前轴角度的最近解
ec错误码

◆ setDefaultSpeed()

void rokae::clr::BaseRobot::setDefaultSpeed ( int  speed,
[Out] ErrorCode^%  ec 
)

设定默认运动速度,初始值为100。该数值表示末端最大线速度(单位mm/s), 自动计算对应关节速度。 关节速度百分比划分为5个的范围:

  • < 100 10%
  • 100 ~ 200 30%
  • 200 ~ 500 50%
  • 500 ~ 800 80%
  • > 800 100%

空间旋转速度为200°/s

参数
speed该接口不对参数进行范围限制。末端线速度的实际有效范围分别是5-4000(协作), 5-7000(工业)。
ec错误码

◆ setDefaultZone()

void rokae::clr::BaseRobot::setDefaultZone ( int  zone,
[Out] ErrorCode^%  ec 
)

设定默认转弯区。初始值为为0 (fine, 无转弯区)。该数值表示运动最大转弯区半径(单位:mm), 自动计算转弯百分比 转弯百分比划分4个范围:

  • < 1 0 (fine)
  • 1 ~ 20 10 %
  • 20 ~ 60 30 %
  • > 60 100 %

参数
zone该接口不对参数进行范围限制。转弯区半径大小实际有效范围是0-200。
ec错误码

◆ setDI()

void rokae::clr::BaseRobot::setDI ( unsigned int  board,
unsigned int  port,
bool  state,
[Out] ErrorCode^%  ec 
)

设置数字量输入信号,仅当输入仿真模式打开时可以设置(见setSimulationMode())

参数
boardIO板序号
port信号端口号
statetrue-开 | false-关
ec错误码

◆ setDO()

void rokae::clr::BaseRobot::setDO ( unsigned int  board,
unsigned int  port,
bool  state,
[Out] ErrorCode^%  ec 
)

设置数字量输出信号值

参数
boardIO板序号
port信号端口号
statetrue-开 | false-关
ec错误码

◆ setEventWatcher()

void rokae::clr::BaseRobot::setEventWatcher ( Event  eventType,
EventCallbackDelegate^  callback,
[Out] ErrorCode^%  ec 
)

设置接收事件的回调函数。

参数
eventType事件类型
callback处理事件的回调函数
  • Event::moveExecution 回调函数在同一个线程执行, 请避免函数中有执行时间较长的操作
  • Event::safety 每次独立线程回调, 没有执行时间的限制
ec错误码

◆ setMaxCacheSize()

void rokae::clr::BaseRobot::setMaxCacheSize ( int  number,
[Out] ErrorCode^%  ec 
)

设置最大缓存指令个数,指发送到控制器待规划的路径点个数,允许的范围[1,300],初始值为30。

如果轨迹多为短轨迹,可以调大这个数值,避免因指令发送不及时导致机器人停止运动(停止后如果有未执行的指令,可moveStart()继续);

参数
number个数
ec错误码

◆ setMotionControlMode()

void rokae::clr::BaseRobot::setMotionControlMode ( MotionControlMode  mode,
[Out] ErrorCode^%  ec 
)

设置运动控制模式.

在调用各运动控制接口之前, 必须设置对应的控制模式。

参数
mode模式
ec错误码

◆ setOperateMode()

void rokae::clr::BaseRobot::setOperateMode ( OperateMode  mode,
[Out] ErrorCode^%  ec 
)

切换手自动模式

参数
mode手动/自动
ec错误码

◆ setPowerState()

void rokae::clr::BaseRobot::setPowerState ( Boolean  on,
[Out] ErrorCode^%  ec 
)

机器人上下电。注: 只有无外接使能开关或示教器的机器人才能手动模式上电。

参数
ontrue-上电 | false-下电
ec错误码

◆ setProjectRunningOpt()

void rokae::clr::BaseRobot::setProjectRunningOpt ( double  rate,
bool  loop,
[Out] ErrorCode^%  ec 
)

更改工程的运行速度和循环模式

参数
rate运行速率,范围 0.01 - 1
looptrue - 循环执行 | false - 单次执行
ec错误码

◆ setSimulationMode()

void rokae::clr::BaseRobot::setSimulationMode ( bool  state,
[Out] ErrorCode^%  ec 
)

设置输入仿真模式

参数
statetrue - 打开 | false - 关闭
ec错误码

◆ setToolset() [1/2]

void rokae::clr::BaseRobot::setToolset ( System::String^  toolName,
System::String^  wobjName,
[Out] ErrorCode^%  ec 
)

使用已创建的工具和工件,设置工具工件组信息

设置前提: 已加载一个RL工程,且创建了工具和工件。否则,只能设置为默认的工具工件,即"tool0"和"wobj0"。一组工具工件无法同时为手持或外部;如果有冲突,以工具的位置为准,例如工具工件同时为手持,不会返回错误,但是工件的坐标系变成了外部

参数
toolName工具名称
wobjName工件名称
ec错误码

◆ setToolset() [2/2]

void rokae::clr::BaseRobot::setToolset ( Toolset toolset,
[Out] ErrorCode^%  ec 
)

设置工具工件组信息。

此工具工件组仅为SDK运动控制使用, 不与RL工程相关。 设置后RobotAssist右上角会显示“toolx", "wobjx", 状态监控显示的末端坐标也会变化。 除此接口外, 如果通过RobotAssist更改默认工具工件(右上角的选项), 该工具工件组也会相应更改. </remarks> <param name="toolset">工具工件组信息</param> <param name="ec">错误码

◆ startJog()

void rokae::clr::BaseRobot::startJog ( JogSpace  space,
double  rate,
double  step,
unsigned  index,
bool  direction,
[Out] ErrorCode^%  ec 
)

开始jog机器人,需要切换到手动操作模式。调用此接口并且机器人开始运动后,无论机器人是否已经自行停止,都必须调用stop()来结束jog操作,否则机器人会一直处于jog的运行状态。

参数
spacejog参考坐标系。
  • 工具/工件坐标系使用原则同setToolset()
  • 工业六轴机型和xMateCR和xMateSR六轴机型支持两种奇异规避方式Jog:Space.singularityAvoidMode, Space.baseParallelMode
  • CR5轴机型支持平行基座模式Jog:Space::baseParallelMode
rate速率, 范围 0.01 - 1
step步长。单位: 笛卡尔空间-毫米 | 轴空间-度。步长大于0即可,不设置上限,如果机器人无法继续jog会自行停止运动。
index根据不同的space,该参数含义如下:
  • 世界坐标系,基坐标系,法兰坐标系,工具工件坐标系: 0~5分别对应X, Y, Z, Rx, Ry, Rz
  • 轴空间: 关节序号,从0开始计数
  • 奇异规避模式,平行基座模式: 六轴机型0~5分别对应X, Y, Z, J4(4轴), Ry, J6(6轴); 5轴机型0~4分别对应X, Y, Z, Ry, J5(5轴)
direction根据不同的space和index,该参数含义如下:
  • 奇异规避模式 J4: true - ±180° | false - 0°
  • 平行基座模式 J4,Ry: true - ±180° | false - 0°
  • 其它,true - 正向 | false - 负向
ec错误码

◆ stop()

void rokae::clr::BaseRobot::stop ( [Out] ErrorCode^%  ec)

暂停机器人运动; 暂停后可调用moveStart()继续运动。若需要完全停止,不再执行已添加的指令,可调用moveReset()

目前支持stop2停止类型:规划停止不断电, 见StopLevel

参数
ec错误码

◆ toolset()

Toolset rokae::clr::BaseRobot::toolset ( [Out] ErrorCode^%  ec)

查询当前工具工件组信息.

此工具工件组仅为SDK运动控制使用, 不与RL工程相关

参数
ec错误码
返回
工具工件组

◆ toolsInfo()

List< WorkToolInfo^> rokae::clr::BaseRobot::toolsInfo ( [Out] ErrorCode^%  ec)

查询当前加载工程的工具信息

参数
ec错误码
返回
工具信息列表, 若未加载任何工程或没有创建工具, 则返回默认工具tool0的信息

◆ wobjsInfo()

List< WorkToolInfo^> rokae::clr::BaseRobot::wobjsInfo ( [Out] ErrorCode^%  ec)

查询当前加载工程的工件信息

参数
ec错误码
返回
工件信息列表, 若未加载任何工程或没有创建工件, 则返回空vector

◆ writeRegister()

template<typename T >
void rokae::clr::BaseRobot::writeRegister ( System::String^  name,
unsigned  index,
value,
[Out] ErrorCode^%  ec 
)

写寄存器值。可写入单个寄存器,或按索引写入寄存器数组中某一元素。

模板参数
T写入数值类型
参数
name寄存器名称
index数组索引,从0开始。下列两种情况会报错:1) 索引超出数组长度; 2) 寄存器不是数组但index大于0
value写入的数值
ec错误码

类成员变量说明

◆ _moveManagedDelegate

EventCallbackDelegate rokae::clr::BaseRobot::_moveManagedDelegate
staticprotected

在文件 robot_cli.hpp48 行定义.

◆ _moveNativeDelegate

EventCallbackNativeDelegate rokae::clr::BaseRobot::_moveNativeDelegate
protected

在文件 robot_cli.hpp47 行定义.

◆ _safetyManagedDelegate

EventCallbackDelegate rokae::clr::BaseRobot::_safetyManagedDelegate
staticprotected

在文件 robot_cli.hpp50 行定义.

◆ _safetyNativeDelegate

EventCallbackNativeDelegate rokae::clr::BaseRobot::_safetyNativeDelegate
protected

在文件 robot_cli.hpp49 行定义.

◆ robot

rokae::BaseRobot* rokae::clr::BaseRobot::robot
protected

在文件 robot_cli.hpp44 行定义.


该类的文档由以下文件生成: