方法
1 机器人基本操作及信息查询
connectToRobot() [1/2]
template<WorkType Wt, unsigned short DoF>
void rokae::Robot_T< Wt, DoF >::connectToRobot (error_code &ec )
建立与机器人的连接。机器人地址为创建robot 实例时传入的
- 参数:[out] ec: 错误码
connectToRobot() [2/2]
template<WorkType Wt, unsigned short DoF>
void rokae::Robot_T< Wt, DoF >::connectToRobot (const std::string &remoteIP,const std::string &localIP = "" )
连接到机器人
- 参数:
remoteIP机器人 IP 地址localIP本机地址。实时模式下收发交互数据用,可不设置;PCB3 /4 轴机型不支持 |
disconnectFromRobot()
void rokae::BaseRobot::disconnectFromRobot (error_code & ec)
断开与机器人连接。断开前会停止机器人运动,请注意安全
- 参数: [out] ec: 错误码
setConnectionHandler()
void setConnectionHandler(const std::function<void(bool)> &handler)
设置连接断开回调函数
- 参数: [in] handler 回调函数, 参数为bool, true-连接 | false-断开
robotInfo()
Info rokae::BaseRobot::robotInfo (error_code &ec ) const
查询机器人基本信息
- 参数: [out] ec: 错误码
- 返回: 机器人基本信息(控制器版本,机型,轴数)
powerState()
PowerState rokae::BaseRobot::powerState(error_code &ec) const
机器人上下电以及急停状态
- 参数: [out] ec: 错误码
- 返回:
- on - 上电
- off - 下电
- estop - 急停
- gstop - 安全门打开
setPowerState()
void rokae::BaseRobot::setPowerState (bool on, error_code & ec)
机器人上下电。注:只有无外接使能开关或示教器的机器人才能手动模式上电。
- 参数:
- [in] on: true-上电|false-下电
- [out] ec: 错误码
operateMode()
OperateMode rokae::BaseRobot::operateMode (error_code & ec)const
查询机器人当前操作模式
- 参数: [out] ec: 错误码
- 返回: 手动|自动
setOperateMode()
void rokae::BaseRobot::setOperateMode ( OperateMode mode, error_code & ec)
切换手自动模式
- 参数:
- [in] mode: manual - 手动/ automatic - 自动
- [out] ec: 错误码
rebootSystem()
void rebootSystem(error_code& ec)
重启工控机 注:在自动模式、上电状态、运动和非空闲状态不允许重启操作
- 参数:
- [out] ec: 错误码
shutdownSystem()
void shutdownSystem(error_code& ec)
关闭工控机。在自动模式、上电状态、运动和非空闲状态不允许关闭操作。控制柜断电后重新上电才能重新启动控制器软件
- 参数:
- [out] ec: 错误码
operationState()
OperationState rokae:BaseRobot::operationState ( error_code & ec) const
查询机器人当前运行状态(空闲,运动中,拖动开启等)
- 参数: [out] ec: 错误码
- 返回: 运行状态枚举类
posture()
std::array< double,6>rokae::BaseRobot::posture(CoordinateType ct, error_code & ec )
获取机器人法兰或末端的当前位姿
- 参数:
- [in] ct 坐标系类型
flangeInBase:法兰相对于基坐标系;endInRef:末端相对于外部参考坐标系。例如,当设置了手持工具及外部工件后,该坐标系类型 - 返回:的是工具相对于工件坐标系的坐标。
- [out] ec: 错误码
- [in] ct 坐标系类型
- 返回: double 数组,[X , Y , Z , Rx , Ry , Rz ],其中平移量单位为米旋转量单位为弧度
cartPosture()
CartesianPosition rokae::BaseRobot::cartPosture(CoordinateType ct, error_code & ec )
获取机器人法兰或末端的当前位姿
- 参数: :
- [in] ct 坐标系类型
- [out] ec: 错误码
- 返回:当前笛卡尔位置
jointPos() [1/2]
template<WorkType Wt, unsigned short DoF>
std::array< double, DoF > rokae::Robot_T< Wt, DoF >::jointPos ( error_code & ec )
机器人当前轴角度, 单位:rad
- 参数: [out] ec: 错误码
- 返回: 轴角度值
jointPos() [2/2]
std::vector<double> rokae::BaseRobot::jointPos (error_code & ec)
机器人当前轴角度, 机器人本体+外部轴。本体单位: rad。外部轴、导轨、附加轴单位: rad 或 m
- 参数: [out] ec: 错误码
- 返回: 关节角度值,和外部轴值
jointVel() [1/2]
template<WorkType Wt, unsigned short DoF>
std::array< double, DoF > rokae::Robot_T< Wt, DoF >::jointVel ( error_code & ec )
机器人当前关节速度,单位:弧度/秒
- 参数: [out] ec: 错误码
- 返回: 关节速度
jointVel() [2/2]
std::vector<double> rokae:: BaseRobot::jointVel(error_code & ec)
机器人当前关节速度, 机器人本体+外部轴。本体单位: rad/s。外部轴、导轨、附加轴单位: rad/s 或 m/s
- 参数: [out] ec: 错误码
- 返回: 关节速度
getStateList()
StateList rokae::BaseRobot::getStateList(error_code &ec)
查询当前位置, IO 信号, 操作模式, 速度覆盖值
- 参数: [out] ec: 错误码
- 返回: 查询结果
jointTorque()
template<WorkType Wt, unsigned short DoF>
std::array< double, DoF > rokae::Robot_T< Wt, DoF >::jointTorque ( error_code &ec )
关节力传感器数值,单位: Nm
- 参数: [out] ec: 错误码
- 返回: 力矩值
baseFrame()
std::array< double, 6 > rokae::BaseRobot::baseFrame ( error_code &ec ) const
用户定义的基坐标系, 相对于世界坐标系
- 参数: [out] ec: 错误码
- 返回: double 数组, [X, Y, Z, Rx, Ry, Rz],其中平移量单位为米旋转量单位为弧度
setBaseFrame()
void rokae::BaseRobot::setBaseFrame(const Frame &frame, error_code &ec)
设置基坐标系, 设置后仅保存数值,重启控制器后生效
- 参数:
- [in] frame 坐标系,默认使用自定义安装方式
- [out] ec: 错误码
toolset()
Toolset rokae:: BaseRobot::toolset (std::error_code & ec ) const
查询当前工具工件组信息
注解 此工具工件组仅为 SDK 运动控制使用, 不与 RL 工程相关
- 参数: [out] ec: 错误码
- 返回: 见 Toolset 数据结构
setToolset()
void rokae:: BaseRobot::setToolset ( const Toolset & toolset,error_code & ec )
设置工具工件组信息
注解 此工具工件组仅为SDK运动控制使用, 不与RL工程相关。设置后RobotAssist右上角会显示“toolx", "wobjx", 状态监控显示的末端坐标也会变化。除此接口外, 如果通过 RobotAssist 更改默认工具工件(右上角的选项), 该工具工件组也会相应更改.
- 参数:
- [in] toolset 工具工件组信息
- [out] ec: 错误码
setToolset()
void rokae:: BaseRobot::setToolset (const std::string &toolName, const std::string &wobjName,error_code &ec )
使用已创建的工具和工件,设置工具工件组信息
注解 设置前提: 已加载一个 RL 工程,且创建了工具和工件。否则,只能设置为默认的工具工件,即"tool0"和"wobj0"。一组工具工件无法同时为手持或外部;如果有冲突,以工具的位置为准,例如,工具工件同时为手持,不会返回错误,但是工件的坐标系变成了外部
- 参数:
- [in] toolName 工具名称
- [in] wobjName 工件名称
- [out] ec: 错误码
calcIk() [1/2]
template<unsigned short DoF>
JointArray rokae::Model_T< DoF >::calcIk (CartesianPosition posture,error_code &ec )
根据位姿计算逆解
- 参数:
- [in] posture 机器人末端位姿,相对于外部参考坐标系
- [out] ec: 错误码
- 返回: 轴角度, 单位:弧度
calcIk() [2/2]
template<unsigned short DoF>
JointArray rokae::Model_T< DoF >::calcIk (CartesianPosition posture, const Toolset & toolseterror_code &ec )
根据位姿计算给定工具工件坐标系下逆解
- 参数:
- [in] posture 机器人末端位姿,相对于外部参考坐标系
- [in] toolset 工具工件组信息
- [out] ec: 错误码
- 返回: 轴角度, 单位:弧度
calcFk()
template<unsigned short DoF>
CartesianPosition rokae::Model_T< DoF >::calcFk ( const JointArray & joints,error_code & ec )
根据轴角度计算正解
- 参数:
- [in] joints 轴角度, 单位: 弧度
- [out] ec: 错误码
- 返回: 机器人末端位姿,相对于外部参考坐标系
calcFk()
template<unsigned short DoF>
CartesianPosition rokae::Model_T< DoF >::calcFk ( const JointArray & joints, const Toolset & toolset error_code & ec )
根据轴角度计算给定工具工件坐标系下正解
- 参数:
- [in] joints 轴角度, 单位: 弧度
- [in] toolset 工具工件组信息
- [out] ec: 错误码
- 返回: 机器人末端位姿,相对于外部参考坐标系
calcAllIkSolutions()
std::vector<std::vector<double>> calcAllIkSolutions(const CartesianPosition &posture, std::vector<std::vector<int>> &confs, error_code &ec) noexcept;
计算笛卡尔位姿所有逆解结果,支持除xMateSR(XMS)之外的所有机型
-
参数
- [in] posture 笛卡尔位姿,法兰相对与基座标系。其它坐标系需自行转换。
- [out] confs 对应的confdata,错误码为0时有效
- [out] ec 错误码,含逆解计算失败错误:-50102奇异点 | -50114 超限位 | -50519 超范围 | -50002 其它逆解错误
-
返回:逆解结果,单位弧度,错误码为0时有效
setToolset()
void rokae:: BaseRobot::setToolset (const std::string &toolName, const std::string &wobjName,error_code &ec )
使用已创建的工具和工件,设置工具工件组信息
- 注解 设置前提:
- 使用 RL 工程中创建的工具工件: 需要先加载对应 RL 工程;
- 全局工具工件: 无需加载工程,直接调用即可。e.g.
setToolset("g_tool_0", "g_wobj_0")一组工具工件无法同时为手持或外部;如果有冲突,以工具的位置为准,例如工具工件同时为手持,不会返回错误,但是工件的坐标系变成了外部
- 参数:
- [in] toolName 工具名称
- [in] wobjName 工件名称
- [out] ec: 错误码
calibrateFrame ()
template<WorkType Wt, unsigned short DoF>
FrameCalibrationResult rokae::Robot_T< Wt, DoF >::calibrateFrame (
FrameType type,
const std::vector< std::array< double, DoF > > &points,
bool is_held,
error_code &ec,
const std::array< double, 3 > & base_aux = {} )
坐标系标定 (N 点标定)
- 注解 各坐标系类型支持的标定方法及注意事项:
- 工具坐标系: 三点/四点/六点标定法
- 工件坐标系: 三点标定。标定结果不会相对用户坐标系做变换,即,若为外部工件, - 返回:的结果是相对于基坐标系的。
- 基坐标系: 六点标定。标定前请确保动力学约束和前馈已关闭。 若标定成功(无错误码),控制器会自动保存标定结果,重启控制器后生效。
- 导轨基坐标系: 三点标定。若标定成功(无错误码),控制器会自动保存标定结果,重启控制器后生效。
- 参数:
- [in] type 坐标系类型,支持工具(FrameType::tool)、工件(FrameType::wobj)、基坐标系(FrameType::base)、导轨基坐标系(FrameType::rail)
- [in] points 轴角度列表,列表长度为 N。例如,使用三点法标定工具坐标系,应传入 3 组轴角度。轴角度的单位是弧度。
- [in] is_held true - 机器人手持 | false - 外部。仅影响工具/工件的标定
- [in] base_aux 基坐标系标定时用到的辅助点, 单位[米]
- [out] ec: 错误码
- 返回: 标定结果,当错误码没有被置位时,标定结果有效
clearServoAlarm()
void rokae::BaseRobot::clearServoAlarm ( error_code & ec)
清除伺服报警
- 参数:[out] ec: 错误码,当有伺服报警且清除失败的情况下错误码置为-1
enableCollisionDetection()
template<unsigned short DoF>
void Cobot<DoF>::enableCollisionDetection(const std::array<double, DoF> &sensitivity, StopLevel behaviour, double fallback_compliance, error_code &ec)
协作机型。设置碰撞检测相关参数, 打开碰撞检测功能
- 参数:
- [in] sensitivity 碰撞检测灵敏度,范围 0.01-2.0
- [in] behaviour 碰撞后机器人行为, 支持 stop1(安全停止, stop0 和 stop1 处理方式相同)和 stop2(触发暂停), suppleStop(柔顺停止)
- [in] fallback_compliance
- 碰撞后行为是安全停止或触发暂停时,该参数含义是碰撞后回退距离,单位: 米
- 碰撞后行为是柔顺停止时,该参数含义是柔顺度,范围 [0.0, 1.0]
- [out] ec: 错误码
enableCollisionDetection()(工业六轴 StandardRobot)
void StandardRobot::enableCollisionDetection(const std::array<double, 6> &sensitivity, double fallback, error_code &ec)
设置碰撞检测相关参数, 打开碰撞检测功能。工业机型只支持 stop1(安全停止),无 behaviour 参数。
- 参数:
- [in] sensitivity 碰撞检测灵敏度,范围 0.01-2.0
- [in] fallback 碰撞后回退距离,单位: 米
- [out] ec: 错误码
disableCollisionDetection()
void BaseCobot::disableCollisionDetection(error_code &ec)
void StandardRobot::disableCollisionDetection(error_code &ec)
关闭碰撞检测功能
- 参数: [out] ec: 错误码
getSoftLimit()
template<WorkType Wt, unsigned short DoF>
bool rokae::Robot_T< Wt, DoF >::getSoftLimit ( std::array< double[2], DoF > &limits,error_code &ec )
获取当前软限位数值
- 参数:
- [out] limits 各轴软限位 [下限, 上限],单位: 弧度
- [out] ec: 错误码
- 返回: true - 已打开 | false - 已关闭
setSoftLimit()
template<WorkType Wt, unsigned short DoF>
void rokae::Robot_T< Wt, DoF >::setSoftLimit ( bool enable,error_code &ec,const std::array< double[2], DoF > & limits = {{DBL_MAX, DBL_MAX}} )
设置软限位。软限位设定要求:
- 打开软限位时,机械臂应下电且处于手动模式;
- 软限位不能超过机械硬限位
- 机械臂当前各轴角度应在设定的限位范围内
- 参数:
- [in] enabletrue - 打开 | false - 关闭。
- [out] ec: 错误码
- [in] limits 各轴[下限, 上限],单位:弧度。
- 当 limits 为默认值时,视为仅打开软限位不修改数值; 不为默认值时,先修改软限位再打开
- 关闭软限位时不会修改限位数值
queryControllerLog()
std::vector< LogInfo > rokae::BaseRobot::queryControllerLog ( unsigned count,const std::set< LogInfo::Level > & level,error_code & ec,unsigned offset = 0 )
查询控制器最新的日志
- 参数:
- [in] count 查询个数,上限是 10 条
- [in] level 指定日志等级,空集合代表不指定
- [out] ec: 错误码
- [in] offset 偏移数, 比如0代表从最新的日志开始查询, 10代表从第11条开始查询
- 返回: 日志信息
recoverState()
void rokae::BaseRobot::recoverState(int item, error_code &ec)
根据选项恢复机器人状态
- 参数:
- [in] item 恢复选项,1:急停恢复
- [out] ec: 错误码
setRailParameter()
template<typename R>
void rokae::setRailParameter(const std::string &name, R value, error_code &ec)
设置导轨参数
- 模板参数: 参数类型
- 参数:
- [in] name: 参数名,见 value 说明
- [in] value:
参数: 参数名 数据类型 开关 enable bool 基坐标系 baseFrame Frame 导轨名称 name std::string 编码器分辨率 encoderResolution int 减速比 reductionRatio double 电机最大转速(rpm) motorSpeed int 软限位(m), [下限,上限] softLimit std::vector<double>运动范围(m), [下限,上限] range std::vector<double>最大速度(m/s) maxSpeed double 最大加速度(m/s^2) maxAcc double 最大加加速度(m/s^3) maxJerk double
getMechUnit()
template<typename R>
void getMechUnit(const std::string &name, const std::string& info, R &value, error_code &ec) noexcept;
读取机械单元参数
- 模板参数: 参数类型
- 参数:
- [in] name 参数名,u1~u6
- [in] info 参数名,见value说明
- [in]value
- 参数 | 参数名 | 数据类型
- 机械单元是否激活 | activation | bool
- 轴名称,顺序与设置顺序相同 | axes_info | string数组
- 机械单元是否启用 | enable | bool
- 机械单元固定名称 | fixed_name | string
- 机械单元类型 | mech_link_type | int
- 自定义的机械单元名 | unit_name | string
- 机械单元类型:0:基座轴 1:变位机 2:伺服焊枪 3:法兰附加轴
- [out] ec: 错误码,参数名不存在或数据类型不匹配返回错误码
getExtAxisInfo()
template<typename R>
void getExtAxisInfo(const std::string &name, const std::string& info, R &value, error_code &ec)
读取附加轴信息
-
模板参数: 参数类型
-
参数:
-
[in] name 参数名,axis1~axis6
-
[in] info 参数名,见value说明
-
[in]value
- 参数 | 参数名 | 数据类型
- 点位中第几个数据映射 | ext_data_number | int
- 连接的第几个驱动器 | ext_axis_number | int
- 是否是伺服焊枪 | is_servo_gun | bool
- 最大加速度 | max_acc | double
- 最大加加速度 | max_jerk | double
- 最大速度 | max_speed | double
- 软限位下限 | soft_limit_lower | double
- 软限位上限 | soft_limit_upper | double
- 零点值 | zero_value | int
- 电机过载系数 | motor_overload_coefficient | int
- 电机转矩限幅 | motor_torque_limiting | double
- 减速比 | reduction_ratio | double
- 电机额定转矩 | rated_torque_of_motor | double
- 分辨率 | resolution_ratio | int
- 关节方向 | joint_orient | bool(true为正)
- 是否坐标系标定 | coordinate_calibrated |bool
- 驱动器别名/固定名 | driver_name | std::string
[out] ec 错误码 参数名不存在或数据类型不匹配返回错误码
-
getRailParameter()
template<typename R>
void rokae::getRailParameter (const std::string &name, R &value, error_code &ec)
读取导轨参数
- 模板参数: 参数类型
- 参数:
- [in] name 参数名,见 setRailParameter()
- [out] value 参数数值,见 setRailParameter()
- [out] ec: 错误码,参数名不存在或数据类型不匹配返回错误码
configNtp()
void rokae::BaseRobot::configNtp(const std::string &server_ip, error_code &ec)
配置 NTP。非标配功能,需要额外安装
- 参数:
- [in] server_ip NTP 服务端 IP
- [out] ec: 错误码, NTP 未正确安装,或 IP 地址格式错误
syncTimeWithServer()
void rokae::BaseRobot::syncTimeWithServer(error_code &ec)
手动同步一次时间,远端 IP 是通过 configNtp 配置的。耗时几秒钟,阻塞等待同步完成,接口预设的超时时间是 12 秒
- 参数: [out] ec: 错误码。NTP 服务未正确安装,或无法和服务端同步
setRobotCfg_DHparam()
void setRobotCfg_DHparam(const std::vector<double> ¶m_all,
const std::vector<double> ¶m_link,
error_code &ec) noexcept
设置 DH 参数。param_all 和 param_link 都非空时同时写入;否则根据精度补偿开关写入对应字段。
- 参数:
- [in] param_all: 精度补偿开对应的 DH 参数,顺序:各轴 Alpha[°], A[mm], D[mm], Theta[°]
- [in] param_link: 精度补偿关对应的 DH 参数
- [out] ec: 错误码。参数超出范围时可能返回
-10152(set_dh_failed)
setRobotCfg_CalibrateZero()
void setRobotCfg_CalibrateZero(const std::vector<double> &calibrate_angle_all,
const std::vector<double> &calibrate_angle_link,
error_code &ec) noexcept
设置机器人零点。精度补偿打开时只设置 calibrate_angle_all,关闭时都设置。面向视觉标定场景,与 DH 写入配套使用。
- 参数:
- [in] calibrate_angle_all: 精度补偿开对应的编码器数值
- [in] calibrate_angle_link: 精度补偿关对应的编码器数值
- [out] ec: 错误码
sdkVersion()
static std::string rokae::BaseRobot::sdkVersion ( )
查询 xCore-SDK 版本
- 返回: 版本号
2 运动控制(非实时模式)
setMotionControlMode()
void rokae::BaseRobot::setMotionControlMode ( MotionControlMode mode, error_code & ec )
设置运动控制模式
- 注: 在调用各运动控制接口之前, 须设置对应的控制模式。
- 参数:
- [in] mode: 模式
- [out] ec: 错误码
moveReset()
void rokae::BaseRobot::moveReset (error_code &ec )
运动重置, 清空已发送的运动指令, 清除执行信息
- 注解: Robot 类在初始化时会调用一次运动重置。RL 程序和 SDK 运动指令切换控制,需要先运动重置。
- 参数: [out] ec 错误码
stop()
void rokae::BaseRobot::stop ( error_code & ec)
暂停机器人运动; 暂停后可调用 moveStart()继续运动。若需要完全停止,不再执行已添加的指令,可调用moveReset()
- 注解: 目前支持 stop2 停止类型, 规划停止不断电, 参见 StopLevel。 调用此接口后, 暂停后可调用
moveStart()继续运动。若需要完全停止,不再执行已添加的指令,可调用moveReset() - 参数: [out] ec: 错误码
moveStart()
void rokae::BaseRobot::moveStart( error_code &ec )
开始/继续运动
- 参数: [out] ec: 错误码
moveAppend() [1/3]
template<class Command >
void rokae::BaseRobot::moveAppend (const std::vector<Command> &cmds, std::string &cmdID,error_code &ec )
添加单条或多条运动指令, 添加后调用 moveStart()开始运动
- 模板参数: Command 运动指令类: MoveJCommand | MoveAbsJCommand | MoveLCommand | MoveCCommand | MoveCFCommand | MoveSPCommand
- 参数
- [in] cmds 指令列表, 允许的个数为 1-100, 须为同类型的指令
- [out] cmdID 本条指令的 ID, 可用于查询指令执行信息
- [out] ec 错误码, 仅反馈指令发送前的错误, 包括: 1) 网络连接问题; 2) 指令个数不符;
moveAppend() [2/3]
template<class Command >
void rokae::BaseRobot::moveAppend (std::initializer_list< Command > cmds, std::string &cmdID,error_code &ec )
添加单条或多条运动指令, 添加后调用 moveStart()开始运动
- 模板参数 Command 运动指令类: MoveJCommand | MoveAbsJCommand | MoveLCommand | MoveCCommand | MoveCFCommand | MoveSPCommand
- 参数:
- [in] cmds 指令列表, 允许的个数为 1-100, 须为同类型的指令
- [out] cmdID 本条指令的 ID, 可用于查询指令执行信息
- [out] ec 错误码, 仅反馈指令发送前的错误, 包括: 1) 网络连接问题; 2) 指令个数不符;
moveAppend() [3/3]
template<class Command >
void rokae::BaseRobot::moveAppend(const Command &cmds, std::string &cmdID, error_code &ec )
添加单条运动指令, 添加后调用 moveStart()开始运动
- 模板参数: Command 运动指令类: MoveJCommand | MoveAbsJCommand | MoveLCommand | MoveCCommand | MoveCFCommand | MoveSPCommand | MoveWaitCommand
- 参数:
- [in] cmds 指令
- [out] cmdID 本条指令的 ID, 可用于查询指令执行信息
- [out] ec 错误码, 仅反馈指令发送前的错误, 包括: 1) 网络连接问题; 2) 指令个数不符;
executeCommand() [1/2]
template<class Command >
void rokae::BaseRobot::executeCommand( std::initializer_list< Command > cmds,error_code & ec )
执行单条或多条运动指令,调用后机器人立刻开始运动
- 模板参数: Command 运动指令类: MoveJCommand | MoveAbsJCommand | MoveLCommand | MoveCCommand | MoveCFCommand | MoveSPCommand;
- 参数:
- [in] cmds 指令列表, 允许的个数为 1-1000
- [out] ec 错误码, 仅反馈执行前的错误, 包括: 1) 网络连接问题; 2) 指令个数不符; 3) 机器人当前状态下无法运动,例如没有上电
executeCommand() [2/2]
template<class Command >
void rokae::BaseRobot::executeCommand( std::vector< Command > cmds,error_code & ec )
执行单条或多条运动指令,调用后机器人立刻开始运动
- 模板参数: Command 运动指令类: MoveJCommand | MoveAbsJCommand | MoveLCommand | MoveCCommand | MoveCFCommand | MoveSPCommand;
- 参数:
- [in] cmds 指令列表, 允许的个数为 1-1000
- [out] ec 错误码, 仅反馈执行前的错误, 包括: 1) 网络连接问题; 2) 指令个数不符; 3) 机器人当前状态下无法运动,例如没有上电
setDefaultSpeed()
void rokae::BaseRobot::setDefaultSpeed ( int speed, error_code &ec )
设定默认运动速度,初始值为 100
- 注解: 该数值表示末端最大线速度(单位 mm/s), 自动计算对应关节速度
- 参数:
- [in] speed 该接口不对参数进行范围限制。末端线速度的实际有效范围分别是 5-4000(协作), 5-7000(工业)。 关节速度百分比划分为 5 个的范围:
- < 100 : 10% ;
- 100 ~ 200 : 30% ;
- 200 ~ 500 : 50% ;
- 500 ~ 800 : 80% ;
-
800 : 100%
- [out] ec 错误码
- [in] speed 该接口不对参数进行范围限制。末端线速度的实际有效范围分别是 5-4000(协作), 5-7000(工业)。 关节速度百分比划分为 5 个的范围:
setDefaultZone()
void rokae::BaseRobot::setDefaultZone (double zone, error_code & ec )
设定默认转弯区
- 注解: 该数值表示运动最大转弯区半径(单位:mm), 自动计算转弯百分比. 若不设置, 则为 0 (fine, 无转弯区)
- 参数:
- [in] zone: 该接口不对参数进行范围限制。转弯区半径大小实际有效范围是 0-200。 转弯百分比划分 4 个范围:
- < 1 : 0 (fine) ;
- 1 ~ 20 : 10% ;
- 20 ~ 60 : 30% ;
- 60 : 100%
- [out] ec: 错误码
- [in] zone: 该接口不对参数进行范围限制。转弯区半径大小实际有效范围是 0-200。 转弯百分比划分 4 个范围:
setDefaultConfOpt()
void rokae::BaseRobot::setDefaultConfOpt(bool forced, error_code &ec)
设置是否使用轴配置数据(confData)计算逆解。初始值为 false
- 参数:
- [in] forcedtrue -使用运动指令的 confData 计算笛卡尔点位逆解, 如计算失败则返回错误; false - 不使用,逆解时会选取机械臂当前轴角度的最近解
- [out] ec 错误码
setAutoIgnoreZone()
void rokae::BaseRobot::setAutoIgnoreZone(bool enable, error_code &ec)
设置运动指令是否使自动取消转弯区。初始值为true
- 参数:
- [in] enable true - 自动取消转弯区 | false - 不会自动取消转弯区
- [out] ec 错误码
setMaxCacheSize()
void rokae::BaseRobot::setMaxCacheSize(int number, error_code &ec)
设置最大缓存指令个数,指发送到控制器待规划的路径点个数,允许的范围[1,1000],初始值为 300。
-
注解: 如果轨迹多为短轨迹,可以调大这个数值,避免因指令发送不及时导致机器人停止运动(停止后如果有未执行的指令,可
moveStart()继续; -
参数:
- [in] number: 个数
- [out] ec 错误码
adjustSpeedOnline()
void rokae::BaseRobot::adjustSpeedOnline(double scale, error_code &ec)
动态调整机器人运动速率,非实时模式时生效。
- 参数:
- [in] scale: 运动指令的速度的比例,范围 0.01 - 1。当设置 scale 为 1 时,机器人将以路径原本速度运动。
- [out] ec: 错误码
getAcceleration()
void rokae::BaseRobot::getAcceleration(double &acc, double &jerk, error_code &ec)
读取当前加/减速度和加加速度
- 参数:
- [out] acc: 系统预设加速度的百分比
- [out] jerk: 系统预设的加加速度的百分比
- [out] ec: 错误码
adjustAcceleration()
void rokae::BaseRobot::adjustAcceleration(double acc, double jerk, error_code &ec)
调节运动加/减速度和加加速度。如果在机器人运动中调用,当前正在执行的指令不生效,下一条指令生效
- 参数:
- [in] acc: 系统预设加速度的百分比,范围[0.2, 1.5], 超出范围不会报错,自动改为上限或下限值
- [in] jerk: 系统预设的加加速度的百分比,范围[0.1, 2], 超出范围不会报错,自动改为上限或下限值
- [out] ec: 错误码
setEventWatcher()
void rokae::BaseRobot::setEventWatcher(Event eventType, const EventCallback &callback, error_code &ec)
设置接收事件的回调函数
- 参数:
- [in] eventType: 事件类型
- [in] callback: 处理事件的回调函数。说明:
- 对于Event::moveExecution, 回调函数在同一个线程执行, 请避免函数中有执行时间较长的操作;
- Event::safety 则每次独立线程回调, 没有执行时间的限制
- [out] ec: 错误码
queryEventInfo()
EventInfo rokae::BaseRobot::queryEventInfo(Event eventType, error_code &ec)
查询事件信息。与 setEventWatcher()回调时的提供的信息相同,区别是这个接口是主动查询的方式
- 参数:
- [in] eventType: 事件类型
- [out] ec: 错误码
- 返回: 事件信息
startJog()
void rokae::BaseRobot::startJog ( JogOpt::Space space,
double rate,
double step,
unsigned index,
bool direction,
error_code &ec )
开始 jog 机器人,需要切换到手动操作模式。
- 注解: 调用此接口并且机器人开始运动后,无论机器人是否已经自行停止,都必须调用
stop()来结束 jog 操作,否则机器人会一直处于 jog 的运行状态。 - 参数:
- [in] space jog 参考坐标系。
- 工具/工件坐标系使用原则同
setToolset(); - 工业六轴机型和 xMateCR/SR 六 轴 机 型 支 持 两 种 奇 异 规 避 方 式
Jog:Space::singularityAvoidMode, Space::baseParallelMode - CR5 轴机型支持平行基座模式
Jog:Space::baseParallelMode
- 工具/工件坐标系使用原则同
- [in] rate: 速率, 范围 0.01 - 1
- [in] step: 步长。单位: 笛卡尔空间-毫米 | 轴空间-度。步长大于 0 即可,不设置上限, 如果机器人机器人无法继续 jog 会自行停止运动。
- [in] index 根据不同的 space,该参数含义如下:
- 世界坐标系,基坐标系,法兰坐标系,工具工件坐标系: a) 6 轴机型: 0~5 分别对应 X, Y, Z, Rx, Ry, Rz。>5 代表外部轴(若有) b) 7 轴机型 6 代表肘关节, >6 代表外部轴(若有)
- 轴空间: 关节序号,从 0 开始计数
- 奇异规避模式,平行基座模式:
a) 6 轴机型:0
5 分别对应 X, Y, Z, J4(4 轴), Ry, J6(6 轴); b) 5 轴机型:04 分别对应 X, Y, Z, Ry, J5(5 轴)
- [in] direction 根据不同的 space 和 index,该参数含义如下:
- 奇异规避模式 J4: true - ±180° | false - 0°;
- 平行基座模式 J4 & Ry: true - ±180° | false - 0°
- 其它,true - 正向 | false - 负向
- [out] ec 错误码
- [in] space jog 参考坐标系。
startJogWithExt()
void startJogWithExt(JogOpt::Space space, double rate,double step, unsigned int index, bool direction, std::string fixed_name, error_code& ec, bool is_ext = true)
开始 jog 机器人+外部轴,需要切换到手动操作模式。
-
注解: 调用此接口并且机器人开始运动后,无论机器人是否已经自行停止,都必须调用
stop()来结束 jog 操作,否则机器人会一直处于 jog 的运行状态。 -
参数:
-
[in] space jog 参考坐标系。
- 工具/工件坐标系使用原则同
setToolset(); - 工业六轴机型和 xMateCR/SR 六 轴 机 型 支 持 两 种 奇 异 规 避 方 式
Jog:Space::singularityAvoidMode, Space::baseParallelMode - CR5 轴机型支持平行基座模式
Jog:Space::baseParallelMode
- 工具/工件坐标系使用原则同
-
[in] rate: 速率, 范围 0.01 - 1
-
[in] step: 步长。单位: 笛卡尔空间-毫米 | 轴空间-度。步长大于 0 即可,不设置上限, 如果机器人机器人无法继续 jog 会自行停止运动。
-
[in] index 根据不同的 space,该参数含义如下:
- 世界坐标系,基坐标系,法兰坐标系,工具工件坐标系: a) 6 轴机型: 0~5 分别对应 X, Y, Z, Rx, Ry, Rz。>5 代表外部轴(若有) b) 7 轴机型 6 代表肘关节, >6 代表外部轴(若有)
- 轴空间: 关节序号,从 0 开始计数
- 奇异规避模式,平行基座模式:
a) 6 轴机型:0
5 分别对应 X, Y, Z, J4(4 轴), Ry, J6(6 轴); b) 5 轴机型:04 分别对应 X, Y, Z, Ry, J5(5 轴)
-
[in] direction 根据不同的 space 和 index,该参数含义如下:
- 奇异规避模式 J4: true - ±180° | false - 0°;
- 平行基座模式 J4 & Ry: true - ±180° | false - 0°
- 其它,true - 正向 | false - 负向
-
fixed_name fixed_name与index配合使用,fixed_name传入任意字符,is_ext为false,index为0,则jog机器人第一个轴
fixed_name传入u1,index为0,则jog机械单元u1的第一个轴
-
is_ext:是否为移动外部轴
-
[out] ec 错误码
-
setAvoidSingularity()
void rokae::xMateRobot::setAvoidSingularity (AvoidSingularityMethod method, bool enable, double limit, error_code &ec)
void rokae::StandardRobot::setAvoidSingularity (AvoidSingularityMethod method, bool enable, double threshold, error_code &ec)
打开/关闭奇异点规避功能。只适用于部分机型:
- 四轴锁定: 支持工业六轴,xMateCR 和 xMateSR 六轴机型;
- 牺牲姿态: 支持所有六轴机型;
- 轴空间插补: 支持工业六轴机型
工业六轴(StandardRobot)三种方式均支持;协作与工业头文件中该阈值参数名分别为 limit / threshold,含义相同。
- 参数:
- [in] method: 奇异规避方式
- [in] enable: true - 打开功能 | false - 关闭。对于四轴锁定方式, 打开之前要确保 4 轴处于零位。
- [in] limit / threshold: 不同的规避方式,该参数含义分别为:
- 牺牲姿态: 允许的姿态误差, 范围 (0, PI*2], 单位弧度
- 轴空间插补: 规避半径, 范围[0.005, 10], 单位米
- 四轴锁定: 无参数
- [out] ec: 错误码
getAvoidSingularity()
bool rokae::xMateRobot::getAvoidSingularity (AvoidSingularityMethod method, error_code &ec)
bool rokae::StandardRobot::getAvoidSingularity (AvoidSingularityMethod method, error_code &ec)
查询是否处于规避奇异点的状态
- 参数:
- [in] method: 奇异规避的方式
- [out] ec: 错误码
- 返回: true - 已打开 | false – 已关闭
enableCompletePostureLerp()
void rokae::xMateCr5Robot::enableCompletePostureLerp(bool enable, error_code &ec)
是否使能平行基座模式(xMateCr5Robot 专用)。
- 参数:
- [in] enable: true - 开启 | false - 关闭
- [out] ec: 错误码
checkPath() [1/3]
std::vector<double> rokae::BaseRobot::checkPath(const CartesianPosition &start,
const std::vector<double> &start_joint, const CartesianPosition &target, error_code &ec)
检验笛卡尔轨迹是否可达,直线轨迹。支持导轨,返回的目标轴角为轴数+外部轴数
- 参数:
- [in] start: 起始点
- [in] start_joint: 起始轴角 [弧度]
- [in] target: 目标点
- [out] ec: 错误码
- 返回: 计算出的目标轴角,仅当无错误码时有效
checkPath() [2/3]
int rokae::BaseRobot::checkPath(const std::vector<double> &start_joint,
const std::vector<CartesianPosition> &points,
std::vector<double> &target_joint_calculated,
error_code &ec)
校验多个直线轨迹
- 参数:
- [in] start_joint: 起始轴角,单位[弧度]
- [in] points: 笛卡尔点位,至少需要 2 个点,第一个点是起始点
- [out] target_joint_calculated: 若校验通过。返回计算出的目标轴角
- [out] ec: 校验失败的原因
- 返回: 若校验失败,返回 points 中出错目标点的下标。其它情况返回 0
checkPath() [3/3]
std::vector<double> rokae::BaseRobot::checkPath(const CartesianPosition &start,
const std::vector<double> &start_joint,
const CartesianPosition &aux,
const CartesianPosition &target,
error_code &ec, double angle =0.0,
MoveCFCommand::RotType rot_type = MoveCFCommand::constPose)
检验笛卡尔轨迹是否可达,包括圆弧,全圆。支持导轨,返回的目标轴角为轴数+外部轴数
- 参数:
- [in] start: 起始点
- [in] start_joint: 起始轴角 [弧度]
- [in] aux: 辅助点
- [in] target: 目标点
- [out] ec: 错误码
- [in] angle: 全圆执行角度,不等于零时代表校验全圆轨迹
- [in] rot_type: 全圆旋转类型
- 返回: 计算出的目标轴角,仅当无错误码时有效
setTeachPendantMode()
void setTeachPendantMode(bool enable, error_code& ec)
示教器热插拔。注:仅部分机型支持示教器热插拔,不支持的机型会返回错误码。不使用示教器后,使能按键和急停按键将失效
- 参数:
- [in] enable true - 使用示教器 | false - 不使用示教
- [out] ec: 错误码
3 实时运动控制
getRtMotionController()
template <unsigned short DoF>
std::weak_ptr<RtMotionControlCobot<DoF>> Cobot<DoF>::getRtMotionController ()
std::weak_ptr<RtMotionControlIndustrial<6>> StandardRobot::getRtMotionController()
创建实时运动控制类实例,通过此实例指针进行实时模式相关的操作。
-
注解: 除非重复调用此接口,客户端内部逻辑不会主动析构返回的对象,包括但不限于断开和机器人连 接
disconnectFromRobot(),切换到非实时运动控制模式等,但做上述操作之后再进行实时模式控制会产生异常。 -
返回: 控制器对象
-
异常:
RealtimeControlException: 创建RtMotionControl实例失败,由于网络问题- ExecutionException 没有切换到实时运动控制模式
reconnectNetwork()
void rokae::MotionControl< MotionControlMode::RtCommand >::reconnectNetwork ( error_code & ec )
重新连接到实时控制服务器
- 参数: [out] ec: 错误码
disconnectNetwork()
void rokae::MotionControl< MotionControlMode::RtCommand >::disconnectNetwork ()
断开与实时控制服务器的连接,关闭数据接收和命令发送端口。但不会断开和机器人的连接。若机器人在运动,断开后立即停止运动。
setControlLoop()
template<class Command>
void rokae::MotionControl< MotionControlMode::RtCommand >::setControlLoop (const std::function<Command(void)>& callback, int priority = 0, bool useStateDataInLoop = false )
使用周期调度,设置回调函数。
- 注解:
- 回调函数应按照 1 毫秒为周期规划运动命令,规划结果为函数的返回值。SDK 对返回值进行滤波处理后发送给控制器。
JointPosition的关节角度数组长度,和Torque的关节力矩值数组长度应和机器人轴数相同。若不同不会报错,但有可能造成不合理的命令- 一次运动循环结束时,可以通过返回的
Command.setFinish()的方式来标识,SDK 内部会负责停止运动以及停止调用回调函数
- 模板参数: JointPosition | CartesianPosition | Torque
- 参数:
- [in] callback: 回调函数。根据控制模式(RtControllerMode)不同,函数返回值有 3 种: 关节角度/笛卡尔位姿/力矩。其中笛卡尔位姿使用旋转矩阵表示旋转量,pos 为末端相对于基坐标系的位姿。
- [in] priority: 任务优先级, 0 为不指定。此参数仅当使用实时操作系统时生效,若无法设置会打印控制台错误信息。
- [in] useStateDataInLoop: 是否需要在周期内读取状态数据。当设置为 true 时:
- xCore-SDK 会在回调函数之前更新实时状态数据
updateStateData(),在回调函数内直接getStateData()即可; - 状态数据的发送周期应和控制周期一致, 为 1ms:
startReceiveRobotState(interval = milliseconds(1));
- xCore-SDK 会在回调函数之前更新实时状态数据
startLoop()
void rokae::MotionControl< MotionControlMode::RtCommand >::startLoop (bool blocking = true )
开始周期性执行调度任务。
-
参数: [in] blocking: 是否阻塞调用此函数的线程。若为非阻塞线程,需调用 stopLoop()停止调度任务,否则无法开始下一次循环周期。
-
异常:
RealtimeControlException: 命令发送网络异常; 或命令类型与控制模式不匹配; 或控制器执行已发送命令时发生错误
stopLoop()
void rokae::MotionControl< MotionControlMode::RtCommand >::stopLoop ()
停止执行周期性调度任务。
- 异常:
RealtimeControlException: 执行过程中发生异常
startMove()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::startMove ( RtControllerMode rtMode )
指定控制模式,机器人准备开始运动,在每段回调执行前需要先调用此接口。 调用此接口机器人不会立即开始运动, 而是有运动命令发送后才会开始。
- 注解:
- 在 startMove 之前应将参数依次设置好,例如滤波阻抗参数等等,设置完成后再调用
startMove()。 在调用 startMove 后执行其他指令可能会失败,例如下电等操作。正确停止方法是调用 stopMove; - 如果没有通过
startReceiveRobotState()设置要接收的状态数据, 调用此函数时会自动设置
- 在 startMove 之前应将参数依次设置好,例如滤波阻抗参数等等,设置完成后再调用
- 参数: [in] rtMode: 控制模式
- 异常:
RealtimeStateException: 已经开始运动运动后重复调用RealtimeParameterException: 指定了不支持的控制模式RealtimeControlException: 控制器无法切换到该控制模式,多出现于切换到力控模式时
stopMove()
void rokae::MotionControl< MotionControlMode::RtCommand >::stopMove ()
机器人停止运动,停止接收客户端发送的运动指令。
- 注解: 另外,JointPosition/CartesianPosition/Torque 指令可通过
setFinished()标识一次运动循环结束,标识后会机器人停止运动, 呈现的效果和调用stopMove()一样。 此函数仅用于实时控制,不可以用于停止非实时运动指令。
sendCommand()
template<class Command>
void sendCommand(const Command &cmd);
发送JointPosition/CartesianPosition/Torque命令。适用于不使用调度周期,程序直接发送命令
-
注解:
- 开始运动后,持续调用此函数发送运动命令。由于控制器执行命令的周期为1ms,发送命令的间隔也需要控制在1ms
- 如果发送间隔过长会判断为通信丢包,间隔过短会造成伺服报错。
- 如果发送间隔过长会判断为通信丢包,间隔过短会造成伺服报错。
- 直接发送命令的话就不需要用调度周期了,setControlLoop(), startLoop(), stopLoop()等相关函数都不需要
-
-
参数
- [in] cmd 根据控制模式(RtControllerMode)不同,有3种运动命令: 关节角度/笛卡尔位姿/力矩
-
异常
- ArgumentException 指令数值存在非法值
- RealtimeStateException 未开始运动 RealtimeControlException 命令发送网络异常; 或命令类型与控制模式不匹配; 或控制器执行已发送命令时发生错误
startReceiveRobotState()
template<WorkType Wt, unsigned short DoF>
void rokae::Robot_T::startReceiveRobotState (std::chrono::steady_clock::duration interval, const std::vector<std::string>& fields)
让机器人开始发送实时状态数据。阻塞等待收到第一帧消息,超时时间为 3 秒
- 参数:
- [in] interval: 控制器发送状态数据的间隔,允许的时长:1ms/2ms/4ms/8ms/1s
- [in] fields 接收的机器人状态数据, 最大总长度为 1024个字节。支持的数据及名称见
data_types.h,RtSupportedFields
- 异常:
RealtimeControlException: 设置了不支持的状态数据;或机器人无法开始发送数据;或总长度超过 1024RealtimeStateException已经开始发送数据;或超时后仍未收到第一帧数据
stopReceiveRobotState()
void rokae::BaseRobot::stopReceiveRobotState ()
停止接收实时状态数据,同时控制器停止发送。可用于重新设置要接收的状态数据。
updateRobotState()
unsigned rokae::BaseRobot::updateRobotState(std::chrono::steady_clock::duration timeout)
接收一次机器人状态数据。在每周期读取数据前,需调用此函数;建议按照设定的发送频率来调用,以获取最新 的数据
- 参数: [in] timeout: 超时时间
- 返回: 接收到的数据长度。如果超时前没有收到数据,那么返回 0。
- 异常:
RealtimeControlException: 无法收到数据;或收到的数据有错误导致无法解析RealtimeMotionException实时模式运动报错
getStateData()
template<typename R >
int rokae::BaseRobot::::getStateData ( const std::string &fieldName,R & data )
读取机器人状态数据
- 注解: 注意传入的 data 类型要和数据类型一致。
- 模板参数: R 数据类型
- 参数:
- [in] fieldName: 数据名
- [out] data: 数值
- 返回: 若无该数据名;或未通过
startReceiveRobotState()设置为要接收的数据;或该数据类型和 R 不符,返回-1。 成功读取返回 0。 - 异常:
RealtimeStateException: 网络错误
setServoJoint()
void setServoJoint(double ServoJ_T, double ServoJ_Lookahead, double ServoJ_Kp, error_code &ec) noexcept;
通过实时模式sendCommand下发关节位置,开放调用周期(仅适用于大于实时模式0.001s的周期)、增益和前瞻时间的设置,且开启servoJ功能。常用值:setServoJoint(0.02, 0.02, 0, ec);
- 参数:
- [in] ServoJ_T:用户下发周期。
- 类型:
double,单位[s] - 范围:
(0.001, 0.1],典型值0.008~0.033 - 含义:用户打算以多大的周期调用一次
sendCommand - 建议:
- 实时性要求高:
0.008~0.012s - 通用场景:
0.020~0.033s - 周期越小,延迟越低,但对上位机算力要求越高
- 实时性要求高:
- 类型:
- [in] ServoJ_Lookahead:计算速度的前瞻时间。
- 类型:
double,单位[s] - 范围:
(0.001, 0.3] - 含义:
- 设为
0:控制器使用相邻指令之间的实际时间间隔来计算速度前馈,适合周期稳定的场景。 - 设为非零值
T:控制器统一用T替代实际间隔来计算速度,相当于假设每帧间距都是T,可平滑偶发抖动。
- 设为
- 建议:
- 上位机调度稳定(RT Linux / 专用硬件):设为
0,真实跟踪 - Windows 等非实时系统:设为
ServoJ_T(等于下发周期),或ServoJ_T * 2~ServoJ_T * 3
- 上位机调度稳定(RT Linux / 专用硬件):设为
- 类型:
- [in] ServoJ_Kp:位置反馈补偿增益。
- 类型:
double,无单位 - 范围:
[0, +∞),典型值0~5 - 含义:
ServoJ_Kp = 0:纯前馈,完全依赖速度插补,适合轨迹精度要求不高但运动流畅的场景。ServoJ_Kp > 0:叠加位置误差反馈,公式为vel += kp * (target_last - current),可修正累积误差。
- 建议:默认从
1开始,若出现抖动可降低;若位置跟随误差大可适当增大。
- 类型:
- [out] ec:错误码
- [in] ServoJ_T:用户下发周期。
- 返回: 无
- 说明(Servo 系列指令适用场景):
- ServoJ 适合:
- 视觉引导抓取:图像处理实时给出关节角目标,机器人跟随
- 示教再现:回放录制的关节角度序列
- 人机协作拖动:力/力矩传感器输出速度,积分为关节角后下发
- 外部运动规划器对接:ROS MoveIt 等第三方规划器实时输出关节轨迹
- 自定义多项式/样条轨迹执行:需要精确控制关节轨迹形状
- ServoL 适合(4.0版本):
- 笛卡尔直线/圆弧作业:焊接、涂胶、打磨等需要保持 TCP 直线运动的场景
- 末端力控引导:力传感器输出笛卡尔方向速度,积分后作为笛卡尔位置目标下发
- 键盘/手柄遥操作:操作者直接控制 TCP 的 XYZ 方向移动
- 物体跟随:3D 视觉输出工件 6D 位姿,机器人末端实时对准
- 不适合 Servo 的场景:
- 大范围、高速度的点到点搬运(用 MoveJ/L)
- 对轨迹平滑性无能力自行保障的场合(建议使用 SDK 内置规划接口)
- 上位机非实时系统但对延迟有极高要求的场合
- ServoJ 适合:
stopServoJoint()
void stopServoJoint() noexcept;
关闭servoJ功能,停止使用setServoJoint需要进行关闭
hasMotionError()
bool hasMotionError() noexcept;
实时模式运动是否发生了运动错误
- 返回: true - 有报错。
MoveJ()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::MoveJ( double speed,
const std::array< double, DoF > & start,
const std::array< double, DoF > & target )
MoveJ 指令,上位机规划路径,在到达 target 之前处于处于阻塞状态。如果运动中发生错误将停止阻塞状态并返回。
-
说明
-
已不建议使用,请使用非实时模式指令MoveAbsJCommand。
-
参数:
- [in] speed: 速度比例系数
- [in] start: 起始关节角度,需要是机器人当前关节角度,否则可能造成下电。
- [in] target: 机器人目标关节角度
-
异常:
RealtimeMotionException: 机器人运动过程中发生错误
moveL()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::MoveL ( double speed,
CartesianPosition & start,
CartesianPosition & target )
MoveL 指令,上位机规划路径,在到达 target 之前处于处于阻塞状态。如果运动中发生错误将停止阻塞状态并返回。
-
说明
-
已不建议使用,请使用非实时模式指令MoveLCommand。
-
参数:
- [in] speed: 速度比例系数, 范围 0 - 1
- [in] start: 起始位姿, 需要是机器人当前位姿,否则可能造成下电。如果设置了 TCP,那么应该是工具相对于基坐标系的位姿。
- [in] target: 机器人目标位姿。同理如果设置了 TCP,应是 TCP 相对于基坐标系的位姿
-
异常:
RealtimeParameterException: 起始或目标位姿参数错误RealtimeMotionException: 机器人运动过程中发生错误
MoveC()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::MoveC ( double speed,
CartesianPosition & start,
CartesianPosition & aux,
CartesianPosition & target )
MoveC 指令,在到达 target 之前处于阻塞状态。如果运动中发生错误将停止阻塞状态并返回。
-
说明
-
已不建议使用,请使用非实时模式指令MoveCCommand。
-
参数:
- [in] speed: 速度比例系数
- [in] start 机器人起始位姿, 需要是机器人当前位姿。如果设置了 TCP,那么应该是工具相对于基坐标系的位姿。
- [in] aux: 机器人辅助点位姿。同理如果设置了 TCP,应是 TCP 相对于基坐标系的位姿
- [in] target: 机器人目标位姿。同理如果设置了 TCP,应是 TCP 相对于基坐标系的位姿
-
异常:
RealtimeParameterException: 点位错误, 无法计算出圆弧路径RealtimeMotionException: 机器人运动过程中发生错误
getRobotCfg_DHparam()
std::vector<double> getRobotCfg_DHparam(bool get_nominal, error_code &ec)
读取DH参数
- 参数:
- [in] get_nominal false - 优化后或设置后的参数 | true - 读取标称参数。一般建议使用false
- [out] ec 错误码
- 返回: DH参数- 错误码为0时有效。依次为各轴的Alpha[°], A[mm], D[mm], Theta[°]
setFilterLimit()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::setFilterLimit( bool limit_rate,double cutoff_frequency )
设置限幅滤波参数.
- 参数:
- [in] limit_rate: true - 限幅开启
- [in] cutoff_frequency: 截止频率。范围是 0 ~ 1000Hz,建议 10~100Hz.
- 返回: true - 设定成功
setCartesianLimit()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::setCartesianLimit ( const std::array< double, 3 > & lengths,const std::array< double, 16 > & frame,error_code & ec )
设置笛卡尔空间运动区域,超过设置区域运动会停止。 非力控虚拟墙。若机器人末端或 TCP 末端超过安全区域,电机同样会做下电处理。
- 参数:
- [in] lengths: 安全区域长方体长宽高,对应 XYZ, 单位: 米
- [in] frame: 安全区域长方体中心相对于基坐标系位姿
- [out] ec: 错误码
setJointImpedance()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setJointImpedance ( const std::array< double, DoF > & factor,error_code & ec )
设置轴空间阻抗控制系数,轴空间阻抗运动时生效
- 参数:
- [in] factor: 轴空间阻抗系数,单位: Nm/rad。
- xMateErPro 机型最大刚度为
{ 3000, 3000, 3000, 3000, 300, 300, 300 } - 其他机型最大刚度为
{ 3000, 3000, 3000, 300, 300, 300 }实际有效的最大值和传感器等硬件状态有关系,如发生抖动等现象,请尝试减小阻抗系数。
- xMateErPro 机型最大刚度为
- [out] ec: 错误码
- [in] factor: 轴空间阻抗系数,单位: Nm/rad。
setCartesianImpedance()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setCartesianImpedance ( const std::array< double, 6 > & factor,error_code & ec )
设置笛卡尔空间阻抗控制系数, 笛卡尔阻抗运动时生效
- 参数:
- [in] factor: 笛卡尔空间阻抗控制系数, 最大值为
{ 3000, 3000, 3000, 300, 300, 300 }, 单位: N/m, Nm/rad - [out] ec: 错误码
- [in] factor: 笛卡尔空间阻抗控制系数, 最大值为
setCollisionBehaviour()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setCollisionBehaviour ( const std::array< double, DoF > & torqueThresholds,error_code & ec )
设置碰撞检测阈值。 碰撞检测只在位置控制时生效,力控时不生效。若检测到碰撞,控制器会下发下电指令,电机抱闸吸合下使能。
- 参数:
- [in] torqueThresholds: 关节碰撞检测阈值。
- xMateErPro 机型最大值为
{ 75, 75, 60, 45, 30, 30, 20 }, - 其他机型最大值为
{ 75, 75, 45, 30, 30, 20 } - 5 轴机型最大值为
{ 75, 75, 45, 30, 20 }
- xMateErPro 机型最大值为
- [out] ec 错误码
- [in] torqueThresholds: 关节碰撞检测阈值。
setEndEffectorFrame()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::setEndEffectorFrame ( const std::array< double, 16 > & frame,error_code & ec )
设置末端执行器相对于机器人法兰的位姿,设置 TCP 后控制器会保存配置,机器人重启后恢复默认设置。
- 参数:
- [in] frame: 末端执行器坐标系相对于法兰坐标系的齐次矩阵,单位: rad, m
- [out] ec: 错误码
setLoad()
template <WorkType Wt, unsigned short DoF>
void RtMotionControl<Wt, DoF>::setLoad ( const Load & load,error_code & ec )
设置工具和负载的质量、质心和惯性矩阵。设置负载后控制器会保存负载配置,机器人重启后恢复默认设置。
- 参数:
- [in] load: 负载信息
- [out] ec: 错误码
setFilterFrequency()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setFilterFrequency ( double jointFrequency,double cartesianFrequency,double torqueFrequency,error_code & ec )
设置机器人控制器的滤波截止频率,用来平滑指令。允许的范围: 1 ~ 1000Hz, 建议设置为 10 ~ 100Hz。
- 参数:
- [in] jointFrequency: 关节位置的滤波截止频率,单位: Hz
- [in] cartesianFrequency: 笛卡尔空间位置的滤波截止频率,单位: Hz
- [in] torqueFrequency: 关节力矩的滤波截止频率,单位: Hz
- [out] ec: 错误码
setCartesianImpedanceDesiredTorque()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setCartesianImpedanceDesiredTorque ( const std::array< double, 6 > & torque,error_code & ec )
设置末端期望力, 在笛卡尔空间阻抗运动时生效
- 参数:
- [in] torque: 笛卡尔空间末端期望力, 允许的范围为
{ 60, 60, 60, 30, 30, 30 }, 单位: N, N·m - [out] ec: 错误码
- [in] torque: 笛卡尔空间末端期望力, 允许的范围为
setTorqueFilterCutOffFrequency()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setTorqueFilterCutOffFrequency ( double frequency,error_code & ec )
设置滤波参数
- 参数:
- [in] frequency: 允许的范围 1 ~ 1000Hz
- [out] ec: 错误码
setFcCoor()
template <unsigned short DoF>
void RtMotionControlCobot<DoF>::setFcCoor ( const std::array< double, 16 > & frame,FrameType type,error_code & ec )
设置机器人力控坐标系
- 参数:
- [in] frame: 力控坐标系相对于法兰坐标系的变换矩阵
- [in] type: 类别, 指定哪个坐标系为力控任务坐标系, 支持:
- 世界坐标系 FrameType::world;
- 工具坐标系 FrameType::tool;
- 路径坐标系 FrameType::path (力控任务坐标系需要跟踪轨迹变化的过程)
- [out] ec: 错误码
automaticErrorRecovery()
void rokae::MotionControl< MotionControlMode::RtCommand >::automaticErrorRecovery ( error_code & ec )
当错误发生后,自动恢复机器人。
- 参数: [out] ec: 错误码
setRtNetworkTolerance()
void rokae::BaseCobot::setRtNetworkTolerance ( unsigned percent,error_code & ec )
设置发送实时运动指令网络延迟阈值,即 RobotAssist - RCI 设置界面中的“包丢失阈值”。 请在切换到 RtCommand 模式前进行设置,否则不生效。
- 参数:
- [in] percent: 允许的范围 0 - 100,Linux下运行建议20%以上; Windows下运行建议60%以上
- [out] ec: 错误码
useRciClient()
void rokae::BaseCobot::useRciClient ( bool use, error_code & ec )
兼容 RCI 客户端设置的接口。通过 SDK 设置运动控制模式为实时模式之后,无法再使用原 RCI 客户端控制机器人。 若有使用原版的需求,可在切换到非实时模式后,调用此接口。然后再在 RobotAssist 上打开 RCI 功能,即可使用 RCI 客户端。
- 参数:
- [in] use: true - 切换到使用第一代
- [out] ec: 错误码
4 力控指令
力控相关接口通过 Cobot::forceControl() 返回的 ForceControl_T 对象调用。
forceControl()
template<unsigned short DoF>
ForceControl_T<DoF> Cobot<DoF>::forceControl()
获取力控指令类对象。
- 返回:
ForceControl_T<DoF>
getEndTorque()
template<unsigned short DoF>
void ForceControl_T<DoF>::getEndTorque(FrameType ref_type,
std::array<double, DoF> &joint_torque_measured,
std::array<double, DoF> &external_torque_measured,
std::array<double, 3> &cart_torque,
std::array<double, 3> &cart_force,
error_code &ec)
获取当前力矩信息。
- 参数:
- [in] ref_type: 力矩相对的参考系。
FrameType::world末端相对世界坐标系;FrameType::flange末端相对法兰;FrameType::tool末端相对 TCP - [out] joint_torque_measured: 各轴测量力矩,单位 Nm
- [out] external_torque_measured: 各轴外部力矩,单位 Nm
- [out] cart_torque: 笛卡尔空间力矩 [X, Y, Z],单位 Nm
- [out] cart_force: 笛卡尔空间力 [X, Y, Z],单位 N
- [out] ec: 错误码
- [in] ref_type: 力矩相对的参考系。
fcInit()
void fcInit(FrameType frame_type, error_code &ec)
力控初始化。工具、工件坐标系使用 setToolset() 设置的坐标系。
- 参数:
- [in] frame_type: 力控坐标系,支持 world / wobj / tool / base / flange
- [out] ec: 错误码
fcStart()
void fcStart(error_code &ec)
开始力控,在 fcInit() 之后调用。如需在力控模式下执行运动指令,在 fcStart() 之后执行。若在 fcStart() 之前通过 moveAppend() 下发了运动指令但尚未开始运动,这些指令会在 fcStart() 之后执行。
- 参数:
- [out] ec: 错误码
fcStop()
void fcStop(error_code &ec)
停止力控。
- 参数:
- [out] ec: 错误码
setControlType()
void setControlType(int type, error_code &ec)
设置阻抗控制类型。
- 参数:
- [in] type:
0关节阻抗,1笛卡尔阻抗 - [out] ec: 错误码
- [in] type:
setLoad() [2/2]
void setLoad(const Load &load, error_code &ec)
设置力控模块使用的负载。fcStart() 之后可调用。实时模式的 setLoad() 见上文。
- 参数:
- [in] load: 负载信息
- [out] ec: 错误码
setJointStiffness()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointStiffness(const std::array<double, DoF> &stiffness, error_code &ec)
设置关节阻抗刚度。fcInit() 之后调用生效。各机型最大刚度不同,请参考《xCore 控制系统手册》SetJntCtrlStiffVec 指令说明。
- 参数:
- [in] stiffness: 各轴刚度
- [out] ec: 错误码
setCartesianStiffness()
void setCartesianStiffness(const std::array<double, 6> &stiffness, error_code &ec)
设置笛卡尔阻抗刚度。fcInit() 之后调用生效。各机型最大刚度不同,请参考《xCore 控制系统手册》SetCartCtrlStiffVec 指令说明。
- 参数:
- [in] stiffness: 依次为 X、Y、Z 方向阻抗力刚度 [N/m],以及对应方向阻抗力矩刚度 [Nm/rad]
- [out] ec: 错误码
setCartesianNullspaceStiffness()
void setCartesianNullspaceStiffness(double stiffness, error_code &ec)
设置笛卡尔零空间阻抗刚度。fcInit() 之后调用生效。
- 参数:
- [in] stiffness: 范围 [0, 4],大于 4 时按 4 处理,单位 Nm/rad
- [out] ec: 错误码
setJointDesiredTorque()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointDesiredTorque(const std::array<double, DoF> &torque, error_code &ec)
设置关节期望力矩。fcStart() 之后可调用。
- 参数:
- [in] torque: 力矩值,范围 [-30, 30],单位 Nm
- [out] ec: 错误码
setCartesianDesiredForce()
void setCartesianDesiredForce(const std::array<double, 6> &value, error_code &ec)
设置笛卡尔期望力/力矩。fcStart() 之后可调用。
- 参数:
- [in] value: 依次为 X、Y、Z 方向期望力,范围 [-60, 60],单位 N;以及对应方向期望力矩,范围 [-10, 10],单位 Nm
- [out] ec: 错误码
setSineOverlay()
void setSineOverlay(int line_dir, double amplify, double frequency, double phase, double bias, error_code &ec)
设置绕单轴旋转的正弦搜索运动。将阻抗类型设为笛卡尔阻抗(setControlType(1))之后、startOverlay() 之前调用生效。各机型幅值和频率上限不同,请参考《xCore 控制系统手册》SetSineOverlay 指令说明。
- 参数:
- [in] line_dir: 参考轴,
0X,1Y,2Z - [in] amplify: 幅值,单位 Nm
- [in] frequency: 频率,单位 Hz
- [in] phase: 相位,范围 [0, PI],单位弧度
- [in] bias: 偏置,范围 [0, 10],单位 Nm
- [out] ec: 错误码
- [in] line_dir: 参考轴,
setLissajousOverlay()
void setLissajousOverlay(int plane, double amplify_one, double frequency_one, double amplify_two, double frequency_two, double phase_diff, error_code &ec)
设置平面内的莉萨如搜索运动。将阻抗类型设为笛卡尔阻抗(setControlType(1))之后、startOverlay() 之前调用生效。
- 参数:
- [in] plane: 参考平面,
0XY,1XZ,2YZ - [in] amplify_one: 一方向幅值,范围 [0, 20],单位 Nm
- [in] frequency_one: 一方向频率,范围 [0, 5],单位 Hz
- [in] amplify_two: 二方向幅值,范围 [0, 20],单位 Nm
- [in] frequency_two: 二方向频率,范围 [0, 5],单位 Hz
- [in] phase_diff: 两方向相位偏差,范围 [0, PI],单位弧度
- [out] ec: 错误码
- [in] plane: 参考平面,
startOverlay()
void startOverlay(error_code &ec)
开启搜索运动。fcStart() 之后调用生效。搜索运动为先前 setSineOverlay() 或 setLissajousOverlay() 的叠加。
- 参数:
- [out] ec: 错误码
stopOverlay()
void stopOverlay(error_code &ec)
停止搜索运动。
- 参数:
- [out] ec: 错误码
pauseOverlay()
void pauseOverlay(error_code &ec)
暂停搜索运动。startOverlay() 之后调用生效。
- 参数:
- [out] ec: 错误码
restartOverlay()
void restartOverlay(error_code &ec)
重新开启已暂停的搜索运动。pauseOverlay() 之后调用生效。
- 参数:
- [out] ec: 错误码
setForceCondition()
void setForceCondition(const std::array<double, 6> &range, bool isInside, double timeout, error_code &ec)
设置与接触力有关的终止条件。
- 参数:
- [in] range: 各方向力限制
{ X_min, X_max, Y_min, Y_max, Z_min, Z_max },单位 N。下限为负表示负方向上的最大值;上限为负表示负方向上的最小值 - [in] isInside:
true超出限制时停止等待;false符合限制时停止等待 - [in] timeout: 超时时间,范围 [1, 600],单位秒
- [out] ec: 错误码
- [in] range: 各方向力限制
setTorqueCondition()
void setTorqueCondition(const std::array<double, 6> &range, bool isInside, double timeout, error_code &ec)
设置与接触力矩有关的终止条件。
- 参数:
- [in] range: 各方向力矩限制
{ X_min, X_max, Y_min, Y_max, Z_min, Z_max },单位 Nm - [in] isInside:
true超出限制时停止等待;false符合限制时停止等待 - [in] timeout: 超时时间,范围 [1, 600],单位秒
- [out] ec: 错误码
- [in] range: 各方向力矩限制
setPoseBoxCondition()
void setPoseBoxCondition(const Frame &supervising_frame, const std::array<double, 6> &box, bool isInside, double timeout, error_code &ec)
设置与接触位置有关的终止条件。
- 参数:
- [in] supervising_frame: 长方体所在参考坐标系,相对于外部工件坐标系(
setToolset()设置的Toolset::ref) - [in] box: 长方体
{ X_start, X_end, Y_start, Y_end, Z_start, Z_end },单位米 - [in] isInside:
true超出限制时停止等待;false符合限制时停止等待 - [in] timeout: 超时时间,范围 [1, 600],单位秒
- [out] ec: 错误码
- [in] supervising_frame: 长方体所在参考坐标系,相对于外部工件坐标系(
waitCondition()
void waitCondition(error_code &ec)
激活已设置的终止条件并等待,直到条件满足或超时。
- 参数:
- [out] ec: 错误码
fcMonitor()
void fcMonitor(bool enable, error_code &ec)
启动或关闭力控保护监控。setJointMaxVel()、setJointMaxMomentum()、setJointMaxEnergy()、setCartesianMaxVel() 设置后不立即生效,调用 fcMonitor(true) 后生效并保持,直到 fcMonitor(false)。关闭后阈值恢复默认值,基础保护仍在,但不再使用本次设置的阈值。
- 参数:
- [in] enable:
true打开,false关闭 - [out] ec: 错误码
- [in] enable:
setJointMaxVel()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointMaxVel(const std::array<double, DoF> &velocity, error_code &ec)
设置力控模式下的轴最大速度。
- 参数:
- [in] velocity: 轴速度,单位 rad/s,范围 >= 0
- [out] ec: 错误码
setCartesianMaxVel()
void setCartesianMaxVel(const std::array<double, 6> &velocity, error_code &ec)
设置力控模式下,机械臂末端相对基坐标系的最大速度。
- 参数:
- [in] velocity: 依次为 X、Y、Z [m/s] 和 A、B、C [rad/s],范围 >= 0
- [out] ec: 错误码
setJointMaxMomentum()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointMaxMomentum(const std::array<double, DoF> &momentum, error_code &ec)
设置力控模式下的轴最大动量。计算方式为 F×t(冲量):F 为力矩传感器读数,t 为控制周期。连续超过 30 个周期高于阈值时触发保护。
- 参数:
- [in] momentum: 动量,单位 N·s,范围 >= 0
- [out] ec: 错误码
setJointMaxEnergy()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointMaxEnergy(const std::array<double, DoF> &energy, error_code &ec)
设置力控模式下的轴最大动能。计算方式为 F×v(功率):F 为力矩传感器读数,v 为关节速度。连续超过 30 个周期高于阈值时触发保护。
- 参数:
- [in] energy: 动能,单位 N·rad/s,范围 >= 0
- [out] ec: 错误码
setCartesianControlMaxWrench()
void BaseForceControl::setCartesianControlMaxWrench(const std::array<double, 6> &max_wrench, error_code &ec)
阻抗力限幅指令 - 笛卡尔。fcStart() 开始生效,fcStop() 后失效。用于部分力控装配场景:阻抗运动时限制末端出力,并起末端力监控作用。
- 参数:
- [in] max_wrench: 依次为 XYZ [N]、ABC [Nm],范围 [0, 1000],默认设置最大值
- [out] ec: 错误码
setCartesianControlMaxVel()
void BaseForceControl::setCartesianControlMaxVel(const std::array<double, 6> &max_cart_vel, error_code &ec)
阻抗速度限幅 - 笛卡尔。fcStart() 开始生效,fcStop() 后失效。例如加期望力下压至接触时,可用本接口对接触过程限速。
- 参数:
- [in] max_cart_vel: XYZ 范围 [0, 3.0] m/s;ABC 范围 [0, 10.0] rad/s;默认设置最大值
- [out] ec: 错误码
setJointControlMaxTorque()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointControlMaxTorque(const std::array<double, DoF> &max_torque, error_code &ec)
阻抗力限幅指令 - 关节。fcStart() 开始生效,fcStop() 后失效。
- 参数:
- [in] max_torque: 力限幅,单位 Nm,范围 [0, 1000],默认设置最大值
- [out] ec: 错误码
setJointControlMaxVel()
template<unsigned short DoF>
void ForceControl_T<DoF>::setJointControlMaxVel(const std::array<double, DoF> &max_joint_vel, error_code &ec)
阻抗速度限幅 - 关节。fcStart() 开始生效,fcStop() 后失效。
- 参数:
- [in] max_joint_vel: 关节速度最大值,单位 rad/s,范围 [0, 10.0],默认设置最大值
- [out] ec: 错误码
setFcGain()
template<unsigned short DoF>
void ForceControl_T<DoF>::setFcGain(const std::array<double, DoF> &gain, error_code &ec)
设置各轴力控带宽。fcStart() 开始生效,fcStop() 后失效。
- 参数:
- [in] gain: 各轴带宽,范围 [0, 60],各轴默认值 20,无单位
- [out] ec: 错误码
setFriction()
template<unsigned short DoF>
void ForceControl_T<DoF>::setFriction(const std::array<double, DoF> &fric, error_code &ec)
设置各轴摩擦力补偿系数。fcStart() 开始生效,fcStop() 后失效。
- 参数:
- [in] fric: 补偿系数,范围 [0, 1],各轴默认值 0.9,无单位
- [out] ec: 错误码
5 路径规划与工具函数
在实时回调中按周期计算期望位姿或关节增量,再通过 sendCommand() 或回调返回值下发。两个规划器都采用 S 速度曲线。calculateDesiredValues() 返回 false 表示规划尚未结束,返回 true 表示本次规划结束。
CartMotionGenerator
S 速度规划的笛卡尔空间运动。规划量是路径弧长,位置和姿态插值由调用方根据弧长自行计算。
rokae::CartMotionGenerator(double speed_factor, double s_goal)
根据路径总长度和速度系数生成一条笛卡尔空间平滑轨迹。
- 参数:
- [in] speed_factor: 速度系数,范围 [0, 1]。实际速度、加速度 = 最大速度、加速度 × 速度系数
- [in] s_goal: 路径总长度,单位米
CartMotionGenerator::setMax()
void setMax(double ds_max, double dds_max_start, double dds_max_end)
设置笛卡尔空间运动的最大速度和加速度。不调用时使用默认值。
- 参数:
- [in] ds_max: 最大速度,单位 m/s,默认 1.0
- [in] dds_max_start: 起始最大加速度,单位 m/s²,默认 2.5
- [in] dds_max_end: 结束最大加速度,单位 m/s²,默认 2.5
CartMotionGenerator::getTime()
double getTime()
获得总运动时间。
- 返回:运动时间,单位秒
CartMotionGenerator::calculateSynchronizedValues()
void calculateSynchronizedValues(double s_init)
同步当前弧长。开始规划前调用,一般从 0 开始。
- 参数:
- [in] s_init: 初始弧长,单位米
CartMotionGenerator::calculateDesiredValues()
bool calculateDesiredValues(double t, double *delta_s_d) const
计算时刻 t 的弧长。用 delta_s_d / s_goal 作为进度,对起止位置和姿态做插值。
- 参数:
- [in] t: 距开始规划的时间,单位秒。实时周期通常按 0.001 累加
- [out] delta_s_d: 当前弧长
- 返回:
false规划未结束,true规划结束
JointMotionGenerator
S 速度规划的轴空间运动,用于回零或运动到指定关节位置。接口按 7 轴数组定义,示例用于 xMateER Pro 七轴机型。各轴增量加到 calculateSynchronizedValues() 传入的起始关节角上,得到该周期的目标关节角。
rokae::JointMotionGenerator(double speed_factor, std::array<double, 7> q_goal)
根据关节目标位置和速度系数生成一条轴空间轨迹。
- 参数:
- [in] speed_factor: 速度系数,范围 [0, 1]。各轴实际速度、加速度 = 轴空间最大速度、加速度 × 速度系数
- [in] q_goal: 目标关节角度,单位弧度
JointMotionGenerator::setMax()
void setMax(const std::array<double, 7> &dq_max,
const std::array<double, 7> &ddq_max_start,
const std::array<double, 7> &ddq_max_end)
设置轴空间 S 速度规划的最大速度和加速度。不调用时使用默认值。
- 参数:
- [in] dq_max: 最大速度,单位 rad/s。默认 J1
J4 为 1.0,J5J7 为 1.25 - [in] ddq_max_start: 起始最大加速度,单位 rad/s²,默认各轴 2.5
- [in] ddq_max_end: 结束最大加速度,单位 rad/s²,默认各轴 2.5
- [in] dq_max: 最大速度,单位 rad/s。默认 J1
JointMotionGenerator::getTime()
double getTime()
获得总运动时间。
- 返回:运动时间,单位秒
JointMotionGenerator::calculateSynchronizedValues()
void calculateSynchronizedValues(const std::array<double, 7> &q_init)
同步当前轴角度。开始规划前调用,传入本次运动的起始关节角。
- 参数:
- [in] q_init: 初始关节角度,单位弧度
JointMotionGenerator::calculateDesiredValues()
bool calculateDesiredValues(double t, std::array<double, 7> &delta_q_d) const
计算时刻 t 相对起始关节角的增量。目标关节角 = 起始关节角 + delta_q_d。
- 参数:
- [in] t: 距开始规划的时间,单位秒。实时周期通常按 0.001 累加
- [out] delta_q_d: 各轴角度增量,单位弧度
- 返回:
false规划未结束,true规划结束
FollowPosition::init()
template<unsigned short DoF>
void init(Cobot<DoF>& robot, xMateModel<DoF>& model);
初始化点位跟随控制器。需使用 xMateModel 模型库(XCORE_USE_XMATE_MODEL=ON)。
- 参数:
- [in] robot: 机器人实例
- [in] model: 机器人模型实例。应使用
xMateModel<DoF>;model.h中仍保留XMateModel别名,但不应作为模板名直接调用init
- 说明:使用默认构造时,须先调用
init()再使用
FollowPosition::start()
开始点位跟随。初始点位类型(笛卡尔位姿或轴角度)须与后续所有 update() 保持一致,不可混用。
FollowPosition::update()
跟随过程中更新目标点位。须与 start() 使用同一类点位(笛卡尔位姿或轴角度)。
Utils::eulerToQuaternion()
欧拉角(RPY)转四元数。
- 旋转合成顺序(v0.7.2+):
Rz * Ry * Rx(yaw → pitch → roll) - 说明:函数签名未变,但相同 RPY 输入得到的四元数与 v0.7.0(
Rx * Ry * Rz)不同,升级后请对姿态转换相关用例做回归 - Windows(
_MSC_VER)下增加#include <corecrt_math_defines.h>,便于使用M_PI等宏
6 RL 工程
projectsInfo()
std::vector<RLProjectInfo> rokae::BaseRobot::projectsInfo(error_code &ec)
查询控制器中的 RL 工程名称及任务。
- 参数:
- [out] ec: 错误码
- 返回:工程信息列表。没有工程时返回空列表
loadProject()
void rokae::BaseRobot::loadProject(const std::string &name, const std::vector<std::string> &tasks, error_code &ec)
加载工程。
- 参数:
- [in] name: 工程名称
- [in] tasks: 要运行的任务,不能为空,否则无法执行工程
- [out] ec: 错误码
ppToMain()
void rokae::BaseRobot::ppToMain(error_code &ec)
程序指针跳转到 main。调用后等待控制器解析完工程再返回,阻塞时间视工程大小而定,超时时间 10 秒。错误码不能反馈 RL 语法错误、变量不存在等问题,可通过 queryControllerLog() 查询控制器日志。
- 参数:
- [out] ec: 错误码
runProject()
void rokae::BaseRobot::runProject(error_code &ec)
开始运行当前已加载的工程。
- 参数:
- [out] ec: 错误码
pauseProject()
void rokae::BaseRobot::pauseProject(error_code &ec)
暂停运行工程。
- 参数:
- [out] ec: 错误码
setProjectRunningOpt()
void rokae::BaseRobot::setProjectRunningOpt(double rate, bool loop, error_code &ec)
设置工程运行速率和循环模式。
- 参数:
- [in] rate: 运行速率,范围 0.01~1
- [in] loop:
true循环执行,false单次执行 - [out] ec: 错误码
toolsInfo()
std::vector<WorkToolInfo> rokae::BaseRobot::toolsInfo(error_code &ec)
查询当前加载工程的工具信息。
- 参数:
- [out] ec: 错误码
- 返回:工具信息列表。未加载工程或未创建工具时,返回默认工具 tool0
wobjsInfo()
std::vector<WorkToolInfo> rokae::BaseRobot::wobjsInfo(error_code &ec)
查询当前加载工程的工件信息。
- 参数:
- [out] ec: 错误码
- 返回:工件信息列表。未加载工程或未创建工件时返回空列表
importProject()
std::string rokae::BaseRobot::importProject(const std::string &file_path, bool overwrite, error_code &ec)
将本地 RL 工程压缩包导入控制器。阻塞直到导入完成或失败。
- 参数:
- [in] file_path: 本地
.zip路径,文件大小在 10MB 以内 - [in] overwrite:
true覆盖同名文件,false自动重命名 - [out] ec: 错误码
- [in] file_path: 本地
- 返回:工程名。自动重命名时返回重命名后的名称
removeProject()
void rokae::BaseRobot::removeProject(const std::string &project_name, error_code &ec, bool remove_all = false)
删除控制器中的 RL 工程。
- 参数:
- [in] project_name: 工程名
- [out] ec: 错误码
- [in] remove_all: 是否删除所有工程,默认
false
importFile()
std::string rokae::BaseRobot::importFile(const std::string &src_file_path, const std::string &dest, bool overwrite, error_code &ec)
导入本地文件到控制器。阻塞直到导入完成或失败。
- 参数:
- [in] src_file_path: 本地文件路径,文件大小在 10MB 以内
- [in] dest: 目标路径。传输单个
.mod:project/[工程名]/[任务名]/[mod文件名]。传输.json/.xml/sys配置文件:project/[工程名]/[文件名]。配置文件名不可更改,任务文件名必须是task.xml - [in] overwrite:
true覆盖同名文件,false自动重命名。仅.mod支持自动重命名 - [out] ec: 本地文件不存在、格式错误、传输失败或目标路径不符合要求
- 返回:导入成功后的文件名
removeFiles()
void rokae::BaseRobot::removeFiles(const std::vector<std::string> &file_path_list, error_code &ec)
删除控制器中的文件。工程的 .xml、.json 等配置文件不能删除,只能替换。
- 参数:
- [in] file_path_list: 文件路径列表。删除某任务下的
.mod:project/[工程名]/[任务名]/[mod文件名]。删除某任务:project/[工程名]/[任务名] - [out] ec: 参数格式错误或网络错误。工程、任务或文件不存在时不返回错误码
- [in] file_path_list: 文件路径列表。删除某任务下的
setToolInfo()
void rokae::BaseRobot::setToolInfo(const WorkToolInfo &tool_info, error_code &ec)
设置全局工具信息,或新建、修改 RL 工程中工具的位姿和负载。
- 参数:
- [in] tool_info: 工具信息
- [out] ec: 全局工具一般不会失败。工程中的工具可能失败,例如已推送工具配置但未重新加载工程、配置不一致时会返回错误码
setWobjInfo()
void rokae::BaseRobot::setWobjInfo(const WorkToolInfo &wobj_info, error_code &ec)
设置全局工件信息,或新建、修改 RL 工程中工件的位姿和负载。
- 参数:
- [in] wobj_info: 工件信息
- [out] ec: 与
setToolInfo()相同。全局工件一般不会失败,工程中的工件可能因配置不一致失败
7 通信相关
getDI()
bool rokae::BaseRobot::getDI(unsigned int board, unsigned int port, error_code &ec)
查询数字量输入信号值。
- 参数:
- [in] board: IO 板序号
- [in] port: 信号端口号
- [out] ec: 错误码
- 返回:
true开,false关
setDI()
void rokae::BaseRobot::setDI(unsigned int board, unsigned int port, bool state, error_code &ec)
设置数字量输入信号值。仅当输入仿真模式打开时可以设置,见 setSimulationMode()。
- 参数:
- [in] board: IO 板序号
- [in] port: 信号端口号
- [in] state:
true开,false关 - [out] ec: 错误码
getDO()
bool rokae::BaseRobot::getDO(unsigned int board, unsigned int port, error_code &ec)
查询数字量输出信号值。
- 参数:
- [in] board: IO 板序号
- [in] port: 信号端口号
- [out] ec: 错误码
- 返回:
true开,false关
setDO()
void rokae::BaseRobot::setDO(unsigned int board, unsigned int port, bool state, error_code &ec)
设置数字量输出信号值。
- 参数:
- [in] board: IO 板序号
- [in] port: 信号端口号
- [in] state:
true开,false关 - [out] ec: 错误码
getAI()
double rokae::BaseRobot::getAI(unsigned int board, unsigned int port, error_code &ec)
读取模拟量输入信号值。
- 参数:
- [in] board: IO 板序号
- [in] port: 信号端口号
- [out] ec: 错误码
- 返回:信号值
setAO()
void rokae::BaseRobot::setAO(unsigned int board, unsigned int port, double value, error_code &ec)
设置模拟量输出信号。
- 参数:
- [in] board: IO 板序号
- [in] port: 信号端口号
- [in] value: 输出值
- [out] ec: 错误码
setSimulationMode()
void rokae::BaseRobot::setSimulationMode(bool state, error_code &ec)
设置输入仿真模式。
- 参数:
- [in] state:
true打开,false关闭 - [out] ec: 错误码
- [in] state:
readRegister()
void rokae::BaseRobot::readRegister(const std::string &name, unsigned index, T &value, error_code &ec)
读取寄存器值。可读取单个寄存器,或按索引读取寄存器数组中的元素。value 支持 bool、int、float 以及对应的 std::vector。读取整个寄存器数组时,value 传入向量,index 被忽略。
- 参数:
- [in] name: 寄存器名称
- [in] index: 数组索引,从 0 开始。索引超出数组长度,或寄存器不是数组但 index 大于 0 时返回错误
- [out] value: 读出的数值,类型须与寄存器一致
- [out] ec: 错误码
writeRegister()
void rokae::BaseRobot::writeRegister(const std::string &name, unsigned index, const T &value, error_code &ec)
写入寄存器值。可写入单个寄存器、整个寄存器数组,或按索引写入数组中的一个元素。value 支持 bool、int、float 以及对应的 std::vector。写入整个数组时,index 被忽略。
- 参数:
- [in] name: 寄存器名称
- [in] index: 数组索引,从 0 开始。索引超出数组长度,或寄存器不是数组但 index 大于 0 时返回错误
- [in] value: 写入的数值
- [out] ec: 错误码
setxPanelVout()
void rokae::BaseRobot::setxPanelVout(xPanelOpt::Vout opt, error_code &ec)
设置 xPanel 对外供电模式。仅部分机型支持,不支持的机型会返回错误码。
- 参数:
- [in] opt:
xPanelOpt::Vout,off不输出,reserve保留,supply12v输出 12V,supply24v输出 24V - [out] ec: 错误码
- [in] opt:
getKeypadState()
KeyPadState rokae::BaseRobot::getKeypadState(error_code &ec)
获取末端按键状态。不支持的机型会返回错误码。按键编号见《xCore 机器人控制系统使用手册》末端把手图示。
- 参数:
- [out] ec: 错误码
- 返回:末端按键状态
setxPanelRS485()
void rokae::BaseRobot::setxPanelRS485(xPanelOpt::Vout opt, bool if_rs485, error_code &ec)
配置末端供电模式,并打开或关闭末端 485 通信。CR、SR 等机型使用 485 前需调用本接口。
- 参数:
- [in] opt: 对外供电模式,
off/reserve/supply12v/supply24v - [in] if_rs485: 是否打开末端 485 通信
- [out] ec: 错误码
- [in] opt: 对外供电模式,
XPRWModbusRTUReg()
void rokae::BaseRobot::XPRWModbusRTUReg(int slave_addr, int fun_cmd, int reg_addr,
const std::string &data_type, int num, std::vector<int> &data_array,
bool if_crc_reverse, error_code &ec)
通过 xPanel 末端读写 Modbus RTU 寄存器。
- 参数:
- [in] slave_addr: 从站地址,0~65535
- [in] fun_cmd: 功能码,
0x03/0x04/0x06/0x10 - [in] reg_addr: 寄存器地址,0~65535
- [in] data_type:
int16/uint16/int32/uint32 - [in] num: 一次连续操作的寄存器个数。
int16/uint16最大为 3;int32/uint32最大为 1。功能码0x06时本参数无效 - [in/out] data_array: 发送或接收数据。功能码
0x06时只使用data_array[0];其余功能码长度须与num一致 - [in] if_crc_reverse: 是否反转 CRC 高低位,默认
false - [out] ec: 错误码
XPRWModbusRTUCoil()
void rokae::BaseRobot::XPRWModbusRTUCoil(int slave_addr, int fun_cmd, int coil_addr,
int num, std::vector<bool> &data_array, bool if_crc_reverse, error_code &ec)
通过 xPanel 末端读写 Modbus 线圈或离散输入。
- 参数:
- [in] slave_addr: 从站地址,0~65535
- [in] fun_cmd: 功能码,
0x01/0x02/0x05/0x0F - [in] coil_addr: 线圈或离散输入地址,0~65535
- [in] num: 一次连续读写个数,范围 0~48。功能码
0x05时本参数无效 - [in/out] data_array: 发送或接收数据。功能码
0x05时只使用data_array[0];其余功能码长度须与num一致 - [in] if_crc_reverse: 是否反转 CRC 高低位,默认
false - [out] ec: 错误码
XPRS485SendData()
void rokae::BaseRobot::XPRS485SendData(int send_byte, int rev_byte,
const std::vector<uint8_t> &send_data, std::vector<uint8_t> &rev_data, error_code &ec)
通过 xPanel 末端直接收发 RTU 协议裸数据。
- 参数:
- [in] send_byte: 发送字节长度,0~16,须与
send_data长度一致 - [in] rev_byte: 接收字节长度,0~16,须与
rev_data长度一致 - [in] send_data: 发送数据
- [out] rev_data: 接收数据
- [out] ec: 错误码
- [in] send_byte: 发送字节长度,0~16,须与
8 协作相关
enableDrag()
void rokae::BaseCobot::enableDrag(DragParameter::Space space, DragParameter::Type type, error_code &ec, bool enable_drag_button = false)
打开拖动。轴空间拖动仅支持自由拖拽类型。前置条件为手动模式、下电状态。
- 参数:
- [in] space: 拖动空间
- [in] type: 拖动类型
- [out] ec: 错误码
- [in] enable_drag_button:
true时打开拖动后可直接拖动,不必按住末端按键。默认false
disableDrag()
void rokae::BaseCobot::disableDrag(error_code &ec)
关闭拖动。
- 参数:
- [out] ec: 错误码
startRecordPath()
void rokae::BaseCobot::startRecordPath(int duration, error_code &ec)
开始录制路径。本接口不阻塞。duration 只做范围检查,到时后控制器不会自动停止,需调用 stopRecordPath()。
- 参数:
- [in] duration: 录制时长,单位秒,范围 1~1800
- [out] ec: 错误码
stopRecordPath()
void rokae::BaseCobot::stopRecordPath(error_code &ec)
停止录制路径。无错误码时,路径数据保存在缓存中。
- 参数:
- [out] ec: 错误码
cancelRecordPath()
void rokae::BaseCobot::cancelRecordPath(error_code &ec)
取消录制,缓存中的路径数据会被删除。
- 参数:
- [out] ec: 错误码
saveRecordPath()
void rokae::BaseCobot::saveRecordPath(const std::string &name, error_code &ec, const std::string &saveAs = "")
保存已录制的路径。若存在尚未保存的录制,则用 name 保存;若没有未保存的路径,则把名为 name 的路径重命名为 saveAs。
- 参数:
- [in] name: 路径名称
- [out] ec: 错误码
- [in] saveAs: 重命名,可为空
replayPath()
void rokae::BaseCobot::replayPath(const std::string &name, double rate, error_code &ec)
路径回放。与其它运动指令相同,调用后需再调用 moveStart() 才会开始运动。
- 参数:
- [in] name: 路径名称
- [in] rate: 回放速率,应小于 3.0,
1为原始速率。大于 1 时可能出现驱动器无法跟随 - [out] ec: 错误码
removePath()
void rokae::BaseCobot::removePath(const std::string &name, error_code &ec, bool removeAll = false)
删除已保存的路径。路径不存在时不置位错误码。
- 参数:
- [in] name: 路径名称
- [out] ec: 错误码
- [in] removeAll: 是否删除所有路径,默认
false
queryPathLists()
std::vector<std::string> rokae::BaseCobot::queryPathLists(error_code &ec)
查询已保存的路径名称。
- 参数:
- [out] ec: 错误码
- 返回:路径名称列表。没有路径时返回空列表
calibrateForceSensor()
void rokae::BaseCobot::calibrateForceSensor(bool all_axes, int axis_index, error_code &ec)
力传感器标定。过程约 100ms,本函数不阻塞等待完成。标定前须通过 setToolset() 设置正确负载(Toolset::load),否则会影响标定结果。
- 参数:
- [in] all_axes:
true标定所有轴,false单轴标定 - [in] axis_index: 轴下标,范围 [0, DoF),仅单轴标定生效
- [out] ec: 错误码
- [in] all_axes:
9 xPanel 通信
setxPanelRS485()
void setxPanelRS485(xPanelOpt::Vout opt, bool if_rs485, error_code& ec) noexcept
配置末端供电模式,并切换是否启用末端 485 通信,CR/SR 等使用 485 功能前需调用,AR机型无需设置,已默认输出24v并开启RS485通信。
- 参数:
- [in] opt: 对外供电模式(
xPanelOpt::Vout):off/reserve/supply12v/supply24v - [in] if_rs485: 是否打开末端 485 通信
- [out] ec: 错误码
- [in] opt: 对外供电模式(
xPanelRS485Init()
void xPanelRS485Init(xPanelCommOpt::Rs485Baud baud,
xPanelCommOpt::CheckBit check_bit,
xPanelCommOpt::StopBit stop_bit,
error_code& ec) noexcept
初始化 xPanel RS485 通信参数(波特率、校验位、停止位),注意AR机型设置完毕后需要重启生效。
- 参数:
- [in] baud: 波特率,见
xPanelCommOpt::Rs485Baud - [in] check_bit: 校验位,
none/odd/even - [in] stop_bit: 停止位,
stopbit1/stopbit2 - [out] ec: 错误码
- [in] baud: 波特率,见
- 说明:AR 机型与其他机型支持的波特率集合不同:
- AR:4800、9600、19200、38400、57600、115200、2500000
- 其他:9600、19200、38400、57600、115200、230400、460800、1000000、2000000
- 不支持的波特率会返回参数超限错误
setxPanelRS485Overtime()
void setxPanelRS485Overtime(int overtime_ms, error_code& ec) noexcept
设置 xPanel RS485 通信超时时间。
- 参数:
- [in] overtime_ms: 超时时间(ms),范围 50~10000
- [out] ec: 错误码
xPanelCANInit()
void xPanelCANInit(xPanelCommOpt::CanArbitrationBaud arbitration_baud,
xPanelCommOpt::CanDataBaud data_baud,
error_code& ec) noexcept
初始化 xPanel CAN 通信波特率参数,目前仅支持AR机型使用,设置完毕后需要重启生效。
- 参数:
- [in] arbitration_baud: 仲裁波特率(
b1M/b500k/b250k/b125k) - [in] data_baud: 数据波特率(
b5M/b4M/b2M/b1M) - [out] ec: 错误码
- [in] arbitration_baud: 仲裁波特率(
XPRWModbusRTUReg()
void XPRWModbusRTUReg(int slave_addr, int fun_cmd, int reg_addr, std::string data_type,
int num, std::vector<int>& data_array, bool if_crc_reverse,
error_code& ec) noexcept
通过 xPanel 末端读写 Modbus RTU 寄存器。
- 参数:
- [in] slave_addr: 从站地址,0~65535
- [in] fun_cmd: 功能码,
0x03/0x04/0x06/0x10 - [in] reg_addr: 寄存器地址,0~65535
- [in] data_type:
int16/uint16/int32/uint32 - [in] num: 一次连续操作个数。功能码
0x06时无效。取值范围:- CR/ER/SR:末端固件版本 < 301 时,16 位为 [1,3],32 位为 1;末端固件版本 ≥ 301 时,16 位为 [1,59],32 位为 [1,29]
- AR:16 位为 [1,27],32 位为[1,13]
- [in/out] data_array: 读写缓冲。功能码
0x06时仅使用data_array[0];其余须与num匹配 - [in] if_crc_reverse: 是否反转 CRC 高低位,默认
false - [out] ec: 错误码
XPRWModbusRTUCoil()
void XPRWModbusRTUCoil(int slave_addr, int fun_cmd, int coil_addr, int num,
std::vector<bool>& data_array, bool if_crc_reverse,
error_code& ec) noexcept
通过 xPanel 末端读写 Modbus 线圈或离散输入。
- 参数:
- [in] slave_addr: 从站地址,0~65535
- [in] fun_cmd:
0x01/0x02/0x05/0x0F - [in] coil_addr: 线圈或离散输入地址,0~65535
- [in] num: 连续读写个数。功能码
0x05时无效。取值范围:- CR/ER/SR:末端固件版本 < 301 时为 [1,48];末端固件版本 ≥ 301 时为 [1,944]
- AR:[1,432]
- [in/out] data_array: 布尔缓冲。功能码
0x05时仅使用data_array[0] - [in] if_crc_reverse: 是否反转 CRC 高低位,默认
false - [out] ec: 错误码
XPRS485SendData()
void XPRS485SendData(int send_byte, int rev_byte,
const std::vector<uint8_t>& send_data, std::vector<uint8_t>& rev_data,
error_code& ec) noexcept
通过 xPanel 末端直接收发 RTU 协议裸数据(非 Modbus 封装)。
- 参数:
- [in] send_byte: 发送字节长度;须与
send_data.size()一致 - [in] rev_byte: 期望接收字节长度;调用前
rev_data.size()须与其一致 - [in] send_data: 发送数据
- [out] rev_data: 接收数据
- [out] ec: 错误码
- [in] send_byte: 发送字节长度;须与
- 说明:最大字节数随 xPanel 类型变化(CR/ER/SR系列301及以上末端固件版本支持128字节,此前版本支持16字节,非定制版本AR系列支持64字节)
CANReceiveData()
void CANReceiveData(int timeout_ms, std::string data_type, CANFrame& recv_frame, error_code& ec) noexcept
通过 xPanel 末端接收 CAN 协议裸数据。
- 参数:
- [in] timeout_ms: 接收超时时间(ms)
- [in] data_type:
int16/uint16/uint8 - [out] recv_frame: 接收帧(
CANFrame,data为vector<int>,由data_type解释) - [out] ec: 错误码
- 说明:超时未收到数据时返回失败;
frame_format见CANFormat,frame_type见CANType
CANSendData()
void CANSendData(std::string data_type, const std::vector<CANFrame>& send_frame, error_code& ec) noexcept
通过 xPanel 末端发送 CAN 协议裸数据(可一次发送多帧)。
- 参数:
- [in] data_type:
int16/uint16/uint8 - [in] send_frame: 待发送帧列表;每帧
data.size()须等于frame_valid_length - [out] ec: 错误码
- [in] data_type:
- 说明:
frame_valid_length合法范围与帧类型、data_type相关:- 经典 CAN +
uint8:[1,8]; - 经典 CAN +
int16/uint16:[1,4] - CANFD / CANFD 加速 +
uint8:[1,8],或 12/16/20/24/32/48/64 - CANFD / CANFD 加速 +
int16/uint16:[1,4],或 6/8/10/12/16/24/32
- 经典 CAN +
CANRwData()
void CANRwData(const CANRwParam& param, CANRwResult& recv_frames, error_code& ec) noexcept
rokae::BaseCobot 通过 xPanel 末端按序执行多组操作。每组先发送一帧 CAN 数据,随后期望接收一帧或多帧 CAN 数据。
- 参数
- [in] param -
CANRwParam,param.rw_frames[i].send_data为第i组要发送的原始字节,param.rw_frames[i].rev_frames_per为该组期望接收的帧数。param.interval_ms指定组间隔(ms) - [out] recv_frames -
CANRwResult,按组保存实际收到的帧。recv_frames[i][j]是第i组的第j帧,内容为原始字节 - [out] ec - 错误码。读取结果前先检查错误码,再按实际返回的组数和帧数访问
- [in] param -