生物指纹机通信协议汇总.docx

生物指纹机通信协议汇总.docx

《生物指纹机通信协议汇总.docx》由会员分享，可在线阅读，更多相关《生物指纹机通信协议汇总.docx（131页珍藏版）》请在冰豆网上搜索。

生物指纹机通信协议汇总

通讯协议

1.通讯相关的数据结构，其中设备采用的是小端模式（低位在前、高位在后。

例如WORD占用两个字节，其中低字节放在前面的内存空间，高字节放在内存的后面空间，这个与X86的CPU系统刚好相反）

Commandpacket

typedefstruct{

BYTEHead1;//55=STX1

BYTEHead2;//AA=STX2

WORDMachineID;//terminal’sID.

WORDReserved;//Reserved

WORDCommand;//CommandID

DWORDLength;//InputParameter1

WORDInParam;//InputParameter2

WORDChkSum;//Checksum

}CMDPKT;//14BYTE

Commandacknowledgepacket

typedefstruct{

BYTEHead1;//Alwaysis0x5A=STX1.

BYTEHead2;//Alwaysis0xA5=STX2.

WORDMachineID;//terminal’sID.

WORDResponse;//0x02-NAK,0x03-ACK.

WORDChkSum;//Checksum

}ACKPKT;//Sizeofcommandacknowledgepacketis8Bytes.

Commandexecutionresultpacket

typedefstruct{

BYTEHead1;//Alwaysis0xAA=STX1.

BYTEHead2;//Alwaysis0x55=STX2.

WORDMachineID;//terminal’sID.

WORDReserved;//Reserved

WORDRet;//1:

OK0:

Error

DWORDOutParam;//OutputParameter

WORDChkSum;//Checksum

}RESULTPKT;//Sizeofcommandexecutionresultpacketis14Bytes.

2.通信命令字;

enum

{

CMD_GET_ENROLL_DATA=0x101,//获取登记信息

CMD_SET_ENROLL_DATA,//下发登记信息

CMD_DELETE_ENROLL_DATA,//删除登记信息

CMD_SLOG_GET_COUNT,//获得管理记录总数

CMD_SLOG_GET,//获得管理记录

CMD_GLOG_GET_COUNT,//获得出入记录总数

CMD_GLOG_GET,//获取考勤记录

CMD_DEVICE_STATUS_GET,//获取设备状态

CMD_DEVICE_INFO_GET,//获取设备信息

CMD_DEVICE_INFO_SET,//设置设备信息

CMD_DISABLE_DEVICE,//禁止设备工作

CMD_ENABLE_DEVICE,//使能设备工作

CMD_ENABLE_USER,//禁止或者全能某用户权限

CMD_DEVICE_TIME_GET,//获取设备时间

CMD_DEVICE_TIME_SET,//同步设备时间

CMD_POWER_OFF,//设备关机

CMD_MODIFY_PRIVILIGE,//修改用户权限

CMD_READ_ALL_USERID,//获取用户列表

CMD_SERIAL_NUM_GET,//获取设备序列号

CMD_CLEAR_KEEPER_DATA,//清空所有数据（登记数据、记录数据）

CMD_BACKUP_NUM_GET,//获取设备备份号

CMD_PRODUCT_CODE_GET,//获取设备生产代码

CMD_ENROLL_DATA_EMPTY,//清空所有登记数据

CMD_GLOG_EMPTY,//清空所有出入记录

CMD_SLOG_EMPTY,//清空所有管理记录

CMD_USER_NAME_GET,//获取用户名字

CMD_USER_NAME_SET,//下发用户名字

CMD_COMPANY_NAME_GET,//获取公司名字

CMD_COMPANY_NAME_SET,//下发公司名字

CMD_DOOR_STATUS_GET,//获取门禁状态

CMD_DOOR_STATUS_SET,//修改门禁状态

CMD_BELLTIME_GET,//获取电铃设置

CMD_BELLTIME_SET,//下发电铃时间设置

CMD_BenumbAllManager,//将所有管理员变成普通用户

CMD_BACKUP_SERIAL_NUM_GET,//获取设备备份序列号

CMD_GBK_SET,//设备液晶对比度（只用于黑白屏机器）

CMD_GET_USERCTRL,//获取用户门禁权限信息

CMD_SET_USERCTRL,//设置用户门禁权限信息

CMD_DELETE_USERCTRL,//删除某用户门禁权限

CMD_CLEAR_USERCTRL,//清空所有用户门禁权限

CMD_GET_DAYPASSTIME,//获取天时段

CMD_SET_DAYPASSTIME,//设置天时段

CMD_GET_WEEKPASSTIME,//获取周时段

CMD_SET_WEEKPASSTIME,//设置周时段

CMD_GET_LOCKGROUP,//获取锁组合定义

CMD_SET_LOCKGROUP//设置锁组合定义

};

3.详细通讯功能介绍：

1.1、BOOLComGetEnrollData（CMDPKT*pCMD）

功能：

获取指纹信息

参数1：

登记号+备份号

参数2：

获取数据的类型：

1表示指纹2表示密码3表示感应卡

返回：

512字节的指纹数据

备注：

指纹数据数据结构

typedefstructtagENR_DATA

{

BYTEValid;

BYTEManager;

BYTEThreshold;

BYTEFingerNum;

DWORDID;

}ENR_DATA;/*8byte*/

typedefstruct_FP_ENROLL_STRUCT

{

UINT8cFlg;/*特征文件标志,当前有效值为0xcb*/

UINT8cType;/*特征文件类型,当前有效值为0x09*/

UINT8cNum;/*从5~50，指特征点个数。

UINT8cQuality;/*指特征的可靠度，从0~100

UINT8cCharInfoTab[240];/*特征信息表*/

//---------用户自定义信息开始于第244字节--------------------------------//

ENR_DATAUserInfo;

UINT32Reserve;/*备用*/

}FP_CHAR_ENROLL,*pFP_CHAR_ENROLL;

typedefstruct_FP_MB_ENROL_STRUCT

{

FP_CHAR_ENROLLCharFile1;

FP_CHAR_ENROLLCharFile2;

}FP_MB_ENROLL,*pFP_MB_ENROLL;//512字节

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_GET_ENROLL_DATA

命令

8

9

Nfp<<28+ENROID

输入参数1：

0~27位：

登记号；32~28位：

备份号（四个字节共32个BIT）

10

11

12

13

1

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error

结果

8

9

0

输出参数

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

数据回复（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0Xa5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

指纹数据（512字节）数据结构：

6

7

。

。

。

514

515

516

517

ChkSum

校验和（前面所有字节相加）

518

1.2、BOOLComGetEnrollData（CMDPKT*pCMD）

功能：

获取注册密码信息

参数1：

登记号

参数2：

获取数据的类型：

：

1表示指纹2表示密码3表示感应卡

返回：

登记号对应的密码

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_GET_ENROLL_DATA

命令

8

9

ENROID

输入参数：

登记号

10

11

12

13

2

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error

结果

8

9

0

输出参数

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

数据回复（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0Xa5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

密码数据（4字节）

6

7

8

9

ChkSum

校验和（前面所有字节相加）

10

1.3、BOOLComGetEnrollData（CMDPKT*pCMD）

功能：

获取感应卡信息

参数1：

登记号

参数2：

获取数据的类型：

：

1表示指纹2表示密码3表示感应卡

返回：

感应卡号

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_GET_ENROLL_DATA

命令

8

9

ENROID

登记号

10

11

12

13

3

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error

结果

8

9

0

权限0：

普通用户；1：

管理员；2：

超级用户

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

数据回复（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0Xa5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

感应卡数据（4字节）

5

6

7

8

ChkSum

校验和（前面所有字节相加）

9

2.1、BOOLComSetEnrollData（CMDPKT*pCMD）

功能：

下发指纹信息

参数1：

登记号

参数2：

获取数据的类型：

：

1表示指纹2表示密码3表示感应卡

返回：

成功1；失败0

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_SET_ENROLL_DATA

命令

8

9

Nfp<<28+ENROID

输入参数1：

0~27位：

登记号；32~28位：

备份号（四个字节共32个BIT）

10

11

12

13

1

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error

结果

8

9

2

输出参数

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

设置数据（PC----Controller）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0Xa5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

指纹数据（512字节）

6

7

。

。

。

。

514

515

516

517

ChkSum

校验和（前面所有字节相加）

518

2.2、BOOLComSetEnrollData（CMDPKT*pCMD）

功能：

下发注册密码信息

参数1：

登记号

参数2：

获取数据的类型：

：

1表示指纹2表示密码3表示感应卡

返回：

成功1；失败0

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_SET_ENROLL_DATA

命令

8

9

ENROID

输入参数：

登记号

10

11

12

13

2

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error

结果

8

9

0

输出参数

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

设置数据（PC----Controller）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0Xa5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

密码数据（4字节）

6

7

8

9

ChkSum

校验和（前面所有字节相加）

10

2.3、BOOLComSetEnrollData（CMDPKT*pCMD）

功能：

下发感应卡信息

参数1：

登记号

参数2：

获取数据的类型：

：

1表示指纹2表示密码3表示感应卡

返回：

成功1；失败0

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_SET_ENROLL_DATA

命令

8

9

ENROID

登记号

10

11

12

13

3

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error

结果

8

9

0

权限0：

普通用户；1：

管理员；2：

超级用户

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

数据回复（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0Xa5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

感应卡数据（4字节）

6

7

8

9

ChkSum

校验和（前面所有字节相加）

10

3、BOOLComDeleteEnrollData（CMDPKT*pCMD）

功能：

删除登记数据

参数1：

登记号+备份号（0~9）

参数2：

获取数据的类型：

：

1表示指纹2表示密码3表示感应卡

返回：

成功1失败0无数据：

2

对应协议：

命令发送（PC----Controller）

字节

值

含义

1

0x55

命令起始字节1，每个命令都一样

2

0xAA

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Reserved

6

7

CMD_DELETE_ENROLL_DATA

命令

8

9

指纹：

Nfp<<28+ENROID

密码：

ENROID

感应卡：

ENROID

指纹：

0~27位：

登记号；32~28位：

备份号（四个字节共32个BIT）

当为密码时：

登记号

当为感应卡时：

登记号

10

11

12

13

1

输入参数2：

1表示指纹2表示密码3表示感应卡

14

15

ChkSum

校验和（前面所有字节相加）

16

命令响应ACK（Controller----PC）

字节

值

含义

1

0x5A

命令起始字节1，每个命令都一样

2

0xA5

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0x00-NAK

0x01-ACK.

Response

6

7

ChkSum

校验和（前面所有字节相加）

8

命令回复结果（Controller----PC）

字节

值

含义

1

0xAA

命令起始字节1，每个命令都一样

2

0x55

命令起始字节2，每个命令都一样

3

1--255

设备ID

4

5

0

Response

6

7

1:

OK0:

Error2：

无数据

结果

8

9

0

无

10

11

12

13

ChkSum

校验和（前面所有字节相加）

14

4、BOOLComS