ProCon说明 快速入门 运动控制 EtherCAT 实时程序 API函数 控件库 硬件说明 问题排查 示例代码 |
函数 | YK_API YKM_SetPosition(UINT32 axisIndex, double position) | |
功能 | 设置当前位置;将当前位置设置为指定值 | |
参数 | axisIndex position |
[IN] 轴序号 [IN] 指定位置 |
返回值 | 错误代码 | |
说明 | 位置变更最多需要2个总线周期 | |
注意事项 | 轴为跟随主轴的时候禁止使用该函数 轴为电子凸轮主轴的时候禁止使用该函数 轴当前在限位的时候禁止使用该函数 会清除IsHomed信号 |
函数 | YK_API YKM_SetAxisProfileClearDrvWarn(UINT32 axisIndex, YKM_AxisProfileClearDrvWarn profile) YK_API YKM_SetAxisProfileClearDrvWarn(UINT32 axisIndex, YKM_AxisProfileClearDrvWarn* profile) |
|
功能 | 设置(获取)清除驱动器报警重试参数 | |
参数 | axisIndex profile |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 只对总线轴有效 |
函数 | YK_API YKM_GetAxisProfilePowerOn(UINT32 axisIndex, YKM_AxisProfilePowerOn profile) YK_API YKM_SetAxisProfilePowerOn(UINT32 axisIndex, YKM_AxisProfilePowerOn* profile) |
|
功能 | 设置(获取)轴使能参数 | |
参数 | axisIndex profile |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 只对总线轴有效 |
函数 | YK_API YKM_ClearDrvWarn(UINT32 axisIndex) | |
功能 | 清除驱动器报警 | |
参数 | axisIndex |
[IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 清除动作需要N个总线周期,和驱动器相关;待该动作完成后再进行其他运动;不同厂商的驱动器报警代码各不一样, 具体操作请查看厂商的驱动器手册 |
|
注意事项 | 某些严重的报警无法通过软件命令清除,和驱动器相关,请参考驱动器手册 |
函数 | YK_API YKM_PowerOn(UINT32 axisIndex) | |
功能 | 轴使能 | |
参数 | axisIndex |
[IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 使能动作需要N个总线周期,和驱动器相关;待该动作完成后再进行其他运动 | |
注意事项 | 实际状态参考YKM_AxisStatus.PowerOn |
函数 | YK_API YKM_PowerOff(UINT32 axisIndex) | |
功能 | 轴去使能 | |
参数 | axisIndex |
[IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 使能动作需要N个总线周期,和驱动器相关 | |
注意事项 | 实际状态参考YKM_AxisStatus.PowerOn |
函数 | YK_API YKM_ClearAxisWarn(UINT32 axisIndex) | |
功能 | 复位轴状态,清除报警 | |
参数 | axisIndex |
[IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 清除动作需要N个总线周期,和驱动器相关;指请我们记录的错误状态,对应枚举YKM_MC_ERROR | |
注意事项 | 某些严重的报警无法通过软件命令清除,和驱动器相关,请参考驱动器手册 |
函数 | YK_API YKM_StopAxis(UINT32 axisIndex, UINT32 dec_sel) | |
功能 | 轴停止 | |
参数 | axisIndex dec_sel |
[IN] 轴序号 [IN] 0=缓停减速度(YKM_AxisStatus.stop_dec_smooth) 1=急停减速度(YKM_AxisStatus.stop_dec_emg) 2=指令减速度 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
发送停止命令后,轴会减速停止,可用YKM_AxisStatus.Active检测是否完全停止。 |
函数 | YK_API YKM_StartHome(UINT32 axisIndex, YKM_HomeConfig config) | |
功能 | 启动回原点 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveAbsolute(UINT32 axisIndex, YKM_MoveAbsoluteConfig config) | |
功能 | 绝对运动 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 可通过再次执行改函数实现变速变位置的功能 |
函数 | YK_API YKM_MoveAbsoluteTrigger(UINT32 axisIndex, YKM_MoveAbsoluteConfig config,YKM_AxisTrigger trigger) | |
功能 | 条件触发绝对运动 | |
参数 | axisIndex config trigger |
[IN] 轴序号 [IN] 运动配置 [IN] 触发条件 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveAbsoluteEvents(UINT32 axisIndex, YKM_MoveAbsoluteConfig config,YKM_TriggerEvents events) | |
功能 | 事件触发绝对运动 | |
参数 | axisIndex config events |
[IN] 轴序号 [IN] 运动配置 [IN] 触发事件 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveRelative(UINT32 axisIndex, YKM_MoveRelativeConfig config) | |
功能 | 相对运动 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveRelativeTrigger(UINT32 axisIndex, YKM_MoveAbsoluteConfig config,YKM_AxisTrigger trigger) | |
功能 | 条件触发相对运动 | |
参数 | axisIndex config trigger |
[IN] 轴序号 [IN] 运动配置 [IN] 触发条件 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveRelativeEvents(UINT32 axisIndex, YKM_MoveAbsoluteConfig config,YKM_TriggerEvents events) | |
功能 | 事件触发相对运动 | |
参数 | axisIndex config events |
[IN] 轴序号 [IN] 运动配置 [IN] 触发事件 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MovePositionSim(UINT32 axisIndex, YKM_MovePositionSimConfig config,YKM_MovePositionSimResult *result) | |
功能 | 速度运动 | |
参数 | axisIndex config result |
[IN] 轴序号 [IN] 运动配置 [IN] 规划结果 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveVelocity(UINT32 axisIndex, YKM_MoveVelocityConfig config) | |
功能 | 速度运动 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 可通过再次执行改函数实现变速的功能 |
函数 | YK_API YKM_MoveVelocityTrigger(UINT32 axisIndex, YKM_MoveVelocityConfig config,YKM_AxisTrigger trigger) | |
功能 | 条件触发速度运动 | |
参数 | axisIndex config trigger |
[IN] 轴序号 [IN] 运动配置 [IN] 触发条件 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveVelocityEvents(UINT32 axisIndex, YKM_MoveVelocityConfig config,YKM_TriggerEvents events) | |
功能 | 事件触速度运动 | |
参数 | axisIndex config events |
[IN] 轴序号 [IN] 运动配置 [IN] 触发事件 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveTorque(UINT32 axisIndex, YKM_MoveTorqueConfig config) | |
功能 | 转矩 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetPositionTorqueConfig(UINT32 axisIndex, YKM_PositionTorqueConfig config) | |
功能 | 写入位置-转矩表配置 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_GetPositionTorqueConfig(UINT32 axisIndex, YKM_PositionTorqueConfig* config) | |
功能 | 获取位置-转矩表配置 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetPositionTorqueData(UINT32 axisIndex, double *data) | |
功能 | 写入位置-转矩表数据 | |
参数 | axisIndex data |
[IN] 轴序号 [IN] 每行数据按位置-转矩(0.1%)-最大速度(r/min)排列;行数由YKM_PositionTorqueConfig.count确定 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_GetPositionTorqueData(UINT32 axisIndex, double *data) | |
功能 | 读取位置-转矩表数据 | |
参数 | axisIndex data |
[IN] 轴序号 [IN] 每行数据按位置-转矩(0.1%)-最大速度(r/min)排列;行数由YKM_PositionTorqueConfig.count确定 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_EnablePositionTorque(UINT32 axisIndex) | |
功能 | 启用位置-转矩表 | |
参数 | axisIndex | [IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_DisablePositionTorque(UINT32 axisIndex) | |
功能 | 禁用位置-转矩表 | |
参数 | axisIndex | [IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_MoveContinuesAbsolute(UINT32 axisIndex, YKM_MoveAbsoluteConfig config, YKM_BufferMode buffMode) | |
功能 | 连续运动:绝对位置模式 | |
参数 | axisIndex config buffMode |
[IN] 轴序号 [IN] 位置配置 [IN] 缓冲模式 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 | 缓冲区最多储存16条连续指令 |
函数 | YK_API YKM_MoveContinuesRelative(UINT32 axisIndex, YKM_MoveRelativeConfig config, YKM_BufferMode buffMode) | |
功能 | 连续运动:相对位置模式 | |
参数 | axisIndex config buffMode |
[IN] 轴序号 [IN] 位置配置 [IN] 缓冲模式 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 | 缓冲区最多储存16条连续指令 |
函数 | YK_API YKM_MoveContinuesTorque(UINT32 axisIndex, YKM_MoveTorqueConfig config) | |
功能 | 连续运动:相对位置模式 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 转矩配置 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 |
函数 | YK_API YKM_MoveContinuesVelocity(UINT32 axisIndex, YKM_MoveVelocityConfig config, YKM_BufferMode buffMode) | |
功能 | 连续运动:速度模式 | |
参数 | axisIndex config buffMode |
[IN] 轴序号 [IN] 位置配置 [IN] 缓冲模式 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 | 缓冲区最多储存16条连续指令 |
函数 | YK_API YKM_MoveContinuesOutput(UINT32 axisIndex, double position, UINT32 byteIndex, UINT32 bitOffset, UINT32 onOff, YKM_AxisCmpType cmp_type) | |
功能 | 连续运动:数字输出 | |
参数 | axisIndex |
[IN] 轴序号 [IN] 输出参考位置,根据位置比较类型设置 [IN] 输出字节编号 [IN] 输出位偏移 [IN] 开/关选择 [IN] 位置比较类型 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 | 缓冲区最多储存16条连续指令 |
函数 | YK_API YKM_MoveContinuesInput(UINT32 axisIndex, UINT32 byteIndex, UINT32 bitOffset, YKM_TrigMode trigMode) | |
功能 | 连续运动:数字输入 | |
参数 | axisIndex byteIndex bitOffset trigMode |
[IN] 轴序号 [IN] 输入字节编号 [IN] 输入位偏移 [IN] 输入触发模式 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 | 缓冲区最多储存16条连续指令 |
函数 | YK_API YKM_MoveContinuesDelay(UINT32 axisIndex, UINT32 tim_us) | |
功能 | 连续运动:延时(us) | |
参数 | axisIndex tim_us |
[IN] 轴序号 [IN] 延时时间,微妙单位 |
返回值 | 错误代码 | |
说明 | 写入缓存队列 | |
注意事项 | 缓冲区最多储存16条连续指令 |
函数 | YK_API YKM_MoveContinuesStart(UINT32 axisIndex) | |
功能 | 启动连续运动 | |
参数 | axisIndex | [IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_EnableAxisBuffer(UINT32 axisIndex, UINT32 depth) | |
功能 | 启用运动缓冲区模式 | |
参数 | axisIndex depth |
[IN] 轴序号 [IN] 缓冲区深度, 范围3~128 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_DisableAxisBuffer(UINT32 axisIndex) | |
功能 | 停用运动缓冲区模式 | |
参数 | axisIndex | [IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_StartAxisBuffer(UINT32 axisIndex) | |
功能 | 启动运动缓冲区 | |
参数 | axisIndex | [IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_StartMultiAxisBuffer(UINT32 axisNum, UINT32 *axisList) | |
功能 | 同时启动多轴的运动缓冲区 | |
参数 | axisNum axisList |
[IN] 轴数量, 最大32轴 [IN] 轴序号列表 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_WriteAxisBufferData(UINT32 axisIndex, double position) | |
功能 | 向运动缓冲区写入位置数据 | |
参数 | axisIndex position |
[IN] 轴序号 [IN] 位置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_GetAxisBufferStatus(UINT32 axisIndex, YKM_AxisBufferStatus* status) | |
功能 | 获取运动缓冲区状态 | |
参数 | axisIndex status |
[IN] 轴序号 [IN] 返回状态/td> |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
Copyright © 2015 深圳市优易控软件有限公司 www.proutech.com |