Table of Contents

Advertisement

Quick Links

Installation and
Programming Manual
FingerVein Online
v. 1.00
Kimaldi Electronics, 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

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the FingerVein Online and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Kimaldi FingerVein Online

  • Page 1 Installation and Programming Manual FingerVein Online v. 1.00 Kimaldi Electronics, S.L. www.kimaldi.com Ctra. Rubí, 292-B Pol.Ind. Can Guitard Tel: 937 361 510 Fax: 937 361 511 08228 Terrassa (Barcelona) CIF B61802302 E-mail: kimaldi@kimaldi.com...
  • Page 2: Table Of Contents

    4.1. FingerVein Online card ........
  • Page 3 9.4.5. ClearCrashInfo ......... 37 9.5. Specific FingerVein Online electronics instructions ... . . 38 9.5.1.
  • Page 4 Appendix A. Application notes ........61 A.1. FingerVein Online + Mag + Mifare electronics ....61 A.1.1.
  • Page 5: About This Manual

    In particular, biometrical identification will be performed on a search engine integrated into the FingerVein module itself. FingerVein Online electronics may be controlled with serial commands or with the help of the Active-X, Kimaldi Bio-OCX controller, the latter method being recommended.
  • Page 6 FingerVein Online Installation and Programming Manual • One 2x20 alphanumeric character, backlit display connector • One card-mounted buzzer • Up to six digital inputs • One KiWi2 Converter connection card www.kimaldi.com Page 6 of 69...
  • Page 7: Operation

    Installation and Programming Manual 3. Operation Thanks to its IP connectivity, FingerVein Online electronics makes it possible to install a network of biometric sensors or different types of card readers, accompanied by the corresponding actuators or user interfaces. All the peripherals are Host-managed, except for the biometric search engine, which is housed inside the FingerVein sensor itself.
  • Page 8: Others

    FingerVein Online Installation and Programming Manual 3.3. Others Another basic aspect of FingerVein Online electronics is the configuration of its interface chapter 6.: “Host with the Host. It has several communication channels, as described in communications” All the aspects related to the operating and connectivity of FingerVein Online electronics chapter 8.: “FingerVein Online electronics...
  • Page 9: Technical Specifications

    FingerVein Online Installation and Programming Manual 4. Technical Specifications 4.1. FingerVein Online card Dimensions: OEM cards: 134 mm x 131 mm x 25 mm Stainless steel terminal box: 142 mm x 209 mm x 82 mm; Weight 1.5 kg. Terminal in plastic box : 160 mm x 220 mm x 65 mm ;...
  • Page 10: Routing

    4.3. Optical barrier FingerVein Online electronics allows for an optical barrier to detect the presence of the finger on the biometric sensor to be controlled. In addition to normal operating conditions, the optical barrier has two possible error situations: 1.- Permanent obstruction of the beam.
  • Page 11: Installation

    FingerVein Online Installation and Programming Manual 5. Installation 5.1. Connector signals Anti-Tamper UART1-UI 8 7 6 5 4 3 2 1 4 3 2 1 UART2-UI J12: FingerVein J17: Display J15: DIN_1-UI J14: TTL-0 J16: Keypad UART2-DB J5: KiWi J7: Ethernet...
  • Page 12: Connection Details

    FingerVein Online Installation and Programming Manual 5.2. Connection details J2 - Main Connector Pin 1 - Do not connect Pin 2 - Negative power supply pole (GND) (Pin no. 5 SubD connector) Pin 3 - Signal Tx 232 to host (Pin no. 2 SubD female connector) or to the Auxiliary User Interface (UI) Pin 4 - Signal Rx 232 to host (Pin no.
  • Page 13 FingerVein Online Installation and Programming Manual Pin 2 - UART1-UI - Tx 232 signal to reader Pin 3 - UART1-UI - Rx 232 signal to reader Pin 4 - Power supply negative pole (GND) J14 - TTL_0 Connector to card Reader:...
  • Page 14: Host Communications

    Sockets. 6.1.1. Kimaldi Localisation Service It is possible to detect the 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 its IP parameters and restart the unit.
  • Page 15: Bio-Ocx Protocol Via Udp

    , parameter 7) and that is 0 by default (automatic assignment). • The frames are received at the FingerVein Online electronics via port 5500 (Remote Port from the Host). The frame format will be binary and will not have the delimiters.
  • Page 16: Routing And Localisation

    Programming Manual). 6.2.1. Routing hardware In terms of Hardware, the FingerVein Online electronics has two jumpers (JP2 and JP1; chapter 5.1.: “Connector signals” ) to encode the high part (Application_ID) of the bus address. Its low part is encoded through a byte in the configuration.
  • Page 17: Communication With Rs-232 Devices

    FingerVein Online Installation and Programming Manual 7. Communication with RS-232 devices FingerVein Online electronics has two RS-232 ports that can be used for different purposes. As explained in Appendix A.2 , the UART1-DB maintains the possibility of connection to the Host so that total compatibility between BioMax, FingerVein Online electronics and FingerVein Online is ensured.
  • Page 18: Online Readers

    7.1.3. Online readers Finally, readers can be connected totally Online. In this case, FingerVein-OnLine electronics is totally transparent and generated events cannot be assimilated to an identification code. Kimaldi readers can be connected KRD13M (Online mode) and SC6000 (mode T=0),...
  • Page 19: Fingervein Online Electronics Configuration

    • IP configuration: data required for machine operations in a local area network (Ethernet). FingerVein Online electronics 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.
  • Page 20 FingerVein Online Installation and Programming Manual Configuration byte of the automatic beeper ena- Subsection Refer to bling after a correct Clock&Data reading. 8.1.4. Configuration byte of the automatic beeper ena- Subsection Refer to bling after an incorrect Clock&Data reading. 8.1.4.
  • Page 21: Serial Port Configuration

    FingerVein Online Installation and Programming Manual Time, in tenths of a second, to indicate incorrect Subsection Refer to reading with the red LED. 8.1.5. Time, in tenths of a second, to indicate correct Subsection Refer to reading with the buzzing of the external beeper.
  • Page 22: Event Configuration

    7.1 Subsection 8.1.4. 8.1.2. Event configuration FingerVein Online electronics has the capacity 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 4: Event configuration Description Def.
  • Page 23: Table 5: Event Channel Identifier

    Default value: - 0xFF: Automatic time-out. Byte : Event Channel. Normally, the FingerVein Online electronics 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.
  • Page 24: Optical Barrier Configuration

    FingerVein Online Installation and Programming Manual Default value: - 0xFF: Events are not generated until the Host has started communicating. Note that a spontaneous TCP/IP output cannot be defined. 8.1.3. Optical barrier configuration Table 6: Optical barrier configuration Description Def.
  • Page 25: Card Reading Port Configuration

    FingerVein Online Installation and Programming Manual 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.
  • Page 26 - 0x8C: TTL_0 enabled. Byte : Buzzer on OK. Buzzer 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): Internal buzzer enabled for UART2-UI.
  • Page 27: Digital Output Timing

    : 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 Online electronics generates a Card Reading event with a null identification value (refer to Subsection 9.5.18.
  • Page 28: Others

    Permitted values: - 0xFF: default value. This is a very conservative Time-out. - 0x0F: recommended value if the display is not connected to the FingerVein Online electronics (the default value, 0xFF, slows down the operation of the electronics in this case).
  • Page 29: Ip Configuration - Tcp And Udp Sockets

    - IP-Context: Four bytes, specifying the IP context. This parameter is maintained for compatibility with other Kimaldi products. - Port-RemoteHost: Two bytes, encoding four BCD digits, which indicate the Host port with which communication with the FingerVein Online electronics is to be established ( Bio-OCX protocol via UDP ).
  • Page 30: Ephy Configuration

    FingerVein Online electronics will wait for Acknowledgement from the Host during TCP_TimeOut seconds. After this time, the frame will be resent up to 3 times. After 3 failed retries, the FingerVein Online electronics will close the TCP/IP socket. This same parameter controls the KeepAlive frame of the FingerVein Online electronics:...
  • Page 31: Table 11: Ephy Configuration Values

    FingerVein Online Installation and Programming Manual Table 11: ePHY configuration values Ethernet negotiation CFG_ePHY Ethernet connection disabled Allows all cases (default value) Self-negotiation, 100 BaseT Self-negotiation, 10 BaseT Manual negotiation, 100 BaseT Manual negotiation, 10 BaseT The normal operation of this parameter is as follows: 1.
  • Page 32: Communications Protocol

    • Frame format • Instructions (OpCode + Arguments) and events. Communications between the FingerVein Online electronics 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.
  • Page 33: Bio-Ocx Udp Frame Format

    <ETB> is not included). Expressed by two ule 255 ( 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: [ 2 char ] This parameter indicates the meaning of the frame <OPC>:...
  • Page 34: Ksp Udp Frame Format

    This contains the information [Data] [Length] directly expressed in binary format. 9.3. KSP UDP frame format If the FingerVein Online electronics 6000 IP port is used, the frames should be in the following format: <AppID><NodeID><KSP_Opc><Len><Lbl><OPC><ARG> Where: Subsection 6.2.2. [ 1 byte ] Application identifier (see <AppID>:...
  • Page 35: Common Instructions For Online Management

    The KSP protocol is quite complex and it is therefore advisable to use the controller 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, , as detailed in the following sections.
  • Page 36: Reset

    9.4.3. Firmware Version Instruction 0x02 0x0000 None Response 0x02 0x0002 Identification code of the firmware version. Byte 1: FW Major (0x65 for FingerVein Online electronics) Byte 2: FW Minor Function: returns the firmware version of the node. www.kimaldi.com Page 36 of 69...
  • Page 37: Getcrashinfo

    0x0E 0x0000 or 0x0014 If 0 arguments, there is no available information. If 20 arguments: Bytes 1..20: information for Kimaldi Electronics. Function: It reads the information stored in the non-volatile memory after an exception has been generated. 9.4.5. ClearCrashInfo Instruction...
  • Page 38: Specific Fingervein Online Electronics Instructions

    FingerVein Online Installation and Programming Manual 9.5. Specific FingerVein Online electronics instructions 9.5.1. ReadCFG_Byte Instruction 0x0A 0x0001 Byte 1: configuration parameter number (see chapter 8.1) Response 0x0A 0x0002 Byte 1: configuration parameter number (see chapter 8.1) >Byte 2: parameter value Function: It reads the value of a configuration parameter stored in the non-volatile chapter 8.: “FingerVein Online electronics configuration”...
  • Page 39: Readcfg_Ip

    8.2) Byte 2. n : parameter value Function: It reads the value of an IP configuration parameter stored in the non-volatile memory. See chapter 8.: “FingerVein Online electronics configuration” 9.5.4. WriteCFG_IP Instruction 0x0D > 0x0001 Byte 1: IP parameter number (see chapter 8.2)
  • Page 40: Factorycfg

    0x0001 Byte 1: IP parameter number (see chapter 8.2) Function: It writes an IP configuration parameter, storing it in the non-volatile memory. chapter 8.: “FingerVein Online electronics configuration” 9.5.5. FactoryCFG Instruction 0x08 0x0000 or 0x0001 Byte 1: 0x00: machine parameters 0x01: IP configuration >...
  • Page 41: Activate Led/Beeper Time

    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 the Kimaldi Electronic Technical Service will be obtained.
  • Page 42: Switch Led/Beeper

    If bit 5 of CFG_ECHO is enabled (see Subsection 8.1.2. ), the FingerVein Online electronics can indicate the end of a timing. In this case, an event is generated indicating the number of the relay to have returned to standby status.
  • Page 43: Close Relay

    If bit 5 of CFG_ECHO is enabled (see Subsection 8.1.2. ), the FingerVein 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.
  • Page 44: Switch Relay

    FingerVein Online Installation and Programming Manual 9.5.10. Switch Relay Instruction 0x41 0x0002 Byte 1: relay number to be enabled (from 0 to 3 in DB module) Byte 2: 0x00: open. <>0x00: enabled (closed) Response 0x41 0x0000 None Function: Closes or opens designated relay.
  • Page 45: Write Display

    FingerVein Online Installation and Programming Manual 9.5.12. Write Display Instruction 0x11 0x0028 Bytes 1 to 20: Text on the first row Bytes 21 to 40: Text on the second row Response 0x11 0x0000 None Function: It shows the specified text via the display in 2 rows of 20 characters. At the same time, the display is automatically backlit during the time specified by chapter 8.1...
  • Page 46: Switch Backlit

    FingerVein Online Installation and Programming Manual 9.5.14. Switch Backlit Instruction 0x13 0x0001 Byte 1: 0x00: off. <>0x00: on Response 0x13 0x0000 None Function: It permanently enables or disabled the Display backlighting. 9.5.15. Write Display, Backlit Instruction 0x14 0x002A Byte 1: Backlit time (from 0x00 to 0xFE tenths of a sec.)
  • Page 47: Digital Input Status

    Installation and Programming Manual Function: It shows the specified text via the display in 2 rows of 20 characters. The timing of the backlighting and the buzzer assembled in the FingerVein Online electronics are also specified. 9.5.16. Digital input status...
  • Page 48: Multiread Filter Status

    FingerVein Online Installation and Programming Manual 9.5.17. Multiread filter status Instruction 0x61 0x0001 Byte 1: 0: Status of UART_0 (only if it is configured as serial reader) 1: Status of UART_1 (only if it is configured as serial reader) 2: Status of TTL_0...
  • Page 49: Key Pressing

    FingerVein Online Installation and Programming Manual characters. It may also include an indicative prefix of the reader to have read the card Subsection 8.1.4. (see If the reading was erroneous, the frame is returned with 0 arguments. This will enable the Host to act on the LEDs or the Beeper to inform users of the success of failure of the operation.
  • Page 50: Send To Uart

    Frame sent to the RS232 reader from the Host Response 0x51 0x0000 Function: Encapsulates a frame to be sent from the Host to the RS232 reader via the UART2-UI of the FingerVein Online electronics. 9.5.21. Reception from UART Event 0x83 0x0001...
  • Page 51: Optical Barrier Status

    FingerVein Online Installation and Programming Manual 9.5.22. Optical Barrier Status Event 0x4B 0x01 Status code of the optical barrier 0x0D: Back to normal 0xED: Interference or blocking of the optical barrier 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 x4B.
  • Page 52: Disable Optical Barrier

    FingerVein Online Installation and Programming Manual Subsection 8.1.3. configuration, see or is indefinitely suspended using the Disable optical barrier instruction). 9.5.24. Disable optical barrier Instruction 0x4C 0x0000 None Response 0x4C 0x0001 Status of the optical barrier Function: Disables the detection LED of the optical barrier There are several reasons for using this instruction: •...
  • Page 53: Error Codes

    “Biometric identification” for further details). 9.6. Error Codes FingerVein Online electronics can also respond to any of the instructions it is sent with one of the following codes: • OpCode 0xFD: Frame Delay (resend later). • OpCode 0xFE: Frame Error (badly-composed frame or argument out of range).
  • Page 54: Biometric Identification

    FingerVein Online Installation and Programming Manual 10. Biometric identification The FingerVein-OnLine electronics protocol provides a set of high-level instructions to simply handle the biometric sensor. The following instructions will be used as arguments in the Encapsulate GCR command Subsection 9.5.25.
  • Page 55: Recover Last Sensor Error

    FingerVein Online Installation and Programming Manual 10.1.2. Recover last sensor error Instruction ‘718’ Description ‘718’ Instruction code. No argument. Response ‘818rreeee’ Description ‘818’ Response code ‘rr’ Operation result. Possible values: 11 - Operation completed correctly. ‘eeee’ Code of the last recorded error.
  • Page 56: Capture Of Biometric Information

    FingerVein Online Installation and Programming Manual 10.2. Capture of biometric information 10.2.1. Capture of biometric information Instruction ‘713’ Description ‘713’ Instruction code. No argument. Response ‘813rr’ - ExtraData: ‘hhh...hhh’ Description ‘813’ Response code ‘rr’ Operation result. Possible values: 11 - Operation completed correctly.
  • Page 57: Sensor Memory Management

    FingerVein Online Installation and Programming Manual 10.3. Sensor memory management 10.3.1. Add user Instruction ‘564nnnnnnnnnn0000000000t’ - ExtraData: “hhh...hhh” Description ‘564’ Instruction code. ‘nnnnnnnnnn’ User identifier. ‘0000000000’ Reserved. ‘t’ Form of user registration. Possible values: ‘1’- The biometric information travels in the Extra-Data field of the frame.
  • Page 58: Request Number Of Users

    FingerVein Online Installation and Programming Manual 10.3.2. Request number of users Instruction ‘715’ Description ‘715’ Instruction code. No argument. Response ‘815nnnn’ Description ‘815’ Response code ‘nnnn’ Number of users stored in the sensor memory. Function: it allows for the number of users stored in the sensor memory to be requested.
  • Page 59: Delete All Users

    FingerVein Online Installation and Programming Manual 10.3.4. Delete all users Instruction ‘561’ Description ‘561’ Instruction code. None Response ‘661rr’ Description ‘661’ Response code ‘rr’ Operation result. 11 - Operation completed correctly. Function: it allows for the biometric data of all users to be deleted from the sensor memory.
  • Page 60: Identification

    FingerVein Online Installation and Programming Manual 10.4.2. Identification Instruction Description ‘716’ Instruction code. None Response 816rrqqnnnnnnnnnn Description ‘816’ Response code ‘rr’ Operation result. 11 - Correct identification. ‘qq’ Quality of information scanning. ‘nnnnnnnnnn’ Identifier of the identified user. Function: it allows for a user whose biometric information is stored in the sensor memory to be identified.
  • Page 61: Appendix A. Application Notes

    Mifare card, which encodes the member number in its block number 1. The FingerVein Online electronics controls a two-way turnstile so that access to the building involves a display and exit from the building involves pressing a button.
  • Page 62: Terminal Configuration

    FingerVein Online Installation and Programming Manual Table 13: FingerVein + Mifare Pinout connections Signal KRD13Mv2 FingerVein 5Vdc Pin 1 of terminal J2 Pin 4 of terminal J10 Pin 2 of terminal J2 Pin 3 of terminal J10 Rx - Tx...
  • Page 63: Krd13Mv2 Reader Configuration

    FingerVein Online Installation and Programming Manual Table 14: Reader configuration example Param. Parameter name Value Details number FingerVein, at 57600 CFG-UI_SerialPortReader baud KRD13M, at 9600 CFG-UI_PortSerialHost baud Readers enabled: CFG-UI_Reader_ Enable - UART2: prefix ‘$’ - TTL0: prefix ‘*’ Beeper for correct CFG-UI_Reader_ BuzOK card readings.
  • Page 64: 1:N Identification

    FingerVein Online Installation and Programming Manual Each of the above instructions will be sent to the reader as follows: Send to UART • Instruction: • Argument: Byte 1 = (i.e. transmission to UART2-UI) • Extra Data: - Via Bio-OCX: ‘>>0A060001000100091B’...
  • Page 65: Communication With The Host Via Rs-232

    Host in the event of emergencies (e.g. if you are unable to reconfigure IP Kimaldi Localisation Service communications via the ). Given that the UART2-DB operates at TTL levels, a USB adaptor cable supplied by Kimaldi is necessary. www.kimaldi.com Page 65 of 69...
  • Page 66: Appendix B. Troubleshooting

    - The Host to contact the FingerVein Online electronics is displayed in the Remote Host.field - The Host contacts the FingerVein Online electronics via its 5501 port in the case of Bio-OCX UDP and via its 6001 port in the case of UDP-KSP.
  • Page 67 Installation and Programming Manual 3. FingerVein Online electronics does not recognise the proximity card Ensure the following: - The reader is correctly connected to the FingerVein Online electronics, either via chapter 5.1.: “Connector signals” the Clock&Data or the RS-232. See - In the case of the UART2-UI, check that their configuration parameters are cor- Subsection 8.1.1.
  • Page 68 ). If the display is not connected, the time-out value may be lowered: 0x0F is an advisable value. - A computer is trying to communicate with FingerVein Online electronics via TCP/IP. If the IP filter is not enabled (see SLK-Safety in chapter 8.2...
  • Page 69: List Of Tables

    List of Tables Table 1: FingerVein Online parameter list ......19 Table 2: RS-232 port configuration .

Table of Contents