Home

FPO-001 - Thaieasyelec.net

1. ERR_SUCCESS or ERR_FAIL Device ID or ERR INVALID PARAM CheckSum Example of Set Device ID Command Packet PREFIX CMD 0x55 OxAA 0x10 0x01 0x02 0x00 0x01 Response Packet PREFIX RCM LEN RET OxAA 0x55 0x10 0x01 0x04 0x00 0x00 0x00 0x01 4 3 17 Get Device ID Function Read Device ID of the module Command and Response 41 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System FPO 001 User s Manual www ThaiEasyElec com ERR_SUCCESS or ERR_FAIL Device ID or Error Code CheckSum Example of Get Device ID Command Packet PREFIX CMD 0x55 OxAA Ox11 0x01 0x00 0x00 0x00 Response packet PREFIX RCM LEN RET OxAA 0x55 0x11 OxO1 0x04 0x00 0x00 0x00 0x01 4 3 18 Get F W Version Function Get FirmWare Version of the Module Command and Response LEN 4 RET ERR_SUCCESS DATA DO Version Major 42 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual D1 Version Minor Example Command Packet PREFIX CMD CKS 0x55 OxAA JOx12 0x01 0x00 0x00 0x00 0x12 0x01 Response packet PREFIX RCM LEN RET OxAA loxss 0x12 0x01 0x04 0x00 0x00 0x00 0x02 0x09 4 3 19 Finger Detect
2. 4 3 32 Set Device Password Function Set password of communication between host and module Default setting is null all command can be executed Verify password is 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 TestConnection and Verify Device Password command is valid Command and Response RET ERR_SUCCESS or ERR_FAIL 61 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Success 0 DATA Fail Error Code CKS CheckSum Example Host send Set Device Password command packet PREFIX CMD LEN DATA 0x55 OxAA 0x26 0x01 OxOE 0x00 14Bytes ASCII Code Module response the result of Set Device Password PREFIX RCM LEN RET OxAA 0x55 0426 OxOL 0x04 0x00 0x00 0x00 0x00 0x00 4 3 33 Verify Device Password Function Verify password between host and module Device Password is null by Default setting and all command is 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 is invalid Result E
3. Function Detect whether finger press on sensor or not Command and Response Result of detect I Finger on sensor 0 no finger on sensor CheckSum 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 43 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual PREFIX CMD 0x55 OxAA 0x13 0x01 0x00 0x00 0x00 Response Packet of Finger detect PREFIX RCM LEN RET OxAA 0x55 0x13 0x01 0x04 0x00 0x00 0x00 0x01 0x00 0x18 4 3 20 Set Baudrate Function Set UART Baudrate Command and Response Baudrate Index 9600bps 19200bps 38400bps 57600bps 115200bps ERR SUCCESS or ERR FAIL Success Baudrate Index Fail ERR INVALID BAUDRATE Notice New value is active only by reset or power on Example Set Baudrate 9600BPS PREFIX CMD LEN DATA CKS 44 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 0x55 OxAA 0x14 0x01 0x02 0x00 0x01 Ox00 0x00 0x17 0x01 Response packet PREFIX RCM LEN RET CKS OxAA 0x55 0x14 OxO1 0x04 0x00 0x00 0x00 0x01
4. Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual PREFIX OxAA55 CMD 0x0109 LEN 0 DATA Null CKS CheckSum PREFIX 0x55AA RCM 0x0109 LEN 6 RET ERR SUCCESS or ERR FAIL Success total number of broken template DO D1 0 denote there is no any template are damaged DATA Fail Error Code The first template No of broken template D2 D3 0 denote there is no any template are damaged CKS CheckSum Example of Get Broken Template PREFIX CMD CKS 0x55 OxAA 0x09 0x01 0x00 0x00 0x00 0x09 0x01 Response Packet PREFIX RCM LEN RET OxAA 0x55 0x09 0x01 0x06 0x00 0x00 0x00 0x00 0x00 0x00 OxOF 0x01 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 result ERR_TMPL_EMPTY 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 30 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL
5. Set BaudRate Set Duplication Check 0x0114 Ox0115 BaudRate Index Duplication Check Option 1 0 0x0114 0x0115 BaudRate Index Error Code Duplication Check Option Error Code Get Duplication Check 0x0116 14 71 0x0116 Duplication Check Option Enable Your Design ThaiEasyElec comillll On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Function Command Response Enter Standby Mode 0x0117 0x0117 Enroll And Store in 0x0118 0x0118 0 ErrorCode RAM Get Enroll Data 0x0119 0x0119 Template Template Record Record Size Data Error Code 2 or 4 Get Feature Data 0x011A OxO11A Template Template Record Record Size Data Error Code of Captured FP 2 or 4 Verify Downloaded 0x011B Template Template 0x011B O Error Code Record Size Record Data Feature with Captured FP Identify Downloaded 0x011C Template Index 0x011C O Error Code Record Size Template Feature with Captured 2 Record Data FP Get Device Name 0x0121 0x0121 STO20 OEM Error Code Sensor LED Control 0x0124 0x0124 0 Identify Free 0x0125 0x0125 Template No Error Code Set Device Password 0x0126 Password 0x0126 0 Error Code Verify Device 0x0127 Password 0x0127 0 Error Code Password Get Enroll Count 0x0128 0x0128 Enroll Count Error Code FP Cancel 0x0130 0x0130 Test Connection 0x0150
6. 6 if the second input fingerprint is correct result GD NEED RELEASE FINGER denote that lift finger after finger release then goto next steep 7 resultzZGD NEED THIRD SWEEP denote that press the same finger for the third time and then goto steep2 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 goto steep IV 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 command the module then stop this command and return ACK that is ERR_FP_CANCEL Please refer to appendix about the flow of Enroll Command and Response 48 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual LEN 4 RET ERR SUCCESS or ERR_FAIL Success GD NEED FIRST SWEEP GD NEED SECOND SWEEP DATA GD NEED THIRD SWEEP GD NEED RELEASE FINGER 0 Fail ERR TIME OUT or ERR BAD QUALITY or ERR GENERALIZE CKS CheckSum Example Enroll And Store in RAM command packet PREFIX CMD 0x55 OxAA 0x18 0x01 0x00 0x00 0x00 Response Packet 4 3 25 Get Enroll Data Function Get template data after execute the Enroll and Store in RAM command This comman
7. OxAS 0x5A OxOB 0x01 0x04 0x00 0x00 0x00 0x01 0x00 0x10 0x01 35 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 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 result ERR INVALID SEC VAL 2 else update the value of Security Level then response the command Security Level and Fingerprint Identification precision Value of FAR amp FRR FAR False Acceptance Rate 0 01 FRR False Rejection Rate 0 005 FAR False Acceptance Rate 0 003 FRR False Rejection Rate 0 01 FAR False Acceptance Rate 0 001 FRR False Rejection Rate 0 1 96 FAR False Acceptance Rate 0 000396 FRR False Rejection Rate 0 5 FAR False Acceptance Rate 0 0001 96 FRR False Rejection Rate 196 36 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL Success the Value of Security Level Fail ERR INVALID SEC VAL CheckSum Example of Set S
8. 0x0150 Incorrect Command 0x0160 Table4 2 Command List 15 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 Command Packet Description 4 3 1 Verify Function one to one match Operation Sequence 1 2 3 4 CA if the template No is invalid result ERR INVALID TMPL NO if the template No there is no template data result ERR TMPL EMPTY 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 else check quality of the captured fingerprint image if image is not good result ERR BAD QUALITY else result GD NEED RELEASE FINGER denote that lift finger verify the captured fingerprint with the appoint template data if verify ok esult Template No else result ERR VERIFY 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 FP CANCEL Please refer to appendix 5 2 2 about the flow of Verify amp ldentify 16 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response Command Packet PREFIX OxAA55 CMD EN 2 DATA Template No Response Packet PREFIX OxSSAA RCM 0x0101 LEN 4
9. Success Template Record Size 2 Fail Error Code CheckSum Response Data Packet Template Record Size 4 ERR_SUCCESS Template No 2byte Template Record Data CheckSum 31 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example of Read Template Read Template Command Packet PREFIX CMD 0x55 OxAA OXOA 0x01 0x02 0x00 0x01 Response and Response Data Packet 0x00 0x00 0x00 OxF4 E 0x00 498 Bytes 0x5A 0x0A 0x00 0x01 Template Data 32 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 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 check the Command packet whether is correct or not if size of Template record is incorrectness result ERR_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 is successful if the appoint template No
10. function 6 Get Feature Data of Captured fingerprint 7 Verify Downloaded Feature with Captured fingerprint 8 Identify Downloaded Feature with Captured fingerprint 9 Security Level setting 10 Standby mode 11 Communication interface UART 1 2 Application examples Access control systems Time amp Attendance Locks safes POS terminals 4 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 1 3 Technology Parameter Item Description CPU AS602 Sensor Optic sensor Fingerprint capacity 500 5000 can be enlarge Default setting is 3000 fingerprints FAR lt 0 001 Security Level is 3 FRR 0 1 Security Level is 3 Match Mode 1 N identification and 1 1 verification Fingerprint Data size 496 Byte Security level Level 1 to Level 5 can be set default setting is Level 3 Time of Response Fingerprint pretreatment 0 45 1 N matching 2000 fingerprints 1s Resistant to Abrasion Million Finger Press UART Parity NONE Stop Bit 1 Flow Control NONE Communication Baud rate is 9600 19200 38400 57600 115200 BPS Default setting 115200bps Working Voltage DC 3 3V 5 Working Current Max omi Standby Mode less than 5mA Working Environment Working Temperature 10 C 60 C Relative humidity 20 80 St
11. 00 0x01 0x08 0x01 Response packet PREFIX RCM LEN RET OxAA 0x55 0x05 0x01 0x04 0x00 0x00 0x00 0x01 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 26 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL Success Total number of deleted template Fail Error code CheckSum Example of Clear All Template Host send Clear All Template Command Packet PREFIX CMD CKS 0x55 OxAA 0x06 0x01 0x00 0x00 0x00 0x06 0x01 Response Packet PREFIX RCM LEN RET OxAA 0x55 0x06 OxO1 0x04 0x00 0x00 0x00 0x01 4 3 7 Get Empty ID Function Get Empty ID Get the first number that can 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 27 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL Success template
12. 04 0x00 0x00 0x00 OxA1 0x00 OxCl 0x01 5 Host send the second template data to module PREFIX CMD LEN a Pak 0x1C 0x01 OxF4 0x01 498Bytes Template Data 6 Module detect finger then identify and response the result PREFIX RCM LEN RET DATA CKS OxAS OxSA Ox1C 0x01 0x04 0x00 0x00 0x00 0x00 0x00 0x20 0x01 57 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 29 Get Device Name Function Read Device name of module Command and Response ERR_SUCCESS or ERR_FAIL Success STO20 OEM Example Get Device Name command pscket PREFIX CMD 0x55 OxAA Ox21 0x01 0x00 0x00 0x00 Response Packet PREFIX RCM LEN RET OxAA 0x55 0x21 0x01 0x10 0x00 0x00 0x00 Device Name in ASCII 58 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 30 Sensor LED Control Function ON OFF LED of fingerprint sensor Command and Response Example Sensor LED ON command packet PREFIX CMD 0x55 OxAA 0x24 0x01 0x02 0x00 0x01 Response Packet PREFIX RCM LEN RET OxAA 0x55 0x24 0x01 0x04 0x00 0x00 0x00 0x00 0x00 59 71 Enable Your Design ThaiEasyElec com Mi
13. 0x00 0x19 0x01 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 ERR SUCCESS or ERR FAIL Success 1 0 status of duplication check Fail ERR INVALID DUP VAL CheckSum Example Set duplication check Enable PREFIX CMD CKS 0x55 OxAA 0x15 0x01 0x02 0x00 0x01 0x18 0x01 45 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Response Packet PREFIX RCM LEN RET OxAA 0x55 0x15 0x01 0x04 0x00 0x00 0x00 0x01 4 3 22 Get Duplication Check Function Get status of Duplication Check Command and Response Status of duplication check currently 1 Enable 0 Disable CheckSum Example Get status of Duplication Check PREFIX CMD CKS 0x55 OxAA 0x16 OxO1 0x00 0x00 0x00 0x16 0x01 Response Packet PREFIX RCM LEN RET OxAA oxss 0x16 0x01 0x04 0x00 0x00 0x00 oxo1 46 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 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
14. 1 Flow of Enroll 70 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 5 2 2 Verify amp Identify gt Waiting for finger uti o No No Result Timeout No Capture Success Yes Verify or Identify Result Fail M Yes Result Accept Result Reject Fig 5 2 Flow of Verify and Identify 71 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System
15. 2 Template No 0x0105 4 0 1 Template No ErrorCode 6 Clear All Template 0x0106 0 0x0106 4 0 1 Cleared TemplateCount Error Code 7 Get Empty ID 0x0107 0 0x0107 4 0 1 Template No Error Code 13 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com Function Command Response FPO 001 User s Manual Get Template Status 0x0108 Template No 0x0108 Template Status Error Code Get Broken Template 0x0109 0x0109 Broken Template Count First Broken Template No Error Code Read Template 0x010A Template No 0x010A Template Record Size 4 or 4 Template No Template Record Data Error Code Write Template 0x010B Template Record Size 2 Template No Template Record Data 0x010B Template No Error Code Set Security Level 0x010C 2 Security Level Value 0x010C Security Level Value Error Code Get Security Level 0x010D 0x010D Security Level Value Set Finger Time Out OxO10E Time Out Value OxO10E TimeOut Value Error Code Get Finger Time Out OxO10F OxO10F TimeOut Value Set Device ID Get Device ID 0x0110 0x0111 Device ID 0x0110 Ox0111 Device ID Device ID Error Code Get F W Version Finger Detect 0x0112 0x0113 0x0112 0x0113 F W Version Detect Result
16. 4 3 19 Finger Detect 43 4 3 20 Set Baudrate 44 4 3 21 Set Duplication Check ON OFF 45 4 3 22 Get Duplication Check 46 4 3 23 Enter Standby Mode 47 4 3 24 Enroll And Store in RAM 48 4 3 25 Get Enroll Data 49 4 3 26 Get Feature Data of Captured FP 51 4 3 27 Verify Downloaded Feature With Captured FP 52 4 3 28 Identify Downloaded Feature With Captured FP 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 61 4 3 33 Verify Device Password 62 4 3 34 Get Enroll Count 63 4 3 35 FP Cancel 64 4 3 36 Test Connection 65 4 3 37 Incorrect Command 66 5 APPENDIX 68 5 1 RESPONSE AND ERROR CODE 68 5 2 FLOW OF ENROLL AND VERIFY AND IDENTIFY PROCESS 70 5 2 1 Enroll 70 5 2 2 Verify amp Identify 71 3 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Introduction Fingerprint Optical FPO 001 serial is All in one Optic sensor CMOS image sensor CPU Flash memory embedded stand alone fingerprint identification module 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 LN Identification One to Many 2 1 1 Verification One to One 3 High speed fingerprint identification algorithm engine 4 Self study function 5 Fingerprint template data read from write to FLASH memory
17. FPO 001 Fingerprint Optical Identification Module User s Guide www ThaiEasyElec com FPO 001 User s Manual Content 1 INTRO 4 1 1 MAIN FUNCTIONS 4 1 2 APPLICATION EXAMPLES 4 1 3 TECHNOLOGY PARAMETER 5 1 4 DEFAULT SETTING 5 2 CONFIGRATION AND CONNECTOR 6 2 1 MOUNT AND CONNECTOR 6 2 2 DIMENSION OF IDWD5012 7 2 3 DIMENSION OF IDWD5020 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 11 3 3 5 Response Data Packet 11 4 PACKET COMMAND DETAIL DESCRIPTION 13 4 1 STRUCTURE OF FINGERPRINT TEMPLATE DATA IS FOLLOW 13 4 2 COMMAND LIST 13 4 3 COMMAND PACKET DESCRIPTION 16 4 3 1 Verify 16 4 3 2 Identify 18 4 3 3 Enroll 20 4 3 4 Enroll One Time 24 4 3 5 Clear Template 25 4 3 6 Clear All Template 26 4 3 7 Get Empty ID 27 4 3 8 Get Template Status 28 2 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 9 Get Broken Template 29 4 3 10 Read Template 30 4 3 11 Write Template 33 4 3 12 Set Security Level 36 4 3 13 Get Security Level 38 4 3 14 Set Finger Time Out 38 4 3 15 Get Finger Time Out 40 4 3 16 Set Device ID 40 4 3 17 Get Device ID 41 4 3 18 Get F W Version 42
18. 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 Notice Before power off module Enter Standby Mode Command is recommend Example Enter Standby Mode PREFIX CMD CKS 0x55 OxAA 10x17 0x01 0x00 0x00 0x00 0x17 0x01 Response Packet PREFIX RCM LEN RET OxAA 0x55 Ox17 0x01 0x04 0x00 0x00 0x00 0x01 47 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 24 Enroll And Store in RAM Function The same as Enroll command exclusive difference is 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_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 resul GD NEED RELEASE FINGER denote that lift finger after finger release then goto next steep 5 result GD NEED SECOND SWEEP denote that press the same finger for the second time and then goto steep2 3
19. No that can be utilized Fail ERR EMPTY ID NOEXIST CheckSum Example of Get Empty ID Command packet PREFIX CMD CKS 0x55 OxAA 0x07 0x01 0x00 0x00 0x00 0x07 0x01 Response Packet PREFIX RCM LEN RET OxAA loxss 0X07 0x01 0x04 0x00 0x00 0x00 0x02 0x00 4 3 8 Get Template Status Function Check the specified Template No whether can be utilized or not Command and Response 28 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual ERR_SUCCESS or ERR_FAIL Success GD_TEMPLATE_NOT_EMPTY GD_TEMPLATE_EMPTY Fail ERR_INVALID_TMPL_NO CheckSum Example of Get Template Status Get template status that No 1 command packet PREFIX CMD 0x55 OxAA 0X08 0x01 0x02 0x00 0x01 Response Packet PREFIX RCM LEN RET OxAA 0x55 0x08 0x01 0x04 0x00 0x00 0x00 0x01 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 Operation Sequence If exist broken template data result total number of broken template template No else total number 0 Template No 0 Command and Response 29 71
20. O 001 User s Manual Success GD_NEED_RELEASE_FINGER Template No Fail Error Code is as follow 2byte JERR_INVALID_TMPL_NO DATA ERR_TMPL_NOT_EMPTY ERR_TIME_OUT ERR_BAD_QUALITY 2byte Null or ERR DUPLICATION ID CKS CheckSum Example of Enroll One Time Enroll to Template No 1 Enroll One Time Command packet is as follow PREFIX CMD 0x55 OxAA 0x04 0x01 0x02 0x00 0x01 Response Packet is as follow 0x00 0x00 0x00 OxF4 0x00 0x00 0x00 0x01 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 appoint template No is invalid result ERR_INVALID_TMPL_NO 2 if the appoint template No is inexistence template data result ERR_TMPL_EMPTY 3 else delete specified template data and then return response packet 25 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL Success Template No to be deleted Fail Error Code is as follow ERR_INVALID_TMPL_NO ERR_TMPL_EMPTY CheckSum Example of Clear Template Clear Template No 1 command packet PREFIX CMD CKS 0x55 OxAA 0x05 0x01 0x02 0x
21. On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 31 Identify Free Function The command cause module detect finger then identify and return result continually until received FPCancel command gt detect finger gt identify gt return identify result gt Sequence 1 PA 3 if no any template data result ERR_ALL_TMPL_EMPTY Detect finger continually Check quality of fingerprint image if image is no good result ERR_BAD_QUALITY else image is good result GD_NEED_RELEASE_FINGER identify and return the result if identify OK result ERR_SUCCESS Template No else result ERR_ FAIL ERR IDENTIFY goto step2 until FPCancel command if received FpCancel command stop identify free command and return ERR_FP_CANCEL Command and Response RET ERR_SUCCESS or ERR_FAIL Success GD NEED RELEASE FINGER Template No Fail ERR ALL TMPL EMPTY DATA 2byte ERR BAD QUALITY ERR IDENTIFY ERR NO RELEASE 60 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual CKS CheckSum Example Host send Identify Free command packet PREFIX CMD CKS 0x55 OxAA 10x25 0x01 0x00 0x00 0x00 0x25 0x01 Module response the result GD Need Release Finger and 0x00 0x00 0x00 OxF4 0x00 0x00 0x00 0x01
22. RET OxAA 0x55 0x28 0x01 0x04 0x00 0x00 0x00 0x01 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 is the result ERR_FP_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 is Result ERR SUCCESS denote that operation of cancel is successful Command and Response LEN 4 RET ERR SUCCESS DATA CKS CheckSum 64 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example 1 Host send FP Cancel commonly PREFIX CMD 0x55 OxAA 0x30 0x01 0x00 0x00 0x00 Module response the result of cancel PREFIX RCM LEN RET OxAA 0x55 0x30 OxO1 0x04 0x00 0x00 0x00 0x00 0x00 Example 2 in process of executing Enroll command host send FP Cancel command PREFIX CMD 0x55 OxAA 0x30 0x01 0x00 0x00 0x00 Module response two result as follow
23. RET ERR SUCCESS or ERR FAIL Success GD NEED RELEASE FINGER or Template No Fail Error Code is as follow ERR VERIFY DATA 2byte ERR INVALID TMPL NO ERR TMPL EMPTY ERR TIME OUT ERR BAD QUALITY CKS Check Sum 17 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example of Verify Command 1 Host send Verify Template No 1 command packet as follow PREFIX CMD LEN CKS 0x55 OxAA_ 0x01 0x01 0x02 Ox00 0x01 0x04 0x01 2 if finger is on sensor and captured image is good module then return GD NEED RELEASE FINGER 3 Module return the result of verify response packet as follow 0x00 0x00 0x00 OxF4 0x00 0x00 0x00 0x01 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 image if image is not good result ERR_BAD_QUALITY 4 else result GD_NEED_RELEASE_FINGER denote that lift finger 5 identify the captured fingerprint with the all template data in FLASH memory if identify ok res
24. RR_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 62 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual RET ERR_SUCCESS or ERR_FAIL DATA 0 ERR NOT AUTHORIZED CKS CheckSum Example Host send Verify Device Password command packet PREFIX CMD LEN DATA 0x55 OxAA 0x27 O0x01 OxOE 0x00 14Bytes passoword form by ASCII Module response the result of verify device password PREFIX RCM LEN RET OxAA 0x55 0X27 OxOL 0x04 0x00 0x00 0x00 0x00 0x00 4 3 34 Get Enroll Count Function Get total number of fingerprint template that have enrolled Command and Response ERR_SUCCESS or ERR_FAIL Total number of template or Error Code CheckSum 63 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example Host send Get Enroll Count PREFIX CMD CKS 0x55 OxAA 0x28 0x01 0x00 0x00 0x00 0x28 0x01 Module response result of get enroll count PREFIX RCM LEN
25. User s Manual 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_TMPL_NO 2 3 OL eA Notice if the template No have existed template data result ERR TMPL NOT EMPTY detect finger whether press on sensor or not repeatedly if no finger press on sensor in the period of timeout result ERR TIME OUT else check quality of captured finger image if image is no good result ERR_BAD_QUALITY else result GD_NEED_RELEASE_FINGER denote that lift finger if Duplication Check OFF storage the template data and return result Template No 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 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 we recommend using Enroll command disapproval using Enroll one time command Command and Response RET ERR_SUCCESS or ERR_FAIL 24 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FP
26. a 4 Module detect finger then verify and response the result PREFIX RCM LEN RET DATA OxAS OxSA 0x1B 0x01 0x04 0x00 0x00 0x00 0x00 0x00 54 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 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 10 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 Module return response packet to inform host that module have get ready for receive the first template data packet Host send command data packet with the first template data to module Module return response packet with result GD DOWNLOAD SUCCESS inform host waiting for the next template data Host send command data packet with the second template data to module After module received the 2 templates data successful module detect finger continually if no any finger on sensor in the period detect finger result ERR_TIME_OUT check the quality of captured fingerprint image if the image is not good result ERR_BAD_QUALITY else identify the 2 template s data with captured fingerprint and then response res
27. aiEasyElec com FPO 001 User s Manual 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 sorage 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 ACK that is ERR FP CANCEL Please refer to appendix about the flow of Enroll 21 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL Success GD_NEED_FIRST_SWEEP GD_NEED_SECOND_SWEEP GD_NEED_THIRD_SWEEP GD_NEED_RELEASE_FINGER or Template No Fail Error Code is as follow ERR INVALID TMPL NO ERR TMPL NOT EMPTY ERR TIME OUT ERR BAD QUALITY ERR GENERALIZE Null or ERR DUPLICATION ID CheckSum 22 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example of Enroll Command Enroll to Template No 1 Command Packet OxAA 0x03 0x01 0x02 0x00 0x01 Response Packet 23 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001
28. d is the same as Read Template command refer to Read Template Command and Response PREFIX OxAA55 49 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual ERR_SUCCESS or ERR_FAIL Success Template Record Size indicate the length of data field in Response Data Packet Fail Error Code Template Record Size 2 ERR_SUCCESS Template Record Data CheckSum Example of Get Enroll Data CMD CKS 0x55 OxAA J 0x19 0x01 0x00 0x00 0x00 0x19 0x01 Response Packet and Response Data Packet 0x55 0x19 0x00 0x00 0x00 OxF2 0x00 498Bytes Template Data 50 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 26 Get Feature Data of Captured FP Function Get template data when captured an fingerprint image This command is 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
29. e Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 5 Appendix 5 1 Response and Error Code ERR SUCCESS Successful for command execute un ERR FAIL Fail for command execute ERR VERIFY Ox11 One to one match fail dn 68 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual ERR INVALID DUP VAL Option Value of Duplication Check is invalid ERR NO RELEASE Ox71 In process of IdentifyFree command Finger is not release 28 GD DOWNLOAD SUCCESS Download Template Record Data is successful GD NEED FIRST SWEEP OxFFF1 Waiting input fingerprint for the first time GD_NEED_SECOND_SWEEP OxFFF2 Waiting input fingerprint for the second time GD_NEED_THIRD_SWEEP 0 Waiting input fingerprint for the third time GD NEED RELEASE FINGER Lift finger GD DETECT FINGER There is an finger on sensor GD NO DETECT FINGER There is no finger on sensor GD TEMPLATE NOT EMPTY The appointed Template Data are not null GD TEMPLATE EMPTY The appointed Template Data are null 69 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 5 2 Flow of Enroll and Verify and Identify process 5 2 1 Enroll Waiting for finger Capture Success Increasing Counter Generalize Success Result Success Result Fail Fig 5
30. e Packet Identify code WORD 2byte Command Code WORD 2byte n n lt 17 Length of Command Parameter Byte array 16byte Command Parameter Check Sum is the low word of value listed below offset 0 offset 1 offset 21 3 3 3 Response packet PREFIX RCM RET DATA eT al S E jJ EEE Ii jp m LII SIZE DESCRYPTION 2byte Packet Identify code 2byte Response Code 2byte n n 17 RET and DATA Result Code WORD 2byte 0 success 1 fail Byte array 14byte Response Data n 2 byte Check Sum is the low word of value listed below offset 0 offset 1 offset 21 10 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 3 3 4 Command Data Packet eee GS PIED FT TITT FEE TYPE SIZE DESCRYPTION WORD 2byte Packet Identify code WORD 2byte Command Code WORD 2byte n n lt 512 Length of DATA Byte array nbyte Command parameter Check Sum is the low word of value listed below offset 0 offset 1 offset 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 3 3 5 Response Data Packet DATA PREFIX RCM ees EG E al al pues al A PE OFFSET FIELD TYPE SIZE DESCRYPTION 0 PREFIX WORD 2byte Packe
31. ecurity Level Set Security Level command packet PREFIX CMD 0x55 OxAA 0xOC 0x01 0x02 0x00 0x03 Set Security Level command response packet PREFIX RCM LEN RET OxAA 0x55 0x0C 0x01 0x04 0x00 0x00 0x00 0x03 0x00 37 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 13 Get Security Level Function Host read the value of Security Level from module Command and Response Value of Security Level CheckSum Example of Get Security Level Get Security Level command packet PREFIX CMD 0x55 OxAA 0X0D Ox01 0x00 0x00 0x00 Get Security Level command response packet PREFIX RCM LEN RET OxAA 0x55 0x0D 0x01 0x04 0x00 0x00 0x00 0x03 0x00 0x00 Ox14 0x01 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 38 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual the Finger TimeOut is the time limit of detect finger on sensor repeatedly 0 60s can be selected Default is 5s O
32. essful module detect finger continually if no any finger on sensor in the period detect finger result ERR TIME OUT check the quality of captured fingerprint image if the image is not good resultZERR BAD QUALITY else verify and then response the result of verify 8 In the period of process the command if module received FP Cancel command the module then stop this command and return ACK that is ERR FP CANCEL Ke Sy Or de mi 52 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response Command Packet ERR_SUCCESS or ERR_FAIL Success 0 Fail Error Code CheckSum Template Record Size Template Record Data ERR_SUCCESS or ERR_FAIL Success 0 Fail Erroe Code CheckSum 53 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example 1 Host send verify downloaded feature data with captured FP command packet CKS OxAA Ox1B 0x01 0x02 0x00 OxF2 0x10 0x02 2 Module return response packet to host PREFIX RCM LEN RET CKS Ox1B x 0x04 0x00 0x00 0x00 0x00 Ox1F 0x01 OxAA 0x55 1 B 3 Host download template data to module PREFIX CMD LEN DATA OxA Ox5A 5 Ox1B 0x01 OxF2 0x01 498Bytes Template Dat
33. ing Result ERR_FP_CANCEL denote that module have stop Enroll command 0x55 0x03 0x00 0x01 0x00 0x41 Result ERR_SUCCESS denote that operation of cancel is successful PREFIX RCM LEN RET OxAA 0x55 0x30 0x01 0x04 0x00 0x00 0x00 0x00 0x00 4 3 36 Test Connection Function Test connection between host and module Command and Response 65 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System FPO 001 User s Manual www ThaiEasyElec com Example of Test Connection Host send Test Connection Command packet PREFIX CMD 0x55 OxAA 0x50 0x01 0x00 0x00 0x00 Module response connection is successful PREFIX RCM LEN RET OxAA 0x55 0x50 0x01 0x04 0x00 0x00 0x00 0x00 0x00 4 3 37 Incorrect Command Function Response to host that the command is incorrect by interference effect Command and Response 66 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example Host send incorrect command PREFIX CMD 0x55 OxAA 0x01 0x00 0x00 0x00 0x00 Response the incorrect command PREFIX RCM LEN RET OxAA 0x55 0x60 OxO1 0x04 0x00 0x00 0x00 0x00 0x00 67 71 Enable Your Design ThaiEasyElec com ill On lin
34. is invalid result ERR INVALID TMPL NO if CheckSum of Template Data is incorrectness resultZERR INVALID PARAM 4 else Template Data that received write to Flash Memory 33 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response Command Packet and Response ERR SUCCESS or ERR FAIL Success 0 Fail ERR INVALID PARAM CheckSum Command Data Packet and Response Template Record Size 2 Template No 2byte Template Record Data ERR SUCCESS or ERR FAIL Success Template No Fail Error Code CheckSum 34 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example of Write Template 1 Host send Write Template command packet CKS OxAA 10x0B 0x01 0x02 0x00 OxF2 0x00 0x02 2 Response to the write template command CKS 0x55 0xOB 0x01 0x04 0x00 0x00 0x00 0x00 0x00 OxOF 0x01 3 Host send Command Data Packet with Template No and Template Data PREFIX CMD LEN 0x5 OxA A 5 OxOB 0x01 OxF4 0x01 498Bytes Template Data 4 After check the command data packet is correct Module write the template data to Flash memory and then response the command data packet PREFIX RCM LEN RET DATA CKS
35. orage Environment Storage temperature 20 C 80 C Storage humidity lt 90 1 4 Default Setting Finger Time Out 074608 BaudRate 9600 19200 38400 57600 115200 BPS 115200 BPS Fingerprint Duplication Check ON OFF 5171 Enable Your Design E ll ThaiEasyElec com On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 2 Configuration and Connector 2 1 Mount and Connector 3 3V DC Input GND Rx Module Receive TTL Tx Module Transmit TTL Connector Signal description Pin No Signal name Signal Description PIN I UART TX Module Transmit Output 3 3V TTL Logic PIN 2 UART RX Module Receive Input 3 3V TTL Logic PIN 3 GND GND PIN 4 VIN DC Input Range of voltage is 3 3V 5 6 71 Enable Your Design ThaiEasyElec com Bl On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 2 2 Dimension 7 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 3 Communication Protocol The module is 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 115200BPS 1 star
36. peration Sequence 1 if the value of TimeOut is out off range resultZERR INVALID TIME OUT 2 else update the value of TimeOut and response the command Command and Response ERR_SUCCESS or ERR_FAIL Value of Time Out or ERR INVALID TIME OUT CheckSum Example of Set Finger TimeOut Set Finger TimeOut command packet PREFIX CMD 0x55 OxAA OxOE 0x01 0x02 0x00 0x00 0x00 Command response packet PREFIX RCM LEN RET OxAA 0x55 030E 0x01 0x04 0x00 0x00 0x00 OxOA 0x00 39 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 3 15 Get Finger Time Out Function Read the value of Finger TimeOut Command and Response Value of Time Out CheckSum Example of Get Finger TimeOut Command packet PREFIX CMD 0x55 OxAA 0xOF 0x01 0x00 0x00 0x00 0x00 Response packet PREFIX RCM LEN RET OxAA 0x55 JOxOF 0x01 0x04 0x00 0x00 0x00 0x05 0x00 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 result ERR_INVALID_PARAM 2 else update the value of Device ID and response the command Command and Response 40 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System FPO 001 User s Manual www ThaiEasyElec com
37. rrect 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_TMPL_NO 2 if the template No have existed template data result ERR TMPL NOT EMPTY 3 else result GD_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 else check quality of captured finger image if image is no good result ERR BAD QUALITY 6 else resultZGD NEED RELEASE FINGER denote that lift finger after finger release then goto next steep 7 result GD NEED SECOND SWEEP denote that press the same finger for the second time and then goto steep4 5 8 if the second input fingerprint is correct result GD NEED RELEASE FINGER denote that lift finger after finger release then goto next steep 9 resultZGD NEED THIRD SWEEP denote that press the same finger for the third time and then goto steep4 5 10 if the third input fingerprint is correct result GD NEED RELEASE FINGER denote that lift finger 11 the module generalize the three templates to one template success goto steep12 fail resultZERR GENERALIZE 12 if Duplication Check OFF storage the template data and return result Template No CA 20 71 Enable Your Design ThaiEasyElec com Mi On line Electronics Shop for Embedded System www Th
38. t Identify code 2 RCM WORD 2byte Response Code Length of result data 4 LEN WORD 2byte n n lt 512 RET DATA 11 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Result code 6 RET WORD 2byte 0 success 1 fail 8 DATA Byte array n 2 byte Response data Check Sum is the low word of value listed below 6 n CKS WORD 2byte offset 0 offset 1 toffset 6 n 1 12 71 Enable Your Design ThaiEasyElec com On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 4 Packet Command Detail Description 4 1 Structure of Fingerprint Template Data is follow Template Data 496B ytes CheckSum 2Bytes 498Bytes Template Data CheckSum 496 bytes Template Data 2 byte Check Sum is the low word of value listed below DO D1 D495 D0 D1 D495 4 2 Command List No Function Command Response CMD LEN DATA RCM LEN RE DATA T 1 Verify Ox0101 2 Template No 0x0101 4 0 1 Template No Error Code D Identify 0x0102 0 0x0102 4 0 1 Template No Error Code 3 Enroll 0x0103 2 Template No 0x0103 4 6 0 1 Template No Error Code Duplicaion ID 4 Enroll One Time 0x0104 2 Template No 0x0104 4 6 0 1 Template No ErrorCode 5 Clear Template 0x0105
39. t bit 1 stop bit no check bit 3 1 The process of communication HOST TARGET SM2A 12 20 Command Packet Data Packet uuumummumumuuummuuub Receive Result Data Packet Fig3 1 Process of Communication Notice Host do not send next command until receive result except send FP Cancel 8 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual 3 2 Classify of 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 is 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 OxAA55 Response packet OxSSAA Command Data Packet OxAS5A Response Data Packet OxSAA5 3 3 2 Structure of Command Packet PREFIX CMD LEN DATA GR GR aa TI BLE BEE Eee JE eJ 9 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual TYPE SIZE DESCRYPTION WORD 2byt
40. to host utilize Response data packet 4 In the period of process the command if module received FP Cancel command the module then stop this command and return ACK that is ERR_FP_CANCEL Command and Response ERROR_SUCCESS or ERR_FAIL Success Template Record Size Fail ERR_TIME_OUT or ERR_BAD_QUALITY Response Data Packet LEN Template Record Size 2 RET ERR_SUCCESS 51 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual DATA Template Record Data CKS CheckSum Example Get Feature Data of Capture FP CMD OLA 0x01 0x00 0x00 0x00 Response packet and Response Data Packet 0x00 0x00 0x00 OxF2 Ox5A OxlA 0x00 498Bytes Template Data 4 3 27 Verify Downloaded Feature With Captured FP Function Verify downloaded template data with captured fingerprint This command is equivalent Write Template Data and Verify 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 Module return response packet to inform host that module have get ready for receive template data packet Host send command data packet with template data to module After module received the template data succ
41. ult 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 ldentify 18 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response ERR_SUCCESS or ERR_FAIL Success GD_NEED_RELEASE_FINGER or Template No Fail Error Code is as follow ERR_IDENTIFY ERR ALL TMPL EMPTY ERR TIME OUT ERR BAD QUALITY CheckSum 19 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Example of Identify Command 1 Host send identify command command packet as follow PREFIX CMD 0x55 OxAA 0x02 0x01 0x00 0x00 0x00 2 iffinger is on sensor and captured image is good module return GD NEED RELEASE FINGER 3 Module return the result of identify 2 3 response packet as follow 0x55 0x02 0x00 0x00 0x00 OxF4 0x00 0x00 0x00 0x01 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 co
42. ult of identify In the period of process the command if module received FP Cancel command the module then stop this command and return ACK that is ERR_FP_CANCEL 55 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual Command and Response Command packet ERR_SUCCESS or ERR_FAIL Success 0 Fail Error Code Template Record Data 2 Template Index 2Byte Template Record Data ERR_SUCCESS or ERR_FAIL Success GD DOWNLOAD SUCCESS Fail Error Code Template Record Data 2 Template Index 2Byte Template Record Data 56 71 Enable Your Design ThaiEasyElec com ill On line Electronics Shop for Embedded System www ThaiEasyElec com FPO 001 User s Manual LEN 4 RET ERR SUCCESS or ERR_FAIL DATA Success 0 Fail Error Code Example 1 Host send Identify Downloaded Feature With Captured FP command packet PREFIX CMD CKS 0x55 OxAA 0x1C 0x01 0x02 0x00 OxF2 0x11 0x02 2 Module return response packet to host CKS 0x55 O0x1C 0x01 0x04 0x00 0x00 0x00 0x00 0x00 0x20 0x01 3 Host send the first template data to module PREFIX CMD LEN 9 9 lxic oxor oxF4 oxot 498Byte Template Data 4 Module request the next template data PREFIX RCM LEN RET DATA CKS OxAS 0x5A JOx1C 0x01 0x

FPO-001 - Thaieasyelec.net

Contents

Download Pdf Manuals

Related Search

Related Contents