HID OMNIKEY 5427 CK Keyboard Wedge User Guide - Manual (Page 8)

OMNIKEY Keyboard Wedge Configuration, 5x27-902, Rev D.0
Page 8 of 23 November 2013
HID GLOBAL CONFIDENTIAL AND PROPRIETARY INFORMATION. Use and disclosure of this information is strictly
restricted by the terms of a non-disclosure agreement with HID Global Corporation. If you have received this information and
are not an intended recipient or are not subject to or do not agree to be bound by the terms of the non-disclosure agreement,
please immediately return this document to HID Global Corporation, 15370 Barranca Pkwy, Irvine, CA 92618-3106.
2.1 General configuration
2.1.1 Card Out Event Keystrokes
OK5x27 CK readers perform keyboard wedge actions on two events:
Card In: A card is detected by the reader
Card Out: A card is removed from the reader
Card Out defines a set of keystrokes that are sent when a card is removed from the
reader. Due to the card removal from the reader, those keystrokes are generic (card-
independent) and apply to all card types supported by the reader. If left open, no action is
performed by the OK5x27 CK reader when a card is removed from the field.
2.1.2 Keyboard Layout
This selection compensates differences in regional keyboard layouts (for example, different
interpretation of Y key on a US and DE keyboard). This setting must be adjusted to the actual
setting of the host system in which the 5x27 CK is connected.
Example: A Y in the keyboard wedge layout US generates a Z on a host-PC using the
German keyboard layout. Only when the keyboard wedge is configured to DE will the Y be
interpreted correctly as a Y on the host-PC.
2.1.3 Output Type (firmware 03000000 or higher)
Keyboard wedge mode includes two output types, Keyboard Wedge and Custom Report.
The Keyboard Wedge output is the standard. The device enumerates as a keyboard and
outputs the keyboard wedge data as a series of keystrokes.
In Custom Report output the device enumerates as a custom HID USB device. In this output
the USB reports have improved to process the USB reports. The following describes custom
report formats.
• The packet size is 40 bytes.
• 1st byte is the length of data in the packet.
• 2nd byte is the version of the report.
• The following bytes contain the keyboard wedge data.
• If the data length, version, byte length combine to less than the USB packet size (40
bytes), additional zeroes are added for the remaining length.
2.1.4 Boot Interface (firmware 03000000 or higher)
The Boot Interface option allows the device to advertise support for the keyboard boot
interface in its HID device descriptor when it enumerates as a keyboard device. If enabled,
the device is operational on host systems that only have minimal USB device handling,
without support for full USB descriptor parsing.
2.1.5 Hex Output case (firmware 03000000 or higher)
The Hex Output case option specifies whether hexadecimal output is lower or upper case.
The setting applies to all card types.