Page 1
OMNIKEY 5121 E THERNET NCODER UIDE L001436, Rev. 2.0 June 2016 hidglobal.com...
Page 2
In no event shall HID Global be liable, whether in contract, tort or otherwise for any indirect, special or consequential damages arising from the use of the information contained in this document.
USB wire enables communication with both the HID Global printer and its embedded USB version of the OMNIKEY 5121 Encoder. This single Ethernet connection to the host printer, when used to access both the printer and the embedded OMNIKEY 5121 Ethernet Encoder device, is hereinafter referred to as the “One-Wire”...
The OMNIKEY 5121 Ethernet Encoder Utility will display the following window at initial start-up. 1.2.2 Program API Control of the Encoder Session To fully automate the process of accessing an OMNIKEY 5121 Ethernet Encoder device, a software application may also require the capability to programmatically manage the OMNIKEY 5121 Ethernet Encoder session.
Initial Installation Retrieve the OMNIKEY 5121 Ethernet Driver installation program from https://www.hidglobal.com/drivers. 2. Run the OMNIKEY 5121 Ethernet Driver installation program. After program initialization the following Welcome screen will be displayed. Click Next to continue to the Ready to Install screen.
Page 7
5. When the installation is complete the Setup Complete Screen will be displayed, as shown below. 6. Ensure the Run the OMNIKEY 5121 Ethernet Driver Utility to add an encoder option is checked to start the utility once the installation program completes.
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 2.2 Upgrading to a new version A newer version of the installer may be run which will detect the presence of the previous version and allow a user to upgrade to a newer version. The current configuration of any drivers installed will be maintained to avoid the need repeat previous encoder settings: 2.3 Reinstalling the same version...
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 2.3.3 Removal After initial installation the installer may be run again to allow a user to perform a removal operation which will remove all driver components and configuration information. June 2016...
OMNIKEY 5121 Ethernet Driver installation program (unless the auto-start option is disabled by the user). To manually start the OMNIKEY 5121 Ethernet Encoder Utility click on the associated icon found in the OMNIKEY folder in the Start Menu.
OK. 3.1.2 Configuration of Fixed Printer Name Mode To add a new OMNIKEY 5121 Ethernet Encoder device in Fixed Printer Name Mode select the Use Printer Name option, select a Printer Name from the drop-down list and click OK.
To add a new OMNIKEY 5121 Ethernet Encoder device in Dynamic IP Address Mode select the Use Dynamic IP Configuration option and click OK. In this mode the IP Address or Printer Name will be specified at the time that the encoder session is established.
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 For a device instance configured in Fixed IP Address Mode the display will appear as shown below, where the fixed IP Address is displayed above the current encoder selection. The Encoder Device Name String OMNIKEY 5x21 LAN B1234567 0 in the example above, will contain the associated Printer Serial Number (B1234567) and the Instance Enumeration Index value (0).
Encoder Device Name String as in the previous two modes. When using the Dynamic IP Address Mode, it may be desirable to install multiple OMNIKEY 5121 Ethernet Encoder device instances on a single server or workstation, with each device instance configured in this mode.
Page 15
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 However, rather than embedding the associated Printer Serial Number (which currently is not available) in the Encoder Device Name String the utility will display a “temporary” Printer Serial Number equal to “Z9999999. This special Printer Serial Number will subsequently indicate to the user that the device has not been completely configured.
Management of a previously installed OMNIKEY 5121 Ethernet Encoder device is done using the Encoder menu of the OMNIKEY 5121 Ethernet Encoder Utility. Within the main dialog of the utility application is the Select Encoder drop-down list. This drop-down list will display all OMNIKEY 5121 Ethernet Encoder devices installed on the current server or workstation.
The Restart Selected Encoder menu option allows the user to manually restart the driver associated with the selected OMNIKEY 5121 Ethernet Encoder device. A restart of the driver is required whenever the device configuration information is changed. This restart enables the driver to update its internal resources and report relevant configuration changes to the Microsoft Windows Smart Card Resource Manager.
Once an OMNIKEY 5121 Ethernet Encoder device has been installed as detailed in the procedures above it will be displayed in the Select Encoder drop-down list of the OMNIKEY 5121 Ethernet Encoder Utility. It will also be accessible via the Microsoft Windows Smart Card Resource Manager.
3.3.1 Failure to Establish an Encoder Session If the OMNIKEY 5121 Ethernet Encoder Utility fails to establish an encoder session with the selected device, then an error message dialog similar to the following will be displayed. Click OK to dismiss.
3. The printer is not powered up or is offline. Note: When an OMNIKEY 5121 Ethernet Encoder device is configured in either the Fixed IP Address Mode or the Fixed Printer Name Mode then an initial encoder session with the device is required to retrieve its configuration information.
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 3.4 OMNIKEY 5121 Ethernet Encoder – Session Termination Once a session has been established with an OMNIKEY 5121 Ethernet Encoder device that session will be maintained indefinitely by the OMNIKEY 5121 Ethernet Driver unless an interruption of the Ethernet connection occurs, the host or printer device is powered down, or a system error occurs.
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 3.5 OMNIKEY 5121 Ethernet Encoder – Session Status The encoder session status information is maintained by the OMNIKEY 5121 Ethernet Encoder Utility for each currently installed encoder device. This status information is displayed in the Reader Status block of the main window.
OMNIKEY 5121 Ethernet Encoder devices installed using the normal configuration (i.e., with both reader slots enabled). The OMNIKEY 5121 Ethernet Encoder Utility supports the ability to disable either the Contact Reader Slot or the Contactless Reader Slot associated with all currently installed OMNIKEY 5121 Ethernet Encoder devices.
Page 24
OMNIKEY 5121 Ethernet Encoder User Guide, L001436, Rev. 2.0 This page intentionally left blank Page 24 of 25 June 2016...
Need help?
Do you have a question about the OMNIKEY 5121 and is the answer not in the manual?
Questions and answers