MCI TouchKey Technical Documentation Figure shows a specific keyboard layout Document Rev. C PrehKeyTec GmbH MCI_TouchKey_TechDoc_RevC_en.
Introduction............................................................................................................... 3 System requirements ............................................................................................... 3 Structure of the MCI TouchKey ............................................................................... 4 Keyboard and module........................................................................................................4 Touch-LCD ....................
MCI TouchKey Introduction The TouchKey is a combination of a Touch LCD and a keyboard. The right section of the device and included modules behave like standard PrehKeyTec keyboards and as such are programmed using the WinProgrammer. On the left section of the device is a LCD Touch Panel which communicates with an application running on the PC. This application evaluates data XML Data stored on the PC and displays them on the LCD. This data could be in the form of a text, graphic or buttons.
Structure of the MCI TouchKey Keyboard and module The keyboard section and other modules (MSR, Keylock) if available are programmed using the WinProgrammer software. This software can be downloaded from the support section of our Website at: http://support.PrehKeyTec.com. For more information on how to use the WinProgrammer, please refer to our Quick Start manual of the WinProgrammer. Touch-LCD LCD The left section of the TouchKey device is made of a LCD Touch Panel.
The XML files can be created using the TouchKey Programmer. The XML data structure created using the TouchKey Programmer can then be used by an application to change content of the XML files. These changes will then be transmitted over the TouchKey Server to the screen of the TouchKey. In order to transmit the TouchKey configuration to the system, one simply has to copy the XML folder, and the TouchKey Server executables (TouchKeySvr.exe / TKInterface.dll) into a folder on the target PC.
TouchKey Programmer General information The TouchKey Programmer is a software used to create the XML files for the MCI TouchKey. This software primarily creates and test layouts using simple drag and drop methods. The most recent version of the TouchKey Programmer can be downloaded from our website at: http://support.PrehKeyTec.com. For getting started a flash animation shows the first steps and explains the basic usage of the MCI TouchKey. Requirements The TouchKey Programmer requires .NET Framework 2.
After creating a project and its layouts, this can be exported to the LCD using "Test Projects". However before the layouts can be viewed on the screen, the TouchKey Server has to be started. This TouchKey Server has to be installed one level above the XML folder which contains the XML files. Clicking on the menu "Test Project" creates all the necessary XML files. The structure of these files is as follows: - A XML file is created for every layout using the Layout data.
The menu "Save & Exit" saves the configuration and exits the tool. Simply click the "Exit" button to end the program without saving the configuration. XML Files General information The simplest way to create XML files is using the TouchKey Programmer. The program has the ability to check the created files for any mistakes. Wrongly configured XML files cannot be displayed on the LCD.
Types of XML files TouchKey.xml Every MCI TouchKey has a basic configuration. This configuration is stored in "Touchkey.xml". This file can also contain information and configurations for more than one TouchKey. Differentiating the layouts for the different TouchKeys is done using the TouchKey’s serial number. Description of the elements Start element for a TouchKey device. This is the TouchKey’s serial number usually found on the sticker at the back of the device.
The number of graphics available for the TouchKey. A graphic file can contain many different graphics. Example: 1 The number of text files which are available for this TouchKey. A text file can contain multiple text fields Example: 2 This is the name of the layout. This name must be the same as the name of the XML file.
MCI TouchKey example for a single device PAGE 12MCI TouchKey example for two devices PAGE 13.xml These files contains the configuration for the layouts. Keys can be programmed in layouts but graphics and text will always be configured in a separate file for each. Description of the Element This element contains as an attribute the name of the XML-Schema. The schema checks the validity of .xml. If there is an error, the TouchKey Server automatically stops and out puts an error message. Example: PAGE 14 Frequency of the key click. Range 0-255. 0 - 15 = ca 4800Hz 16 - 31 = ca 2400Hz 32 - 63 = ca 1200Hz from 64 = ca 600Hz Example: 16 Length of key click. Rane 0-255. Length = Value * 8,3ms Example: 10 Inverts the key when it is pressed. Possible values: true, false Example: true Out puts a key when the button (key) is pressed.
The text written on the key. Special characters have to be written using character references as follows: "&#character;" An example for creating a new line will be "
". A list of the ASCI characters is found at the end of this document. Numbers are to be written in decimal form. Example: drinks
table 1 This describes the characteristics of the fonts used in labeling buttons.
Describes index of the font being used. The fonts have to be loaded on the flash memory of the TouchKey before they can be used. The a user defined. The list below shows the default font found in each MCI TouchKey: 0 Verdana 8 pt fat 1 Verdana 8 pt 2 Verdana 20 pt fat 3 Verdana 12 pt fat 4 MS Sans Serif 18 pt fat 5 MS Sans Serif 12 pt 6 Verdana 10 pt fat 7 Verdana 14 pt fat 8 Verdana 16 pt fat Example: 0 This defines the of the touch field.
The scan code for the key. The decimal number for the value is used. This block also ends with a 0 scan code.
The XML file for the above example has the following structure PAGE 1983 true 31 0 83 false 31 0 84 true 20 0 84 false 20 0 0 fal
.xml The configuration of the text fields is made in this section. One or multiple text fields can be defined here. Description of the elements Name of the text file without the additional ".xml". Example: food_txt The created text is shown in the layout defined in . When the layout is displayed on the LCD, it automatically out puts all text files .xml defined within this layout.
Position Horizontal. Range 0-320. Example: 0 Position Vertical. Range 0-240. Example: 0 Width of text field in pixels. Range 0-320. Example: 138 Height of text field in Pixel. Range 0-240. Example: 200 This describes the index of the font that is being used. These fonts have to be loaded in the memory of the TouchKey before they can be used and they are user defined.
Underlines the text. Possible values: true, false Example: false This section holds the content of the text field. Special characters are written with character references. This is structure is as follows:"&#character reference;". For example a new line will be written as "
". A list of the ASCII character is found at the end of this document. Decimal numbers are to be used. Example: label1 The mode of the text.
A layout sample The name for the XML file is "L1_txt.xml". This Layout contains a text field with the text "This is a test". This text field is displayed in layout "L1". PAGE 24.xml This section handles the configuration of graphics. One or multiple graphics can be defined and configured here. Description of the elements This is the name of the graphic file without the ".xml" ending. Example: tables_gfx The graphic will be displayed in this Layout. Example: food This is a POS key that can be programmed on the keyboard section of the WinProgrammer to start a graphic when pressed.
Position vertical. Range 0-240. Example: 6 This index represents that of the graphic in the TouchKey device. The graphics must be loaded into the TouchKey before they can be used. Consult the section Loading graphics for more information on how to do this. Example: 17 Defines if the graphic is animated (true) or not (false).
Startlayout.xml When the TouchKey Server is started, the layout at the top of the file "TouchKey.xml" is the first to be displayed on the screen. Each time the TouchKey Server is initiated, "Startlayout.xml" is loaded with a new layout. The client’s application can be used here to write the layout that is to be displayed in "Startlayout.xml". This causes the TouchKey device to change the displayed layout to the actual one in "Startlayout.xml".
Appendix Sample project for the TouchKey Programmer Using the TouchKey Programmer, we are going to create two layouts as a working example. The first layout contains a text field, a graphic and a programmed key (button). The second layout contains a text field and programmed key. Using the programmed key in the second layout, one could drill back to the first layout. Layout "L1" displays a graphic, a text field and a programmed key. Pressing on the programmed key "Layout 2" drills down to next layout "L2".
Data for L1.xml PAGE 29Data for L1_txt L1_txt L1 0 false 0 80 319 40 3 false false Scheinbergweg 10
D-97638 Mellrichstadt 131 Data for L2.
Data for L2_txt.xml L2_txt L2 0 false 45 40 230 40 7 false false Layout 2 131 PrehKeyTec GmbH MCI_TouchKey_TechDoc_RevC_en.
OPOS Service Object LineDisplay The two line display previously offered for the MC family keyboards is no longer available for our MCI keyboards. Using the display of the TouchKey however, and using OPOS, it is possible to out put the two lines on the display of the TouchKey. The OPOS tool makes it possible to configure the fonts and the number of lines, and also the number of characters in each line. For the TouchKey OPOS Service object please contact support@prehkeytec.
Configuring the flash memory using iLCD Setup The most recent version of this software (iLCD Setup) can be downloaded from this location: http://www.demmel.com/ilcd/english/software.htm How it works This program is used to load graphics into the flash memory of the TouchKey. In order to load graphics, start by selecting "setup" as shown in the image on the right. One can read out the actual graphics that are stored in the TouchKey using "Read Flash". Selecting "Edit->Graphics" brings up the image below.
ASCII Character Table PrehKeyTec GmbH MCI_TouchKey_TechDoc_RevC_en.
PrehKeyTec GmbH MCI_TouchKey_TechDoc_RevC_en.
Scan Codes This table contains a variety of PS2-Scan codes (Scanset1). A complete list of all the PS2-Scan codes can be found in the Microsoft Translation Table in this location: http://www.microsoft.com/whdc/archive/scancode.mspx#ENB PrehKeyTec GmbH MCI_TouchKey_TechDoc_RevC_en.
Virtual Key Codes These key codes are based on a key board with the US layout. There will be slight differences to other country specific layouts.
72 H key 73 I key 74 J key 75 K key 76 L key 77 M key 78 N key 79 O key 80 P key 81 Q key 82 R key 83 S key 84 T key 85 U key 86 V key 87 W key 88 X key 89 Y key 90 Z key VK_NUMPAD0 96 Numeric keypad 0 key VK_NUMPAD1 97 Numeric keypad 1 key VK_NUMPAD2 98 Numeric keypad 2 key VK_NUMPAD3 99 Numeric keypad 3 key VK_NUMPAD4 100 Numeric keypad 4 key VK_NUMPAD5 101 Numeric keypad 5 key VK_NUMPAD6 102 Numeric keypad 6 key VK_NUMPAD7 103 Numeric keypad 7
VK_F20 131 F20 key VK_F21 132 F21 key VK_F22 133 F22 key VK_F23 134 F23 key VK_F24 135 F24 key VK_NUMLOCK 144 NUM LOCK key VK_SCROLL 145 SCROLL LOCK key VK_LSHIFT 160 Left SHIFT key VK_RSHIFT 161 Right SHIFT key VK_LCONTROL 162 Left CONTROL key VK_RCONTROL 163 Right CONTROL key PrehKeyTec GmbH VK_LMENU 164 Left MENU key VK_RMENU 165 Right MENU key VK_PLAY 250 Play key VK_ZOOM 251 Zoom key MCI_TouchKey_TechDoc_RevC_en.
Technical Data Electronics: Supply voltage: Current consumption: Interface: LCD TouchKey: Backlight: Touch panel: +5 V ± 5% < 500 mA USB 5.
Additional help Recent versions of our programming software and more information can be downloaded from the support section on our website at: http://www.prehkeytec.com. Our customer support contacts are as follows: Email: support@prehkeytec.de or support@prehkeytecusa.com for North and Latin America Copyright © Copyright PrehKeyTec GmbH 2011 Published by PrehKeyTec GmbH.
