1. Manuals
  2. Brands
  3. Kimaldi Manuals
  4. Control Unit
  5. FingerVein
  6. Installation and programming manual

Kimaldi FingerVein Installation And Programming Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Installation and
Programming Manual
FingerVein - VIM
Integration Module
v. 1.01
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 and is the answer not in the manual?

Questions and answers

Summary of Contents for Kimaldi FingerVein

  • Page 1 Installation and Programming Manual FingerVein - VIM Integration Module v. 1.01 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

    7. FingerVein VIM configuration ........
  • Page 3 Table of Contents 8.3. Specific FingerVein VIM instructions ......24 8.3.1. ReadCFG_Byte ......... 24 8.3.2.

  • Page 4: About This Manual

    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.

  • Page 5: Operation

    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”...

  • Page 6: Information On Exceptions

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

  • Page 7: Technical Specifications

    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”...

  • Page 8: Optical Barrier

    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 Subsection 7.1.3.

  • Page 9: Installation

    J3: C&D Reader J2: Fr. Panel 1 2 3 WARNING! FingerVein sensor requires +12 Vdc supply. Control electronics require +5 Vdc supply (provided from J7). Take the necessary antistatic precautions when handling this product to avoid damaging the sensitive electronic devices.

  • Page 10: Connection Details

    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.

  • Page 11: Host Communications

    FingerVein Integration Module (VIM) Installation and Programming Manual 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.

  • Page 12: Fingervein Vim Configuration

    FingerVein Integration Module (VIM) Installation and Programming Manual 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.
  • Page 13 FingerVein Integration Module (VIM) Installation and Programming Manual Time-out in tenths of a second of the multiread fil- Subsection Refer to tering, to detect that a card has left the reading 7.1.4. field. Configures the communications channel through Subsection Refer to which the event frames are sent.

  • Page 14: Serial Port Configuration

    CFG_ReaderSerialPort $BB: 57600 baud 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 4: Event configuration Description Def.
  • Page 15 - 0xFF: Automatic time-out. Byte : 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.

  • Page 16: Optical Barrier Configuration

    FingerVein Integration Module (VIM) Installation and Programming Manual 7.1.3. Optical barrier configuration Table 6: Optical barrier configuration Description Def. Time-out between finger detection events CFG_OPT _T_GUARD Watchdog for permanent blockage detection CFG_OPT _T_WDOG The optical barrier will generate a Key Pressing...

  • Page 17: Card Reading Port Configuration

    FingerVein Integration Module (VIM) Installation and Programming Manual Byte : Optical Key Code. The presence of a finger blocking the optical barrier Key Pressing will generate an event equivalent to a . The key code is configurable, although we recommend comparing finger presence to the pressing of the green key.
  • Page 18 Installation and Programming Manual Byte : 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.

  • Page 19: Digital Output Timing

    FingerVein Integration Module (VIM) Installation and Programming Manual Permitted values: - The time-out value should exceed the reading repetition time. Default value: Card Reading - 0x28: event 4 seconds after the last correct reading. 7.1.5. Digital output timing The timings of the internal buzzer can be configured:...

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

  • Page 21: Common Instructions For Online Management

    255 ( hexadecimal ASCII characters. 8.2. Common Instructions for Online Management We will first present the instructions that work with any electronics equipped with the Bio-OCX protocol: BioMax, FingerVein VIM, KBio, Serie-xR Card. 8.2.1. Communications Test Instruction 0x00 0x0000 None.

  • Page 22: Reset

    8.2.3. Firmware Version Instruction 0x02 0x0000 None Response 0x02 0x0002 Identification code of the firmware version. Byte 1: FW Major (0x6D for FingerVein VIM) Byte 2: FW Minor Function: returns the firmware version of the node. www.kimaldi.com Page 22 of 48...

  • Page 23: 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. 8.2.5. ClearCrashInfo Instruction...

  • Page 24: Specific Fingervein Vim Instructions

    FingerVein Integration Module (VIM) Installation and Programming Manual Function: It deletes the information stored in the non-volatile memory after an exception has been generated. 8.3. Specific FingerVein VIM instructions 8.3.1. ReadCFG_Byte Instruction 0x0A 0x0001 Byte 1: configuration parameter number (see chapter 7.1)

  • Page 25: Factorycfg

    FingerVein Integration Module (VIM) Installation and Programming Manual 0x0B 0x0001 Byte 1: configuration parameter number (see chapter 7.1) Function: Writes configuration stored in non-volatile memory. See chapter 7.: “FingerVein VIM configuration” 8.3.3. FactoryCFG Instruction 0x08 0x0000 or 0x0001 Byte 1: 0x00: machine parameters 0x01: IP configuration >...

  • Page 26: 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 27: Switch Led/Beeper

    Byte 2: always 0x00 If bit 5 of CFG_ECHO is enabled (see Subsection ), the FingerVein VIM 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 28: Close Relay

    Byte 2: always 0x00 If bit 5 of CFG_ECHO is enabled (see Subsection ), 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.

  • Page 29: Switch Relay

    FingerVein Integration Module (VIM) Installation and Programming Manual 8.3.8. 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 30: Multiread Filter Status

    Bit 3: Status of DIN 3 Subsection If bit 4 of the CFG-DB_ECHO is enabled (see ), the FingerVein VIM can notify of the change in the digital input status via an event with the same OpCode. 8.3.10. Multiread filter status...

  • Page 31: Card Reading

    FingerVein Integration Module (VIM) Installation and Programming Manual Function: It allows for the status of the card reader to be questioned to confirm whether there is a card in the field that it is being filtered in multiread mode. If there is no card in the reader field, it will return just one argument byte.

  • Page 32: Send To Uart

    FingerVein Integration Module (VIM) Installation and Programming Manual Function: Returns key code pressed for Online management according to the following table: Table 9: Key codes Key pressed Code assigned Numerical ( 0 to 9 ) 0x30 to 0x39 (‘0’ to ‘9’) Green key (“Enter”)

  • Page 33: Reception From Uart

    FingerVein Integration Module (VIM) Installation and Programming Manual Function: Encapsulates a frame to be sent from the Host to the RS232 reader via the UART2-UI of the FingerVein VIM. 8.3.14. Reception from UART Event 0x83 0x0001 Byte 1: 0x02 Extra Data...

  • Page 34: Enable Optical Barrier

    FingerVein Integration Module (VIM) Installation and Programming Manual 8.3.16. Enable optical barrier Instruction 0x4A 0x0000 None Response 0x4A 0x0001 Status of the optical barrier Function: 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.

  • Page 35: Encapsulate Gcr

    FingerVein sensor identification functions (see chapter 9.: “Biometric identification” for further details). 8.4. Error Codes FingerVein VIM can also respond to any of the instructions it is sent with one of the following codes: www.kimaldi.com Page 35 of 48...
  • Page 36 FingerVein Integration Module (VIM) Installation and Programming Manual • OpCode 0xFD: Frame Delay (resend later). • OpCode 0xFE: Frame Error (badly-composed frame or argument out of range). • OpCode 0xFF: Instruction Error ( invalid OpCode). www.kimaldi.com Page 36 of 48...

  • Page 37: Biometric Identification

    FingerVein Integration Module (VIM) Installation and Programming Manual 9. Biometric identification The FingerVein-VIM 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 8.3.18.

  • Page 38: Recover Last Sensor Error

    FingerVein Integration Module (VIM) Installation and Programming Manual 9.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 39: Capture Of Biometric Information

    FingerVein Integration Module (VIM) Installation and Programming Manual 9.2. Capture of biometric information 9.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 40: Sensor Memory Management

    FingerVein Integration Module (VIM) Installation and Programming Manual 9.3. Sensor memory management 9.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 41: Request Number Of Users

    FingerVein Integration Module (VIM) Installation and Programming Manual 9.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 42: Delete All Users

    FingerVein Integration Module (VIM) Installation and Programming Manual 9.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 43: Identification

    FingerVein Integration Module (VIM) Installation and Programming Manual 9.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.

  • Page 44: Appendix A. Application Notes

    Therefore, users can either identify themselves directly (1:N) or present theirRFID card, which encodes the member number. The FingerVein VIM controls a two-way turnstile so that access to the building involves LED signaling and exit from the building involves pressing a button.

  • Page 45: Terminal Configuration

    FingerVein Integration Module (VIM) Installation and Programming Manual • 12 volt, 1 amp power supply for the VIM: - Connect the terminal power supply jack. • Biometric module: - Directly connect to the J4 - UART1 connector • RFID reader with Clock&Data output (ABA-Track2 compatible): - Directly connect to J3 - C&D input .

  • Page 46: 1:N Identification

    FingerVein Integration Module (VIM) Installation and Programming Manual A.2.3. 1:N Identification In this type of identification, the scanned biometric information is compared with the entire biometric information database stored in the terminal. The approximate sequence of the process will be: Key Pressing 1.

  • Page 47: Appendix B. Troubleshooting

    - There is too much ambient light on the biometric sensor. This light stops the opti- cal barrier from working correctly and probably also stops the FingerVein sen- sor from making a correct identification. We advise you to protect the FingerVein VIM against excessive light, especially sunlight.

  • Page 48: List Of Tables

    Tabla 1: FingerVein VIM parameter list ....... . 12 Tabla 2: RS-232 port configuration .

Table of Contents