background image

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.

Summary of Contents for FingerVein

Page 1: ...tra Rub 292 B Pol Ind Can Guitard 08228 Terrassa Barcelona CIF B61802302 www kimaldi com Tel 937 361 510 Fax 937 361 511 E mail kimaldi kimaldi com Installation and Programming Manual FingerVein VIM I...

Page 2: ...er 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...

Page 3: ...CR 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 infor...

Page 4: ...l 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 electroni...

Page 5: ...rs 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...

Page 6: ...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 Su...

Page 7: ...nputs 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 t...

Page 8: ...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...

Page 9: ...ctor 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 F...

Page 10: ...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 P...

Page 11: ...tablished 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 chapte...

Page 12: ...nths 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...

Page 13: ...r 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 futu...

Page 14: ...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...

Page 15: ...ue 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 int...

Page 16: ...ronic 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 Optic...

Page 17: ...d 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 b...

Page 18: ...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 confi...

Page 19: ...nternal 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 triggere...

Page 20: ...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 expre...

Page 21: ...l four digit value The maximum supported length is 912 Data This contains the Extra Data information This field will be made up by Length pairs of hexadecimal ASCII charac ters representing each of th...

Page 22: ...es one node 8 2 3 Firmware Version Function returns the firmware version of the node Instruction OP 0x01 NA 0x0000 ARG None Response OP 0x01 NA 0x0000 ARG None Instruction OP 0x02 NA 0x0000 ARG None R...

Page 23: ...red in the non volatile memory after an exception has been generated 8 2 5 ClearCrashInfo Instruction OP 0x0E NA 0x0000 ARG None Response OP 0x0E NA 0x0000 or 0x0014 ARG If 0 arguments there is no ava...

Page 24: ...unction It reads the value of a configuration parameter stored in the non volatile memory See chapter 7 FingerVein VIM configuration 8 3 2 WriteCFG_Byte Instruction OP 0x0A NA 0x0001 ARG Byte 1 config...

Page 25: ...the initial factory configuration which is made up of two parts see chapter 7 IP parameters 8 3 4 ApplyCFG OP 0x0B NA 0x0001 ARG Byte 1 configuration parameter number see chapter 7 1 Instruction OP 0...

Page 26: ...rt other than 0000 is defined In general if this event is enabled it will be seen when the electronics is started even in the event of a restart due to an exception In the latter case information for...

Page 27: ...ming In this case an event is generated indicating the number of the relay to have returned to standby status 8 3 6 Switch Led Beeper Response OP 0x30 NA 0x0000 ARG None Event OP 0x30 NA 0x0002 ARG By...

Page 28: ...n the FingerVein VIM can notify the end of a timing In this case an event is generated indicating the number of the relay to have returned to standby status Response OP 0x31 NA 0x0000 ARG None Instruc...

Page 29: ...elay 8 3 9 Digital input status Instruction OP 0x41 NA 0x0002 ARG Byte 1 relay number to be enabled from 0 to 3 in DB module Byte 2 0x00 open 0x00 enabled closed Response OP 0x41 NA 0x0000 ARG None In...

Page 30: ...tify of the change in the digital input status via an event with the same OpCode 8 3 10 Multiread filter status Event OP 0x60 NA 0x0001 ARG Bit 0 Status of DIN 0 Bit 1 Status of DIN 1 Bit 2 Status of...

Page 31: ...eading Function It returns the code read by the card reader It may be made up of decimal ASCII characters from 0 to 9 or ASCII Hex from 0 to 9 and from A to F characters It may also include an indicat...

Page 32: ...is also announced via this event normally via code 0x41 A configurable 8 3 13 Send to UART Table 9 Key codes Key pressed Code assigned Numerical 0 to 9 0x30 to 0x39 0 to 9 Green key Enter 0x41 A Red k...

Page 33: ...s Function If the path of the optical barrier is blocked for some time or there is interference from an external light source this is communicated through OpCode 0x4B When the situation returns to nor...

Page 34: ...efore this instruction is useful to Activate biometric identification after reading a proximity card Force the fast recovery of the optical barrier after a biometric identification the normal recovery...

Page 35: ...press F1 or F2 prior to biometric identification 8 3 18 Encapsulate GCR Function it encapsulates instruction frames in GCR format Kreta Classic format These GCR instructions allow you to address the...

Page 36: ...ule VIM Installation and Programming Manual www kimaldi com Page 36 of 48 OpCode 0xFD Frame Delay resend later OpCode 0xFE Frame Error badly composed frame or argument out of range OpCode 0xFF Instruc...

Page 37: ...ts in the Encapsulate GCR command indicated in Subsection 8 3 18 9 1 Basic instructions 9 1 1 Recover sensor version Function It allows for the type of biometric sensor installed in the terminal and i...

Page 38: ...allows for the biometric sensor to be restarted Instruction 718 Description 718 Instruction code No argument Response 818rreeee Description 818 Response code rr Operation result Possible values 11 Ope...

Page 39: ...information present in the sensor to be obtained Instruction 713 Description 713 Instruction code No argument Response 813rr ExtraData hhh hhh Description 813 Response code rr Operation result Possib...

Page 40: ...n User identifier 0000000000 Reserved t Form of user registration Possible values 1 The biometric information travels in the Extra Data field of the frame This information has been captured beforehand...

Page 41: ...it allows for the biometric data of a user to be deleted from the sensor memory Instruction 715 Description 715 Instruction code No argument Response 815nnnn Description 815 Response code nnnn Number...

Page 42: ...nformation sent to be compared with the information displayed on the reader Instruction 561 Description 561 Instruction code None Response 661rr Description 661 Response code rr Operation result 11 Op...

Page 43: ...allows for a user whose biometric information is stored in the sensor memory to be identified Instruction 716 Description 716 Instruction code None Response 816rrqqnnnnnnnnnn Description 816 Response...

Page 44: ...en pin 5 IN0 and pin 2 GND of J1 on the control board RS 232 cable Connect an RS 232 cable with a female DB9 connector on one end and free wires on the other Connect free wires to J1 pin 2 GND pin 5 o...

Page 45: ...arameter configuration To configure the operating parameters for the terminal communicate with the terminal via any of its protocols and configure the following parameters Each of the previous values...

Page 46: ...sponse to instruction event Identification 4 Depending on the outcome of the identification you can decide whether to enable a relay or show the LEDs etc A 2 4 1 1 Identification In this type of ident...

Page 47: ...ntification We advise you to protect the FingerVein VIM against excessive light especially sunlight 2 FingerVein VIM electronics does not recognise the proximity card Ensure the following The reader i...

Page 48: ...nd KRD13M are products belonging to Kimaldi Electronics S L Version No Date Description Version 1 00 12 November 2009 First drafting for FW 0x65 30 Version 1 01 16 December 2009 Includes KiWi as DC DC...

Reviews: