ProCon说明 快速入门 运动控制 EtherCAT 实时程序 API函数 控件库 硬件说明 问题排查 示例代码 |
函数 | YK_API YKM_SetCommandEquiv(UINT32 axisIndex, UINT32 dist, UINT32 pulse) YK_API YKM_GetCommandEquiv(UINT32 axisIndex, UINT32 *dist, UINT32 *pulse) |
|
功能 | 设置(获取)规划方向的当量;初始化完成后先设置当量,再使用和当量有关的函数 | |
参数 | axisIndex dist pulse |
[IN] 轴序号 [IN] 位移当量,整数格式 [IN] 脉冲当量,整数格式 |
返回值 | 错误代码 | |
说明 | 更新后不需要进行热复位,轴busyoff状态即生效 | |
注意事项 | 建议在ProEn里面设置 |
函数 | YK_API YKM_SetCommandEquivEx(UINT32 axisIndex, double dist, double pulse) YK_API YKM_GetCommandEquivEx(UINT32 axisIndex, double *dist, double *pulse) |
|
功能 | 设置(获取)规划方向的当量;初始化完成后先设置当量,再使用和当量有关的函数 | |
参数 | axisIndex dist pulse |
[IN] 轴序号 [IN] 位移当量,浮点格式 [IN] 脉冲当量,浮点格式 |
返回值 | 错误代码 | |
说明 | 更新后不需要进行热复位,轴busyoff状态即生效 | |
注意事项 | 建议在ProEn里面设置 |
函数 | YK_API YKM_SetFeedbackEquiv(UINT32 axisIndex, UINT32 dist, UINT32 pulse) YK_API YKM_GetFeedbackEquiv(UINT32 axisIndex, UINT32 *dist, UINT32 *pulse) |
|
功能 | 设置(获取)反馈方向的当量(已弃用) | |
参数 | axisIndex dist pulse |
[IN] 轴序号 [IN] 位移当量,整数格式 [IN] 脉冲当量,整数格式 |
返回值 | 错误代码 | |
说明 | 当量值变化后需要热复位生效 | |
注意事项 | 对于半闭环系统,设为和YKM_SetCommandEquiv一样或者0,默认值是0。 对于全闭环系统,根据光栅尺换算 |
函数 | YK_API YKM_SetFeedbackEquivEx(UINT32 axisIndex, double dist, double pulse) YK_API YKM_GetFeedbackEquivEx(UINT32 axisIndex, double *dist, double *pulse) |
|
功能 | 设置(获取)反馈方向的当量(已弃用) | |
参数 | axisIndex dist pulse |
[IN] 轴序号 [IN] 位移当量,浮点格式 [IN] 脉冲当量,浮点格式 |
返回值 | 错误代码 | |
说明 | 当量值变化后需要热复位生效 | |
注意事项 | 对于半闭环系统,设为和YKM_SetCommandEquivEx一样 对于全闭环系统,根据光栅尺换算 |
函数 | YK_API YKM_SetSoftLimit(UINT32 axisIndex, double limit_p, double limit_n) YK_API YKM_GetSoftLimit(UINT32 axisIndex, double* limit_p, double* limit_n) |
|
功能 | 设置(获取)软限位,自动启用 | |
参数 | axisIndex limit_p limit_n |
[IN] 轴序号 [IN] 正方向最大值 单位unit [IN] 负方向最大值 单位unit |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 软限位停止的减速度采用的是软限位减速度,可以在轴参数配置YKM_SetAxisProfile中设置 |
函数 | YK_API YKM_SetSoftLimitEx(UINT32 axisIndex, YKM_SoftLimitConfig config) YK_API YKM_GetSoftLimitEx(UINT32 axisIndex, YKM_SoftLimitConfig* config) |
|
功能 | 软限位开/关设置 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 限位配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetStopConfig(UINT32 axisIndex, YKM_StopConfig config) YK_API YKM_GetStopConfig(UINT32 axisIndex, YKM_StopConfig* config) |
|
功能 | 设置(获取)停止信号配置 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] DI选择 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 轴运动过程中,如果DI有效,则自动减速停止。 |
函数 | YK_API YKM_ReadCommandPosition(UINT32 axisIndex, double* position) | |
功能 | 获得规划位置 | |
参数 | axisIndex position |
[IN] 轴序号 [IN] 位置,单位unit |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_ReadActualPosition(UINT32 axisIndex, double *position) | |
功能 | 获得实际位置 | |
参数 | axisIndex position |
[IN] 轴序号 [IN] 位置,单位unit |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 对于总线轴(带编码器),读取的是编码器反馈 对于总线轴(不带编码器),读取的是驱动器实际发送给电机的脉冲数量 对于脉冲轴,读取的是实际发送给驱动器的脉冲数量 |
函数 | YK_API YKM_ReadRawPosition(UINT32 axisIndex, INT32* position) | |
功能 | 获取轴的原始位置 | |
参数 | axisIndex position |
[IN] 轴序号 [IN] 位置,单位unit |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_ReadCommandVelocity(UINT32 axisIndex, double* velocity) | |
功能 | 获得规划速度 | |
参数 | axisIndex velocity |
[IN] 轴序号 [IN] 速度值,unit/s |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_ReadActualVelocity(UINT32 axisIndex, double *velocity) | |
功能 | 获得实际速度 | |
参数 | axisIndex velocity |
[IN] 轴序号 [IN] 速度值,unit/s |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_ReadCommandTorque(UINT32 axisIndex, double* torque) | |
功能 | 获得给定转矩 | |
参数 | axisIndex torque |
[IN] 轴序号 [IN] 转矩值 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 需要在PDO中配置转矩对象字典 |
函数 | YK_API YKM_ReadActualTorque(UINT32 axisIndex, double *torque) | |
功能 | 获得实际转矩 | |
参数 | axisIndex torque |
[IN] 轴序号 [IN] 转矩值 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 需要在PDO中配置转矩对象字典 |
函数 | YK_API YKM_ReadAxisInfo(UINT32 axisIndex, YKM_AxisStatus *info) | |
功能 | 读轴状态 | |
参数 | axisIndex info |
[IN] 轴序号 [IN] 状态参考 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_ReadAxisStatus(UINT32 axisIndex, YKM_AxisStatus* info) | |
功能 | 读轴状态 | |
参数 | axisIndex info |
[IN] 轴序号 [IN] 状态参考 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetAxisProfile(UINT32 axisIndex, YKM_AxisProfile config) | |
功能 | 轴公共参数设置 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_GetAxisProfile(UINT32 axisIndex, YKM_AxisProfile *info) | |
功能 | 读轴状态 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetAxisProfileInp(UInt32 axisIndex, YKM_AxisProfileInp config) | |
功能 | 设置轴到位配置 | |
参数 | axisIndex config |
[IN] 轴序号 [IN] 到位配置 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 由于轴序号用户可设置,所以读取的编号可能不是连续的。 |
函数 | YK_API YKM_GetAxisList(UINT32* axisNum, UINT32* axisList, UINT32 buffSize =1024) | |
功能 | 获得轴使用列表 | |
参数 | axisNum axisList axisNum |
[IN] 返回值,轴数量 [IN] 轴序号列表 [IN] axisList缓冲区大小,至少256 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 由于轴序号用户可设置,所以读取的编号可能不是连续的。 |
函数 | YK_API YKM_SetAxisMode(UINT32 axisIndex, YKM_CIA402Mode mode) | |
功能 | 设置轴的运动模式,总线轴专用 | |
参数 | axisIndex mode |
[IN] 轴序号 [IN]CoE运动模式 |
返回值 | 错误代码 | |
说明 | 模式切换需要N个总线周期,和驱动器相关;待模式切换完成后再进行其他运动。 | |
注意事项 | 高创驱动器切换模式时请先去使能,待模式切换完成后再使能 |
函数 | YK_API YKM_GetAxisMode(UINT32 axisIndex, YKM_CIA402Mode*mode) | |
功能 | 获取轴的运动模式,总线轴专用 | |
参数 | axisIndex mode |
[IN] 轴序号 [IN] CoE运动模式 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetWarnMask(UINT32 axisIndex, UINT32 mask) | |
功能 | 设置轴报警屏蔽配置 | |
参数 | axisIndex mask |
[IN] 轴序号 [IN] 屏蔽配置,按位定义 BIT0=硬限位 BIT1=DI有效停止 BIT2=软限位 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 | 设置轴对应屏蔽功能后,轴状态YKM_AxisStatus报警信号将不会触发 屏蔽限位报警功能,只屏蔽运动过程中碰到限位,体现在有无当前报警,在限位状态启动,函数返回还是会报错的 |
函数 | YK_API YKM_GetWarnMask(UInt32 axisIndex, out UInt32 mask) | |
功能 | 获取轴报警屏蔽配置 | |
参数 | axisIndex mask |
[IN] 轴序号 [IN] 屏蔽配置,按位定义 BIT0=硬限位 BIT1=DI有效停止 BIT2=软限位 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_GetAxisAlias(UINT32 axisIndex, char *name, UINT32 buffSize = 64) | |
功能 | 获取轴名称,名称在ProEn中设置 | |
参数 | slaveIndex name buffSize |
[IN] 轴序号 [IN] 返回名称,至少分配64字节 [IN] name缓冲区尺寸 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_ClearAxisHome(UINT32 axisIndex) | |
功能 | 回原点状态清除(YKM_AxisStatus.IsHomed) | |
参数 | axisIndex |
[IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
函数 | YK_API YKM_SetAxisHome(UINT32 axisIndex) | |
功能 | 设置轴的回原点状态(YKM_AxisStatus.IsHomed) | |
参数 | axisIndex |
[IN] 轴序号 |
返回值 | 错误代码 | |
说明 | 调用后立即生效 | |
注意事项 |
Copyright © 2015 深圳市优易控软件有限公司 www.proutech.com |