PrehKeyTec Programmable Keyboards

PrehKeyTec JavaPOS Service for Linux (i386 and x86_64)

Release 1.12.088

Installation Notes - 2012-Sep-10

Overview

This package contains all files needed to install the PrehKeyTec JavaPOS service for Linux. Our JavaPOS package enables easy access to keyboard integrated modules via Java applications. This software has been released under the term of the PrehKeyTec LICENCE included in this package.

Note on PrehKeyTec PS/2 keyboards:
We do no longer provide JavaPOS support for PS/2 keyboards on Linux Kernel 2.6.x or newer. For PS/2 keyboards you might use our old JavaPOS driver package 1.6.0.66 on Linux Kernel 2.4.

Features

The PrehKeyTec JavaPOS driver has been developed to provide simple access to the PrehKeyTec keyboards and their internal modules (like MSR, Keylock, PosKeys) and supports the following devices:

• POSKeyboard
• Keylock
• MSR
• ToneIndicator

Supported Keyboard Interfaces:

• USB

System requirements

• PrehKeyTec Keyboard equipped/connected with USB interface.
• Linux Kernel 2.6.xx or above.
• Java2 Runtime Environment Version 1.4.x or above.
• Keys and keyboard modules configured for OPOS/JavaPOS usage.
• For specific information on USB configuration please refer to README_USB.html

Preparing your keyboard configuration for OPOS/JavaPOS usage

In order to use the keyboard's modules MSR, Keylock and POSKeys with JavaPOS, these must be configured correctly.

Please use our WinProgrammer to program PrehKeyTec special OPOS/JavaPOS headers and terminators:
Either just download one of the ready-to-use templates into the keyboard -or- create/adapt your own configuration using those headers.
For downloading the binary keytable on Linux, please use our utility "copy2mci" which is available on request.

Installation Procedure

To install the PrehKeyTec JavaPOS driver under Linux, please follow the steps below:

A. Extract the PrehKeyTec JavaPOS driver package

1. Unpack the driver to the directory of your choice (e.g. /home/user1):
   cd /home/user1
   tar -xzvf JavaPOS.1.12.0.xx.tar.gz
2. Change to the driver's directory:
   cd JavaPOS.1.12.0.xx

B. Set up USB environment for PrehKeyTec USB keyboard on Linux

PrehKeyTec keyboards connected to your Linux system via USB do not require any special driver, nor the kernel needs to be modified. Just to access the special keyboard modules from within JavaPOS at normal user privileges, some minor udev rules configuration must be done. This configuration is done automatically by executing the setup script in step C. For details please refer to README_USB.html.

C. Run the setup script wizard

1. Go to setup subdirectory
   cd ./JavaPOS.1.12.0.xx/setup
2. Run the setup script
   ./setup
3. Follow the setup wizard instructions.

Sample JavaPOS test applications

After installation all devices can be tested by running the PrehKeyTec JavaPOS demo applications. This is done by starting the script files in the PrehKeyTec JavaPOS directory:

• PrehKeyTec POSKeyboard: ./TestPOSKeyboard.sh
• PrehKeyTec Keylock: ./TestKeylock.sh
• PrehKeyTec MSR: ./TestMSR.sh
• PrehKeyTec ToneIndicator: ./TestToneIndicator.sh

Using PrehKeyTec devices in your own JavaPOS application

The PrehKeyTec JavaPOS devices can be accessed by the following device names:

• com.preh.POSKeyboard - PrehKeyTec POSKeyboard device
• com.preh.Keylock - PrehKeyTec Keylock device
• com.preh.MSR - PrehKeyTec MSR device
• com.preh.ToneIndicator - PrehKeyTec ToneIndicator device

Important Note - JNI and default interface:
We have two different PrehKeyTec JNI (java native interface library) versions: One for USB/i386 and one for USB/x86_64.
The appropriate files and symbolic links are located in the PrehJavaPOS subdirectories:

• ./usb32/libPrehJPOS.so
• ./usb64/libPrehJPOS.so

The interface used by the PrehKeyTec JavaPOS demo applications is resolved by a set of symbolic links.
These are always based on the PrehKeyTec JavaPOS directory - Example:

• ./libPrehJPOS.so -> ./usb32/libPrehJPOS.so -> ./usb32/libPrehJPOS.so.0.7

Use the scripts to configure interface by updating the symbolic links for PrehKeyTec JavaPOS Demo applications:

• ./setto_usb.sh - PrehKeyTec JavaPOS default interface USB.

To run your own JavaPOS applications you need:

• in java class path:
• PrehJPOS.jar - PrehKeyTec JavaPOS service classes.
• in library path:
• libPrehJPOS.so - PrehKeyTec java native interface library.

Troubleshooting

To be able to run the Demo applications, you must have installed a proper Java2 runtime environment. Furthermore the executable java must be in the search path.

To check if the Java2 environment was set up correctly, execute the following command:

• java -version the Java runtime environment should report it's version.

The path to the JRE executable java is is usually added in one of the following configuration files:

• /etc/profiles for all users
• ~/.profile for the individual user.

To display the version of the PrehKeyTec JavaPOS package:

• java -jar PrehJPOS.jar

To display detailed diagnostic information required for supporting you:

• ./setup/diag.sh

Package Contents

./JavaPOS.1.12.xx/ - Main folder containing all the following:

• PrehJPOS_xx.jar - JAR package of PrehKeyTec JavaPOS classes.
• jpos.xml - JavaPOS registry file.
• README.html (this file) - Instructions on driver installation and usage.
• README_USB.html - Instructions on USB driver installation and usage.
• License.txt - Software license for the PrehKeyTec JavaPOS driver.

• TestPOSKeyboard.sh - start POSKeyboard demo application.
• TestKeylock.sh - start Keylock demo application.
• TestMSR.sh - start MSR demo application.
• TestToneIndicator.sh - start ToneIndicator demo application.

• setto_usb.sh - Script to change/update PrehKeyTec JavaPOS interface settings.

./usbNN - Subfolder containing JNI library to access keyboard modules via USB interface 32/64bit:

• ./usb32/libPrehJPOS.so.0.x - JNI library for USB i386.
• ./usb64/libPrehJPOS.so.0.x - JNI library for USB x86_64.

./setup - Subfolder containing setup tools and xml templates:

• ./setup/setup - Script based wizard to setup JavaPOS installation.
• ./setup/diag - Script for system diagnostic.
• ./setup/jpos_std.xml - JavaPOS registry file for PrehKeyTec standard keyboard.
• ./setup/jpos_133uq.xml - JavaPOS registry file for 133UQ/AU keyboard.

• ./setup/usb/sh_install - script for USB environment invoked by setup.
• ./setup/usb/52-prehkeytec.rules - UDEV rule sample file for PrehKeyTec keyboards.

./lib - Subfolder containing external JAR packages:

• ./lib/jcl_editor.jar - JavaPOS registry editor package.
• ./lib/jpos1122.jar - JavaPOS common control object package 1.12.2.
• ./lib/xerces.jar - Package to access JavaPOS registry.

./jpos/res - Subfolder containing files for JavaPOS registry manipulation:

• ./jpos/res/jcl.dtd - DTD file for XML syntax of JavaPOS registry files (e.g. jpos.xml).
• ./jpos/res/jpos.properties - Properties file for JavaPOS.

Version History

• 2012-09-10 JavaPOS.1.12.088.tar.gz - Release for UPOS 1.12 (including updated JNI 0.7)
• 2011-02-01 JavaPOS.1.12.087.tar.gz - Beta release for UPOS 1.12

Annex

Help and Support
If you should have any problems on installing and using these drivers we of course will like to help you. Also if you have any comments or suggestions to improve our drivers and installation scripts please email to: support@prehkeytec.de. Further information and latest drivers you can find in the internet at www.prehkeytec.com

Copyright
© PrehKeyTec GmbH 2012. PrehKeyTec GmbH reserves the right to update or change the products described in this document as well as the document itself without prior notice. This document may not be reproduced, processed or translated into electronic form or other languages without the prior written permission of PrehKeyTec GmbH.

Trademarks
All trademarks and brand names mentioned in this document are the property of their respective owners. e.g: "Linux" is a trademark of Linus Torvalds.