TF-MD-M1指纹模块开发协议

《TF-MD-M1指纹模块开发协议》由会员分享，可在线阅读，更多相关《TF-MD-M1指纹模块开发协议（13页珍藏版）》请在装配图网上搜索。

1、深圳市十指科技有限公司 指纹开发模块手册 指纹模块开发协议 适用于：本协议适用于本公司TF-MD-M1指纹开发模块。一、 通信方式DSP模块作为从设备，由主设备发送相关命令对其进行控制。命令接口：UART（通用异步串口） 19200bps 1起始位 1停止位 （无校验位）主设备发送的命令及DSP模块的应答按数据长度可分为两类：1）= 8字节，数据格式如下： 字节12345678命令0xF5CMDP1P2P30CHK0xF5应答0xF5CMDQ1Q2Q30CHK0xF5说明：CMD：命令/应答类型P1，P2，P3：命令参数Q1，Q2，Q3：应答参数，Q3多用于返回操作的有效性信息，此时可有如下取

2、值：#define ACK_SUCCESS 0x00/操作成功#define ACK_FAIL 0x01/操作失败#define ACK_FULL 0x04/指纹数据库已满 #define ACK_NOUSER 0x05/无此用户#define ACK_USER_EXIST 0x07 /用户已存在#define ACK_TIMEOUT 0x08/采集超时CHK：校验和，为第2字节到第6字节的异或值2） 8字节，数据由两部分组成：数据头+数据包数据头格式：字节12345678命令0xF5CMDHi(Len)Low( Len)00CHK0xF5应答0xF5CMDHi(Len)Low(Len)Q30

3、CHK0xF5说明：CMD，Q3的定义同上Len：数据包内有效数据长度，16位，由两字节组成Hi(Len)：数据包长度高8位Low(Len)：数据包长度低8位CHK：校验和，为第2字节到第6字节的异或值数据包格式：字节12Len + 1Len + 2Len + 3命令0xF5DataCHK0xF5应答0xF5DataCHK0xF5说明：Len即为Data的字节数；CHK：校验和，为第2字节到第Len - 2字节的异或值发送完数据头后紧接着发送数据包。二、 命令类型21 使模块进入休眠状态（命令/应答均为8字节）命令数据格式：字节12345678命令0xF50x2C0000CHK0xF5应答数据

4、格式：字节12345678应答0xF50x2C0000CHK0xF522设置/读取指纹添加模式（命令/应答均为8字节）指纹添加分两种模式：允许重复模式/禁止重复模式, 在”禁止重复模式”下，同一枚手指只能添加一个用户，若强行进行第二轮添加将返回错误信息。上电后系统处于禁止重复模式。字节12345678命令0xF50x2D0Byte5=0：0：允许重复1：禁止重复 Byte5=1： 00：设置新的添加模式1：读取当前添加模式0CHK0xF5应答0xF50x2D0当前添加模式ACK_SUCCUSSACK_FAIL0CHK0xF523添加指纹（命令/应答均为8字节）为确保有效性，用户必须录入3次指纹

5、，主机须向DSP模块发送3次命令。i) 第1次字节12345678命令0xF50x01用户号（高8位）用户号（低8位）用户权限（1/2/3）0CHK0xF5应答0xF50x0100ACK_SUCCESSACK_FAILACK_FULLACK_TIMEOUT0CHK0xF5说明：用户号的取值范围为1 0xFFF；用户权限取值范围为1、2、3，其含义由二次开发者自行定义。ii) 第2次字节12345678命令0xF50x02用户号（高8位）用户号（低8位）用户权限(1/2/3)0CHK0xF5应答0xF50x0200ACK_SUCCESSACK_FAILACK_TIMEOUT0CHK0xF5iii

6、) 第3次字节12345678命令0xF50x03用户号（高8位）用户号（低8位）用户权限(1/2/3)0CHK0xF5应答0xF50x0300ACK_SUCCESSACK_FAILACK_USER_EXISTACK_TIMEOUT0CHK0xF5说明：三次命令中用户号与用户权限应为相同值。24删除指定用户（命令/应答均为8字节）字节12345678命令0xF50x04用户号（高8位）用户号（低8位）00CHK0xF5应答0xF50x0400ACK_SUCCESSACK_FAIL0CHK0xF525删除所有用户（命令/应答均为8字节）字节12345678命令0xF50x050000CHK0xF

7、5应答0xF50x0500ACK_SUCCESSACK_FAIL0CHK0xF526取用户总数（命令/应答均为8字节）字节12345678命令0xF50x090000CHK0xF5应答0xF50x09用户数（高8位）用户数（低8位）ACK_SUCCESSACK_FAIL0CHK0xF527比对1：1（命令/应答均为8字节）字节12345678命令0xF50x0B用户号（高8位）用户号（低8位）00CHK0xF5应答0xF50x0B00ACK_SUCCESSACK_FAILACK_TIMEOUT0CHK0xF528比对1：N（命令/应答均为8字节）字节12345678命令0xF50x0C0000

8、CHK0xF5应答0xF50x0C用户号（高8位）用户号（低8位）用户权限(1/2/3)ACK_NOUSERACK_TIMEOUT0CHK0xF529取用户权限（命令/应答均为8字节）字节12345678命令0xF50x0A用户号（高8位）用户号（低8位）00CHK0xF5应答0xF50x0A00用户权限(1/2/3)ACK_NOUSER0CHK0xF5210取DSP模块版本号（命令为8字节/应答8字节）命令数据格式：字节12345678命令0xF50x260000CHK0xF5应答数据格式：1） 数据头：字节12345678应答0xF50x26Hi(Len)Low(Len)ACK_SUCCE

9、SSACK_FAIL0CHK0xF52） 数据包：字节12 - Len + 1Len + 2Len + 3应答0xF5版本数据CHK0xF5说明：此协议暂不公开211设置/读取比对等级（命令/应答均为8字节）字节12345678命令0xF50x280Byte5=0：新比对等级；Byte5=1： 00：设置新的比对等级1：读取当前比对等级0CHK0xF5应答0xF50x280当前比对等级ACK_SUCCUSSACK_FAIL0CHK0xF5说明：比对等级取值为0-9，取值越大比对越严格，默认值为5212采集图像并上传（命令为8字节/应答8字节）命令数据格式：字节12345678命令0xF50x2

10、40000CHK0xF5应答数据格式：1) 数据头：字节12345678应答0xF50x24Hi(Len)Low(Len)ACK_SUCCESSACK_FAILACK_TIMEOUT0CHK0xF52) 数据包：字节12 - Len + 1Len + 2Len + 3应答0xF5图像数据CHK0xF5说明：在DSP模块中，指纹图像为280*280像素，每个像素灰度由8位表示。在上传过程中，为了减小数据量，在横/纵方向进行跳像素采样，这样图像变为140*140，并取灰度的高4位，每两个像素合成一个字节传输（前一像素在低四位，后一像素在高四位）。传输从第一行开始逐行进行，每一行从第一个像素开始，总

11、共传输140*140/2个字节的数据。图像数据长度Len恒为9800字节。213采集图像并提取特征值上传（命令为8字节/应答8字节）命令数据格式：字节12345678命令0xF50x230000CHK0xF5应答数据格式：1） 数据头：字节12345678应答0xF50x23Hi(Len)Low(Len)ACK_SUCCESSACK_FAILACK_TIMEOUT0CHK0xF52） 数据包：字节12345 - Len + 1Len + 2Len + 3应答0xF5000特征值数据CHK0xF5说明：特征值数据长度Len - 3恒为193字节。214下传特征值与采集指纹比对（命令8字节/应答为

12、8字节）命令数据格式：1） 数据头：字节12345678命令0xF50x44Hi(Len)Low(Len)00CHK0xF52） 数据包：字节12345 - Len + 1Len + 2Len + 3命令0xF5000特征值数据CHK0xF5说明：特征值数据长度Len - 3恒为193字节。应答数据格式：字节12345678应答0xF50x4400ACK_SUCCESSACK_FAILACK_TIMEOUT0CHK0xF5215下传指纹特征值与DSP模块数据库指纹比对1：1（命令8字节/应答为8字节）命令数据格式：1） 数据头：字节12345678命令0xF50x42Hi(Len)Low(Le

13、n)00CHK0xF52） 数据包：字节12345 - Len + 1Len + 2Len + 3命令0xF5用户号（高8位）用户号（低8位）0特征值数据CHK0xF5说明：特征值数据长度Len - 3恒为193字节。应答数据格式：字节12345678应答0xF50x4200ACK_SUCCESSACK_FAIL0CHK0xF5216下传指纹特征值与DSP模块数据库指纹比对1：N（命令8字节/应答为8字节）命令数据格式：1） 数据头：字节12345678命令0xF50x43Hi(Len)Low(Len)00CHK0xF52） 数据包：字节12345 - Len + 1Len + 2Len +

14、3命令0xF5000特征值数据CHK0xF5说明：特征值数据长度Len - 3恒为193字节。应答数据格式：字节12345678应答0xF50x43用户号（高8位）用户号（低8位）用户权限(1/2/3)ACK_NOUSER0CHK0xF5217上传DSP模块数据库内指定用户特征值（命令为8字节/应答8字节）命令数据格式：字节12345678命令0xF50x31用户号（高8位）用户号（低8位）00CHK0xF5应答数据格式：1）数据头：字节12345678应答0xF50x31Hi(Len)Low(Len)ACK_SUCCESSACK_FAILACK_NOUSER0CHK0xF52） 数据包：字节

15、12345 - Len + 1Len + 2Len + 3应答0xF5用户号（高8位）用户号（低8位）用户权限(1/2/3)特征值数据CHK0xF5说明：特征值数据长度Len - 3恒为193字节。218下传特征值并按指定用户号存入DSP模块数据库（命令8字节/应答为8字节）命令数据格式：1) 数据头：字节12345678命令0xF50x41Hi(Len)Low(Len)00CHK0xF52) 数据包：字节12345- Len + 1Len + 2Len + 3命令0xF5用户号（高8位）用户号（低8位）用户权限(1/2/3)特征值数据CHK0xF5说明：特征值数据长度Len - 3恒为193

16、字节。应答数据格式：字节12345678应答0xF50x4100ACK_SUCCESSACK_FAIL0CHK0xF5219 取已登录所有用户用户号及权限（命令为8字节/应答8字节）命令数据格式：字节12345678命令0xF50x2B0000CHK0xF5应答数据格式：1）数据头：字节12345678应答0xF50x2BHi(Len)Low(Len)ACK_SUCCESSACK_FAIL0CHK0xF52）数据包：字节1234 - Len + 1Len + 2Len + 3应答0xF5用户数（高8位）用户数（低8位）用户信息数据（用户号及权限）CHK0xF5说明：数据包中数据长度Len恒为

17、”3 * 用户数 + 2”。用户信息数据格式如下:字节456789数据用户号1(高8位)用户号1(低8位)用户1权限(1/2/3)用户号2(高8位)用户号2(低8位)用户2权限(1/2/3)220 取单条记录数据（命令为8字节/应答8字节）- 注: 此协议模块内暂不提供此协议返回记录库中由“记录位置”指定的记录数据。命令数据格式：字节12345678命令0xF50x38记录位置（高8位）记录位置（低8位）00CHK0xF5应答数据格式：1）数据头：字节12345678应答0xF50x38Hi(Len)Low(Len)ACK_SUCCESSACK_FAIL0CHK0xF52）数据包：字节1234

18、5应答0xF5位7-1：年位0：月（位3）位7-5：月（位2-0）位4-0：日位7-2：时位1-0：分（位5-4）位7-4：分（位3-0）位3-0：记录号(位21-18)字节67891011应答记录号（位17-10）记录号（位9-2）位7-6：记录号（位1-0）位5-0：用户号(位13-8)用户号（位7-0）CHK0xF5说明：记录数据长度Len恒为8；221 取新记录数据（命令为8字节/应答8字节）- 注: 此协议模块内暂不提供此协议返回记录库中记录号大于等于“最小记录号”的接续50条记录数据。命令数据格式：字节12345678命令0xF50x39位7-6：0位5-0：最小记录号（位21-1

19、6）最小记录号（位15-8）最小记录号(位7-0)0CHK0xF5应答数据格式：1）数据头：字节12345678应答0xF50x39Hi(Len)Low(Len)ACK_SUCCESSACK_FAIL0CHK0xF52）数据包：字节12-910-17Len + 2Len + 3应答0xF5第1条记录第2条记录CHK0xF5说明：数据包中的每条记录格式同220中应答数据包中字节2-字节9。数据长度Len恒为（8 * 50 = 400字节）。222 清空记录数据（命令/应答均为8字节）- 注: 此协议模块内暂不提供字节12345678命令0xF50x3A0000CHK0xF5应答0xF50x3A0

20、0ACK_SUCCESSACK_FAIL0CHK0xF5223 设置模块时间（命令8字节/应答为8字节）- 注: 此协议模块内暂不提供命令数据格式：1） 数据头：字节12345678命令0xF50x48Hi(Len)Low(Len)00CHK0xF52） 数据包：字节12345678910命令0xF5星期年月日时分秒CHK0xF5说明：时间数据长度Len恒为7。应答数据格式：字节12345678应答0xF50x4800ACK_SUCCESSACK_FAIL0CHK0xF5224 读取系统时间 - 注: 此协议模块内暂不提供命令数据格式：字节12345678命令0xF50x3C0000CHK0x

21、F5应答数据格式：1）数据头：字节12345678应答0xF50x3CHi(Len)Low(Len)ACK_SUCCESSACK_FAIL0CHK0xF52）数据包：字节12345678910应答0xF5星期年月日时分秒CHK0xF5说明：时间数据长度Len恒为7。225设置/读取指纹采集等待超时时间（命令/应答均为8字节）字节12345678命令0xF50x2E0Byte5=0：新超时时间；Byte5=1： 00：设置新的超时时间1：读取当前超时时间0CHK0xF5应答0xF50x2E0当前超时时间ACK_SUCCUSSACK_FAIL0CHK0xF5说明：指纹等待超时时间（tout）范围为 0-255。若此值为0，若无指纹按压则指纹采集过程将一直持续；若此值非0，在tout * T0时间内若无指纹按压则系统将超时退出。注：T0为采集/处理一幅图像所需的时间，一般为0.2-0.3s。第 13 页 共 13 页