PrehKeyTec TouchKey
Description Version 1.2.0.1
This File descripes the usage of the PrehKeyTec TouchKey. It shows the parameters of the XML
Files. These parameters are necessary to communicate with the TouchKey.
File TouchKey.xml
<Device>
Start of TouchKey.xml. Always necessary.
<Serialnumber>
This field includes the
serialnumber of the TouchKey. You find the serialnumber on the bottom side of
the TouchKey on the label (e.g. 7264-0000002). More than one TouchKey can be
connected to the computer. So you need a different serial number for each
device.
sample: <Serialnumber>7264-0000002</Serialnumber>
<Contrast>
The contrast of the LCD is
set to the value in the contrast field at the start of the server. The
value is in the range 0 to 255.
sample: <Contrast>160</Contrast>
<Backlight>
The backlight of the
TouchKey is set to the value in the backlight field at the start of the server.
The value is in the range 0 to 15.
sample: <Backlight>15</Backlight>
<NumberOfLayers>
Number of all layout files
displayed on this TouchKey. For each layout you need an own layout file.
sample: <NumberOfLayers>2</NumberOfLayers>
<NumberOfGraphics>
Number of all graphics
displayed on this TouchKey. One or more graphics can be displayed in
a layout, a text field or as an own layout.
sample: <NumberOfGraphics>1</NumberOfGraphics>
<NumberOfText>
Number of all text fields
displayed on the TouchKey. One or more textfields can be displayed in a layout,
a graphic or as stand alone.
sample: <NumberOfText>3</NumberOfText>
<Layer>
The
layout name.
This name must be the same name as the according layout file. E. g. layout name
is "main" the according XML-File is "main.xml". More than
one layout names can be defined.
sample: <NumberOfLayers>2</NumberOfLayers>
<Layers>
<Layer>Liquor</Layer>
<Layer>Grocery</Layer>
</Layers>
<graphic>
The graphic name. This name must be the same name as the according graphic file. Description see <Layer>.
sample: <
sample:
<NumberOfGraphics>1</NumberOfGraphics>
<graphics>
<graphic>SpiritGraphic</graphic>
</graphics>
<txt>
The text
name. This name
must be the same name as the according text name. Description
see <Layer>.
sample: <NumberOfText>3</NumberOfText>
<text>
<txt>LiquorTxt</txt>
<txt>GroceryTxt</txt>
<txt>PaymentTxt</txt>
</text>
Additional devices can be
added. The TouchKey or interactive Customer Displays are selected by the
serialnumber.Add the same structure for the new device.
File <Layername>.xml
<Layer>
The
attribute contains the name of the XML schema. This schema validates the
<Layername>.xml file. If an incorrect <Layername>.xml file was
loaded the server stops with an error.
<name>
The name
of the layer.
sample: <name>Liquor</name>
<index>
The index of the layer. The first layer in the list described in TouchKey.xml has the index 0. This element ist unused at the moment.
<keytostart>
The
POS-Key which starts this layer. A POS Key can be programmed with the
WIN-Programmer on a key of the keyboard side (right side of the TouchKey
keyboard). This value is in the range 1 to 255 but the keyboard
sample: <keytostart>1</keytostart>
<buttondata>
Button data
describes all parameters of one key of the TouchKey.
<beep>
Creates a
keyclick of the key. The value can be "true" or "false".
sample: <beep>true</beep>
<beepfreq>
Frequency
of keyclick.
Range of 0 to 255. There are 4 steps of frequency.
Range 0 to 15, frequency of
4800 Hz
Range 16 to 31, frequncy of
2400 Hz
Range 32 to 63, frequency
of 1200 Hz
Above 64, frequency 600 Hz
<beepduration>
Duration
of keyclick.
Range of 0 to 255.
Value * 8,3 ms = Duration of keyclick
<inverse>
Shows inverse of the key if pressed. Not inverse state if key was released. Value is „true" or "false".
sample: <inverse>true</inverse>
<begininverse>
Button is set to inverse at
start. Value is “true" or "false".
sample: <begininverse>true</begininverse>
<keyboardoutput>
The programmed button on
the TouchKey sends a keycode as keyboardoutput. Value
"true" -> keyboard output, otherwise "false".
sample: <keyboardoutput>true</keyboardoutput>
<xpixel>
Set the x coordinate of the button. Maximum x is display width (320 pixel). Range 1 to 320.
<ypixel>
Set the y coordinate of the button. Maximum y is display height (240 pixel). Range 1 to 240.
<wpixel>
Set the width of the button. Maximum w is display width (320 pixel). Range 1 to 320.
<hpixel>
Set the height of the button. Maximum height is display height (240 pixel). Range 1 to 240.
<text>
Set the text of the button.
Special characters must be defined as code sequence (e. g. new line ).
sample: <text>Beer 6Pack</text>
<textmode>
Set the textmode of the
button. The following description defines the HEX value of textmode. The
value is in the range 0 to 255 (decimal).
|
Bit 0 |
Center text horizontally |
|
Bit 1 |
Center text vertically |
|
Bit 2 |
Right justify text |
|
Bit 3 |
Bottom justify text |
|
Bit 4 |
Do not
word wrap text |
|
Bit 5 |
Add
horizontal space for border |
|
Bit 6 |
Add
vertical space for border |
|
Bit 7 |
Turn alignment on |
<framemode>
Set the
framemode of the button. The following description defines the HEX value of the
framemode. The value is in the range 0 to 255 (decimal).
|
Bit 0 |
The
rectangle is drawn with rounded corner |
|
Bit 1 |
A shadow
is drawn at the right and tho bottom |
|
Bit 2 |
Blank
pixels are drawn outside the rectangle |
|
Bit 3 |
The inner
part of the rectangle will be erased |
|
Bit 4 |
Erasing
of the inner part is done with the inverse setting |
<font>
Set the
index of the font. The fonts have to be flashed before working with TouchKey. The
fonts are user defined. The manufactory settings are:
|
index |
Font |
|
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 |
<touchindex>
Defines the touch fiels index. The value must be in the range 0 to 63. A value of 255 (HEX FF) use the next free index.
<press>
Value "true"
send the keycode while pressing, "false"
send keycode while releasing.
<startlayer>
The name
of the layout which will be started when pressing this button.
sample: <startlayer>12PackMillerTxt</startlayer>
<buttonvalue>
Virtual
keycodes and scancodes are defined in this section.The end of a buttonvalue
section marks a zero keycode and a zero scancode package.
<vk_code>
See list keycodes.
<make>
Value
"true" for make code, "false" for break code.
<scan_code>
See list keycodes. A scan_code 0 must be set as end
tag.
sample:
<buttonvalue>
<vk_code>49</vk_code>
<make>true</make>
<scan_code>2</scan_code>
<scan_code>0</scan_code>
</buttonvalue>
<buttonvalue>
<vk_code>49</vk_code>
<make>false</make>
<scan_code>2</scan_code>
<scan_code>0</scan_code>
</buttonvalue>
<buttonvalue>
<vk_code>0</vk_code>
<make>false</make>
<scan_code>0</scan_code>
</buttonvalue>
Sends the key "1" to the Computer (press key "1" and
release key "1").
File <Text>.xml
<name>
The name
of the Text file.
sample: <name>12CoronaTxt</name>
<showinlayer>
The text was displayed in
the layout named in <showinlayer>.
sample: <showinlayer>Layout1</showinlayer>
The
textfield appears in layout "Layout1".
<keytostart>
The POS-Key which starts this textfield. A POS Key can be programmed with the
WIN-Programmer on a key of the keyboard side (right side of the TouchKey
keyboard). Values are in the range 1 to 255. Only 1 to 128 are
<erasedisplay>
Erase the
complete LCD area.
<textfield>
One or more
textfields follow.
<xpixel>
X position
in pixel of the textfield.
<ypixel>
Y position in pixel of the textfield.
<wpixel>
Width of
the textfield This value is used to erase the
textfield before writing again.
<hpixel>
Hight of
the textfield This value is used to erase the
textfield before writing again.
<font>
Set the
index of the font. The fonts have to be flashed before working with TouchKey. The
fonts are user defined. The manufactory settings are:
|
index |
Font |
|
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 |
<inverse>
Shows the
textfield inverse if pressed. Not yet
<setunderline>
Underline
the text. Not yet
<textstring>
Value of textfield. Special characters must be defined as code sequence (e. g. new line
).
<textmode>
Set the textmode of the
button. The following description defines the HEX value of textmode. The
value is in the range 0 to 255 (decimal).
|
Bit 0 |
Center text horizontally |
|
Bit 1 |
Center text vertically |
|
Bit 2 |
Right justify text |
|
Bit 3 |
Bottom justify text |
|
Bit 4 |
Do not
word wrap text |
|
Bit 5 |
Add
horizontal space for border |
|
Bit 6 |
Add
vertical space for border |
|
Bit 7 |
Turn alignment on |
File
<Graphic>.xml
<name>
The name of the Graphic file.
<showinlayer>
The graphic was
displayed in the layout named in <showinlayer>.
sample: <showinlayer>Layout1</showinlayer>
The
graphic appears in layout "Layout1".
<keytostart>
The POS-Key which starts this graphic. A POS Key can be programmed with the
WIN-Programmer on a key of the keyboard side (right side of the TouchKey
keyboard). Values are in the range 1 to 255. Only 1 to 128 are
<erasedisplay>
Erase the
complete LCD area.
<graphicfield>
One or more
graphics will be defined in this section.
<xpixel>
X position
in pixel of the graphic.
<ypixel>
Y position in pixel of the graphic.
<index>
The index of the graphic in flash memory. The graphic has to be flashed before running
TouchKey Server. You need the tool "iLCD Setup & Test" from
demmel products to download graphics and fonts.
<animated>
Set value
to "true" if graphic is animated otherwise "false".