Serial Comm Guide
Uploaded by
Adeel AhmedSerial Comm Guide
Uploaded by
Adeel AhmedSerial Protocol
Serial Protocol
NITGEN ®
RS-232C serial protocol for Stand-Alone Fingerprint Recognition Device
Protocol Guide
(Supported device: FIM40 Ver. 1.00,
FIM50 Ver 1.08)
Version 2.01
NITGEN ____________________________________________________________ Pages 1
Serial Protocol
Serial Protocol
© Copyright 2011 NITGEN Co., Ltd.
ALL RIGHTS RESERVED
Serial Number:
Specifications can be changed without notice.
NITGEN ____________________________________________________________ Pages 2
Serial Protocol
Serial Protocol
Revision Information
Date Version Description
2010-05-03 2.0 Release
Change Command
CMD_DELETE_ALL_FP
Add New Command
2010-12-10 2.01 CMD_CTL_IO
CMD_CFG_IO
Add New Chapter
Appendix F
NITGEN ____________________________________________________________ Pages 3
Serial Protocol
Serial Protocol
Contents
1. GENERAL DESCRIPTION .................................................................................................................. 7
2. PACKET DESCRIPTION ..................................................................................................................... 8
■ PACKET STRUCTURE............................................................................................................................. 8
■ ERROR CODE........................................................................................................................................ 9
■ HOW TO MAKE THE HEADER CHECKSUM & THE DATA CHECKSUM...................................................... 9
3 COMMAND DESCRIPTION .............................................................................................................. 10
● INITIALIZATION .................................................................................................................................. 10
CMD_REQUEST_CONNECTION................................................................................................. 10
CMD_SET_BAUDRATE ................................................................................................................. 11
CMD_GET_FIRMWARE_VERSION2 .......................................................................................... 12
CMD_GET_DEVICE_INFO ............................................................................................................ 13
● MATCHING ..................................................................................................................................... 14
CMD_VERIFY_FP ........................................................................................................................... 14
CMD_IDENTIFY_FP ....................................................................................................................... 16
CMD_IDENTIFY_RID_FP .............................................................................................................. 18
CMD_INSTANT_MATCHING ......................................................................................................... 20
CMD_GET_TEMPLATE.................................................................................................................. 21
CMD_CANCEL ................................................................................................................................ 22
CMD_INSTANT_VERIFY ............................................................................................................... 23
CMD_INSTANT_IDENTIFY ............................................................................................................ 24
CMD_AUTO_IDENTIFY ................................................................................................................. 26
CMD_AUTO_IDENTIFY_RESULT ................................................................................................ 27
● DATABASE MANAGEMENT ........................................................................................................ 28
CMD_DELETE_FP .......................................................................................................................... 28
CMD_DELETE_ALL_FP................................................................................................................. 29
CMD_SET_MASTER ...................................................................................................................... 30
NITGEN ____________________________________________________________ Pages 4
Serial Protocol
Serial Protocol
CMD_LEAVE_MASTER_MODE ................................................................................................... 31
CMD_SET_MASTER_PASSWORD ............................................................................................. 32
CMD_READ_USER_DATA ............................................................................................................ 33
CMD_WRITE_USER_DATA .......................................................................................................... 34
CMD_ERASE_USER_DATA_BLOCK .......................................................................................... 35
CMD_DELETE_MASTER_PASSWORD ..................................................................................... 36
CMD_ENTER_MASTER_MODE2 ................................................................................................ 37
CMD_GET_FP_LIST2 .................................................................................................................... 39
CMD_GET_MASTER_LIST2 ......................................................................................................... 40
CMD_READ_LOG_DATA2............................................................................................................. 41
CMD_REGISTER_FP ..................................................................................................................... 42
CMD_CHANGE_FP ........................................................................................................................ 44
CMD_ADD_FP ................................................................................................................................. 46
CMD_GET_FP ................................................................................................................................. 48
CMD_DELETE_ALL_LOG ............................................................................................................. 51
CMD_REGISTER_MULTI_FP ....................................................................................................... 52
● CONFIGURATION .......................................................................................................................... 54
CMD_SET_OPP_OPTION ............................................................................................................. 54
CMD_GET_OPP_OPTION ............................................................................................................ 55
CMD_SET_SECURITY_LEVEL .................................................................................................... 56
CMD_GET_SECURITY_LEVEL .................................................................................................... 57
CMD_SET_CAPTURE_OPTION .................................................................................................. 58
CMD_GET_CAPTURE_OPTION .................................................................................................. 59
CMD_SET_LOG_OPTION ............................................................................................................. 60
CMD_GET_LOG_OPTION ............................................................................................................ 61
CMD_SET_CAPTURE_PERIOD .................................................................................................. 62
CMD_GET_CAPTURE_PERIOD .................................................................................................. 63
CMD_SET_SYSINFO ..................................................................................................................... 64
CMD_GET_SYSINFO ..................................................................................................................... 65
CMD_SAVE_SYSINFO ................................................................................................................... 66
CMD_CHG_NUM_OF_TEMP........................................................................................................ 67
CMD_SET_DEFAULT_SYSINFO.................................................................................................. 68
CMD_CHG_EMULMODE ............................................................................................................... 69
NITGEN ____________________________________________________________ Pages 5
Serial Protocol
Serial Protocol
CMD_CHG_LENGTH_OF_USERID............................................................................................. 70
● SYSTEM MANAGEMENT ............................................................................................................. 71
CMD_STATUS_CHECK ................................................................................................................. 71
CMD_GET_FP_IMAGE2 ................................................................................................................ 72
CMD_UPGRADE_FIRMWARE2 ................................................................................................... 73
CMD_SET_TIME ............................................................................................................................. 74
CMD_GET_TIME ............................................................................................................................. 75
CMD_CTL_IO ................................................................................................................................... 76
CMD_GET_IMAGE_QUALITY ...................................................................................................... 77
CMD_CFG_IO................................................................................................................................... 78
APPENDIX A. LOG DATA BLOCK ...................................................................................................... 79
■ LOG DATA FORMAT ............................................................................................................................ 79
APPENDIX B. EMULATION MODE COMMAND TABLE............................................................... 83
■ FIM20 EMULATION COMMAND .......................................................................................................... 83
■ FIM30 EMULATION COMMAND .......................................................................................................... 85
APPENDIX C. PACKET RESULT LIST ............................................................................................... 87
APPENDIX D. DATA STURCTURE ..................................................................................................... 91
APPENDIX E. EXAMPLES .................................................................................................................. 102
1. REQUEST CONNECTION ..................................................................................................................... 102
2. USER ENROLLMENT........................................................................................................................... 103
3. USER DELETION ................................................................................................................................ 113
4. AUTHENTICATION .............................................................................................................................. 114
APPENDIX F. PROGRAMMABLE GPIO .......................................................................................... 119
APPENDIX G. THE EXAPMLE OF FIRMWARE UPGRADE ........................................................ 122
APPENDIX H. SUPPORT INFORMATION....................................................................................... 123
NITGEN ____________________________________________________________ Pages 6
Serial Protocol
Serial Protocol
1. GENERAL DESCRIPTION
NITGEN FIM modules are independent fingerprint identification devices processing commands
through UART interface. They receive command from host, run function and return result of
command. Host can control FIM modules and check the result by using command.
Command is sent and received by packet structure. This packet consists of communication start
byte, command code, parameters, data size and auxiliary data. In packet, checksum is added
for
This document describes packet structure and command code for FIM modules.
NITGEN ____________________________________________________________ Pages 7
Serial Protocol
Serial Protocol
2. PACKET DESCRIPTION
■ Packet Structure
The following figure shows the organization of a packet. The packet consists of start byte,
header, data (optional), and data checksum (optional). Data and data checksum block is sent
only if needed.
P A C K E T S T RU C T U RE
Data
Header Data*
Check Sum*
24 Data Size 4
PAC KET H EAD ER
Start
Error Header
Byte Command Param1 Param2 Data Size
Code Checksum
*
1 4 4 4 4 4 4
* If data size is zero, then data and data check sum is not used.
* Start byte: 0x7E
The maximum size of a packet is 64Kbyte.
Size (Start Byte) + Size (Header) + Size (Data) + Size (Data Checksum) 65,536
If data size is so large that the host/device cannot carry data in a single packet, the host/device
divides data into small data blocks and sends them over several subsequent packets. And the
packet index has the value from 0 to 255. The maximum data size that can be sent is calculated
as the following.
Max Data block = 256 x 65,507 = 16,769,792 [byte]
Packet index is transferred by the parameter of the header. The following explains the format of
packet index.
(Packet index (0~N) << 8) + (Max Packet Index N)
For example, if single packet is sent, packet index is 0x0000.
If two packets are sent, the first packet index is 0x0001, and the second packet index is 0x0101.
NITGEN ____________________________________________________________ Pages 8
Serial Protocol
Serial Protocol
If three packets are sent, packet indexes are sequentially 0x0002, 0x0102, and 0x0202.
Warning: The total data size of multiple packets is dependent on the target devices.
The multi-packet is executed after last packet is transferred.
■ Error Code
If the host sends the command packet, the device returns the acknowledge packet with the
packet error code. If Error code is not “ERR_NONE”, the previously sent command packet is
ignored in the device. The host needs to check the returned error code, and then retry or does
something.
ERROR CODE LIST
ERR_NONE The command packet successfully executed 0x0
ERR_CHECKSUM_ERROR There exists checksum error in header or data block. 0x2
ERR_INVALID_CMD The command sent to the device is invalid. 0x5
■ How to Make the Header Checksum & the Data Checksum
Checksum data can be calculated by adding all byte data.
For example, in order to create the header checksum, 20 bytes from start byte to error code are
added.
NITGEN ____________________________________________________________ Pages 9
Serial Protocol
Serial Protocol
3 COMMAND DESCRIPTION
This capture describes communication commands.
● Initialization
CMD_REQUEST_CONNECTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x01 Command 0x01
Param1 0 Param1 RESULT_SUCCEEDED
Param2 0 Param2 User Count
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is easy and simple command for testing device operation and get information
about the number of user.
NITGEN ____________________________________________________________ Pages 10
Serial Protocol
Serial Protocol
CMD_SET_BAUDRATE
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x02 Command 0x02
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_CANCELED
Param2 Baud rate (0 ~ 4) Param2 Baud rate (0 ~ 4)
0 – 115,200 bps 0 – 115,200 bps
1 – 57,600 bps 1 – 57,600 bps
2 – 38,400 bps 2 – 38,400 bps
3 – 19,200 bps 3 – 19,200 bps
4 – 9,600 bps 4 – 9,600 bps
5 – 14,400 bps 5 – 14,,400 bps
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only supported in FIM30 emulation mode.
This command changes the baudrate of module UART interface channel and save the speed.
If succeeded, the device returns acknowledge packet and changes baudate to new speed.
New baud rate is applied from the next packet.
NITGEN ____________________________________________________________ Pages 11
Serial Protocol
Serial Protocol
CMD_GET_FIRMWARE_VERSION2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x04 Command 0x04
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_CANCELED
Param2 0 Param2 Version Information
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command requests the version of firmware in FIM modules.
The version information is BCD code and has the following format.
Data: 0x0000aabb
Version: [Link]
NITGEN ____________________________________________________________ Pages 12
Serial Protocol
Serial Protocol
CMD_GET_DEVICE_INFO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x05 Command 0x05
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_CANCELED
Param2 0 Param2 Device Name
Refer to the following Device type
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
Device Type of acknowledge packet
0x5060 – FIM5060 module
0x5360 – FIM5360
0x5110 – FIM5110
0x5120 – FIM5120
Legacy Device type
0x00 – Reserved for old device
0x01 – Reserved for old device
0x02 – FIM10_HV (EOL)
0x03 – FIM10_LV (EOL)
0x04 – FIM01_HV (EOL)
0x13 – FIM1030 (EOL)
0x33 – FIM2030
0x34 – FIM2040
0x3030 – FIM3030
0x3040 – FIM3040
0x3200 – FIM3200
NITGEN ____________________________________________________________ Pages 13
Serial Protocol
Serial Protocol
● MATCHING
CMD_VERIFY_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x11 Command 0x11
Param11) 0 – FP verification Param1 RESULT_SUCCEEDED
1 – Password RESULT_FAILED
RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_INVALID_ID
RESULT_INVALID_PARAM
RESULT_NOT_IN_TIME
RESULT_CANCELED
RESULT_EXTRACT_FAIL
Param2 (Packet Index (0~N) << 8) Param2 IF (Param1 == Succeeded)
+ (Max Packet Index N) IF (Command Param1 = 0)
Template Index Number
ELSE
ELSE
Data Size IF FP verification Data Size 0
Size (a fraction of FPID)
ELSE IF password
Size (a fraction of FPID + password)
ELSE
Error Code X Error Code Error Code
Data IF (Param1 == 0) Data -
A fraction of FPID
ELSE IF (Param1 == 1)
A fraction of FPID + password
ELSE
NITGEN ____________________________________________________________ Pages 14
Serial Protocol
Serial Protocol
-
This command is used to verify user with user‟s ID.
Verification means finding user with user‟s ID, what we called, 1:1 matching.
There are two methods for verification – fingerprint and password.
According to methods, data has different structure. For fingerprint verification, user‟s ID is sent
and for password verification, user‟s ID and password are sent in data.
NITGEN ____________________________________________________________ Pages 15
Serial Protocol
Serial Protocol
CMD_IDENTIFY_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x12 Command 0x12
Param1 0x00 – User ID only request Param1 RESULT_SUCCEEDED
0x01 – User ID and Template index RESULT_FAILED
request RESULT_INVALID_PARAM
0x02 – User ID and user type request RESULT_NOT_IN_TIME
RESULT_IDENTIFY_TIMEOUT (FIM01 &
FIM20xx only)
RESULT_CANCELED
RESULT_EXTRACT_FAIL
Param2 0 Param2 (Packet Index (0~N) << 8)
+ (Max Packet Index N)
Data Size 0 Data Size IF (Param1 == Succeeded)
IF (Command Param1 = 0x00)
Size of FPID (various between devices)
ELSE IF (Command Param1 = 0x01)
Size of (FPID + Template Index)
ELSE IF (Command Param1 = 0x02)
Size of(FPID + User Type)
ELSE
ELSE
Error Code 0 Error Code Error Code
Data - Data IF (Param1 == Succeeded)
IF (Command Param1 = 0)
FPID
ELSE IF (Command Param1 = 1)
(FPID + Template Index)
ELSE
ELSE
NITGEN ____________________________________________________________ Pages 16
Serial Protocol
Serial Protocol
0
This command is used to identify user.
Identification means finding user with unknown ID, what we called, 1:N matching.
If device find user ID having matched fingerprint, it returns user‟s ID.
According to the Param1 of command packet, auxiliary information such as template index or
user type is also returned.
In 1 ID multi-template mode, User can be registered with a number of different finger in 1 ID.
Template index shows which template is matched in ID.
User type is user‟s privilege such as normal user or master user.
NITGEN ____________________________________________________________ Pages 17
Serial Protocol
Serial Protocol
CMD_IDENTIFY_RID_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x13 Command 0x13
Param1 0x00 - User ID only request Param1 RESULT_SUCCEEDED
0x01 - User ID and Template index RESULT_FAILED
Request RESULT_INVALID_PARAM
0x02 – User ID and User Type request RESULT_NOT_IN_TIME
RESULT_IDENTIFY_TIMEOUT (FIM01 &
FIM20xx only)
RESULT_CANCELED
Param2 (Packet Index (0~N) << 8) Param2 (Packet Index (0~N) << 8)
+ (Max Packet Index N) + (Max Packet Index N)
Data Size Size (FPID) Data Size IF (Param1 == Succeeded)
IF (Command Param1 == 0x00)
Size of FPID
ELSE IF(Command Param1 == 0x01)
Size of (FPID + Template Index)
ELSE IF(Command Param1 == 0x02)
Size of (FPID + User Type)
ELSE
ELSE
Error Code 0 Error Code Error Code
Data A fraction of FPID Data IF (Param1 == Succeeded)
IF (Command Param1 == 0x00 )
FPID
ELSE IF (Command Param1 == 0x01)
(FPID + Template Index)
ELSE IF (Command Param1 == 0x02)
(FPID + User Type)
ELSE
NITGEN ____________________________________________________________ Pages 18
Serial Protocol
Serial Protocol
0
ELSE
This command is only supported in FIM40/50 and FIM20 emulation mode.
This command is used to identify user with limited user‟s ID. It provides more information about
user‟s ID and narrows the range of search. That results in fast response time.
If device find user ID having matched fingerprint, it returns user‟s ID.
According to the Param1 of command packet, auxiliary information such as template index or
user type is also returned.
In 1 ID multi-template mode, User can be registered with a number of different finger in 1 ID.
Template index shows which template is matched in ID.
User type is user‟s privilege such as normal user or master user.
When you want to reduced ID matching, you must send ID having „*‟ (0x2A) that matching one
unknown digit.
For example, If you want to identify with ID starting with “12” and ID requires 4 digits, you must
send reduced ID such as “12**”.
NITGEN ____________________________________________________________ Pages 19
Serial Protocol
Serial Protocol
CMD_INSTANT_MATCHING
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x15 Command 0x15
Param1 (Template Mode << 8) + Aux Info Param1 RESULT_SUCCEEDED
Template Mode RESULT_FAILED
0 - single template RESULT_INVALID_DATASIZE
1 - Multi Template RESULT_INVALID_DATA
(FIM30 emulation mode Only) RESULT_NOT_IN_TIME
Aux Info (FIM30 emulation mode only) RESULT_INVALID_PARAM
In Template Mode == 0 (single-template) RESULT_TOO_LARGE_DATA
0 – Nitgen template RESULT_CANCELED
1 - FDA01 compatible style RESULT_EXTRACT_FAIL
2 – ISO 19794-2 template
3 – ANSI 378 template
In Template Mode == 1 (Multi-template)
1~10 – the number of templates
(NITGEN Format Only)
Param2 (Packet Index (0~N) << 8) Param2 0
+ (Max Packet Index N)
Data Size Size (A fraction of TEMPLATE_INFO) Data Size 0
Error Code 0 Error Code Error Code
Data A fraction of TEMPLATE_INFO Data -
The template of FIM40/50 and FIM20 include format information of template in itself.
By using this command, host can verify fingerprint with template data saved in host.
The template data can be obtained form CMD_GET_TEMPLATE command.
NITGEN ____________________________________________________________ Pages 20
Serial Protocol
Serial Protocol
CMD_GET_TEMPLATE
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x16 Command 0x16
Param1 0 - Default Param1 RESULT_SUCCEEDED
2 – ISO 19794-2 Format RESULT_FAILELD
3 – ANSI 378 Format RESULT_NOT_IN_TIME
RESULT_CANCELED
RESULT_EXTRACT_FAIL
Param2 0 Param2 (Packet Index (0~N) << 8)
+ (Max Packet Index N)
Data Size 0 Data Size IF (Param1 == Succeeded)
Size (A fraction of TEPLATE_INFO)
ELSE
Error Code 0 Error Code Error Code
Data - Data IF (Param1 == Succeeded)
A fraction of TEMPLATE_INFO
ELSE
The structure of TEMPLATE_INFO is explained in Appendix D.
This command returns template data of fingerprint. According to Param1 of command packet,
ISO or ANSI format can be returned.
Template data is used for CMD_INSTANT_MATCHING.
NITGEN ____________________________________________________________ Pages 21
Serial Protocol
Serial Protocol
CMD_CANCEL
COMMAND PACKET ACKNOWLEDGEMENT PACKET1)
Command 0x17 Command 0x17
Param1 0 Param1 RESULT_IDLE_STATUS
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error Code
If the device received the CMD_CANCEL command packet in idle, the device returns the
CMD_CANCEL acknowledge packet with RETURN_CANCLE in paramter1. Otherwise, it stops
the currently executing command and returns acknowledge packet with RESULT_CANCLEDED.
NITGEN ____________________________________________________________ Pages 22
Serial Protocol
Serial Protocol
CMD_INSTANT_VERIFY
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x18 Command 0x18
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_NOT_IN_TIME
RESULT_INVALID_PARAM
RESULT_INVALID_ID
RESULT_TOO_LARGE_DATA
RESULT_CANCELED
Param2 (Packet Index (0~N) << 8) Param2 IF (Param1 == Succeeded)
+ (Max Packet Index N) Template Index Number
ELSE
Data Size Size (A fraction of FPID + Template) Data Size 0
Error Code 0 Error Code Error Code
Data A fraction of FPID + Template Data -
The structure of data is explained in Appendix D.
This command is only supported in FIM40/50 and FIM20 emulation mode.
This command verifies template data using user‟s ID. It is similar to verification except that
template data form host instead of sensor.
NITGEN ____________________________________________________________ Pages 23
Serial Protocol
Serial Protocol
CMD_INSTANT_IDENTIFY
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x19 Command 0x19
Param1 0 – User ID only request Param1 RESULT_SUCCEEDED
1 – User ID and Template index request RESULT_FAILED
(FIM40/50 & FIM20 emulation only) RESULT_INVALID_DATASIZE
2 –User ID and User Type request RESULT_INVALID_DATA
(FIM 40/50 only) RESULT_NOT_IN_TIME
RESULT_IDENTIFY_TIMEOUT
RESULT_INVALID_PARAM
RESULT_TOO_LARGE_DATA
RESULT_CANCELED
Param2 (Packet Index (0~N) << 8) Param2 X
+ (Max Packet Index N)
Data Size Size (A fraction of Template) Data Size IF (Param1 == Succeeded)
IF (Command Param1 = 0)
Size of FPID (various between devices)
ELSE IF (Command Param1 = 1)
Size of (FPID + Template Index)
ELSE
ELSE
Error Code 0 Error Code Error Code
Data A fraction of Template Data IF (Param1 == Succeeded)
IF (Command Param1 = 0)
FPID
ELSE IF (Command Param1 = 1)
(FPID + Template Index)
ELSE
ELSE
NITGEN ____________________________________________________________ Pages 24
Serial Protocol
Serial Protocol
The structure of data is explained in Appendix D.
This command is only supported in FIM40/50 and FIM20 emulation mode.
This command identifies template data. It is similar to verification except that template data form
host instead of sensor.
NITGEN ____________________________________________________________ Pages 25
Serial Protocol
Serial Protocol
CMD_AUTO_IDENTIFY
COMMAND PACKET ACKNOWLEDGEMENT PACKET1)
Command 0x1A Command 0x1A
Param1 Selection of Operation Param1 RESULT_SUCCEEDED
0x00 – Stop Auto Identification RESULT_FAILED
0x01 – Start Auto Identification RESULT_INVALID_PARAM
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error Code
By using this command, you can change the mode of module to auto-identify mode.
In auto-identify mode, if user places finger on sensor, module returns result
CMD_AUTO_IDENTIFY_RSULT acknowledge packet. And module ignores other command
except CMD_AUTO_IDENTIFY.
NITGEN ____________________________________________________________ Pages 26
Serial Protocol
Serial Protocol
CMD_AUTO_IDENTIFY_RESULT
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command Command 0x1B
Param1 Param1 RESULT_SUCCEEDED
RESULT_FAILED
Param2 Param2 0
Data Size Data Size IF (Param1 == Succeeded)
Size of FPID (various between devices)
ELSE
Error Code Error Code Error Code
Data Data IF (Param1 == Succeeded)
FPID
ELSE
This command is used only for acknowledge packet. In auto-identify mode, module returns the
result of identification using this packet.
NITGEN ____________________________________________________________ Pages 27
Serial Protocol
Serial Protocol
● DATABASE MANAGEMENT
CMD_DELETE_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x22 Command 0x22
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
REAULT_INVALID_ID
RESULT_NOT_MASTER_MODE
Param2 (Packet Index (0~N) << 8) Param2 IF (Param1 == Succeeded)
+ (Max Packet Index N) Registered User Count
ELSE
Data Size Size (A fraction of FPID) Data Size 0
Error Code 0 Error Code Error Code
Data A fraction of FPID Data -
This command is only executed in master mode.
This command deletes user. If succeeded, currently remained user count is returned in Param2.
NITGEN ____________________________________________________________ Pages 28
Serial Protocol
Serial Protocol
CMD_DELETE_ALL_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x23 Command 0x23
Param1 0x00 – Delete all user Param1 RESULT_SUCCEEDED
0x01 – Delete all user (except Master) RESULT_FAILED
0x02 – Delete all Master RESULT_INVALID_PARAM
0x03 – Format FP Area RESULT_NOT_MASTER_MODE
RESULT_CANCELED
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error Code
This command is only executed in master mode.
This command deletes users.
According to the Param1 of command packet, normal user or master users are deleted
selectively.
NITGEN ____________________________________________________________ Pages 29
Serial Protocol
Serial Protocol
CMD_SET_MASTER
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x24 Command 0x24
Param1 0 – Clear Master Flag Param1 RESULT_SUCCEEDED
1 – Set Master Flag RESULT_FAILED
RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_INVALID_PARAM
REAULT_INVALID_ID
RESULT_NOT_MASTER_MODE
RESULT_EXCEEDED_MASTER_CNT
(Packet Index (0~N) << 8)
Param2 Param2 Master Count
+ (Max Packet Index N)
Data Size Size (A fraction of FPID) Data Size 0
Error Code 0 Error Code Error Code
Data A fraction of FPID Data -
This command is only executed in master mode.
This command changes the privilege of user. Host can changes normal user to master or
reversely.
NITGEN ____________________________________________________________ Pages 30
Serial Protocol
Serial Protocol
CMD_LEAVE_MASTER_MODE
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x26 Command 0x26
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
In FIM module, there are two operating mode – normal mode and master mode.
Host can request authentication such as verification, identification and so on in normal mode.
But for changing system option and managing users, host need to enter the master operation
mode.
This command is used to leave master operation mode. To enter master operation mode, use
CMD_ENTER_MASTER_MODE2 command.
NITGEN ____________________________________________________________ Pages 31
Serial Protocol
Serial Protocol
CMD_SET_MASTER_PASSWORD
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x27 Command 0x27
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_NOT_MASTER_MODE
Param2 (Packet Index (0~N) << 8) Param2 0
+ (Max Packet Index N)
Data Size Size (A fraction of Password) Data Size 0
Error Code 0 Error Code Error code
Data A fraction of Password Data -
This command is only executed in master mode.
FIM provides board password. This board password provides another method to enter master
operating mode.
In default system, this password is empty.
NITGEN ____________________________________________________________ Pages 32
Serial Protocol
Serial Protocol
CMD_READ_USER_DATA
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x2B Command 0x2B
Param1 Address Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 User data length (byte) Param2 IF (Param1 == RESULT_SUCCEEDED)
User data length (byte)
ELSE
Data Size 0 Data Size IF (Param1 == RESULT_SUCCEEDED)
User data length (byte)
ELSE
Error Code 0 Error Code Error code
Data - Data IF (Param1 == RESULT_SUCCEEDED)
User data
ELSE
This command is only executed in master mode.
Host can read data in custom user area.
Custom user area is 64 Kbytes. The range of address is from 0x00000000 to 0x00010000.
NITGEN ____________________________________________________________ Pages 33
Serial Protocol
Serial Protocol
CMD_WRITE_USER_DATA
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x2C Command 0x2C
Param1 Address Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 User data length (byte) Param2 0
Data Size User data length Data Size 0
Error Code 0 Error Code Error code
Data User Data Data -
This command is only executed in master mode.
Custom user area is 64 Kbytes. The range of address is from 0x00000000 to 0x00010000.
NITGEN ____________________________________________________________ Pages 34
Serial Protocol
Serial Protocol
CMD_ERASE_USER_DATA_BLOCK
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x2D Command 0x2D
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command erases custom user area. The data in custom area is initialized to 0xFF.
NITGEN ____________________________________________________________ Pages 35
Serial Protocol
Serial Protocol
CMD_DELETE_MASTER_PASSWORD
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x2E Command 0x2E
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command deletes board password set by CMD_SET_MASTER_PASSWORD command.
NITGEN ____________________________________________________________ Pages 36
Serial Protocol
Serial Protocol
CMD_ENTER_MASTER_MODE2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x2F Command 0x2F
Param1 Master authentication type Param1 RESULT_SUCCEEDED
Master FP verification = 0 RESULT_FAILED
Master password verification = 1 RESULT_INVALID_DATASIZE
Board password verification = 2 RESULT_INVALID_DATA
Null = 3 RESULT_NOT_IN_TIME
Master instant FP verification = 4 RESULT_INVALID_PARAM
RESULT_INVALID_ID
RESULT_CANCELED
RESULT_EXTRACT_FAIL
Param2 (Packet Index (0~N) << 8) Param2 Master authentication type
+ (Max Packet Index N) Master FP = 0
Master password = 1
FDA board password = 2
Null = 3
Master FP from host = 4
Master FP from host (FDA01 style) = 5
(FIM10 only)
Data Size IF Master FP Data Size 0
Size (A fraction of FPID)
ELSE IF master password
Size (A fraction of FPID + Password)
ELSE IF device board password
Size (A fraction of password)
ELSE IF Master FP from host
Size (A fraction of FPID + Template)
ELSE IF null
Error Code X Error Code Error code
Data IF Master FP Data -
A fraction of FPID
NITGEN ____________________________________________________________ Pages 37
Serial Protocol
Serial Protocol
ELSE IF master password
A fraction of FPID + Password
ELSE IF device board password
A fraction of Password
ELSE IF Master FP from host
FPID + Template
ELSE IF null
This command is used to enter master operation mode.
If one of the followings is satisfied, device requires master authentication.
1. User having master privilege exists
2. Board password is not null string.
Otherwise, host can enter master mode without authentication by setting Param1 of command
packet to 3.
To enter master operation mode, host need to be authenticated. There are four methods.
1. Master user Fingerprint verification
2. Master user password verification
3. Board password verification
4. Master user instant verification
NITGEN ____________________________________________________________ Pages 38
Serial Protocol
Serial Protocol
CMD_GET_FP_LIST2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x30 Command 0x30
Param1 List data selection Param1 RESULT_SUCCEEDED
0 = User count, ID list RESULT_FAILED
1 = User count RESULT_NOT_MASTER_MODE
RESULT_INVALID_PARAM
RESULT_CANCELED
Param2 Packet Index (0~N) Param2 IF (Param1 == RESULT_SUCCEEDED)
(Packet Index (0~N) << 8)
+ (Max Packet Index N)
ELSE
Data Size 0 Data Size IF (Param1 == RESULT_SUCCEEDED)
Size of (a piece of FP list block)
ELSE
Error Code 0 Error Code Error code
Data - Data A piece of FP list block
This command is only executed in master mode.
This command is used to get user list including masters.
The user list block may be different according to devices. Before using CMD_GET_FP_LIST2
packet, check device information using CMD_GET_DEVICE_INFO
User list block consists of the number of user, the size of FPID, and user list.
If Param1 of command packet is „0‟, device returns the list of users.
If Param1 of command packet is „1‟, device returns only the number of users.
The structure of data is explained in Appendix D.
NITGEN ____________________________________________________________ Pages 39
Serial Protocol
Serial Protocol
CMD_GET_MASTER_LIST2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x31 Command 0x31
Param1 List data selection Param1 RESULT_SUCCEEDED
0 = Master count, ID list RESULT_FAILED
1 = Master count RESULT_NOT_MASTER_MODE
RESULT_INVALID_PARAM
RESULT_CANCELED
Param2 Packet index (0~N) Param2 IF (Param1 == RESULT_SUCCEEDED)
(Packet Index (0~N) << 8)
+ (Max Packet Index N)
ELSE
Data Size 0 Data Size IF (Param1 == RESULT_SUCCEEDED)
Size of (a piece of master list block)
ELSE
Error Code 0 Error Code Error code
Data - Data A piece of master list block
This command is only executed in master mode.
This command is used to get master list except normal users.
The Master list block may be different according to devices. Before using
CMD_GET_MASTER_LIST2 packet, check device information using
CMD_GET_DEVICE_INFO
Master list block consists of the number of master, the size of FPID, and master list.
If Param1 of command packet is „0‟, device returns the list of masters.
If Param1 of command packet is „1‟, device returns only the number of masters.
The structure of data is explained in Appendix D.
NITGEN ____________________________________________________________ Pages 40
Serial Protocol
Serial Protocol
CMD_READ_LOG_DATA2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x32 Command 0x32
Param1 Log request mode Param1 RESULT_SUCCEEDED
0 = Param2 previous log read RESULT_FAILED
1 = oldest unread log RESULT_NOT_MASTER_MODE
2 = last written log RESULT_INVALID_PARAM
3 = All log RESULT_CANCELED
4 = from oldest unread to last
Param2 IF Param1 == 0 Param2 IF (Param1 == RESULT_SUCCEEDED)
Nth log (Packet Index (0~N) << 8)
ELSE IF Param1 == 3 + (Max Packet Index N)
Index(0~N) ELSE
ELSE IF Param1 == 4 -
Index (0~N)
ELSE
Data Size 0 Data Size IF (Param1 == RESULT_SUCCEEDED)
Size of a piece of Log data block
ELSE
Error Code 0 Error Code Error code
Data - Data IF (Param1 == RESULT_SUCCEEDED)
Size of a piece of Log data block
ELSE
This command is only executed in master mode.
Log data block consists of the number of returned log, the size of log, and log data
The log data block may be different according to emulation modes. Before using
CMD_READ_LOG2 packet, check device information using CMD_GET_SYSINFO
NITGEN ____________________________________________________________ Pages 41
Serial Protocol
Serial Protocol
CMD_REGISTER_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x33 Command 0x33
Param1 0 – User Param1 RESULT_SUCCEEDED
1 – Master RESULT_FAILED
Otherwise – Reserved RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_NOT_IN_TIME
RESULT_INVALID_PARAM
RESULT_USED_ID
RESULT_DB_IS FULL
RESULT_NOT_MASTER_MODE
RESULT_ANOTHER_FINGER
RESULT_CANCELED
RESULT_EXTRACT_FAIL
RESULT_INVALID_SEQUENCE
Param2 Packet index Param2 IF (Param1 == RESULT_SUCCEEDED)
st
0x00 – Extract 1 Template from sensor && ( ((Packet index == 0x01 or 0x02)
with ID and password && (2 templates mode)) ||
st
0x10 – Extract 1 Template from sensor ((Packet index == 0x11 or 0x12)
with auto-generated ID && (4 templates mode)) )
nd
0x01 – Extract 2 Template from sensor Registered User Count
& Save (Only valid if succeed)
nd
0x02 – Extract 2 Template from sensor ELSE
& Save with different finger 0
(FIM20 emulation mode Only)
0x03 – Extract 3rd Template from sensor
0x04 – Extract 4th Template form sensor &
save
0x05 – Extract 4th Template from sensor &
save with different finger
Data Size IF (Packet index == 0) Data Size 0
Size of (FPID + Password)
NITGEN ____________________________________________________________ Pages 42
Serial Protocol
Serial Protocol
ELSE
Error Code 0 Error Code Error Code
Data IF (Packet index == 0) Data -
FPID + password
ELSE
This command is only executed in master mode.
User‟s privilege is set in Param1 of command packet.
The DB of user is saved only after executing command packet with Param2 value such as 0x01
or 0x02 in 2 templates mode, or 0x04 or 0x05 in 4 templates mode.
FIM provides auto-generated ID function.
Auto-generated ID is 4 digits from “0000” to “9999”. It makes ID from “0000”.
FIM provides different finger mode.
FIM requires two fingerprint images for ensuring divergence of image.
In non-different finger mode, device checks whether input fingers are same finger or not.
If not, device returns fail.
In different finger mode, device registers user without checking. Therefore, host can register
user with 2 different fingers in 2 templates mode or 4 fingers in 4 templates mode.
For registration, host process two stages in 2 templates mode.
Firstly send CMD_REGISTER_FP with 0x00 (send ID) or 0x10 (auto-generated ID) in Param2.
Secondly send CMD_REGISER_FP with 0x01 (same fingers) or 0x02 (different fingers) in
Param2.
The 4 templates mode is supported in FIM20 emulation mode.
For using FIM40/50 more efficiently, use CMD_REGISTER_MULTI_FP command instead of this
command. This command is provided for compatibility of old modules such as FIM20 and FIM30.
NITGEN ____________________________________________________________ Pages 43
Serial Protocol
Serial Protocol
CMD_CHANGE_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x34 Command 0x34
Param1 0x01 – Change Master Privilege & Save Param1 RESULT_SUCCEEDED
0x02 – Change Password & Save RESULT_FAILED
0x03 – Change User security Level & RESULT_INVALID_DATASIZE
Save RESULT_INVALID_DATA
Others – reserved RESULT_NOT_IN_TIME
RESULT_INVALID_PARAM
RESULT_INVALID_ID
RESULT_NOT_MASTER_MODE
RESULT_CANCELED
RESULT_EXTRACT_FAIL
Param2 IF (Param1 == 0x01) Param2 0
0 – set to normal user
1 – set to master
ELSE IF (Param1 == 0x03)
Security Level
ELSE
Reserved
Data Size IF (Param1 == 0x01) Data Size 0
Size of (FPID)
ELSE IF (Param2 == 0x02)
Size of (FPID + Password)
ELSE IF (Param3 == 0x03)
Size of(FPID)
ELSE
Error Code 0 Error Code Error Code
Data IF (Param1 == 0x01) Data -
FPID
ELSE IF(Param1 == 0x02)
FPID + password
NITGEN ____________________________________________________________ Pages 44
Serial Protocol
Serial Protocol
ELSE IF(Param3 == 0x03)
FPID
ELSE
This command is only executed in master mode.
The structure of data is explained in Appendix D.
This command is only supported in FIM40/50 and FIM20 emulation mode.
Host can change user‟s privilege, password and verification security level. When user is
registered, verification security is not set and system verification security level is applied. By
changing user‟s security level, host can verify user with individual security level.
NITGEN ____________________________________________________________ Pages 45
Serial Protocol
Serial Protocol
CMD_ADD_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x35 Command 0x35
Param1 DB structure version Param1 RESULT_SUCCEEDED
For FIM30 emulation mode RESULT_FAILED
0x01 - FIM_OLD_DB_FIM30 RESULT_INVALID_DATASIZE
data structure RESULT_INVALID_DATA
0x11 – FIM_DB_FIM30 data structure RESULT_INVALID_PARAM
(NITGEN, ISO 19794-2 and RESULT_USED_ID
ANSI 378) RESULT_DB_IS_FULL
For FIM40&50 and RESULT_NOT_MASTER_MODE
FIM20 emulation mode RESULT_CANCELED
0x01 – FIM_OLD_DB2 data structure RESULT_WRONG_TEMP_MODE
0x02 – FIM_OLD_DB4 data structure
0x11 – FIM_DB2 data structure
(NITGEN, ISO 19794-2 and
ANSI 378)
0x12 – FIM_DB4 data structure
(NITGEN, ISO 19794-2 and
ANSI 378)
For FIM40&50 Only
0x20 – FIM_MT_DB data structure
(NITGEN, ISO 19794-2 and
ANSI 378)
Others – reserved
Param2 (Packet index (0~N) << 8) Param2 0
+ (Max Packet Index N)
Data Size Size (a piece of DB structure) Data Size 0
Error Code 0 Error Code Error Code
Data A piece of DB structure Data -
This command is only executed in master mode.
The structure of data is explained in Appendix D.
NITGEN ____________________________________________________________ Pages 46
Serial Protocol
Serial Protocol
This command is used for adding new user‟s DB to device.
Caution is needed because different data structures are used according to emulation mode
(FIM30, FIM20 and none emulation mode) and template format (NITGEN, ISO and ANSI).
User‟s DB can be obtained by using CMD_GET_FP command.
FIM30 cannot accept DB which is made in FIM5110, FIM5120.
NITGEN ____________________________________________________________ Pages 47
Serial Protocol
Serial Protocol
CMD_GET_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x36 Command 0x36
Param1 Get operation Param1 RESULT_SUCCEEDED
0 – FPID DB RESULT_FAILED
1 – First DB RESULT_INVALID_DATASIZE
2 – Next DB RESULT_INVALID_DATA
Others – reserved RESULT_INVALID_PARAM
RESULT_INVALID_ID
RESULT_NOT_MASTER_MODE
RESULT_CANCELED
Param2 DB structure version Param2 0
For FIM30 Emulation mode
0x01 – FIM_OLD_DB_FIM30 data
Structure
0x11 – FIM_DB_FIM30 data structure
(Template: NITGEN format)
0x13 – FIM_DB_FIM30 data structure
(Template: ISO 19794-2 format)
0x15 – FIM_DB_FIM30 data structure
(Template: ANSI 378 format)
For FIM40/50 and
FIM20 Emulation Mode
0x01 – FIM_OLD_DB2 data structure
0x02 – FIM_OLD_DB4 data structure
0x11 – FIM_DB2 data structure
(Template:-NITGEN format)
0x12 – FIM_DB4 data structure
(Template:-NITGEN format)
0x13 – FIM_DB2 data structure
(Template: ISO 19794-2 format)
0x14 – FIM_DB4 data structure
(Template: ISO 19794-2 format)
NITGEN ____________________________________________________________ Pages 48
Serial Protocol
Serial Protocol
0x15 – FIM_DB2 data structure
(Template: ANSI 378 format)
0x16 – FIM_DB4 data structure
(Template: ANSI 378 format)
For FIM40&50 Only
0x20 – FIM_MT_DB data structure
(Template: NIGEN format)
0x21 – FIM_MT_DB data structure
(Template: ISO 19794-2 format)
0x22 – FIM_MT_DB data structure
(Template: ANSI 378 format)
Others – reserved
Data Size IF (Param1 == 0) Data Size IF (Param1 == RESULT_SUCCEEDED)
Size of FPID Size of DB structure
ELSE ELSE
0 0
Error Code 0 Error Code Error Code
Data IF (Param1 == 0) Data IF (Param1 == RESULT_SUCCEEDED)
FPID DB structure
ELSE ELSE
- 0
This command is only executed in master mode.
The structure of DB is explained in Appendix D.
Caution is needed because different data structures are used according to emulation mode
(FIM30, FIM20 and none emulation mode) and template format (NITGEN, ISO and ANSI).
User‟s DB can be added by using CMD_ADD_FP command.
There are two ways to get users‟ DB.
The first way is the request with user ID (Param1 == 0). Device returns user‟s DB having
matching ID. If not find, return error.
The second way is request with sequential order using Param1 of command packet.
In first request, get first DB (Param1 == 1).
NITGEN ____________________________________________________________ Pages 49
Serial Protocol
Serial Protocol
And get next DB (Param1 == 2) until error is returned.
NITGEN ____________________________________________________________ Pages 50
Serial Protocol
Serial Protocol
CMD_DELETE_ALL_LOG
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x37 Command 0x37
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
RESULT_CANCELED
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error Code
This command is only executed in master mode.
This command deletes all log data. Once deleted, there is no way to recover.
NITGEN ____________________________________________________________ Pages 51
Serial Protocol
Serial Protocol
CMD_REGISTER_MULTI_FP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x38 Command 0x38
Param1 0 – User Param1 RESULT_SUCCEEDED
1 – Master RESULT_FAILED
Otherwise – Reserved RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_NOT_IN_TIME
RESULT_INVALID_PARAM
RESULT_USED_ID
RESULT_DB_IS FULL
RESULT_NOT_MASTER_MODE
RESULT_ANOTHER_FINGER
RESULT_CANCELED
RESULT_EXTRACT_FAIL
RESULT_INVALID_SEQUENCE
Param2 Packet index Param2 IF((Param1 == RESULT_SUCCEEDED)
Refer to the following define (1) && (Capture Mode == 0x03 or 0x04))
Registered User count
ELSE
Data Size IF ( (Finger Index == 0) && Data Size 0
(Capture Mode == 0) )
Size of (FPID + Password)
ELSE
Error Code 0 Error Code Error Code
Data IF ( (Finger Index == 0) && Data -
(Capture Mode == 0) )
FPID + password
ELSE
NITGEN ____________________________________________________________ Pages 52
Serial Protocol
Serial Protocol
This command is only executed in master mode.
This command is only supported in FIM40/50.
In FIM40/50, 1 ID multi-template function is newly added. For supporting this function, this
command is added. When user is added, host can insert up to 10 fingers for one user and save.
Define (1) – Packet index
Bit
Order 31 ~ 28 27 ~ 24 23 ~ 20 19 ~ 16 15 ~ 12 11 ~ 8 7~4 3~0
Finger Capture
Index mode
Finger Index: 0x0 ~ 0x9
The index of finger
Capture Mode: 0x0 – First Capture with User ID and Password
0x1 – First Capture with Auto ID
0x2 – Second Capture and Continue
0x3 – Second Capture and Save
0x4 – Save
Auto ID is generated to 4-digits.
Packet Index Sample
Save 1 template for User with User ID and Password
0x00 -> 0x03
Save 2 templates for User with User ID and Password
0x00 -> 0x02 -> 0x10 -> 0x13
Save 1 template for User with Auto-Generated ID
0x01 -> 0x03
NITGEN ____________________________________________________________ Pages 53
Serial Protocol
Serial Protocol
● CONFIGURATION
CMD_SET_OPP_OPTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x40 Command 0x40
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 Option value Param2 Option value
bit[23..16] = gain bit[23..16] = gain
bit[15..8] = brightness bit[15..8] = brightness
bit[7..0] = contrast bit[7..0] = contrast
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
Default Value
Gain = 2
Brightness = 45
Contrast = 20
NITGEN ____________________________________________________________ Pages 54
Serial Protocol
Serial Protocol
CMD_GET_OPP_OPTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x41 Command 0x41
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 IF (Param1 == RESULT_SUCCEEDED)
Option value
bit[23..16] = gain
bit[15..8] = brightness
bit[7..0] = contrast
ELSE
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
NITGEN ____________________________________________________________ Pages 55
Serial Protocol
Serial Protocol
CMD_SET_SECURITY_LEVEL
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x42 Command 0x42
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 Verification security level Param2 Verification security level
bit[31..16] bit[31..16]
Identification security level Identification security level
Bit[15..0] Bit[15..0]
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
Default Value
Verification security level: 8
Identification security level: 5
NITGEN ____________________________________________________________ Pages 56
Serial Protocol
Serial Protocol
CMD_GET_SECURITY_LEVEL
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x43 Command 0x43
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 IF (Param1 == RESULT_SUCCEEDED)
Verification security level
bit[31..16]
Identification security level
bit[15..0]
ELSE
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
NITGEN ____________________________________________________________ Pages 57
Serial Protocol
Serial Protocol
CMD_SET_CAPTURE_OPTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x44 Command 0x44
Param1 0x00 -> Latent & Adaptive Param1 RESULT_SUCCEEDED
0x01 -> Latent RESULT_FAILED
0x02 -> Adaptive RESULT_FAILED
0x08 -> Max number of Capture in RESULT_INVALID_PARAM
Adaptive RESULT_NOT_MASTER_MODE
Param2 IF (Param1 == 0x0 or 0x01 or0x02) Param2 IF (Command Param1 == 0x00 or
Turn Off = 0 / Turn On = 1 0x01 or 0x02)
Else IF (Param1 == 0x08) Turn Off = 0 / Turn On = 1
Max number of capture in Adaptive ELSE IF (Command Param1 == 0x08)
ELSE Max number of Capture in Adaptive
- ELSE
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
The latent option does not return error, but does not used.
The range of Max Number of Capture is from 0 to 255.
NITGEN ____________________________________________________________ Pages 58
Serial Protocol
Serial Protocol
CMD_GET_CAPTURE_OPTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x45 Command 0x45
Param1 0x00 -> Reserved Param1 RESULT_SUCCEEDED
0x01 -> Latent RESULT_FAILED
0x02 -> Adaptive RESULT_NOT_MASTER_MODE
0x08 -> Max number of Capture in
Adaptive
Param2 0 Param2 IF (Param1 == RESULT_SUCCEEDED)
IF (Command Param1 == 0x00 or
0x01 or 0x02)
Turn Off = 0 / Turn On = 1
ELSE IF (Command Param1==0x08)
Max number of capture
in adaptive
ELSE
ELSE
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
The latent option does not return error, but does not used.
NITGEN ____________________________________________________________ Pages 59
Serial Protocol
Serial Protocol
CMD_SET_LOG_OPTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x48 Command 0x48
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 Disable = 0 / Enable = 1 Param2 Disable = 0 / Enable = 1
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
Default Value
Disable
NITGEN ____________________________________________________________ Pages 60
Serial Protocol
Serial Protocol
CMD_GET_LOG_OPTION
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x49 Command 0x49
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 IF (Param1 == RESULT_SUCCEEDED)
Disable = 0 / Enable = 1
ELSE
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
NITGEN ____________________________________________________________ Pages 61
Serial Protocol
Serial Protocol
CMD_SET_CAPTURE_PERIOD
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x4A Command 0x4A
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 Capture period Param2 Capture period (1 ~ 255)
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
Capture period means 100 ms tick count.
When capturing fingerprint, device try to capture until tick count reaches to capture period time.
NITGEN ____________________________________________________________ Pages 62
Serial Protocol
Serial Protocol
CMD_GET_CAPTURE_PERIOD
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x4B Command 0x4B
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 IF (Param1 == RESULT_SUCCEEDED)
Capture period (1 ~ 255)
ELSE
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is only supported in FIM30 emulation mode.
NITGEN ____________________________________________________________ Pages 63
Serial Protocol
Serial Protocol
CMD_SET_SYSINFO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x4C Command 0x4C
Param1 SI_Type Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
RESULT_DB_ISNOT_EMPTY
Param2 SI_Value Param2 0
Data Size 0 Data Size IF (Param1 == Succeeded)
Size (SI_INFO)
ELSE
Error Code 0 Error Code Error code
- IF (Param1 == Succeeded)
SI_INFO
ELSE
This command is only executed in master mode.
SI_TYPE and SI_INFO are defined in Appendix D.
Caution: Option value is changed temporary by this command. After power off, this value is
changed to the previous value. If you want to keep new option value, send
CMD_SAVE_SYSINFO command after changing option value.
NITGEN ____________________________________________________________ Pages 64
Serial Protocol
Serial Protocol
CMD_GET_SYSINFO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x4D Command 0x4D
Param1 SI_Type Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_NOT_MASTER_MODE
Param2 X Param2 SI_Value
Data Size 0 Data Size IF (Param1 == Succeeded)
Size (SI_INFO)
ELSE
Error Code X Error Code Error code
Data - Data IF (Param1 == Succeeded)
SI_INFO
ELSE
SI_TYPE and SI_INFO are defined in Appendix D.
NITGEN ____________________________________________________________ Pages 65
Serial Protocol
Serial Protocol
CMD_SAVE_SYSINFO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x4E Command 0x4E
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
This command is only executed in master mode.
This command is used to save current system option to non-volatile memory. After executing
this command, system options are restored when power-on.
NITGEN ____________________________________________________________ Pages 66
Serial Protocol
Serial Protocol
CMD_CHG_NUM_OF_TEMP
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x4F Command 0x4F
Param1 Number of Template (2 or 4) Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
RESULT_INVALID_PARAM
RESULT_DB_ISNOT_EMPTY
Param2 X Param2 X
Data Size 0 Data Size 0
Error Code X Error Code Error code
This command is only executed in master mode.
This command is supported in FIM20 emulation mode
This command is used to change template mode (2 templates or 4 templates). When executing
this command, there must be no user in device. If not, error is returned.
After executing this command, option is saved by force because non-saved option causes
problem in next power-on.
NITGEN ____________________________________________________________ Pages 67
Serial Protocol
Serial Protocol
CMD_SET_DEFAULT_SYSINFO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x50 Command 0x50
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 0
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
- -
This command is only executed in master mode.
This command changes all options to default value except the following options.
SI_NUM_OF_TEMP
SI_CHANNEL0_BAUDRATE
SI_CHANNEL1_BAUDRATE
SI_LENGTH_OF_USER_ID
SI_EMULATION_MODE
This command changes programmable GPIO configuration.
GPIO0: High Active output when succeeded. (0x81)
GPIO1: High Active output when failed. (0x83)
GPIO2: User enrollment with automatically generated ID (Low Active) (0x02)
GPIO3: User deletion by fingerprint input (Low Active) (0x04)
GPIO4: User Identification (Active) (0x06)
GPIO5: sensor capturing.(High Active) (0x85)
GPIO6: Disabled (0xFF)
GPIO7: Disabled (0xFF)
Caution) This command does not save the changed option value. So to save options, use
CMD_SAVE_SYSINFO.
NITGEN ____________________________________________________________ Pages 68
Serial Protocol
Serial Protocol
CMD_CHG_EMULMODE
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x51 Command 0x51
Param1 0x01 – FIM20 emulation mode Param1 RESULT_SUCCEEDED
0x02 – FIM30 emulation mode RESULT_FAILED
0xFF – None emulation mode RESULT_NOT_MASTER_MODE
Otherwise - Reserved
Param2 0 Param2 0x01 – FIM20 emulation mode
0x02 – FIM30 emulation mode
0xFF – None emulation mode
Otherwise - reserved
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
- -
This command is only executed in master mode.
When this command is executed, length of user ID (system option) is also changed because
FIM20 or FIM30 mode has fixed length of user ID.
After executing this command, option is saved by force because non-saved option causes
problem in next power-on
The default system mode is none-emulation mode.
NITGEN ____________________________________________________________ Pages 69
Serial Protocol
Serial Protocol
CMD_CHG_LENGTH_OF_USERID
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x52 Command 0x52
Param1 Length of User ID (4~15) Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_MASTER_MODE
Param2 0 Param2 Length of User ID
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
- -
This command is only executed in master mode.
If this system option is changed, other commands using user ID, such as CMD_VERIFY_FP,
CMD_ADD_FP, and so on, is changed to accommodate length of user ID.
After executing this command, option is saved by force because non-saved option causes
problem in next power-on
The default system mode is none-emulation mode.
NITGEN ____________________________________________________________ Pages 70
Serial Protocol
Serial Protocol
● SYSTEM MANAGEMENT
CMD_STATUS_CHECK
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x62 Command 0x62
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
Param2 0 Param2 STATUS =
IDLE (0x00)
BUSY (0x01)
: Current executed command
DB_UPLOADING (0x03)
: During power-up operation, a device
isn‟t ready to communicate
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
Data - Data -
This command is used to check the status of device.
If device is busy in processing command, it returns BUSY status.
If not, it returns IDLE status.
DB_UPLOADING status is returned when device is uploading user‟s DB in boot-up.
NITGEN ____________________________________________________________ Pages 71
Serial Protocol
Serial Protocol
CMD_GET_FP_IMAGE2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x63 Command 0x63
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_NOT_IN_TIME
RESULT_CANCELED
Param2 Packet index (0~N) Param2 IF (Param1 == RESULT_SUCCEEDED)
(Packet Index (0~N) << 8)
+ (Max Packet Index N)
ELSE
Data Size 0 Data Size IF (Param1 == RESULT_SUCCEEDED)
Size of (a piece of image data block)
ELSE
Error Code 0 Error Code Error code
Data - Data IF (Param1 == RESULT_SUCCEEDED)
A piece of image data block
ELSE
This command is used to get fingerprint image.
NITGEN ____________________________________________________________ Pages 72
Serial Protocol
Serial Protocol
CMD_UPGRADE_FIRMWARE2
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x64 Command 0x64
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_PARAM
RESULT_CANCELED
Param2 (Packet Index (0~N) << 8) Param2 Command packet param2 value
+ (Max Packet Index N-1)
Data Size Size of (a fragment of Firmware data Data Size 0
block)
Error Code 0 Error Code Error code
Data Firmware data block Data -
Each firmware data block consists of the total size of firmware and a portion of firmware data.
(Refer to Appendix D)
There need a caution .If wrong data is written to device, device can be out of order. This
damage cannot be fixed in user.
NITGEN ____________________________________________________________ Pages 73
Serial Protocol
Serial Protocol
CMD_SET_TIME
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x65 Command 0x65
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_INVALID_DATASIZE
RESULT_INVALID_DATA
RESULT_CANCELED
Param2 0 Param2 0
Data Size Size of TIME_INFO Data Size 0
Error Code 0 Error Code Error code
Data TIME_INFO Data -
TIME_INFO data structure is defined in Appendix D
This command is used to set device RTC (real time clock).
NITGEN ____________________________________________________________ Pages 74
Serial Protocol
Serial Protocol
CMD_GET_TIME
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x66 Command 0x66
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
RESULT_CANCELED
Param2 0 Param2 0
Data Size 0 Data Size IF (Param1 == RESULT_SUCCEEDED)
Size of TIME_INFO
ELSE
Error Code 0 Error Code Error code
Data - Data IF (Param1 == RESULT_SUCCEEDED)
TIME_INFO
ELSE
TIME_INFO data structure is defined in Appendix D
This command is used to set device RTC (real time clock).
NITGEN ____________________________________________________________ Pages 75
Serial Protocol
Serial Protocol
CMD_CTL_IO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x67 Command 0x67
Param1 For FIM40&50 Param1 RESULT_SUCCEEDED
0x00 ~ 0x07 – Selection of GPIO (0~7) RESULT_FAILED
0x10 – Sensor LED (Write only) RESULT_INVALID_PARAM
RESULT_CANCELED
For FIM20 emulation mode and FIM30
emulation mode
0x01 – Sensor LED
0x40 – Relay Channel 0
0x41 – Relay Channel 1
Param2 For FIM40&50 Param2 For FIM40&50
(Direction << 8) + (Value) IF (Direction == 1)
Direction (Direction << 8) +
0 – Write (Status of GPIO)
1 – Read ELSE
Value 0
0 – Low/Off
1 – High/On For FIM20 emulation mode and FIM30
emulation mode
For FIM20 emulation mode and FIM30 0
emulation mode
Value
0 – Low/Off
1 – High/On
Data Size 0 Data Size 0
Error Code X Error Code Error code
Data - Data -
In order to read the value of GPIO through this command, selected GPIO should be configured
as „Normal Input‟.
Also „Normal Output‟ should be configured to write the value.
NITGEN ____________________________________________________________ Pages 76
Serial Protocol
Serial Protocol
CMD_GET_IMAGE_QUALITY
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x68 Command 0x68
Param1 0 Param1 RESULT_SUCCEEDED
RESULT_FAILED
Param2 0 Param2 Quality Value
Data Size 0 Data Size 0
Error Code 0 Error Code Error code
- -
This command returns image quality after using the following commands.
CMD_VERIFY_FP
CMD_IDENTIFY_FP
CMD_INSTANT_MATCHING
CMD_GET_TEMPLATE
CMD_GET_FP_IMAGE2
CMD_ENTER_MASTER_MODE2
CMD_REGISTER_FP
CMD_CHANGE_FP
CMD_FEGISTER_MULTI_FP
For other commands, the value of image quality is invalid.
The quality range is from 0 (low quality) to 100 (high quality).
NITGEN ____________________________________________________________ Pages 77
Serial Protocol
Serial Protocol
CMD_CFG_IO
COMMAND PACKET ACKNOWLEDGEMENT PACKET
Command 0x69 Command 0x69
Param1 Selection of GPIO (0~7) Param1 RESULT_SUCCEEDED
RESULT_FAILED
Param2 Refer to Appendix F Param2 0
Data Size 0 Data Size 0
Error Code X Error Code Error code
Data - Data -
The configuration of GPIO can be initialized by CMD_SET_DEFAULT_SYSINFO (0x50).
NITGEN ____________________________________________________________ Pages 78
Serial Protocol
Serial Protocol
APPENDIX A. LOG DATA BLOCK
The log data block consists of index, type, event, and information, and the size of a log data
block is 28 bytes. The following table shows the organization of a log data block. The max
number of log data to be supported is different according to devices.
■ Log Data Format
Information (22)
Index (4) Type (1) Event (1)
ID (10) Result (2) Reserved (10)
0 ~ (0xFFFFFFFF – 1) Command = 01) Enroll = 0 FPID (10) RESULT (2) X
Delete = 1 FPID (10) RESULT (2) X
Verify = 2 FPID (10) RESULT (2) X
Identify = 3 FPID (10) RESULT (2) X
Instant Match = 6 X RESULT (2) X
Enter Master Mode = 7 FPID (10) RESULT (2) X
Set Master = 8 X RESULT (2) X
Reset Master = 9 X RESULT (2) X
Delete All = 10 X RESULT (2) X
Change FP = 11 FPID (10)
Change Password = 12 FPID (10)
Add FP = 13 FPID (10)
Instant Verify = 14
Instant Identify = 15
Change User Security = 16 FPID (10)
Error = 1 Error String
Information (22)
Type (1) Event (1)
Result (2) Time (8) ID (12)
2)
Command = 2 Enroll = 0 RESULT (2) TIME (8) FPID (12)
NITGEN ____________________________________________________________ Pages 79
Serial Protocol
Serial Protocol
Delete = 1 RESULT (2) TIME (8) FPID (12)
Verify = 2 RESULT (2) TIME (8) FPID (12)
Identify = 3 RESULT (2) TIME (8) FPID (12)
Instant Match = 6 RESULT (2) TIME (8) FPID (12)
Enter Master Mode = 7 RESULT (2) TIME (8) FPID (12)
Set Master = 8 RESULT (2) TIME (8) FPID (12)
Reset Master = 9 RESULT (2) TIME (8) FPID (12)
)
Delete All = 10 RESULT (2) TIME (8) FPID (12)
Change FP = 11 RESULT (2) TIME (8) FPID (12)
Change Password = 12 RESULT (2) TIME (8) FPID (12)
Add FP = 13 RESULT (2) TIME (8) FPID (12)
Instant Verify = 14 RESULT (2) TIME (8) FPID (12)
Instant Identify = 15 RESULT (2) TIME (8) FPID (12)
Change User Security = 16 RESULT (2) TIME (8) FPID (12)
Information (26)
Type (1) Event (1)
Result (2) Time (8) ID (16)
Command = 33) Enroll = 0 RESULT (2) TIME (8) FPID (16)
Delete = 1 RESULT (2) TIME (8) FPID (16)
Verify = 2 RESULT (2) TIME (8) FPID (16)
Identify = 3 RESULT (2) TIME (8) FPID (16)
Instant Match = 6 RESULT (2) TIME (8) FPID (16)
Enter Master Mode = 7 RESULT (2) TIME (8) FPID (16)
Set Master = 8 RESULT (2) TIME (8) FPID (16)
Reset Master = 9 RESULT (2) TIME (8) FPID (16)
Delete All) = 10 RESULT (2) TIME (8) FPID (16)
Change FP = 11 RESULT (2) TIME (8) FPID (16)
Change Password = 12 RESULT (2) TIME (8) FPID (16)
Add FP = 13 RESULT (2) TIME (8) FPID (16)
Instant Verify = 14 RESULT (2) TIME (8) FPID (16)
Instant Identify = 15 RESULT (2) TIME (8) FPID (16)
Change User Security = 16 RESULT (2) TIME (8) FPID (16)
1) This type is supported in FIM30 Emulation Mode.
NITGEN ____________________________________________________________ Pages 80
Serial Protocol
Serial Protocol
2) This type is supported in FIM20 Emulation Mode.
3) This type is supported in FIM40/50 None Emulation Mode.
NITGEN ____________________________________________________________ Pages 81
Serial Protocol
Serial Protocol
The following table lists log events.
LOG EVENT LIST
LOGEVT_ENROLL 0x00
LOGEVT_DELETE 0x01
LOGEVT_VERIFY 0x02
LOGEVT_IDENTIFY 0x03
LOGEVT_INSTANT_MATCH 0x06
LOGEVT_ENTER_MASTERMODE 0x07
LOGEVT_SET_MASTER 0x08
LOGEVT_RESET_MASTER 0x09
LOGEVT_DELETE_ALL 0x0A
1)
LOGEVT_CHANGE_FP 0x0B
1)
LOGEVT_CHANGE_PASSWD 0x0C
1)
LOGEVT_ADD 0x0D
1)
LOGEVT_INSTANT_VERIFY 0x0E
1)
LOGEVT_INSTANT_IDNETIFY 0x0F
LOGEVT_NONE 0xFF
NITGEN ____________________________________________________________ Pages 82
Serial Protocol
Serial Protocol
APPENDIX B. Emulation mode Command Table
This chapter describes commands used in Emulation mode.
■ FIM20 Emulation Command
CMD_REQUEST_CONNECTION (0x01)
CONNECTION CMD_GET_FIRMWARE_VERSION2 (0x04)
CMD_GET_DEVICE_INFO (0x05)
CMD_VERIFY_FP (0x11)
CMD_IDENTIFY_FP (0x12)
CMD_IDENTIFY_RID_FP(0x13)
CMD_INSTANT_MATCHING (0x15)
MATCHING
CMD_GET_TEMPLATE (0x16)
CMD_CANCEL (0x17)
CMD_INSTNAT_VERIFY (0x18)
CMD_INSTNAT_IDENTIFY (0x19)
CMD_DELETE_FP (0x22)
CMD_DELETE_ALL_FP (0x23)
CMD_SET_MASTER (0x24)
CMD_LEAVE_MASTER_MODE (0x26)
CMD_SET_MASTER_PASSWORD (0x27)
CMD_READ_USER_DATA (0x2B)
CMD_WRITE_USER_DATA (0x2C)
DATABASE
CMD_ERASE_USER_DATA_BLOCK (0x2D)
MANAGEMENT
CMD_DELETE_MASTER_PASSWORD (0x2E)
CMD_ENTER_MASTER_MODE2 (0x2F)
CMD_GET_FP_LIST2 (0x30)
CMD_GET_MASTER_LIST2 (0x31)
CMD_READ_LOG_DATA 2(0x32)
CMD_REGISTER_FP (0x33)
CMD_CHANGE_FP (0x34)
NITGEN ____________________________________________________________ Pages 83
Serial Protocol
Serial Protocol
CMD_ADD_FP (0x35)
CMD_GET_FP (0x36)
CMD_DELETE_ALL_LOG (0x37)
CMD_SET_SYSINFO (0x4C)
CMD_GET_SYSINFO (0x4D)
CMD_SAVE_SYSINFO (0x4E)
CONFIGURATION CMD_CHG_NUM_OF_TEMP (0x4F)
CMD_SET_DEFAULT_SYSINFO (0x50)
CMD_SET_EMULMODE (0x51)
CMD_GET_EMULMODE (0x52)
CMD_STATUS_CHECK (0x62)
CMD_GET_FP_IMAGE2 (0x63)
CMD_UPGRADE_FIRMWARE2 (0x64)
SYSTEM MANAGEMENT CMD_SET_TIME (0x65)
CMD_GET_TIME (0x66)
CMD_CTL_IO (0x67)
CMD_GET_IMAGE_QUALITY (0x68)
NITGEN ____________________________________________________________ Pages 84
Serial Protocol
Serial Protocol
■ FIM30 Emulation Command
CMD_REQUEST_CONNECTION (0x01)
CMD_SET_BAUDRATE (0x02)
CONNECTION
CMD_GET_FIRMWARE_VERSION2 (0x04)
CMD_GET_DEVICE_INFO (0x05)
CMD_VERIFY_FP (0x11)
CMD_IDENTIFY_FP (0x12)
CMD_INSTANT_MATCHING (0x15)
MATCHING CMD_GET_TEMPLATE (0x16)
CMD_CANCEL (0x17)
CMD_AUTO_IDENTIFY (0x1A)
CMD_AUTO_IDENTIFY_RESULT (0x1B)
CMD_DELETE_FP (0x22)
CMD_DELETE_ALL_FP (0x23)
CMD_SET_MASTER (0x24)
CMD_LEAVE_MASTER_MODE (0x26)
CMD_SET_MASTER_PASSWORD (0x27)
CMD_READ_USER_DATA (0x2B)
CMD_WRITE_USER_DATA (0x2C)
DATABASE
CMD_ERASE_USER_DATA_BLOCK (0x2D)
MANAGEMENT
CMD_DELETE_MASTER_PASSWORD (0x2E)
CMD_ENTER_MASTER_MODE2 (0x2F)
CMD_GET_FP_LIST2 (0x30)
CMD_GET_MASTER_LIST2 (0x31)
CMD_READ_LOG_DATA2 (0x32)
CMD_REGISTER_FP (0x33)
CMD_DELETE_ALL_LOG (0x37)
CMD_SET_OPP_OPTION (0x40)
CMD_GET_OPP_OPTION (0x41)
CONFIGURATION
CMD_SET_SECURITY_LEVEL (0x42)
CMD_GET_SECURITY_LEVEL (0x43)
NITGEN ____________________________________________________________ Pages 85
Serial Protocol
Serial Protocol
CMD_SET_CAPTURE_OPTION (0x44)
CMD_GET_CAPTURE_OPTION (0x45)
CMD_SET_LOG_OPTION (0x48)
CMD_GET_LOG_OPTION (0x49)
CMD_SET_CAPTURE_PERIOD (0x4A)
CMD_GET_CAPTURE_PERIOD (0x4B)
CMD_SET_EMULMODE (0x51)
CMD_GET_EMULMODE (0x52)
CMD_STATUS_CHECK (0x62)
CMD_GET_FP_IMAGE2 (0x63)
SYSTEM MANAGEMENT CMD_UPGRADE_FIRMWARE2 (0x64)
CMD_CTL_IO (0x67)
CMD_GET_IMAGE_QUALITY (0x68)
NITGEN ____________________________________________________________ Pages 86
Serial Protocol
Serial Protocol
APPENDIX C. PACKET RESULT LIST
The following table lists return code in acknowledge packet.
PACKET RESULT LIST
RESULT_SUCCEEDED 0x01
RESULT_FAILED 0x02
RESULT_NOT_MASTER_MODE 0x03
RESULT_USED_ID 0x04
RESULT_INVALID_ID 0x05
RESULT_DB_IS_FULL 0x06
RESULT_NOT_IN_TIME 0x07
RESULT_INVALID_PARAM 0x09
RESULT_OPP_INIT_FAILED 0x0C
RESULT_CANCELED 0x0D
RESULT_ANOTHER_FINGER 0x0E
RESULT_IDLE_STATUS 0x10
1)
RESULT_TOO_LARGE_DATA 0x11
2)
RESULT_IDENTIFY_TIMEOUT 0x12
3)
RESULT_DB_ISNOT_EMPTY 0x13
3)
RESULT_WRONG_TEMP_MODE 0x14
3)
RESULT_INVALID_DATASIZE 0x15
3)
RESULT_INVALID_DATA 0x16
4)
RESULT_EXTRACT_FAIL 0x17
RESULT_NOT_SUPPORTED 0x18
RESULT_AUTO_IDENTIFY_MODE 0x19
RESULT_INVALID_SEQUNCE 0x20
RESULT_SUCCEEDED
This code is returned when the command is executed successfully.
NITGEN ____________________________________________________________ Pages 87
Serial Protocol
Serial Protocol
RESULT_FAILED
This code is returned when the command cannot be executed for unknown reason.
RESULT_NOT_MASTER_MODE
This code is returned when the command that requires the master privilege is executed
in normal mode.
RESULT_USED_ID
This code is returned when ID in command packet already exists.
RESULT_INVALID_ID
This code is returned when the ID in command packet is invalid.
RESULT_DB_IS_FULL
This code is returned when there is no space for new user.
RESULT_NOT_IN_TIME
This code is returned when the fingerprint image can not be captured in capture
timeout.
RESULT_INVALID_PARAM
This code is returned when parameters of the command packet are invalid.
Normally, value out of range is used.
RESULT_OPP_INIT_FAILED
This code is returned when the initialization of the sensor is failed for hardware
problem.
RESULT_CANCELED
This code is returned when cancel command is transferred during executing a previous
command.
NITGEN ____________________________________________________________ Pages 88
Serial Protocol
Serial Protocol
RESULT_ANOTHER_FINGER
This code is returned when the first input finger of a user is not equal to the second
one in registration process.
RESULT_IDLE_STATUS
This code is returned when there is no executed command for the cancel command.
RESULT_TOO_LARGE_DATA
This code is returned when the size of data is greater than the size of pre-defined data
structure.
RESULT_IDENTIFY_TIMEOUT
This code is returned when identification process (1:N matching) can‟t be finished until
pre-defined identification timeout.
RESULT_DB_ISNOT_EMPTY
This code is returned when the command requires empty DB, but there exists user or
users.
RESULT_WRONG_TEMP_MODE
This code is returned when the template mode that required by command is different
from the current template mode.
RESULT_INVALID_DATASIZE
This code is returned when the size of data needed is different from the size of data
sent.
RESULT_INVALID_DATA
This code is returned when the transferred data cannot be comprehended.
RESULT_EXTRACT_FAIL
This code is returned when device cannot extract template data from image.
NITGEN ____________________________________________________________ Pages 89
Serial Protocol
Serial Protocol
RESULT_NOT_SUPPORTED
This code is returned when unsupported command is sent.
RESULT_AUTO_IDENTIFY_MODE
The code is returned when any commands are executed in Auto Identification mode.
RESULT_INVALID_SEQUENCE
This value is returned if wrong parameter is sent in sequential commands like
CMD_REGISTER_FP or CMD_REGISTER_MULTI_FP.
NITGEN ____________________________________________________________ Pages 90
Serial Protocol
Serial Protocol
Appendix D. DATA STURCTURE
In this chapter, the structure of data block to be transmitted is explained.
According to the device, the variables are defined as the following.
FIM30 emulation mode:
LENGTH_OF_FPID = 10
LENGTH_OF_PASSWD = 16
LENGTH_OF_TEMPLATE_HEADER=0
LENGTH_OF_TEMPLATE_DATA = 400
FIM20 emulation mode:
LENGTH_OF_FPID = 11
LENGTH_OF_PASSWD = 16
LENGTH_OF_TEMPLATE_HEADER=4
LENGTH_OF_TEMPLATE_DATA = 400
FIM40/50 none emulation mode:
LENGTH_OF_FPID = 11 (default value, can be changed)
LENGTH_OF_PASSWD = 16
LENGTH_OF_TEMPLATE_HEADER=4
LENGTH_OF_TEMPLATE_DATA = 400
Caution) FPID and Password are string. So the last byte is null (0x00). The available size
of FPID is (LENGTH_OF_FPID – 1), and the available size of password is
(LENGTH_OF_PASSWD – 1).
1. The structure of a FPID
Structure {
UINT8 FPID[LENGTH_OF_FPID];
} ID_INFO
2. The structure of a password
Structure {
NITGEN ____________________________________________________________ Pages 91
Serial Protocol
Serial Protocol
UINT8 FPPassword[LENGTH_OF_PASSWD];
} PASSWORD_INFO
3. The structure of TEMPLATE_INFO
TEMPLATE_INFO consists of TEMPLATE Header and Template Data.
For NITGEN Format:
Structure {
UINT8 Header[LENGTH_OF_TEMPLATE_HEADER];
UINT8 Data[LENGTH_OF_TEMPLATE_DATA];
} TEMPLATE_INFO
For ISO 19794-2 Format:
Structure {
UINT8 Header[LENGTH_OF_TEMPLATE_HEADER];
UINT8 Data[Length of ISO data];
} TEMPLATE_INFO
“Length of ISO data” varies according to the length of ISO template data.
Template Header is defined as followings:
0x00 0x00 0x00 0x03 : NITGEN Data Format
0x00 0x00 0x01 0x00: ISO 17974-2 Format
0x00 0x00 0x02 0x00: ANSI 378 Format
4. The structure of a “FPID + Password”
Structure {
ID_INFO FPID;
PASSWORD_INFO FPPassword;
}
5. The structure of a “FPID + Template”
Structure {
ID_INFO FPID;
TEMPLATE_INFO FPTemplate;
NITGEN ____________________________________________________________ Pages 92
Serial Protocol
Serial Protocol
}
6. The structure of a “FPID + Template Index”
Structure {
ID_INFO FPID;
UINT8 Template_Index;
}
7. The structure of a “FPID + User type”
Structure {
ID_INFO FPID;
UINT8 Right; // Normal User:0 Master: 1
}
8. The structure of a list block used in CMD_GET_FP_LIST2, CMD_GET_MASTER_LIST2
if Param1 == 0
Structure {
UINT16 User_Number; // for example, N
UINT16 ID_Size; // FIM30 emulation mode: 10
// FIM40/50 or FIM20 emulation mode:
11
ID_INFO FPID_1;
ID_INFO FPID_2;
…
ID_INFO FPID_N;
}
else if Param1 == 1
Structure {
UINT16 User_Number; // for example, N
}
User_Number and ID_Size are big endian format.
NITGEN ____________________________________________________________ Pages 93
Serial Protocol
Serial Protocol
9. The structure of a log block used in CMD_READ_LOG_DATA2
Structure {
UINT16 Log_Number; // for example, N
UINT16 Log_Size;
LOG_DATA Log1;
LOG_DATA Log2;
…
LOG_DATA LogN;
}
Log_Number and Log_Size are big endian.
For FIM30 Emulation Mode (28 Bytes)
Structure {
UINT8 Index[4]; // Big Endian Format
UINT8 Type; // For FIM30 emulation mode, 0x00
UINT8 Event;
UINT8 UserID[10];
UINT8 Result[2]; // Big Endian Format
UINT8 Reserved[10]; // all 0xFF
} LOG_DATA_TYPE0
For FIM20 Emulation Mode (28 Bytes)
Structure {
UINT8 Index[4]; // Big Endian Format
UINT8 Type; // For FIM20 emulation mode, 0x02
UINT8 Event;
UINT8 Result[2]; // Big Endian Format
UINT* Time[8];
UINT8 UserID[12];
} LOG_DATA_TYPE2
For None Emulation Mode (32 Bytes)
NITGEN ____________________________________________________________ Pages 94
Serial Protocol
Serial Protocol
Structure {
UINT8 Index[4]; // Big Endian Format
UINT8 Type; // For None emulation mode, 0x03
UINT8 Event;
UINT8 Result[2]; // Big Endian Format
UINT* Time[8];
UINT8 UserID[16];
} LOG_DATA_TYPE3
10. The structure of a firmware block used in CMD_UPGRADE_FIRMWARE2
(Refer to Appendix F)
Structure {
UINT32 Firmware_Size; // for example, N = M1+M2+ … + Mn
UINT8 Firmware[M*]; // 1 M* 32768
}
11. The structure of a TIME_INFO used in CMD_SET_TIME and CMD_GET_TIME
Structure {
UINT8 HundredthYear; // hundredth Year
UINT8 Year; // Remain Year
UINT8 Month; // Month: from 1 to 12
UINT8 Date; // Date: from 1 to 31
UINT8 Hour; // Hour: form 0 to 23
UINT8 Minute; // Minute: form 0 to 59
UINT8 Second; // Second: form 0 to 59
UINT8 Reserved; //
} TIME_INFO
All data is BCD code.
12. SI_TYPE used in CMD_SET_SYSINFO and CMD_GET_SYSINFO
Default
Code System Information Value Range
Value
NITGEN ____________________________________________________________ Pages 95
Serial Protocol
Serial Protocol
0x01 SI_USING_RELAY True/False False Not Executed
0x02 SI_USING_LOG True/False False
Supported in
0x03 SI_NUM_OF_TEMP 2, 4 2 FIM20 Emulation
mode only
0 – No out No side effect
0x10 SI_WIEGAND_FORMAT 1 – 26 bits 0
2 – 34 bits
0x11 SI_WIEGAND_SITECODE 0x0000 No side effect
255 or 100ms tick
0x17 SI_IDENTIFY_TIMEOUT 30
10 ~ 250 255 = unlimited
0x18 SI_RELAY_TIME 0 or 1~100 10 100ms ticks
0x19 SI_CAPTURE_TIMEOUT More than 10 50 100ms ticks
0x20 SI_IMAGE_BRIGHTNESS 0~100 45 100 - brightest
0x21 SI_IMAGE_GAIN 1,2,4,8 2
0x22 SI_IMAGE_CONTRAST 0~100 20
0x28 SI_ADAPTIVE_CAPTURE True/False False
0x30 SI_VERIFY_SECURITY_LEVEL 1~9 5
0x31 SI_IDENTIFY_SECURITY_LEVEL 6~9 8
0x32 SI_REGISTER_QUALITY 30~100 40
0x33 SI_VERIFY_QUALITY 10~100 30
0x38 SI_USING_LATENT True/False False No side effect
0x40 SI_ENABLE_CHANNEL1 True/False True No Side effect
0 – 115200
1 – 57600
0x48 SI_CHANNEL0_BAUDRATE 2 – 38400 4
3 – 19200
4 – 9600
0x49 SI_CHANNEL1_BAUDRATE “ 4
0x4A SI_CURR_CHANNEL_BAUDRATE “
Supported in
0x50 SI_MAX_USER
FIM20 Emulation
NITGEN ____________________________________________________________ Pages 96
Serial Protocol
Serial Protocol
mode only
0x51 SI_FP_FULL_ROTATION True/False False
0x52 SI_LENGTH_OF_USER_ID 4~15 10
0x53 SI_NUM_OF_ADAPTIVE_CAP 1~10 5
0x54 SI_MAX_TEMPLATE Read Only
1 – FIM20
0xF0 SI_EMULATION_MODE 2 – FIM30 0xFF
0xFF - None
True means „1‟ and False means „0‟.
SI_LENGTH_OF_USER_ID and SI_EMULATION_MODE are only changed when there is no
user.
If SI_EMULATION_MODE is changed, SI_LENGTH_OF_USER_ID can be changed according
to the value of SI_EMULATION_MODE.
13. DB structure used in CMD_SET_SYSINFO and CMD_GET_SYSINFO
Structure {
UINT32 SI_TYPE;
UINT32 SI_VALUE
} SI_INFO
14. DB structure used in CMD_ADD_FP and CMD_GET_FP
Old Format for FIM30:
Structure {
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FIID; // user ID
PASSWOR_DINFO FPPasswd; // Password
TEMPLATE_INFO FPTemplate1; // 1st Template
TEMPALTE_INFO FPTemplate2; // 2nd Template
} FIM_OLD_DB_FIM30
New Format for FIM30:
Structure {
NITGEN ____________________________________________________________ Pages 97
Serial Protocol
Serial Protocol
UINT8 Header[4]; // Data Header
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FIID; // user ID
PASSWOR_DINFO FPPasswd; // Password
UINT8 SecuLevelInfo; // 0xFC: Using security Level
// Otherwise: reserved
UINT8 UserSecuLevel; // User’s verification security
UINT8 Reserved[6]; // Reserved area for future use
SIZE_INFO FPSize1; // size of FPTemplate1
SIZE_INFO FPSize2; // size of FPTemplate2
st
TEMPLATE_INFO FPTemplate1; // 1 Template
nd
TEMPALTE_INFO FPTemplate2; // 2 Template
} FIM_DB_FIM30
Reserved area must be set full 0xFF.
Old Format for FIM20:
Structure {
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FIID; // user ID
PASSWOR_DINFO FPPasswd; // Password
st
TEMPLATE_INFO FPTemplate1; // 1 Template
nd
TEMPALTE_INFO FPTemplate2; // 2 Template
TIME_INFO Time; // Time Information
} FIM_OLD_DB2
Structure {
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FPID; // user ID
PASSWORD_INFO FPPasswd; // Password
st
TEMPLATE_INFO FPTemplate1; // 1 Template
nd
TEMPLATE_INFO FPTemplate2; // 2 Template
rd
TEMPLATE_INFO FPTemplate3; // 3 Template
th
TEMPLATE_INFO FPTemplate4; //4 Template
NITGEN ____________________________________________________________ Pages 98
Serial Protocol
Serial Protocol
TIME_INFO Time; // Time Information
} FIM_OLD_DB4
New Format for FIM20:
Structure {
UINT8 Header[4]; // Data Header
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FIID; // user ID
PASSWORD_INFO FPPasswd; // Password
UINT8 SecuLevelInfo; // 0xFC: Using security Level
// Otherwise: reserved
UINT8 UserSecuLevel; // User’s verification security
UINT8 Reserved[6]; // Reserved area for future use
TIME_INFO Time; // Time Information
SIZE_INFO FPSize1; // size of FPTemplate1
SIZE_INFO FPSize2; // size of FPTemplate2
st
TEMPLATE_INFO FPTemplate1; // 1 Template
nd
TEMPALTE_INFO FPTemplate2; // 2 Template
} FIM_DB2
Reserved area must be set full 0xFF.
Structure {
UINT8 Header[4]; // Data Header
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FPID; // user ID
PASSWORD_INFO FPPasswd; // Password
UINT8 SecuLevelInfo; // 0xFC: Using security Level
// Otherwise: reserved
UINT8 UserSecuLevel; // User’s verification security
UINT8 Reserved[6] // Reserved area for future use
TIME_INFO Time; // Time Information
SIZE_INFO FPSize1; // size of FPTemplate1
SIZE_INFO FPSize2; // size of FPTemplate2
NITGEN ____________________________________________________________ Pages 99
Serial Protocol
Serial Protocol
SIZE_INFO FPSize3; // size of FPTemplate3
SIZE_INFO FPSize4; // size of FPTemplate4
st
TEMPLATE_INFO FPTemplate1; // 1 Template
nd
TEMPLATE_INFO FPTemplate2; // 2 Template
rd
TEMPLATE_INFO FPTemplate3; // 3 Template
th
TEMPLATE_INFO FPTemplate4; //4 Template
} FIM_DB4
Reserved area must be set full 0xFF.
Format for FIM40/50:
Structure {
UINT8 Header[4]; // Data Header
UINT8 Right; // Normal User:0 Master: 1
ID_INFO FPID; // user ID
PASSWORD_INFO FPPasswd; // Password
UINT8 SecuLevelInfo; // 0xFC: Using security Level
// Otherwise: reserved
UINT8 UserSecuLevel; // User’s verification security
UINT8 Reserved[6] // Reserved area for future use
TIME_INFO Time; // Time Information
SIZE_INFO FPSize[10]; // size of FPTemplate
st
TEMPLATE_INFO FPTemplate1; // 1 Template
nd
TEMPLATE_INFO FPTemplate2; // 2 Template
rd
TEMPLATE_INFO FPTemplate3; // 3 Template
.
.
th
TEMPLATE_INFO FPTemplate10; //10 Template
} FIM_MT_DB
Reserved area must be set full 0xFF.
FPTemplate1 ~ 10 exist only when FPSize[ ] has non-zero value.
For example, When 1 template exists, FPSize[0] has non-zero value and FPSzie[1] ~
FPSzie[9] has zero.
NITGEN ____________________________________________________________ Pages
100
Serial Protocol
Serial Protocol
Therefore, FPTemplate2 ~ FPTemplate10 does not exists.
Structure {
UINT8 Size_H; // MSB 8 bits
UINT8 Size_L; // LSB 8 bits
} SIZE_INFO
Size = (Size_H x 256) + Size_L
Header has the following values
“0xC1 0x00 0x00 0x00” – FIM_DB2 with NITGEN format data
“0xC1 0x01 0x00 0x00” – FIM_DB2 with ISO 19794-2 format data
“0xC1 0x02 0x00 0x00” – FIM_DB2 with ANSI 378 format data
“0xC2 0x00 0x00 0x00” – FIM_DB4 with NITGEN format data
“0xC2 0x01 0x00 0x00” – FIM_DB4 with ISO 19794-2 format data
“0xC2 0x02 0x00 0x00” – FIM_DB4 with ANSI 378 format data
“0xC3 0x00 0x00 0x00” – FIM_MT_DB with NITGEN format data
“0xC3 0x01 0x00 0x00” – FIM_MT_DB with ISO 19794-2 format data
“0xC3 0x02 0x00 0x00” – FIM_MT_DB with ANSI 378 format data
In ISO 91794-2 format, the maximum number of minutiae supported in FIM is 80.
NITGEN ____________________________________________________________ Pages
101
Serial Protocol
Serial Protocol
Appendix E. EXAMPLES
In this chapter, communication method is explained with examples. These examples are made
for the following conditions.
LENGTH_OF_FPID = 11
LENGTH_OF_PASSWD = 16
LENGTH_OF_TEMPLATE_HEADER=4
LENGTH_OF_TEMPLATE_DATA = 400
1. Request Connection
For checking serial connection, use “Request Connection” command. For explanation on real
packet data, assume that the device has 10 users in DB. The following figure shows the
sequence of packets, and the contents of packets.
Host FDA or FIM
1)
2)
Figure E.1 The sequence of Request Connection
1) The structure of CMD_REQUEST_CONNECTION command packet
The following table shows the command packet made in the host.
Command 0x00000001
Param1 0x00000000
Param2 0x00000000
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000001
The following table shows the sequence of data to be transmitted to the device.
NITGEN ____________________________________________________________ Pages
102
Serial Protocol
Serial Protocol
7E 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01
2) Acknowledgement packet
In response to CMD_REQUEST_CONNECTION packet from host, the device sends
acknowledgement packet meaning a success as the following.
Command 0x00000001
Param1 0x00000001
Param2 0x0000000A
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x0000000C
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 01 00 00 00 01 00 00 00 0A 00 00 00 00 00 00 00 00 00 00 00 0C
Parameter 2 (0x0A) means 10 users are registered.
2. User Enrollment
There are two methods in registering user.
In FIM20 or FIM30 emulation mode, CMD_REGISTER_FP is used. But in none emulation mode,
CMD_REGISTER_MULTI_FP is recommended.
2.1 Using CMD_REGISTER_FP (Supported in FIM20 & 30 emulation mode)
This command is used for registering user with fingerprint, password, and master privilege
setting in registration. Password is optional.
2.1.1 Enrolling Normal User
Assume that a device has 10 users in DB. The following description explains the sequence of
registering normal user with the ID „1234‟ and the password “5678‟.
NITGEN ____________________________________________________________ Pages
103
Serial Protocol
Serial Protocol
In 2-template mode, device requires two fingerprint image. This sequence is controlled by
Param2 of command packet.
1) The structure of CMD_REGISTER_FP command packet (First capture)
The following table shows the command packet made in the host.
Command 0x00000033
Param1 0x00000000
Param2 0x00000000
Data Size 0x0000001B
Error Code 0x00000000
Header Checksum 0x0000004E
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data 0x00 0x35 0x36 0x37 0x38 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x00 0x00
Data Checksum 0x000001A4
In this example, FPID is 11 bytes null-terminated string and Password is 16 bytes null-
terminated string. Though password is not used, 16 bytes null data must be sent.
Param1 is used whether user is master or not. Param2 is used to inform the sequence of
registration. This packet request first image capture.
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 33 00 00 00 00 00 00 00 00 00 00 00 1A 00 00 00 00 00 00 00 4E
31 32 33 34 00 00 00 00 00 00 00 35 36 37 38 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 A4
2) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet meaning a success as the following.
Command 0x00000033
Param1 0x00000001
NITGEN ____________________________________________________________ Pages
104
Serial Protocol
Serial Protocol
Param2 0x00000000
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000034
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 33 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 34
3) The structure of CMD_REGISTER_FP command packet (Second capture)
If the acknowledgement packet to the first CMD_REGISTER_FP is returned successfully, the
host sends the second CMD_REGISTER_FP command packet as the following for requesting
second capture.
7E 00 00 00 33 00 00 00 00 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 34
In this packet .Param2 is used to control the sequence of registration.
4) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet as the following meaning a success.
7E 00 00 00 33 00 00 00 01 00 00 00 0B 00 00 00 00 00 00 00 00 00 00 00 3F
If this acknowledge packet is returned with successful result, user is added to device.
2.1.2 Registering Master
Assume that a device has 10 users in DB. The following description explains the sequence of
registering master with the ID „1234‟ ,the password “5678‟ and master privilege.
NITGEN ____________________________________________________________ Pages
105
Serial Protocol
Serial Protocol
1) The structure of CMD_REGISTER_FP command packet (First capture)
The following table shows the command packet made in a host.
Command 0x00000033
Param1 0x00000001
Param2 0x00000000
Data Size 0x0000001B
Error Code 0x00000000
Header Checksum 0x0000004F
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data 0x00 0x35 0x36 0x37 0x38 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x00 0x00
Data Checksum 0x000001A4
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 33 00 00 00 01 00 00 00 00 00 00 00 1A 00 00 00 00 00 00 00 4E
31 32 33 34 00 00 00 00 00 00 00 35 36 37 38 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 A4
The difference between normal and master is Param2 of command packet.
2) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet meaning a success as the following.
Command 0x00000033
Param1 0x00000001
Param2 0x00000000
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000034
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 33 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 34
NITGEN ____________________________________________________________ Pages
106
Serial Protocol
Serial Protocol
3) The structure of CMD_REGISTER_FP command packet (Second capture)
If the acknowledgement packet to the first CMD_REGISTER_FP is returned successfully, the
host sends the second CMD_REGISTER_FP command packet as the following.
7E 00 00 00 33 00 00 00 01 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 35
4) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet as the following meaning a success.
7E 00 00 00 33 00 00 00 01 00 00 00 0B 00 00 00 00 00 00 00 00 00 00 00 3F
2.1.3 Enrolling Normal User with different finger
In FIM20 & FIM30 emulation mode, device requires two fingerprint image and check the
fingerprint by matching first and second image. If two images are matched, device save user
with 2 templates what we called 1 ID 1 Fingers 2 Templates.
In some case, host want to save 1 ID with two different fingers.
Here is the method to save 1 ID with two different fingers, what we called 1 ID 2 Fingers 2
Templates.
Assume that a device has 10 users in DB. The following description explains the sequence of
registering normal user with the different finger and the ID „1234‟ and the password “5678‟.
1) The structure of CMD_REGISTER_FP command packet (First Capture)
This step is the same process with enrolling normal user
7E 00 00 00 33 00 00 00 00 00 00 00 00 00 00 00 1B 00 00 00 00 00 00 00 4E
31 32 33 34 00 00 00 00 00 00 35 36 37 38 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 A4
NITGEN ____________________________________________________________ Pages
107
Serial Protocol
Serial Protocol
2) Acknowledgement packet
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 33 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 34
3) The structure of CMD_REGISTER_FP command packet (Second capture)
If the acknowledgement packet to the first CMD_REGISTER_FP is returned successfully, the
host sends the second CMD_REGISTER_FP command packet as the following.
In order to enroll different finger with same ID, param2 of command packet have to be set in 2.
7E 00 00 00 33 00 00 00 00 00 00 00 02 00 00 00 00 00 00 00 00 00 00 00 35
4) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet as the following meaning a success.
7E 00 00 00 33 00 00 00 01 00 00 00 0B 00 00 00 00 00 00 00 00 00 00 00 3F
2.2 Using CMD_REGISTER_MULTI_FP
This command is newly added in FIM40/50 for supporting 1 ID multi-template mode.
Host can add 1 ID up to 10 fingers.
2.2.1 1 ID 1 finger Enrollment
Assume that a device has 10 users in DB. The following description explains the sequence of
registering normal user with the ID „1234‟ and the password “5678‟.
1) The structure of CMD_REGISTER_MULTI_FP command packet (First capture)
The following table shows the command packet made in the host.
Command 0x00000038
NITGEN ____________________________________________________________ Pages
108
Serial Protocol
Serial Protocol
Param1 0x00000000
Param2 0x00000000
Data Size 0x0000001B
Error Code 0x00000000
Header Checksum 0x00000053
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data 0x00 0x35 0x36 0x37 0x38 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x00 0x00
Data Checksum 0x000001A4
In this example, FPID is 11 bytes null-terminated string and Password is 16 bytes null-
terminated string. Though password is not used, 16 bytes null data must be sent.
Param1 is used whether user is master or not. Param2 is used to inform the sequence of
registration and finger index. This packet request first image capture.
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 38 00 00 00 00 00 00 00 00 00 00 00 1A 00 00 00 00 00 00 00 53
31 32 33 34 00 00 00 00 00 00 00 35 36 37 38 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 A4
2) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet meaning a success as the following.
Command 0x00000038
Param1 0x00000001
Param2 0x00000000
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000039
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 38 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 39
NITGEN ____________________________________________________________ Pages
109
Serial Protocol
Serial Protocol
3) The structure of CMD_REGISTER_MULTI_FP command packet (Second capture)
If the acknowledgement packet to the first CMD_REGISTER_MULTI_FP is returned
successfully, the host sends the second CMD_REGISTER_MULTI_FP command packet as the
following for requesting second capture.
7E 00 00 00 38 00 00 00 00 00 00 00 03 00 00 00 00 00 00 00 00 00 00 00 39
In this packet .Capture mode of param2 is used to control the sequence of registration. By using
capture mode 0x03, device capture fingerprint and save user.
4) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet as the following meaning a success.
7E 00 00 00 38 00 00 00 01 00 00 00 0B 00 00 00 00 00 00 00 00 00 00 00 44
If this acknowledge packet is returned with successful result, user is added to device.
2.2.2 1 ID multi-fingers Enrollment
Assume that a device has 10 users in DB. The following description explains the sequence of
registering normal user with the ID „1234‟ and the password “5678‟.
1) The structure of CMD_REGISTER_MULTI_FP command packet (First capture)
The following table shows the command packet made in the host.
Command 0x00000038
Param1 0x00000000
Param2 0x00000000
Data Size 0x0000001B
NITGEN ____________________________________________________________ Pages
110
Serial Protocol
Serial Protocol
Error Code 0x00000000
Header Checksum 0x00000053
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data 0x00 0x35 0x36 0x37 0x38 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x00 0x00
Data Checksum 0x000001A4
In this example, FPID is 11 bytes null-terminated string and Password is 16 bytes null-
terminated string. Though password is not used, 16 bytes null data must be sent.
Param1 is used whether user is master or not. Param2 is used to inform the sequence of
registration and finger index. This packet request first image capture.
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 38 00 00 00 00 00 00 00 00 00 00 00 1A 00 00 00 00 00 00 00 53
31 32 33 34 00 00 00 00 00 00 00 35 36 37 38 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 A4
2) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet meaning a success as the following.
Command 0x00000038
Param1 0x00000001
Param2 0x00000000
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000039
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 38 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 39
3) The structure of CMD_REGISTER_MULTI_FP command packet (Second capture)
If the acknowledgement packet to the first CMD_REGISTER_MULTI_FP is returned
NITGEN ____________________________________________________________ Pages 111
Serial Protocol
Serial Protocol
successfully, the host sends the second CMD_REGISTER_MULTI_FP command packet as the
following for requesting second capture.
7E 00 00 00 38 00 00 00 00 00 00 00 02 00 00 00 00 00 00 00 00 00 00 00 39
In this packet .Capture mode of param2 is used to control the sequence of registration. By using
capture mode 0x02, device capture fingerprint but not save yet.
4) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet as the following meaning a success.
7E 00 00 00 38 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 39
5) Repeat from 1) to 4) until host want to finish adding finger to user
Finger index must be changed.
6) Save user
To finish and save, set capture mode 0x04
7E 00 00 00 38 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 00 00 00 00 3B
7) Acknowledgement packet
In response to CMD_REGISTER_FP packet from host, the device sends acknowledgement
packet as the following meaning a success.
7E 00 00 00 38 00 00 00 01 00 00 00 0B 00 00 00 00 00 00 00 00 00 00 00 44
NITGEN ____________________________________________________________ Pages
112
Serial Protocol
Serial Protocol
If acknowledge packet is returned with successful result, user is added to device.
3. User Deletion
Two deletion commands such as CMD_DELETE_FP for deleting a single user and
CMD_DELETE_ALL_FP for deleting all users are supported. For example, assume that a
device has 10 users in DB. The following description shows the sequence of deleting user that
has the ID „1234‟.
Host FDA or FIM
1)
2)
Figure E.3 The sequence of deletion
1) The structure of CMD_DELETE_FP command packet
The following table shows the command packet made in the host.
Command 0x00000022
Param1 0x00000000
Param2 0x00000000
Data Size 0x0000000B
Error Code 0x00000000
Header Checksum 0x0000002D
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data
0x00
Data Checksum 0x000000CA
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 22 00 00 00 00 00 00 00 00 00 00 00 0A 00 00 00 00 00 00 00 2C
NITGEN ____________________________________________________________ Pages
113
Serial Protocol
Serial Protocol
31 32 33 34 00 00 00 00 00 00 00 00 00 00 CA
2) Acknowledgement packet
In response to CMD_DELETE_FP packet from host, the device sends acknowledgement packet
meaning a success as the following.
Command 0x00000022
Param1 0x00000001
Param2 0x00000009
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x0000002C
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 22 00 00 00 01 00 00 00 09 00 00 00 00 00 00 00 00 00 00 00 2C
4. Authentication
There are two methods for authentication.
Verification for 1:1 authentication
Identification for 1:N authentication.
4.1 Verification (1:1 Authentication)
The device supports user verification with fingerprint or password.
4.1.1 Verification with fingerprint
The following description shows the sequence of verifying user that has the ID „1234‟.
NITGEN ____________________________________________________________ Pages
114
Serial Protocol
Serial Protocol
Host FDA or FIM
1)
2)
Figure E.4 sequence of verification
1) The structure of CMD_VERIFY_FP command packet
The following table shows the command packet made in the host.
Command 0x00000011
Param1 0x00000000
Param2 0x00000000
Data Size 0x0000000B
Error Code 0x00000000
Header Checksum 0x0000001C
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data
0x00
Data Checksum 0x000000CA
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 11 00 00 00 00 00 00 00 00 00 00 00 0A 00 00 00 00 00 00 00 1B
31 32 33 34 00 00 00 00 00 00 00 00 00 00 CA
2) Acknowledgement packet
In response to CMD_VERIFY_FP packet from host, the device sends acknowledgement packet
meaning a success as the following.
Command 0x00000011
Param1 0x00000001
Param2 0x00000000
NITGEN ____________________________________________________________ Pages
115
Serial Protocol
Serial Protocol
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000012
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 11 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12
4.1.2 Verification with password
The following description shows the sequence of verifying user that has the ID „1234‟ and the
password „5678‟.
1) The structure of CMD_VERIFY_FP command packet
The following table shows the command packet made in the host.
Command 0x00000011
Param1 0x00000001
Param2 0x00000000
Data Size 0x0000001B
Error Code 0x00000000
Header Checksum 0x0000002D
0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data 0x00 0x35 0x36 0x37 0x38 0x00 0x00 0x00 0x00 0x00
0x00 0x00 0x00 0x00 0x00 0x00 0x00
Data Checksum 0x000000DA
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 11 00 00 00 01 00 00 00 00 00 00 00 10 00 00 00 00 00 00 00 22
31 32 33 34 00 00 00 00 00 00 00 35 36 37 38 00 00 00 00 00 00 00 00 00 00 00 00 00 00 01 A4
2) Acknowledgement packet
In response to CMD_VERIFY_FP packet from host, the device sends acknowledgement packet
NITGEN ____________________________________________________________ Pages
116
Serial Protocol
Serial Protocol
meaning a success as the following.
Command 0x00000011
Param1 0x00000001
Param2 0x00000000
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000012
If the host gets the following packet, it means that the communication was successfully done.
7E 00 00 00 11 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12
4.2 Identification (1:N Authentication)
The device supports user verification only with fingerprint.
4.2.1 Identification with fingerprint
The following description shows the sequence of Identification.
Host FDA or FIM
1)
2)
Figure E.5 The sequence of Identification
1) The structure of CMD_IDENTIFY_FP command packet
The following table shows the command packet made in the host.
Command 0x00000012
Param1 0x00000000
Param2 0x00000000
NITGEN ____________________________________________________________ Pages
117
Serial Protocol
Serial Protocol
Data Size 0x00000000
Error Code 0x00000000
Header Checksum 0x00000012
The following table shows the sequence of data to be transmitted to the device.
7E 00 00 00 12 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 12
2) Acknowledgement packet
In response to CMD_IDENTIFY_FP packet from host, the device sends acknowledgement
packet meaning a success as the following.
Command 0x00000012
Param1 0x00000001
Param2 0x00000000
Data Size 0x0000000A
Error Code 0x00000000
Header Checksum 0x0000001D
Data 0x31 0x32 0x33 0x34 0x00 0x00 0x00 0x00 0x00 0x00
Data Checksum 0x000000CA
If the host gets the following packet, it means that the communication was successfully done.
If succeeded, User ID is also returned.
7E 00 00 00 12 00 00 00 01 00 00 00 00 00 00 00 0B 00 00 00 00 00 00 00 1E
31 32 33 34 00 00 00 00 00 00 00 00 00 00 CA
NITGEN ____________________________________________________________ Pages
118
Serial Protocol
Serial Protocol
Appendix F. Programmable GPIO
This chapter explains 8 programmable GPIOs (General Purpose Input and Output) which are
contained in FIM40 and FIM50 devices.
These GPIOs could be configured as the following table by using CMD_CFG_IO (0x69)
command.
Function
Configuration
Input Output
0x00 Normal Input
External Interrupt (Enroll)
0x01
High Active
External Interrupt (Enroll)
0x02
Low Active
External Interrupt
0x03 (Delete, Delete All)
High Active
External Interrupt
0x04 (Delete, Delete All)
Low Active
External Interrupt (Identify)
0x05
High Active
External Interrupt (Identify)
0x06
Low Active
0x80 Normal Output
Success Result
0x81
High Active
Success Result
0x82
Low Active
Failure Result
0x83
High Active
0x84 Failure Result
NITGEN ____________________________________________________________ Pages
119
Serial Protocol
Serial Protocol
Low Active
Sensor Capturing
0x85
High Active
(0x00) Normal Input: This function is used to read the status of the port.
(0x01) External Interrupt (High Active), Enroll: User registration with automatically created
user ID is activated when the port level goes from low to high.
(0x02) External Interrupt (Low Active), Enroll: User registration with automatically created
user ID is activated when the port level goes from high to low.
(0x03) External Interrupt (High Active), Delete and Delete All: User deletion by fingerprint is
activated when the port level goes from low to high. If high-level is maintained more than 5
seconds, all users will be deleted.
(0x04) External Interrupt (Low Active), Delete and Delete All: User deletion by fingerprint is
activated when the port level goes from high to low. If high-level is maintained more than 5
seconds, all users will be deleted.
(0x05) External Interrupt (High Active), Identify: Identification is activated when the port level
goes from low to high.
(0x06) External Interrupt (Low Active), Identify: Identification is activated when the port level
goes from high to low.
(0x80) Normal Output: This function is used to change the status of port. High or low can be
applied.
(0x81) Success Result (High Active): The Status of port is changed to high when Functions
started by external interrupt such as enroll, delete, delete all and identify and commands
defined in Table F.1 are executed successfully. Active time is controlled by RelayTime option.
(0x82) Success Result (Low Active): The Status of port is changed to low when Functions
started by external interrupt such as enroll, delete, delete all and identify and commands
defined in Table F.1 are executed successfully. Active time is controlled by RelayTime option.
(0x83) Failure Result (High Active): The Status of port is changed to high when Functions
started by external interrupt such as enroll, delete, delete all and identify are and commands
defined in Table F.1 failed. Active time is controlled by RelayTime option.
(0x84) Failure Result (Low Active): The Status of port is changed to low when Functions
NITGEN ____________________________________________________________ Pages
120
Serial Protocol
Serial Protocol
started by external interrupt such as enroll, delete, delete all and identify and commands
defined in Table F.1 are failed. Active time is controlled by RelayTime option.
(0x85) Sensor Capturing (High Active): The status of port is active during sensor is capturing
fingerprint.
(0xFF) Disabled: The port is not used.
Success and Fail output (0x0A ~ 0x0D) are affected by following commands.
CMD_VERIFY_FP (0x11)
CMD_IDENTIFY_FP (0x12)
CMD_IDENTIFY_RID_FP (0x13)
CMD_INSTANT_MATCHING (0x15)
CMD_INSTANT_VERIFY (0x18)
CMD_INSTANT_IDENTIFY (0x19)
CMD_AUTO_IDENTIFY_RESULT (0x1B)
CMD_DELETE_FP (0x22)
CMD_DELETE_ALL_FP (0x23)
CMD_REGISTER_FP (0x33)
CMD_REGISTER_MULTI_FP (0x38)
Table F.1
Normal Input and Output (0x00 and 0x80) can be controlled by CMD_CTL_IO (0x67)
command.
NITGEN ____________________________________________________________ Pages
121
Serial Protocol
Serial Protocol
Appendix G. THE EXAPMLE OF FIRMWARE UPGRADE
This chapter explains packet sequence for upgrading firmware with
„CMD_UPGRADE_FIRMWARE2‟ command.
In upgrading firmware, the data block of packet consists of size information and a portion of
firmware. For example, assume that firmware size is “S”, and firmware data consists of 10
blocks - B0, B1, … B9 as the following table.
B0 B1 B2 B3 B4 B5 B6 B7 B8 B9
Using CMD_UPGRADE_FIRMWARE2 command, 10 packets are needed for carrying firmware. The following table
shows all 10 packets.
Packet1 Data
Header S B0 Checksum
Packet2 Data
Header S B1 Checksum
.
.
.
Packet10 Data
Header S B9 Checksum
NITGEN ____________________________________________________________ Pages
122
Serial Protocol
Serial Protocol
Appendix H. Support Information
NITGEN & COMPANY Co., Ltd.
Ace Techno-Tower II, #105., 197-7,
Guro-Dong,Guro-Gu,
Seoul,, Korea (152-766)
Tel: +82-80-060-1600
Fax: +82-2-867-3801
E-mail. Customer@[Link]
NITGEN ____________________________________________________________ Pages
123
You might also like
- Fingerprint Recognition Module SpecificationNo ratings yetFingerprint Recognition Module Specification27 pages
- NITGEN FIM60 Fingerprint Protocol GuideNo ratings yetNITGEN FIM60 Fingerprint Protocol Guide28 pages
- UHF RFID Reader Serial Interface - V3.7No ratings yetUHF RFID Reader Serial Interface - V3.751 pages
- YR903 UHF RFID Reader Module - ProtocolNo ratings yetYR903 UHF RFID Reader Module - Protocol44 pages
- UART Packet Format for Fingerprint ModuleNo ratings yetUART Packet Format for Fingerprint Module15 pages
- Serial ATA II: Extensions To Serial ATA 1.0aNo ratings yetSerial ATA II: Extensions To Serial ATA 1.0a110 pages
- FIM2030 & FIM2040 Fingerprint Device DatasheetNo ratings yetFIM2030 & FIM2040 Fingerprint Device Datasheet21 pages
- Ni Serial - User - Manual - 2026 03 10 15 16 19No ratings yetNi Serial - User - Manual - 2026 03 10 15 16 1958 pages
- SIM7080 Series Linux Application Note V1.00No ratings yetSIM7080 Series Linux Application Note V1.0011 pages
- 000667-001A AST-3780 Users Manual Oct1987No ratings yet000667-001A AST-3780 Users Manual Oct1987118 pages
- VF-747 RFID Fixed Reader: Development ManualNo ratings yetVF-747 RFID Fixed Reader: Development Manual75 pages
- Atmel 8390 WIRELESS AVR2054 Serial Bootloader User Guide Application Note100% (1)Atmel 8390 WIRELESS AVR2054 Serial Bootloader User Guide Application Note23 pages
- AN3259 Application Note: RS232 Communications With A Terminal Using The STM8S-DISCOVERYNo ratings yetAN3259 Application Note: RS232 Communications With A Terminal Using The STM8S-DISCOVERY25 pages
- Nu 5800 Series Rs 485 Communications Function Setup and OperationNo ratings yetNu 5800 Series Rs 485 Communications Function Setup and Operation10 pages
- Obsolete Product(s) - Obsolete Product(s)No ratings yetObsolete Product(s) - Obsolete Product(s)33 pages
- Device Communication Guide SE. Park 1 of 134 ST SUNLAB Messages To Back-End Server 1.197No ratings yetDevice Communication Guide SE. Park 1 of 134 ST SUNLAB Messages To Back-End Server 1.197134 pages
- Simcom Sim8200 Linux Usb User Guide v1.00.00 20200509No ratings yetSimcom Sim8200 Linux Usb User Guide v1.00.00 2020050923 pages
- Tuya Serial Communication Protocol GuideNo ratings yetTuya Serial Communication Protocol Guide153 pages
- Universal Reporting Guide - 1.192 (LATAM)No ratings yetUniversal Reporting Guide - 1.192 (LATAM)130 pages
- Industrial Secure Serial to Ethernet ServerNo ratings yetIndustrial Secure Serial to Ethernet Server5 pages
- Leoxsys V4R Mini PC: Android 11, 4GB RAMNo ratings yetLeoxsys V4R Mini PC: Android 11, 4GB RAM3 pages
- Vola BMW ISID and ISSS For ICOM Emulator With ENET Cable Configuration ManualNo ratings yetVola BMW ISID and ISSS For ICOM Emulator With ENET Cable Configuration Manual30 pages
- OXO10.3 SD Omnitouchcallcenteroffice 8al91209usac 1 enNo ratings yetOXO10.3 SD Omnitouchcallcenteroffice 8al91209usac 1 en68 pages
- Iridium Pilot Site Survey Tool Instructions - Feb 2012No ratings yetIridium Pilot Site Survey Tool Instructions - Feb 20128 pages
- User Test Cases for Sales Order ProcessingNo ratings yetUser Test Cases for Sales Order Processing13 pages
- Data Representation in Computer SystemsNo ratings yetData Representation in Computer Systems36 pages
- TC2987en-Ed01 How To Implement SNMP To Monitor OXO ConnectNo ratings yetTC2987en-Ed01 How To Implement SNMP To Monitor OXO Connect18 pages