FPC1020指纹模块用户使用手册.docx

1、FPC1020指纹模块用户使用手册IDWD1020指纹识别模块用户手册IDWD1020 Fingerprint Module Users Guide(Ver 1.1)北京艾迪沃德科技发展有限公司http:/www.idworld.cc2014年6月 第二版(一)概述本文描述了IDWorld公司指纹识别模块的串口参数，通讯过程，指令/数据格式。本指令集适用于光学和面阵式半导体指纹传感器及滑动式指纹传感器。滑动式指纹传感器在采集图像（CMD_GET_IMAGE）时手指要有一个滑动操作过程，需要模块自身控制和判别滑动是否结束，因此增加了采集指纹超时（FP TimeOut）及取消采集指纹命令（CMD_

2、FP_CANCEL）。参数（FP TimeOut）及指令（CMD_FP_CANCEL）只适用于滑动指纹传感器通讯过程:所有指令的发送、接收必须要遵循一发一收的原则。主机（Host）在没有收到应答时，不可以向目标模块（TARGET ）发送指令。数据传送：数据以串行异步方式传送，第一位为起始位，其后是数据位。字节（Byte）遵循最低有效位优先传送的规则字（Word）遵循低字节优先高字节在后传送的规则。串行通讯所用参数如下：起始位：1位（1bit）数据位：8位 （8bit）停止位：1位（1bit）校验位：无波特率：9600/19200/38400/57600/115200/230400/460800

3、/921600 ，默认值：115200BPSIDWorld指纹识别模块所采用的指纹图像如下：分辨率：500DPI灰度： 256（8位）灰度像素大小：光学采集器：242*266 ；按压式半导体采集器：202*258；滑动式半导体采集器FPC1080：128*436；主要功能：不仅仅具有活体指纹注册入库（容量支持:1700/2000/3000），指纹验证（Verify）和识别（Identify），删除指定编号范围的指纹等常规功能外，还具有如下功能：1.上传指纹特征数据到主机，下载指纹特征数据到模块（入库/验证/识别）2.上传指纹图像到主机，下载指纹图像到模块（提取指纹特征入库/与活体指纹验证/识别

4、）3.检查指定编号范围内的已注册保存在模块闪存内的指纹模板数据是否有坏损情况4.设置/读取指纹模块的序列号(二)通讯协议2.1 通讯处理过程主机 H O S T 指纹模块 T A R G E T 图2-1 通讯过程注：通讯过程中，所有指令的发送、接收必须要遵循一发一收的原则。Host在没有收到应答时，不可以向 TARGET 发送指令。2.2 通讯包 Packet 的分类2.2.1命令包 Command packet命令包说明从 Host 至 Target 的指令内容。从 Host 中发出的所有指令，都通过命令包Command packet传输。命令包Command packet 的帧长度为 2

5、6字节bytes。2.2.2响应包 Response packet响应包指从 Target 至 Host 的应答内容。所有指令收到相应处理结果即Response packet 后终止其使命。响应包Response packet 的长度为 26字节byte 。2.2.3指令/响应的数据包 Data Packet当指令参数或响应数据的长度大于16byte时，利用指令/响应数据包Data Packet传输数据。Host须在发送指令数据包之前，利用命令包Command packet将数据包的长度告知模块Target指令参数或相应数据包的最大长度为 500byte2.3 通讯包的帧结构2.3.1通讯包P

6、arket识别代码通讯包Packet的开始 2byte 为表示通讯包packet种类的识别码，其如下表2-1：Packet类别Code包类别识别码命令包Command packet0xAA55响应包Response packet0x55AA指令数据包Command Data Packet0xA55A响应数据包Response Data Packet0x5AA5表2-1 Packet识别代码2.3.2命令包（Command packet ）的帧结构PREFIXSIDDIDCMDLENDATACKS0x550xAA源ID目标IDLHLHD0D1D15LH0123456789232425表2-2 命

7、令包（Command packet）的结构如下：偏移值OFFSET域定义FIELD数据类型TYPE字节数SIZE描述DESCRYPTION0PREFIXWORD2byte包识别码 Packet Identify code2SIDBYTE1byte源标识 Soruce Device ID3DIDBYTE1byte目标标识 Destination Device ID4CMDWORD2byte命令字 Command Code6LENWORD2byte (=n, n 16)数据长度 Length of DATA8DATAByte Array16byte命令参数 Command Parameter (实

8、际数据为 n byte)24CKSWORD2byte校验和 Check Sum：从PREFIX DATA 所有数据的算术和的最低2字节2.3.3响应包（Response packet）的帧结构PREFIXSIDDIDRCMLENRETDATACKS0x550xAA源ID目标IDLHLHLHD0D1D15LH01234567891011242526表2-3 响应包（Response packet）的结构如下：偏移值OFFSET域定义FIELD数据类型TYPE字节数SIZE描述DESCRYPTION0PREFIXWORD2byte包识别码 Packet Identify code2SIDBYTE1

9、byte源标识 Soruce Device ID3DIDBYTE1byte目标标识 Destination Device ID4RCMWORD2byte响应码 Response Code6LENWORD2byte(=n, n 16)长度 Length of RET and DATA8RETWORD2byte结果码 Result Code(0 :成功, 1 :失败)10DATAByte Array14byte响应数据 Response Data(实际为 n-2 byte)24CKSWORD2byte校验和 Check Sum：从PREFIX DATA 所有数据的算术和的最低2字节2.3.4指令数

10、据包（Command Data Packet）的帧结构PREFIXSIDDIDCMDLENDATACKS0x5A0xA5源ID目标IDLHLHD0D1Dn-1LH01234567898+n-18+n8+n+1表2-4 指令数据包（Command Data Packet）的结构如下：偏移值OFFSET域定义FIELD数据类型TYPE字节数SIZE描述DESCRYPTION0PREFIXWORD2byte包识别码 Packet Identify code2SIDBYTE1byte源标识 Source Device ID3DIDBYTE1byte目标标识 Destination Device ID4

11、CMDWORD2byte命令码 Command Code6LENWORD2byte(=n , n 500) 数据长度 Length of DATA8DATAByte Arraynbyte命令参数 Command parameter8+nCKSWORD2byte校验和 Check Sum：从PREFIX DATA 所有数据的算术和的最低2字节Host须在发送指令数据包之前先传输命令包（Command packet），使得模块Target 进入指令数据包（Command Data packet）接收等待状态。在该命令包（Command packet）的数据域（DATA field）中，须设定待传输

12、的指令数据包的长度。Host 应在确认Target 处于指令数据包接收等待状态后传输指令数据包（Command Data Packet）。2.3.5响应数据包（Response data packet）的帧结构PREFIXSIDDIDRCMLENRETDATACKS0xA50x5A源ID目标IDLHLHLHD0D1Dn-3LH012345678910118+n-18+n8+n+1表2-5 响应数据包（Response Data Packet）的结构如下：偏移值OFFSET域定义FIELD数据类型TYPE字节数SIZEDESCRYPTION0PREFIXWORD2byte包标识 Packet I

13、dentify code2SIDBYTE1byte源标识 Soruce Device ID3DIDBYTE1byte目标标识 Destination Device ID4CMDWORD2byte响应码 Response Code6LENWORD2byte(=n, n 500)结果接数据长度Length of result data (RET + DATA)8RETWORD2byte结果码 Result code(0 : 成功, 1 : 失败)10DATAByte Arrayn-2 byte响应数据 Response data8+nCKSWORD2byte校验和 Check Sum：从PREFI

14、X DATA 所有数据的算术和的最低2字节注：从模块Target 至 Host 中传输14byte以上数据时，需利用响应数据包（Response data packet）(三)通讯命令（Command ）综述3.1指纹特征模板(Template Record)的数据结构Template DataCheckSum496 byte2 byteTemplate DataTemplate Data 的每个字节的算术和的最低2字节.表3-1 Template Record的结构注：每个指纹特征模板数据为498字节：Template Data(496Bytes)+CheckSum(2Bytes)3.2命令

15、列表（ Command List ）序号No命令名称Command Name命令码Code命令功能Function1CMD_TEST_CONNECTION0x0001进行与设备的通讯测试2CMD_SET_PARAM0x0002设置设备参数 (Device ID, Security Level, Baudrate, Duplication Check, Auto Learn)3CMD_GET_PARAM0x0003获取设备参数 (Device ID, Security Level, Baudrate, Duplication Check, Auto Learn)4CMD_GET_DEVICE_I

16、NFO0x0004获取设备信息5CMD_ENTER_IAP_MODE0x0005将设备设置为 IAP状态6CMD_GET_IMAGE0x0020从采集器采集指纹图像并保存于 ImageBuffer 中7CMD_FINGER_DETECT0x0021检测指纹输入状态8CMD_UP_IMAGE0x0022将保存于 ImageBuffer 中的指纹图像上传至HOST9CMD_DOWN_IMAGE0x0023HOST下载指纹图像到模块的ImageBuffer 中10CMD_SLED_CTRL0x0024控制采集器背光灯的开/关（注：半导体传感器不用此功能）11CMD_STORE_CHAR0x0040将

17、指定编号Ram Buffer中的Template，注册到指定编号的库中12CMD_LOAD_CHAR0x0041读取库中指定编号中的Template到指定编号的 Ram Buffer13CMD_UP_CHAR0x0042将保存于指定编号的Ram Buffer 中的 Template 上传至HOST14CMD_DOWN_CHAR0x0043从HOST下载 Template到模块指定编号的 Ram Buffer 中15CMD_DEL_CHAR0x0044删除指定编号范围内的 Template 。16CMD_GET_EMPTY_ID0x0045获取指定范围内可注册的（没有注册的）第一个模板编号。17

18、CMD_GET_STATUS0x0046获取指定编号的模板注册状态。18CMD_GET_BROKEN_ID0x0047检查指定编号范围内的所有指纹模板是否存在坏损的情况19CMD_GET_ENROLL_COUNT0x0048获取指定编号范围内已注册的模板个数。20CMD_GENERATE0x0060将ImageBuffer 中的指纹图像生成模板数据，并保存于指定编号的 Ram Buffer 中。21CMD_MERGE0x0061将保存于Ram Buffer 中的两或三个模板数据融合成一个模板数据22CMD_MATCH0x0062指定 Ram Buffer 中的两个指纹模板之间进行 1:1 比对

19、23CMD_SEARCH0x0063指定 Ram Buffer 中的模板与指纹库中指定编号范围内的所有模板之间进行 1:N 比对24CMD_VERIFY0x0064指定 Ram Buffer 中的指纹模板与指纹库中指定编号的指纹模板之间进行 1:1比对25CMD_SET_MODULE_SN0x0008在设备中设置模块序列号信息（Module SN）26CMD_GET_MODULE_SN0x0009获取本设备的模块序列号（ Module SN）27CMD_FP_CANCEL0x0025取消指纹采集操作（只适用于带TimeOut参数的滑动传感器）28CMD_GET_ENROLLED_ID_LIST

20、0x0049获取已注册ID列表29CMD_ENTER_STANDY_STATE0x000C使模块进入休眠状态。(四)各通讯命令（Command）详细说明模块中含有指令通讯用的 ImageBuffer 和 Ram Buffer 。ImageBuffer： 用于保存图像。Ram Buffer 用于暂存指纹模板数据，模块共有三个 Ram Buffer ：Ram Buffer0，Ram Buffer1 和 Ram Buffer2 。注：断电情况下，ImageBuffer 和 Ram Buffer 中的数据会丢失。4.1连接测试（CMD_TEST_CONNECTION）功能 Function检查 Tar

21、get 和 Host 的连接状态。Host 需要首先发送此指令检查与 Target 的连接状态。若不成功，则可认为与 Target 的连接不正常，或 Target 的工作不正常，或波特率的设置有误。工作过程 Sequence连接正常，则返回 ERR_SUCCESS 。命令和响应Command and ResponsePREFIX0xAA55SIDSource Device IDDIDDestination Device IDCMD0x0001LEN0DATA无数据PREFIX0x55AASIDSource Device IDDIDDestination Device IDRCM0x0001LE

22、N2RETResult CodeDATA无数据表4-1 CMD_TEST_CONNECTION 指令4.1 例子：HOST发送 CMD_TEST_CONNECTION指令及模块的响应HOST命令： 55 AA 00 00 0100 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01Target响应：AA 55 01 00 010002000000 00 00 00 00 00 00 00 00 00 00 00 00 00 00 03 014.2设置参数（CMD_SET_PARAM）功能 Function根据指定 Parame

23、ter Type，设置设备参数（Device ID, Security Level, Baudrate, Duplication Check, Auto Learn，FP TimeOut）并返回其结果。工作过程 Sequence若指定 Parameter Type 无效，则返回ERR_INVALID_PARAM 。若指定 Parameter Value 无效，则返回 ERR_INVALID_PARAM 。根据 Parameter Type，设置 Parameter Value并返回其结果。命令和响应 Command and ResponsePREFIX0xAA55SIDSource Devic

24、e IDDIDDestination Device IDCMD0x0002LEN5DATA1bytesParameter Type4bytesParameter ValuePREFIX0x55AASIDSource Device IDDIDDestination Device IDRCM0x0002LEN2RETResult CodeDATA无数据表4-2 CMD_SET_PARAM 指令参数类型 Parameter TypeParameterTypeParameter ValueDescription0表示本设备编号（Device ID）。可设置 1 255 。1表示安全等级（Securit

25、y Level）：可设置值：15 。默认为：3Security Level 对应的识别率如下表：Security Level识别率Level 1认假率FAR（False Acceptance Rate）0.1%拒真率 FRR（False Rejection Rate）0.005%Level 2认假率FAR（False Acceptance Rate）0.003%拒真率 FRR（False Rejection Rate）001%Level 3认假率FAR（False Acceptance Rate）0.001 %拒真率 FRR（False Rejection Rate）0.1 %Level 4认

26、假率FAR（False Acceptance Rate）0.003%拒真率 FRR（False Rejection Rate）0.5%Level 5认假率FAR（False Acceptance Rate）0.0001%拒真率 FRR（False Rejection Rate）%2指纹重复检查（Duplication Check）状态开/关。可设置 0 或 1。若为 1 ，则处理 CMD_STORE_CHAR 指令时进行重复检测。若为 0 ，则不进行重复检测。3波特率（Baudrate）参数。可设置索引值： 1 8 。1:9600bps, 2:19200bps, 3:38400bps, 4:5

27、7600bps, 5:115200bps6:230400bps, 7:460800bps, 8:921600bps4表示指纹模板自学习（Auto Learn）状态开/关。可设置0 或 1 。若为 1 ：则处理 CMD_SEARCH, CMD_VERIFY 指令时进行智能更新。若为 0 ：则不进行智能更新。5表示采集指纹超时时间（ Fp TimeOut）参数，可设置值：1秒至60秒。CMD_GET_IMAGE指令中采用该参数，在FP TimeOUT 时间内等待指纹的输入。注：本参数只用于滑动指纹传感器模块，默认值为：5s4.2 例子：设置波特率为921600BPSHOST命令： 55 AA 00 00 020005000308000000 00 00 00 00 00 00 00 00 00 00 00 11 01Target响应：AA 55 01 00 020002000000 00 00 00 00 00 00 00 00 00 00 00 00 00 00 04 014.3读取参数（CMD_GET_PARAM）功能 F