background image

FingerVein Online

Installation and Programming Manual

www.kimaldi.com

Page

 33 of 69

character 0x03

To speed up data transmission to the serial ports (e.g. for biometric data transmission),
the UDP frames have the Extra Data field that encodes the end of the frame:

<OPC><NA><ARG><CRC><ETB>[Length][Data]<CRC>

<ETB>

:

 Extra Data start indicator (

End Transmission Block

, ASCII 

$17

).

[Length]

: [ 4 char: ] This parameter indicates the number of bytes that 

are encoded in the Extra Data data field. It is a 16 bit value 
expressed by four hexadecimal characters representing a hex-
adecimal 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 the 

[Length]

 information bytes.

<CRC>:

[ 1 byte ] This field contains a byte value resulting from add-
ing all the ASCII values of

[Length]

 and 

[Data] in mod-

ule 255 (

 <ETB> is not included). Expressed by two 

hexadecimal ASCII characters.

9.2. Bio-OCX UDP frame format 

If the FingerVein Online electronics 5500 IP port is used, the frames should be in the
following format:

<OPC><NA><ARG><CRC>

Where:

<OPC>: 

[ 2 char ] This parameter indicates the meaning of the frame 
and enables you to interpret the data it contains. It is a binary 
byte.

<NA>:

 

[ 4 char: ] This parameter indicates the number of bytes that 
are encoded in the data field. It is a 16 bit value expressed in 
binary format.

<ARG>: 

[ 2 x NA char ] This contains the frame information. This 
field will be made up of <NO> bytes with information 
directly encoded in binary format.

<CRC>:

[ 2 char ] This field contains a byte value resulting from add-
ing the rest of the bytes of the frame in module 255 except for 
<CRC>.

Summary of Contents for FingerVein Online

Page 1: ...cs S L Ctra 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 FingerVe...

Page 2: ...alisation Service 14 6 1 2 Bio OCX protocol via TCP 14 6 1 3 Bio OCX protocol via UDP 15 6 1 4 KSP protocol via UDP 15 6 2 Routing and Localisation 16 6 2 1 Routing hardware 16 6 2 2 KSP Address 16 6...

Page 3: ...r Time 41 9 5 8 Switch Led Beeper 42 9 5 9 Close Relay 43 9 5 10 Switch Relay 44 9 5 11 Clear Display 44 9 5 12 Write Display 45 9 5 13 Backlit Time 45 9 5 14 Switch Backlit 46 9 5 15 Write Display Ba...

Page 4: ...0 4 1 Instant Matching 59 10 4 2 Identification 60 Appendix A Application notes 61 A 1 FingerVein Online Mag Mifare electronics 61 A 1 1 Hardware Connection 61 A 1 2 Terminal configuration 62 A 1 3 KR...

Page 5: ...Kimaldi Bio OCX controller the latter method being recommended 2 1 FingerVein Online electronics Internally FingerVein Online electronics is organised in two subelectronics capable of segregating in...

Page 6: ...line Installation and Programming Manual www kimaldi com Page 6 of 69 One 2x20 alphanumeric character backlit display connector One card mounted buzzer Up to six digital inputs One KiWi2 Converter con...

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

Page 8: ...es a function for diagnosing faults in the hardware and for remote firmware updating 3 3 1 Information on exceptions If an exception occurs in the operation of the microcontroller the information on i...

Page 9: ...Internal buzzer operates together with the main reader and keypad 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 RS232...

Page 10: ...lectronic fault Under normal conditions 2 or 3 consecutive identification attempts can be made without removing your finger from the biometric sensor before this error is triggered This parameter can...

Page 11: ...ELAY 2 B RELAY 3 A RELAY 3 B RELAY 4 A RELAY 4 B J2 5V out GND Tx 232 UI 2 Rx 232 UI 2 DIN_1 DIN_2 DIN_3 DIN_4 1 2 3 4 5 6 7 8 1 2 3 4 5 6 7 8 J14 TTL 0 1 J16 Keypad J17 Display J12 FingerVein J15 DIN...

Page 12: ...ay 1 Pin 2 Pole B of Relay 1 Pin 3 Pole A of Relay 2 Pin 4 Pole B of Relay 2 Pin 5 Pole A of Relay 3 Pin 6 Pole A of Relay 3 Pin 7 Pole A of Relay 4 Pin 8 Pole B of Relay 4 J5 Connection to KiWi modul...

Page 13: ...ND disabled if not connected Jumpers Application_ID Encoded with two jumpers The default value is 3 Back up Battery this is a 3V lithium battery size CR2032 If a low battery level is detected we recom...

Page 14: ...FingerVein Online electronics connected to your local area network using the Kimaldi Localisation Service IP configuration once the unit is located from its MAC Address it is possible to configure it...

Page 15: ...t 5500 Remote Port from the Host The frame format will be binary and will not have the STX ETX delimiters The CFG DB_EventsChannel parameter should take the 07 value for the FingerVein Online Electron...

Page 16: ...Online electronics reads the configuration of the jumpers on receiving the power supply Therefore if the address is to be changed the power supply should be switched off for a moment or and an ApplyCF...

Page 17: ...ing process that multiread filtering can be applied and that in any case a Card Reading event will be generated Subsection 8 1 4 shows that the data is processed in the same way whether it is from a C...

Page 18: ...3M Online mode and SC6000 mode T 0 capable of handling reading and writing data on a Mifare card or ISO 7816 chip respectively The data frames are sent via the Send to UART instruction The responses a...

Page 19: ...meter array All the machine s parameters are listed below Table 1 FingerVein Online parameter list No Description Further informa tion 01 Defines the events reported to the Host in DB module Refer to...

Page 20: ...ications channel through which the event frames are sent In DB module Refer to Subsection 8 1 2 0E Time out before starting the biometric sensor Refer to Subsection 8 1 2 0F to 13 Reserved 14 Time out...

Page 21: ...igned are detailed in the following table 20 Time in tenths of a second to indicate incorrect reading with the red LED Refer to Subsection 8 1 5 21 Time in tenths of a second to indicate correct readi...

Page 22: ...line serial readers e g SC6000 or KRD13M in Online mode CFG UI_AuxSerial Port 88 9600 baud 89 19200 baud 8A 38400 baud 8B 57600 baud Mode without format totally transparent Only UART2 UI RS 232 card r...

Page 23: ...al 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 s...

Page 24: ...e 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...

Page 25: ...tted values 0x00 0xFF Any although we recommend an alphanumerical value Default value 0x41 A is equivalent to the pressing of the green Enter key 8 1 4 Card reading port configuration Byte 08 Reader E...

Page 26: ...configuration for correct readings We can enable the buzzer assembled on the FingerVein Online electronics internal so that it is enabled when a correct reading has occurred Permitted values Bit 0 LSB...

Page 27: ...efines 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 Online electronics generates a Card Reading event with a...

Page 28: ...of 10 milliseconds 0x00 Timing disabled Default value depending on parameter see table 8 1 6 Others Byte 14 Display time out Time out in cycles after writing on the Display Permitted values 0xFF defa...

Page 29: ...s value is 00001 the FingerVein Online electronics will automatically respond to the Host port originating the frame 08 SLK Safety if the most significant bit is at 1 only TCP IP communications from t...

Page 30: ...for the type of Ethernet connection available for our electronics to be consulted and specified in advance 1F KSPPort RemoteHost Four BCD digits that indicate the Host port through which communication...

Page 31: ...is the most common speed The improvements introduced with this parameter are visible for the following cases 10 BaseT with no self negotiation capacity value 01 can be set manually and initialisation...

Page 32: ...232 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 indicat...

Page 33: ...presenting each of the Length information bytes CRC 1 byte This field contains a byte value resulting from add ing all the ASCII values of Length and Data in mod ule 255 ETB is not included Expressed...

Page 34: ...ppID NodeID KSP_Opc Len Lbl OPC ARG Where AppID 1 byte Application identifier see Subsection 6 2 2 NodeID 1 byte Node identifier see Subsection 6 2 2 KSP_Opc 1 byte Its value is F8 for the data frames...

Page 35: ...oller supplied by Kimaldi prKSPdll The programming interface of this controller is low level and it must be sent a chain made up by the OpCode and the instruction arguments OPC ARG as detailed in the...

Page 36: ...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 Response OP 0x02...

Page 37: ...erated 9 4 5 ClearCrashInfo Function It deletes the information stored in the non volatile memory after an exception has been generated Instruction OP 0x0E NA 0x0000 ARG None Response OP 0x0E NA 0x000...

Page 38: ...r 8 FingerVein Online electronics configuration 9 5 2 WriteCFG_Byte Instruction OP 0x0A NA 0x0001 ARG Byte 1 configuration parameter number see chapter 8 1 Response OP 0x0A NA 0x0002 ARG Byte 1 config...

Page 39: ...alue of an IP configuration parameter stored in the non volatile memory See chapter 8 FingerVein Online electronics configuration 9 5 4 WriteCFG_IP Instruction OP 0x0C NA 0x0001 ARG Byte 1 IP paramete...

Page 40: ...G Function It restores the initial factory configuration which is made up of two parts see chapter 8 IP parameters 9 5 6 ApplyCFG NA 0x0001 ARG Byte 1 IP parameter number see chapter 8 2 Instruction O...

Page 41: ...port 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 f...

Page 42: ...timing In this case an event is generated indicating the number of the relay to have returned to standby status 9 5 8 Switch Led Beeper Response OP 0x30 NA 0x0000 ARG None Event OP 0x30 NA 0x0002 ARG...

Page 43: ...ein Online electronics 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 Instr...

Page 44: ...designated relay 9 5 11 Clear Display Function Deletes the information from the Display Instruction OP 0x41 NA 0x0002 ARG Byte 1 relay number to be enabled from 0 to 3 in DB module Byte 2 0x00 open 0x...

Page 45: ...ly backlit during the time specified by CFG_TempBacklit see chapter 8 1 9 5 13 Backlit Time Function It enables the display backlighting during the specified time Instruction OP 0x11 NA 0x0028 ARG Byt...

Page 46: ...15 Write Display Backlit Instruction OP 0x13 NA 0x0001 ARG Byte 1 0x00 off 0x00 on Response OP 0x13 NA 0x0000 ARG None Instruction OP 0x14 NA 0x002A ARG Byte 1 Backlit time from 0x00 to 0xFE tenths of...

Page 47: ...al inputs 0 to 3 If the bit is at 0 the input is in open circuit If the bit is at 1 the input is shorted to GND If bit 4 of the CFG DB_ECHO is enabled see Subsection 8 1 2 the FingerVein Online electr...

Page 48: ...include an indicative prefix of the reader to have read the card see Subsection 8 1 4 9 5 18 Card Reading Function It returns the code read by the card reader It may be made up of decimal ASCII chara...

Page 49: ...s of failure of the operation If the multiread filter is enabled a code based on special characters e g for TTL_0 can be obtained to indicate that the card has been removed from the reader 9 5 19 Key...

Page 50: ...the Host to the RS232 reader via the UART2 UI of the FingerVein Online electronics 9 5 21 Reception from UART Function Encapsulates a frame to be sent to the Host from the RS232 reader via the UART2...

Page 51: ...ction Enables the detection LED of the optical barrier This command can be used to allow for biometric identification simply by placing a finger on the sensor The optical barrier is self managed by de...

Page 52: ...reasons for using this instruction When the scanning of a finger print has started to prevent new warnings In the case of 1 1 identification the user is expected to start identification using the pro...

Page 53: ...the different FingerVein sensor identification functions see chapter 10 Biometric identification for further details 9 6 Error Codes FingerVein Online electronics can also respond to any of the instru...

Page 54: ...s in the Encapsulate GCR command indicated in Subsection 9 5 25 10 1 Basic instructions 10 1 1 Recover sensor version Function It allows for the type of biometric sensor installed in the terminal and...

Page 55: ...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 Operation...

Page 56: ...ation 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 Possible valu...

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

Page 58: ...ows 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 of use...

Page 59: ...tion 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 Operatio...

Page 60: ...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 code r...

Page 61: ...identification is biometric Therefore users can either identify themselves directly 1 N or present their old magnetic band card or new Mifare card which encodes the member number in its block number 1...

Page 62: ...n can be used to configure the Ethernet parameters of the terminal which mean that all the terminals available in an operating network can be located and configured Operating parameter configuration T...

Page 63: ...rt Table 14 Reader configuration example Param number Parameter name Value Details 1B CFG UI_SerialPortReader BB FingerVein at 57600 baud 1C CFG UI_PortSerialHost 40 KRD13M at 9600 baud 08 CFG UI_Read...

Page 64: ...rminal identifies the user using its internal database After a few seconds the identifier of the identified user is received via the response to instruction event Identification 5 Depending on the out...

Page 65: ...RT0 port stops interacting with the Host and the UART2 automatically takes its place In cases where the use of adapter cards for other protocols is required e g WiFi TCP IP and Bluetooth etc this will...

Page 66: ...rent port for each one In this case con figure the Host port in the Port RemoteHost field Value 0 configures the suita ble port automatically with the limitation that it does not generate events until...

Page 67: ...moteHost parameter indicated in chapter 8 2 In the case of Bio OCX UDP the Host IP port must also be known This will be port 5501 by default Nevertheless if several FingerVein Online electronics are b...

Page 68: ...gerVein Online electronics via TCP IP If the IP filter is not enabled see SLK Safety in chapter 8 2 the FingerVein Online electronics will generate rejection frames to each request Enable the Remote H...

Page 69: ...63 Revision Control Notes FingerVein is a product belonging to Hitachi Omron Terminal Solutions Corp KiWi Ethernet KiWi Wifi and KRD13M are products belonging to Kimaldi Electronics S L Version No Da...

Reviews: