Kimaldi FingerVein Assembly instructions

Kimaldi Electronics, S.L.
Ctra. Rubí, 292-B Pol.Ind. Can Guitard
08228 Terrassa (Barcelona) CIF B61802302
www.kimaldi.com
Tel: [phone] Fax: [phone]
E-mail: [e-mail]
Installation and
Programming Manual
FingerVein - VIM
Integration Module
v. 1.01

Table of Content s
Date 12/16/09 Page 2 of 48
Table of Contents
1. About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2.1. FingerVein VIM electronics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3. Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.1. FingerVein sensor operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2. Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2.1. Start-up process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3.2.2. Information on exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4. Technical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.1. FingerVein VIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.2. Keypad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.3. Light indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4.4. Optical barrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.1. Connector signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2. Connection details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
6. Host communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
7. FingerVein VIM configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.1. Parameter array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.1.1. Serial port configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
7.1.2. Event configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
7.1.3. Optical barrier configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
7.1.4. Card reading port configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
7.1.5. Digital output timing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
8. Communications Protocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
8.1. Bio-OCX RS-232 frame format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
8.2. Common Instructions for Online Management . . . . . . . . . . . . . . . . . 21
8.2.1. Communications Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
8.2.2. Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
8.2.3. Firmware Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
8.2.4. GetCrashInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
8.2.5. ClearCrashInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Tabl e o f C o n tent s
Date 12/16/09 Page 3 of 48
8.3. Specific FingerVein VIM instructions . . . . . . . . . . . . . . . . . . . . . . . . 24
8.3.1. ReadCFG_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
8.3.2. WriteCFG_Byte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
8.3.3. FactoryCFG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
8.3.4. ApplyCFG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
8.3.5. Activate Led/Beeper Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
8.3.6. Switch Led/Beeper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
8.3.7. Close Relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
8.3.8. Switch Relay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
8.3.9. Digital input status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
8.3.10. Multiread filter status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
8.3.11. Card Reading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
8.3.12. Key Pressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
8.3.13. Send to UART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
8.3.14. Reception from UART . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
8.3.15. Optical Barrier Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
8.3.16. Enable optical barrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
8.3.17. Disable optical barrier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
8.3.18. Encapsulate GCR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
8.4. Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
9. Biometric identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
9.1. Basic instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
9.1.1. Recover sensor version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
9.1.2. Recover last sensor error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
9.1.3. Sensor reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
9.2. Capture of biometric information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.2.1. Capture of biometric information . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.3. Sensor memory management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
9.3.1. Add user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
9.3.2. Request number of users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
9.3.3. Delete user . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
9.3.4. Delete all users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
9.4. User identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
9.4.1. Instant Matching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
9.4.2. Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Appendix A. Application notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
A.1. Hardware connexions setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
A.2. FingerVein + Clock&Data electronics . . . . . . . . . . . . . . . . . . . . . . . 44
A.2.1. Hardware Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
A.2.2. Terminal configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
A.2.3. 1:N Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
A.2.4. 1:1 Identification: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Appendix B. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Revision Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Tabl e o f C o n tent s
Date 12/16/09 Page 4 of 48
1. About this Manual
This manual applies to FingerVein Integration Module (VIM), with FingerVein
biometric reader, firmware version 0x6D.32.
2. Description
The FingerVein Integration Module (VIM) aims to provide an easy integration of the
FingerVein subcutaneous vein pattern reading technology.
Default connectivity is based on RS232. Additional connectivity such as TCP/IP, WiFi
or USB are also possible as an option.
FingerVein VIM may be controlled with serial commands or with the help of the Active-
X, Kimaldi Bio-OCX controller, the latter method being recommended.
2.1. FingerVein VIM electronics
The FingerVein Integration Module is made up of three elements:
1. Control electronics: includes control electronics for the biometric reader and
connectivity towards the Host computer.
2. FingerVein biometric reader: includes the biometric sensor and its lower-level
electronic controller.
3. KiWi Voltage converter: a switched DC-to-DC regulator generates 5 Volts for the
Control Electronics from the 12-Volt power supply that also powers the FingerVein
biometric sensor. TCP/IP or Wi-Fi connectivity may be added to this module as an
option.
The control electronics and the biometric reader are interconnected through a serial
communications cable.
FingerVein VIM electronics has the following hardware resources:
• UART0: First port RS-232 (for Host connection).
• UART1: Second port RS-232 (for FingerVein sensor connection).
• One Clock&Data port
• One connector to Front Panel with 3 LEDs and 3 keys
• One card-mounted buzzer
• One digital input
• One relay (optional)
• One KiWi2 Converter connection card

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 5 of 48
3. Operation
Normal operations consist of sending the events that occur to the Host. Normally, these
will be linked to a user ID. The user can simply put his or her finger on the biometric
sensor or start the identification by presenting the card or pressing any key. From hereon,
the Host will launch the identification and save its result. Once the identity of the person
is known, it will be possible to act on an access relay, display a personalised message on
screen or even ask for a code using the keycard.
An aspect that deserves special attention is the possibility to carry out 1:1 identification
with the help of a Clock&Data or RS-232 reader, as indicated in chapter 7.
3.1. FingerVein sensor operation
FingerVein VIM allows for several types of use:
• 1:N Identification: the user places his or her finger on top of the biometric sensor.
An optical barrier activation event occurs, after which the Host orders the capture
of the user's fingerprint. The sensor compares it with all the fingerprints in the
database of up to 1,000 users.
• 1:1 Identification: the user is identified using the card or by entering a code. The
Host receives the identification code and retrieves the corresponding
identification code from its database. This fingerprint is sent to the biometric
sensor, after which the sensor itself scans the user's finger to check its identify
with a 1 to 1 comparison (“Instant Matching”).
The FingerVein VIM is controlled through elemental instructions integrated in the
Active-X Kimaldi Bio-OCX.
3.2. Others
All the aspects related to the operating and connectivity of FingerVein VIM electronics
can be configured as explained in chapter 7.: “FingerVein VIM configuration” .
It also incorporates a function for diagnosing faults in the hardware and for remote
firmware updating.
3.2.1. Start-up process
When the FingerVein VIM starts, it will in turn initialize the FingerVein biometric
sensor. This process takes approximately 8 seconds, during which both green and red
LEDs are switched on. After successful completion of the initialization process, red and
green LEDs turn off, and yellow LED remains indefinitely on.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 6 of 48
3.2.2. Information on exceptions
If an exception occurs in the operation of the microcontroller, the information on it is
stored in the non-volatile memory of the FingerVein VIM. The second time an exception
occurs, the machine restarts automatically.
The most normal thing will be enabling the ApplyCFG event via the CFG_ECHO
parameter (see Subsection ) and notifying Kimaldi Electronics Technical Service if this
event responds to a non-null void frame. The same information can be retrieved at any
time using the GetCrashInfo instruction and can then be deleted with ClearCrashInfo.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 7 of 48
4. Technical Specifications
4.1. FingerVein VIM
Dimensions: Control and power supply modules: 96 x 59 x 45 mm
FingerVein biometric sensor: 69 x 85 x 49 mm
Power Supply: 12 Vdc ± 8%
Maximum Current consumption: Control electronics: 200 mA 1@ 5V (self-generated)
FingerVein biometric sensor: 600 mA @ 12V
Interface to Host: RS232 - baudrate between 9600 and 57600; n,8,1
Outlet for external reader power supply: 5Vdc for the auxiliary reader power supply with
a current capacity of 200 mA.
User interface: Front panel with 3 keys and 3 LEDs. Beeper on-board.
Optical barrier: Integrated within the FingerVein biometric sensor.
Relay contacts: 1 relay contacts, normally open, 24V / 3A (optional)
Digital inputs: 1 relay-type digital inputs. In open circuit (contact open) their
logic value will be 0. In contact with earth (contact closed),
logic value 1.
Clock & Data input: In the UI module, it allows for a device to be connected that
transmits in Clock&Data with ABA encoding, Track 2.
4.2. Keypad
The FingerVein VIM allows connection of a Front Panel with three keys (J2 connector),
which may represent up to six different codes. That is achieved by distinguishing
between short (usual operation) and long press durations. Codes achieved after long
press durations are referred hereafter as “ALT + Key” codes.
Short-duration pressing of a key ends up with a short beep. On the other hand, if we keep
the key pressed for more than 4 seconds, a long beep will be emitted, thus indicating the
extended-mode operation. We may then release the key, which will trigger the “ALT +
Key” code.
4.3. Light indicators
The FingerVein VIM supports operatio of up to three light indicators (LEDs).
1. No peripherals attached

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 8 of 48
• Yellow LED (“Ready”): indicates normal operation of the module
• Green LED (“OK”): activated by a correct identification. It may also be driven by
the Host, in Online mode.
• Red LED (“Error”): activated by an incorrect identification. It may also be driven
by the Host, in Online mode.
• Red and Green flashing together: no connection was established with the
FingerVein sensor.
Outlets to LEDs are available on connector J2.
4.4. Optical barrier
When the FingerVein VIM detects finger presence on the biometric sensor, it issues an
OnKey event. The associated key code is configured under parameter $05. Please refer
to Subsection 7.1.3. for mor details.
Persistent detection of finger presence leads to an error status, notified to the host
through an Optical Barrier Status event, with argument code 0xE0. When the finger is
withdrawn, the optical barrier goes back to normal while generating a new Optical
Barrier Status event, with argument code 0x00.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 9 of 48
5. Installation
5.1. Connector signals
WARNING!
Take the necessary antistatic precautions when handling this product
to avoid damaging the sensitive electronic devices.
Control electronics require +5 Vdc supply (provided from J7).
FingerVein sensor requires +12 Vdc supply.
J2: Fr. Panel
J3: C&D Reader
LEDS
J 4: FingerVein
1 2 3 4 5 6 7
J1
JP1
JP2
J7: +5V Supply

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 10 of 48
5.2. Connection details
J1 - Main Connector:
Pin 1 - Do not connect (Power supply positive, +5V, is fed from J7)
Pin 2 - Power supply negative (GND, Pin no. 5 connector SubD female)
Pin 3 - UART0-Tx, RS-232 to the host (Pin no. 2 connector SubD female)
Pin 4 - UART0-Rx, RS-232 from the host (Pin no. 3 connector SubD female)
Pin 5 - Digital input 0 (DIN 0)
Pin 6 - Pole 1 relay contact 0 1
Pin 7 - Pole 2 relay contact 0
J2 - Connector to panel
Pin 1 - Anode (+) of the Red LED (“Error”)
Pin 2 - Anode (+) of the Green LED (“OK”)
Pin 3 - Anode (+) of the Yellow LED (“Ready”)
Pin 4 - Common Cathode (-) of the three LEDs (GND)
Pin 5 - Common keys
Pin 6 - Green key (“Enter”)
Pin 7 - F1 key
Pin 8 - F2 key
J3 - TTL_0 Connector to Card Readers: compatible with NdCAN TTL connector
Pin 1 - Data signal (TTL_0)
Pin 2 - Clock signal (TTL_0)
Pin 3 - CLS signal (TTL_0)
Pin 4 - Output +5 VDC
Pin 5 - Power supply negative (GND)
J4 - Connection to FingerVein biometric sensor, via UART1
Pin 1 - Do not connect.
Pin 2 - UART1-Tx, RS-232 to FingerVein sensor.
Pin 3 - UART1-Rx RS-232 from FingerVein sensor.
Pin 4 - Power supply negative (GND).
J5 - Not used
J7 - 5Vdc input from KiWi DC-DC converter.
JP1, JP2: Jumpers to select KSP Application_ID (not used).
Status LEDs.
LD1 - +3V3 Power Supply correct.
LD2 - Rx/Tx instructions or events between KBio2 and Host.
LD3 - Red - Not used - Always on
LD4 - Green - Not used - Always on.
1. Relay is optional. Contact Kimaldi Electronics if required.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 11 of 48
6. Host communications
FingerVein VIM allows for RS-232 serial communication with the Host. The FingerVein
VIM is permanently listening to the serial channel and will return a response when a
command is received.
The UART0 port corresponds to communications with the Host via RS-232. This
communication is established at 19200 bps, with 8 bits, no parity and one stop bit by
default. The serial frames will consist of ASCII-Hex values according to the frame
format generated by the Bio-OCX controller (see chapter 8).
From the CFG_HostSerialPort configuration byte (parameter $1A), however, there are
other alternatives:
• Communication speed can be configured to 9600, 19200, 38400 or 57600 baud. To
do so, the CFG_HostSerialPort byte should take the $90, $91, $92 or $93
values respectively.
The CFG_EventsChannel parameter ($0D) should take the $00 value for the FingerVein
VIM to spontaneously transmit Online frames through this channel.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 12 of 48
7. FingerVein VIM configuration
The FingerVein VIM configuration consists of an array of bytes that allow certain
machine characteristics to be defined in terms of function (timings, parameter enabling/
disabling, etc.).
FingerVein VIM is stored in EEPROM memory, which provides it with around 10,000
read/write cycles. This should be taken into account when managing the configuration
parameters.
7.1. Parameter array
All the module's parameters are listed below:
Table 1: FingerVein VIM parameter list
No. Description Further informa-
tion
$01 Defines the events reported to the Host Refer to Subsection
$02 Guard time, in tenths of a second, between finger
detection events.
Refer to Subsection
7.1.3.
$03 Watchdog, in tenths of a second, for the detection
of the permanent blocking of the optical barrier.
Refer to Subsection
7.1.3.
$04 Time-out, in tenths of a second, of reception
of data by the UART. Applicable to all UART.
Refer to Subsection
$05 The optical barrier will generate a Key Pressing
event corresponding to a configurable key value.
Refer to Subsection
7.1.3.
$06 Duration, in hundredths of a second, of the buzz-
ing of the internal beeper to indicate the pressing
of a key.
Refer to Subsection
7.1.5.
$07 Duration, in hundredths of a second, of the buzz-
ing of the internal beeper to indicate an error.
Refer to Subsection
7.1.5.
$08 Enables RS-232 Reader (UART2-UI) and
Clock&Data (TTL_0) ports.
Refer to Subsection
7.1.4.
$09 Configuration byte of the automatic beeper ena-
bling after a correct Clock&Data reading.
Refer to Subsection
7.1.4.
$0A Configuration byte of the automatic beeper ena-
bling after an incorrect Clock&Data reading.
Refer to Subsection
7.1.4.
$0B Configuration of the multiread filtering. Refer to Subsection
7.1.4.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 13 of 48
$0C Time-out in tenths of a second of the multiread fil-
tering, to detect that a card has left the reading
field.
Refer to Subsection
7.1.4.
$0D Configures the communications channel through
which the event frames are sent.
Refer to Subsection
$0E Time-out, before starting the biometric sensor. Refer to Subsection
$0F
to
$19
Reserved
$1A Determines the protocol and Baud Rate assigned
to the UART0.
Refer to Subsection
7.1.1.
$1B Determines the protocol and Baud Rate assigned
to the UART1. Do not change.
Refer to Subsection
7.1.1.
$1C Reserved.Refer to Subsection
7.1.1.
$1D Do not change
$1E Reserved for future uses.
$1F Time, in tenths of a second, to indicate correct
reading with the green LED.
Refer to Subsection
7.1.5.
$20 Time, in tenths of a second, to indicate incorrect
reading with the red LED.
Refer to Subsection
7.1.5.
$21 Time, in tenths of a second, to indicate correct
reading with the buzzing of the external beeper.
Refer to Subsection
7.1.5.
$22 Time, in tenths of a second, to indicate incorrect
reading with the buzzing of the external beeper.
Refer to Subsection
7.1.5.
$23 Reserved for future uses.

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 14 of 48
7.1.1. Serial port configuration
The behaviour of the serial ports is defined from the $1A, $1B and $1C configuration
parameters:
Depending on the function associated to the port and baud rate, the values to be assigned
are detailed in the following table.
7.1.2. Event configuration
FingerVein VIM has the capability to start communications to the Host when any event
occurs in the machine (e.g. a key is pressed). The following parameters can be
configured:
Table 2: RS-232 port configuration
No. Description Def.
$1A CFG_ Host-
SerialPort
Determines the protocol and Baud Rate assigned
to the UART0. Refer toTable 3
$93
$1B CFG_Reader-
Serial-Port
Determines the protocol and Baud Rate assigned
to the UART1. Refer toTable 3
$BB
Table 3: Reader configuration codes
Type of Reader Parameter and values Details
Communication with the
Host, Bio-OCX protocol
CFG_ HostSerialPort
$90: 9600 baud
$91: 19200 baud
$92: 38400 baud
$93: 57600 baud
Only UART0
FingerVein Sensor CFG_ReaderSerialPort
$BB: 57600 baud
Only UART1
Table 4: Event configuration
No. Description Def.
$01 CFG_ ECHO Defines the events reported to the Host (DB mod-
ule)
$50
$04 CFG_
SCITimeout
Time-out of the reception of the UART from the
RS232 reader(UART2-UI)
$FF
$0D CFG
_EventCH
Communications channel through which the elec-
tronics will generate the event frame. Refer
toTable 5
$FF

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 15 of 48
The following section explains the meaning of each of these configuration bytes.
Byte $01: ECHO. This generates an OpCode for each status change (digital inputs,
time-locking relays and optical barrier, among others). We can configure from which
type of signal we want to obtain the Echo.
Permitted values:
- Bit 3: ECHO ON – Reset Output.
- Bit 4: ECHO ON – Status change in digital inputs.
- Bit 5: ECHO ON – Ends digital output timing (Relay, LED, buzzer).
- Bit 6: ECHO ON – Optical barrier (notifies erroneous status)
- Bit 7 (MSB): ECHO ON – Reserved (keep at 0)
- 0x00: ECHO OFF: - silent (only responds if it is asked for the digital inputs).
Default value:
- 0x50: ECHO ON, for digital inputs and optical barrier
Byte $04: SCI Time-out. This configures the maximum time-out between
consecutive characters received by the terminal from the RS232 reader to be
interpreted as part of the same command frame.
Permitted values:
- 0x01 .. 0xFE: Time-out value in tenths of a second.
- 0x00, 0xFF: Automatic time-out value (from 150 ms for 9600 baud and 20 ms for
115200 baud)
Default value:
- 0xFF: Automatic time-out.
Byte $0D: Event Channel. Normally, the FingerVein VIM always responds through
the same channel from which the instruction is received. However, there are
situations (typically after Reset) where there is no prior instruction and therefore we
have to refer to CFG-DB_EventCH to determine this output channel.
Default value:
- 0xFF: Events are not generated until the Host has started communicating.
Table 5: Event Channel identifier
CFG-DB_EventCH Communications channel
$00 UART0
$FF None

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 16 of 48
7.1.3. Optical barrier configuration
Byte $02: Optical Guard Time. This configures the optical barrier guard time: when
the optical barrier has detected the presence of the finger, it is disabled for a few
seconds. This allows for biometric identification, with no new finger detection events
occurring. If the guard time runs out and the finger is still blocking the optical
barrier, a new event will be generated.
Permitted values:
- 0x00 .. 0xFE: Guard time value in tenths of a second.
Default value:
- 0x14: Guard time of 2 seconds.
Byte $03: Optical Watchdog Timer. In its standby state, the optical barrier detects
the beam of light from the LED transmitter. If it does not detect the beam for some
time, it may be due to a mechanical or electronic fault. In this situation, you must
press the green key (“Enter”) to initiate biometric identification. When the Watchdog
Timer of the optical barrier is triggered, the Host receives a notification (Optical
Barrier Status event, code 0xED ). It will automatically return to normal when the
beam of light is no longer obstructed (Optical Barrier Status event, code 0x0D ). The
default value of the Watchdog Timer allows for 2 or 3 consecutive identification
attempts to be made without removing your finger from the biometric sensor.
Permitted values:
- 0x00: This disables the optical barrier.
- 0x01 .. 0xFE: Delay value in tenths of second.
Default value:
- 0x80: This disables the optical barrier after 12.8 seconds without detecting the
beam.
Table 6: Optical barrier configuration
No. Description Def.
$02 CFG_OPT
_T_GUARD
Time-out between finger detection events $14
$03 CFG_OPT
_T_WDOG
Watchdog for permanent blockage detection $80
$05 CFG_OPT
_KeyCode
The optical barrier will generate a Key Pressing
event corresponding to a configurable key value
$41

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 17 of 48
Byte $05: Optical Key Code. The presence of a finger blocking the optical barrier
will generate an event equivalent to a Key Pressing. The key code is configurable,
although we recommend comparing finger presence to the pressing of the green key.
For this reason, the default value is 0x41 (corresponding to ‘A’).
Permitted values:
- 0x00 .. 0xFF: Any, although we recommend an alphanumerical value.
Default value:
- 0x41: ‘A’, is equivalent to the pressing of the green “Enter” key.
7.1.4. Card reading port configuration
Byte $08: Reader Enable. Enables and configures the operation of the Clock&Data
ports.
Permitted values:
- Bit 0: not in use
- Bit 1: not in use
- Bit 2: TTL_0 ON – Clock&Data TTL_0 enabled.
- Bit 3: not in use
- Bit 4: not in use
- Bit 5: not in use
- Bit 6: ‘*’ before TTL_0 – An asterisk is in front of the data received via TTL_0.
- Bit 7: not in use
Default value:
- 0x8C: TTL_0 enabled.
Table 7: Card reading port configuration
No. Description Def.
$08 CFG_ Rdr_
Enable
Enables RS-232 (UART2-UI) Reader and
Clock&Data (TTL_0) ports
$8C
$09 CFG_Rdr_
BuzOK
Automatic activation of the Beeper after a correct
Clock&Data reading
$0C
$0A CFG_Rdr_
BuzError
Automatic activation of the Beeper after an incor-
rect Clock&Data reading
$0C
$0B CFG_Rdr_
Multiread
Multiread filtering $00
$0C CFG_Multi
read_TMO
Time-out in tenths of a second of the multiread
filtering to detect that a card has left the reading
field.
$28

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 18 of 48
Byte $09: Buzzer on OK. Buzzer configuration for correct readings. We can enable
the buzzer assembled on the FingerVein VIM (internal), so that it is enabled when a
correct reading has occurred.
Permitted values:
- Bit 0: not in use.
- Bit 1: not in use
- Bit 2: Internal buzzer enabled for TTL_0.
- Bits 3-7: not in use
Default value:
- 0x0C: Internal buzzer enabled for TTL_0.
Byte $0A: Buzzer on Fail. Buzzer configuration for incorrect readings. We can
enable the buzzer assembled on the FingerVein VIM (internal), so that it is enabled
when an incorrect reading has occurred.
Permitted values:
- Bit 0: not in use.
- Bit 1: not in use
- Bit 2: Internal buzzer enabled for TTL_0.
- Bits 3-7: not in use
Default value:
- 0x0C: Internal buzzer enabled for TTL_0.
Byte $0B: Multiread. This enables multiread filtering of the Clock&Data and RS232
inputs. Multiread filtering is useful for when we have a reader configured in
multiread mode connected to the card (every X time the reader checks the presence
of the card and if it is present it generates an event with the card's identification
information). This mode allows for filtering all the events that correspond to a same
card and only generates events when it varies with the reading data.
Permitted values:
- Bit 0: not in use.
- Bit 1: not in use
- Bit 2: Multiread filter enabled for TTL_0.
- Bits 3-7: not in use
Default value:
- 0x00: Disabled multiread filter.
Byte $0C: Multiread time-out. This defines the time required for determining that a
card has left the field of a reader configured in multiread. When this time is up, the
FingerVein VIM generates a Card Reading event with a null identification value
(refer to Subsection 8.3.11.).

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 19 of 48
Permitted values:
- The time-out value should exceed the reading repetition time.
Default value:
- 0x28: Card Reading event 4 seconds after the last correct reading.
7.1.5. Digital output timing
The timings of the internal buzzer can be configured:
For all the parameters described in the table, the configuration value corresponds to
the time in multiples of 10 ms that they are to remain enabled:
- With a correct reading, the internal buzzer (CFG_TempBuzz1_OK) and the green
LED (CFG_GreenLED_OK) will be triggered.
- With an incorrect reading, the internal buzzer (CFG-UI_Temp-Buzz_Fail) and the
red LED (CFG_RedLED_Fail) will be triggered.
Permitted values:
- 0xFF: Permanently enabled.
- 0x01 .. 0xFE: Timing in multiples of 10 milliseconds.
- 0x00: Timing disabled.
Default value: depending on parameter (see table)
Table 8: Internal buzzer timing
No. Description Def.
$06 CFG_TempBuzz1_
OK
Internal buzzer, OK reading or key
pressed. In hundredths of second
$06
$07 CFG_TempBuzz1_
Fail
Internal buzzer, error (not used). In hun-
dredths of second
$78
$1F CFG_GreenLED_OK Green LED, correct reading. In tenths of
second.
$0A
$20 CFG_RedLED_Fail Red LED, wrong reading. In tenths of
second.
$14

FingerVein Integration Module (VIM)
Installation and Programming Manual
www.kimaldi.com Page 20 of 48
8. Communications Protocol
The communications protocol with the FingerVein VIM consists of two aspects:
• Frame format
• Instructions (OpCode + Arguments) and events.
Communications between the FingerVein VIM and the Host can be via several
communication channels and, in fact, the communications protocol will differ in each
case. ActiveX Kimaldi Bio-OCX (PrKBIOMAXctl) controls can be used, which
encapsulate all the details of the protocol and instructions.
8.1. Bio-OCX RS-232 frame format
If the serial port, the TCP/IP socket or an external converter (e.g. RS232-WiFi) is used,
the frames should be in the following format:
<STX><OPC><NA><ARG><CRC><ETX>
Where:
<STX>: [ 1 byte ] Indicates the start of the frame. It is the ASCII char-
acter 0x02.
<OPC>: [ 2 char ] This parameter indicates the meaning of the frame
and enables you to interpret the data it contains. It is a byte
value expressed by two hexadecimal ASCII characters (rang-
ing from '0' to '9' or from 'A' to 'F'), representing a hexadeci-
mal two-digit value.
<NA>: [ 4 char: ] This parameter indicates the number of bytes
encoded in the data field. It is a 16 bit value expressed by four
hexadecimal characters representing a hexadecimal four-digit
value.
<ARG>: [ 2 x NA char ] This contains the frame information. This
field will be made up of <NA> pairs of hexadecimal ASCII
characters representing each of the <NA> information bytes.
<CRC>: [ 2 char ] This field contains a byte value resulting from add-
ing all the ASCII values from the frame in module 255 except
for <STX>, <CRC> and <ETX>. Expressed by two hexadec-
imal ASCII characters.
<ETX>: [ 1 byte] This indicates the end of the frame. It is the ASCII
character 0x03