background image

BioMax2 / KBio2-Online

Installation and Programming Manual

www.kimaldi.com

Page

 22 of 91

6. Comunicación con el Host

BioMax2

 and 

KBio2-Online

 electronics allows for several communication channels with

the Host. Establishing this communication is the first step towards correctly configuring
the electronics. 

BioMax2

 / 

KBio2-Online

 electronics is permanently listening to these

channels and will return a response via the channel from which the command was
received.

Configuration parameters discussed in this chapter will be:

• 

Parameter$0D

CFG_EventCH. 

It allows configuring the communications channel

that routes the initial events, before the first frame is received from the Host (for
instance, 

Key Pressing

). Default value: 

$FF

• 

Parameter$1A

CFG_Serial_Port_Host. 

Default value:

 

$91

• 

Parameter$1C

CFG_Serial_Port_Aux. 

Default value:

 

$F0

 (disabled).

The detailed programming model may be found on 

Table 3

 and 

chapter 8.1.

6.1. Communication with the Host via RS-232 

The UART0 port corresponds to communications with the Host via RS-232 by default.
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 9

).

From the 

CFG_Serial_Port_Host

 parameter, however, there are other alternatives:

• Communication speed can be configured to 9600, 19200, 38400 or 57600 baud. To

do so, the 

CFG_Serial_Port_Host

 byte should take the 

$90

$91

$92

 or 

$93

values respectively.

• Values other than those indicated above are used for many purposes, as will be seen

later. In these cases, the UART0 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 be done from this UART0 port. Whenever connecting to
the Host via UART0, it is advisable to suitably configure the 

$10

 parameter of the IP

configuration (see 

Subsection 8.2.1.

).

The 

CFG_EventCH

 parameter should take the 

$00

 value for the 

BioMax2 / KBio2-

Online

 electronics to spontaneously transmit Online frames through this channel.

The UART2 is enabled to maintain connectivity with the Host in configurations in which

CFG_Serial_Port_Host

 takes a value other than 

$90

$91

$92

, etc. Then,

CFG_Serial_Port_Aux

 automatically takes the 

$91

 value, which allows connection to

the Host in the event of emergencies (e.g. if you are unable to reconfigure IP
communications via the 

Kimaldi Localisation Service

). Given that the UART2 operates at

TTL levels, a USB adaptor cable supplied by Kimaldi is necessary.

Summary of Contents for BioMax2

Page 1: ...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 BioMax2 BiomaxP...

Page 2: ...Connection to a configurable RS 232 reader 17 5 3 Finger presence detection 17 5 3 1 Optical Barrier 17 5 3 2 FIM Module 18 5 3 3 Setup and operation 19 5 4 Connection to an auxiliary board Bio OCX pr...

Page 3: ...timing 41 8 1 6 Others 42 8 2 IP configuration TCP and UDP sockets 43 8 2 1 ePHY configuration 44 9 Communications Protocol 46 9 1 Bio OCX RS 232 or TCP IP frame format 46 9 2 Bio OCX UDP frame forma...

Page 4: ...elete all users 71 10 4 User identification 72 10 4 1 Instant Matching 72 10 4 2 1 N Identification 72 10 4 3 1 1 Identification 73 Appendix A Application Notes 74 A 1 BioMax2 FP Mag Mifare 74 A 1 1 H...

Page 5: ...iFi communications It is possible to add the BiomaxPlus DB device intended for Semi Offline access control That is the system switches to Offline mode whenever communication with main Host is lost Tha...

Page 6: ...pad One 2x20 character alphanumeric backlit display connector One card mounted buzzer Four digital inputs Connection to Optical Barrier One socket for KiWi2 Converter UART0 or BioMaxPlus DB UART2 2 2...

Page 7: ...open 24V 1A Digital inputs 4 relay type digital inputs In open circuit contact open their logic value will be 0 In contact with GND contact closed logic value 1 Clock Data Inputs 2 ports for Clock Da...

Page 8: ...n its logic value will be 0 In contact with GND contact closed logic value 1 Clock Data Input 1 port for Clock Data reader ABA Track 2 encoding 3 3 Addressing BioMax2 and KBio2 Online electronics have...

Page 9: ...onics board requires 5 Vdc supply 1 2 3 4 5 6 7 8 1 2 3 4 5 6 7 8 8 7 6 5 4 3 2 1 8 7 6 5 4 3 2 1 J3 5 vcc GND N C N C N C N C Host Rx Host Tx J4 DIN_0 DIN_1 DIN_2 DIN_3 GND LED_0 LED_1 BUZZER J2 RELE...

Page 10: ...Pin 2 Pole B of Relay 0 Pin 3 Pole A of Relay 1 Pin 4 Pole B of Relay 1 Pin 5 Pole A of Relay 2 Pin 6 Pole A of Relay 2 Pin 7 Pole A of Relay 3 Pin 8 Pole B of Relay 3 J4 Digital Input Output connecto...

Page 11: ...ector of the receiving phototransistor Pin 4 Emitter GND of the receiving phototransistor P2 Display Contrast adjustment potentiometer JP1 JP2 Jumpers to select KSP Application_ID see Subsection 6 3 2...

Page 12: ...2 KBio2 Online Installation and Programming Manual www kimaldi com Page 12 of 91 Pin 5 GND Pin 6 5VDC input output only for KiWi2 BioMaxPlus DB 4 3 Mechanical Outline BioMax2 Measurements in mm J1 J2...

Page 13: ...onnector signals KBio2 Online WARNING Take the necessary antistatic precautions when handling this product to avoid damaging the sensitive electronic devices KBio2 electronics board requires 5 Vdc sup...

Page 14: ...Reader NdCAN compatible 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 Negative power supply pole GND J4 Connection to FIM biometric identification mo...

Page 15: ...ion_ID see Subsection 6 3 1 LEDs showing the electronics status LD1 3V3 supply operating LD2 Rx Tx Instructions or Events between BioMax2 and the Host computer LD3 Red Ethernet Link Error LD4 Green Et...

Page 16: ...statement applies to KBio2 Online In both cases several types of use are allowed Host based template database 1 to N identification 1 N the user places his or her finger on top of the biometric sensor...

Page 17: ...3 1 Auto On funcion Newer FIM versions FIM 5360 and later provide an Auto Identify function based on an embedded capacitive sensor This is going to be the default detection method for BioMax2 and KBio...

Page 18: ...capacitive sensors that can be attached to the FIM5360 module and later If two FIM devices are connected to a single BioMax2 or KBio2 Online the same detection mechanism can be used In order to activa...

Page 19: ...f a finger is presented during the boot up period an Optical Barrier Status event showing status FC will appear After boot up Auto On starts automatically If we force Enable optical barrier we get its...

Page 20: ...Kimaldi Electronics offers the BiomaxPlus DB module which provides an offline behaviour so that it acts as a back up host when the main one is out of reach The BioMax2 BiomaxPlus DB assembly is commer...

Page 21: ...sing faults in the hardware and for remote firmware updating 5 6 1 Information on exceptions If an exception occurs in the operation of the microcontroller the information on it is stored in the non v...

Page 22: ...format generated by the Bio OCX controller see chapter 9 From the CFG_Serial_Port_Host parameter however there are other alternatives Communication speed can be configured to 9600 19200 38400 or 5760...

Page 23: ...For further information on the low level protocol please see the SLK Programming Manual 6 2 2 Bio OCX protocol via TCP TCP Server The Bio OCX protocol is also available via a TCP Socket which makes i...

Page 24: ...ame format will be used that will allow us to specify the node at KSP level The frames are received at the BioMax2 KBio2 Online electronics via port 6000 Remote Port from the Host One significant adva...

Page 25: ...the configuration byte The jumpers take logic value 1 when the bridge is on and 0 if not The BioMax2 KBio2 Online electronics reads the configuration of the jumpers on receiving the power supply There...

Page 26: ...elf depending on the particular needs of the installation The Bio OCX controller allows a simple operation with the FIM modules We must also configure the following parameters Parameter 1B UART1 confi...

Page 27: ...to the baud rate The maximum length of the frame is 48 bytes Connection via UART1 is established after configuring the Parameter 1B CFG_Serial_Port_Reader to the value 40 41 or 42 according to the ba...

Page 28: ...ver IP 7 3 3 Communication via Bio OCX UDP When using Bio OCX protocol over UDP port 5500 on BioMax2 KBio2 We contact the peripheral electronics via Send to UART Answers and events are collected throu...

Page 29: ...r communication However a more convenient method exists Our BioMax2 KBio2 board has a KSP address see Subsection 6 3 2 made of an Application_ID between 11 and 14 plus Node_ID between 1 and 254 For in...

Page 30: ...02 Guard time in tenths of a second between finger detection events See Subsection 8 1 3 03 Watchdog in tenths of a second for the detection of the permanent blocking of the optical barrier See Subsec...

Page 31: ...1A Determines the protocol and Baud Rate assigned to the UART0 See Table 3 See Subsection 8 1 1 1B Determines the protocol and Baud Rate assigned to the UART1 See Table 3 See Subsection 8 1 1 1C Deter...

Page 32: ...module for Offline behaviour add on 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 valu...

Page 33: ...00 baud 89 19200 baud 8A 38400 baud 8B 57600 baud Transparent frames no formatting considerations UART0 up to 912 bytes UART1 up to 912 bytes RS 232 Card Reader Automatic Mode 40 9600 baud 41 19200 ba...

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

Page 35: ...BioMax2 KBio2 responde siempre por el mismo canal de donde procede la instrucci n Sin embargo existen situaciones t picamente despu s de Reset donde no existe una instrucci n previa y por tanto debemo...

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

Page 37: ...f 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 pres...

Page 38: ...before TTL_0 is in front of the data received via TTL_0 Bit 7 before TTL_1 is in front of the data received via TTL_1 Default value 0x8C TTL_0 TTL_1 enabled before TTL_1 TTL_0 without prefix Paramete...

Page 39: ...when an incorrect reading has occurred Bit 0 LSB Internal buzzer enabled for UART0 Bit 1 Internal buzzer enabled for UART1 Bit 2 Internal buzzer enabled for TTL_0 Bit 3 Internal buzzer enabled for TT...

Page 40: ...bsection 9 6 18 Permitted values The time out value should exceed the reading repetition time Default value 0x28 Null Card Reading event 4 seconds after the last correct reading Parameter 0F Wiegand c...

Page 41: ...lay is written on Write Display the backlighting will be automat ically enabled Permitted values 0xFF Permanently enabled 0x01 0xFE Timing in tenths of a second 0x00 Timing disabled Default value depe...

Page 42: ...bled the inter nal buzzer CFG_Temp Buzz_Fail will be triggered Permitted values 0xFF Permanently enabled 0x01 0xFE Timing in multiples of 10 milliseconds 0x00 Timing disabled Default value depending o...

Page 43: ...ts value is 00001 the BioMax2 KBio2 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 fr...

Page 44: ...gh which TCP communications Bio OCX protocol via TCP TCP Server or KSP TCP communications KSP protocol via TCP TCP client will be established Its default value is 0000 so that the enabled protocol is...

Page 45: ...ts 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 of the electronics will be faster Conne...

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

Page 47: ...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 48: ...AppID NodeID KSP_Opc Len Lbl OPC ARG Where AppID 1 byte Application identifier see Subsection 6 3 2 NodeID 1 byte Node identifier see Subsection 6 3 2 KSP_Opc 1 byte Its value is F8 for the data fram...

Page 49: ...sections 9 4 KSP TCP frame format If the BioMax2 KBio2 Online electronics 6600 IP port is used the frames should be in the following format AppID NodeID KSP_Opc Len Lbl OPC ARG That is the frame is i...

Page 50: ...ode 9 5 2 Reset Function Initialises one node 9 5 3 Firmware Version 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 51: ...ion It reads the information stored in the non volatile memory after an exception has been generated 9 5 5 ClearCrashInfo Instruction OP 0x0E NA 0x0000 ARG None Response OP 0x0E NA 0x0000 or 0x0014 AR...

Page 52: ...value of a configuration parameter stored in the non volatile memory See chapter 8 BioMax2 KBio2 Online electronics configuration 9 6 2 WriteCFG_Byte OP 0x0F NA 0x0000 ARG None Instruction OP 0x0A NA...

Page 53: ...e value of an IP configuration parameter stored in the non volatile memory See chapter 8 BioMax2 KBio2 Online electronics configuration 9 6 4 WriteCFG_IP Response OP 0x0B NA 0x0001 ARG Byte 1 configur...

Page 54: ...restores the initial factory configuration which is made up of two parts see chapter 8 IP parameters ARG Byte 1 IP parameter number see section 8 2 Byte 2 n parameter value Response OP 0x0D NA 0x0001...

Page 55: ...f the CFG_EventCH parameter is correctly configured and in the event of communications via UDP if a remote port other than 0000 is defined In general if this event is enabled it will be seen when the...

Page 56: ...g In this case an event is generated indicating the number of the relay to have returned to standby status Instruction OP 0x30 NA 0x0002 ARG Byte 1 0x00 Green LED 0x01 Red LED 0x02 external beeper 0x0...

Page 57: ...ff 9 6 9 Close Relay Instruction OP 0x31 NA 0x0002 ARG Byte 1 0x00 Green LED 0x01 Red LED 0x02 external beeper 0x03 internal beeper Byte 2 0x00 off 0x00 on Response OP 0x31 NA 0x0000 ARG None Instruct...

Page 58: ...f a timing In this case an event is generated indicating the number of the relay to have returned to standby status 9 6 10 Switch Relay Function Closes or opens designated relay Event OP 0x40 NA 0x000...

Page 59: ...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 CFG_TempBacklit see section 8 1 Instruction OP 0x10 NA...

Page 60: ...klighting during the specified time 9 6 14 Switch Backlit Function It permanently enables or disabled the Display backlighting Instruction OP 0x12 NA 0x0001 ARG Byte 1 enabling time 0x00 to 0xFE tenth...

Page 61: ...e electronics are also specified 9 6 16 Digital input status Instruction OP 0x14 NA 0x002A ARG Byte 1 Backlit time from 0x00 to 0xFE tenths of a sec Byte 2 Timing of the internal buzzer from 0x00 to 0...

Page 62: ...n notify of the change in the digital input status via an event with the same OpCode 9 6 17 Multiread filter status Event OP 0x60 NA 0x0001 ARG Bit 0 Status of DIN 0 Bit 1 Status of DIN 1 Bit 2 Status...

Page 63: ...d 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 indicative prefix of the reader to have read the card see...

Page 64: ...o be sent from the Host to the RS232 reader via the UART of the BioMax2 KBio2 Online electronics Table 12 Key codes Key pressed Code assigned Numerical 0 to 9 0x30 to 0x39 0 to 9 Green key Enter 0x41...

Page 65: ...nce from an external light source this is communicated through OpCode 0x4B When the situation returns to normal the same OpCode with Arg 0x0D indicates this See Subsection 5 3 2 and the explanation of...

Page 66: ...G UI_OPT_T_GUARD Byte of the configuration see Subsection 8 1 3 or is indefinitely suspended using the Disable optical barrier instruction 9 6 24 Disable optical barrier Function Disables the detectio...

Page 67: ...rVein sensor identification functions see chapter 10 Biometric identification for further details 9 7 Error Codes BioMax2 KBio2 Online electronics can also respond to any of the instructions it is sen...

Page 68: ...ameter 1E associated to commands 72x must be properly configured that is with a value of 04 or 05 If the available FIM module does not support Auto On detection the following instructions may still be...

Page 69: ...2 nn Optional argument specifies the number of templa tes to scan 01 or 02 If no argument one tem plate is scanned when in FIM30 emulation mode and two scans when in FIM20 emulation mode Response 813...

Page 70: ...t Template destination Possible values 1 2 3 Send template to Main FIM 1 to Auxiliary FIM 2 or to both 3 hhh hhh Biometric information of the user to be registered Only used where t 1 t 2 t 3 This in...

Page 71: ...the biometric data of all users to be deleted from the sensor s database as well as from BiomaxPlus DB If two FIM modules are connected information is deleted from both with no other choices available...

Page 72: ...information to use in the comparison Response 817rrqq 827rrqq Description 817 Response code Intermediate digit addresses Main FIM 1 or auxiliary 2 rr Operation result Possible values 00 Incorrect mat...

Page 73: ...se biometric information is stored in the sensor s database to be identified In 1 1 identification the user s scanned fingerprint is compared against one single template that corresponds to the provid...

Page 74: ...a detallar podr a corresponder al acceso principal de un club deportivo Cada socio del club tiene una tarjeta de acceso que hist ricamente era de banda magn tica pero que actualmente se est migrando...

Page 75: ...ta a Tx del KRD13M pin 4 del bornero Tx UART0 desde Pin 8 J3 conecta a Rx del KRD13M pin 3 del bornero M dulo biom trico FIM Conectar directamente a J7 UART1 Barrera ptica Conectar directamente a J8 R...

Page 76: ...r el puerto serie Table 13 Ejemplo de configuraci n de lectores N mero par m Nombre del par metro Valor Detalles 1A CFG_PuertoSerieHost 40 KRD13M a 9600 baud 1B CFG_PuertoSerieLector 8A FIM a 38400 ba...

Page 77: ...PT_KeyCode 2 Suspendemos el funcionamiento de la barrera ptica para impedir que genere nue vos avisos durante el proceso de identificaci n Desactivar barrera ptica 3 Generamos el mensaje oportuno a tr...

Page 78: ...erar la huella del usuario que se ha identificado Deberemos convertir la huella a formato FIM HV 404 bytes Si la huella est disponible iniciamos el proceso de verificaci n 4 Suspendemos el funcionamie...

Page 79: ...a plantear la siguiente situaci n Un terminal BioMax2 FP Prox con conectividad IP al Host Un terminal KBio Online conectado al Host a trav s de la BioMax2 En esta aplicaci n el punto de acceso requier...

Page 80: ...Hembra A 2 2 Device configuration En primer lugar hay que establecer comunicaci n con el equipo Esto se consigue a trav s del Kimaldi Localisation Service Existe un programa Demo que nos puede servir...

Page 81: ...al que se manda en Extra Data es en Hexadecimal y a partir de ETB incluido 172662000400000020 La trama entera UDP 5100010087172662000400000020 La Response del terminal KBio nos llegar de la siguiente...

Page 82: ...de Node_ID por defecto que se puede modificar a trav s del par metro de configuraci n IP KSP Address_Low La parte alta de la direcci n KSP Application_ID se deriva de los jumpers JP1 y JP2 See chapte...

Page 83: ...GET_FIRMWARE_VERSION2 a KBio en formato KSP UDP trama entera 4D01F8034251001726620019 7E000000040000000000000000000000000000000000000004 A 3 Wiegand Reception Starting on FW version x61 41 60 on BioMa...

Page 84: ...bits format The Wiegand 26 bit format allows a user ID which contains 6 ASCII Hex characters That is to say user ID codes numbered between 0000000001 and 0000FFFFFE will be admitted Data format is as...

Page 85: ...t might exist are also included in the Card Reading data No parity check is performed so caution must be taken if the incoming data is to be used for access control or other applications where securit...

Page 86: ...X UDP is used to contact several BioMax2 KBio2 Online electronics at the same time the Host will require a different port for each one In this case configure the Host port in the Port RemoteHost field...

Page 87: ...r fingerprint identification as well 4 BioMax2 KBio2 Online electronics does not recognise the proximity card Ensure the following The reader is correctly connected to the BioMax2 KBio2 Online electro...

Page 88: ...eives an instruction from the Host This limitation can be solved by using the KSP UDP protocol as the event is then transmitted via the Host s 6001 port from any KSP node In the case of Bio OCX TCP ev...

Page 89: ...ronics board by means of the KSearch application at least when the Broadcast response is selected If the ETH_LINK LED is on the physical link could not be achieved Then Try replacing the Ethernet cabl...

Page 90: ...values 45 Table 12 Key codes 64 Table 13 Ejemplo de configuraci n de lectores 76 Table 14 Ejemplo de configuraci n de KRD13M 76 Table 15 Ejemplo de configuraci n con KBio auxiliar 80 Revision Control...

Page 91: ...ncourage reuse recycling and other ways of recovery and to prevent possible damage to the environment and personal health Go to a recycling plant to dispose of this product If in doubt contact your di...

Reviews: