Installation and Programming Manual BioMax2 English
Installation and Programming Manual BioMax2 English
Programming Manual
BioMax2 / BiomaxPlus
KBio2-Online
v. 2.11
Table of Contents
1. About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2. Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1. BioMax2 electronics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.2. KBio2-Online electronics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3. Technical Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.1. BioMax2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2. KBio2-Online . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.3. Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4. Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.1. Connector signals, BioMax2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4.2. Connection details, BioMax2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4.3. Mechanical Outline, BioMax2 . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
4.4. Connector signals, KBio2-Online . . . . . . . . . . . . . . . . . . . . . . . . . 13
4.5. Connection details, KBio2-Online . . . . . . . . . . . . . . . . . . . . . . . . . 14
4.6. Mechanical Outline, KBio2-Online . . . . . . . . . . . . . . . . . . . . . . . . 15
5. Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.1. Connection of a FIM module . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.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 protocol . . . . . . . . . . . 20
5.5. BiomaxPlus-DB module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5.6. Others . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
5.6.1. Information on exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
5.6.2. Remote FW update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .21
6. Comunicación con el Host . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
6.1. Communication with the Host via RS-232 . . . . . . . . . . . . . . . . . . 22
6.2. IP Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.2.1. Kimaldi Localisation Service . . . . . . . . . . .. .. . .. . . . . . . . . . . .23
6.2.2. Bio-OCX protocol via TCP (TCP Server) . . .. .. . .. . . . . . . . . . . .23
6.2.3. Bio-OCX protocol via UDP . . . . . . . . . . . . .. .. . .. . . . . . . . . . . .24
6.2.4. KSP protocol via UDP . . . . . . . . . . . . . . . .. .. . .. . . . . . . . . . . .24
6.2.5. KSP protocol via TCP (TCP-client) . . . . . . .. .. . .. . . . . . . . . . . .24
6.3. Routing and Localisation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
6.3.1. Routing hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
6.3.2. KSP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
6.3.3. MAC Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
6.3.4. IP Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
This manual applies to BioMax2 and KBio2-Online access and presence control
electronics, firmware versions 0x61.43 and 0x62.43 respectively.
2. Description
1. Nitgen’s eNSearch and eNBSP libraries are available for that purpose.
www.kimaldi.com Page 5 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 6 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
3. Technical Specifications
3.1. BioMax2
Size: OEM board: 134 mm x 106 mm x 25 mm
Supply Voltage: 5 VDC. ± 10%
www.kimaldi.com Page 7 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
3.3. Addressing
BioMax2 and KBio2-Online electronics have two jumpers (JMP1 and JMP2) to encode
the ID Application in the KSP protocol.
See chapter 6.3.: “Routing and Localisation” for further details.
1. The LED optical barrier has been discontinued on devices featuring FIM5360 or equivalent.
See section 5.3 for further information
www.kimaldi.com Page 8 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
4. Installation
Lector Rx
Lector Tx
RELE 3-B
RELE 2-B
RELE 1-B
RELE 0-B
RELE 3-A
RELE 2-A
RELE 1-A
RELE 0-A
+5V Out
DATA_1
CLK_1
CLS_1
J1
J2
GND
GND
8 7 6 5 4 3 2 1 8 7 6 5 4 3 2 1
J10: Display
J7: FIM Connector
J9: TTL-0
P2: Contrast
J8: Opt. Bar.
J14: KiWi2
J6: Keypad
JP1
JP1, JP2 JP2
LEDs LD1
LD2
LD3
LD4
1 2 3 4 5 6 7 8 1 2 3 4 5 6 7 8
BUZZER (-)
LED_0 (+)
LED_1 (+)
Host Rx
Host Tx
DIN_0
DIN_1
DIN_2
DIN_3
5 vcc
GND
J3
J4
GND
N.C.
N.C.
N.C.
N.C.
WARNING !!!!
BioMax2 electronics board requires +5 Vdc supply
Take the necessary antistatic precautions when handling this product
to avoid damaging the sensitive electronic devices.
www.kimaldi.com Page 9 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 10 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
In addition, Keypad and Display connections are available for the OEM version of the
equipment:
J6: 4x4 Keypad connector
Pin 1 - Column 3 (OUT) Pin 5 - Row 0 (IN)
Pin 2 - Column 2 (OUT) Pin 6 - Row 1 (IN)
Pin 3 - Column 1 (OUT) Pin 7 - Row 2 (IN)
Pin 4 - Column 0 (OUT) Pin 8 - Row 3 (IN)
J10: Connector to 20x2 Display, with incorporated Backlit
J14 - Connector/socket for KiWi2 Converter (UART0):
Pin 1 - No Connect
Pin 2 - No Connect
Pin 3 - UART_0 - Tx 232 signal to Host
Pin 4 - UART_0 - Rx 232 signal to Host
www.kimaldi.com Page 11 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Pin 5 - GND
Pin 6 - 5VDC input/output (only for KiWi2, BioMaxPlus-DB).
J1 J2
J3 J4
Measurements in mm.
www.kimaldi.com Page 12 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
J7: KiWi2
J4: FIM
LEDS
J3: TTL-0
J2: Keypad
JP1
1 2 3 4 5 6 7 JP2
J1
WARNING !!!!
KBio2 electronics board requires +5 Vdc supply
Take the necessary antistatic precautions when handling this product
to avoid damaging the sensitive electronic devices.
www.kimaldi.com Page 13 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 14 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
J1
+5V GND TX RX
IN0 RELE0
POWER IN HOST
Measurements in mm.
www.kimaldi.com Page 15 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
5. Operation
1. Offline behaviour is allowed when the search engine is located in the FIM. Typically, the
offline mode is enhanced by means of the BiomaxPlus-DB auxiliary board. See section 5.5
www.kimaldi.com Page 16 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 17 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
flash to indicate this. In this situation, you must press the green key (“Enter”) to initiate
biometric identification.
It will automatically return to normal when the beam of light is no longer obstructed or
the external interference is removed (event Optical Barrier Status, code 0x0D).
In order to activate this detection method, it is necessary to configure the following
parameters:
• Parameter$03 (CFG_Opt_T_Watchdog): it allows activation of the LED optical
barrier. So:
- LED operation: $80 (LED optical barrier on, obstruction timeout to 12.8 sec.).
If a second FIM module is connected, a special cable assembly allows using a Digital
Input to detect finger presence.
www.kimaldi.com Page 18 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Optical barrier
The LED optical barrier will operate immediately, and it will be promptly generate a Key
Pressing event as soon as the infra-red beam is blocked. Any key value may be
announced, as configured through Parameter$05 (CFG_OPT_KeyCode). Its default
value is $41 (‘A’ : green key).
Upon finger detection, operation is suspended during a guard time period, which is
configured through Parameter$02 (CFG_OPT_T_GUARD). Such guard time may be
overridden from the application by disabling the optical barrier prior to communication
with the FIM module (Disable optical barrier). When done, re-enable operation (Enable
optical barrier) to resume detection.
FIM Auto-On
Automatic finger detection by the biometric sensor is a more complex process:
- Upon startup, a boot-up time is required for the FIM module. We may configure
such value through Parameter$0E (CFG_IDNT_-BOOTUP_TIME). The
recommended value depends on the FIM model and the database capacity.
- If 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 current status in response. Value $00 is the correct operation status,
while $FD means that boot-up operation did not end correctly, so Auto-On is
not available. That can be due to a communication error (baudrate mismatch,
broken cable...) or to an old version of FIM that does not support this feature.
- Finger detection occurs when the finger is placed on the surface of the sensor. If
there is no clear perception of change (for instance, if the finger does is not
removed between one failed identification and the next retry), the finger is not
detected. Therefore, it is necessary to remove and re-place the finger for each
identification that we try. Upon detection, a Key Pressing event appears. The
value of the pressed key is configurable through Parameter$05 (CFG_
OPT_KeyCode), and its default value is $41 (‘A’ : green key).
- Upon finger detection, operation is suspended during a guard time period, which
is configured through Parameter$02 (CFG_OPT_T_GUARD). Such guard time
may be overridden from the application by disabling the optical barrier prior to
communication with the FIM module (Disable optical barrier). When done, re-
enable operation (Enable optical barrier) to resume detection.
www.kimaldi.com Page 19 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
- If Auto-On could not be enabled, an Optical Barrier Status event appears every
time we contact the FIM module through Send to UART.
- If two FIM modules are connected to BioMax2, both may activate the Auto-On
mechanism. In such case, the key value that is reported by the auxiliary FIM is
one count higher than the one of the main FIM (by default, values $41 for the
main FIM and $42 for the auxiliary FIM are used, corresponding to green and
red keys on the BioMax2 keypad).
www.kimaldi.com Page 20 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Commands are available to switch between Online and Offline mode and vice-versa:
SetModeOnline and SetModeOffline.
In order for the system to operate properly, the Host must periodically send the
SetModeOnline command to BioMaxPlus, so that it keeps its online operating status.
Time between such frames must be lower than the one configured on Parameter$13.
5.6. Others
Another basic aspect of BioMax2 and KBio2-Online electronics is the configuration of
its interface with the Host. It has several communication channels, as described in
chapter 6.: “Comunicación con el Host”
All the aspects related to the operating and connectivity of BioMax2 and KBio2-Online
electronics can be configured as explained in chapter 8.: “BioMax2 / KBio2-Online
electronics configuration” .
It also incorporates a function for diagnosing faults in the hardware and for remote
firmware updating.
www.kimaldi.com Page 21 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
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.
www.kimaldi.com Page 22 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
6.2. IP Communications
To access the IP communication services, the network parameters must be configured
correctly. Configuration can be carried out using the Bio-OCX protocol, via RS-232. In
this case, we shall deal with the parameters described in section 8.2. Alternatively, the
Kimaldi Localisation Service detailed below can be used. Once the equipment is
configured, there will be one TCP/IP Socket and two different protocols via UDP
Sockets.
www.kimaldi.com Page 23 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 24 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
The CFG_EventCH parameter should take the $0C value for the BioMax2 / KBio2-
Online Electronics to spontaneously transmit Online frames through this channel.
6.3.4. IP Address
The IP address of each BioMax2 / KBio2-Online electronics will be user-assigned based
on the characteristics of the local area to which it is connected. This is generally a
configuration field, which can be user-modified through the Kimaldi Localisation Service
or any service for connection to the Host (see all configuration fields in section 8.2).
www.kimaldi.com Page 25 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
BioMax2 and KBio2-Online electronics have two RS-232 ports that can be used for
different purposes.
As explained in chapter 6.1, UART0 maintains the possibility of connection to the Host
so that total compatibility between BioMax and BioMax2 is ensured. However,
communication to Host will normally occur through the IP ports, so that UART1 and
usually UART0 will be available for connection to peripheral RS-232 devices.
To date, these devices will be of the following types:
1. We may also connect the FIM module to UART0, but then we must use Terminal Block J3
(BioMax2), and configure Parameter$1A CFG_Serial_Port_Host to $8A, and Parameter$1D to $04.
www.kimaldi.com Page 26 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 27 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
<OPC><NA_high><NA_low><ARG_0><ARG_1>....<ARG_NA><CRC>
<OPC><NA><ARG_0><ARG_1>....<ARG_NA><CRC>
www.kimaldi.com Page 28 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 29 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 30 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
$0C Time-out in tenths of a second of the multiread fil- See Subsection 8.1.4.
tering, to detect that a card has left the reading
field.
$0D Configures the communications channel through See Subsection 8.1.2.
which the event frames are sent.
$0E FIM Boot-Up time
$0F Configure TTL_x ports as Wiegand Inputs See Subsection 8.1.4.
$10 Reserved
a
$11
$12 Host reply Time-Out, upon event generated by See Subsection 5.5.
BioMax2 / KBio2-Online, before switching to
Offline Mode
$13 No-traffic Time-Out, before switching to Offline See Subsection 5.5.
Mode
$14 Display response Time-Out See Subsection 8.1.6.
$15 Reserved
to
$19
$1A Determines the protocol and Baud Rate assigned See Subsection 8.1.1.
to the UART0. See Table 3.
$1B Determines the protocol and Baud Rate assigned See Subsection 8.1.1.
to the UART1. See Table 3.
$1C Determines the protocol and Baud Rate assigned See Subsection 8.1.1.
to the UART2. See Table 3.
$1D Enables main FIM with Auto-On detection See Subsection 8.1.3.
$1E Enables auxiliary FIM with Auto-On detection See Subsection 8.1.3.
$1F Time, in tenths of a second, to indicate correct See Subsection 8.1.5.
reading with the green LED.
$20 Time, in tenths of a second, to indicate incorrect See Subsection 8.1.5.
reading with the red LED.
$21 Time, in tenths of a second, to indicate correct See Subsection 8.1.5.
reading with the buzzing of the external beeper.
$22 Time, in tenths of a second, to indicate incorrect See Subsection 8.1.5.
reading with the buzzing of the external beeper.
$23 Reserved for future uses.
www.kimaldi.com Page 31 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
The behaviour of the serial ports is defined from the $1A, $1B and $1C configuration
parameters:
Table 2: RS-232 port configuration
$1A CFG_Serial_ Determines the protocol and Baud Rate assigned $91
Port_Host to the UART0. Refer to Table 3
$1B CFG_Serial_ Determines the protocol and Baud Rate assigned $88 a
Port_Reader to the UART1. Refer to Table 3
$1C CFG_Serial_ Determines the protocol and Baud Rate assigned $F0
Port_Aux to the UART2. Refer to Table 3
a. OEM electronic boards are configured at 9600 baud by default. BioMax2 terminals (already
assembled) are configured at the optimum speed for the FIM, typically 38400 baud ($8A).
Depending on the function associated to the port and baud rate, the values to be assigned
are detailed in the following table.
www.kimaldi.com Page 32 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 33 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
$04 CFG_ Time-out of the reception of the UART from the $FF
SCITimeout RS232 reader (UART1, UART0)
The following section explains the meaning of each of these configuration bytes.
Parameter$01: ECHO. This generates an OpCode for each status change (digital
inputs, time-locking relays and optical barrier, among others). We can configure
from which type of signal we want to obtain the Echo.
Permitted values:
- Bit 3: ECHO ON – Reset Output.
- Bit 4: ECHO ON – Status change in digital inputs.
- Bit 5: ECHO ON – Ends digital output timing (Relay, LED, buzzer).
- 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 digital inputs and optical barrier
www.kimaldi.com Page 34 of 91
BioMax2 / KBio2-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.
www.kimaldi.com Page 35 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
$05 CFG_OPT_ The optical barrier will generate a Key Pressing $41
KeyCode event corresponding to a configurable key value
$1D CFG_Main_ Auto-On Finger Detection is enabled for the Main $FF
Reader FIM (UART1) $05
Parameter$02: Optical Guard Time. This configures the optical barrier guard time:
when the optical barrier has detected the presence of the finger, it is disabled for a
few seconds. This allows for biometric identification, with no new finger detection
events occurring. If the guard time runs out and the finger is still blocking the optical
barrier, a new event will be generated.
Permitted values:
- 0x00 .. 0xFE: Guard time value in tenths of a second.
Default value:
- 0x14: Guard time of 2 seconds.
Parameter$03: Optical Watchdog Timer. In its standby state, 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 the 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 automatically return to normal
when the beam of light is no longer obstructed (Optical Barrier Status event, code
0x0D ). The default value of the Watchdog Timer allows for 2 or 3 consecutive
identification attempts to be made without removing your finger from the biometric
sensor.
This parameter is also used to enable Auto-On detection, or to disable finger detection
altogether.
www.kimaldi.com Page 36 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Permitted values:
- 0x00: This disables the optical barrier.
- 0x01 .. 0xFE: Delay value in tenths of second.
- 0xFF: Detect finger presence through the FIM module (Auto-ON).
Default value:
- 0xFF: Auto-On Finger Detection through FIM.
Legacy value:
- 0x80: This disables the optical barrier after 12.8 seconds without detecting the
beam (only for terminals with old FIM models and LED optical barrier).
Parameter$05: Optical Key Code. The presence of a finger blocking the optical
barrier will generate an event equivalent to a Key Pressing. The key code is
configurable, although we recommend comparing finger presence to the pressing of
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 pressing of the green “Enter” key.
www.kimaldi.com Page 37 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 38 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Permitted values:
- 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 TTL_1.
- Bit 4: External green LED and buzzer enabled for UART0.
- Bit 5: External green LED and buzzer enabled for UART1.
- Bit 6: External green LED and buzzer enabled for TTL_0.
- Bit 7: External green LED and buzzer enabled for TTL_1.
Default value:
- 0x0C: Internal buzzer enabled for TTL_0 and TTL_1.
www.kimaldi.com Page 39 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Permitted values:
- Bit 0 (LSB): Multiread filter enabled for UART0.
- Bit 1: Multiread filter enabled for UART1.
- Bit 2: Multiread filter enabled for TTL_0.
- Bit 3: Multiread filter enabled for TTL_1.
- Bits 4, 5: When set, EMC FW filter for TTL_0, TTL_1 (respectively) is disabled.
Set only when recommended by Kimaldi.
- Bits 6, 7: not in use
Default value:
- 0x00: Multiread filter disabled, EMC FW filter enabled.
Parameter$0C: 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 BioMax2 / KBio2-Online electronics generates a Card Reading event with a null
identification value (refer to Subsection 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.
www.kimaldi.com Page 40 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
For all the parameters described in the table, the configuration value corresponds to
the time in tenths of second that they are to remain enabled:
- Whenever a port enabled in CFG_Reader_BuzOK receives a correct reading, the
external green LED (CFG_TempGREEN_OK) and the buzzer will activate
(CFG_TempBuzz_OK) .
- Whenever a port enabled in CFG_Reader_ BuzError receives an incorrect
reading, the external red LED (CFG_TempRED_Fail) and the buzzer will
activate (CFG_TempBuzz_Fail).
- When the display 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: depending on parameter (see table)
Internal buzzer timings may also be configured (FW 0x61.33 and later):
www.kimaldi.com Page 41 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
For all the parameters described in the table, the configuration value corresponds to
the time in multiples of 10 ms that they are to remain enabled:
- With a correct reading for which CFG_Reader_BuzOK is enabled, the internal
buzzer (CFG_TempBuzz_OK) will be triggered.
- With an incorrect reading for which CFG_Reader_ BuzError is enabled, 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 on parameter (see table)
8.1.6. Others
Table 10: Other configuration parameters
Parameter$14: Display time-out. Time-out (in cycles) after writing on the Display.
Permitted values:
- 0xFF: legacy value. This is a very conservative Time-out.
- 0x0F: recommended value.
- 0x02: minimum value. Use it if no display is connected.
Default value:
- 0x0F: recommended value.
www.kimaldi.com Page 42 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
1. Warning: if the value of the Remote Host Port, Bio-OCX UDP, is 0, events will not be gener-
ated via this protocol until a frame is sent from the Host
www.kimaldi.com Page 43 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
- $0E - TCP_TimeOut: This is a byte that encodes the time in seconds between
transmission retries. In other words, after the transmission of a frame, the BioMax2 /
KBio2-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 BioMax2 / KBio2-Online electronics will close the TCP/IP
socket. This same parameter controls the KeepAlive frame of the BioMax2 / KBio2-
Online electronics: every 10 x TCP_TimeOut seconds, the BioMax2 / KBio2-Online
electronics will send a frame with the ASCII $06 byte to check that communications
with the Host remain valid. If the frame KeepAlive is not acknowledged after 3
retries, the Socket will also be closed.
If TCP_TimeOut is 0, no retries are made, KeepAlive frames are not generated and the
socket can only be closed from the Host.
- $0F - KSP-Address_Low: This byte encodes Node_ID in a KSP network. It would be
equivalent to the 8 bit DIP-Switch of Kimaldi CAN system products.
- $10 - CFG_ePHY: This byte allows for the type of Ethernet connection available for
our electronics to be consulted and specified in advance.
- $1E - TCP Port-RemoteHost: Four BCD digits that indicate the Host port through
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 Bio-OCX (TCP Server). If a
different value is encoded (typically, 6601), TCP-Client will be enabled.
- $1F - KSPPort-RemoteHost: Four BCD digits that indicate the Host port through
which communications with BioMax2 / KBio2-Online electronics will be establis-
hed (KSP protocol via UDP). Its default value is 6001 and it requires a value other
than 0000.
It is important to remember that changes in the IP configuration will not take effect until
after the machine is restarted, which can be done by simply sending the ApplyCFG
instruction.
www.kimaldi.com Page 44 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 45 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
9. Communications Protocol
<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 indicates the meaning of the frame
and enables you to interpret the data it contains. It is a byte
value expressed by two hexadecimal ASCII characters (rang-
ing from '0' to '9' or from 'A' to 'F'), representing a hexadeci-
mal two-digit value.
<NA>: [ 4 char: ] This parameter indicates the number of bytes
encoded in the data field. It is a 16 bit value expressed by four
hexadecimal characters representing a hexadecimal four-digit
value.
<ARG>: [ 2 x NA char ] This contains the frame information. This
field will be made up of <NA> pairs of hexadecimal ASCII
characters representing each of the <NA> information bytes.
<CRC>: [ 2 char ] This field contains a byte value resulting from add-
ing all the ASCII values from the frame in module 255 except
for <STX>, <CRC> and <ETX>. Expressed by two hexadec-
imal ASCII characters.
<ETX>: [ 1 byte] This indicates the end of the frame. It is the ASCII
www.kimaldi.com Page 46 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
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>
<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>.
www.kimaldi.com Page 47 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
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>&b[Length][Data]
<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 frames.
<Len>: [ 1 byte ] Length afterwards. Its value is 2 + NA.
<Lbl>: [ 1 byte ] Value that is always different, indicating the frame
number (“label”).
<OPC>: [ 1 byte ] This parameter indicates the meaning of the frame
and enables you to interpret the data it contains. It is a binary
byte.
<ARG>: [ NA bytes ] This contains the frame information. This field
will be made up of <NA> bytes with information directly
encoded in binary format.
In some cases, the BioMax2 / KBio2-Online electronics will simply transfer the data
received from a slave reader. In this case, this data can be encapsulated as Extra Data at
the end of the KSP frame:
<Frame_KSP><ETB>&b[Length][Data]
www.kimaldi.com Page 48 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
<AppID><NodeID><KSP_Opc><Len><Lbl><OPC><ARG>
That is, the frame is identical to KSP-UDP, but this time in ASCII-Hex format.
Therefore, <AppID> has a length of two bytes and so on. Given the complexity of the
KSP protocol and the TCP-Server functionality, it is recommended to use the BioKSP-
OCX controller provided by Kimaldi, or its .NET equivalent.
Instruction
OP 0x00
NA 0x0000
ARG None.
Response
OP 0x00
NA 0x0000
ARG None.
www.kimaldi.com Page 49 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
9.5.2. Reset
Instruction
OP 0x01
NA 0x0000
ARG None
Response
OP 0x01
NA 0x0000
ARG None
Instruction
OP 0x02
NA 0x0000
ARG None
Response
OP 0x02
NA 0x0002
ARG Identification code of the firmware version.
Byte 1: FW Major (0x61 for BioMax2, 0x62 forKBio2-Online)
Byte 2: FW Minor
www.kimaldi.com Page 50 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
9.5.4. GetCrashInfo
Instruction
OP 0x0E
NA 0x0000
ARG None
Response
OP 0x0E
NA 0x0000 or 0x0014
ARG 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.5.5. ClearCrashInfo
Instruction
OP 0x0F
NA 0x0000
ARG None
Response
www.kimaldi.com Page 51 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
OP 0x0F
NA 0x0000
ARG None
Function: It deletes the information stored in the non-volatile memory after an exception
has been generated.
Instruction
OP 0x0A
NA 0x0001
ARG Byte 1: configuration parameter number (see section 8.1)
Response
OP 0x0A
NA 0x0002
ARG Byte 1: configuration parameter number (see section 8.1)
>Byte 2: parameter value
9.6.2. WriteCFG_Byte
Instruction
OP 0x0B
NA 0x0002
ARG Byte 1: configuration parameter number (see section 8.1)
Byte 2: parameter value
www.kimaldi.com Page 52 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Response
OP 0x0B
NA 0x0001
ARG Byte 1: configuration parameter number (see section 8.1)
Function: Writes configuration stored in non-volatile memory. See chapter 8.: “BioMax2
/ KBio2-Online electronics configuration” .
9.6.3. ReadCFG_IP
Instruction
OP 0x0C
NA 0x0001
ARG Byte 1: IP parameter number (see section 8.2)
Response
OP 0x0C
NA > 0x0001
ARG Byte 1: IP parameter number (see section 8.2)
Byte 2. n : parameter value
9.6.4. WriteCFG_IP
Instruction
OP 0x0D
NA > 0x0001
www.kimaldi.com Page 53 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Response
OP 0x0D
NA 0x0001
ARG Byte 1: IP parameter number (see section 8.2)
9.6.5. FactoryCFG
Instruction
OP 0x08
NA 0x0000 or 0x0001
ARG Byte 1: 0x00: machine parameters
0x01: IP configuration
> 0x01: machine parameters
If NO = 0, this is equivalent to byte 1 = 0x00 (machine parameters)
Response
OP 0x08
NA 0x0000
ARG None
Function: It restores the initial factory configuration, which is made up of two parts (see
chapter 8 ): IP parameters.
www.kimaldi.com Page 54 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
9.6.6. ApplyCFG
Instruction
OP 0x09
NA 0x0000
ARG None
Function: It restarts the machine for the new configuration values to be applied.
Event
OP 0x09
NA 0x0000 or 0x0014
ARG If 0 arguments, normal start-up.
If 20 arguments, automatic restart after an exception:
Bytes 1..20: information for Kimaldi Electronics.
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.
www.kimaldi.com Page 55 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Instruction
OP 0x30
NA 0x0002
ARG Byte 1: 0x00: Green LED
0x01: Red LED
0x02: external beeper
0x03: internal beeper
Byte 2: enabling time 0x00 to 0xFE tenths of a second (only from 0x00
to 0x19 for internal beeper)
Response
OP 0x30
NA 0x0000
ARG None
Function: Activates one of the LEDs or the beeper for the specified time.
Event
OP 0x30
NA 0x0002
ARG Byte 1: 0x00: Green LED
0x01: Red LED
0x02: external beeper
0x03: internal beeper
indicating that its timing has ended
Byte 2: always 0x00
www.kimaldi.com Page 56 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
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
Instruction
OP 0x40
NA 0x0002
ARG Byte 1: relay number to be enabled (from 0 to 3 in DB module)
Byte 2: enabling time 0x00 to 0xFE tenths of second
Response
OP 0x40
NA 0x0000
ARG None
www.kimaldi.com Page 57 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Event
OP 0x40
NA 0x0002
ARG Byte 1: relay number to end the timing (from 0 to 3 in DB module)
Byte 2: always 0x00
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
www.kimaldi.com Page 58 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Instruction
OP 0x10
NA 0x0000
ARG None
Response
OP 0x11
NA 0x0000
ARG None
Instruction
OP 0x11
NA 0x0028
ARG Bytes 1 to 20: Text on the first row
Bytes 21 to 40: Text on the second row
Response
OP 0x11
NA 0x0000
ARG 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
CFG_TempBacklit (see section 8.1).
www.kimaldi.com Page 59 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Instruction
OP 0x12
NA 0x0001
ARG Byte 1: enabling time 0x00 to 0xFE tenths of second
Response
OP 0x12
NA 0x0000
ARG None
Instruction
OP 0x13
NA 0x0001
ARG Byte 1: 0x00: off.
<>0x00: on
Response
OP 0x13
NA 0x0000
ARG None
www.kimaldi.com Page 60 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
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 0x19 tenths)
Bytes 3 to 22: Text of the first row
Bytes 23 to 42: Text of the second row
Response
OP 0x14
NA 0x0000
ARG None
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 BioMax2 / KBio2-Online
electronics are also specified.
Instruction
OP 0x60
NA 0x0000
ARG None
Response
OP 0x60
NA 0x0001
ARG Bit 0: Status of DIN 0
Bit 1: Status of DIN 1
Bit 2: Status of DIN 2
Bit 3: Status of DIN 3
www.kimaldi.com Page 61 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Function: It returns a byte, showing the status of the four digital 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.
Event
OP 0x60
NA 0x0001
ARG Bit 0: Status of DIN 0
Bit 1: Status of DIN 1
Bit 2: Status of DIN 2
Bit 3: Status of DIN 3
If bit 4 of the CFG_ECHO is enabled (see Subsection 8.1.2.), the BioMax2 / KBio2-
Online electronics can notify of the change in the digital input status via an event with
the same OpCode.
Instruction
OP 0x61
NA 0x0001
ARG 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
3: Status of TTL_1
Response
OP 0x61
NA 0x0001 or >0x0001
ARG Byte 1: port from which the status is announced
Bytes 2 to <NA>: Code of the present card
www.kimaldi.com Page 62 of 91
BioMax2 / KBio2-Online
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.
The reader code 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 Subsection 8.1.4.).
Event
OP 0x81
NA 0x0000 (erroneous reading)
> 0x0000 (correct reading)
ARG Bytes 1 to <NA>: Code of the read card
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 indicative prefix of the reader to have read the card
(see Subsection 8.1.4.).
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.
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.
Event
OP 0x80
NA 0x0001
ARG Key code:
Function: Returns key code pressed for Online management according to the following
table:
www.kimaldi.com Page 63 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Note that the presence of a finger on the optical barrier is also announced via this event
(normally via code 0x41 = ‘A’, configurable).
Instruction
OP 0x51
NA 0x0001
ARG Byte 1: 0x00 to 0x02: UART0 to UART2
Extra Data Frame sent to the RS232 reader from the Host
Response
OP 0x51
NA 0x0000
ARG
Function: Encapsulates a frame to be sent from the Host to the RS232 reader via the
UART of the BioMax2 / KBio2-Online electronics.
www.kimaldi.com Page 64 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Event
OP 0x83
NA 0x0001
ARG Byte 1: 0x02
Extra Data Frame that sends the RS232 reader to the Host
Function: Encapsulates a frame to be sent to the Host from the RS232 reader via the
UART of the BioMax2 / KBio2-Online electronics.
Event
OP 0x4B
NA 0x01
ARG 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 0x4B.
When the situation returns to normal, the same OpCode with Arg = 0x0D indicates this.
See Subsection 5.3.2. and the explanation of the CFG-UI_OPT_T_WATCHDOG byte
for further details. chapter 8
Instruction
OP 0x4A
NA 0x0000
ARG None
www.kimaldi.com Page 65 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Response
OP 0x4A
NA 0x0001
ARG 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.
The optical barrier is self-managed by default; therefore 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 time is set using the CFG-UI_OPT_T_GUARD Byte of the
configuration, see Subsection 8.1.3. or is indefinitely suspended using the
Disable optical barrier instruction).
Instruction
OP 0x4C
NA 0x0000
ARG None
Response
OP 0x4C
NA 0x0001
ARG Status of the optical barrier
Function: Disables the detection LED of the optical barrier There are several 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
proximity reader.
• In the case of presence control, the user is expected to press F1 or F2 prior to
biometric identification.
www.kimaldi.com Page 66 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Instruction
OP 0xBD
NA 0x0003 or above
ARG See section 10.1
Response
OP 0xBD
NA 0x0005 or above
ARG See section 10.1
www.kimaldi.com Page 67 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Function: It allows for the type of biometric sensor installed in the terminal and its
firmware version to be retrieved.
www.kimaldi.com Page 68 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 69 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Response ‘664rr’
Description ‘664’ Response code
‘rr’ Operation result. Possible values:
11 - Operation completed correctly.
www.kimaldi.com Page 70 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Instruction ‘562nnnnnnnnnn’
Description ‘562’ Instruction code.
‘nnnnnnnnnn’ Identifier of the user to be deleted.
Response ‘662rr’
Description ‘662’ Response code
‘rr’ Operation result. Possible values:
11 - Operation completed correctly.
Function: it allows for the biometric data of a user 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.
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’s
database, as well as from BiomaxPlus-DB. If two FIM modules are connected,
information is deleted from both, with no other choices available.
www.kimaldi.com Page 71 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Function: the user’s finger is scanned, and the retrieved template is compared against the
information provided by the same instruction.
www.kimaldi.com Page 72 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Function: it allows for a user whose biometric information is stored in the sensor’s
database to be identified. That is, the user’s scanned fingerprint is compared against all
templates in the FIM module’s database. The matching template has an identifier (FP-ID)
that is returned to the Host.
Function: it allows for a user whose 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 provided FP-ID. The matching result
(true or false) is returned.
www.kimaldi.com Page 73 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
N.B. Appendix A.1 and Appendix A.2 not translated to English yet.
www.kimaldi.com Page 74 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 75 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 76 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
17266200090A060001000100091B
17266200197E000000160000000000000000000000000000000000000016
17266201B17E0000001600000001000000000000019400000000000000AC
00000003<400 Bytes de datos de la huella>
www.kimaldi.com Page 77 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
17266201B17E0000001500000000000000000000019400000000000000AA
00000003<400 Bytes de datos de la huella>
www.kimaldi.com Page 78 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
• Extra Data:
- A través de Bio-OCX: recibimos una cadena de datos.
- La trama real que se recibe en Extra Data es, en Hexadecimal y a partir de <ETB>
(incluido):
17266200197E000000150000000100000000000000000000000000000016
www.kimaldi.com Page 79 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 80 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
172662000400000020
5100010087172662000400000020
172662000400000020
830001008C172662000400000020
www.kimaldi.com Page 81 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
• Extra Data:
- A través de Bio-OCX:
‘>>5000197E000000040000000000000000000000000000000000000004B3’
- La trama real que se manda en Extra Data es, en Hexadecimal y a partir de <ETB>
(incluido):
172662001D5000197E000000040000000000000000000000000000000000000004B3
5100010087172662001D500019
7E000000040000000000000000000000000000000000000004B3
0D01F8027A00
4D01F8027B00
Observemos que en ambos casos mandamos el OpCode 0x00, una vez al dispositivo
0x0D.01 y la siguiente al dispositivo 0x4D.01. La etiqueta de la trama deberá ser
distinta cada vez (0x7A y 0x7B, respectivamente).
www.kimaldi.com Page 82 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
17266200197E000000040000000000000000000000000000000000000004
4D01F8034251001726620019
7E000000040000000000000000000000000000000000000004
J1
J9 BioMax2
www.kimaldi.com Page 83 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Port activation
As said, Wiegand Input will be enabled through Parameter$0F, CFG_Wiegand, as
explained in Subsection 8.1.4.
Following the case depicted in Figure 1:, let CFG_Wiegand take value $21 (i.e, 26-bit
Wiegand through TTL_1 port).
www.kimaldi.com Page 84 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
• Bit 33: last parity bit, “odd” type. Its value is such, that the 17 last bits together (bit
33 included) contain an odd number of ones (‘1’).
Free format
A Card Reading event is issued, directly transferring all bits received through the
Wiegand port, with no format processing at all. For that reason, whatever parity bits that
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 security is required: data integrity is not
guaranteed in Free Format mode.
www.kimaldi.com Page 85 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
Appendix B. Troubleshooting
1. The BioMax2 / KBio2-Online electronics does not open the session via UDP,
although it is detected via SLK
Using the Kimaldi Localisation Service, select the terminal in question and edit the
network configuration. Make sure that:
- The terminal's IP is properly assigned (there are no duplicities, you obtain
response to ‘ping’). If you are in a network with dynamic IP assignment, set the
‘DHCP’ field of the IP configuration to ‘TRUE’ (‘01’).
- The submask and gateway are correctly configured.
- The server's IP is only necessary if DHCP is enabled.
- The Host to contact the BioMax2 / KBio2-Online electronics is displayed in the
Remote Host.field
- The Host contacts the BioMax2 / KBio2-Online electronics via its 5501 port in the
case of Bio-OCX UDP and via its 6001 port in the case of UDP-KSP.
- If Bio-OCX 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. Value 0 configures the
suitable port automatically with the limitation that it does not generate events
until the Host has started communications.
If configuration parameters are to be modified, remember to apply them (ApplyCFG)
before assessing their effectiveness. If the DHCP is enabled, IP initialisation may
take several seconds.
www.kimaldi.com Page 86 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 87 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
the Host. After a reset, and until no communication is received from the Host,
this decision is based on the CFG_EventCH parameter (see Subsection 8.1.2.).
- In the case of IP communications, the Host IP address to which the frame is to be
sent must be determined. This is the IP-RemoteHost parameter indicated in sec-
tion 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 BioMax2 / KBio2-Online electronics are being routed,
these should be connected to different IP ports in the Host. If they are assigned
automatically by the Host, simply specify a value of 0000 in the Port-Remote-
Host parameter (section 8.2). In this case, BioMax2 / KBio2-Online electronics
cannot determine the destination port until it receives a frame from the Host
and, therefore, no events will be received. This could be a limitation when faced
with an unexpected power cut, as when the power supply is restored, BioMax2 /
KBio2-Online electronics will stop generating events until it receives 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, events cannot be generated until the Host has
opened the TCP/IP Socket. It is not possible to configure the CFG_EventCH
parameter (see Subsection 8.1.2.) so that events are spontaneously generated
via TCP/IP after a reset.
www.kimaldi.com Page 88 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
www.kimaldi.com Page 89 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
List of Tables
Revision Control
Notes
FIM biometric modules (FIM20xx, FIM30xx and FIM5360), as well as eNBSP software,
are products belonging to Nitgen Co., Ltd.
Omnikey readers are products belonging to HiD Global Corporation.
KiWi Ethernet, KiWi Wifi and KRD13M are products belonging to Kimaldi Electronics,
S.L.
www.kimaldi.com Page 90 of 91
BioMax2 / KBio2-Online
Installation and Programming Manual
This symbol indicates that Waste Electrical and Electronic Equipment (WEEE) should be
disposed of separately to domestic waste. This measure is adopted to encourage
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 distributor or consult section "Environ
ment" in our website at www.kimaldi.com
This information is only applicable to consumers in the European Union. In other countries,
contact the local authorities to see whether this product can be recycled.
www.kimaldi.com Page 91 of 91