NG OP-67 Fingerprint Module User Manual V1.

NG OP-67 Fingerprint Module User Manual

System Summarize
System Characteristic
NG OP-67 Blue backlight Fingerprint Sensor Module adopts the optic fingerprint sensor, which consists of high-performance DSP and Flash. NG OP-67 is able to conduct fingerprint image processing, template generation, template matching, fingerprint searching, template storage, etc. Compared with similar products from other suppliers, NG OP-67 proudly boasts of following features: Immense Improved Algorithm NG OP-67 algorithm is specially written according to optic imaging theory. The algorithm is good for de-shaped or low-quality fingers due to its excellent correction and tolerance features. Flexible Application User can easily set NG OP-67 Module to different working modes depending on complexity of application systems. User can conduct secondary development with high efficiency and reliability. Easy to Use and Expand It is not necessary for user to have professional knowledge in the field of fingerprint verification. User can develop powerful fingerprint verification application systems with the command set provided by NG OP-67.

NG OP-67 Fingerprint Module User Manual V1.1 Low Power Consumption Sleep/awake control interface makes NG OP-67 suitable for occasions that require low power consumption. Different Security Levels User can set different security level according to different application environment.

Concepts in Fingerprint System

Fingerprint Feature Fingerprint algorithmic means capturing features from fingerprint image, it represents the fingerprint information. The saving, matching and capturing of fingerprint templates are all manipulated through fingerprint features. 1:1 Comparing 2 fingerprint templates, return info: matching or not matching. 1:N Searching Search the matching fingerprint from numbers of fingerprint features. Return info: No matching features or having matching features and returning the matching features ID simultaneity.

System parameter and interface

serial number 1 2 3 4 5 6 7 8 9 10 11 Index Power supply Working current Peak value current Fingerprint input time 1:1 matching time 1:900 searching time Fingerprint capacity FAR(False Acceptance Rate) FRR (False Rejection Rate) Fingerprint template size Outer interface Parameter 5V 170mA 200mA 250ms 600ms 2s Max. 960 0. 001 % 1.5 % 512bytes UART Matching features + matching fingerprint Condition

Default baud rate 9600bps, could change to other standard baud rate, refer to the parameter in this document Outer Interface Standard

UART Interface
Outer interface 6 chip FPC (Under wire), pins details as below:

NG OP-67 Fingerprint Module User Manual V1.1 Pins 1 2 3 4 5 6 Name VIN VIN TD RD GND GND Define Power Power Data transfer Data receive GND GND Type P P O I P P Function DC:3.6V-7V DC:3.6V-7V Open-drain output TTL3.3V or 5V GND GND

PINs from left to right

6--------1

USBInterface
Communicate with PC by USB. Capturing images, input template, searching, and interface defines as below:

GND

USB_DP

USB_DN

Power

UART Communication format detail

NG OP-67 is a complete fingerprint sensor module. No need to connect to other outer terminal, it is a Slave mode, Host could fulfill every functioning by different commands. Host command, module respond and data exchange are all operated according to specified format. Host should comply to the following format encapsulate.

NG OP-67 Fingerprint Module User Manual V1.1

Commands / Datasheet format

Commands / datasheet: Pack mark =01 Command Pack mark=02 Data, and has Follow-up package Pack mark=08 the last data pack, over All data packets have to add: 0xEF01

Command packs format:

Byte Name Content 2bytes Pack head 0xEF01 4bytes Chip add. xxxx 1 byte Pack mark 01 2 bytes Pack length N= 1byte command Parameter1 Parameter n 2 bytes Check sum

Data pack format:

Byte Name Content 2bytes Pack head 0xEF01 4bytes Chip add. Xxxx 1 byte Pack mark 02 2 bytes Pack length N bytes Data 2 bytes Check sum

Over Pack format:

Byte name content 2bytes Pack head 0xEF01 4bytes Chip add. Xxxx 1 byte Pack mark 08 2 bytes Pack length N bytes data 2 bytes Check sum

Data packs can not ingress into executive flow alone, it has to follow behind the command pack or respond pack. Upload or upload data pack are the same format. Pack length = the total bytes of pack length to check sum (command, parameter or data) including check sum, but excludes the bytes of pack length itself. Check sum includes all the bytes of the pack mark to check sum, in excess of 2-byte binary are ignored. Chip address are default as 0xFFFFFFFF before created, once the host computer through the command to generate the chip address, all packets must be generated in accordance with the address to send and receive. Chip will refuse to address the wrong packet.

NG OP-67 Fingerprint Module User Manual V1.1

Command response
Response is to report for the implementation of the orders and results execution. Response includes all the parameter and the follow-up data packets, PC only confirm by receiving the SOC response and order execution.

Response packet format: 2bytes 0xEF01 4bytes Chip add. 1 byte Pack mark 07 2 bytes Pack length 1 byte Confirm code N bytes Return parameter 2 bytes Check sum

Confirm code define: 1. 00hCommand execution over or OK; 2. 01hError in receiving data pack; 3. 02hNo fingerprint on sensor; 4. 03hFail in capturing fingerprint image; 5. 04hFingerprint images are too dry or too weak to generate the features; 6. 05hFingerprint images are too wet or unclear to generate the features; 7. 06hFingerprint images are too mess to generate the features; 8. 07hFingerprint images are normal but with few size to generate the features; 9. 08hFingerprint not match; 10. 09hNo fingerprints were found; 11. 0ahFail in matching fingerprint features; 12. 0bhThe address serial number on visiting the fingerprint database out of the range; 13. 0chReading template from fingerprint database fail or invalid; 14. 0dhUpload features failed; 15. 0ehModule can not accept follow-up data pack; 16. 0fhUpload image failed; 17. 10hDelete template failed; 18. 11hEmpty fingerprint data failed; 19. 12hCan no enter low consumption state; 20. 13hCommand incorrect; 21. 14hSystem reposition failed; 22. 15HCan not generate image due to invalid original image in buffer; 23. 16HOn line upgrade failed; 24. 17HRemnant fingerprint or No movement on second scan; 25. 18HReading FLASH error; 26. 0xf0Having follow-up data pack command, respond with 0xf0 after receiving; 27. 0xf1Having follow-up data pack command, respond with 0xf1; 28. 0xf2Check sum error on writing inner FLASH; 29. 0xf3Pack mark error on writing inner FLASH; 30. 0xf4Pack length error on writing inner FLASH; 31. 0xf5Code length too long on writing inner FLASH;

NG OP-67 Fingerprint Module User Manual V1.1 32. 0xf6Failed on writing inner FLASH; 33. 0x19Not define error; 34. 0x1aInvalid register number; 35. 0x1bRegister enactment error number; 36. 0x1cWordPad page define error; 37. 0x1dTerminal operation failed; 38. 0x1eEnroll failed; 39. 0x1fFingerprint data full; 40. 0x200xefhReserved Command could only download from PC to module, module responds to PC. When system electrify reposition, first to check if the default equipment handshake command has been modified, if not, system thinks the PC doesnt have demand to verify the command, SOC begins to work. If it has been modified, first have to verify equipment handshake command, when the command passed, SOC begins to work.

Command and address

System default command is 0, if the default command hasnt been modified, the system doesnt require for command, PC could communicate directly to chip. If the command has been modified, the first command on PC and chip communication must be the verify command, only if the verify command passed, the chip begins to receive other commands. The default address for chip is 0Xffffffff, it can be modified by command, the data pack address field must match to this address then the command/data pack can be received by system.

Communicate baud rate

a) UART default baud rate 57.6kbps; b) UART default baud rate can be modified by loaded configuration list; c) UART baud rate can be set by command, range from 9600bps to 921600bps; d) If the PC is MCU, then connect to TD and RD, if it is the PC, then should connect with RS232 Chip-level conversion. e ) Module support standard USB port, could communicate with PC by converter.

Commands
1. PS_GetImage Command code01H FunctionCapture fingerprint image from sensor and save on image buffer. 2. PS_GenChar Command code02H FunctionGenerate fingerprint features according to original image and save on CharBuffer1 or

NG OP-67 Fingerprint Module User Manual V1.1 CharBuffer2 3. PS_Match Command code03H FunctionAccurately matching features in CharBuffer1 and CharBuffer2 4. PS_Search Command code04H FunctionSearching features in CharBuffer1 or CharBuffer2 in fingerprint data 5. PS_RegModel Command code05H FunctionCombine features in CharBuffer1 and CharBuffer2, generate template and save in CharBuffer2 6. PS_StoreChar Command code06H FunctionSave documents to flash 7. PS_LoadChar Command code07H FunctionReading template to feature buffer from 8. PS_UpChar Command code08H FunctionUpload document to PC from feature buffer 9. PS_DownChar Command code09H FunctionDownload feature document from PC to feature buffer 10. PS_UpImage Command code0AH FunctionUpload origin image 11. PS_DownImage Command code0BH FunctionDownload origin image 12. PS_DeletChar Command code0CH FunctionDelete feature document from flash 13. PS_Empty Command code0DH FunctionEmpty flash 14. PS_WriteReg Command code0EH Function Writing SOC 15. PS_ReadSysPara Command code0FH FunctionReading system parameter 16. PS_Enroll Command code10H FunctionEnrolling template

NG OP-67 Fingerprint Module User Manual V1.1 17. PS_ Identify Command code11H FunctionIdentifying fingerprint 18. PS_SetPwd Command code12H FunctionSet up password 19. PS_VfyPwd Command code13H FunctionValidate equipment hand-shake command 20. PS_GetRandomCode Command code14H FunctionSampling Random Number 21. PS_SetChipAddr Command code15H FunctionSet up chip address 22. PS_ReadINFpage Command code16H FunctionReading FLASH Information Page 23. PS_Port_Control Command code17H FunctionCommunication portUART/USBon / off control 24. PS_WriteNotepad Command code18H Function Writing notepad 25. PS_ReadNotepad Command code19H FunctionReading notepad 26. PS_BurnCodePS1802 SOC burning FLASH code Command code1AH FunctionProgramming FLASH 27. PS_HighSpeedSearch Command code1BH FunctionHigh speed search FLASH 28. PS_GenBinImage Command code1CH FunctionGenerate Binarization fingerprint image 29. PS_ValidTempleteNum Command code1dH FunctionReading Valid template numbers

User Notepad
Theres a 512 byte memory as user notepad in FLASH, total 16 pages and 32 byte on every page, PC could visit any page with PS_WriteNotepad and PS_ReadNotepad command.

NG OP-67 Fingerprint Module User Manual V1.1 Note: when writing one of the pages, the 32 byte concept would be fully writing in to cover the original concept.

Feature and template

The size for fingerprint feature document is 256 byte, include character info. And general info. Template size is 512 byte are the sum of 2 different fingerprint features.

Command Details Entry image PS_GetImage

Functiondetecting finger, entry image and save on ImageBuffer, return confirm code means entry success, no finger etc. Input parameter none Return parameter confirm command code 01H command pack format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 03H 1 byte Command code 01H 2 bytes Check sum 05H

Respond format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

1 byte Pack mark 07H

2 bytes Pack length 03H

1 byte Confirm code xxH

2 bytes Check sum sum

Remark confirm code=00H means input success Confirm code=01H means receive error Confirm code=02H means no finger on sensor Confirm code=03H means input not success sum check sum

Generate features PS_GenChar

Function Generate original fingerprint feature as fingerprint feature document and save on CharBuffer1 or CharBuffer2 Input parameterBufferID Return parameterconfirm Command code02H

NG OP-67 Fingerprint Module User Manual V1.1 Command pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

1 byte Pack mark 01H

2 bytes Pack length 04H

1 byte Command code 02H

1 byte Buffer ID BufferID

2 bytes Check sum sum

Note: CharBuffer1, CharBuffer2s BufferID are 1h and 2h, if appointing to other value, dealing following CharBuffer2. Respond format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 07H Pack length 03H Confirm code xxH Check sum sum

NoteConfirm code=00H means generate feature success; Confirm code=01H means receiving error: Confirm code=06H means fingerprint image are too mess to generate feature; Confirm code=07H means fingerprint image normal but having very little characteristics to generate feature Confirm code=15H means no valid original image in buffer to generate image; sum means check sum

Precisely matching 2 fingerprint fatures PS_Match

FunctionPrecisely matching feature documents in CharBuffer1 and CharBuffer2 Input parameternone Return parameterconfirm, matching score Command code03H Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 01H 1 byte Pack mark 07H Pack length 03H 2 bytes Pack length 05H Command code 03H 1 byte Command code xxH Check sum 07H 2 bytes Check sum xxH

Responding format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means fingerprint match Confirm code=01H means receiving error Confirm code=08H means fingerprint not match sum means check sum

NG OP-67 Fingerprint Module User Manual V1.1

Searching fingerprint PS_Search

Functionsearching the whole data with CharBuffer1 or CharBuffer2 feature documents, return to page if found out Input parameterBufferID StartPagePageNum Return parameterconfirm, page (matching fingerprint template Command code04H Command code format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 08H 1 byte Command code 04H 1 byte Buffer BufferID 2 bytes parameter StartPage 2 bytes parameter PageNum 2 bytes Check sum sum

Note CharBuffer1CharBuffer2 and BufferID are 1h and 2h Respond format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 2 bytes Pack length 07H 1 byte Confirm code xxH 2 byte Page PageID 2 byte score MatchScore 2 bytes Check sum sum

NoteConfirm code=00H mean searching out Confirm code=01H means receiving error Confirm code=09H means no searching outpage score 0 sum means check sum

Combine featuresgenerate template PS_RegModel

FunctionCombine the CharBuffer1 and CharBuffer2s feature documents and generate template, save in CharBuffer1 and CharBuffer2. Input parameterNone Return parameterConfirm Command code05H Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 01H 1 byte Pack mark 07H Pack length 03H 2 bytes Pack length 03H Command code 05H 1 byte Command code xxH Check sum 09H 2 bytes Check sum sum

Respond format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NG OP-67 Fingerprint Module User Manual V1.1 NoteConfirm code=00H means combine success Confirm code=01H means receiving error Confirm code=0aH means combine failed ( the 2 fingerprint are not for the same finger) sum means check sum

Store templates PS_StoreChar

Functionsave template documents in CharBuffer1 or CharBuffer2 to PageID flash. Input parameterBufferID, PageID Return parameterConfirm Command code06H Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 01H Pack length 06H Command code 06H Buffer BufferID ID PageID Check sum sum

Note CharBuffer1, CharBuffer2 and BufferID are 1h and 2h Respond format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

1 byte Pack mark 07H

2 bytes Pack length 03H

1 byte Confirm code xxH

2 bytes Check sum sum

NoteConfirm code=00H means store success Confirm code=01H means receiving error Confirm code=0bH means PageID not in database Confirm code=18H means FLASH error sum means check sum

Reading template PS_LoadChar

FunctionReading pointed ID in database to CharBuffer1 or CharBuffer2 Input parameterBufferID, PageID Return parameterConfirm Command code07H Command pack format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 06H 1 byte Command code 07H 1 byte buffer BufferID 2 bytes page PageID 2 bytes Check sum sum

Note CharBuffer1CharBuffer2 s BufferID are 1h and 2h Respond format

NG OP-67 Fingerprint Module User Manual V1.1 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 2 bytes Pack length 03H 1 byte Confirm code xxH 2 bytes Check sum sum

NoteConfirm code=00H means reading success Confirm code=01H means receiving error Confirm code=0cH means reading error or invalid template Confirm code=0BH means PageID not in data sum means check sum

Upload characteristics or template PS_UpChar

FunctionUploading buffer characteristics document to PC Input parameterBufferID Return parameterConfirm Command code08H Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 04H 1 byte Command code 08H 1 byte buffer BufferID 2 bytes Check sum sum

NoteCharBuffer1CharBuffer2 s BufferID are 1h and 2h Respond format 2 bytes 4bytes 1 byte 2 bytes 1 byte Pack head 0xEF01 Chip address xxxx Pack mark 07H Pack length 03H Confirm code xxH

2 bytes Check sum sum

NoteConfirm code=00H means following pack Confirm code=01H receiving error Confirm code=0dH executive command failed sum means check sum sending following data pack after respond

Download characteristic or template PS_DownChar

FunctionPC download characteristic document to module buffer Input parameterBufferID Return parameterconfirm Command code09H Command pack format

NG OP-67 Fingerprint Module User Manual V1.1 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 04H 1 byte Command code 09H 1 byte buffer BufferID 2 bytes Check sum sum

Note CharBuffer1CharBuffer2s BufferID are 1h and 2h Respond pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte Pack head 0xEF01 Chip address xxxx Pack mark 07H Pack length 03H Confirm code xxH

2 bytes Check sum sum

NoteConfirm code=00H means could accept following data pack Confirm code=01H receiving error Confirm code=0eH means can not accept following data pack Sum means check sum Receiving following data pack after respond

Image PS_UpImage
FunctionUpload buffer image to PC Input parameterNone
Return parameterConfirm Command code0aH command pack format 2 bytes 4bytes Chip address xxxx 4bytes Chip address xxxx

1 byte Pack mark 01H 1 byte Pack mark 07H

2 bytes Pack length 03H 2 bytes Pack length 03H

1 byte Command code 0aH 1 byte Confirm code xxH

2 bytes Check sum 000eH 2 bytes Check sum sum

Pack head 0xEF01

Respond format 2 bytes Pack head 0xEF01

NoteConfirm code=00H means following data pack Confirm code=01H means receiving error. Confirm code=0fH means can not send following data pack sum means check sum Sending following data pack after respond 1 byte with 2 Pixels, every Pixel with 4bits

NG OP-67 Fingerprint Module User Manual V1.1

Download image PS_DownImage

FunctionPC downloads image data to module Input parameterNone Return parameterConfirm Command code0bH command pack format
2 bytes Pack head 0xEF01 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 4bytes Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 07H 2 bytes Pack length 03H 2 bytes Pack length 03H 1 byte Command code 0bH 1 byte Command code xxH 2 bytes Check sum 000fH 2 bytes Check sum sum

Respond pack format

NoteConfirm code=00H means could receive following data pack Confirm code=01H means receiving error Confirm code=0eH means can not receive following data pack sum means check sum receiving following data pack after respond, data pack length 64128 or 256

1 byte include 2 pixels, every pixel with 4bits

Delete template PS_DeletChar

FunctionDelete pointed fingerprint template ID starts with N in flash Input parameterPageIDdelete template number N Return parameterConfirm Command code0cH command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 07H 1 byte Command code 0cH 2 bytes page PageID 2bytes Delete number N 2 bytes Check sum sum

Respond pack format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 2 bytes Pack length 03H 1 byte Confirm code xxH 2 bytes Check sum sum

NoteConfirm code=00H means delete template success

NG OP-67 Fingerprint Module User Manual V1.1 Confirm code=01H means receiving error; Confirm code=10H means delete template fail; sum means check sum

Empty fingerprint data PS_Empty

FunctionDelete all fingerprint templates in data flash

Input parameterNone Return parameterConfirm Command code0dH Command pack format

2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 07H 2 bytes Pack length 03H 2 bytes Pack length 03H 1 byte Command code 0dH 1 byte Confirm code xxH 2 bytes Check sum 0011H 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means empty success; Confirm code =01H means receive error; Confirm code=11H means empty fail; sum means check sum

Writing system Register PS_WriteReg

FunctionWriting module register Input parameterRegister series number Return parameterConfirm Command code0eH Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 05H 1 byte Command code 0eH 1byte Register series number 4/5/6 1byte concept xx 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

1 byte Pack mark 07H

2 bytes Pack length 03H

1 byte Confirm code xxH

2 bytes Check sum sum

NG OP-67 Fingerprint Module User Manual V1.1 Register number 4 5 Register name Baud rate controls register Matching threshold register details 9600 s multiple N 1level1 2level2 3level3 4level4 5level5 032bytes 164bytes 2128bytes 3256bytes

Pack size register

Note 1 : Confirm code=00H means OK Confirm code=01H means receiving pack error Confirm code=1aH means register series number error sum means check sum Note 2Writing system registerPS_WriteReg executing command, respond with original configure, modify system setup after respond and configure record in FLASH, when system being restarted, it will work with new configure.

Reading system parameter PS_ReadSysPara

FunctionReading module parameter (baud rate, pack size etc.).
the first 16 bytes on parameter list store basic communication and configure info., this is the module basic parameter

Input parameterNone Return parameterconfirm code + basic parameter16bytes Command code0fH Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 1 byte Pack mark 01H 2 bytes Pack length 3+16 2 bytes Pack length 03H 1 byte Confirm code xxH 1 byte Command code 0fH 16 bytes Basic parameter list Configure as below 2 bytes Check sum 0013H 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means OK Confirm code=01H means receiving pack error sum means check sum Name Description Offset (Byte) Size Byte

NG OP-67 Fingerprint Module User Manual V1.1 Status Register Sensor type System Concepts of the Status Register Sensor type code 0fpc1011c 2c500 3s500 strip 7strip 9User-defined sensor Othersreserved Fingerprint data capacity Security level code (1/2/3/4/5) 32 byte equipment address Data pack size code 032bytes 162bytes 2128bytes 3256bytes N (baud rate 9600*N bps) 0 1 1 1

Fingerprint data size Security level Equipment address Data pack size

2 3 4 6

1 1 2 1

Baud rate setup

Auto register template PS_Enroll

Function First enroll fingerprint register template, searching space and store in database, return store ID Input parameterNone Return parameterconfirm, page matching fingerprint template Command code10H Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 01H 1 byte Pack mark 07H Pack length 0003H 2 bytes Pack length 5 1 byte Confirm code xxH Command code 10H 2 bytes Page PageID Check sum 0014H 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means register success Confirm code=01H means receiving error Confirm code=1eH means register fail. sum means check sum

NG OP-67 Fingerprint Module User Manual V1.1

Auto identify fingerprint PS_Identify

Function Auto collect fingerprint, searching target template in data and return with searching result. If the target template with the current collection of fingerprint matching score is higher than the maximum threshold, and the target template with incomplete collected characteristics, then upgrade the target template s blank space with collected characteristics. Input parameternone Return parameterconfirm, page matching fingerprint template Command code11H Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Pack head 0xEF01 2 bytes Pack head 0xEF01 4bytes Chip address xxxx Chip address xxxx 1 byte Pack mark 07H Pack mark 01H 2 bytes Pack length 7 Pack length 0003H 1 byte Confirm code xxH 2 bytes Page PageID Command code 11H 2 bytes Score MatchScore Check sum 0015H 2 bytes Check sum sum

Respond pack format

NoteConfirm code=00H means searching out Confirm code=01H means receiving pack error Confirm code=09H means no searching result, page and score 0 sum means check sum

Setting password PS_SetPwd

FunctionSetting module hand-shake password Input parameterPassWord Return parameterConfirm Command code12H Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 07H 1 byte Command code 12H 4 byte Password PassWord 2 bytes Check sum sum

Note Module address default 0

Respond pack format 2 bytes Pack head 4 byte Chip address 2 bytes Pack length 1 byte Confirm code 2 bytes Check sum

NG OP-67 Fingerprint Module User Manual V1.1 0xEF01 xxxx 03H xxH sum

NoteConfirm code=00H means OK Confirm code=01H means receiving pack error sum means check sum

Verifying password PS_VfyPwd

FunctionVerifying module hand-shake password Input parameterPassWord Return parameterConfirm Command code13H Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 07H 2 bytes Pack length 07H 2 bytes Pack length 03H 1 byte Command code 13H 4 byte Password PassWord 1 byte Confirm code xxH 2 bytes Check sum sum 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means password correct; Confirm code=01H means receiving pack error Confirm code=13H means password incorrect sum means check sum

Sampling random number PS_GetRandomCode

Functionchip generates a random number and return to PC Input parameternone Return parameterconfirm Command code14H Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 03H 1 byte Command code 14H 2 bytes Check sum 0018H

Respond pack format 2 bytes 4bytes Pack head Chip

1 byte Pack mark

2 bytes Pack length

1 byte Confirm

4 bytes Random

2 bytes Check sum

NG OP-67 Fingerprint Module User Manual V1.1 address 0xEF01 xxxx 07H 07H code xxH number xxxx sum

NoteConfirm code=00H means generate success Confirm code=01H means receiving pack error sum means check sum

Setting chip address PS_SetChipAddr

FunctionSetting chip address Input parameternone Return parameterconfirm Command code15H Command pack format
2 bytes Pack head 0xEF01 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 4bytes Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 07H 2 bytes Pack length 07H 1 byte Command code 15H 2 bytes Pack length 03H 4 byte Chip address xxxx 1 byte Confirm code xxH 2 bytes Check sum sum 2 bytes Check sum sum

Respond pack format

NoteConfirm code=00H means generate address success Confirm code=01H means receiving pack error sum means check sum Using default address when PC sending command pack0xffffffff, responding pack address using new generated address. Chip address stays unchanged by executing the command. To change the chip address only with emptying FLASH.

Reading flash Info. Page PS_ReadINFpage

FunctionReading FLASH Information Page (512bytes) Input parameternone Return parameterconfirm Command code16H
Command pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 2 bytes Pack length 03H 2 bytes Pack length 1 byte Command code 16H 1 byte Confirm code 2 bytes Check sum 001aH 2 bytes Check sum

Responding pack format 2 bytes 4bytes Pack head Chip address

NG OP-67 Fingerprint Module User Manual V1.1 0xEF01 xxxx 07H 03H xxH sum

NoteConfirm code=00H means sending data pack by following Confirm code=01H means receiving pack error Confirm code=0dH means executing command fail sum means check sum Sending following data pack after respond

Port control PS_Port_Control

Function
For UART protocol, the command controls USB communication port. For USB protocol, the command controls UART port

Input parameterControl code

Control code 0 means closing port Control code 1 means opening port

Return parameterConfirm Command code17H Command pack format

2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 07H 2 bytes Pack length 04H 2 bytes Pack length 03H 1 byte Command code 17H 1 byte Control code 0/1 1 byte Confirm code xxH 2 bytes Check sum sum 2 bytes Check sum sum

Responding pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means port operation success Confirm code=01H means receiving pack error Confirm code=1dH means port operation fail Sum means check sum

Writing notepad PS_WriteNotepad

Function Internal module creates a 256bytes FLASH for users to store data, this is User
Notepad, it has 16 pages. Writing notepad command uses to write users 32bytes data to pointed notepad.

Input parameterNotePageNum,user content Return parameterconfirm Command code18H Command pack format
2 bytes Pack 4bytes Chip 1 byte Pack 2 bytes Pack 1 byte Command 1byte Page 32 bytes User info. 2 bytes Check

NG OP-67 Fingerprint Module User Manual V1.1 head 0xEF01 address xxxx mark 01H length 36 1 byte Pack mark 07H code 18H 2 bytes Pack length 03H 0~15 content 1 byte Confirm code xxH sum sum 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=00H means OK Confirm code=01H means receiving pack error sum means check sum

Reading notepad PS_ReadNotepad

FunctionReading FLASH User space 128bytes data Input parameternone Return 7169 parameterConfused + user info. Command code19H Command pack format
2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 04H 1 byte Command code 19H 1byte Page 0~15 2 bytes Check sum xxH

Respond pack format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 2 bytes Pack length 35 1 byte Confirm code xxH 32 bytes User info. User content 2 bytes Check sum sum

NoteConfirm code=00H means OK Confirm code=01H means receiving pack error sum means check sum

Burnning FLASH PS_ BurnCode

FunctionPC downloads code data and write to FLASH Input parameternone Return parameterconfirm Command code01AH
Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 bytes 2 bytes

NG OP-67 Fingerprint Module User Manual V1.1 Chip address xxxx Command code 1AH Upgrade mode 0/1

Pack head 0xEF01

Pack mark 01H

Pack length 04H

Check sum sum

Upgrade mode 0only upgrade info. pages Upgrade mode 1fully upgrade Othererror Respond pack format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 2 bytes Pack length 03H 1 byte Confirm code xxH 2 bytes Check sum sum

NoteConfirm code=00H means could accept follow-by data pack Confirm code=01H means receiving pack error Confirm code=0eH means can not accept following data pack sum means check sum Accepting following data pack after respond, data pack length 64, 128 or 256

High speed search PS_HighSpeedSearch

Function Searching data with CharBuffer1 or CharBuffer2s characteristic document. Return with searching result This command will give a fast search result for fingerprint in good condition. Input parameterBufferID StartPagePageNum Return parameterConfirm, page(matching fingerprint template Command code1bH Command pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 01H Pack length 08H Command code 1bH Buffer BufferID Parameter StartPage Parameter PageNum Check sum sum

NoteBuffer CharBuffer1CharBuffer2s BufferID are 1h and 2h Respond pack format 2 bytes 4bytes 1 byte 2 bytes 1 byte 2 bytes Pack head 0xEF01 Chip address xxxx Pack mark 07H Pack length 7 Confirm code xxH Page PageID

2 bytes Score MatchScore

2 bytes Check sum sum

NoteConfirm code=00H means searching out Confirm code=01H means receiving pack error Confirm code=09H means no searching result; page and score 0

NG OP-67 Fingerprint Module User Manual V1.1 sum means check sum

Generate fingerprint image PS_GenBinImage

Function Processing with fingerprint image in buffer, precising and generate fingerprint image Input parameterBinImgTpye 0Image binarization 1Not including characteristics mark binarization image 2 or otherswith characteristic mark binarization image Return parameterConfirm

Command code1cH Command pack format

2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 1 byte Pack mark 07H 2 bytes Pack length 04H 2 bytes Pack length 03H 1 byte Command code 1cH 1 bytes Target type 0/1/2 1 byte Confirm code xxH 2 bytes Check sum sum 2 bytes Check sum sum

Respond pack format 2 bytes 4bytes Pack head 0xEF01 Chip address xxxx

NoteConfirm code=01H means receiving pack error Confirm code=15H means invalid fingerprint image Confirm code= 07 H means no enough characteristic info. Confirm code=06 H means image in poor quality sum means check sum

Reading valid template number PS_ValidTempleteNum

FunctionReading valid template numbers Input parameternone Return parameterconfirmvalid template number ValidN Command code1dH Command pack format 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 01H 2 bytes Pack length 0003H 1 byte Command code 1dH 2 bytes Check sum 0021H

Respond pack format

NG OP-67 Fingerprint Module User Manual V1.1 2 bytes Pack head 0xEF01 4bytes Chip address xxxx 1 byte Pack mark 07H 2 bytes Pack length 5 1 byte Confirm code xxH 2 bytes Valid template number ValidN 2 bytes Check sum sum

Noteconfirm code=00H means reading success Confirm code=01H means receiving pack error sum means check sum

Function realization sample

a) Press twice the fingerprint and enroll a template, save in flash
Sending get image

Start

command: PS_GetImage

Sending capturing image command: PS_GetImage Wait for respond

Over

Wait for respond Read image

Flash shows success

Reading image

Waiting respond Generate characteristic command: PS_ GenChar Parameter: BufferID=2

Generate characteristic command: PS_GenChar Parameter: BufferID=1 Waiting respond

Generate characteristic command: PS_ StoreChar ParameterBufferID=2

Waiting respond OK OK OK Green light flash (Optional, depend on PC) Green light flash

NG OP-67 Fingerprint Module User Manual V1.1

Waiting respond

Send register template command: PS_ RegModle

Flash shows failed register

b fingerprint data space from sensor to searching fingerprint 10100

Start

Send command: PS_GetImage

Waiting respond

OK

Send command: PS_GetChar

Waiting respond

Send command: PS_Search Parameter: StartPage, PageNum, BufferID

Waiting respond

NG OP-67 Fingerprint Module User Manual V1.1