Toyonway TFP821 User manual

User’s Manual for Fingerprint Module TFP821
(Xiamen Toyonway Intellectual Technology Co., Ltd.)

Revision
Date
Description
0.0.1
08/02/2018
Draft
0.0.2
08/06/2018
Updated, Comment AutoEnroll,
AutoIdentify Functions, Modify
Starting Time.
0.0.3
09/14/2018
Format Revision.

CONTENTS
Specification .................................................................................................................................... 1
Pin map............................................................................................................................................ 2
Basic concept................................................................................................................................... 3
Available resources.................................................................................................................. 3
Module Parameters................................................................................................................. 3
Communication Protocol................................................................................................................. 4
Package format........................................................................................................................ 4
Command Code ....................................................................................................................... 5
Response Code ........................................................................................................................ 5
Command ........................................................................................................................................ 6
GetImg ..................................................................................................................................... 6
Img2Tz ..................................................................................................................................... 7
Match....................................................................................................................................... 8
Search ...................................................................................................................................... 8
RegModel ................................................................................................................................ 9
StoreModel.............................................................................................................................. 9
LoadChar................................................................................................................................ 10
UpChar................................................................................................................................... 10
DownChar.............................................................................................................................. 11
UpImage ................................................................................................................................ 12
DeleteChar............................................................................................................................. 13
Empty..................................................................................................................................... 13
SetSysPara ............................................................................................................................. 14
ReadSysPara .......................................................................................................................... 15
SetPwd................................................................................................................................... 15

VfyPwd................................................................................................................................... 16
WriteNotePad........................................................................................................................ 16
ReadNotePad......................................................................................................................... 17
TemplateNum........................................................................................................................ 17
ReadConList........................................................................................................................... 18
Combination .................................................................................................................................. 19
Enroll...................................................................................................................................... 19
Identification ......................................................................................................................... 19
Sleep and Wakeup......................................................................................................................... 20
Test environment .......................................................................................................................... 21
Technical Support.......................................................................................................................... 24

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
1/ 26
Thank you for your interest in our fingerprint identification module.
TFP821 is the stand-alone fingerprint identification module.
The module performs the functions like fingerprint enrollment, identification,
verification.
The module supports UART or USB communication.
This paper provides the information necessary for the user to develop fingerprint
product by using the fingerprint module TFP821.
Specification
Item
Description
Processor
ARM9（footprint : QFN40）
Fingerprint Sensor
FPC1025AM
Image
160 * 160 pixel, 508dpi, 256 gray levels
Active sensor area
8.0mm * 8.0 mm
Image acquiring time
about 100 msec
Enrollment
Proceed by twice of fingerprint acquiring
Identification time
< 0.55 sec (including image acquiring, for 300
templates)
Verification time
< 0.5 sec (including image acquiring)
Match Accuracy
FAR 0.001% / FRR 1.0%
Starting time
< 0.23 sec
Template size
448 byte
Fingerprint Capacity
300
Power
module
DC 3.3V
sensor
DC 3.3V
Current
Working mode
<= 40 mA

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
2/ 26
Image Acquiring
<= 45 mA
Sleep mode
<= 10 uA
Communication
UART,USB
Baud Rate(UART)
(9600 x N) bps, N = 0 ~ 12
Default N=6 (57600 bps) ,0 for USB
Module Outline dimension
20mm* 33mm
Table 1.
TFP821 has template improvement function.
You can see match score increases for same fingerprint, after several times of
identification.
Template improvement function increases fingerprint match accuracy.
Pin map
Pin
Name
Type
Description
1
VDD33
Power
MCU Power
2
TX
Output
UART TXD
3
RX
Input
UART RXD
4
GND
Power
Ground
5
TouchOut
Output
Sensor Awake(touch fingerprint : HIGH)
6
VTouch
Power
Sensor Power
7
DP
I/O
USB D+
8
DM
I/O
USB D-
Table 2.
Connection Type: XH-1.25-8PConnection

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
3/ 26
Basic concept.
Available resources
Size(byte)
Description
Image Buffer
160*160
Store image (name as ImageBuffer)
Template Buffer
448 * 3
Store 3 Templates(name as CharBuffer1 ~ 3)
Fingerprint database
Template x (300)
Note
32 * 15
One note is of size 32 bytes.
There are 15 record of note(address 0x0~0xe)
You can use this to store binary data you want.
Table 3.
Module Parameters
member
value
Description
Module Status
0
Static
Module Address
0xFFFFFFFF
Static
Fingerprint
Capacity
300
Static
Security Level
3
Static
Baud Rate
0
USB
1
UART 9600 bps
2
UART 19200 bps
4
UART 38400 bps
6
UART 57600 bps
default factory
setting
12
UART 115200 bps
Table 4.
Remark:
(1) The module does not support both USB and UART at the same time.

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
4/ 26
When you test the module with PC, you can determine whether USB is available or not
in windows explorer.
If CD Drive does not appear, you can use UART communication.
(2) Module parameters would be effective after reset of module.
Communication Protocol
The protocol defines the data exchanging format when the module communicates with PC or
other Hosts.
Package format
Header
Address
Package Kind
Package Length
Content
Check Sum
2 bytes
4 bytes
1 byte
2 bytes
(N-2) Bytes
2 Bytes
Table 5-1
Name
Symbol
Size
Description
Header
START
2
0xEF01
Address
ADDR
4
0xFFFFFFFF, module address
Package
Kind
PID
1
0x01
Command packet
0x02
Data packet
0x07
Response(ACK) packet
0x08
Last data packet
Package
Length
LENGTH
2
sum of lengths of (Content) and (Check sum)
Content
PAYLOAD
-
Check
sum
SUM
2
Accumulated sum of each byte from (PID) to (Content)
Table5-2
Remark: The module uses big-endian.
Packet example (length 12 bytes):
START
ADDR
PID
LENGTH
PAYLOAD
SUM
0xEF
0x01
0xFF
0xFF
0xFF
0xFF
0x01
0x00
0x03
0x01
0x00
0x05
Table 5-3

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
5/ 26
Command Code
No
Value
Name
Description
1
0x01
GetImg
Capture image(with finger detection)
2
0x02
Img2Tz
Extract feature
3
0x03
Match
Match two features
4
0x04
Search
Search fingerprints in DB
5
0x05
RegModel
Merge two features into one template
6
0x06
StoreModel
Store template into DB
7
0x07
LoadChar
Load template of DB into CharBuffer(1 or 2)
8
0x08
UpChar
Upload CharBuffer(1 or 2)’s data
9
0x09
DownChar
Download data into CharBuffer(1 or 2)
10
0x0A
UpImage
Upload image from ImageBuffer
11
0x0C
DeleteChar
Remove template from DB
12
0x0D
Empty
Remove all from DB
13
0x0E
SetSysPara
Set module parameters
14
0x0F
ReadSysPara
Read module parameters
15
0x12
SetPwd
Set module’s password
16
0x13
VfyPwd
Verify module’s password
17
0x18
WriteNotePad
Write one note(32 bytes)
18
0x19
ReadNotePad
Read one note(32 bytes)
19
0x1D
TemplateNum
Read template number in DB
20
0x1F
ReadConList
Read template valid flag data of DB
Table 6.
Response Code
No
value
Symbol
Description
1
0x00
RET_OK
Success
2
0x01
RET_InvalidPacket
Invalid Packet
3
0x02
RET_NoFinger
No finger in sensor
4
0x03
RET_StoreImageFail
Failed to store image into ImageBuffer
5
0x06
RET_TooLowQuality
Image quality is too low to extract feature
6
0x07
RET_TooFewPoint
Feature point is too few to extract feature
7
0x08
RET_NotMatched
Features( or Templates) were not matched
8
0x09
RET_NotIdentified
Not found matched fingerprint
9
0x0A
RET_MergeFail
Failed to merge features
10
0x0B
RET_InvalidTempID
Template ID is not in available range.
11
0x0C
RET_ReadTempFail
Failed to read template from DB
12
0x0D
RET_UpTempFail
Failed to upload template(or feature)
13
0x0E
RET_ModBusyErr
Currently, the module can’t receive packet

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
6/ 26
14
0x0F
RET_UpImgFail
Failed to upload image
15
0x10
RET_RemoveTempFail
Failed to remove template from DB
16
0x11
RET_RemoveAllFail
Failed to remove all templates from DB
17
0x13
RET_InvalidPwd
Invalid Password
18
0x15
RET_InvalidImg
There is no valid image data in ImageBuffer
19
0x20
RET_InvalidMAddr
Invalid Module Address
20
0x21
RET_NeedVfyPwd
Need to verify password
Table 7
Command
GetImg
-Operation
Capture fingerprint image. Normally,
When get first command “GetImg” after reset, it runs like follows;
Get Full Image
Start
Finger
Detection
Return RET_OK
End
Return RET_NoFingerr
Return RET_StoreImgFail
No Finger
I/O Error
Finger exists

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
7/ 26
-Parameters : None
-Command Packet
START
ADDR
PID
LENGTH
Command
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x01
0x0005
Table 8-1
-Response packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 8-2
Please refer to response code(Table 7).
Img2Tz
-Operation
Create feature from image of ImageBuffer, and store into CharBuffer(1 or 2 or 3), where
1 ~3 is bufferID.
-Parameters
BufferID : ID of CharBuffer(1 or 2 or 3).
-Command Packet
START
ADDR
PID
LENGTH
Command
BufferID
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x02
X
Sum
Table 9-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Start
End
Get Full Image
Return RET_OK

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
8/ 26
Table 9-2
Please refer to response code(Table 7).
Match
-Operation
Match CharBuffer1 and CharBuffer2.
-Parameters : None
-Command Packet
START
ADDR
PID
LENGTH
Command
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x03
0x0007
Table 10-1
-Response Packet
START
ADDR
PID
LENGTH
Response Code
Score
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2 bytes
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0005
X
XX
SUM
Table10-2
Please refer to response code(Table 7).
Search
-Operation
Search match with CharBuffer(1 ~ 2) in the given range of DB.
-Parameters
BufferID: CharBuffer’s ID(1~2)
TempID: start template ID of search range
TempCount: Template count to search
-Command Packet
START
ADDR
PID
LENGTH
Command
BufferID
Temp
ID
Temp
Count
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
2bytes
2bytes
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0008
0x04
X
XX
XX
Sum
Table11-1
-Response Packet
START
ADDR
PID
LENGTH
Response
Temp ID
Score
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2 bytes
2bytes
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0007
X
XX
XX
SUM
Table11-2

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
9/ 26
Please refer to response code.(Table 7)
RegModel
-Operation
Merge CharBuffer1~2) into one template and store at CharBuffer1.
-Parameters : None
-Command Packet
START
ADDR
PID
LENGTH
Command
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x05
0x0009
Table 12-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 12-2
Please refer to response code(Table 7).
StoreModel
-Operation
Store feature of CharBuffer(1 or 2) into DB.
-Parameters
BufferID : CharBufferID (1 or 2)
TempID : ID to store into DB
-Command Packet
START
ADDR
PID
LENGTH
Command
BufferID
TempID
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
2 bytes
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0006
0x06
X
XX
Sum
Table 13-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 13-2
Please refer to response value(Table 7).

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
10 / 26
LoadChar
-Operation
Read an template of DB and store into CharBuffer(1 or 2).
-Parameters
BufferID : CharBuffer’s ID(1 or 2)
TempID : template ID
-Command Packet
START
ADDR
PID
LENGTH
Command
BufferID
TempID
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
2 bytes
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0006
0x07
X
XX
Sum
Table 14-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 14-2
Please refer to response code(Table 7).
UpChar
-Operation
Upload template of CharBuffer(1 or 2).
-Parameters
BufferID : CharBuffer’s ID(1 or 2)
-Command Packet
START
ADDR
PID
LENGTH
Command
BufferID
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0004
0x08
X
Sum
Table 15-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 15-2
Please refer to response code(Table 7).
-Data Packet
A. Normal

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
11 / 26
START
ADDR
PID
LENGTH
Template Bytes
SUM
2 bytes
4bytes
1byte
2bytes
N byte
2bytes
0xEF01
0xFFFFFFFF
0x02
N+2
-
Sum
Table 15-3
B. Last
START
ADDR
PID
LENGTH
Template Bytes
SUM
2 bytes
4bytes
1byte
2bytes
N byte
2bytes
0xEF01
0xFFFFFFFF
0x08
N+2
-
Sum
Table 15-4
Remark : UART : N = 128
If only 1 Data packet needs sending, just send a “Last” format data packet.
DownChar
-Operation
Download template into CharBuffer(1 or 2).
-Parameters
BufferID : CharBuffer’s ID(1 or 2)
-Command Packet
START
ADDR
PID
LENGTH
Command
BufferID
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0004
0x09
X
Sum
Table 16-1
Start
Get response packet
Send Data packets
END
Check
response
Fail
OK

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
12 / 26
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 16-2
Please refer to response code(Table 7).
-Data Packet
Please refer to Table 15-3,15-4.
UpImage
-Operation
Upload image of ImageBuffer.
-Parameters: None
-Command Packet
START
ADDR
PID
LENGTH
Command
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x0A
0x0E
Table 17-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Start
Get response packet
Receive Data packets
END
Check
response
Fail
OK

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
13 / 26
Table 17-2
Please refer to response value.(Table 7)
Data packet is same as Table 15-3,15-4.
Remark : UART : N = 128 for data packet.
-Image Data Format
UART : Upload data is image bytes with width=256, height=288.
Each pixel needs 4 bits.
Therefore (size of image bytes) = 256 * 288 / 2=36864 (bytes), and this size is
multiplier of 128.
The image of FPC sensor lies at center of image.
DeleteChar
-Operation
Remove templates from TempID to (TempID+TempCount-1).
-Parameters
TempID : start Id of templates to remove or check.
TempCount: template count to remove or check.
(If given ID’s template is empty, go to next ID)
-Command Packet
START
ADDR
PID
LENGTH
Command
TempID
Temp
Count
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2 bytes
2 bytes
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0007
0x0c
XX
XX
Sum
Table 18-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 18-2
Please refer to response code(Table 7).
Empty
-Operation
Remove all templates from DB.
-Parameters : None

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
14 / 26
-Command Packet
START
ADDR
PID
LENGTH
Command
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x0D
0x10
Table 19-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 19-2
Please refer to response code(Table 7).
SetSysPara
-Operation
Set module parameters, especially Baud rate.
-Parameters
ParaID : module parameter’s ID(4)
value : number to set
Name
ParaID
Value
Communication
Baud rate
BaudRate
4
0
USB
USB
1
UART
9600 bps
2
19200 bps
3
38400 bps
6
57600 bps
12
115200 bps
Table 20-1
-Command Packet
START
ADDR
PID
LENGTH
Command
ParaID
Value
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
1 byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0005
0x0E
4 or 6
X
Sum
Table 20-2
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 20-3
Please refer to response code.(Table 7)

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
15 / 26
ReadSysPara
-Operation
Read module parameters.
-Parameters : None
-Command Packet
START
ADDR
PID
LENGTH
Command
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0003
0x0F
0x0012
Table 21-1
-Response Packet
START
ADDR
PID
LENGTH
Response
Mod. Para
SUM
2 bytes
4bytes
1byte
2bytes
1byte
16 bytes
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0013
X
-
SUM
Table 21-2
Please refer to response code(Table 7).
16bytes of module parameters are as follows;
(Please refer to Module Parameter’s table)
Name
Size
Value
Module Status
2
0x0000
Module Number
2
0x0000
Fingerprint Capacity
2
0x012C
Security Level
2
0x0003
Module Address
4
0xFFFFFFFF
BaudRate
2
XX
Table 21-3
SetPwd
-Operation
Set 4 bytes of module password.
-Parameters
Pwd : New password(4 bytes)
-Command Packet
START
ADDR
PID
LENGTH
Command
Pwd
SUM
2 bytes
4bytes
1byte
2bytes
1byte
4 byte
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0007
0x12
XXXX
Sum
Table 22-1
-Response Packet

User’s Manual for Fingerprint Module TFP821 www.toyonway.com
16 / 26
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 22-2
Please refer to response code(Table 7).
VfyPwd
-Operation
Verify module password.
-Parameters
Pwd : password(default : 0x00000000)
-Command Packet
START
ADDR
PID
LENGTH
Command
Pwd
SUM
2 bytes
4bytes
1byte
2bytes
1byte
4bytes
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0007
0x13
XXXX
Sum
Table 23-1
-Response Packet
START
ADDR
PID
LENGTH
Response
SUM
2 bytes
4bytes
1byte
2bytes
1byte
2bytes
0xEF01
0xFFFFFFFF
0x07
0x0003
X
SUM
Table 23-2
Please refer to response code(Table 7).
WriteNotePad
-Operation
Write one note into given record.
-Parameters
NoteID: noteID to write.(0x0~ 0x0E)
Data1: data to write.(32 bytes)
-Command Packet
START
ADDR
PID
LENGTH
Command
NoteID
Data1
SUM
2 bytes
4bytes
1byte
2bytes
1byte
1 byte
32 bytes
2bytes
0xEF01
0xFFFFFFFF
0x01
0x0024
0x18
X
-
Sum
Table 24-1
-Response Packet