Soliddigi Optical Fingerprint Module User Manual
Soliddigi Optical Fingerprint Module User Manual
June 2011
1
Specifications
:
Supply power DC 3.6~6.0V
:
Supply current
: (
Working current 100mA typical value )
:
Peak current 150mA
:
Fingerprint image record time <0.5 second
:
Window area 14 X 18 mm
Matching mode :
Compared method (1:1)
Searching method (1:N)
:
Signature file 256 byte
:
Template file 512 byte
:
Storage capacity 120/375/880 pieces
: ( :
Security level 5 levels from low to high 1, 2, 3, 4 and 5 )
:
False accept rate (FAR) <0.001% (security level is 3)
: )
FRR <0.1% (security level is 3
:
Searching time ,
<1.0 second (when doing 1:1000 average)
:
PC interface UART (TTL logical level)
: ╳ ( ,
Communication baud rate (UART) (9600 N)bps when N=1-12 default N=6 i.e.,
57600bps )
Working environment :
:
Temperature -20 degree C -+40 degree C
: -
Relative humidity 40%RH 85%RH (No condensation)
Storage environment :
: -
Temperature -40 degree C +85 degree C
: (
Relative humidity <85%H No condensation )
Dimensions (LXW XH) :
:
Split mode
: :
Module 42 X 25 X 8.5mm (installation dimensions 31.5 x19 mm )
:
Fingerprint sensor 56 x20 X 21.5mm
One-in mode :
56 X 20 X 21.5mm
2
Hardware Interface
Hardware connection
Through communication interface, the module can communicate with MCU (3.3V
or 5V) directly: module sending pin (J2, TD) is connected to data receiving pin on
MCU (RXD); module receiving pin (J3, RD) is connected to data sending pin on
MCU (TXD).
If it is need to communicate with RS-232 level (such as PC), please add level
conversion circuit between the module and PC (such as MAX232 circuit).
Serial protocol
It uses half-duplex asynchronous serial communication. Default baud
rate is 576000bps and can be set 9600~115200 bps by commands.
Sending frame format is 10 bits, one start bit level. 8 data bits (low in
front) and one stop bit. There is no parity bit.
Power-delay time
When the module is powered on, it needs 500ms to initialize. During this period, the
module can’t respond to host commands.
3
Electrical Specifications
1. Power input
Item Specifications Unit Notes
Min Typical Max
Power voltage Vin 3.6 6.0 V Normal working value
Limit voltage Vin max -0.3 7.0 V Over this range may cause permanent
damage
Working current Icc 90 100 110 mA
Peak current Ipeak 150 mA
Sensor interface(
(J2)
)
Split module provides the special interface to electrical fingerprint sensor (15-pin
socket with 1.25mm spacing). It uses 15-pin row socket to connect with sensor board.
The length is 150mm if there is no special requirement.
One-in module is internal connection. User doesn’t need to consider this.
4
System resources
To meet different customers’ requirements, module provides plenty of resources.
User notepad
The module reserves a storage area 512 byte (15 page * 32 byte) for host to use as
user notepad
User can store the data which needs power protection ( see Writenotepad command)
in specified page of this area or read the content of specified page( see ReadNotepad
command).
Note: when write a page in notepad, the 32 byte content is written all together and the
original content is overwritten.
Buffer
Module RAM has one image buffer ImageBuffer and two 512 bytes feature-file buffers
CharBuffer1 and CharBuffer2. User can read / write any buffer through commands.
The content in imagebuffer and two feature file buffers are not saved when power is
off.
Image buffer
Image Buffer is used to store image data and used as internal buffer for internal
image processing. Image’s format is 256X288 pixels.
To speed up the upload / download speed through UART, only the four HSB of the
pixel is sent, which means 16-level grayscale. Each byte means two pixels (high four
is one pixel, and low four which is in the next pixel. Combine these two pixels as one
byte to send. As image is 16-level grayscale, when downloaded to PC to display
(corresponding to BMP format), the grayscale level need to be extended (enlarge it
to 256-level grayscale, 8 bit bitmap format)
.
Signature file buffer
Signature file buffer CharBuffer1 and CharBuffer2 can be used to store common
signature files and template signature files.
Fingerprint library
The module reserved a storage area in FLASH as fingerprint temperate storing area,
which is fingerprint library. The data in fingerprint library is power protected.
Fingerprints are stored in sequence. If the storage capacity is N fingerprints, the
number of fingerprints in library is 0, 1, 2-----N-2, N-1. Users can only access the
5
fingerprint database based on the serial number.
System configuration:
Commands can be used to change the system parameters. Refer to system
configuration commands SetSysPara and ReadSysPara.
When host sends system configuration commands, module will reply with a response
and set accordingly. The new configuration is saved in FLASH. When system is
powered cycle, it will use new configuration.
Security level(
(parameter serial number 5)
)
This parameter controls fingerprint matching and searching value. It has 5 levels,
:
and value range is 1, 2, 3, 4 and 5.
The security level is 1, the false accept rate is highest and the reject rate is lowest.
The security is 5, the false accept is lowest and the reject is highest.
Packet length(
(parameter serial number 6)
)
This determines the longest packet: 0, 1, 2 and 3, which corresponds to (in byte) 32,
64, 128, 256.
6
Module password
After module resets, the device handshake password will first be checked to see if it
has been changed or not. If it hasn’t been changed, the module will think host doesn’t
need the password and will go to normal working status directly. When the module
password is the default one, the verification can be ignored. Password is 4 bytes. The
:
default password is 0FFH,0FFH,0FFH,0FFH.
(
If the internal password has been changed see set password command, the module
will do device handshake verification. If it passed, the module goes to the normal
working status. Or the module will refuse any command.
New password will be saved in Flash after changed and saved when power off. See
verify password command VfyPwd and set password command.
Module address
Each module has an identify address. When the module communicates with host,
each command / data is sent as a data packet. Each packet has one address and
addressed content. Module only responds to the command and data packet which has
the same address as its address.
Module address is 4 bytes, and factory default is: 0xFFFFFFFF. User can change
module address by commands (see set module address command SetAdder). After
adjustment, new address will be saved even the module is power off.
7
Communication Protocol
Packet format
When module communicates with host, it uses packet to send / receive the command,
data and result.
Packet format:
:
Packet Address Packet tag Packet length Packet content checksum
header code (command /
data/
parameter)
8
Packet DATA ----- Can be command, data, command parameters, reply
content result and etc.(fingerprint feature value and fingerprint
module are data)
Checksum SUM 2 bytes It is the sum of all bytes of packet tag, length and
content. Carry ignored when longer than 2 bytes.
Higher byte sent first.
When module receives command, it will report the execution results back to host
through reply packet. Reply packet has parameters and can be followed by other
packets. PC can confirm the command packet by receiving reply packets from
modules.
Reply packet contains one byte confirm code (necessary) and return parameters
(optional)
:
1. 00h command finished OK.
:
2. 01h packet receiving error.
:
3. 02h no finger on sensor.
:
4. 03h fail to record fingerprint.
:
5. 06h the fingerprint is too confused to generate features.
:
6. 07h fingerprint is normal, but feature points too few (area is too small) to generate
features.
:
7. 08h fingerprints are not matched.
:
8. 09h cannot find fingerprint.
:
9. 0Ah fail to combine features.
:
10. 0Bh the serial number is out of fingerprint library range.
:
11. 0Ch error reading template files from fingerprint library.
:
12. 0Dh fail to upload features.
:
13. 0Eh module cannot accept the follow-on data packet.
:
14. 0Fh fail to upload image.
:
15. 10h fail to delete template.
:
16. 11h fail to clean up fingerprint library.
:
17. 13h wrong password .
:
18. 15H there is no effective original image in buffer and cannot generate images.
9
19. 18H:read / write FLASH failed.
20. 19H:Undefined error;
21. 1AH:Invalid register number;
22. 1BH:error when set the contents of register.
23. 1CH:notepad page specify error.
24. 1DH:port operation failed.
25.other:reserved.
10
Module instruction set
SD-FPM10A module has 23 commands in total. Application usea different combinations
of commands to achieve different fingerprints’ identification. All of commands / data’s
sending are using packet format. Packet format and definition see previous section.
System instructions
1) Password: VfyPwd
: (
Function description Verify module handshake password See module password ).
:
Input Parameter PassWord (4 bytes)
:
Return Parameter Verification code (1 byte)
:
Command code 13H
11
2)Set password: SetPwd
Function description:set module handshake password(See module password)
Input Parameter: PassWord
Return Parameter: confirmation word
Command code: 12H
12
ACK packet format:
13
5) Ports control: Control
Function description :
To UART protocol ,this command is use to open and close UART port.
:
Input Parameter Control code
Control code 0 means close the port.
Control code 1 means open the port
:
Return Parameter Confirmation word
Command code:17H
14
Command packet format :
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet Comma Checksum
header address tag length nd code
0xEF01 xxxx 01H 03H 0fH sum
15
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes
Packet Module Packet Packet Comma Module Checksu
head address tag length nd code number m
0xEF01 xxxx 07H 5 xxH N sum
16
Fingerprint instructions
8 )Record fingerprint image: GenImg
Function description:detect fingers. After detection, record the fingerprint image
and save it in ImageBuffer, and return record success
confirmation code. If detection failed, return “no finger”
confirmation code.
:
Input Parameter none
:
Return Parameter confirmation word
Command code 01H :
17
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet Comma Checksum
header address tag length nd code
0xEF01 xxxx 07H 03H xxH sum
Note: 1 Confirmation coed = 00H means continue to send following data packets
Confirmation code = 01H means packet receiving has mistake
Confirmation code = 0fH means can not send following data packet
2 After answered, module sends follow-on data packet.
)
10 Download image: DownImage
:
Function description PC downloads image data to image buffer (see image buffer)
:
Input Parameter none
:
Return Parameter confirmation word
Command code 0bH :
18
Command packet format :
2 bytes 4 bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes
Packet Module Packet Packet Command code Buffer Checksum
header address tag length No.
0xEF01 xxxx 01H 04H 02H BufferID sum
Note: IDs of buffer CharBuffer1, CharBuffer 2 are 1h and 2h. Other value’s setting, please
follow CharBuffer2
19
ACK packet format:
)
13 Upload feature or module: UpChar
:
Function description upload the feature files in buffer CharBuffer1 or CharBuffer2 to
PC.
:
Input Parameter BufferID(buffer No.)
:
Return Parameter confirmation word
:
Command code 08H
Note: 1 Confirmation coed = 00H means continue to send follow-on data packets
Confirmation code = 01H means packet receiving has mistake
Confirmation code = 0dH means command failed
2 after answering, module sends follow-on data packet
3 this command will not affect on the content in module feature buffer
20
)
14 Download feature or module: DownChar
:
Function description host downloads feature files to one of its feature buffer
:
Input Parameter BufferID(buffer No.)
:
Return Parameter confirmation word
:
Command code 09H
Note: 1 Confirmation coed = 00H means can receive following data packets
Confirmation code = 01H means packet receiving has mistake
Confirmation code = 0eH means can not receive follow-on data packet
2 After answering, module starts s to receive follow-on data packets.
21
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet Confirmation Checksum
head address tag length code
0xEF01 xxxx 07H 03H xxH sum
Note: 1 Confirmation coed = 00H means store successfully
Confirmation code = 01H means packet receiving has mistake
Confirmation code = 0bH means PageID is out of fingerprint library range.
Confirmation code = 18H means FLASH error
)
16 Read and load module: LoadChar
:
Function description Read and load specified ID in flash data library to module buffer
CharBuffer1 or CharBuffer2.
: ,
Input Parameter BufferID(buffer No.) PageID (fingerprint library position No.2 byte.
Higher byte is in the front . )
:
Return Parameter confirmation word
Command code 07H :
Command packet format :
2 bytes 4 bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes 2 bytes
Packet Module Packet Packet Comma Buffer Page Checksu
head address tag length nd code No. No. m
0xEF01 xxxx 01H 06H 07H BufferID Page ID sum
Note: IDs of buffer CharBuffer1, CharBuffer 2 are 1h and 2h.
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet Confirmation Checksum
head address tag length code
0xEF01 xxxx 07H 03H xxH sum
Note: Confirmation coed = 00H means read and load successfully
Confirmation code = 01H means packet receiving has mistake
Confirmation code = 0cH means read and load error or invaild
Confirmation code = 0BH means PageID is out of fingerprint library range.
)
17 Delete module: DeletChar
:
Function description Delete specified period module in fingerprint library module (N
fingerprint module start from ID number)
,
Input Parameter: PageID (fingerprint library position No.) N deleted module quantity 。
:
Return Parameter confirmation word
Command code 0cH :
22
Command packet format :
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes 2 bytes 2 bytes
Packet Module Packet Packet Comma Page Delete Checksu
header address tag length nd code No. quantity m
0xEF01 xxxx 01H 07H 0cH Page ID N sum
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet Confirmation Checksum
head address tag length code
0xEF01 xxxx 07H 03H xxH sum
Note: Confirmation coed = 00H means delete successfully
Confirmation code = 01H means packet receiving has mistake
Confirmation code = 0cH means delete failed
23
Command packet format :
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet command Checksum
head address tag length code
0xEF01 xxxx 01H 03H 03H 07H
24
Other commands
22) Get random data: GetRandomCode
Function description: Ask chip to generate one random data and report to PC(see
4.8 Random number generator)
Input Parameter: none
Return Parameter: confirmation word
Command code: 14H
Command packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 2 bytes
Packet Module Packet Packet Comma Checksu
head address tag length nd code m
0xEF01 xxxx 01H 03H 14H 0018H
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 4 bytes 2 bytes
Packet Module Packet Packet Confirmation Random Checksum
head address tag length code data
0xEF01 xxxx 07H 07H xxH xxxx sum
Note: Confirmation coed = 00H means generate successfully
Confirmation code = 01H means packet receiving has mistake
25
) :
24 Read notepad ReadNotepad
:
Function description Read specified page data in notepad (see 4.1 user
notepad).This command corresponds to WriteNotepad.
Input Parameter none :
:
Return Parameter confirmation word + user information
Command code 19H :
Command packet format :
2 bytes 4 bytes 1 byte 2 bytes 1 byte 1 byte 2 bytes
Packet Module Packet Packet Comma Page Checksu
head address tag length nd code m
0xEF01 xxxx 01H 04H 19H 0~15 xxH
ACK packet format:
2 bytes 4 bytes 1 byte 2 bytes 1 byte 32 bytes 2 bytes
Packet Module Packet Packet Confirmation User Checks
head address tag length code information um
0xEF01 xxxx 07H 3 + 32 xxH User content sum
Note: Confirmation coed = 00H means OK
Confirmation code = 01H means packet receiving has mistake
26
9 0AH Upload image
10 0BH Download others 21 14H Get random
image data
11 02H Image feature 22 18H Write notepad
12 05H Feature 23 19H Read notepad
combination
module
27
SolidDigi Technologies, Inc
Add:Building A of Nano Sensor Park, 200 Linghu Ave, Taihu International Science
Technology Park, WuXi New District, WuXi, JiangSu, China
Tel: +86-510-85387391
Email:[email protected]
28