R305 User Manual

April 2, 2018 | Author: chandrasekar | Category: Network Packet, File Format, Instruction Set, Byte, Library (Computing)


Comments



Description

R30X Series Fingerprint Identification ModuleUser Manual 1 Preface & Declaration Thank you for you selection of R30x series Fingerprint Identification Module (Module) of SFG. The Manual is targeted for hardware & 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 conditions 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. . I II . generate a template of the finger based on processing results and store the template. for 1:N matching. -1- .I Introduction Power Working current Baud rate Image acquiring time Storage capacity FAR Average searching time Working environment Outline Dimention DC 3. system will compare the live finger with specific template designated in the Module.1 1:1 and 1:N 256 bytes 512 bytes 5 (1.001% < 1s (1:1000) Temp: -10℃. 5(highest)) <0. system will search the whole finger library for the matching finger. Character file size N=1~12 (default N=6) <0. user needs to enter the finger two times. The system will process the two time finger images. When enrolling.5mm 54.8mm (9600*N)bps. 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.6*23. 2. When matching.5s 256 <0.0V Typical: 100mA Peak: 150mA Interface Matching Mode UART(TTL logical level)/ USB 1. system will return the matching result.+85℃ RH: <85% Module: 32*23*7mm Sensor:56*20*21. success or failure.1% 18mm*22mm Temp: -40℃.5*20.6V-6. In both circumstances. or searching.+40℃ RH: 40%-85% Split type Integral type Template size Security level FRR Window dimension Storage environment Operation Principle Fingerprint processing includes two parts: fingerprint enrollment and fingerprint matching (the matching can be 1:1 or 1:N). 3. 4. For 1:1 matching. II Main Parameters III Hardware Interface Exterior Interface R305 (All in one) -2- . definition of J1 is as follows: Pin Nmuber Name Vin GND TD RD Type in - in out Power input Function Description Signal ground. Connected to power ground (color: black) Data output. TTL logical level 1 2 3 4 -3- .R305F Connecting with PC (P1/P2 on board) Serial Communication(P1) When the FP module communicates with user device. TTL logical level Data input. There is no check bit. 8-bit data with the LSB first. Current 90 100 110 150 mA mA Peak Current (Ipeak) TD(output.0 7. and an ending bit. TTL logic level) Item VOL VOH Condition IOL=-4mA IOH= 4mA Parameter Min 2. Reset time At power on.4 Typ Max 0. Should the upper computer (PC) be in RS-232 mode. During this period. User may set the baud rate in 9600~115200bps。 Transferring frame format is 10 bit: the low-level starting bit. Electrical paramenter (All electrical level takes GND as reference) Power supply Item Power Voltage (Vin) Maximum (Vinmax) Operation (Icc) Voltage Parameter Min 3. TTL logic level) Item VIL Condition Parameter Min Typ Max 0. the Module may communicate with MCU of 3.3 Unit V V Note Logic Logic 0 1 RD(input.4 3. RD (pin 4 of P1) connects with TXD (transferring pin of MCU).6 -0. between the Module and PC. Exceeding the Maximum rating may cause permant harm to the Module. And the default baud rate is 57600bps. Serial communication protocol The mode is semiduplex asychronism serial communication.0 Unit V V Note Normal working value. the Module can’t accept commands for upper computer. it takes about 500ms for initialization.6 Unit V Loigc Note 0 -4- .3V or 5V power: TD (pin 3 of P1) connects with RXD (receiving pin of MCU).3 Typ Max 6. please add level converting circuit.Hardware connection Via serial interface. like MAX232. User can only access library by template number. CharBuffer2. The host can access the page by instructions of PS_WriteNotepad and PS_Read Notepad. where data requiring power-off protection can be stored. CharBuffer1. That’s 8-bit BMP format. Note: when write on one page of the pad. the image is 8-bit pixel. Assume the fingerprint capacity N. Users can read & write any of the buffers by instructions. can be used to store both character file and template file.3 5. Buffer There are an image buffer and two 512-byte-character-file buffer within the RAM space of the module. 1. Note: Contents of the above buffers will be lost at power-off.5 V mA uA V Logic 1 Maximum input voltage IV System Resources To address demands of different customer.3V 2. Notepad The system sets aside a 512-bytes memory (16 pages* 32 bytes) for user’s notepad. Module system provides abundant resources at user’s use. Character file buffer Character file buffer. Contents of the library remain at power off. 3 … N. only the upper 4 bits of the pixel is transferred (that is 16 grey degrees). the entire 32 bytes will be written in wholly covering the original contents. to quicken speed. Image buffer ImageBuffer serves for image storage and the image format is 256*288 pixels. -5- .VIH IIH VImax VIH =5V VIH =3. 4. system will recognize the latter automatically.4 1 30 -0. When transferring through UART. And two adjacent pixels of the same row will form a byte before the transferring. Capacity of the library changes with the capacity of Flash. that’s 256 grey degrees. then the serial number of template in library is 0. 2. When uploaded to PC.3Fingerprint Library Synstem sets aside a certain space within Flash for fingerprint template storage. Fingerprint template’s storage in Flash is in sequential order. When transferring through USB. the 16-grey-degree image will be extended to 256-grey-degree format. that’s fingerprint library. -6- . That’s. 5. and can be read via instruction ReadSysPara. At level 1. Baud rate control (Parameter Number: 4) The Parameter controls the UART communication speed of the Modul. FAR is the lowest and FRR is the highest. 0FFH. Module first responses with original configurations. Security level is divided into 5 grades. Cooresponding baud rate is 9600*N bps。 Security Level (Parameter Number: 5) The Parameter controls the matching threshold value of fingerprint searching and matching. Module password At power-on reset. Both instructions take Parameter Number as parameter. 1: system is executing commands. 1: find the matching finger. 4. 0FFH. when Module password remains the default. 1: image buffer contains valid image. 3. and cooresponding value is 1. corresponding to 32 bytes. 128 bytes. Pass:1 bit. Or else. system will run with the new configurations. At the next startup. PWD:1 bit. 0FFH. however at level 5. 64 bytes. N= [1. If not. system deems upper computer has no requirement of verifying password and will enter into normal operation mode. Data package length (Parameter Number: 6) The parameter decides the max length of the transferring data package when communicating with upper computer. 1: Verified device’s handshaking password. Should the password have be modified. Definition of the register is as follows: Bit Num Description 15 4 3 ImgBufStat 2 PWD 1 Pass 0 Busy Reserved Note: Busy:1 bit. System status register System status register indicates the current operation status of the Module. Its value is 0. 256 bytes respectively. 3. and its default factory value is 0FFH. Its length is 1 word. FAR is the highest and FRR is the lowest. 2. 2. refer to instruction SetPwd. 0: system is free. And the basic instructions are SetSysPara & ReadSysPara. system will refuse to execute and command. verifying process can be jumped. 12]. When upper computer sends command to modify parameter. system first checks whether the handshaking password has been modified. The password length is 4 bytes. Its value is an integer N. ImgBufStat:1 bit. Module opens part system parameters for use.System Confiuration Parameter To facilitate user’s developing. then Module (or device) handshaking password must be verified before the system enter into normal operation mode. 1. 0: wrong finger. then performs the parameter modification and writes configuration record into Flash. Data package format Header Adder Package identifier Package length Package content (instuction/data/Parameter) Checksum Definition of Data package Name Header Symbol Start Length 2 bytes Description Fixed value of 0xEF01. Default value is 0xFFFFFFFF. Data packet shall not appear alone in executing processs. Adder Package identifier ADDER 4 bytes PID 1 byte 02H 07H -7- . The address length is 4 bytes. USB interface is strongly recommended to improve the exchanging speed. which can be modified by command. which contains the address item. Acknowledge packet. Random number generator Module integrates a hardware 32-bit random number generator (RNG) (without seed). V Communication Protocol The protocol defines the data exchanging format when ZFM-20 series communicates with upper computer. When communicating with upper computer.1Data package format When communicating. 01H Command packet. Module address Each module has an identifying address. High byte transferred first. User may modify the address via instruction SetAdder. the transferring and receiving of command/data/result are all wrapped in data package format. 5. must follow command packet or acknowledge packet. module will reject to transfer. For PC. system will generate a random number and upload it. The protocol and instruction sets apples for both UART and USB communication mode. The new modified address remains at power off. High byte transferred first and at wrong adder value. Data packet. and its default factory value is 0xFFFFFFFF.The new modified password is stored in Flash and remains at power off. Via instruction GetRandomCode. Module system only responds to data package whose address item value is the same with its identifying address. each instruction/data is transferred in data package form. especially in fingerprint scanning device. Module will report the commands execution status and results to upper computer through acknowledge packet. Acknowledge packet includes 1 byte confirmation code and maybe also the returned parameter. 10h: fail to delete the template. Package length LENGTH 2 bytes Refers to the length of package content (command packets and data packets) plus the length of Checksum( 2 bytes). 11h: fail to clear finger library. etc. And high byte is transferred first. 0Eh: Module can’t receive the following data packages. 0Bh: addressing PageID is beyond the finger library. 1Bh: incorrect configuration of register. Max length is 256 bytes. 0Ah: fail to combine the character files. template are all deemed as data). 07h: fail to generate character file due to lackness of character point or over-smallness of fingerprint image 08h: finger doesn’t match. 06h: fail to generate character file due to the over-disorderly fingerprint image. 02h: no finger on the sensor. Package contents DATA - Checksum SUM 2 bytes Check and acknowledgement of data package Note: Commands shall only be sent from upper computer to the Module. Acknowledge packet has parameters and may also have following data packet. package length and all package contens. 01h: error when receiving data package. Upper computer can’t ascertain Module’s package receiving status or command execution results unless through acknowledge packet sent from Module. 0Ch: error when reading template from library or the template is invalid. The arithmetic sum of package identifier. (fingerprint character value. data. 13h: wrong password! 15h: fail to generate the image for the lackness of valid primary image. 0Fh: error when uploading image. 19h: No definition error. 1Ah: invalid register number. Upon receipt of commands.08H End of Data packet. Confirmation code’s definition is : 00h: commad execution complete. Unit is byte. 03h: fail to enroll the finger. command’s parameters. 18h: error when writing flash. acknowledge result. It can be commands. 0Dh: error when uploading template. 09h: fail to find the matching finger. high byte is transferred first. Overflowing bits are omitted. -8- . and the Module acknowledges the commands. application program may realize muti finger authentication functions. (Refer to 4. (Refer to 4. Confirmation code = 13H: Wrong password. VI Module Instruction System R303A series provide 23 instructions.1 for the detailed information of package.6 for details) Input Parameter: PassWord (4 bytes) Return Parameter: Confirmation code (1 byte) Instruction code: 12H Command (or instruction) package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 07H 1 byte Instruction code 12H 4 byte Password PassWord 2 bytes Checksum sum -9- . Confirmation code = 01H: error when receiving package. Through combination of different instructions. 1Dh: fail to operate the communication port. All commands/data are transferred in package format.1Ch: wrong notepad page number. Set password SetPwd Description: Set Module’s handshaking password. Refer to 5. System-related instructions Verify passwoard VfyPwd Description: Verify Module’s handshaking password. others: system reserved.6 for details) Input Parameter: PassWord (4 bytes) Return Parameter: Confirmation code (1 byte) Instruction code: 13H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address xxxx 4bytes Module address xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 07H 2 bytes 1 byte Instruction code 13H 2 bytes Package Length 03H 4 byte Password PassWord 1 byte Confirmation code xxH 2 bytes Checksum sum 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code = 00H: Correct password. (Refer to 4. .4 for more information) Input Parameter: Parameter number.Acknowledge package format: 2 bytes Header 0xEF01 4 byte Module address xxxx 2 bytes Package length 03H 1 byte Confirmation code xxH 2 bytes Checksum Sum Note: Confirmation code=00H: password setting complete. Confirmation code=01H: error when receiving package.7 for adderss information) Input Parameter: None. Confirmation code=01H: error when receiving package. Return Parameter: Confirmation code (1 byte) Instruction code: 0eH Command (or instruction) package format: 2 bytes Header 0xEF01 4bytes Module address Xxxx 1 byte Package identifier 01H 4bytes Module address Xxxx 2 bytes Package length 05H 1 byte Package identifier 07H 1 byte Instruction code 0eH 2 bytes Package length 03H 1byte Parameter number 4/5/6 1 byte Confirmation code xxH 1byte Contents xx 2 bytes Checksum sum 2 bytes Checksum Sum Acknowledge package format: 2 bytes Header 0xEF01 Note: Confirmation code=00H: parameter setting complete. (Refer to 4. Confirmation code=01H: error when receiving package. Set module system’s basic parameter SetSysPara Description: Operation parameter settings. Set Module address SetAdder Description: Set Module address. Return Parameter: Confirmation code (1 byte) Instruction code: 15H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Original Module address xxxx 4bytes New Module address xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 2 bytes Package length 07H 2 bytes Package length 07H 1 byte Instruction code 15H 4 bytes New Module address xxxx 1 byte Confirmation code xxH 2 bytes Checksum sum 2 bytes Checksum Sum Acknowledge package format: Note: Confirmation code=00H: address setting complete.10 - . 5 for system status register). Return Parameter: confirmation code. Read system Parameter ReadSysPara Description: Read Module’s status register and system basic configuration parameters. it control the “on/off” of USB port. Instruction code: 17H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Chip address xxxx 4bytes Chip address xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 2 bytes Package length 04H 2 bytes Package length 03H 1 byte Instruction code 17H 1 byte Confirmation code xxH 1byte Control code 0/1 2 bytes Checksum sum 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: Port operation complete. For USB protocol. Control code ”1” means turns on the port. Port Control Control Description: For UART protocol.4 ( for system configuration parameter and 4. Input Parameter: control code Control code ”0” means turns off the port.Confirmation code=1aH: wrong register number. Confirmation code=01H: error when receiving package. . Confirmation code=1dH: fail to operate the communication port. Input Parameter:none Return Parameter:Confirmation code (1 byte) + basic parameter(16bytes) Instuction code: 0fH Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address Xxxx Acknowledge package format: 4bytes Module address xxxx 1 byte Package identifier 07H 2 bytes Package length 3+16 1 byte Confirmation code xxH 16 bytes Basic parameter list See following table 2 bytes Checksum sum 1 byte Package identifier 01H 2 bytes Package length 03H 1 byte Instruction code 0fH 2 bytes Checksum sum Note: Confirmation code=00H: read complete. Refer to 4.11 - . Confirmation code=01H: error when receiving package. it control the “on/off” of UART port. 4. Confirmation code=01H: error when receiving package. 3) N (baud = 9600*N bps) Offset (word) 0 1 2 3 4 6 7 Size (word) 1 1 1 1 2 1 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 instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address xxxx 4bytes Module address xxxx 1 byte Package identifier 07H 1 byte Package identifier 01H 2 bytes Package length 5 2 bytes Package length 0003H 1 byte Confirmation code xxH 1 byte Instruction code 1dH 2 bytes Template number N 2 bytes Checksum 0021H 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: read complete. If there is no finger. returned confirmation code would be “can’t detect finger”. 5) 32-bit device address Size code (0. 1.Name Status register System identifier code Finger library size Security level Device address Data packet size Baud settings Description Contents of system status register Fixed value: 0x0009 Finger library size Security level (1. Fingerprint-processing instructions To collect finger image GenImg Description: detecting finger and store the detected finger image in ImageBuffer while returning successfull confirmation code. 3. 2. 2. Input Parameter: none Return Parameter: Confirmation code (1 byte) Instuction code: 01H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes 4bytes Module address Xxxx 4bytes 1 byte Package identifier 01H 1 byte 2 bytes Package length 03H 2 bytes 1 byte Instruction code 01H 1 byte 2 bytes Checksum 05H 2 bytes Acknowledge package format: .12 - . 1. Confirmation code=02H: can’t detect finger.1 for more about the image buffer. Confirmation code=01H: error when receiving package. Refer to 1.13 - . Refer to 1.1 for more about image buffer. 2:Module shall transfer the following data packet after responding to the upper computer.Header 0xEF01 Module address Xxxx Package identifier 07H Package length 03H Confirmation code xxH Checksum Sum Note: Confirmation code=00H: finger collection successs. Download the image DownImage Description: to download image from upper computer to Img_Buffer. Confirmation code=01H: error when receiving package. Input Parameter: none Return Parameter: Confirmation code (1 byte) Instuction code: 0aH Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address Xxxx 4bytes Module address Xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 2 bytes Package length 03H 2 bytes Package length 03H 1 byte Instruction code 0aH 1 byte Confirmation code xxH 2 bytes Checksum 000eH 2 bytes Checksum sum Acknowledge package format: Note 1: Confirmation code=00H: ready to transfer the following data packet. Confirmation code=03H: fail to collect finger. Input Parameter: none Return Parameter: Confirmation code (1 byte) Instuction code: 0bH Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 4bytes Module address Xxxx 4bytes Module 1 byte Package identifier 01H 1 byte Package 2 bytes Package length 03H 2 bytes Package 1 byte Instruction code 0bH 1 byte Confirmation 2 bytes Checksum 000fH 2 bytes Checksum Acknowledge package format: . Confirmation code=0fH: fail to transfer the following data packet. Upload image UpImage Description: to upload the image in Img_Buffer to upper computer.1. Input Parameter:none Return Parameter:Confirmation code (1 byte) Instuction code: 05H Command (or instruction) package format: 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes . 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 CharBuffer1 or CharBuffer2.address 0xEF01 Xxxx identifier 07H length 03H code xxH sum Note: 1:Confirmation code=00H: ready to transfer the following data packet.14 - . Confirmation code=01H: error when receiving package. Input Parameter: BufferID (character file buffer number) Return Parameter: Confirmation code (1 byte) Instuction code: 02H Command (or instruction) package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 04H 1 byte Instruction code 02H 1 byte Buffer number BufferID 2 bytes Checksum sum Note: BufferID of CharBuffer1 and CharBuffer2 are 1h and 2h respectively. Confirmation code=15H: fail to generate the image for the lackness of valid primary image. 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. Data package length must be 64. Confirmation code=0eH: fail to transfer the following data packet. 2:Module shall transfer the following data packet after responding to the upper computer. Other values (except 1h. Confirmation code=01H: error when receiving package. Acknowledge package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 07H 2 bytes Package length 03H 1 byte Confirmation code XxH 2 bytes Checksum sum Note: Confirmation code=00H: generate character file complete. 2h) would be processed as CharBuffer2. 128. To generate template RegModel Description: To combine information of character files from CharBuffer1 and CharBuffer2 and generate a template which is stroed back in both CharBuffer1 and CharBuffer2. 2h) would be processed as CharBuffer2. 2: Module shall transfer following data packet after responding to the upper computer. the character files don’t belong to one finger. Confirmation code=0dH: error when uploading template. That’s. 3: The instruction doesn’t affect buffer contents.Header 0xEF01 2 bytes Header 0xEF01 Module address xxxx 4bytes Module address xxxx Package identifier 01H 1 byte Package identifier 07H Package length 03H 2 bytes Package length 03H Instruction code 05H 1 byte Confirmation code xxH Checksum 09H 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: operation success. Confirmation code=0aH: fail to combine the character files. Confirmation code=01H: error when receiving package. Input Parameter: BufferID (Buffer number) Return Parameter: Confirmation code (1 byte) Instuction code: 08H Command (or instruction) package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 04H 1 byte Instruction code 08H 1 byte Buffer number BufferID 2 bytes Checksum sum Note: BufferID of CharBuffer1 and CharBuffer2 are 1h and 2h respectively. Acknowledge package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 07H 2 bytes Package length 03H 1 byte Confirmation code xxH 2 bytes Checksum sum Note 1: Confirmation code=00H: ready to transfer the following data packet. Other values (except 1h.15 - . 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: . To upload character or template UpChar Description: to upload the character file or template of CharBuffer1/CharBuffer2 to upper computer. Confirmation code=01H: error when receiving package. 2: Module shall transfer the following data packet after responding to the upper computer.16 - . Confirmation code=0eH: fail to receive the following data packages. Acknowledge package format: 2 bytes Header 0xEF01 4bytes Module address Xxxx 1 byte Package identifier 07H 2 bytes Package length 03H 1 byte Confirmation code xxH 2 bytes Checksum sum Note: Confirmation code=00H: storage success. Confirmation code=18H: error when writing Flash.2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 04H 1 byte Instruction code 09H 1 byte buffer number BufferID 2 bytes Checksum sum Note: BufferID of CharBuffer1 and CharBuffer2 are 1h and 2h respectively. Other values (except 1h. 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 Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 06H 1 byte Instruction code 06H 1 byte buffer number BufferID 2 bytes Location number PageID 2 bytes Checksum sum Note: BufferID of CharBuffer1 and CharBuffer2 are 1h and 2h respectively. Confirmation code=01H: error when receiving package. To store template Store Description: to store the template of specified buffer (Buffer1/Buffer2) at the designated location of Flash library. Confirmation code=0bH: addressing PageID is beyond the finger library. PageID(Flash location of the template. To read template from Flash library LoadChar Description: to load template at the specified location (PageID) of Flash library to template buffer CharBuffer1/CharBuffer2 . Other values (except 1h. Acknowledge package format: 2 bytes Header 0xEF01 Note 1: 4bytes Module address xxxx 1 byte Package identifier 07H 2 bytes Package length 03H 1 byte Confirmation code xxH 2 bytes Checksum sum Confirmation code=00H: ready to transfer the following data packet. Confirmation code=01H: error when receiving package. 2h) would be processed as CharBuffer2. Input Parameter: BufferID(buffer number). 2h) would be processed as CharBuffer2. 2h) would be processed as CharBuffer2. Input Parameter: PageID (template number in Flash). N (number of templates to be deleted) Return Parameter: Confirmation code (1 byte) Instuction code: 0cH Command (or instruction) package format: 2 bytes Header 4bytes Module address Xxxx 4bytes Module address Xxxx 1 byte Package identifier 01H 2 bytes Package length 07H 1 byte Package identifier 07H 1 byte Instruction code 0cH 2 bytes Page number PageID 2 bytes Package length 03H 2bytes number of templates to be deleted N 1 byte Confirmation code xxH 2 bytes Checksum 0xEF01 2 bytes Header sum 2 bytes Checksum sum Acknowledge package format: 0xEF01 Note: Confirmation code=00H: delete success. Confirmation code=0cH: error when reading template from library or the readout template is invalid. Confirmation code=0BH: addressing PageID is beyond the finger library. PageID (Flash location of the template. .17 - .Input Parameter: BufferID(buffer number). Other values (except 1h. Confirmation code=01H: error when receiving package. To delete template DeletChar Description: to delete a segment (N) of templates of Flash library started from the specified location (or PageID). two bytes with high byte front and low byte behind)。 Return Parameter: Confirmation code (1 byte) Instuction code: 07H Command (or instruction) package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 06H 1 byte Instruction code 07H 1 byte buffer number BufferID 2 bytes Page number PageID 2 bytes Checksum sum Note: BufferID of CharBuffer1 and CharBuffer2 are 1h and 2h respectively. Confirmation code=01H: error when receiving package. Confirmation code=10H: faile to delete templates. Acknowledge package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 07H 2 bytes Package length 03H 1 byte Confirmation code XxH 2 bytes Checksum sum Note: Confirmation code=00H: load success. Confirmation code=01H: error when receiving package. To carry out precise matching of two finger templates Match Description: to carry out precise matching of templates from CharBuffer1 and CharBuffer2. Instuction code: 03H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address Xxxx 4bytes Module address Xxxx 1 byte Package identifier 07H 1 byte Package identifier 01H 2 bytes Package length 05H 2 bytes Package length 03H 1 byte Confirmation code XxH 1 byte Instruction code 03H 2 bytes Matching score XxH 2 bytes Checksum sum 2 bytes Checksum 07H Acknowledge package format: Note 1: Confirmation code=00H: templates of the two buffers are matching! Confirmation code=01H: error when receiving package. Input Parameter: none Return Parameter: Confirmation code (1 byte),matching score. To search finger library Search Description: to search the whole finger library for the template that matches the one in CharBuffer1 or CharBuffer2. 2: The instruction doesn’t affect the contents of the buffers. . When found. Confirmation code=08H: templates of the two buffers aren’t matching. providing matching results. Confirmation code=11H: fail to clear finger library.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: 0dH Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address Xxxx 4bytes Module address Xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 2 bytes Package length 03H 2 bytes Package length 03H 1 byte Instruction code 0dH 1 byte Confirmation code xxH 2 bytes Checksum 0011H 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: empty success. PageID will be returned.18 - . PageNum(searching numbers) Return Parameter: Confirmation code (1 byte). 2h) would be processed as CharBuffer2. Other instructions To generate a random code GetRandomCode Description: to command the Module to generate a random number and return it to upper computer. Acknowledge package format: 2 bytes Header 0xEF01 4bytes Module address xxxx 1 byte Package identifier 07H 2 bytes Package length 7 1 byte Confirmation code xxH 2 bytes 页码 PageID 2 bytes 得分 MatchScore 2 bytes Checksum sum Note 1: Confirmation code=00H: found the matching finer.Input Parameter: BufferID. StartPage (searching start address).19 - . Other values (except 1h. 2: The instruction doesn’t affect the contents of the buffers. Confirmation code=01H: error when receiving package.8 for more about Random Number Generator. . Confirmation code=09H: No matching in the library (both the PageID and matching score are 0). Input Parameter: none Return Parameter: Confirmation code (1 byte) Instuction code: 14H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address xxxx 4bytes Module address xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 2 bytes Package length 03H 2 bytes Package length 07H 1 byte Confirmation code xxH 1 byte Instruction code 14H 4 bytes Random number xxxx 2 bytes Checksum 0018H 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: generation success. PageID (matching templates location) Instuction code: 04H Command (or instruction) package format: 2 bytes Header 4bytes Module address xxxx 1 byte Package identifie r 01H 2 bytes Package length 08H 1 byte Instructio n code 04H 1 byte buffer number BufferID 2 bytes Parameter 2 bytes Parameter 2 bytes Checks um sum 0xEF01 StartPage PageNum Note: BufferID of CharBuffer1 and CharBuffer2 are 1h and 2h respectively.Refer to 4. Confirmation code=01H: error when receiving package. Also see WriteNotepad.To write note pad WriteNotepad Description: for upper computer to write data to the specified Flash page (refer to 4. Input Parameter: NotePageNum. Input Parameter: none Return Parameter: Confirmation code (1 byte) + data content Instuction code: 19H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address xxxx 4bytes Module address xxxx 1 byte Package identifier 01H 1 byte Package identifier 07H 2 bytes Package length 3+32 2 bytes Package length 04H 1 byte Confirmation code xxH 1 byte Instruction code 19H 1byte Page number 0~15 32bytes User content User content 2 bytes Checksum xxH 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: read success. Refer to 4. Confirmation code=01H: error when receiving package. To read note pad ReadNotepad Description: to read the specified page’s data content.20 - .1 for more about user note pad. Confirmation code=01H: error when receiving package. .1 for more about Note pad). user content (or data content) Return Parameter: Confirmation code (1 byte) Instuction code: 18H Command (or instruction) package format: 2 bytes Header 0xEF01 2 bytes Header 0xEF01 4bytes Module address xxxx 4bytes Module address xxxx 1 byte Package identifier 01H 2 bytes Package length 36 1 byte Package identifier 07H 1 byte Instruction code 18H 2 bytes Package length 03H 1byte Page number 0~15 1 byte Confirmation code xxH 32 bytes Data content content 2 bytes Checksum sum 2 bytes Checksum sum Acknowledge package format: Note: Confirmation code=00H: write success. Also see ReadNotepad. Instruction Table Classified by functions type num 1 2 3 4 5 6 7 System-related code 01H 02H 03H 0AH Finerprint processing 04H 05H 06H 07H 08H 09H code 13H 12H 15H 0EH 17H 0FH 1DH description To verify password To set password To set device address To set Parameter Port control To read Parameter system system Finerprint processing Type num 13 14 15 16 17 18 19 Code 08H 09H 06H 07H 0CH 0DH 03H description to upload template To download template To store template. Search the finger library to get random code to write note pad To read note pad To read finger template numbers Collect finger image To upload image To download image To generate character file from image To combine character files and generate template 8 9 10 11 12 01H 0AH 0BH 02H 05H 20 21 22 others 23 04H 14H 18H 19H Classified by instruction code identifier GenImg Img2Tz Match Description Collect finger image To generate character file from image Carry out precise matching of two templates.21 - . to read/load template to delete tempates to empty the library Carry out precise matching of two templates. Search library the finger Code 0DH 0EH 0FH Identifier Empty SetSysPara ReadSysPara Description to empty the library To set system Parameter To read Parameter To set password To verify password system Serach RegModel 12H 13H SetPwd VfyPwd To combine character files and generate template To store template. to read/load template to upload template to download template To upload image Store LoadChar UpChar DownChr UpImage 14H 15H 17H 18H 19H GetRandomCode SetAdder Control WriteNotepad ReadNotepad to get random code To set device address Port control to write note pad To read note pad . 22 - .0BH 0CH DownImage DeletChar To download image to delete tempates 1BH 1DH HiSpeedSearch TempleteNum Search the library fastly To read finger template numbers . 23 - ..
Copyright © 2024 DOKUMEN.SITE Inc.