R30X User Manual
Contents
1. Power supply Parameter A Item Unit Note Min Typ Max Power Voltage Vin 3 6 6 0 V Normal working value Maximum Voltage 0 3 7 0 V Exceeding the Maximum rating Vin max may cause permant harm to the Module Operation Current 90 100 110 mA Icc Peak Current Ipeak 150 mA TD output TTL logic level ER Parameter i Item Condition Unit Note Min Typ Max VoL lors 4mA 0 4 V Logic 0 Vou Ionp 4mA 2 4 3 3 V Logic 1 RD input TTL logic level Parameter Item Condition Unit Note Min Typ Max Vit 0 6 EN Loigc 0 n nitro professional line at nitropdf com professional Vin 2 4 Vv Logic 1 Vin 5V 1 mA Vin 3 3V 30 uA Mie 0 3 55 V Maximum input voltage IV System Resources To address demands of different customer Module system provides abundant resources at user s use Notepad The system sets aside a 512 bytes memory 16 pages 32 bytes for user s notepad where data requiring power off protection can be stored The host can access the page by instructions of PS WriteNotepad and PS Read Notepad Note when write on one page of the pad the entire 32 bytes will be written in wholly covering the original contents Buffer There are an image buffer and two 512 byte character file buffer within the RAM space of the module Users can read amp write any of the buffers by instructi2. The system will process the two time finger images generate a template of the finger based on processing results and store the template When matching user enters the finger through optical sensor and system will generate a template of the finger and compare it with templates of the finger library For 1 1 matching system will compare the live finger with specific template designated in the Module for 1 N matching or searching system will search the whole finger library for the matching finger In both circumstances system will return the matching result success or failure n nitro professional iline at nitropedf com professional II Main Parameters III Hardware Interface Exterior Interface R305 All in one i 1 i i p m a IE JE Bi i BORA M gt 1 i 4 LIE L E mnn 8 75 HEE E AW LEHI wa mm 22e EE NZ HE HEE H HE HEE E em see a a if J murg aY Y Created with M nitro professional download the free trial online at nitropdf com professional R305F 0 07 0 05 eS DETAIL B SCALE 4 1 12 00 p Ene T 9 x sed z N l JL 2 33 40 1 oy a S ea do I Poe A eee L DTALA 8 SCALE 4 1 a is a 5 moni 20 4 lam VZ J Connecting
3. Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note Confirmation code 00H operation success Confirmation code 01H error when receiving package Confirmation code 0aH fail to combine the character files That s the character files don t belong to one finger To upload character or template UpChar Description to upload the character file or template of CharBufferl CharBuffer2 to upper computer Input Parameter BufferID Buffer number Return Parameter Confirmation code 1 byte Instuction code 08H Command or instruction package format 2 bytes Abytes 1 byte 2 bytes 1 byte 1 byte 2 bytes Header Module Package Package Instruction Buffer Checksum address identifier length code number OxEFO1 XXXX 01H 04H 08H BufferID sum Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values except 1h 2h would be processed as CharBuffer2 Acknowledge package format 2 bytes Abytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note 1 Confirmation code 00H ready to transfer the following data packet Confirmation code 01H error when receiving package Confirmation code 0dH error when uploading template 2 Module shall transfer following data packet after responding to the upper com
4. library fastly OCH DeletChar to delete tempates 1DH TempleteNum To read finger template numbers ss n nitro professional id the fre se trial ine at nitropelf com professional 23 Created with M nitro professional download the free trial online at nitropdf com professional
5. parameter setting complete Confirmation code 01H error when receiving package n nitro professional iline at nitropdf com professional 10 Port Control Confirmation code 1aH wrong register number Description For UART protocol it control the For USB protocol it control the Control Input Parameter control code on off of USB port on off of UART port Control code 0 means turns off the port Control code 1 means turns on the port Return Parameter confirmation code Instruction code 17H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte lbyte 2 bytes Header Chip Package Package Instruction Control Checksum address identifier length code code OxEFO1 XXXX 01H 04H 17H 0 1 sum Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Chip Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note Confirmation code 00H Port operation complete Confirmation code 01H error when receiving package Confirmation code 1dH fail to operate the communication port Read system Parameter ReadSysPara Description Read Module s status register and system basic configuration parameters Refer to 4 4 for system configuration parameter and 4 5 for system status register Input Paramete
6. point or over smallness of fingerprint image O8h finger doesn t match O9h fail to find the matching finger OAh fail to combine the character files OBh addressing PageID is beyond the finger library OCh error when reading template from library or the template is invalid ODh error when uploading template OEh Module can t receive the following data packages OFh error when uploading image 10h fail to delete the template 11h fail to clear finger library 13h wrong password 15h fail to generate the image for the lackness of valid primary image 18h error when writing flash 19h No definition error 1Ah invalid register number 1Bh incorrect configuration of register n nitro professional he free trial online at nitropdf com professional 1Ch wrong notepad page number 1Dh fail to operate the communication port others system reserved VI Module Instruction System R303A series provide 23 instructions Through combination of different instructions application program may realize muti finger authentication functions All commands data are transferred in package format Refer to 5 1 for the detailed information of package System related instructions Verify passwoard VfyPwd Description Verify Module s handshaking password Refer to 4 6 for details Input Parameter PassWord 4 bytes Return Parameter Confirmation code 1 byte Instruction code 13H Command or instruction pack
7. take Parameter Number as parameter When upper computer sends command to modify parameter Module first responses with original configurations then performs the parameter modification and writes configuration record into Flash At the next startup system will run with the new configurations Baud rate control Parameter Number 4 The Parameter controls the UART communication speed of the Modul Its value is an integer N N 1 12 Cooresponding baud rate is 9600 N bps Security Level Parameter Number 5 The Parameter controls the matching threshold value of fingerprint searching and matching Security level is divided into 5 grades and cooresponding value is 1 2 3 4 5 At level 1 FAR is the highest and FRR is the lowest however at level 5 FAR is the lowest and FRR is the highest Data package length Parameter Number 6 The parameter decides the max length of the transferring data package when communicating with upper computer Its value is 0 1 2 3 corresponding to 32 bytes 64 bytes 128 bytes 256 bytes respectively System status register System status register indicates the current operation status of the Module Its length is 1 word and can be read via instruction ReadSysPara Definition of the register is as follows Bit Num 15 4 3 2 1 0 Description Reserved ImgBufStat PWD Pass Busy Note Busy 1 bit 1 system is executing commands 0 system is free Pass 1 bit
8. 1 find the matching finger 0 wrong finger PWD 1 bit 1 Verified device s handshaking password ImgBufStat 1 bit 1 image buffer contains valid image Module password At power on reset system first checks whether the handshaking password has been modified If not system deems upper computer has no requirement of verifying password and will enter into normal operation mode That s when Module password remains the default verifying process can be jumped The password length is 4 bytes and its default factory value is OFFH OFFH OFFH OFFH Should the password have be modified refer to instruction SetPwd then Module or device handshaking password must be verified before the a enter into normal operation mode Or else system will refuse to execute and command Cre n nitro professional he free trial online at nitropdf com professional The new modified password is stored in Flash and remains at power off Module address Each module has an identifying address When communicating with upper computer each instruction data is transferred in data package form which contains the address item Module system only responds to data package whose address item value is the same with its identifying address The address length is 4 bytes and its default factory value is OXFFFFFFFF User may modify the address via instruction SetAdder The new modified address remains at power off Random number generator Module integra
9. R30X Series Fingerprint Identification Module User Manual n nitro professional tropdf com profes Preface amp Declaration Thank you for you selection of R30x series Fingerprint Identification Module Module of SFG The Manual is targeted for hardware amp software developing engineer covering hardware interface system resource instruction system installment information etc To ensure the developing process goes smoothly it is highly recommended the Manual is read through carefully We will try our best to assure you the correctness of the Manual However should you find any problem or error with it feel free to contact us or the sales representative of us We would be very grateful Holding the principle of constantly improving and perfecting products so both the module and contents of the Manual might subject to changes Sorry for separate notice You may visit our website or call us for the latest information The Manual contains proprietary information of SFG which shall not be used by or disclosed to third parties without the permission of SFG nor for any reproduction and alteration of information without any associated warranties conditions limitations or notices No responsibility or liability is assumed by SFG for the application or use nor for any infringements of patents or other intellectual property rights of third parties that may result from its use All products are sold subject to SFG s terms and condit
10. age format 2 bytes Abytes 1 byte 2 bytes 1 byte 4 byte 2 bytes Header Module Package Instruction Password Checksum address identifier code OxEFO1 XXXX 01H 07H 13H Pass Word sum Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module address Package Package Confirmation Checksum identifier Length code OxEFO1 XXXX 07H 03H xxH sum Note Confirmation code 00H Correct password Confirmation code 01H error when receiving package Confirmation code 13H Wrong password Set password SetPwd Description Set Module s handshaking password Refer to 4 6 for details Input Parameter PassWord 4 bytes Return Parameter Confirmation code 1 byte Instruction code 12H Command or instruction package format 2 bytes Abytes 1 byte 2 bytes 1 byte 4 byte 2 bytes Header Module Package Package Instruction Password Checksum address identifier length code OxEFO1 XXXX 01H 07H tedi2Hth SOR sum n nitro professional iline at nitropdf com professional Acknowledge package format 2 bytes 4 byte 2 bytes 1 byte 2 bytes Header Module address Package length Confirmation Checksum code OxEFO1 XXXX 03H xxH Sum Note Confirmation code 00H password setting complete Confirmati
11. byte 2 bytes 1 byte 2 bytes Header Module Package Package length Instruction Checksum address identifier code OxEFO1 XXXX 01H 03H 14H 0018H Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 4 bytes 2 bytes Header Module Package Package Confirmation Random Checksum address identifier length code number OxEFO1 XXXX 07H 07H xxH XXXX sum Note Confirmation code 00H generation success Confirmation code 01H error when a a n nitro professional 19 iline at nitropedf com professional To write note pad WriteNotepad Description for upper computer to write data to the specified Flash page refer to 4 1 for more about Note pad Also see ReadNotepad Input Parameter NotePageNum user content or data content Return Parameter Confirmation code 1 byte Instuction code 18H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte lbyte 32 bytes 2 bytes Header Module Package Package Instruction Page Data Checksum address identifier length code number content OxEFO1 XXXX 01H 36 18H 0 15 content sum Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module address Package Package Confirmation code Checksum identifier length OxEFO1 XXXX 07H 03H xxH sum To read note pad Note Confirmation code O0H write success Confirmation code 01H error when receiving
12. f Flash library Input Parameter BufferID buffer number PageID Flash location of the template two bytes with high byte front and low byte behind Return Parameter Confirmation code 1 byte Instuction code 06H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes Header Module Package Package Instruction buffer Location Checksum address identifier length code number number OxEF01 xxxx 01H 06H 06H BufferID PageID sum Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values except 1h 2h would be processed as CharBuffer2 Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note Confirmation code 00H storage success Confirmation code 01H error when receiving package Confirmation code 0bH addressing PageID is beyond the finger library Confirmation code 18H error when writing Flash To read template from Flash library LoadChar Description to load template at the specified location PageID of Flash library to template buffer CharBuffer1 CharBuffer2 n nitro professional iline at nitropedf com professional 16 Input Parameter BufferID buffer number PageID Flash location of the template two bytes with hi
13. gh byte front and low byte behind Return Parameter Confirmation code 1 byte Instuction code 07H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes Header Module Package Package Instruction buffer Page Checksum address identifier length code number number OxEF01 xxxx 01H 06H 07H BufferID PageID sum Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values except 1h 2h would be processed as CharBuffer2 Acknowledge package format 2 bytes Abytes 1 byte 2 bytes 1 byte 2 bytes Header Module address Package Package Confirmation Checksum identifier length code OxEFO1 XXXX 07H 03H XxH sum Note Confirmation code 00H load success Confirmation code 01H error when receiving package Confirmation code OcH error when reading template from library or the readout template is invalid Confirmation code OBH addressing PageID is beyond the finger library To delete template DeletChar Description to delete a segment N of templates of Flash library started from the specified location or PageID Input Parameter PageID template number in Flash N number of templates to be deleted Return Parameter Confirmation code 1 byte Instuction code OCH Command or instruction package format 2 bytes 4bytes 1 byte 2 byte
14. inger 2 19 03H Carry out precise template numbers od matching of two templates 01H Collect finger image 20 04H Search the finger library 5 OAH To upload image E 10 OBH To download image 21 14H to get random code 5 11 02H To generate character 22 18H to write note pad file from image ae D 12 05H To combine character z 23 19H To read note pad H files and generate template Classified by instruction code identifier Identifier Description Description OIH GenImg Collect finger image ODH Empty to empty the library 02H Img2Tz To generate character OEH SetSysPara To set system Parameter file from image 03H Match Carry out precise OFH ReadSysPara To read system matching of two Parameter templates 04H Serach Search the finger 12H SetPwd To set password library 05H RegModel To combine character 13H VfyPwd To verify password files and generate template 06H Store To store template 14H GetRandomCode to get random code 07H LoadChar to read load template 15H_ SetAdder To set device address 08H UpChar to upload template 17H_ Control Port control 09H DownChr to download template 18H WriteNotepad to write note pad OAH UpImage To upload image 19H ReadNot pad To read note pad T nitro professional ili nitropdf com professional OBH DownImage To download image 1BH HiSpeedSearch Search the
15. ions of sale supplied at the time of order acknowledgment Testing tool and other quality control techniques are used to the extent SFG considers necessary to support the warranty of relevant performance of its products to the specifications except as expressly agreed to in writing by government requirements testing of all parameters of each product is not necessarily performed n nitro professional nline at nitropdf com professional I Created with M nitro professional download the free trial online at nitropedf com professional I Introduction Power DC 3 6V 6 0V Interface UART TTL logical level USB 1 1 Working current Typical 100mA Matching Mode 1 1 and 1 N Peak 150mA Baud rate 9600 N bps Character file size 256 bytes N 1 12 default N 6 Image acquiring time lt 0 5s Template size 512 bytes Storage capacity 256 Security level 5 1 2 3 4 Schighest FAR lt 0 001 FRR lt 0 1 Average searching time lt Is 1 1000 Window dimension 18mm 22mm Working environment Temp 10 C 40 C Storage environment Temp 40 C 85 C RH 40 85 RH lt 85 Outline Dimention Split type Module 32 23 7mm Sensor 56 20 21 5mm Integral type 54 5 20 6 23 8mm Operation Principle Fingerprint processing includes two parts fingerprint enrollment and fingerprint matching the matching can be 1 1 or 1 N When enrolling user needs to enter the finger two times
16. llection successs Confirmation code 01H error when receiving package Confirmation code 02H can t detect finger Confirmation code 03H fail to collect finger Upload image UpImage Description to upload the image in Img_Buffer to upper computer Refer to 1 1 1 for more about image buffer Input Parameter none Return Parameter Confirmation code 1 byte Instuction code 0aH Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module address Package Package length Instruction code Checksum identifier OxEFO1 XxXxX 01H 03H 0aH 000eH Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note 1 Confirmation code 00H ready to transfer the following data packet Confirmation code 01H error when receiving package Confirmation code OfH fail to transfer the following data packet 2 Module shall transfer the following data packet after responding to the upper computer Download the image DownImage Description to download image from upper computer to Img_Buffer Refer to 1 1 1 for more about the image buffer Input Parameter none Return Parameter Confirmation code 1 byte Instuction code ObH Command or instruction package format 2 bytes Aby
17. on package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module address Package Package Instruction Checksum identifier length code OxEFO1 XXXX 01H 0003H 1dH 0021H Acknowledge package format 2 bytes Abytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes Header Module Package Package Confirmation Template Checksum address identifier length code number OxEFO1 XXXX 07H 5 xxH N sum Note Confirmation code 00H read complete Confirmation code 01H error when receiving package Fingerprint processing instructions To collect finger image GenImg Description detecting finger and store the detected finger image in ImageBuffer while returning successfull confirmation code If there is no finger returned confirmation code would be can t detect finger Input Parameter none Return Parameter Confirmation code 1 byte Instuction code 01H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package length Instruction Checksum address identifier code OxEF01 Xxxx 01H 03H 01H 05H Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes M nitro professional t ili nitropdf com professional aD Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH Sum Note Confirmation code 00H finger co
18. on code 01H error when receiving package Set Module address SetAdder Description Set Module address Refer to 4 7 for adderss information Input Parameter None Return Parameter Confirmation code 1 byte Instruction code 15H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 4 bytes 2 bytes Header Original Package Package Instruction New Module Checksum Module address identifier length code address OxEF01 XXXX 01H 07H 15H XXXX sum Acknowledge package format 2 bytes Abytes 1 byte 2 bytes 1 byte 2 bytes Header New Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 07H xxH Sum Note Confirmation code 00H address setting complete Confirmation code 01H error when receiving package Set module system s basic parameter SetSysPara Description Operation parameter settings Refer to 4 4 for more information Input Parameter Parameter number Return Parameter Confirmation code 1 byte Instruction code 0eH Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte lbyte lbyte 2 bytes Header Module Package Package Instruction Parameter Contents Checksum address identifier length code number OxEFO Xxxx 01H 05H OeH 4 5 6 XX sum Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH Sum Note Confirmation code 00H
19. ons Note Contents of the above buffers will be lost at power off Image buffer ImageBuffer serves for image storage and the image format is 256288 pixels When transferring through UART to quicken speed only the upper 4 bits of the pixel is transferred that is 16 grey degrees And two adjacent pixels of the same row will form a byte before the transferring When uploaded to PC the 16 grey degree image will be extended to 256 grey degree format That s 8 bit BMP format When transferring through USB the image is 8 bit pixel that s 256 grey degrees Character file buffer Character file buffer CharBufferl CharBuffer2 can be used to store both character file and template file 4 3Fingerprint Library Synstem sets aside a certain space within Flash for fingerprint template storage that s fingerprint library Contents of the library remain at power off Capacity of the library changes with the capacity of Flash system will recognize the latter automatically Fingerprint template s storage in Flash is in sequential order Assume the fingerprint capacity N then the serial number of template in library is 0 1 2 3 N User can only access library by template number n nitro professional line at nitropelf com professional System Confiuration Parameter To facilitate user s developing Module opens part system parameters for use And the basic instructions are SetSysPara amp ReadSysPara Both instructions
20. package ReadNotepad Description to read the specified page s data content Refer to 4 1 for more about user note pad Also see WriteNotepad Input Parameter none Return Parameter Confirmation code 1 byte data content Instuction code 19H Command or instruction package format 2 bytes Abytes 1 byte 2 bytes 1 byte lbyte 2 bytes Header Module Package Package Instruction Page Checksum address identifier length code number OxEFO1 XXXX 01H 04H 19H 0 15 xxH Acknowledge package format 2 bytes Abytes 1 byte 2 bytes 1 byte 32bytes 2 bytes Header Module Package Package Confirmation User content Checksum address identifier length code OxEFO1 XXXX 07H 3 32 xxH User content sum Note Confirmation code O0OH read success Confirmation code 01H error when receiving package n nitro professional iline at nitropedf com professional 20 Instruction Table Classified by functions 1 13H To verify password 13 08H to upload template 2 12H To set password 14 09H To download template 3 15H_ To set device address 15 06H To store template L 4 OEH To set system 16 07H to read load template Parameter 2 5 5 17H_ Port control 3 17 OCH to delete tempates 6 OFH To _ read system 18 ODH to empty the library Parameter 3 7 1DH To read f
21. puter 3 The instruction doesn t affect buffer contents To download character file or template DownChar Description to download character file or template from upper computer to the specified buffer of Module Input Parameter BufferID buffer number Return Parameter Confirmation code 1 byte Instuction code 09H Command or instruction package format 15 n nitro professional iline at nitropedf com professional 2 bytes Abytes 1 byte 2 bytes 1 byte 1 byte 2 bytes Header Module Package Package Instruction buffer Checksum address identifier length code number OxEFO1 XXXX 01H 04H 09H BufferID sum Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values except 1h 2h would be processed as CharBuffer2 Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note 1 Confirmation code 00H ready to transfer the following data packet Confirmation code 01H error when receiving package Confirmation code 0eH fail to receive the following data packages 2 Module shall transfer the following data packet after responding to the upper computer To store template Store Description to store the template of specified buffer Buffer1 Buffer2 at the designated location o
22. r Return Parameter Instuction code OfH none Command or instruction package format Confirmation code 1 byte basic parameter 16bytes 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package length Instruction Checksum address identifier code OxEFO1 XXXX 01H 03H OfH sum Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 16 bytes 2 bytes Header Module Package Package Confirmation Basic parameter Checksum address identifier length code list OxEFO1 XXXX 07H 3 16 xxH See following sum table Note Confirmation code 00H read complete Confirmation code 01H error when receiying package n nitro professional t nitropdf com professional alie Name Description Offset word Size word Status register Contents of system status register 0 1 System identifier code Fixed value 0x0009 1 1 Finger library size Finger library size 2 1 Security level Security level 1 2 3 4 5 3 1 Device address 32 bit device address 4 2 Data packet size Size code 0 1 2 3 6 1 Baud settings N baud 9600 N bps 7 1 Read valid template number TempleteNum Description read the current valid template number of the Module Input Parameter none Return Parameter Confirmation code 1 byte template number N Instuction code 1dH Command or instructi
23. s 1 byte 2 bytes 2bytes 2 bytes Header Module Package Package Instruction Page number of Checksum address identifier length code number templates to be deleted OxEF01 Xxxx 01H 07H OcH PageID N sum Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package identifier Package Confirmation Checksum address length code OxEFO1 XXXX 07H 03H xxH sum Note Confirmation code O0H delete success Confirmation code 01H error when receiving package Confirmation code 10H faile to delete templates n nitro professional iline at nitropedf com professional aly To empty finger library Empty Description to delete all the templates in the Flash library Input Parameter none Return Parameter Confirmation code 1 byte Instuction code OdH Command or instruction package format 2 bytes Abytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Instruction Checksum address identifier length code OxEFO1 XXXX 01H 03H O0dH 0011H Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation Checksum address identifier length code OxEFO1 XxXxX 07H 03H xxH sum Note Confirmation code 00H empty success Confirmation code 01H error when receiving package Confirmation code 11H fail to clear finger library To carry out precise matching of t
24. t 1h 2h would be processed as CharBuffer2 Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package length Confirmation Checksum address identifier code OxEFO1 XXXX 07H 03H XxH sum Note Confirmation code 00H generate character file complete Confirmation code 01H error when receiving package Confirmation code 06H fail to generate character file due to the over disorderly fingerprint image Confirmation code 07H fail to generate character file due to lackness of character point or over smallness of fingerprint image Confirmation code 15H fail to generate the image for the lackness of valid primary image To generate template RegModel Description To combine information of character files from CharBufferl and CharBuffer2 and generate a template which is stroed back in both CharBuffer1 and CharBuffer2 Input Parameter none Return Parameter Confirmation code 1 byte Instuction code 05H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes rt byte 2 bytes n nitro professional t nitropdf com professional 14 Header Module Package Package Instruction Checksum address identifier length code OxEF01 xxxx 01H 03H 05H 09H Acknowledge package format 2 bytes Abytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package Confirmation
25. tes 1 byte 2 bytes 1 byte 2 bytes Header Module address Package Package Instruction Checksum identifier length code OxEFO1 XXXX 01H 03H ObH 000fH Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Packaged wlth Confirmation Checksum n nitro professional iline at nitropdf com professional 13 address identifier length code OxEFO1 XXXX 07H 03H xxH sum Note 1 Confirmation code 00H ready to transfer the following data packet Confirmation code 01H error when receiving package Confirmation code 0eH fail to transfer the following data packet 2 Module shall transfer the following data packet after responding to the upper computer Data package length must be 64 128 or 256 To generate character file from image Img2Tz Description to generate character file from the original finger image in ImageBuffer and store the file in CharBufferl or CharBuffer2 Input Parameter BufferID character file buffer number Return Parameter Confirmation code 1 byte Instuction code 02H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes Header Module Package Package Instruction Buffer Checksum address identifier length code number OxEFO1 XXXX 01H 04H 02H BufferID sum Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values excep
26. tes a hardware 32 bit random number generator RNG without seed Via instruction GetRandomCode system will generate a random number and upload it V Communication Protocol The protocol defines the data exchanging format when ZFM 20 series communicates with upper computer The protocol and instruction sets apples for both UART and USB communication mode For PC USB interface is strongly recommended to improve the exchanging speed especially in fingerprint scanning device 5 1Data package format When communicating the transferring and receiving of command data result are all wrapped in data package format Data package format Header Adder Package Package Package content Checksum identifier length instuction data Parameter Definition of Data package Name Symbol Length Description Header Start 2 bytes Fixed value of OxEFO1 High byte transferred first Default value is OxFFFFFFFF which can be modified by Adder ADDER 4 bytes command High byte transferred first and at wrong adder value module will reject to transfer Package PID 1 byte OIH Command packet identifier Data packet Data packet shall not appear alone in 02H executing processs must follow command packet or acknowledge packet 07H Acknowledge packet n nitro professional iline at nitropedf com professional 08H End of Data packet Paa Refers to
27. the length of package content command packets and ons LENGTH 2 bytes data packets plus the length of Checksum 2 bytes Unit is byte Max length is 256 bytes And high byte is transferred first It can be commands data command s parameters Package i i rn DATA acknowledge result etc fingerprint character value template are all deemed as data The arithmetic sum of package identifier package length and Checksum SUM 2 bytes all package contens Overflowing bits are omitted high byte is transferred first Check and acknowledgement of data package Note Commands shall only be sent from upper computer to the Module and the Module acknowledges the commands Upon receipt of commands Module will report the commands execution status and results to upper computer through acknowledge packet Acknowledge packet has parameters and may also have following data packet Upper computer can t ascertain Module s package receiving status or command execution results unless through acknowledge packet sent from Module Acknowledge packet includes 1 byte confirmation code and maybe also the returned parameter Confirmation code s definition is 00h commad execution complete Olh error when receiving data package 02h no finger on the sensor 03h fail to enroll the finger O6h fail to generate character file due to the over disorderly fingerprint image O7h fail to generate character file due to lackness of character
28. uction code 04H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes 2 bytes Header Module Package Package Instructio buffer Parameter Parameter Checks address identifie length n code number um r OxEF01 xxxx 01H 08H 04H BufferID StartPage PageNum sum except 1h 2h would be processed as CharBuffer2 Acknowledge package format Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes 2 bytes Header Module Package Package Confirmation W45 td Checksum address identifier length code OxEFO1 XXXX 07H 7 xxH PageID MatchScore sum Note 1 Confirmation code 00H found the matching finer Confirmation code 01H error when receiving package Confirmation code 09H No matching in the library both the PageID and matching score are 0 2 The instruction doesn t affect the contents of the buffers Other instructions To generate a random code GetRandomCode Description to command the Module to generate a random number and return it to upper computer Refer to 4 8 for more about Random Number Generator Input Parameter none Return Parameter Confirmation code 1 byte Instuction code 14H Command or instruction package format 2 bytes Abytes 1
29. with PC P1 P2 on board Serial Communication P1 When the FP module communicates with user device definition of J1 is as follows Pin Nmuber Name Type Function Description 1 Vin in Power input 2 GND Signal ground Connected to power ground color black 3 TD in Data output TTL logical level 4 RD out Data input TTL logical level ES n nitro professional ad the free trial online at nitropdf com professional Hardware connection Via serial interface the Module may communicate with MCU of 3 3V or 5V power TD pin 3 of P1 connects with RXD receiving pin of MCU RD pin 4 of P1 connects with TXD transferring pin of MCU Should the upper computer PC be in RS 232 mode please add level converting circuit like MAX232 between the Module and PC Serial communication protocol The mode is semiduplex asychronism serial communication And the default baud rate is 57600bps User may set the baud rate in 9600 115200bps Transferring frame format is 10 bit the low level starting bit 8 bit data with the LSB first and an ending bit There is no check bit Star Bit Stop Bit l 0 DO X D1 X I2 X D3 X u X Ds XD Xx DT 1 10Bit p Reset time At power on it takes about 500ms for initialization During this period the Module can t accept commands for upper computer Electrical paramenter All electrical level takes GND as reference
30. wo finger templates Match Description to carry out precise matching of templates from CharBufferl and CharBuffer2 providing matching results Input Parameter none Return Parameter Confirmation code 1 byte matching score Instuction code 03H Command or instruction package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Header Module Package Package length Instruction code Checksum address identifier OxEFO1 XXXX 01H 03H 03H 07H Acknowledge package format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes Header Module Package Package Confirmation Matching Checksum address identifier length code score OxEFO1 Xxxx 05H XxH XxH sum Note 1 Confirmation code 00H templates of the two buffers are matching To search finger library Confirmation code 01H error when receiving package Confirmation code 08H templates of the two buffers aren t matching 2 The instruction doesn t affect the contents of the buffers Search Description to search the whole finger library for the ee that matches the one in CharBuffer1 or CharBuffer2 When found PageID will be returned n nitro professional iline at nitropedf com professional 18 Input Parameter BufferID StartPage searching start address PageNum searching numbers Return Parameter Confirmation code 1 byte PageID matching templates location Inst
Download Pdf Manuals
Related Search