====================================================================== PrehKeyTec PKTUSBAPI for Windows Version V5.2.0.01 Package 2023-10-20 ====================================================================== ====================================================================== 1) PKTUSBAPI - General information ====================================================================== The PKTUSBAPI.dll provides a software library to communicate with PrehKeyTec USB devices. It is the interface between the hardware and the customer application. Various keyboards and their internal modules can be handled by this API. The PKTUSBAPI.dll library is written in C# with Microsoft® .NET Framework 4.0. It supports usage of multiple PrehKeyTec devices in parallel - using high-level methods and properties. Please refer to "PKTUSBAPI Manual.pdf" for a complete documentation. Here you find instructions how to implement the API into customer’s application - including source code samples. ====================================================================== 2) System Requirements ====================================================================== * Windows® 7 or later The PKTUSBAPI.dll supports both 32bit and 64bit OS. * Microsoft® .NET Framework 4.x or later * PrehKeyTec USB device(s) with firmware 605/3xxx, 605/5xxx or later. * Keytable configuration Standard API functions can be used on any supported PrehKeyTec USB device. But for testing all modules, devices must be configured for OPOS/JavaPOS usage (please refer to chapter 6 below). ====================================================================== 3) Installation / Deployment ====================================================================== PKTUSBAPI.dll deployment is rather easy: Just place PKTUSBAPI.dll and both sub-dlls into the same folder as your own executable. It's no longer necessary to register any of the DLLs as it was in our older software. This ZIP contains latest DLLs in the DemoApplication subfolder: PKTUSBAPI.dll API DLL itself PKTUSB32.dll C++ Sub-DLL for 32bit PKTUSB64.dll C++ Sub-DLL for 64bit IMPORTANT NOTES: In addition of including the PKTUSBAPI.dll to your own applications, please make sure that also the two C++ DLLs (PKTUSB32.dll and PKTUSB64.dll) are copied into the same directory as the PKTUSBAPI.dll. We usually have added a PostBuild xcopy command line to the projects which will do this automatically: xcopy "$(ProjectDir)..\..\..\..\DemoApplication\*.dll" "$(TargetDir)" /D /Y The PKTUSBAPI reference is also pointing to above directory which will build process easy. To use both features, the 3 files PKTUSB*.DLL must be here (relative, 4 directories above of Project file): ..\..\..\..\DemoApplication\ ====================================================================== 4) Usage: Demo Application / Samples ====================================================================== ---------------------------------------------------------------------- PKTUSBAPI Demo.exe ---------------------------------------------------------------------- This fully-featured test application shows the various features included in our PKTUSBAPI. Also you may use it to demonstrate the multiple device capabilities and hotplug. The application will list up all PrehKeyTec devices on the left column. You then may open each of those devices and execute all available functions, like manufacturing information, beep tones, LED, etc. In order to test MSR/Keylock/POSKeys, please refer to chapter 6) for configuring those modules for API usage. On tab "Device Configuration" you can program an existing binary keytable *.MWX into your device. A ready-to-use sample keytable file for MCI 30..128 is included in folder "keytable". ---------------------------------------------------------------------- Sample_xyz.exe ---------------------------------------------------------------------- Easy samples for various tasks and different programming languages will be added in future. For details and source code, please see the appropriate subfolders in \Samples\. ====================================================================== 5) Contents of this ZIP: ====================================================================== .\Readme.txt this file .\PKTUSBAPI Manual.pdf documentation .\DemoApplication\ PKTUSBAPI Demo.exe extensive test application demonstrating various PKTUSBAPI capabilities PKTUSBAPI.dll API DLL itself PKTUSB32.dll C++ Sub-DLL for 32bit PKTUSB64.dll C++ Sub-DLL for 64bit Sample_xyz... Some compiled binaries of Source code in \Samples .\Keytable\ pos_mci128.MWF Sample configuration file to be downloaded into MCI 30..128 pos_mci128.mwx Binary image of above MWF keytable file. .\Samples\ Additional source codes examples. Easy samples for various tasks and different programming languages will be added in future. For details and source code, please see the appropriate subfolders. ====================================================================== 6) Keyboard configuration for API and OPOS/JavaPOS usage: ====================================================================== Standard functions, like sound and version information can be used on any supported PrehKeyTec device. But to use POSKeys and the modules MSR/Keylock/etc, the devices must be configured for OPOS/JavaPOS usage. ---------------------------------------------------------------------- Configurating PrehKeyTec devices (modules and keys) for API usage: ---------------------------------------------------------------------- Configuration software "WinProgrammer" provides ready-to-use templates for OPOS/JavaPOS usage, example: \WinProg\Keytables\OposJavaPOS\MCI\pos_mci128.MWF Use WinProgrammer to create your own keytable with 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. You also can drag&drop POSKeys into your layout and mix them with "classic" keys. Please refer to our detailed WinProgrammer and programming manual: Quickstart WinProgrammer (PDF). Notes: PKTUSBAPI now also supports reading/writing keytable files in format *.MWX. Use our Demo Application / tab "Device Configuration" to program an existing binary keytable *.MWX into your device. See folder "Keytable" for a binary MWX file which can be used for all MCI keyboards MCI 30..128. ====================================================================== 7) Help and Support ====================================================================== Please refer to the documentation "PKTUSBAPI Manual.pdf" for a complete set of functions. Please contact our technical support team: support@prehkeytec.de Any questions or suggestions to improve our products are welcome. ====================================================================== Annex ====================================================================== Copyright © Copyright PrehKeyTec GmbH 2023 Published by PrehKeyTec GmbH. 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 Brands and product names mentioned in this document are trademarks or registered trademarks of their owner, e.g.: Windows: Trademark of Microsoft Corporation PrehKeyTec GmbH Scheinbergweg 10 D-97638 Mellrichstadt Germany Email: support@prehkeytec.de Web: www.prehkeytec.com -------- pkt/2073/sz