金天鹅门禁接口说明V12

金天鹅门禁接口说明V12

接口说明

一、文件说明

JKXYLOCK.dll 门锁接口文件，此文件需要拷贝至应用程序工作目录下

XYID.dll 门锁接口环境支持文件，此文件需要拷贝至应用程序工作目录下JKDemo.exe 接口演示程序文件

VBDemo.rar 接口演示源程序Visual Basic 6.0 JKTool.exe 获取门锁软件中的门锁编码及接口授权

二、接口步骤

1. 电脑环境应正常安装门锁软年，并且门锁软件已正常工作;

2. 运行JKTool.exe 文件，按[取门锁编码]获取房号与门锁编码，房号及其对应关系保

存在文件XYLockCode.txt 中，此文件可给开发人员参考使用。文件中房号等于后

面的就是门锁编码，写卡时需要正确传入此编码;

3. 在JKTool 工具程序窗口中按读授权卡，此时放置授权卡，再按[ 读授权卡] 按钮，然

后将显示的信息码报给软件供应商，获取注册码，注册码成功后就可进行接口

开发

工作。

4. 可以开始看接口函数及写代码了。

三、接口函数说明

1. int JK_XYOpenCom(int p_nPort);

功能: 打开卡机的通讯端口

参数:p-nPort 表通讯端口号，值为0-255; 建议用函数JK_XYScanReaderPort 返回的

卡机端口号，直接传入就可以了。

返回: 参考错误代码说明。

注意: 打开端口后，在不需要读写卡时请关闭端口。

2. int JK_XYCloseCom(void);

功能: 关闭卡机的通讯端口

参数:无

返回: 参考错误代码说明。

注意: 完成读写卡后，请调用此函数关闭端口。

3. int JK_XYScanReaderPort(int &p_nComPort,int &p_nReaderID);

功能: 自动扫描当前插入的读卡机，并返回通讯端口及卡机类型

参数:p_ nComPort 返回的读卡机所在的端口号，此端口号可供JK_XYOpenCom 函

数使用，p_nReaderID返回的卡机类型，1-表示T57卡卡机，2-表示M1卡卡机返回: 参考错误代码说明。

4. int JK_XYReadGuestCard(LPSTR p_csRoomNo,LPSTR p_csStartTime,int

&p_nTimeUnit,int &p_nTimeLength,int &p_nStopFlag,LPSTR p_csCardNo);

功能: 读客人卡，此函数只能读客人卡

参数:

p_csRoomNo返回客人卡的门锁编码，此门锁编码独立于接口使用，用户软件不

要去管理它;

p_csStartTime 客人卡开门的起始时间，格式为YYMMDD，HH如12112718 表示2012年11月27日18时;

p_nTimeUnit 有效开门的时间单位，0- 以小时为单位，1- 以天为单位，2-以- 以年为单位; 月为单位，3

p_nTimeLength 开门的有效时间，以小时为单位时此值范围为1-63, 以天为单

位时此值范围为1-63, 以月为单位时此值范围为1-15, 以年为单位时此值范围为1-3;

p_nStopFlag 挂失旧的客人卡标志，0- 表示不挂失旧客人卡，1-表示能挂失旧

的客人卡。

p_csCardNo 此客人卡的卡号，卡号由接口自动生成，卡号值是与起始时间有

关系的。

返回: 参考错误代码说明。

5. int JK_XYWriteGuestCard(LPSTR p_csRoomNo,LPSTR p_csStartTime,int

p_nTimeUnit,int p_nTimeLength,int p_nStopFlag,LPSTR p_csCardNo);

功能: 写客人卡，此函数只能发行客人卡

参数:

p_csRoomNo客人卡的门锁编码，此门锁编码独立于接口使用，用户软件不要

去管理它，此门锁编码可以从读客人卡函数中返回，也可以用JKTool.exe 工具程

序一次性获取房号对应的门锁编码;

p_csStartTime 客人卡开门的起始时间，格式为YYMMDD，HH如12112718 表

示2012年11月27日18时;

p_nTimeUnit 有效开门的时间单位，0- 以小时为单位，1- 以天为单位，2-以

月为单位，3- 以年为单位;

p_nTimeLength 开门的有效时间，以小时为单位时此值范围为1-63, 以天为单位时此值范围为1-63, 以月为单位时此值范围为1-15, 以年为单位时此值范围为

1-3;

p_nStopFlag 挂失旧的客人卡标志，0- 表示不挂失旧客人卡，1-表示能挂失旧的客人卡。

p_csCardNo 此客人卡的卡号，卡号由接口自动生成，卡号值是与起始时间有

关系的。写卡完成后即返回此卡的最新卡号。

返回: 参考错误代码说明。

6. int JK_XYClearGuestCard(void); 功能: 清空客人卡，也就可客人卡退房。

参数:无

返回: 参考错误代码说明。

四、错误代码说明

错误代码错误说明备注没有找到卡机检查卡机有否正确插入电脑的USB口20

读卡机型号不对21 没有找到可用的卡片需要正确放置在卡机的感应区22比对卡片密码错误23 读卡失败放好卡后不要触碰卡，直至写卡完成24

写卡失败放好卡后不要触碰卡，直至写卡完成25

卡机错误不能正确读写卡机26

门锁接口授权错误必须使用正确授权的卡机，包括厂家授权及27 读授权卡授权。

门锁接口授权失败必须使用正确授权的卡机，包括厂家授权及28 读授权卡授权。