| ProCon说明 快速入门 运动控制 EtherCAT 实时程序 API函数 控件库 硬件说明 问题排查 示例代码 |
| 函数 | YK_API YKM_GetVersion(int *version) | |
| 功能 | 获取当前库版本 | |
| 参数 | version |
[IN] 当前版本号 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YK_API YKM_LoadLib() | |
| 功能 | 打开和实时服务(ProR)之间的通讯通道 | |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 使用控制函数前必先调用本函数执行初始化工作。 | |
| 函数 | YK_API YKM_UnloadLib() | |
| 功能 | 释放系统资源，程序退出时调用 | |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 应用程序退出时调用 | |
| 函数 | YK_API YKM_SetAppTimeout(UINT32 tim) | |
| 功能 | 设置应用程序心跳超时时间 | |
| 参数 | tim |
[IN] 毫秒单位 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 系统在设定时间内未检测到应用程序心态则停止轴运动及关闭输出；可防止应用程序异常关闭后，导致机器处于失控状态。由于windows的进程调度时间的不确定性，超时时间建议设在1s以上。 | |
| 函数 | YK_API YKM_SetLogLevel(UINT32 level) | |
| 功能 | 设置操作日志等级 | |
| 参数 | level |
[IN] 0=不记录 1=记录写操作(不包括数字输出) 2=记录写操作(包括数字输出) 3=记录错误操作 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 日志放在应用程序当前目录下，文件名为“yklog2.txt”。 | |
| 函数 | YK_API YKM_GetLogLevel(UINT32 *level) | |
| 功能 | 获取操作日志等级 | |
| 参数 | level |
[IN] 0=不记录 1=记录写操作(不包括数字输出) 2=记录写操作(包括数字输出) 3=记录错误操作 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YKM_SetLogFile(Byte[] filename) | |
| 功能 | 设置日志文件名称，包括路径 | |
| 参数 | filename |
[IN] 文件路径及名称 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | Windows下有效；notime下的日志存放在应用程序当前目录，文件名称ykcat2_notime.txt | |
| 函数 | YK_API YKM_GetSysConfig(YKM_SysConfig *config) | |
| 功能 | 获取系统配置信息 | |
| 参数 | config |
[IN] 配置 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YK_API YKM_GetSysWarn(char* buff, UINT32 buffSize, UINT32* num) | |
| 功能 | 获取当前报警信息 | |
| 参数 | buff buffSize num |
[IN] 缓冲区，不小于2048字节 [IN] 缓冲区尺寸 [IN] 报警数量 |
| 返回值 | 错误代码 | |
| 说明 | 缓存区指令 | |
| 注意事项 | C#程序可调用TransWarns函数解析成字符串 | |
| 函数 | YK_API YKM_GetSysLog(char* buff, UINT32 buffSize) | |
| 功能 | 获取系统日志 | |
| 参数 | buff buffSize |
[IN] 缓冲区，不小于2048字节 [IN] 缓冲区尺寸 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效。 | |
| 注意事项 | C#程序可调用TransLog函数解析成字符串 | |
| 函数 | YK_API YKM_ClearSysLog() | |
| 功能 | 清除缓存中的日志 | |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 在频繁热复位过程中会产生许多过程信息，如果不想查看，可以看调用此函数清除 | |
| 函数 | YK_API YKM_SetLoadFlag(UINT32 enable) YK_API YKM_SetLoadFlagEx(YKM_NODE master, UINT32 enable) |
|
| 功能 | 设置配置文件加载标记；启用后，在热复位之前先从本地配置文件加载数据，加载完成后清除本标记 | |
| 参数 | master enable |
[IN] 主站选择 [IN] 0=禁用 1=启用 |
| 返回值 | 错误代码 | |
| 说明 | 在下次热复位时生效；启用后，在热复位之前先从本地配置文件加载数据，加载完成后清除本标记 | |
| 注意事项 | 默认只在实时服务启动时从本地文件读取配置，之后热复位过程中不会再从本地文件读取配置。如果应用程序需要根据不同设备型号自动选择不同配置，则调用此函数后更新配置文件，再执行热复位命令。 | |
| 函数 | YK_API YKM_GetLoadFlag(UINT32* enable) YK_API YKM_GetLoadFlagEx(YKM_NODE master, UINT32* enable) |
|
| 功能 | 读取配置文件加载标记 | |
| 参数 | master enable |
[IN] 主站选择 [IN] 返回值 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YK_API YKM_SetRuntimeStatus(UINT32 run_stop) YK_API YKM_SetRuntimeStatusEx(YKM_NODE master, UINT32 run_stop) |
|
| 功能 | 设置runtime运行状态 | |
| 参数 | master run_stop |
[IN] 主站选择 [IN] 0=停止(轴会停止，输出会关闭) 1=运行 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YK_API YKM_GetRuntimeStatus(UINT32* status) YK_API YKM_GetRuntimeStatusEx(YKM_NODE master, UINT32* status) |
|
| 功能 | 获取runtime运行状态 | |
| 参数 | master status |
[IN] 主站选择 [IN] 0=停止 1=运行 2=过渡状态 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YK_API YKM_WarmReset() YK_API YKM_WarmResetEx(YKM_NODE master) |
|
| 功能 | 热复位热复位节点A。复位runtime，轴运动停止，关输出。 热复位。复位runtime，轴运动停止，关输出。复位A节点时,默认复位其他节点 |
|
| 参数 | master |
[IN] 主站选择 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 复位runtime，轴运动停止，关输出；不会清除IO滤波参数； | |
| 函数 | YK_API YKM_ColdReset() | |
| 功能 | 冷复位 | |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | 此动作会重启实时系统和Runtime | |
| 函数 | YKM_SetSysProfile(YKM_GlobalProfile config) | |
| 功能 | 设置全局配置，未实现 | |
| 参数 | config | 配置参数 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| 函数 | YKM_SetSysProfile(YKM_GlobalProfile config) | |
| 功能 | 获取全局配置，未实现 | |
| 参数 | config | 配置参数 |
| 返回值 | 错误代码 | |
| 说明 | 调用后立即生效 | |
| 注意事项 | ||
| Copyright © 2015 深圳市优易控软件有限公司 www.proutech.com |