Professional Documents
Culture Documents
Fingerprint Module Product User Manual - V1.8
Fingerprint Module Product User Manual - V1.8
Fingerprint Module Product User Manual - V1.8
信
智
河
长
杭州长河智信科技有限公司
指纹模组产品用户手册
Statement
The following documents contain Hangzhou chang he zhi xin technology co., LTD. (hereinafter referred
to as chang he) of private information, in the absence of chang he formal permission, a third party shall not use
or leaked, any without authorization, special conditions, restrictions or inform in the case of the information
copy and modification is infringement.
At any time, chang he has the right to change, add, delete, improve and any other changes to its products
and services without informing any party. chang he shall not bear any responsibility or obligation in the use of
the Company's products; and a third party shall not infringe any patent or other intellectual property rights in the
use.
The sale of all products is subject to the terms and conditions of sale of the Company in the purchase
admission. The company uses testing, tools, quality control and other technical means to support the relevant
performance of the product to meet the required specifications. There is no need to perform all parameter tests for
each product, except for explicit written government requirements. If the product is damaged or unable to use
信
normally due to the improper use, the customer shall bear the responsibility himself.
Except for chang he's logo design, all other trademarks or registered trademarks belong to their respective
智
owners.
Hangzhou chang he Security Technology Co., Ltd. 20052020 © copyright. Copyright, the
河
I J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Contact Way
杭州长河智信科技有限公司
Site:1006-2, Building 6, Lierda Internet of Things Technology Park, No. 1324 Wenyi West Road,
Postcode:311121
Switchboard:+86 17367084650
Email:Summer@hzchanghe.com.cn
URL:杭州长河智信科技有限公司 (www.hzchanghe.com.cn)
信
智
河
长
指纹模组产品用户手册
II J-JY-指纹模组产品用户手册
信
智
河
长
指纹模组产品用户手册
Version History
1.3 2017-11-28 All qianp Enrich the contents of the parameter tables.
Increase obtaining image information and search for current
fingerprint instructions; enrich the general instruction process;
1.4 2017-12-12 All qianp
and enrich the general registration and automatic registration
process.
instruction.
1.7 2018-03-05 3.5.7 qianp Modify the description of the LED lamp instruction time bits.
河
1.8 2019-01-09 qianp confirmation code 34H; modify table 3-34 "Bytes"; add
.3.1.13,4.5,5
supplementary instructions for dormancy process; and add 5
supplementary instructions.
III J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Catalogue
Statement ............................................................................................................................................................................. I
Contact Way ....................................................................................................................................................................... II
Version History ................................................................................................................................................................. III
Catalogue........................................................................................................................................................................... IV
Catalog of attached drawings.......................................................................................................................................... VI
Table directory ............................................................................................................................................................... VII
Abbreviations And Terms ................................................................................................................................................. X
1 Hardware Interface Description .................................................................................................................................... 1
2 Software Instructions ...................................................................................................................................................... 2
2.1 Parameter Table ................................................................................................................................................... 2
2.2 Number of registrations and the fingerprint template size .............................................................................. 9
2.3 Power shake hands signal.................................................................................................................................... 9
3 Instructions format detailed explanation...................................................................................................................... 10
3.1 Instruction package / packet format ................................................................................................................. 10
信
3.2 Directive response ............................................................................................................................................. 11
3.3 Business class instruction set ........................................................................................................................... 13
3.3.1 Universal instruction set ........................................................................................................................ 13
智
3.3.2 Module instruction set ........................................................................................................................... 31
3.3.3 Security instruction set .......................................................................................................................... 37
河
IV J-JY-指纹模组产品用户手册
指纹模组产品用户手册
4.1.3 Receiving process of UART packets ................................................................................................... 61
4.1.4 Sending and receiving process of USB data packets .......................................................................... 62
4.2 General instruction communication process ................................................................................................... 64
4.2.1 General instruction Pour book fingerprint process ............................................................................. 64
4.2.2 General instructions to verify the fingerprint process ........................................................................ 65
4.2.3 The fingerprint is taken from the sensor and the features are uploaded to the master ..................... 66
4.2.4 Read a specified template upload from the flash fingerprint library ................................................. 67
4.2.5 The master control downloads a fingerprint feature and searches for the fingerprint library with
that feature ....................................................................................................................................................... 68
4.2.6 The master downloads two fingerprint features or templates for accurate alignment ..................... 69
4.2.7 The master downloads a fingerprint feature or template for accurate alignment ............................. 70
4.3 Module instruction communication process ................................................................................................... 71
4.3.1 Automated Pour Book Template Process .............................................................................................71
4.3.2 Automatic verify fingerprint process ................................................................................................... 72
4.4 Security instruction communication process .................................................................................................. 73
4.4.1 Security instruction Pour book fingerprint process ............................................................................ 73
4.4.2 Security instructions to verify the fingerprint process ........................................................................ 74
4.5 Sleep wake up process ...................................................................................................................................... 75
4.5.1 Self-triggering process .......................................................................................................................... 75
信
4.5.2 External trigger process ......................................................................................................................... 76
5 Additional Remarks....................................................................................................................................................... 77
智
5.1.1 Relationship between software version and antiresistance .................................................................77
河
长
V J-JY-指纹模组产品用户手册
指纹模组产品用户手册
FIG.4 - 1 Functional Example 1: Processing of the UART and USB command packets ............................... 59
FIG. 4 -2 . Example 2: UART packet sending process ......................................................................................... 61
FIG.4 -3 Functional Implementation Example 3: A UART packet receiving process .................................... 62
FIG. 4 -4 Function Example 4: USB packet sending process .......................................................................... 63
FIG.4 -5 Function Example 5: USB packet receiving process ......................................................................... 63
FIG.4 -6 Function implementation Example 6: General instruction Pour book process ................................ 64
FIG.4 -7 Function implementation Example 7: General instruction verification process ............................. 65
FIG. 4 -8 Functional implementation Example 8: Getting the fingerprint from the sensor and generating the
feature is uploaded to the master ............................................................................................................................ 66
FIG.4 -9 Example 9: Read a specified template upload from the flash fingerprint library ........................... 67
FIG. 4 - 10 Function implementation example 10 : Master downloads a fingerprint feature and searches the
fingerprint library with the feature ......................................................................................................................... 68
FIG. 4 - 11 Function implementation example 11: Master downloads two fingerprint features or templates
for accurate comparison .......................................................................................................................................... 69
FIG. 4 - 12
信
Function implementation example 12: Master downloads a fingerprint feature or template for
accurate comparison ................................................................................................................................................ 70
FIG.4 - 13 Example 13: Automatic Pour book template process ...................................................................... 71
智
FIG.4 - 14 Function implementation Example 14: Automatic verification of the fingerprint process ...........72
FIG.4 - 15 Function implementation example 15: Security instruction Pour book fingerprint process .........73
河
FIG. 4 - 16 Function implementation example 16: security instruction verification fingerprint process .......74
FIG.4 - 17 Example 17: Self-triggering process ................................................................................................. 75
FIG.. 4 - 18 Example 18: External trigger process .......................................................................................... 76
长
VI J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table directory
VII J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3 -40 Read the number of valid templates, Directive package format .................................................. 28
Table 3 -41 Read the number of valid template instruction Answer package format ..................................... 28
Table 3 -42 Read the Index Table Directive package format ............................................................................ 29
Table 3 -43 Read the index table instructions Answer package format ............................................................29
表 Table 3 -44 : Entry of the image, Directive package format ........................................................................... 30
Table 3 -45 Input the image instruction Answer package format ..................................................................... 30
Table 3 -46 Read the Index Table Directive package format ............................................................................ 30
Table 3 -47 Read the index table instructions Answer package format ............................................................30
Table 3 -48 Read the Index Table Directive package format ............................................................................ 31
Table 3 -49 Read the index table instructions Answer package format ............................................................31
Table 3 -50 Automatic Pour Book Template Directive package format ...........................................................32
Table 3 -51 Automatic Pour book template instruction normal process Answer package format ................. 32
Table 3 -52 Automatic Pour Book template response package interpretation table.........................................33
Table 3 -53 Automatic verified fingerprint Directive package format ............................................................. 35
Table 3 -54 Automatic verify fingerprint instruction Answer package format ............................................... 35
Table 3 -55 Automatic verification of fingerprint response package Paraphrase ............................................ 36
Table 3 -56 Get the secret key pair of Directive package format ..................................................................... 37
Table 3 -57 obtains the secret key pair instruction Answer package format ................................................... 37
Table 3 -58 Get the secret key pair packet format ............................................................................................. 38
Table 3 -59
信
Lock the secret key to the Directive package format .................................................................... 39
Table 3 -60 Lock the secret key pair instruction Answer package format .......................................................... 39
智
Table 3 -61 obtains the ciphertext random number Directive package format ............................................... 40
Table 3 -62 obtains the ciphertext random number instruction Answer package format ................................40
Table 3 -63 obtains the ciphertext random number packet format ................................................................... 40
河
VIII J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3 -84 Set the password command Answer package format .................................................................... 50
Table 3 -85 Verify the password Directive package format .............................................................................. 51
Table 3 -86 verifies the command instruction Answer package format ........................................................... 51
Table 3 -87 The sampled random numbers are Directive package format ...................................................... 51
Table 3 -88 Sampling random number instruction response package format...................................... 52
Table 3 - 89 Setting up the Device addressDirective package format...................................................... 52
Table 3 - 90 install Device address order Answer package format ...................................................................... 52
Table 3 -91 Write Notepad Directive package format ....................................................................................... 53
Table 3 -92 Write the notepad instruction Answer package format ..................................................................53
Table 3 -93 Read Notepad Directive package format ........................................................................................54
Table 3 -94 Read the Notepad instruction, Answer package format ................................................................ 54
Table 3 -95 . General indicator lamp Directive package format .......................................................................... 54
Table 3 -96 Colorful Programming Breath Light Directive package format .................................................. 55
Table 3 -97 Color control position schematic table ........................................................................................... 56
Table 3 -98 Breathing light Instructions Answer package format .................................................................... 56
Table 3 -99 obtains the image information, Directive package format ............................................................ 57
Table 3 - 100 acquires the image information instruction Answer package format ......................................... 57
Table 3 - 101 searches for the current fingerprint Directive package format ................................................... 57
Table 3 - 102 searches for the current fingerprint instructions, Answer package format .................................58
信
Table 5 - 1 Table of software version and anti-false mode................................................................................. 77
智
河
长
IX J-JY-指纹模组产品用户手册
指纹模组产品用户手册
信
智
河
长
X J-JY-指纹模组产品用户手册
指纹模组产品用户手册
1) UART
a) The UART default port rate is 57.6Kbps, with the data format: 8-bit data bits, 2-bit stop bits, and
no check bits;
b) The UART wave rate can be set by instructions, ranging from 9600 to 115200;
c) If the master is MCU(3.3V), connect directly to UART_TD and UART_RD; if the master is PC,
the RS232 level conversion device is required.
2) USB
a) Standard USB interface, embedded USB communication protocol;
1 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
2 Software Instructions
The content of the parameter table is the basic parameters of the protocol and the
algorithm operation. All the work of the module will use the content of the parameter table,
so understanding and properly set the parameter table is crucial for how to correctly use
the fingerprint module product;
2 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Serial Length Content and
Type Chinese name English name Annotation
Number (Bytes) default values
Purpose: The score level indicates; the system sets the alignment valve according to
this value
Read the instructions: PS_ReadSysPara See instructions for details
Five levels:
1:Level 1 Lowest
2:Level 2
3 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
3:Level 3
4:Level 4
5:Level 5 Highest
Length: 4 bytes
Purpose: The system only receives instruction packets / packets with matching
addresses
Length: 2 bytes 信
Property: Read / write
Purpose: When sending the data, the system sets the length of an individual packet
智
according to the value
Reset Value: 1
Length: 2 bytes
Purpose: Used to eliminate the phenomenon of false finger mold fusion into the
fingerprint template
4 J-JY-指纹模组产品用户手册
Set instructions: PS_ WriteReg , See instructions for details
Bit1: 0-Turn off the fingerprint membrane recognition algorithm, 1-Open the
fingerprint membrane recognition algorithm (default state).
Bit2: 0- Turn off learning function, 1- Turn on learning function (default state).
pay attention to : The software version format is the Vx.y .z. The n, where some versions do
not display the n bits. If z> =5, set the configuration parameters as above,
otherwise refer to the 5.1.1 settings.
Purpose: Set the relevant parameters for the communication between the master
信
chip and the sensor
智
Read the instructions: PS_ReadSysPara ,See instructions for details
Reset Value: 0
Length: 2 bytes
Property: Read / write
Purpose: Set the module encryption level, not allowed after setting
Read the instructions: PS_ReadINFpage ,See instructions for details
Secret grade :
0:Level 0 Default state. Support for all instructions except for the security
instruction set。
5 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
2:Level 2 SM4 (ECB), does not support the upload of templates, download
templates, download images, accurate alignment, fingerprint search,
storage templates, automatic registration, automatic verification and
cancellation of instructions, support the security instruction set.
3:Level 3 AES (128bits, ECB), does not support the upload of templates, download
templates, download images, accurate alignment, search for fingerprint,
storage templates, automatic registration, automatic verification and
cancellation of instructions, support the security instruction set.
4:Level 4 3DES (16bytes, ECB), does not support to upload templates, download
templates, download images, accurate alignment, search for fingerprint,
storage templates, automatic registration, automatic verification and
cancellation instructions, support the security instruction set.
21:Level 21 ECC (256bits), does not support to upload templates, download templates,
河
Reset Value: 0
Length: 2 bytes
Property: Read / write
Logical way:
6 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Reset Value: 1
Length: 2 bytes
Property: Read / write
Format type:
0:Format 0 The original figure。
Reset Value: 0
Length: 2 bytes
Property: Read / write
信
Purpose: When serial ports transfer packets, you set the time interval between
packets
智
Read the instructions: PS_ReadINFpage ,See instructions for details
Timeframe : 0 ~ 255ms
Length: 8bytes
Property: read- only
Length: 8bytes
Property: read- only
7 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Length: 8 bytes
Length: 8 bytes
Purpose: Writing a specific value the first time closes the JTAG port
Read the instructions: PS_ReadINFpage ,See instructions for details
Purpose: If the value of the domain is 0x1234, then the parameter table is
initialized; if the value of the domain is 0x0204 means that the
system initializes only the PART1 part of the parameter table; if the domain
is otherwise, the system will initialize the parameter table.
Read the instructions: PS_ReadINFpage ,See instructions for details
8 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Between the fingerprint module products, the registration times and the fingerprint template size differ, as
shown in Table 2 1, the relevant information can be read through the PS_ReadSysPara instruction.
The fingerprint module product sends a 0x55 signal through Uart. When the host waits for the fingerprint
module initialization, it can enter the working state in advance by receiving the handshake signal.
信
智
河
长
9 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
The fingerprint module is always in a subordinate position, and the master control needs to get the module to
complete various functions through different instructions. The master instructions, module responses, and data
exchange are all data packets in the specified format. The master control must encapsulate the instructions or data
to be sent in the following format, and must also resolve the received packets in the following format.
number
Substance 0xEF01 xxxx 01 N=
02Database format:
Table 3-2 Data Package Format
Head of
Device Package Packet
Name contracted Data Checksum
address logo length
labour
Byte
2bytes 4bytes 1 byte 2 bytes N bytes 2 bytes
number
Substance 0xEF01 xxxx 02
21
10 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
08End package format:
Table 3-3 Ends the package format
Head of
Device Package Packet
Name contracted Data Checksum
address logo length
labour
Byte
2bytes 4bytes 1 byte 2 bytes N bytes 2 bytes
number
Substance 0xEF01 xxxx 08
The packet cannot enter the execution process alone and must be followed by the
instruction package or the answer packet。
Package length = the total number of bytes from the packet length to the checksum
(instruction, parameter, or data), containing the checksum, but not the number of bytes for
the packet length itself。
Checksum is the sum of all bytes from package identity to checksum, contains package
identity that does not contain checksum and ignores carry beyond 2 bytes。
信
The device address is the default 0xffffffff before being generated. Once the master control
generates the device address through the command, all data packets must be sent and
智
received according to the generated address。
For multibytes of high byte in front of low byte in back (like 00 06 of 2bytes means 00 06
河
instead of 0600)。
长
The answer is to report the command execution and results to the master control, which contains parameters
and can follow the subsequent data package. The master control can only confirm the packet receipt situation and
the instruction execution situation after receiving the answer package.
11 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
02H:It means that there is no finger on the sensor;
04H :It means that the fingerprint image is too dry and too light to feature;
05H:It means that the fingerprint is too wet and too muddy to feature;
06H :It means that the fingerprint image is too messy to feature;
07H:It means that the fingerprint image is normal, but has too few feature points (or too small area) to
produce features;
0 bH: Indicates that the address number is outside the fingerprint library;
0 cH: Indicates that reading the template from a fingerprint library is wrong or invalid;
0 dH: Indicates that the upload feature has failed;
17H :Indicates a residual fingerprint or no finger movement between the two collections;
18H:Indicates a read-write FLASH error;
21H:Password is wrong;
12 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
22 H:Fingerprint template is not empty;
26 H: overtime ;
35H:Illegal data
长
36H—efH:Reserved。
Function declaration : When verifying the fingerprint, detect the finger, detect, and
then input the fingerprint image in the image buffer. Return confirmation code
indicates: successful input, no fingers, etc。
13 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Directive package format:
Table 3-5 Input the image instruction package format
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 0003H 01H 0005H
Function declaration : Store the raw image generation fingerprint feature files in the
image buffer in the template buffer。
长
Pour:As part of the registration process, BufferID indicates the location where the extracted feature is
stored in the buffer; in other cases, BufferID has a corresponding default value。
14 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
Confirmation code =06H indicates that the fingerprint image is too messy to be
uncharacteristic;
Confirmation code =07H indicates that the fingerprint image is normal, but has too few
feature points to produce no features;
Confirmation code =08H indicates no association between the current fingerprint feature and
the previous feature; (this feature is turned off by default)
Confirmation code =28H indicates an association between the current fingerprint feature and
信
the previous feature; (this feature is turned off by default)
15 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-10 accurately compares the two fingerprint feature instructions, Answer package format
Head of
Device Package Packet Confirm
contracted Score Checksum
address logo length code
labour
2bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes
0xEF01 xxxx 07H 0005H xxH xxH sum
Confirmation code =31 H indicates that the function does not match the encryption level;
The sum refers to the Checksum。
Function declaration : 以 The feature files in the template buffer search for the whole
or part of the fingerprint library. Page number if searched. This feature is
信
supported if the encryption level is set to 0 or 1 in Table 2- 1。
Return the parameter : Confirm word, page number (matching fingerprint template),
河
score
Head of Buffer
Device Package Packet Instruction
contracted area Parameter Parameter Checksum
address logo length code
labour number
2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes 2 bytes
0xEF01 xxxx 01H 0008H 04H BufferID StartPage PageNum sum
Pour:BufferID defaults to 1, searching entire or partial fingerprint libraries with fingerprint templates in
the template buffer。
16 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Confirm code=09 H indicates no search; the page number and score are 0;
Confirm code=17H indicates a residual fingerprint or no finger movement between the two
collections;
Confirm code= The 31 H indicates that the functionality does not match the encryption level;
Confirm code= The 35 H indicates the illegal data;
Function declaration : The feature files are fused to generate a template, and the
results are saved in the template buffer。
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
长
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 0003H 05H 0009H
17 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Function declaration : Save the template file in the template buffer to the PageID
number flash database location 。This feature is supported if the encryption
level is set to 0 or 1 in Table 2 1。
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
长
Confirm code=0bH Indicates that the PageID is outside the fingerprint library range;
Confirm code=1 8 H Indicates an error in writing the FLASH;
Confirm code=31H Indicates that the functionality does not match the encryption level;
Function declaration : Read the fingerprint template with the specified ID number in
the flash database into the template buffer。
18 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of Buffer
Device Package Packet Instruction Page
contracted area Checksum
address logo length code number
labour number
2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes
0xEF01 xxxx 01H 0006H 07H BufferID PageID sum
Confirm code=0bH Indicates that the PageID is outside the fingerprint library range;
Confirm code=1 8 H Indicates an error in writing the FLASH;
长
Function declaration : Pass the template file saved in the template buffer to the
master. This feature is supported with the encryption level set to 0 in Table 2
1。
19 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-19 Upload template Directive package format
Head of
Device Package Packet Instruction Buffer area
contracted Checksum
address logo length code number
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes
0xEF01 xxxx 01H 0004H 08H BufferID sum
Pour :Templates collected and generated from the sensor, BufferID is 1 on upload; templates loaded
from Flash are 2 on upload。
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
智
Table 3-21 UART upload features or template package format
Head of
长
Package logo=08 :The last data packet, namely, the end packet。
UART When uploading features or template packets, subcontract them at a pre-set length。
USB When uploading features or template packets, send the whole package data directly ,not
have Head of contracted labour 、 Device address 、 Package logo 、 Packet length 和 Checksum。
20 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Instruction Buffer area
contracted Checksum
address logo length code number
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes
0xEF01 xxxx 01H 0004H 09H BufferID sum
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
The sum refers to the Checksum。
长
Head of
Device Package Packet
contracted Data Checksum
address logo length
labour
2 bytes 4bytes 1 byte 2 bytes N byte 2 bytes
0xEF01 xxxx xxH xxH xxH sum
Package logo=08 :The last data packet, namely, the end packet。
UART When downloading feature or template packets, subcontract the receipt at a pre-set
length。
USB When dropping feature or template packets, receive the whole packet data directly ,not
have Head of contracted labour 、 Device address 、 Package logo 、 Packet length 和 Checksum。
21 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Function declaration : Remove the N fingerprint templates in the flash database that
specify the ID number to start。
22 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-27 Empty the fingerprint library, Directive package format
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 0003H 0dH 0011H
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
23 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Confirm code=1 bH Indicates that the register has set the Content error number;
The sum refers to the Checksum。
Pour2: When writing the system register (PS_WriteReg) instruction, answer the reply according
to the original configuration, modify the system setting, and record the configuration in FLASH。
Table 3-31 Register configuration table
Register
Register name The Content description
number
0 String time delay 0 ~ 255ms
1 Number of the Pour Books EnrollTimes
0:format 0
2 Image format register
1:format 1
0:mode 0
3 The Pour Book Logic Register
信 1:mode 1
2:mode 2
4 Baud rate control register Multiples of the 9,600'sN(0<N<13)
1:level 1
智
2:level 2
5 Alignment threshold register 3:level 3
河
4:level 4
5:level 5
0:32 bytes
长
1:64 bytes
6 Package size register
2:128 bytes
3:256 bytes
0:level 0
1:level 1
2:level 2
3:level 3
7 Encryption level register 4:level 4
5~19:keep back
20:level 20
21:level 21
22~255:keep back
bit0:Resistance resistance (on by
default)。
8 Anti-die register Bit1:Fingerprint identification
algorithm (open by default)
Bit2:Learning function (turned on by
24 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Register
Register name The Content description
number
default)
Bit3~ Bit7:keep back(Default is 0)
Pour means: the software version
format is Vx.y.z. The n, where some
versions do not display the n bits. If z>
=5, configure Parameter with the
settings above, otherwise refer to the
5.1.1 settings.
Function declaration :
信
Read the basic Parameter of the module (wave rate, packet
size, etc.). The first 16 bytes of the Parameter table store the basic
智
communication and configuration information of the module, called the basic
Parameter of the module 。
河
Head of
Device Package Packet Confirm The Basic
contracted Checksum
address logo length code Parameter List
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 16 bytes 2 bytes
Structure is
0xEF01 xxxx 07H 13H xxH sum
shown in Table 3
25 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Confirm The Basic
contracted Checksum
address logo length code Parameter List
labour
34
Offset Amount
Name Content description Size (Bytes)
(Bytes)
Number of the Pour Books Pour book, the number of times 0 2
Fingerprint template size Fingerprint template size 2 2
Fingerprint library size Fingerprint library capacity 4 2
Score grade Score Level Code (1 / 2 / 3 / 4 / 5) 6 2
Device address 32 Positions Device address 8 4
Package size code:
0:32bytes
Database size 1:62bytes
信 12 2
2:128bytes
3:256bytes
智
Porter rate setting N(baud rate was 9,600 * N bps) 14 2
河
Function declaration : Read the Parameter page where the FLASH Information Page
is located(512bytes)。
26 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-36 Read the flash information page instruction Answer package format
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4 byte 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
Package logo=08 :The last data packet, namely, the end packet。
智
When the USB uploads a Parameter packet, it sends the whole packet data directly,not have
Head of contracted labour、 Device address、 Package logo 、 Packet length 和 Checksum。
长
Function declaration : The master sends the erase code instruction, and the module
responds enters the upgrade mode。
Pour:Upgrade mode:Default is 1;
27 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Answer package format:
Table 3-39 : FLASH instruction Answer package format in the burner
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
Pour: Confirm code=0 0 H Indicates that subsequent data packets can be received;
Confirm code=01 H It means there is a mistake in receiving the package;
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
长
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 0003H 1dH 0021H
28 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Input parameter : Index tables Page number, Page number0,1,2,3..., respectively, for
indexes corresponding to templates from
0-256,256-512,512-768,768-1024..., each 1 bit represents a template, 1
means the template of the corresponding storage area has been entered
and 0 indicates none。
contracted Checksum
address logo length code information
labour
2 bytes
长
Confirm code=0bH Inmeans that the address number of the fingerprint library exceeds the scope of
the fingerprint library;
Function declaration : When Pour fingerprint, detect finger, input fingerprint image in
the image buffer. Return to Confirm code indicates: successful entry, no
fingers, etc。
29 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 0003H 29H 002DH
Input parameter : 无
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
30 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1byte 2bytes 1byte 2bytes
0xEF01 xxxx 07H 03 xxH sum
Function declaration : Cancel the automatic Pour book template and the automatic
fingerprint verification. This feature is supported if the encryption level is set
to 0 or 1 in Table 2 1。
信
Input parameter : 无
智
Return the parameter : Confirmation of the word
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2bytes 1 byte 2bytes
0xEF01 xxxx 01H 0003H 30H xxxxH
Pour: Confirm code= 0 0 H Indicates that the cancellation setting was successful。
Confirm code=0 1 H Indicates that the cancellation setting has failed。
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
The sum refers to the Checksum。
31 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
ID number: high byte before, low byte after. For example, to input the fingerprint number 1, it is
智
0001H.
Input times: 1byte, with 2 times of input, it is 02H, and with 4 times of input, it is 04H
河
1) bit0:Drawing backlight control position, 0- LED long bright, 1- LED image acquisition
长
successfully extinguished;
3) bit2:In the Pour book process, whether the module is required in the critical step, return
to the current state, 0-require a return, 1-require no return;
5) bit4:Allow fingerprints to repeat Pour book control bits, 0- allowed, 1- not allowed;
6) bit5:In the Pour book, whether the finger is required to leave to enter the next fingerprint
acquisition during the fingerprint image acquisition process, 0-It is required to leave; 1-It
is not required to leave;
7) bit6~bit15: obligate 。
32 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Parameter Parameter
1 2
2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 1 byte 2 bytes
Order legality
0xEF01 xxxx 07H 5 xxH 0H 0H sum detection:
legal /..
Drawing results:
0xEF01 xxxx 07H 5 xxH 01H 1 sum Success /
timeout
1 Generate the
0xEF01 xxxx 07H 5 xxH 02H sum feature results:
Success / failure
Finger leave,
The first entry
0xEF01 xxxx 07H 5 xxH 03H 1 sum was successful:
Success /
timeout
…
Drawing results:
信
0xEF01 xxxx 07H 5 xxH 01H n sum Success /
timeout
智
n Generate the
0xEF01 xxxx 07H 5 xxH 02H sum feature results:
Success / failure
河
Template
0xEF01 xxxx 07H 5 xxH 06H F2H sum
storage results
Fingerprint legality
00H Succeed 00H Fingerprint legality detection 00H
detection
01H Lose 01H Get the image F0H Merge template
Check that the finger
Failed to generate
07H 02H Production characteristics F1H has been placed in the
features
Pour book
Failed to merge
0aH 03H Judge the finger to leave F2H Storage template
template
0bH ID number out of range 04H Merge template n Current entry number
33 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
n
Error in reading and
18H 05H Pour Book Inspection
writing the FLASH
The fingerprint library
1fH 06H Storage template
is full
Fingerprint template is
22H
not empty
Entry times are set
25H
incorrect
26H overtime
The fingerprint already
27H
exists
The function does not
31H match with the
encryption level;
35H Illegal data
信
Instructions:
1) If the specified ID number is invalid, Confirm code, Parameter 1, and Parameter 2 return
智
(described directly as return): 0b 00 00H. Legitimate detection:
3) Wait for the generated feature to succeed (00 02 0nH), and if it fails (07 02 0nH), wait for the
color map to succeed again。
4) Wait for the finger to leave, the first entry is successful (00 03 0nH), after the finger leaves,
jump to step 2, and enter the next cycle, until n sets the number of entries. Pour: If the finger
does not need to leave during the input process, then return to the first input success directly,
and jump to step 2; if the last fingerprint is collected, the answer without the finger leaving the
input successfully。
5) Synthetic the template, combined the previously acquired finger features into a finger
template, successfully returned 00 04 F0H and failed 0A 04 F0H。
6) Fingerprint repeat check means the matching check between the newly entered finger and the
stored finger (by setting Parameter bit4 on or off), returns 27 05 F1H with the same fingerprint,
34 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
and returns 00 05 F1H without the same fingerprint。
7) Register the template data, store the failure to return 01 06 F2H, and end the process; and
successfully return 00 06 F2H。
Return the parameter : Confirmation of the word , Page number (Match fingerprint
template)
Auxiliary instructions:
长
ID number:2byte, big end mode. For example, input the fingerprint 1,it is 0001 H. The ID number
is 0xFFFF, then do 1: N search; no 1:1 match
1) bit0:Drawing backlight control position, 0- LED long bright, 1- LED image acquisition
successfully extinguished;
3) bit2:In the Pour book process, whether the module is required in the critical step, return to the
current state, 0-require a return, 1-require no return;
4) bit3~bit15: obligate 。
35 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Confirm ID
contracted Parameter Score Checksum 备 Pour
address logo length code number
labour
Order legality
0xEF01 xxxx 07H 0008H xxH 00H xxxxH xxxxH sum detection:
legal /..
Drawing results:
0xEF01 xxxx 07H 0008H xxH 01H xxxxH xxxxH sum Success /
timeout
search result:
0xEF01 xxxx 07H 0008H xxH 05H xxxxH xxxxH sum Success /
failure
Instructions:
1) If the fingerprint library is empty, Confirm code and Parameter return (described directly as
return): 24 00H. Return of 0b 00H if the specified ID number is invalid. Return of 23 00H if
the registered Template does not exist。
2) Command legitimacy detects Success, returns 00 00H, and enters the fingerprint input。
3) If a complete fingerprint input is not completed, 26 00 H is returned to end the process。
4) Check the correctness of the input fingerprint image. If not correct, wait for the next image
acquisition。
5) If the input fingerprint is correct, return to 00 01H, namely input fingerprint acquisition image
36 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Success。
6) If the production feature Lose, 09 05 H returns to end the process。
7) After the feature Success is generated, the currently collected fingerprint template is compared
to the registered fingerprint template, and the results are returned. For Lose, 09 05H ends the
process, for Success, 00 05H and the correct ID number and Score。
Some security chip-based fingerprint module products support secure Pour book and verification
functions。
Function declaration : The module receives the internal data (if already entered) and
generates a set of key pairs. This feature is not supported if the encryption
信
level is set to 0 and 1 in Table 2 1。
Input parameter :
智
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 0003H E0H sum
37 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
Confirm code=32 H The secret key is locked;
Head of
Device Package Packet
contracted Data Checksum
address logo length
labour
2 bytes 4bytes 1 byte 2 bytes N byte 2 bytes
0xEF01 xxxx xxH xxH sum
Pour: Package logo=0 2 : Data packages, and with subsequent packages。
Package logo=08 :The last data packet, namely, the end packet。
信
When UART uploads packets, it subcontracts them at a pre-set length。
When the USB uploads the packet, it sends the whole packet data directly ,not have Head of
智
contracted labour 、 Device address、 Package logo 、 Packet length 和 Checksum。
Auxiliary instructions:
河
When encryption level 2, after the module receives the command, clear the internal data (if there is
input information) , generate 3 2 bytes random number ( 1 6 byte key A, 1 6 byte key B) and save in the
长
module, then send two pairs of secret key data, the master control receives to save A, B to the internal.
Two pairs of secret key data are 32 bytes long;
When encryption level 3, after the module receives the command, clear the internal data (if there is
input information) , generate 3 2 bytes random number ( 1 6 byte key A, 1 6 byte key B) and save in the
module, then send two pairs of secret key data, the master control received to save A, B to the internal.
Two pairs of secret key data are 32 bytes long;
When encryption level 4, the module receives the command to empty the internal data (if there is
input information), generate 32 bytes random number (1 6 byte key A, 16 byte key B) to save in the
module, then send two pairs of secret key data, after the master control to save A, B to the internal. Two
pairs of secret key data are 32 bytes long;
When the encryption level is 20, the module receives the command and empthe internal data (if
there is input information), generates the RSA key pair (1024 bit generation key pair 2 times / miao,
private key 75 times / second) and saves it in the module, and then the public key and module are sent,
and saves to the internal after the main control receives. The public key and module length are (4 + 128)
bytes。
38 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
When the encryption level is 21, the module receives the command and empthe internal data (if
there is input information), generates the ECC key pair (256 bit generation key pair 100 times /
wonderful, private key 80 times / second) and saves it in the module, Then the private key data is sent,
and the private key is saved after the master receives it. The private key data length is 32 bytes。
Pour:Pour security is required when interacting secret key. First, during the product process, the
external environment is safe; then, after the product is repaired or upgraded, the main control needs to
verify whether the encryption level matches for the first time, and then it is automatically called。
Function declaration : After the module receives the command, the master control is
no longer supported to obtain a new key pair. This feature is not supported if
the encryption level is set to 0 and 1 in Table 2- 1。
Input parameter :
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
河
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
长
Confirm code=2 EH Indicates that the secret key does not exist;
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
Confirm code=32 H The secret key is locked;
39 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Function declaration : Get ciphertext or random numbers from the module end. This
feature is not supported if the encryption level is set to 0 and 1 in Table 2- 1。
Input parameter :
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
The sum refers to the Checksum。
40 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Package logo=08 :The last data packet, namely, the end packet。
When the USB uploads the packet, it sends the whole packet data directly ,not have Head of
contracted labour 、 Device address、 Package logo 、 Packet length 和 Checksum。
Auxiliary instructions:
When the encryption level is 2, the master control sends the instructions, and the module generates
16 bytes of random number R after receiving the command, and uses the key A to encrypt R for Q and
returns it to the master control. Diphertext data length is 16 bytes。
When the encryption level is 3, the main control sends the command, and the module receives 16
bytes of random number R after receiving the command, and encrypts R with the key A to obtain Q and
returns it to the main controller. Diphertext data length is 16 bytes。
When the encryption level is 4, the master control sends the command, and the module receives 16
bytes of random number R after receiving the command, and uses the key A to encrypt R for Q and
returns it to the master control. Diphertext data length is 16 bytes。
When the encryption level is 20, the master control sends the instruction, and after the module
信
receives the command, it generates 16 bytes of random number R, and uses the private key to encrypt R
for Q, and returns it to the master control. Diphertext data length is 128 bytes。
智
When the encryption level is 21, the master control sends the instructions. After the command is
received by the module, the module generates 16 bytes of random number R, and returns them to the
河
Function declaration : Save the template file in the template buffer to the PageID
number flash database location. This feature is not supported if the
encryption level is set to 0 and 1 in Table 2 1。
Head of Buffer
Device Package Packet Instruction Position Handshake
contracted area Checksum
address logo length code number signal
labour number
2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes xx byte 2 bytes
0xEF01 xxxx 01H xxH E3H BufferID PageID sum
41 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Answer package format:
Table 3-65 Secure Storage Template Instructions Answer package format
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
Confirm code=0bH Indicates that the PageID is outside the fingerprint library range;
Confirm code=1 8 H Indicates the Flash operating on Lose;
At the encryption level 2, the master control will then use A decryption to get R 'after receiving Q,
河
and then uses the key B to encrypt R' to get M. The master sends M to the module, the module uses key
B decryption M to get R '', compare R==R '' execution template storage is not execute otherwise. The
长
At the encryption level 3, the master control uses A decryption to get R 'after receiving Q, and then
uses the key B to encrypt R' to get M. The master sends M to the module, the module uses key B
decryption M to get R '', compare R==R '' execution template storage is not execute otherwise. The
handshake signal data length is 16 bytes。
At the encryption level 4, the master control will then use A decryption to get R 'after receiving Q,
and then uses the key B to encrypt R' to get M. The master sends M to the module, the module uses key
B decryption M to get R '', compare R==R '' execution template storage is not execute otherwise. The
handshake signal data length is 16 bytes。
When the encryption level is 20, the master control uses the public key decryption to obtain R '.
The master sends R 'to the module, module comparison R==R''execution template storage otherwise not
executed. The handshake signal data length is 16 bytes。
At encryption level 21, the master control uses the private key signature R to receive Q. The master
control sends Q to the module, which uses the public key to check Q. Checchecking is stored by
execution template otherwise not executed. The handshake signal data length is 64 bytes。
42 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Function declaration : Search the entire or part of the fingerprint library with feature
files in the template buffer. Page number if searched. This feature is not
supported if the encryption level is set to 0 and 1 in Table 2 1。
Return the parameter : Confirmation of the word , Page number (Match fingerprint
template), Score
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 03H xxH sum
Confirm code=2 EH Indicates that the secret key does not exist;
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
The sum refers to the Checksum。
43 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-68 Secure search for fingerprint instruction packet format
Head of
Device Package Packet
contracted Data Checksum
address logo length
labour
2 bytes 4bytes 1 byte 2 bytes N byte 2 bytes
0xEF01 xxxx xxH xxH sum
Auxiliary instructions:
When the encryption level is 2, the master control generates 16 bytes of random numbers as R,
which uses the key A to encrypt R as Q and sends it to the module. The module receives the command
using the key A decryption Q to get R'and performs the search. Search results for T, search ID as I,
search Score for S, P= T (1 byte) | I (2 bytes) | S (2 bytes) | R'(low 11 bytes), use the key B encryption P
M, sent to the master, master use key B decryption M X, compare X (low 11 bytes) ==R (low 11 bytes)
take X high 5 bytes valid data. The response data length is 16 bytes。
When the encryption level is 3, the master control generates 16 bytes of random numbers as R,
which uses the key A to encrypt R as Q and sends it to the module. The module receives the command
using the key A decryption Q to get R'and performs the search. Search results for T, search ID as I,
search Score for S, P= T (1 byte) | I (2 bytes) | S (2 bytes) | R'(low 11 bytes), use the key B encryption P
信
M, sent to the master, master use key B decryption M X, compare X (low 11 bytes) ==R (low 11 bytes)
take X high 5 bytes valid data. The response data length is 16 bytes。
智
When the encryption level is 4, the master control generates 16 bytes of random numbers as R,
which uses the key A to encrypt R as Q and sends it to the module. The module receives the command
河
using the key A decryption Q to get R'and performs the search. Search results for T, search ID as I,
search Score for S, P= T (1 byte) | I (2 bytes) | S (2 bytes) | R'(low 11 bytes), use the key B encryption P
长
M, sent to the master, master use key B decryption M X, compare X (low 11 bytes) ==R (low 11 bytes)
take X high 5 bytes valid data. The response data length is 16 bytes。
When the encryption level is 20, the master control generates 16 bytes of random numbers as R and
sends them to the module. Modulreceived command execution search, search results as T, search ID I,
search Score as S, P= T (1 byte) | I (2 bytes) | S (2 bytes) | R (low 11 bytes), use private key encryption P
get Q, send to the master, master use public key decrypt Q X, compare X (low 11 bytes) ==R (low 11
bytes) take X high 5 bytes valid data. The answer data length is 128 bytes。
When the encryption level is 21, the master generates 16 bytes of random numbers as R and sent to
the module. Modulreceived the command to execute the search results as T, search ID as I, search Score
as S, P= T (1 byte) | I (2 bytes) | S (2 bytes) | R (low 11 bytes), using public key encryption P get Q, send
to the master, master using private key decrypt QX, compare X (low 11 bytes) ==R (low 11 bytes) take
X high 5 bytes valid data. The answer data length is 128 bytes。
44 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Function declaration : Upload the data in the image buffer to the master。
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 01H 信 0003H 0aH 000eH
Package logo=08 The last data packet, namely, the end packet。
When the USB uploads the image packet, it sends the whole packet data directly ,not have
45 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of contracted labour、 Device address、 Package logo 、 Packet length 和 Checksum。
Function declaration : Master control to download the image data to the module. This
feature is supported with the encryption level set to 0 in Table 2- 1。
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
信
0xEF01 xxxx 01H 0003H 0bH 000fH
Pour:After the pre-processing function is enabled, the collected images can be uploaded, but it does not
智
support the download function, let alone the subsequent fingerprint algorithm function.
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
Pour: Confirm code=0 0 H Indicates that subsequent data packets can be received;
Confirm code=01 H It means there is a mistake in receiving the package;
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
The sum refers to the Checksum。
46 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Pour: Package logo=0 2 : Data packages, and with subsequent packages。
Package logo=08 :The last data packet, namely, the end packet。
When UART downloads image packets, it subcontracts the receipt at a preset length。
When the USB downloads the image data package, it receives the whole-packet data directly ,
not have Head of contracted labour、 Device address 、 Package logo 、 Packet length 和 Checksum。
Head of
信
Device Package Packet Instruction
contracted Parameter Checksum
address logo length code
智
labour
2 bytes 4bytes 1 byte 2bytes 1 byte 1 byte 2bytes
0xEF01 xxxx 01H 0004H 34H 0 0039H
河
Head of Unique
Device Package Packet Confirm
contracted serial Checksum
address logo length code
labour number
2 bytes 4bytes 1byte 2bytes 1byte 32bytes 2bytes
0xEF01 xxxx 07H 0023H xxH SN sum
47 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Directive package format:
Table 3-77 Handshake with Directive package format
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2bytes 1 byte 2bytes
0xEF01 xxxx 01H 0003H 35H 0039H
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1byte 2bytes 1byte 2bytes
0xEF01 xxxx 07H 0003H xxH sum
48 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Confirm code=01 H It means there is a mistake in receiving the package;
Function declaration : After the module receives the command, emptying the internal
data (if already entered), and removes the internal key pair, the master can
retrieve the secret key pair. This feature is not supported if the encryption
level is set to 0 and 1 in Table 2- 1。
Input parameter :
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
Confirm code=2 EH Indicates that the secret key does not exist;
49 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Function declaration : Set the module handshake password. The default password of
the fingerprint module system is 0. If the default password is not modified,
the system does not require the verification password during the
communication, and the master control can communicate directly with the
module. If the password is modified, the first command of the master control
and the device module must verify the password. And the module receives
other commands only after the password verification is passed。
Head of
Device Package Packet Instruction
智
contracted command Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 4 byte 2 bytes
河
Head of
Device Package Packet Confirm
contracted Checksum
address logo length code
labour
2 bytes 4 byte 1 byte 2 bytes 1 byte 2 bytes
0xEF01 xxxx 07H 0003H xxH sum
50 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Head of
Device Package Packet Instruction
contracted command Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 4 byte 2 bytes
0xEF01 xxxx 01H 0007H 13H PassWord sum
Function declaration : The order module generates a random number and returns it to
长
the master。
51 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-88 Sampling random number instruction response package format
Head of
Device Package Packet Confirm random
contracted Checksum
address logo length code number
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 4 bytes 2 bytes
0xEF01 xxxx 07H 0007H xxH xxxx sum
Function declaration : The default address of the module is 0xffffffff, which can be
modified by this instruction. The address domain of the command packet /
packet must match the address before it can be received by the fingerprint
module。
信
Input parameter : Device address
智
Return the parameter : Confirmation of the word
Head of
Device Package Packet Instruction Device
contracted Checksum
address logo length code address
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 4 bytes 2 bytes
0xEF01 xxxx 01H 0007H 15H xxxx sum
The module address is the current address, and the address domain of the answer packet
52 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
will use the newly generated address。
After this instruction is executed, the Device address is immediately fixed and remains
unchanged. The Device address can only be changed again after the reset。
After this instruction is executed, all packets have to use the generated address。
Function declaration : The module has a 512bytes FLASH space for storing user data,
which is called the user notepad, which is logically divided into 16 pages,
and the write notepad command is used to write the user's 32bytes data to
the specified notepad page. When Pour writes about a certain page of a
notepad, the 32 bytes of Content on that page are written overall, and the
original Content is overwritten。
Head of
Device Package Packet Instruction Page
contracted Userinfo Checksum
河
53 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Input parameter : Page number
Head of
Device Package Packet Instruction Page
contracted Checksum
address logo length code number
labour
2 bytes 4 bytes 1 byte 2 bytes 1 byte 1byte 2 bytes
0xEF01 xxxx 01H 0004H 19H 0~15 xxxxH
Function declaration : Control light instructions are mainly divided into two categories:
general indicator light and colorful programming breathing
light。
Input parameter : Function code, start color, end color, number of cycles
辅助说明
54 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
function code :LED lamp mode control bit, 1-Common breathing light, 2-flashing, 3-normally on,
4-normally switch on, 5-fade on, 6-fade off, other function code not applicable
to this Directive package format;
Start color: When set to the ordinary breathing light, the color from out to light is limited to the
ordinary breathing light (function code 01) function, and the other functions are
consistent with the End the color. Where, bit0 is a blue light control bit, bit1 is a
green light control bit, and bit2 is a red light control bit. Put 1 light on, put 0 light
out. For example, 0x01_ blue light, 0x02_ green light, 0x04_ red light, 0x06_ traffic
light, 0x05_ red blue light, 0x03_ green blue light, 0x07_ red green blue light,
End the color:When set to ordinary breathing light, the color from light to out is limited to
ordinary breathing light (function code 0x01), and other functions are
consistent with Start color. Set up in the same way as the Start color;
Cycle index :Indicates the number of breathing or flashing lights. When set to 0,indicates infinite
cycles and a limited number of breaths when set to other values. Cycle index is
suitable for breathing, flashing function, and is invalid in other functions, such
信
as in normally open, normally closed, gradually open, and gradually closed;
Table 3-96 Colorful Programming Breath Light Directive package format
智
Head of function Time Color Color Color Color Color Cycle
Chip Package Packet Instruction
contracted code position code code code code code index Checksum
address logo length code
河
labour 1 2 3 4 5
2 1 byte 1byte 1byte 1byte 1byte
2 bytes 4bytes 1 byte 1 byte 1 byte 1byte 1byte 2 bytes
bytes
长
Auxiliary instructions
function code :7-Colorful programming breathing lamp, other function code is not applicable to
this Directive package format;
Time position: used to control the time of the light breathing once, that is, from extinguish to light,
and then to extinguish time. The time range of a single breath is about 0. 1 s~ 1 0 .0 s , which is represented
by a number between 1 and 100, and the numbers beyond this range are invalid. That is, time bit set to 1
corresponds to 0.1s and time bit set to 100 corresponds to 10.0s. The recommended time bit is set to 36,
and the breathing time is the same as the ordinary breathing lamp (function code 0x01), or about 3.6s 。
Color code: a total of 5 bytes, as shown in the following table below, each byte color code is
divided into 2 units, each unit has 4 bits, from the high level is divided into an effective bit, and 3 color
control bits. Each unit controls the process of a certain color light from out to on to out. Further, the
programmed breathing light 1 cycle lighting starts from the unit 1 of color 1, then the unit 2 of color 1,
followed by the unit 1 of color 2, and so on。
55 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-97 Color control position schematic table
Colour(1byte)
cell 1 unit 2
significance digit:0- This unit and all units after this member are invalid. 1- This unit is valid;
Red light:0-Red light out, 1-Red light on;
Cycle index : Represents the number of breathing lights. When set to 0, infinite cycles and a
limited number of breaths。
Function declaration : After being detected, input the fingerprint image is stored in the
image buffer and return the image information。
Input parameter : 无
Return the parameter : Confirmation of the word 、 Image area (percentage) 、 Image
quality (0: qualified; Other: unqualified)
56 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-99 obtains the image information, Directive package format
Head of
Device Package Packet Instruction
contracted Checksum
address logo length code
labour
2 bytes 4bytes 1 byte 2bytes 1 byte 2bytes
0xEF01 xxxx 01H 0003H 3DH 0041H
Confirm code=06 H It means that the image is too messy to produce a feature;
信
Confirm code=33 H It means that the Image area is small;
智
The sum refers to the Checksum。
Function declaration : Search the entire or partial fingerprint library with the most
长
Return the parameter : Confirmation of the word , Page number (Match fingerprint
template), Score
57 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Table 3-102 searches for the current fingerprint instructions, Answer package format
Head of
Device Package Packet Confirm Page
contracted Score Checksum
address logo length code number
labour
2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes 2 bytes
0xEF01 xxxx 07H 07H xxH PageID MatchScore sum
Confirm code=09 H Indicates; not found; Page number and Score are 0;
Confirm code=17H Indicates a residual fingerprint or no finger movement between the two
collections;
Confirm code=3 1 H Indicates that the functionality does not match the encryption level;
The sum refers to the Checksum。
信
智
河
长
58 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
信
智
河
长
FIG.4-1 Functional Example 1: Processing of the UART and USB command packets
59 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Before the UART transmits the packet, it should first receive the command packet to transmit the packet,
prepare for the transmission and then send the Success answer packet, and finally start transmitting the
packet. Data packages mainly include: Head of contracted labour, Device address, Package logo, Packet
length, data, and Checksum。
There are two main types of Package logo for data packages: 02H and 08H.02H: Package, with
subsequent packages.08H: The last data packet, namely, the end packet. The data length is preset, mainly
divided into: 32,64,128, and 256 four kinds,。
For example, if the data length to transfer is 1K bytes and the pre-set data length in the packet is 128
bytes, then the 1K bytes data should be divided into eight packet transfers. Each package includes: 2
bytesHead of contracted labour, 4 bytesDevice address, 1 bytesPackage logo, 2 bytesPacket length, 128 bytes
信
data, and 2 bytesChecksum, with each data Packet length of 139 bytes. In addition, among the 8 packets, the
first 7 packets are labeled as 02H, and the last end packet reporting identification is 08H. The last thing that
智
Pour requires is that the end package will not otherwise expand to 139 bytes if the actual length does not
reach 139 bytes。
河
长
60 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
信
智
Before the UART transmits the packet, it should first receive the command packet to transmit the packet,
prepare for the transmission and then send the Success answer packet, and finally start transmitting the
packet. Data packages mainly include: Head of contracted labour, Device address, Package logo, Packet
length, data, and Checksum。
There are two main types of Package logo for data packages: 02H and 08H.02H: Package, with
subsequent packages.08H: The last data packet, namely, the end packet. The data length is pre-set, mainly
divided into: 32,64,128, and 256 four kinds。
For example, if the data length to transfer is 1K bytes and the pre-set data length in the packet is 128
bytes, then the 1K bytes data should be divided into eight packet transfers. Each package includes: 2
bytesHead of contracted labour, 4 bytesDevice address, 1 bytesPackage logo, 2 bytesPacket length, 128 bytes
data, and 2 bytesChecksum, with each data Packet length of 139 bytes. In addition, among the 8 packets, the
61 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
first 7 packets are labeled as 02H, and the last end packet reporting identification is 08H. The last thing that
Pour requires is that the end package will not otherwise expand to 139 bytes if the actual length does not
reach 139 bytes。
信
智
河
长
Before the USB transmits the packet, it should first receive the command packet to transmit the packet,
prepare for the transmission and then send the Success answer packet, and finally start transmitting the
packet. The USB packets have only data, no Head of contracted labour, Device address, Package logo,
62 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Packet length, and Checksum, and unlike the UART subcontractor transmission, the USB is a whole-packet
transmission。
信
FIG. 4-4 Function Example 4: USB packet sending process
智
河
长
63 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
General instruction Pour book fingerprint process mainly includes: Pour book to obtain images, generate
features, merge features and storage templates. For example, AM11 0 , AM22 0 and other products, N = 4
times。
信
智
河
长
As shown in Table 2- 1, the Pour book logic is set to 1 when the Pour book fingerprint. If the currently
included fingerprint is similar to the previously included fingerprint, the Confirm code in the response
package generating the feature command will not display Success, but returns 28H, indicating the association
between the current fingerprint feature and the previous feature. What Pour means that the mutual
comparison correlation is only limited to the fingerprints included in the Pour book, and will not be
compared with the fingerprints in the fingerprint library。
As shown in Table 2- 1, Pour book logic is set to Pour book fingerprint at 2. If the currently included
fingerprint is not similar to the previously included fingerprint, the Confirm code in the response package
generating the feature command will not display Success, but returns 08H, indicating no association between
64 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
the current fingerprint feature and the previous feature. What Pour means that the mutual comparison
correlation is only limited to the fingerprints included in the Pour book, and will not be compared with the
fingerprints in the fingerprint library。
No matter returning 28H or 08H, the current fingerprint feature has been extracted from Success. You
can recover images and generate features without changing BufferID, and you can also skip this round of
BufferID to include the next round of fingerprint。
The general instruction verification fingerprint process mainly includes: verification with image
acquisition, feature generation and fingerprint search. When sending generated features and searching for
fingerprints, BufferID is set to the default value of 1。
信
智
河
长
65 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
4.2.3 The fingerprint is taken from the sensor and the features are uploaded to the
master
The whole process mainly includes: obtaining images, generating features, and uploading templates.
When you send the generated features and upload the template, the BufferID is set to the default value of 1.
This feature is supported with the encryption level set to 0 in Table 2 1.
信
智
河
长
FIG. 4-8 Functional implementation Example 8: Getting the fingerprint from the sensor and generating the feature is
uploaded to the master
66 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
4.2.4 Read a specified template upload from the flash fingerprint library
The whole process mainly includes: reading out templates and uploading templates. When sending the
readout template and the upload feature, the BufferID is set to the default value of 2. This feature is
supported with the encryption level set to 0 in Table 2- 1。
信
智
河
长
FIG.4-9 Example 9: Read a specified template upload from the flash fingerprint library
67 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
4.2.5 The master control downloads a fingerprint feature and searches for the
The whole process mainly includes: downloading templates and searching for fingerprints. When
downloading the template and searching for the fingerprint, the default BufferID is set to 1. This feature is
supported with the encryption level set to 0 in Table 2 1。
信
智
河
长
FIG. 4-10 Function implementation example 10: Master downloads a fingerprint feature and searches the fingerprint
library with the feature
68 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
4.2.6 The master downloads two fingerprint features or templates for accurate
alignment
The whole process mainly includes: downloading templates and accurate alignment. When two of them
download the template, BufferID needs to set differently. This feature is supported with the encryption level
set to 0 in Table 2 1。
For Pour, when exact alignment objects are two feature files or two templates. If the exact alignment
object is a feature file and a template, the BufferID is set to 1 when downloading the feature file, and the
BufferID is set to 2 when downloading the template。
信
智
河
长
FIG. 4-11 Function implementation example 11: Master downloads two fingerprint features or templates for accurate
comparison
69 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
4.2.7 The master downloads a fingerprint feature or template for accurate alignment
The whole process mainly includes: downloading templates, reading out templates, and accurate
alignment. When downloading a template, BufferID is set to 1, and when reading out the template, BufferID
is set to 2. This feature is supported with the encryption level set to 0 in Table 2- 1。
信
智
河
长
FIG. 4-12 Function implementation example 12: Master downloads a fingerprint feature or template for accurate
comparison
70 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
信
智
河
长
71 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
As shown in Table 2- 1, the Pour book logic is set to 1 when the Pour book fingerprint. If the currently
included fingerprint is similar to the previously included fingerprint, the Confirm code in the response
package generating the feature command will not display Success, but returns 28H, indicating the association
between the current fingerprint feature and the previous feature. What Pour means that the mutual
comparison correlation is only limited to the fingerprints included in the Pour book, and will not be
compared with the fingerprints in the fingerprint library. In addition, Pour meaning is also needed. Different
from the general instruction Pour book fingerprint process, the number of correlation comparisons of the
automatic Pour book template process is limited. After the number limit is exceeded, the current fingerprint
characteristics will not be compared with the previous features。
As shown in Table 2- 1, Pour book logic is set to Pour book fingerprint at 2. If the currently included
fingerprint is not similar to the previously included fingerprint, the Confirm code in the response package
generating the feature command will not display Success, but returns 08H, indicating no association between
the current fingerprint feature and the previous feature. What Pour means that the mutual comparison
correlation is only limited to the fingerprints included in the Pour book, and will not be compared with the
fingerprints in the fingerprint library. In addition, the Pour meaning is also required. Unlike the automatic
Pour book template process, when the Pour book logic is set to 1, the number of association comparisons is
信
not limited。
FIG.4-14 Function implementation Example 14: Automatic verification of the fingerprint process
72 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Before calling the security instruction set Pour book, you need to call the write system register
PS_WriteReg command, set the encryption level, and then call the obtain the secret key pair PS_GetKeyt
command to obtain and store the secret key。
信
智
河
长
FIG.4-15 Function implementation example 15: Security instruction Pour book fingerprint process
73 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Before calling the security instruction set verification, you need to call the write system register
PS_WriteReg command, set the encryption level, and then call the obtain the secret key pair PS_GetKeyt
command to obtain and store the secret key。
信
智
河
长
FIG. 4-16 Function implementation example 16: security instruction verification fingerprint process
74 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
For Pour purposes, the touch-feedback foot signal of the fingerprint module is only valid after the
Success enters the dormant process。
Pour means that if you want to let the self-trigger type into the low power consumption, you should first
send the hibernation instructions to the module, and cut off the module fingerprint chip power supply after
receiving the Success response。
信
智
河
长
75 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
Here is an example process for an external trigger product with a touch chip。
Need to Pour meaning is, if you want to let the external trigger type into the low power consumption,
directly cut off the module fingerprint chip power supply can be。
信
智
河
长
76 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
5 Additional Remarks
Software version format is Vx.y.z. The n, where some versions do not display the n bits. Different software
versions need to set the anti-fake finger mode function according to different configuration modes, that is, to set
the instructions in chapter 3.3.3.1.12. The setting mode is mainly divided into the following three situations:
Bit1: 0-Close fingerprint identification algorithm, 1-Open fingerprint identification algorithm (default
state)。
3 、Bit0 : 0-Turn off fingerprint film recognition algorithm (default state), 1-Open the fingerprint film
河
recognition algorithm。
Please select the above setting mode according to the software version number in the following table:
Table 5- 1 Table of software version and anti-false mode
77 J-JY-指纹模组产品用户手册
指纹模组产品用户手册
The x The y Thez The n Set the
position position position position way
y == 7 z == 4 — Do not set
z <= 2 — Do not set
x == 2 —
z == 3 3
y <= 3 Do not set
z <= 2 Do not set
z == 3 3
y == 4
z == 4 2
z >= 5 1
z <= 2 — Do not set
x == 3
z == 3 —
y == 5 3
z == 4 —
z >= 5 — 1
z == 4 2
y == 6
z >= 5 1
y == 8 z == 4 2
信
智
河
长
78 J-JY-指纹模组产品用户手册