ESEN119A FPO-001 Fingerprint Optical Scan
Contents
1. Operation Sequence If exist broken template data result total number of broken template template No else total number z0 Template No 0 Command and Response mo p RCM EN 22 Success Total number of broken template denote there is no any template are damaged DATA Fail Error Code The first template No of broken template denote there is no any template are damaged Example of Get Broken Template PREFIX CMD LEN DATA CKS ia ld al ll m Response Packet RET DATA CKS LEN dal ld mer T P 28 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 10 Read Template Function Read fingerprint Template data with specified Template No from the module Operation Sequence 1 if the appoint template No is invalid result ERR INVALID TMPL NO 2 if the appoint template No is inexistence template data TMPL 3 else result Template Record Size 2 denote that length of the data field of Response data packet 4 utilize Response data packet to transmit the template data 5 0x010A Template No PREFIX 58 01 ERR SUCCESS or ERR FAIL Success Template Record Size 2 Command and Res DATA Fail Error Code E T P 29 lhaieasyelec enable your design spon www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Example2. OxO1OE 2 Time Out OxO10E uM Time out Value Value Error Code Device ID Error Code Baud Rate Index Error Code Duplication Check Option Error Code Duplication Check Option Page 13 www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 CMD RCM LEN RE DATA T And Store in 0x0118 EMEN Ox0118 m 0 Error Code Get Enroll Data 0x0119 0 0119 Template Template Record Record Size Data Error Code 2 or 4 Get Feature Data pee OxO11A Template Template Record Record Size Data Error Code of Captured FP 2 or 4 Verify Downloaded 0 011 Template Template OxO11B 4 0 1 O Error Code Record Size Record Data Feature with Captured FP Identify Downloaded Template Index OxOLIC 4 O Error Code Record Size Template Feature with Captured 2 Record Data FP Get Device Name 0 0121 0 0121 16 0 1 STO20 OEM Error Code 30 Sensor LED Control Ld Identify Free _ pr lt gt No Error Code Device Password Lund pee lid Ll Error Code Pen Device ui ol Error Code Password Get Enroll Count i 0x0128 0 1 Enroll Count Error Code FP Cancel 0x0130 0x0130 2 eee Table4 2 Command List haieasyelec enable your design Page 14 www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 Command Packet Desc
3. ERR INVALID PARAM J gt gt KS Checksum Command Data Packet and Response T P 3l lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 PREFIX O0xA55A MD 0x010B EN Template Record Size 2 DATA Template No 2byte Template Record Data PREFIX 5 5 0x010B ERR_SUCCESS ERR_FAIL Success Template No DATA 2byte Fail Error Code Example of Write Template 1 Host send Write Template command packet PREFIX CMD LEN DATA LN 2 Response to the write template command PREFIX RCM LEN RET DATA CKS i a lal ll dl a ad 3 Host send Command Data Packet with Template No and Template Data CKS EN 4 After check the command data packet is correct module write the template data to Flash memory and then response the command data packet DATA CK ee c Ga ad c a d 32 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 12 Set Security Level Function Set Security Level Set up the threshold of fingerprint identification engine Integer of 1 5 can be selected one is the lowest identification level and five is the highest identification level Default is three Operation Sequence 1 if value of the security level is invalid resultZERR INVALID SEC VAL 2 else update the value of Security Level then response the
4. Error Code O KS Checksum T P 53 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Example Host send m downloaded feature data with captured FP command packet p prs oer 2 Module return Tm to host 0 3 Host download template data to module PREFIX CD loxiB OxF2 498Bytes Template Data 0 5 5 4 Module detect m then S and response the result ses ee or eor or ra oru er Tor vri P 54 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 28 Identify Downloaded Feature with Captured FP Function Download 2 templates data and identify with captured fingerprint This command is equivalent Write Template Data 2 times and Identify command Sequence 1 Host send this command packet cause module wait for receive Command Data Packet to get template data from Host Host set length of template data in the data field of command packet 2 Module return response packet to inform host that module have get ready for receive the first template data packet 3 Host send command data packet with the first template data to module 4 Module return response packet with result GD DOWNLOAD SUCCESS inform host waiting for the next template data 5 Host send command data packet with the second template data to mo
5. Template Di I Duplication ID Enroll One Time 0x0104 Template No 0x0104 Template No Fr pe pc Clear Template Ox0105 Template No 0 0105 Template No Error Code Clear All Template 0 0106 0 0106 Cleared Template Count Error Code Get Empty ID 0 0107 0 0107 Template No rem Prop TT rm Get Template Status 0x0108 Template No 0x0108 Template Status ll Error Code Page 12 haieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Get Broken Template 0 0109 MUT 0x0109 NI 0 1 Read Template 0x010A 2 Template No 0x010A Template Record Size 4 or 4 Write Template OxO10B Template Record Size Get Security Level 0x010D po m a 15 Get Finger Time Out Ld pem d mau amm B F W Version 12 12 er f Set Baud Rate 0 0114 2 Baud Rate 0 0114 4 0 1 Index Set Duplication Check 0x0115 Duplication 0 0115 Option 1 0 ee DS haieasyelec enable your design DATA Broken Template Count First Broken Template No Error Code Template No Template Record Data Error Code Template No 0 010 4 0 1 Template No Template Record Data Error Code Set Security Level Security Level mh Security Level Value Value Error Code Level Set Finger Time
6. communication packet 3 2 1 Command packet Command Packet is the instruction from Host to Target Total length of the command packet is 24 Bytes 3 2 2 Response packet Response packet is result of execute command packet from Target SM2A xx to Host Total length of the command packet is 24 Bytes 3 2 3 Data Packet When length of Command Parameter or Data 15 larger than 16 Bytes Utilize Data Packet to transmit block Data the maximum length of Data Packet is 512Bytes 3 3 Packet Structure 3 3 1 Packet Identify Code Section of start 2byte prefix define type of packet Type of Packet Command packet 55 Response packet OxSSAA Command Data Packet OxA55A Response Data Packet OxSAAS 3 3 2 Structure of Command Packet PREFIX DATA CKS FK Nm Check Sum 15 the low word of value listed below 22 CKS WORD offset 0 offset 1 offset 21 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 3 3 3 Response packet RET DATA CKS OFFSET FIELD TYPE SIZE DESCRYPTION a L R WORD 2byte Result Code 0 success 1 fail Check Sum is the low word of value listed below 22 WORD offset 0 offset 1 t0ffset 2 1 3 3 4 Command Data Packet PREFIX CMD LEN DATA mu I5 eee WORD 2byte n n lt 17 RET and DAT
7. on sensor 0 no finger on sensor ___ Notice Host need send Sensor LED Control enable command to power on LED before Finger Detect command otherwise the result of Finger Detect is incorrect Example Detect Finger command packet Response Packet of Finger detect T P 41 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 20 Set Baud Rate Function Set UART Baud Rate Command and Response PREFIX 55 Baud Rate Index 1 9600bps 2 19200bps DATA 3 38400bps 4 57600bps 5 115200bps CMD EN o Success Baud Rate Index DATA Fail ERR INVALID BAUDRATE Notice New value is active only by reset or power on Example Set Baud Rate 9600BPS Response packet T P 42 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 21 Set Duplication Check ON OFF Function Setup Enable Disable fingerprint duplication check when execute Enroll or Enroll One Time command Command and Response PREFIX 0x55AA RCM ERR SUCCESS or ERR FAIL Success 1 0 status of duplication check DATA Fail ERR INVALID DUP VAL Example Set duplication check Enable PREFIX CMD LEN DATA que pes e eser Response Packet ees 1 Cd Gam T P 43 lhaieasyelec enable your design www l haiEasyElec com ESENII9A FPO 001
8. 0 0x18 T P 37 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 16 Set Device ID Function Set the Device ID number 1 254 can be selected Default is 1 Operation Sequence 1 if the value is out off range resultZERR INVALID PARAM 2 else update the value of Device ID and response the command Command and Response PREFIX 55 KS Example of Set Device ID Command Packet Response Packet 5 T P 38 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 17 Get Device ID Function Read Device ID of the module Command and Response EM MN O Example of Get Device ID Command Packet Response packet S sal id id id i i ad vri P 39 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 18 Get F W Version Function Get Firmware Version of the Module Command and Response Example Command Packet Es eps pen eres em erem Response Ta LN MN ain 0x0 T P 40 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 19 Finger Detect Function Detect whether finger press on sensor or not Command and Response o EM O a CMD EN CKS PREFIX 55 CKS Result of detect DATA 1 Finger
9. 1 27 ERR NO RELEASE 0x71 In process of Identify Free command aeq Finger 1s not release T P 70 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 5 2 Flow of Enroll and Verify and Identify process 5 2 1 Enroll Waiting for finger Capture Success Increasing Counter Generalize Success Yes Result Success Result Fail Fig 5 1 Flow of Enroll T P 71 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 5 2 2 Verify amp Identify Waiting for finger mm No No Result Timeout No Capture Success Yes Verify or Identify Result Fail Result Accept Result Reject Fig 5 2 Flow of Verify and Identify Page 72 lhaieasyelec enable your design
10. 34 Get Enroll Count Function Get total number of fingerprint template that have enrolled Command and Response PREFIX 55 O ________ ERR_SUCCESS ERR_FAIL DATA Total number of template or Error Code Example Host send Get Enroll Count espe Ten penes e sm Module Tp result of rc enroll count n MN mre 0x2 peni pe F pe T P 64 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 35 FP Cancel Function Cancel current operation 1 In the period of process following command Verify Identify Enroll Enroll One Time Enroll and Store in RAM Get Feature Data of Captured FP Verify Downloaded Feature with Captured FP Identify Downloaded Feature with Captured FP Once received command of FP Cancel stop the command in process immediately then return 2 response packet One 15 result ERR_ CANCEL indicate current command have been cancelled The other result ERR_SUCCESS denote that operation of cancel is successful 2 for the other command except above 6 only return one response packet that 1s Result ERR SUCCESS denote that operation of cancel 15 successful Command and Response 55 0 0130 lhaieasyelec enable your design Page 65 www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Example 1 Host sends FP Cancel commonly Module response the result of canc
11. A ET KS OFFSET FIELD TYPE SIZE DESCRYPTION SS DON P Fw wa M LL Check Sum 15 the low word of value listed below 6 n CKS WORD offset 0 offset 1 t0ffset 6 n 1 Before send Command Data packet Host first send Command packet which set the length of next command data packet in Data Field haieasyelec enable your design Page 10 www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 3 3 5 Response Data Packet Fep 6 1 1 sre OFFSET FIELD SIZE DESCRYPTION PREFIX WORD _ 2byte Packet Identify code 2 RCM WORD 2byte Response Code 4 LEN WORD 2byte n n lt 512 Length of result data RET DATA WORD 2byte Result code 0 success 1 fail Check Sum 15 the low word of value listed below 6 n CKS WORD 2byte offset 0 offset 1 t0ffset 6 n 1 T 11 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 Packet Command Detail Description 4 1 Structure of Fingerprint Template Data is follow Template Data 496 Bytes Checksum 2 Bytes 498 Bytes Template Data Checksum 496 bytes Template Data 2 byte Check Sum is the low word of value listed below 0 11 0495 1 0495 4 2 Command List T Verify 0x0101 Template No 0x0101 0 1 Template No Identify 0 0102 0 0102 4 0 1 Template No Enroll 0 0103 Template 0 0103
12. ED_RELEASE_ FINGER 5 identify and return the result if identify OK result ERR_SUCCESS Template No else result ERR_FAIL ERR_IDENTIFY 6 go to step2 until FP Cancel command 7 if received FP Cancel command stop identify free command and return ERR FP CANCEL T P 60 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Command and Response ERR SUCCESS or ERR FAIL Success GD NEED RELEASE FINGER Template No Fail ERR ALL TMPL EMPTY 2byte ERR BAD QUALITY ERR IDENTIFY ERR NO RELEASE Example Host send Identify Free command packet PREFIX CMD wo om m o dE d c NN o a a Module response the result GD NEED RELEASE FINGER and 1 CKS 2 T P 61 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 32 Set Device Password Function Set password of communication between host and module Default setting is null all command can be executed and verify password 15 needless Password is composed by 14bytes ASCII code less than 14byte will report error Password is authentication by Verify Device Password command If new password is setup successful all command is invalid unless Verify Device Password is successful But Test Connection and Verify Device Password command 15 valid Command and Response PREFIX 55 14 Bytes passw
13. ESEN119A FPO 001 Fingerprint Optical Scan OEM Module V2 User Manual V 1 1 enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Table of Contents 1 SUMMARY 4 1 1 Main functions 4 1 2 Application examples 4 1 3 Technology Parameter 5 1 4 Default Setting 5 2 CONFIGURATION AND CONNECTOR 6 2 1 Mount and Connector 6 2 2 Dimension 7 3 COMMUNICATION PROTOCOL 8 3 1 The process of communication 8 3 2 Classify of communication packet 9 3 2 1 Command packet 9 3 2 2 Response packet 9 3 2 3 Data Packet 9 3 3 Packet Structure 9 3 3 1 Packet Identify Code 9 3 3 2 Structure of Command Packet 9 3 3 3 Response packet 10 3 3 4 Command Data Packet 10 3 3 5 Response Data Packet 11 4 PACKET COMMAND DETAIL DESCRIPTION 12 4 1 Structure of Fingerprint Template Data is follow 12 4 2 Command List 12 4 3 Command Packet Description 15 4 3 1 Verify 15 4 3 2 Identify 17 4 3 3 Enroll 19 4 3 4 Enroll One Time 22 4 3 5 Clear Template 24 4 3 6 Clear All Template 25 4 3 7 Get Empty ID 26 4 3 8 Get Template Status 27 4 3 9 Get Broken Template 28 4 3 10 Read Template 29 4 3 11 Write Template 31 4 3 12 Set Security Level 33 4 3 13 Get Security Level 35 4 3 14 Set Finger Time Out 36 4 3 15 Get Finger Time out 37 4 3 16 Set Device ID 38 4 3 17 Get Device ID 39 4 3 18 Get F W Version 40 4 3 19 Finger Detect 41 4 3 20 Set Baud Rate 42 4 3 21 Set Duplication Check ON OFF 43 4 3 22 Get Du
14. FIRST_SWEEP denote that press finger for the first time 2 detect finger whether press on sensor or not repeatedly if no finger press on sensor in the period of timeout result ERR_TIME_OUT 3 else check quality of captured finger image if image is no good result ERR_BAD_QUALITY 4 else result GD_NEED_RELEASE_FINGER denote that lift finger after finger release then go to next step 5 result GD_NEED_SECOND_SWEEP denote that press the same finger for the second time and then go to step2 3 6 if the second input fingerprint 1s correct result GD_NEED_RELEASE_FINGER denote that lift finger after finger release then go to next step 7 result GD_NEED_THIRD_SWEEP denote that press the same finger for the third time and then go to step2 3 8 if the third input fingerprint is correct result GD_NEED_RELEASE_FINGER denote that lift finger 9 the module generalize the three templates to one template success go to steep 10 fail result ERR_GENERALIZE 10 result 0 and storage the template data into RAM 11 In the period of process the command if module received FP Cancel commands the module then stop this command and return ACK that is ERR CANCEL Please refer to appendix about the flow of Enroll T 46 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Command and Response PREFIX 55 PREFIX 0x55AA RCM ERR SUCCESS or ERR FAIL success GD NEED FIRST S
15. R_TIME_OUT ERR_BAD_QUALITY a Host send identify command command packet as follow PREFIX DATA SS a if finger is on sensor and captured image is good module return GD NEED RELEASE FINGER Module return the result of identify Oresponse packet as follow fo pofa Jo Joon e e ener pr T P 18 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 3 Enroll Function Enroll In the process of enroll The same finger must be press on the sensor for 3 times each time module get template temporary and storage in RAM if the three templates are correct the module generalize the three templates to one template then write to Flash memory Operation Sequence 1 if the appoint template No is invalid result ERR INVALID NO 2 if the template No have existed template data resultZERR TMPL NOT EMPTY 3 else result ZGD NEED FIRST SWEEP denote that press finger for the first time 4 detect finger whether press on sensor or not repeatedly if no finger press on sensor in the period of timeout resultZERR TIME OUT 5 else check quality of captured finger image if image is no good resultZERR BAD QUALITY 6 else resultZGD NEED RELEASE FINGER denote that lift finger after finger release then go to next steep 7 resultZGD NEED SECOND SWEEP denote that press the same finge
16. V2 User Manual v 1 1 4 3 22 Get Duplication Check Function Get status of Duplication Check Command and Response PREFIX 55 PREFIX 55 Status of duplication check currently DATA 1 Enable 0 Disable Example Get status of Duplication Check PREFIX CMD LEN DATA epe een e Response Packet nsi RN NN Lan 1 Pe haieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 23 Enter Standby Mode Function Put module into standby mode Only reset or power on will lead module from standby mode to active mode Sequence 1 Module enter into Standby Mode and result ERR_SUCCESS 2 From standby mode to active mode only by RESET or Power ON Command and Response ERR_SUCCESS Notice Before power off module enter Standby Mode Command is recommended Example Enter IM Response Packet PREFIX at eae 0 T P 45 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 24 Enroll And Store in RAM Function The same as Enroll command exclusive difference 15 Enroll command store template data into FLASH memory but Enroll And Store in RAM command store template data into RAM temporarily host can utilize Get Enroll Data command acquire template data Sequence 1 else result GD_NEED_
17. WEEP GD NEED SECOND SWEEP or DATA NEED THIRD SWEEP GD NEED RELEASE FINGER O Fail ERR TIME OUT or ERR QUALITY or ERR GENERALIZE Example Enroll And Store in RAM command packet mx Packet 0 ld ul id deri le 8 0 x04 0x00 0x00 0x00 OxF4 OxFF 0x00 OxOF 0x03 mr sar ses 0 01 id NN iul MM 1 47 m enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 25 Get Enroll Data Function Get template data after execute the Enroll and Store in RAM command This command 15 the same as Read Template command refer to Read Template Command and Response 55 0 0119 PREFIX 771 0 0119 ERR SUCCESS ERR FAIL Success Template Record Size indicate the length of data field in Response Data Packet Fail Error Code i Response Data Response Data DATA Template Record Data vri P 48 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Example of Get Enroll Data Response Packet and Response Data Packet Laud un 0x01 0x00 0x00 0x01 0 00 a 0x19 0x01 0x01 498Bytes Template Data T P 49 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 26 Get Feature Data of Captured FP Function Get template data when captu
18. ature with Captured fingerprint Identify Downloaded Feature with Captured fingerprint Security Level setting 0 Standby mode 1 Communication interface UART 1 2 Application examples Access control systems Time amp Attendance Locks safes POS terminals Ir haieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 1 3 Technology Parameter Item CPU ACS 120MHz IMbits Flash 128K SRAM Sensor Optic sensor Fingerprint capacity FAR FRR Match Mode Fingerprint Data size Security level Time of Response 1 N matching 2000 fingerprints lt 1s UAR m Parity NONE Stop 1 Flow Control NONE Baud rate is 9600 19200 38400 57600 1 15200 BPS Default setting 9600bps Working Voltage 3 3V 5 Max 100mA Standby Mode less than 5mA Working Temperature 10 C 60 C Relative humidity 20 80 Gorce Pus Storage temperature 20 80 E Storage humidity lt 90 1 4 Default Setting Resistant to Abrasion gt Million Finger Press T Working Current Working Environment Baud Rate 9600 19200 38400 57600 115200 9600 bps Fingerprint Duplication Check ON OFF lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 2 Configuration and Connector 2 1 Mount and Connector Connector Signal description DC Inpu
19. be used for storage fingerprint template Operation Sequence Search the first number that can be used for storage fingerprint template if all fingerprint data base is full result ERR EMPTY ID NOEXIST else result template No that can be utilized Command and Response PREFIX 55 PREFIX 0x55AA ERR_SUCCESS or ERR_FAIL Success template No that can be utilized DATA 2byte Fail ERR EMPTY ID NOEXIST Example of Get Empty ID Command packet PREFIX CMD LEN DATA EIE mem Response Packet 0x0 T P 26 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 8 Get Template Status Function Check the specified Template No whether can be utilized or not Command and Response Success GD TEMPLATE NOT EMPTY DATA 2byte GD TEMPLATE EMPTY Fail ERR INVALID TMPL NO Example of Get Template Status Get template status that No 21 command packet 0x0 j oss oan pot nfo a ome Response Packet 0 em gt 27 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 9 Get Broken Template Function Check template Data Base integrality Check fingerprint template Data base whether is damage or not Some unit of FLASH memory may be damaged by chance failure For the broken template data you can delete the template and then enroll again
20. command Security Level and Fingerprint Identification precision Security Level Value of FAR amp FRR FAR False Acceptance Rate 0 01 Level 1 FRR False Rejection Rate 0 005 FAR False Acceptance Rate 0 003 Level 2 FRR False Rejection Rate 0 01 FAR False Acceptance Rate 0 001 Level 3 FRR False Rejection Rate FAR False Acceptance Rate 0 0003 Level 4 FRR False Rejection Rate FAR False Acceptance Rate 0 0001 96 Level 5 FRR False Rejection Rate T P 33 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Command and Response PREFIX 55 Value of Security Level ___ _ PREFIX 0x55AA pa SUCCESS or ERR FAIL Success The Value of Security Level DATA Fail ERR INVALID SEC VAL ___ Example of Set Security Level Set Level command Las qe pee Ton on om om es en e Set LAM Level command response a perpe Tere em e e pem em Tem eo e T P 34 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 13 Get Security Level Function Host read the value of Security Level from module Command and Response PREFIX 0x55AA DATA Value of Security Level Example of Get Security Level Get mex E Level command ux 0x0 d ani bnd Get Level command response T P 35 lhaieasyelec enabl
21. dule 6 After module received the 2 templates data successful module detect finger continually 7 if no any finger on sensor in the period detect finger resultZERR TIME OUT 8 check the quality of captured fingerprint image if the image 16 not good result ERR_BAD_QUALITY 9 else identify the 2 template s data with captured fingerprint and then response result of identify 10 In the period of process the command if module received FP Cancel commands the module then stop this command and return ACK that is ERR_FP_CANCEL T P 55 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Command and Response TO C em PREFIX 55 MD 0x011C EN DATA Template Record Size PREFIX 0x55AA 0x011C Hm EN ET ERR_SUCCESS or ERR_FAIL DATA Success 0 Fail Error Code S OL J ar D em s Page 56 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 ERR SUCCESS or ERR FAIL DATA Success 0 Fail Error Code Example Host send Identify Downloaded Feature With Captured FP command packet ps a Em 2 Module return response packet to host um e qm pe em a E d ll dd al d 3 Host send the first template data to module PREFIX e 4 Modul
22. e request the next template data PREFIX RCM LEN RET DATA CK Edi i i d d nd il la 5 Host send the second template data to module mm pe pe ps Em CKS wm 6 Module detect finger then identify and response the result PREFIX RCM LEN RET DATA CK dia d i i d d vri P 57 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 29 Get Device Name Function Read Device name of module Command and Response DEM m Success STO20 OEM DATA Fail Error Code Example Get Device Name command packet Response Packet T P 58 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 30 Sensor LED Control Function ON OFF LED of fingerprint sensor Command and Response Example Sensor LED ON command packet Response Packet T P 59 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 31 Identify Free Function The command cause module detect finger then identify and return result continually still received FP Cancel command gt gt detect finger gt identify gt return identify result 7 Sequence 1 if no any template data result ERR_ALL_TMPL_EMPTY 2 Detect finger continually 3 Check quality of fingerprint image if image is no good result ERR_BAD_QUALITY 4 else image is good result GD_NE
23. e your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 14 Set Finger Time Out Function Verify Identify Enroll Enroll One Time Enroll And Store in RAM Get Feature Data of Captured FP Verify Downloaded Feature with Captured FP Identify Downloaded Feature with Captured FP Identify Free In the period of above command executing the parameter of the Finger Time out is the time limit of detect finger on sensor repeatedly 0 60s can be selected Default is 5s Operation Sequence 1 if the value of Time out is out off range resultZERR INVALID TIME OUT 2 else update the value of Time out and response the command Command and Response DATA Value of Time Out OxOIOE SUCCESS ERR FAIL DATA Value of Time Out or ERR INVALID TIME OUT Example of Set Finger Time out Set Finger Time out command packet PREFIX CMD 0 55 OxAA OxOE 0x01 0x02 0x00 0 00 0x00 Command response packet PREFIX OxOE 0x01 0x04 0x00 0x00 0x00 OxOA 0x00 OxAA 0x55 pg c enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 15 Get Finger Time out Function Read the value of Finger Time out Command and Response DATA Value of Time Out BEEN o Example of Get Finger Time out Command packet PREFIX 0x55 OxAA JOxOF 0x01 0x00 0x00 OxOO 0x00 Response packet PREFIX OxAA 0x55 JOxOF 0x01 0x04 0x00 0x00 0x00 0 05 0x00 0x0
24. el Example 2 In process of executing Enroll command host send FP Cancel command Module response two result as following Result ERR CANCEL denote that module have stop Enroll command Result ERR SUCCESS denote that operation of cancel is successful T P 66 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 36 Test Connection Function Test connection between host and module Command and Response o __________ KS RCM N T S CM ERR_SUCCESS ERR_FAIL Example of Test Connection Host send Test Connection Command packet Module response connection is successful vri P 67 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 37 Incorrect Command Function Response to host that the command is incorrect by interference effect Command and Response PREFIX 0x55AA CM 0 0160 4 ERR SUCCESS 5 Example Host send incorrect command Response the incorrect command gt 68 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 5 Appendix 5 1 Response and Error Code em 770007 Id precem eren m mu REP 0x51 Memory Error T P 69 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1
25. ft finger 6 if Duplication Check OFF storage the template data and return result Template No 7 if Duplication Check ON the template data match to all template to check whether exist duplicated fingerprint or not Yes result ERR DUPLICATION ID else result Template No and storage the template data 8 In the period of process Enroll One Time command if module received FP Cancel the module then stop the command and return ACK that is ERR FP CANCEL Notice we recommend using Enroll command disapproval using Enroll one time command Command and Response Ir 22 haieasyelec enable your design WWW En Ee re com ESENII9A FPO 001 V2 User Manual v 1 1 Success GD NEED RELEASE FINGER Template No Fail Error Code 18 as follow ERR INVALID NO ERR TMPL NOT EMPTY ERR TIME OUT ERR BAD QUALITY X or ERR DUPLICATION ID Example of Enroll One Time Enroll to No 1 Enroll One Time Command packet 15 as follow pe o pepe lc Response Packet is as follow erer MN a s 0x0 Ie per 0x0 T P 23 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 5 Clear Template Function Delete specified template data Delete template data with specified ID from database after this command is executed specified template data are deleted immediately Operation Sequence 1 if the appoi
26. nt template No is invalid result ERR INVALID TMPL 2 if the appoint template No is inexistence template data TMPL EMPTY 3 else delete specified template data and then return response packet Command and Response Ox55AA 0x0105 Success Template No to be deleted Fail Error Code 18 as follow ERR INVALID NO ERR TMPL Example of Clear Template Clear Template No 21 command packet erem mm Response packet per ao oe os oor e Page 24 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 6 Clear All Template Function Clear All Template Delete all template data in database After this command is executed all fingerprint template data are deleted immediately Command and Response 55 0 0106 55 0 0106 ERR_SUCCESS ERR_FAIL Success Total number of deleted template Fail Error code Example of Clear All Template Host sends Clear All Template Command Packet PREFIX CMD DATA ld Response Packet 0x06 0 01 0x04 0 00 0x00 0x00 0x01 0x00 00 0x01 0 55 X X X X X X X X X B X vri P 25 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 7 Get Empty ID Function Get Empty ID Get the first number that can
27. of Read Template Read Template Command Packet 0x0 abe FE Response and Response Data Packet 0x0 m Bytes OxAS OxSA JOxOA 00x01 OxF6 0 01 Ox00 0x00 0 01 0x00 Template Data T P 30 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 11 Write Template Function Download fingerprint template data with specified ID number from host to module then write to module s fingerprint template Database Operation Sequence Host send Write Template command to cause module wait for receive Command Data Packet to get template data from Host 1 Module checks the Command packet whether 15 correct or not if size of Template record is incorrectness resultZERR INVALID PARAM else return response packet and prepare receive template data Command Data Packet 2 Host send Command Data Packet with template No and Template Data 3 after receive Command Data Packet 1s successful if the appoint template No 16 invalid result ERR INVALID TMPL if Checksum of Template Data is incorrectness resultZERR INVALID PARAM 4 else Template Data that received write to Flash Memory Command and Response Co ect co eo un un 2 Template Record Size ge PREFIX 0x55AA 0x010B ERR_SUCCESS ERR_FAIL Success 0 2byte Fail
28. ord form by Code CM EN ET KS PREFIX 55 ERR SUCCESS ERR FAIL Success DATA Fail Error Code Example Host send Set Device Password command packet 0 26 0 01 14Bytes ASCII Code Module response the result of Set Device Password 2 gt 62 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 33 Verify Device Password Function Verify password between host and module Device Password is null by Default setting and all command 15 valid verify device password command is needless If device s new password is setup ever time power on the device from power down the module is safeguard by password all command except 15 invalid ResultZERR NOT AUTHORIZED until verify password is successful but Verify Device Password and Test Connection command is valid in any time Sequence 1 if verify device password is OK result ERR SUCCESS all command is valid 2 else result ERR NOT AUTHORIZED module is safeguard by password Command and Response DATA 14 Bytes password form by ASCII code ERR SUCCESS or ERR FAIL DATA 0 ERR NOT AUTHORIZED Example Host send Device Password command packet Module the result of device 2 T P 63 lhaieasyelec enable your design www l haiEasyElec com ESENII9A FPO 001 V2 User Manual v 1 1 4 3
29. plication Check 44 4 3 23 Enter Standby Mode 45 4 3 24 Enroll And Store in RAM 46 haieasyelec De enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 25 Get Enroll Data 48 4 3 26 Get Feature Data of Captured FP 50 4 3 27 Verify Downloaded Feature With Captured FP 52 4 3 28 Identify Downloaded Feature With Captured 55 4 3 29 Get Device Name 58 4 3 30 Sensor LED Control 59 4 3 31 Identify Free 60 4 3 32 Set Device Password 62 4 3 33 Verify Device Password 63 4 3 34 Get Enroll Count 64 4 3 35 FP Cancel 65 4 3 36 Test Connection 67 4 3 37 Incorrect Command 68 5 APPENDIX 69 5 1 Response and Error Code 69 5 2 Flow of Enroll and Verify and Identify process 71 5 2 1 Enroll 71 5 2 2 Verify amp Identify 72 haieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 1 Summary FPO 001 is All in one Optic sensor CMOS image sensor CPU Flash memory embedded stand alone fingerprint identification modules It is convenient for second development extremely easy to integrate minimizing time to market 1 1 Main functions Optic sensor is reliable and Low cost High ESD Protection 1 N Identification One to Many 1 1 Verification One to One High speed fingerprint identification algorithm engine Self study function Fingerprint template data read from write to FLASH memory function Get Feature Data of Captured fingerprint Verify Downloaded Fe
30. r for the second time and then go to step 4 5 8 if the second input fingerprint is correct result NEED RELEASE FINGER denote that lift finger after finger release then go to next steep 9 resultZGD NEED THIRD SWEEP denote that press the same finger for the third time and then go to step 4 5 10 if the third input fingerprint 1s correct resultZGD NEED RELEASE FINGER denote that lift finger 11 the module generalize the three templates to one template success go to steep12 fail resultZERR GENERALIZE 12 if Duplication Check OFF storage the template data and return result Template No 13 if Duplication Check ON the template data match to all template to check whether exist duplicated fingerprint or not if yes result ERR DUPLICATION ID else result Template No and storage the template data 14 In the period of process ENROLL command if module received FP Cancel command the module then stop ENROLL command and return that is ERR CANCEL gt haieasyelec enable your design Page 19 www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Please refer to appendix about the flow of Enroll _________ 5 Success Command and Response z5 tr e Un zi tr 2 GD_NEED_FIRST_SWEEP GD_NEED_SECOND_SWEEP GD_NEED_THIRD_SWEEP GD_NEED_RELEASE_FINGER or Template No 2byte Fail Error Code 1s as follo
31. red a fingerprint image This command 15 equivalent Enroll One Time Get Enroll Data command Sequence After module have received the Get Feature Data of Captured FP command Module detect finger continually 1 if no any finger on sensor in the period detect finger result ERR_TIME_OUT 2 check the quality of captured fingerprint image if the image is not good result ERR_BAD_QUALITY 3 else acquire the template data and upload to host utilize Response data packet 4 In the period of process the command if module received FP Cancel commands the module then stop this command and return ACK that 15 ERR_FP_CANCEL Command and Response 55 11 PREFIX _____ 0x011A Page 50 enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 DATA Template Record Data Example Get Feature Data of 1 Response and Response Data Packet ps poor Ts oe oto vri P 51 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 27 Verify Downloaded Feature With Captured FP Function Verify downloaded template data with captured fingerprint This command 15 equivalent Write Template Data and Verify command Sequence Host send this command packet cause module wait for receive Command Data Packet to get template data f
32. response packet as follow 00 vri P 16 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 2 Identify Function One to many match The live scanning fingerprint matches to all templates stored in FLASH memory and then respond the result Operation Sequence 1 if Template Data Base is null result ERR ALL TMPL EMPTY 2 detect finger whether press on sensor or not repeatedly if no any finger press on sensor in the period of timeout result ERR TIME OUT 3 else check quality of the captured fingerprint 1mage if image is not good result ERR BAD QUALITY 4 else resultzGD NEED RELEASE FINGER denote that lift finger 5 identify the captured fingerprint with the all template data in FLASH memory if identify ok result matched template No else result ERR IDENTIFY 6 In the period of process identify command if module received FP Cancel command The module then stop identify command and return ACK that is ERR FP CANCEL Please refer to appendix about the flow of Verify amp Identify Command and Response PREFIX 55 Ox55AA 0x0102 wo Bes SUCCESS or ERR FAIL DATA 2byte GD NEED RELEASE FINGER or Template No Fail Error Code 15 as follow Example of Identify Command T P 17 Jhaieasyelec enable your design WWW Re En UPS ESENII9A 001 V2 User Manual v 1 1 ERR_IDENTIFY ERR_ALL_TMPL_EMPTY ER
33. ription 4 3 1 Verify Function one to one match Operation Sequence 1 if the template No is invalid result ERR INVALID NO 2 if the template No there is no template data result ERR TMPL EMPTY 3 detect finger whether press on sensor or not repeatedly if no any finger press on sensor in the period of timeout result ERR TIME OUT 4 else check quality of the captured fingerprint image if image is not good result ERR BAD QUALITY 5 else resultZGD NEED RELEASE FINGER denote that lift finger 6 verify the captured fingerprint with the appoint template data if verify ok result Template No else result ERR VERIFY 7 In the period of process verify command if module received FP Cancel command The module then stop verify command and return ACK that is ERR CANCEL Please refer to appendix 5 2 2 about the flow of Verify amp Identify Command and Response 101 T P 15 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 ERR_SUCCESS or ERR_FAIL Success GD_NEED_RELEASE_FINGER or Template No Fail Error Code is as follow ERR_VERIFY DATA ERR_INVALID_TMPL_NO ERR_TMPL_EMPTY OUT ERR_BAD_QUALITY Example of Verify Command 1 Host send Verify Template No 1 command packet as follow 2 if finger 1s on sensor and captured image 15 good module then return NEED RELEASE FINGER 3 Module return the result of verify
34. rom Host Host set length of template data 1n the data field of command packet 2 Module return response packet to inform host that module have get ready for receive template data packet 3 Host send command data packet with template data to module 4 After module received the template data successful module detect finger continually 5 if no any finger on sensor in the period detect finger resultZERR TIME OUT 6 check the quality of captured fingerprint image if the image is not good resultZERR QUALITY 7 else verify and then response the result of verify 8 In the period of process the command if module received FP Cancel commands the module then stop this command and return ACK that is ERR FP CANCEL T P 52 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Command and Response x ge Co ect PREFIX 55 OxO11B Template Record Size KS Checksum PREFIX 0x55AA EN ERR_SUCCESS ERR_FAIL DATA Success 0 Fail Error Code gt KS Checksum Co ax or Co oct PREFIX 55 C MD OxO11B Template Record Size DATA Template Record Data KS Checksum PREFIX OxSAA5 0x011B EN z ERR_SUCCESS ERR_FAIL DATA Success 0 Fail
35. t range of voltage is Power 3 3V 5 GND Module Receive Input Rx 3 3V TTL PING 433V lt 00 Please note that old module have 2 versions of PCB previous Blue and current Green different in pins assignment Use their cable s color to identify Version 2 module have black PCB with 7 pins cable Reset pin located on red dotted line marked as PINI Attention Power supply 1s only 3 3V 5V or more might destroy the module Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 2 2 Dimension 19 651 12 1000 Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 3 Communication Protocol The module 1s used as a slave device The Master device sends relative commands to control it The CMD sent by the master and the ACK signal returned by the module Command interface UART Universal Asynchronous Receiver Transmitter Default Setting is 960 5 1 start bit 1 stop bit no parity check bit 3 1 The process of communication HOST _TARGET SM2A 12 20 Command Packet Data Packet SS eee eee ees Receive Result Data Packet Fig3 1 Process of Communication Notice Host not send next command until receive result except send FP Cancel Jhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 3 2 Classify of
36. w DATA ERR_INVALID_TMPL_NO ERR_TMPL_NOT_EMPTY ERR_TIME_OUT ERR_BAD_QUALITY ERR_GENERALIZE 2byte or ERR DUPLICATION ID Un vri P 20 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 Example of Enroll Command Enroll to Template No 1 Command Packet Response Packet PREFIX RCM RET DATA CKS for por ow orn XF1 0x00 0x00 OxF4 OxFF 0x00 OxFA 0x02 0x00 0x00 OxF2 OxFF 0x00 OxF8 0x02 0 0x00 x00 0x00 OxF4 OxFF 0x00 OxFA 0x02 0x00 0x00 OxF3 OxFF 0x00 OxF9 0x02 a lal ll di id inh i d ud nd T P 21 lhaieasyelec enable your design www l haiEasyElec com ESENI19A FPO 001 V2 User Manual v 1 1 4 3 4 Enroll One Time Function Enroll One Time Enroll command require the same finger press on the sensor for 3 times corresponding Enroll One Time command require the finger press on sensor for one time only Operation Sequence 1 if the appoint template No is invalid result ERR INVALID NO 2 if the template No have existed template data resultZERR TMPL NOT EMPTY 3 detect finger whether press on sensor or not repeatedly if no finger press on sensor in the period of timeout resultZERR TIME 4 else check quality of captured finger image if image is no good resultZERR BAD QUALITY 5 else resultzGD NEED RELEASE FINGER denote that li
Download Pdf Manuals
Related Search