Fingerprint Identification Module - AJ155 - User Manual & Operation Guide

Transcription

1 Fingerprint Identification Module - AJ155 - User Manual & Operation Guide YANEN Technology. Page: 1/24

2 Table of Contents 1. INTRODUCTION OVERVIEW SPECIFICATION FEATURE HARDWARE INTERFACE PROTOCOL UART Format Command Set Register Fingerprint Compare Fingerprint Query Fingerprint Image Information Scan Fingerprint Image Check Registered Fingerprint Number Switch Baudrate Init Fingerprint Image Get Next Fingerprint Image EXAMPLE LED LIGHT DISPLAY INSTRUCTIONS CONNECTION MODE STANDALONE MODE OPERATION EXAMPLE CONNECTION TO ARDUINO Hardware Installation Arduino Source Code Arduino Command CONNECTION TO RASPBERRY PI Hardware Installation Raspberry Pi Source Code Raspberry Pi Command CONNECTION TO PC SIDE Hardware installation Tool installation Tool operation instruction Command Set...22 YANEN Technology. Page: 2/24

3 1. Introduction This document is the operation manual of the "Fingerprint Evaluation Board (AJ155)". The following instructions are called AJ155. The contents of the document contain the AJ155 introduction, specifications, communication protocols, operating instructions and usage examples in different environments. The operating examples in this manual also provide test tools and source code. The AJ155 is a high-performance fingerprint identification module that provides product developers with the need to develop fingerprint identification requirements (application areas such as fingerprint locks, safes, industrial controls, licensing, finance, etc.). In addition, the AJ155 can be used in development kits such as Arduino, Raspberry Pi, FPGA, ARM, pcduino, etc. in microprocessor control boards with UART (Serial Port) interface. This document provides the user with a complete description of the steps to easily complete the operation Overview AJ155 is a fingerprint identification sensor. The sensor consists of high-speed processor, high-performance fingerprint algorithm and FLASH chip. The sensor has stable performance and simple structure. The functions include fingerprint comparison, image scanning transmission, search, fingerprint storage and system unique internal code protection mechanism. The fingerprint matching display program can register two fingerprints for comparison, and the comparison speed is fast and the correct rate is high, which can provide developers to develop various applications. The system-specific XOM mechanism protects the code from "execution" and cannot be "read" to protect important intellectual property code. Functional characteristics: Independently complete fingerprint acquisition, fingerprint storage, fingerprint comparison (1:1) and fingerprint search (1: N) functions. Small size: The product size is small, and the built-in fingerprint algorithm chip board is convenient for installation. Low power consumption: Low power consumption and suitable for most applications. Simple application development: Developers can develop fingerprint-related products based on control instructions without the need for professional fingerprint identification knowledge. AJ155 Fingerprint Sensor YANEN Technology. Page: 3/24

4 1.2. Specification EVB Size:65x19x1(mm) MCU:Nuvoton M2351, ARM-M0 Plus, 32-bit, 64 MHz Sensor Module:A172 FAR:<0.001%(Security Level, 3) Active area:176*176pixels FRR:<0.1%(Security Level, 3) Resolution:508 Dpi Operating environment:-20 to +60 / <RH 90% Sample rate:40 frames/s Storage environment:-40 to +70 / <RH 90% Matching mode:1:1, 1:N Matching time:< 0.3s Enrollment time:< 0.2s 1.3. Feature USB 2.0 full speed device LED and push buttons SD card socket Fingerprint sensor Crypto acceleraor Emulating drivers - HID protocol - Storage class - Biometric class Communication interface:uart Power:UART 3.3V or USB 1.4. Hardware Interface The communication interface of AJ155 module is UART. The AJ155 hardware description and wiring diagram are shown below. In the figure, the oval red frame is the USB interface, the square red frame is the fingerprint sensor, the round red frame is the reset button, the rectangle red frame is the UART interface, and the UART pin is from left to right for VCC (3.3V), GND, RX, and TX are defined as follows. When the AJ155 module communicates with user device, definition of pin is as follows: Name Type Description VCC In Power input (3.3V) GND -- Signal ground. Connected to power ground RX In Data input. TX Out Data output. YANEN Technology. Page: 4/24

5 Vcc GND RX TX AJ155 hardware description and wiring diagram 2. Protocol The communication protocol between the AJ155 and the connected control board. The control board (such as Arduino ) is the master (Master) and the AJ155 is the slave (Slave). Slave are powered by UART and USB. Slave(AJ155) Power Master (Arduino/Raspberry/PC) MA UART/USB The channel used by this communication protocol is UART. The initial transfer rate of the UART is 9600, N, 8, and 1. This setting can be changed by command UART 9600/19200/38400/57600/ N,8,1(No parity, 8-bit data, 1-bit Stop). YANEN Technology. Page: 5/24

6 Format The protocol format is done in string form and defines the format of the instruction. Basically, the command string for the Master is given to the slave. The command string is encapsulated with <C> and </C>, and then all the strings from the Slave are scanned and the response string is parsed therefrom. The Slave response string is as follows: Command string OK: NG: FINISHED: PASS: FAIL: OK: INFO: Response string <R>OK</R> <R>NG</R> <R>FINISHED</R> <R>PASS</R> or <R>PASS_0</R>, <R>PASS_1</R> <R>FAIL</R> <R>OK</R> <R>W=(width),H=(height)</R>, (width) and (height) are the width and length of the fingerprint image, and Slave responds according to the actual value. In addition, for fingerprint image data, Slave is especially transmitted back and forth by a plurality of binary bytes (bytes) encapsulated by <I> and </I>. The Master must wait for the previous command to complete before the next command string can be given to the Slave Command Set Register Fingerprint Command string:<c>registerfingerprint</c> After the Master commands the Slave to complete the fingerprint registration, the previously registered data will be overwritten. After the Master commands the Slave to complete the fingerprint registration, the previously registered data will be overwritten. A total of 2 fingerprints will be registered, and each fingerprint will be pressed 3 times to register. (After registering the fingerprint press, see the green light is on, the finger can move away from the pressing area) The Slave response is as follows: 1> Return OK_string first. 2> Slave will give an indication of pressing the fingerprint, and the user will press according to the instruction. 3> Return FINISHED_ string Compare Fingerprint Command string:<c>comparefingerpring</c> Master commands Slave to do fingerprint matching. If there are no registered fingerprints available for comparison, Slave will return the NG_ string, otherwise it will return to the YANEN Technology. Page: 6/24

7 OK_ string as follows: 1> Return OK_string first. 2> Slave will give an indication of pressing the fingerprint, and the user will press according to the instruction. 3> After the comparison, respond to the FAIL_ string (match failure) or PASS_ string (match success), Also shows the details as follows: <R>PASS_0</R> <= Successful comparison with the first fingerprint (record starts from 0). <R>PASS_1</R> <= Successfully compared with the second fingerprint Query Fingerprint Image Information Command string:<c>fpimageinformation</c> The Master asks for fingerprint image information, and the Slave responds to the INFO_ string, for example: <R>W=300, H=600</R> The fingerprint images are 8-bit grayscale images. This response indicates that the fingerprint image width is 300 pixels and the height is 600 pixels Scan Fingerprint Image Command string:<c>scanfpimage</c> The Master sends a command to the Slave to scan the fingerprint image and upload it to the Master. The steps are as follows: 1> Return OK_string first. 2> Slave transmits an indication of the fingerprint pressing action, and the user presses according to the instruction, and the step is ended after the valid fingerprint is scanned. 3> All image data uploaded to the Master is encapsulated by <I> and </I>. In the current version of the fingerprint module image, the length and width of the image size are 176 pixels, so there will be 176*176=30976 bytes of image data between <I> and </I> Check Registered Fingerprint Number Command string:<c>checkregisteredno</c> Slave responds with <R> and </R> to encapsulate the number, for example: <R>0<R> Indicates no registration data. <R>2<R> Indicates that there are 2 registration data. YANEN Technology. Page: 7/24

8 Switch Baudrate Command string:<c>baudrate=(baudrate)</c> From the Master command to the Slave, change the Baudrate transmission rate, the current system supports the following speeds: <C>Baudrate=9600</C> Set the transmission rate to 9600, N, 8, 1 <C>Baudrate=19200</C> Set the transmission rate to 19200, N, 8, 1 <C>Baudrate=38400</C> Set the transmission rate to 38400, N, 8, 1 <C>Baudrate=57600</C> Set the transmission rate to 57600, N, 8, 1 <C>Baudrate=115200</C> Set the transmission rate to , N, 8, 1 Note: If the Master setting is not within the supported rate, the Slave will have no response. For example, if the Master is <C>Baudrate=50000</C>, the Slave will have no response. Within the baudrate speed supported by the system, when the Slave is changed to baudrate, the Slave will respond to the OK_ string and execute at the changed rate until it is changed again. Therefore, the Master must confirm the supported speed before the modification. Otherwise, the Master will not be able to communicate with Slave after the change. After changing the baudrate, Slave will reset and restart at the new rate Init Fingerprint Image Command string:<c>initfpimage</c> Master commands Slave to scan the fingerprint image. If Slave does not support this function, it will return to the NG_ string, otherwise it will respond according to the following steps: 1> Return OK_string first. 2> Slave transmits an indication of the fingerprint pressing action, and the user presses according to the instruction, and the step is ended after the valid fingerprint is scanned. 3> Return FINISHED_ string Get Next Fingerprint Image Command string:<c>getnextfpimage</c> This command must be used in conjunction with the scan fingerprint image command. The Master commands the slave to upload the next fingerprint image to the Master. One segment is a 512-bit tuple. If less than 512 bytes, the remaining data is uploaded. If Slave does not support this function or if there is no data to return, it will return to the NG_ string, otherwise it will respond according to the following steps: 1> Return OK_string first. 2> Slave encapsulates the image data of each segment with <I> and </I> and uploads it to the Master. YANEN Technology. Page: 8/24

9 2.2. Example <UART> Check Registered Fingerprint Number Master <C>CheckRegisteredNo</C> Slave // Slave responds to the current number of registrations. Master <R>0<R> Slave Register Fingerprint Master <C>RegisterFingerprint</C> Slave // Slave responds to the OK_ string. Master <R>OK<R> Slave // Slave returns the registration action indication to the user, and the Master displays the indication to the user. // After the registration is successful, Slave responds to the FINISHED_ string. Master <R>FINISHED<R> Slave Compare Fingerprint Master <C>CompareFingerprint</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave // Slave returns the fingerprint indication to the user, and the Master displays the indication to the user. // After the comparison is completed, Slave responds to the PASS_string or FAIL_ string. Master <R>FAIL</R> Slave or Master <R>PASS</R> Slave or Master <R>PASS_0</R> Slave or Master <R>PASS_1</R> Slave Query Fingerprint Image Information Master <C>FpImageInformation</C> Slave // Slave responds to fingerprint image data. Master <R>W=176, H=176</R> Slave This response indicates that the fingerprint image has a width of 176 pixels and a height of 176 pixels. The fingerprint image size is 176x176 = bytes. Scan Fingerprint Image Master <C>ScanFpImage</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave // Slave returns the fingerprint indication to the user, and the Master displays the indication to the user. // When the valid fingerprint image is scanned successfully, Slave returns the fingerprint image. YANEN Technology. Page: 9/24

10 Master <I> (Fingerprint image data total bytes) </I> Slave Init Fingerprint Image Master <C>InitFpImage</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave // Slave returns the fingerprint indication to the user, and the Master displays the indication to the user. // After the valid fingerprint image is scanned successfully, Slave responds to the FINISHED_ string. Master <R>FINISHED<R> Slave // Upload the next segment fingerprint image data command. // first time Master <C>GetNextFpImage</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave //Slave returns fingerprint image. (Byte 0 ~ Byte 511, a total of 512 bytes) Master <I> (fingerprint image data total 512 bytes) </I> Slave // Upload the next segment fingerprint image data command. // second time Master <C>GetNextFpImage</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave //Slave returns the fingerprint image. (Byte 512 ~ Byte 1023, a total of 512 bytes) Master <I> (fingerprint image data total 512 bytes) </I> Slave // Upload the next segment fingerprint image data command. // 60th Master <C>GetNextFpImage</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave //Slave returns the fingerprint image. (Byte ~ Byte 30719, a total of 512 bytes) Master <I> (fingerprint image data total 512 bytes) </I> Slave // Upload the next segment fingerprint image data command. // 61th Master <C>GetNextFpImage</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave //Slave returns the fingerprint image. (Byte ~ Byte 30975, a total of 256 bytes) Master <I> (256 bytes of fingerprint image data) </I> Slave // Upload the next segment fingerprint image data command. // 62th Master <C>GetNextFpImage</C> Slave //Slave responds to the NG_ string because no remaining image data can be transmitted unless the scan fingerprint image command is executed again. Master <R>NG</R> Slave YANEN Technology. Page: 10/24

11 // Set transfer rate command. Master <C>Baudrate=115200</C> Slave // Slave responds to the OK_ string. Master <R>OK</R> Slave Slave will operate with the , N, 8, and 1 setting. At this point, the Master must confirm that it can support this rate. 3. Led light display instructions The LED light of the AJ155 shows the current working status. After the AJ155 is powered or reset, if the red LED and the green LED flash in turn, it means that the operation is in the connection mode. If the red LED or the green LED is blinking alone, it means that the work is in the standalone mode Connection mode After power supply or reset, if the red LED and the green LED flash in turn, it means that it is receiving the command status, and the master (Arduino or Raspberry PI) can command it to perform related functions. The LED light display shows the following. The red and green LEDs flash in turn: Indicates the status of the received command and waits for the command from the master. The red LED and the green LED are ON (light) at the same time: In the reminder state, it will enter the registration state after two or three seconds. The red LED flashes: In the registration state, waiting for the fingerprint to press to register, if you register two fingerprints, each fingerprint needs to be pressed 3 times. After each successful pressing of the fingerprint, the green LED will light for two or three seconds. The green LED flashes: In the input fingerprint state, wait for the fingerprint to press to scan the fingerprint image to compare with the registered fingerprint or upload the fingerprint image. If the fingerprint is compared, the green LED is on for two or three seconds when the comparison is successful, and the red LED is on for two or three seconds when the comparison fails. If the fingerprint image is uploaded, the red LED and the green LED alternately flash twice during image uploading. The red LED and the green LED flash twice in turn: Indicates the fingerprint image upload status. YANEN Technology. Page: 11/24

12 3.2. Standalone mode After power or reset, if the red LED or the green LED is flashing alone, it means that it is working in standalone mode. The LED lights are described as follows. The red LED and the green LED are ON (light) at the same time: In the reminder state, it will enter the registration state after two or three seconds. The red LED flashes: In the registration state, waiting for the fingerprint to press to register, if you register two fingerprints, each fingerprint needs to be pressed 3 times. After each successful pressing of the fingerprint, the green LED will light for two or three seconds. The green LED flashes: In the comparison state, waiting for the fingerprint to press and compare with the registered fingerprint. If the comparison is successful, the green LED is on for two or three seconds, and if the comparison fails, the red LED is on for two or three seconds. If the continuous comparison fails 3 times, it will enter the reminder state. 4. Operation Example Example of connection test environment in Arduino, Raspberry Pi and PC as follow Connection to Arduino Example operation based on Arduino UNO Hardware Installation The cable line connection between AJ155 and Arduino UNO is as follows. YANEN Technology. Page: 12/24

13 Arduino AJ155 Cable color: Red 3.3V Vcc Cable color: Black GND GND Cable color: Blue GPIO10 RX Cable color: Green GPIO9 TX Arduino Source Code The source code please refer to Fingerprint_Demo.ino file Arduino Command After executing Fingerprint_Demo.ino in the Arduino IDE, the following items will appear on the screen. ================================== 1. Register Fingerprint 2. Compare Fingerprint 3. Query Fingerprint Image Information 4. Scan Fingerprint Image 5. Check Registered Fingerprint Number ================================== 1) Register Fingerprint: Register fingerprint (enter number 1), the user must register two fingerprints in the fingerprint sensing area, and each fingerprint registration must be pressed 3 times. (When each press is successful, the light will turn green.). After successful execution, the response is as follows: YANEN Technology. Page: 13/24

14 2) Compare Fingerprint: Register fingerprint (enter number 2), When the user presses the fingerprint in the fingerprint sensing area, the matching error or the correct message will be displayed. After successful execution, the response is as follows: YANEN Technology. Page: 14/24

15 Comparison error (error fingerprint) <R>OK</R> Please input fingerprint to compare. Unmatched! <R>FAIL</R> or Correct (correct fingerprint) <R>OK</R> Please input fingerprint to compare. Matched! <R>PASS</R> 3) Query Fingerprint Image Information: Register fingerprint (enter number 3),,After successful execution, the response is as follows: 4) Scan Fingerprint Image: Register fingerprint (enter number 4), The user must press the fingerprint in the fingerprint sensing area After successful execution, the response is as follows. YANEN Technology. Page: 15/24

16 (Note: Most of the built-in SRAM in Arduino is less than Bits (30KBytes), so all image data cannot be displayed. Users should confirm the hardware specifications used.) 5) Check Registered Fingerprint Number: Register fingerprint (enter number 5), Slave responds with <R> and </R> to encapsulate the number, for example: <R>0<R> Indicates no registration data. <R>2<R> Indicates that there are 2 registration data. YANEN Technology. Page: 16/24

17 4.2. Connection to Raspberry Pi Example operation based on Raspberry Pi 3 B Hardware Installation The cable line connection between AJ155 and Raspberry Pi is as follows. Raspberry Pi AJ155 Cable color: Red 3.3V Vcc Cable color: Black GND GND Cable color: Blue GPIO14 RX Cable color: Green GPIO15 TX Raspberry Pi Source Code Test version: Python The source code please refer to Fingerprint_Demo.py file Raspberry Pi Command After executing Fingerprint_Demo.py in the Python environment, the following items will appear on the screen. ================= 1. Register Fingerprint 2. Compare Fingerprint 3. Query Fingerprint Image Information YANEN Technology. Page: 17/24

18 4. Scan Fingerprint Image 5. Check Registered Fingerprint Number 0. End Please enter the function code: ================= 1) Register Fingerprint: Register fingerprint (enter number 1), the user must register two fingerprints in the fingerprint sensing area, and each fingerprint registration must be pressed 3 times. (When each press is successful, the light will turn green.). After successful execution, the response is as follows: <R>OK</R> Fingerprint registration state. Input fingerprint #1 for capture #1. Move finger away from sensor. Input fingerprint #1 for capture #2. Move finger away from sensor. Input fingerprint #1 for capture #3. Move finger away from sensor. Input fingerprint #2 for capture #1. Move finger away from sensor. Input fingerprint #2 for capture #2. Move finger away from sensor. Input fingerprint #2 for capture #3. Move finger away from sensor. <R>FINISHED</R> Registration is complete 2) Compare Fingerprint: Register fingerprint (enter number 2), When the user presses the fingerprint in the fingerprint sensing area, the matching error or the correct message will be displayed. After successful execution, the response is as follows: Comparison error (error fingerprint) <R>OK</R> Please input fingerprint to compare. Unmatched! <R>FAIL</R> or Correct (correct fingerprint) <R>OK</R> Please input fingerprint to compare. YANEN Technology. Page: 18/24

19 Matched! <R>PASS</R> 3) Query Fingerprint Image Information: Register fingerprint (enter number 3),,After successful execution, the response is as follows: <R>W=176, H=176</R> 4) Scan Fingerprint Image: Register fingerprint (enter number 4), The user must press the fingerprint in the fingerprint sensing area After successful execution, the response is as follows. Please input fingerprint to scan. Receiving data Total Bytes=30983 Data reception completed Please enter the storage path and file name, such as /home/pi/finger/image1.pgm, and the fingerprint image will be stored in the specified path. 5) Check Registered Fingerprint Number: Register fingerprint (enter number 5), Slave responds with <R> and </R> to encapsulate the number, for example: <R>0<R> Indicates no registration data. <R>2<R> Indicates that there are 2 registration data Connection to PC side Note: In this test case, the user needs to have a USB to UART (or USB to TTL) line Hardware installation Connect the USB to UART (or USB to TTL) cable to the AJ155 and PC. When the USB to UART cable is connected to the AJ155, the TX/RX pin of the AJ155 needs to be exchanged. AJ155 PC side (USB to UART line) Description VCC (3.3V) VCC (3.3V) Powered by USB. TX RX Exchange docking RX TX Exchange docking GND GND -- After power supply, the AJ155 LED will flash in turn. For the LED display in the connected mode, please refer to the section: Led light display instructions. YANEN Technology. Page: 19/24

20 Tool installation The executable file name is BNCom.exe Tool operation instruction First confirm that the hardware connection is OK and the power is supplied. The red LED and the green LED will flash in turn, indicating that the command status is being received. At this time, the BNCom is started, and the command can be executed by the Master (BNCom) to perform related functions. (If other software has occupied the COM port, you must first close the software.) 1) COM port Setting When the USB to UART cable is connected to the PC, Windows will generate a virtual COM port. Please make sure to select the COM port, otherwise the communication with the AJ155 will not work properly. 2) Baudrate Setting YANEN Technology. Page: 20/24

21 This is the speed of setting BNCom. The baudrate of BNCom and AJ155 must be the same, otherwise it will not be able to communicate. The AJ155 default value is 9600, but may change to other values after the command is changed, so you may have to test the current baudrate first. You can select 9600, N, 8, 1 and then press the reset button to check if you can see the following message. If you set 9600 and can't see the correct message, you can switch to other speeds one by one, and then press the reset button of AJ155 until you can see the boot message correctly. At the bottom left of the screen, you can see the currently set speed. At the bottom right, you can see that the currently set COM port display setting is OK. 3) Command execution YANEN Technology. Page: 21/24

22 Select the command to execute. When the selected command is executed, if you want to execute the next command again, you must wait for the previous command to end Command Set // Command string:fpimageinformation Query Fingerprint Image Information: Currently, it will respond to <R>W=176, H=176</R>, indicating that the fingerprint image size is an 8-bit grayscale image and its image width is 176 pixels, and the image height is also 176 pixels. // Command string:checkregisteredno Check Registered Fingerprint Number: Currently, it will respond to <R>0</R>, <R>1</R> or <R>2</R>, indicating that the number of fingerprints that have been registered is 0, 1, or 2. // Command string:registerfingerprint Register fingerprint: If there is already a registered fingerprint, it will be cleared first. In total, the user will register 2 fingerprints in succession. Each fingerprint must be pressed 3 times. Please follow the message displayed on the screen. // Command string:comparefingerprint Compare Fingerprint: Compare with the registered fingerprint. If there is no registered fingerprint, AJ155 will respond to <R>NG</R>. If there is already registered fingerprint, it will respond to pressing the fingerprint message. Please press the fingerprint according to the instructions. If the comparison fails, it will respond to <R>FAIL</R>. If the comparison is successful, it will respond as follows: <R>PASS_0</R> Indicates that the comparison with the first registered fingerprint is successful. or <R>PASS_1</R> Indicates that the comparison with the second registered fingerprint is successful. YANEN Technology. Page: 22/24

23 // Command string:scanimage Scan fingerprint image: Please press the fingerprint according to the instructions. After the test is successful, the image will be transmitted to the PC. During the transmission, the red and green LEDs will flash twice. After the image upload is completed, you will see the following screen: The uploaded fingerprint image will be stored in the same data as BNCom. The file name is fixed to FpImage.pgm. You can view the fingerprint by using the software (CxImage/InfraView, etc.) that can view the format. Note:When the red and green lights on the AJ155 board flash once, but the upload end screen cannot be displayed, the reason is that the AJ155 will upload the image data according to the set speed (baudrate), and the USB to UART used (or USB to TTL) line will lose data due to too fast speed, please reduce the speed and then scan the image. For example, you can execute the BPS 9600 command, and then reduce the baudrate speed to 9600, and then execute the ScanImage command. YANEN Technology. Page: 23/24

24 FpImage.pgm uses the CxImage software to open the file as above. BPS 9600 BPS BPS BPS BPS The above BPS commands are used to change the baudrate speed of the AJ155. After the AJ155 responds to <R>OK</R>, it will immediately switch to the new baudrate speed. At this time, be sure to set the BNBCom baudrate speed to the same value. Otherwise, Communication with the AJ155 will not be successful due to the speed of the two sides. YANEN Technology. Page: 24/24