User Manual
Contents
1. Instuction code 02H Command or instruction package format Header Module Package Package Instruction Buffer Checksum al a E BE S Eo OxEFOL Xxxx BufferID Note BufferID ae and wt are Ih and 2h respectively values except lh 2h would be processed as CharBuffer2 Acknowledge package format Header Module Package Package length Confirmation Checksum a ae A m E ss i generate character file a 1 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 CharBufferl and CharBuffer2 Input Parameter none Return Parameter Confirmation code 1 byte Instuction code 05H Command or instruction package format Header Module Package Package Instruction Checksum a i lt a E OxEFOL Xxxx Acknowledge at poom Header Module Package Package Confirmation Checksum address E ES a Note Confirmation m mE n SUCCESS Confirmation code 01H error when receiving package Confirmation code 0aH2. package format Header Module address Package Package Instruction Checksum site en a OxEFOL Acknowledge _ __ format Header Module Package Package Confirmation Template Checksum address AT a code number Note m Loom code 00H read E Confirmation code 01H error when receiving package Fingerprint processing instructions To collect finger image GenlImg 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 Header Module Package Package length Instruction Checksum ee aa B OxEF0O Xxxx Acknowledge aaa format Header Module Package Package Confirmation Checksum aa _ B OxEFOl Xxxx o Note Confirmation T collection 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 OaH Command or instruction package format Header Module address Package Package length Instruc
3. 2h respectively values except 1h 2h would be processed as CharBuffer2 Acknowledge package format Header Module Package Package Confirmation Checksum address lt a E Note 1 Confirmation code 00H E to transfer the at _ an data alae Confirmation code 01H error when receiving package Confirmation code QeH 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 Bufferl Buffer2 at the designated location of 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 Header Module Package Package Instruction buffer Location Checksum address Ea e code number number oc oon Butter Paget sum Note e of CharBufferl and CharBuffer2 are 1h and 2h respectively Other values except lh 2h would be processed as CharBuffer2 Acknowledge package format Header Module Package Package Confirmation Checksum oe a OxEFOL Xxx o Note Confirmation Lom E success Confirmation code 01H error when receiving package Confirmation code ObH addressing PageID is beyond the finger library Confirmation code 18H error when
4. aa len nen m EF OxEFOI OOX Acknowledge sm format Header Chip Package Package Confirmation Checksum address n EF code Note a m CREE Port operation sH odam 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 Parameter none Return Parameter Confirmation code 1 byte basic parameter 16bytes Instuction code OfH Command or instruction package format Header Module Package Package length Instruction Checksum ao a code Loess Dee package L om Header Module Package Package Confirmation Basic parameter Checksum address identifier length code list table Note Confirmation code 00H read complete Confirmation code 01H error when receiving package Stars reper Contents ofaystem status egies OOO oO O System identifier code Fined vale 0x0009 SSS Finger brary size wows O o B Security evel L2 3 45 SiS Device adress pones OOOO O o j opes sewo e 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 instruction
5. code 19H Command or instruction package format Header Module Package Package Instruction Page Checksum address Ea B code number Acknowledge package do Header Module Package Package Confirmation User content Checksum E n lt length code OxEFOL User content Note dm code 00H read success Confirmation code 01H error when receiving package Instruction Table Classified by functions Tepe mum code deccription Type mum Code description 4 OEH To set system 16 07H to read load template Parameter OFH To read system 18 ODH_ to empty the library es 6 a 7 IDH To read finger 19 03H Carry out precise template numbers matching of two templates 8 O1H Collect finger image Search the finger library 11 02H To generate character 22 18H to write note pad S a e g Peet 12 05H To combine character 23 19H To read note pad files and generate template Classified by instruction code 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 pIE PI WIJS gz T oO DM z ve SUISSIIOId JULIGIIUL OSH RegModel To combine character 13H VfyPwd To verify password files and generate template To downlo
6. writing Flash To read template from Flash library LoadChar Description to load template at the specified location PageID of Flash library to template buffer CharBuffer 1 CharBuffer2 Input Parameter Buffer D 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 07H Command or instruction package format Header Module Package Package Instruction buffer Page Checksum es seats aga oe Note BufferID of lt es ot are lh oe 2h respectively Other values er 1h 2h would be processed as CharBuffer2 Acknowledge package format Header Module address Package Package Confirmation Checksum a B B OxEFOL O xxx Note Confirmation code 00H m success Confirmation code 01H error when receiving package Confirmation code 0cH 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 Header Module Package Package Instruction Page number of Checksum addr
7. 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 O3h fail to enroll the finger Ooh fail to generate character file due to the over disorderly fingerprint image O7h fail to generate character file due to lackness of character 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 1 Ah invalid register number 1Bh incorrect configuration of register 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 for
8. R303A Series Fingerprint Identification Module User Manual CE QUAUTY OF UFE THEN START Smart Facility Guard I Introduction Power DC 3 6V 6 0V Interface UART TTL logical Working current Typical 100mA Matching Mode 1 1 and 1 N Baud rate 9600 N bps Character file size 256 bytes Image acquiring time Template size 512 bytes Storage capacity 120 375 880 Security level 5 1 2 3 4 5 highest Working environment Storage environment ee eee Outline Dimention Split type Module 42 38 7mm Sensor 56 20 2 1 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 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 II Main Parameters HI Hardware Interface Exterior Interface R303A All in one Connecti
9. ad image HiSpeedSearch Search the library fastly OCH DeletChar to delete tempates IDH TempleteNum To read finger template numbers Dimensions F1 1 Dimensions of spilt tyoe Module
10. ant harm to the Module Operation Current 100 Icc Peak Current Ipeak TD output TTL logic level i aai oe Ne em ondion ni ote m e ae aie et a r e RD input TTL S a level 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 instructions Note Contents of the above buffers will be lost at power off Image buffer ImageBuffer serves for image storage and the image format is 256 288 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 Charact
11. core Note 1 Confirmation code 00H aes of the two buffers are ae 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 To search finger library Search Description to search the whole finger library for the template that matches the one in CharBuffer1 or CharBuffer2 When found PageID will be returned Input Parameter BufferID StartPage searching start address PageNum searching numbers Return Parameter Confirmation code 1 byte PageID matching templates location Instuction code 04H Command or instruction package format Header Module Package Package Instructio buffer Parameter Parameter Checks address identifie length n code number Note BufferID of CharBufferl and CharBuffer2 are 1h and 2h respectively Other md am except 1h 2h would be processed as CharBuffer2 Acknowledge package format Header Module Package Package Confirmation W44 fa Checksum E aca a OxEFOL OXXX xxH PageID_ MatchScore core Note 1 e te found the a 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
12. e 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 Command packet Package Data packet Data packet shall not appear alone in a PID l byte 02H executing processs must follow command packet or identifier acknowledge packet Acknowledge packet Ea Refers to the length of package content command packets and ackage j LENGTH 2 bytes data packets plus the length of Checksum 2 bytes Unit is en i byte Max length is 256 bytes And high byte is transferred first It can be commands data command s parameters Package acknowledge result etc fingerprint character value template contents 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
13. er 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 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 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 cooresp
14. ess identifier length code number templates to be deleted Acknowledge package format Header Module Package identifier Package Confirmation Checksum address len a BE Note xox L code 00H delete success Confirmation code 01H error when receiving package Confirmation code 10H faile to delete templates 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 O0dH Command or instruction package format Header Module Package Package Instruction Checksum o i A m M OxEF0OL Xxxx OOH 1H Acknowledge package tt Header Module Package Package Confirmation Checksum address oe Note Confirmation a u SUCCESS Confirmation code 01H error when receiving package Confirmation code 11H fail to clear finger library To carry out precise matching of two 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 Header Module Package Package length Instruction code Checksum address identifier Acknowledge package format Header Module Package Package Confirmation Matching Checksum address identifier length code s
15. 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 Header Module Package Package Instruction Buffer Checksum address Ea m number Note BufferID EE CharBuffer1 a are lh and 2h camila Gi Other values except lh 2h would be processed as CharBuffer2 Acknowledge package format Header Module Package Package Confirmation Checksum address Note 1 CE code 00H on to udi the o a Confirmation code 01H error when receiving package Confirmation code OdH error when uploading template 2 Module shall transfer following data packet after responding to the upper computer 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 Header Module Package Package Instruction buffer Checksum aan aa E S number OxEFOL XX BufferID Note BufferID of aa and are and
16. mat 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 package format Header Module Package Instruction Password Checksum ae Yee N lt i a eh es format Header Module address Package Package Confirmation Checksum a Len _ code ser a at OOH Correct re 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 Header Module Package Package Instruction Password Checksum aa lt M m OxEFO1 XXK PassWord Acknowledge package format 2bytes 2bytes Abyte Abyte 2bytes 2bytes lbyte lbe 2bytes 2bytes oe Note Confirmation code 00H password setting Confirmation 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 instructio
17. n package format 2 bytes Abytes 1 byte 2 bytes 1 byte 4 bytes 2 bytes y Header Original Package Package Instruction New Module Checksum e address a code n n package 1 on Header New Module Package Package Confirmation Checksum B n a mgn B OxEFOL l Note e ma a address setting CNE 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 Header Module Package Package Instruction Parameter Contents Checksum a identifier ae a OxEFO1 Xxxx Acknowledge a m oH Header Module Package Package Confirmation Checksum a lt code OxEFOL Note es i parameter setting on Confirmation code 01H error when receiving package Confirmation code laH wrong register number Port Control Control Description For UART protocol it control the on off of USB port For USB protocol it control the on off of UART port Input Parameter control code Control code 0 means turns off the port Control code 1 means turns on the port Return Parameter confirmation code Instruction code 17H rae or instruction package format ELOS Chip Package Package Instruction Control Checksum EF
18. ng with PC P1 P2 on board Serial Communication P1 When the FP module communicates with user device definition of J1 1s as follows Vin in Power input ee Data output TTL logical level O 3 RD o Data input TTL logical level _ NE te Signal ay Connected to power ground color black Hardware connection Via serial interface the Module may communicate with MCU of 3 3V or 5V power TD pin 2 of P1 connects with RXD receiving pin of MCU RD pin 3 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 of O XDI X_b2_X_D3_X DEX Da xE XDI i 10Bit 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 Power supply it Parameter Unit Not em ni ote Power Voltage Vin Ee cae Normal working value Maximum Voltage 0 3 7 0 V Exceeding the Maximum rating Vin max may cause perm
19. onding 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 Note Busy 1 bit 1 system is executing commands 0 system is free Pass 1 bit 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 system enter into normal operation mode Or else system will refu
20. se to execute and command 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 integrates 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 Symbol Length p Description Fixed value of OxEFO1 High byt
21. 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 Header Module Package Package length Instruction Checksum B aa e code OxEFOL OO xxxx BHE W 0018H Acknowledge package do Header Module Package Package Confirmation Random Checksum address u E code a Note ae code 00H SUCCESS Confirmation code 01H error when receiving package 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 Header Module Package Package Instruction Page Data Checksum address Ea m code number content Acknowledge a format Header Module address Package Package Confirmation code Checksum a ae Note Confirmation m write success Confirmation code 01H error when receiving package To read note pad 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
22. tion code Checksum p OxEFOL Xxx Acknowledge package L Header Module Package Package Confirmation Checksum ae len m OxEFOI Xxxx Note 1 Confirmation code 00H E to transfer the n chain ce data Lom Confirmation code 01H error when receiving package Confirmation code 0fH 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 Header Module address Package Package Instruction Checksum a code Acknowledge package format M S engi ede Note 1 Confirmation code 00H ready to transfer the following data packet Confirmation code 01H error when receiving package Confirmation code QeH 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
Download Pdf Manuals
Related Search