Keba KeTop T100 User Manual

Download

Page 1

RGB ELEKTRONIKA AGACIAK CIACIEK

SPÓŁKA JAWNA

Jana Dlugosza 2-6 Street

51-162 Wrocław

Poland

biuro@rgbelektronika.pl

+48 71 325 15 05

www.rgbautomatyka.pl

www.rgbelektronika.pl

DATASHEET

www.rgbautomatyka.pl

www.rgbelektronika.pl

OTHER SYMBOLS:

C100 T2 1384364 72700 064863/0

KEBA

Page 2

YOUR PARTNER IN MAINTENANCE

At our premises in Wrocław, we have a fully equipped servicing facility. Here we perform all the repair

works and test each later sold unit. Our trained employees, equipped with a wide variety of tools and

having several testing stands at their disposal, are a guarantee of the highest quality service.

OUR SERVICES

ENCODERS

SERVO DRIVERS

LINEAR ENCODERS

SERVO AMPLIFIERS

CNC

MACHINES

MOTORS

POWER

SUPPLIERS

OPERATOR PANELS

CNC

CONTROLS

INDUSTRIAL COMPUTERS

PLC

SYSTEMS

Repair this product with RGB ELEKTRONIKA

ORDER A DIAGNOSIS

∠

Buy this product at RGB AUTOMATYKA

BUY

∠

Page 3

KeTop T100

Handheld Terminal

User's Manual V 3.1

Page 4

Notes on This Manual

At various points in this manual you will see notes and precautionary warn- ings regarding possible hazards. The meaning of the symbols used is ex- plained below.

• DANGER indicates an imminently hazardous situation which, if not avoided, will

result in death or serious injury.

• WARNING indicates a potentially hazardous situation which, if not avoided,

could result in death or serious injury.

DANGER

WARNING

CAUTION

• CAUTION indicates a potentially hazardous situation which, if not avoided, may

result in minor or moderate injury.

• CAUTION used without the safety alert symbol indicates a potentially hazardous

situation which, if not avoided, may result in property injury.

Note

Notes on use of equipment and useful practical tips are identified by the “Notice” symbol. Notices do not contain any information that draws atten- tion to potentially dangerous or harmful functions.

rights reserved. Document: version 3.1 / material no.: 57448

Filename: t100_en.doc, last saving on: 25. 10. 2006 KEBA AG, Postfach 111, Gewerbepark Urfahr, A-4041 Linz

Tel.: ++43 / 732 / 70 90-0, Fax: ++43 / 732 / 73 09 10, E-Mail: keba@keba.com, www.keba.com KEBA GmbH, Ulmer Straße 123, D-73037 Göppingen

Tel.: ++49 / 7161 / 97 41-0*, Fax: ++49 / 7161 / 97 41-40 KEBA Corp., 100 West Big Beaver Road, Troy, MI 48084

Tel. ++1 / 248 / 526 - 0561, Fax: ++1 / 248 / 526 - 0562, E-Mail: schr@us.keba.com

CAUTION

This symbol reminds you of the possible consequences of touching electrostatically sensitive components.

Page 5

Handheld Terminal Contents

History

For the description of modification of versions see the document revi- sion.doc.

User's Manual, version: 3.1 / material no.: 57448 3

Page 6

Contents KeTop T100

4 User's Manual, version: 3.1 / material no.: 57448

Page 7

Handheld Terminal Contents

Contents

Brief Description..............................................................................................................7

Target group of this manual...............................................................................................7

General information...........................................................................................................7

Intended Use of the Handheld Terminal............................................................................7

Construction.......................................................................................................................9

Ergonomic Features ........................................................................................................10

Housing............................................................................................................................10

Operating and Display Panel...........................................................................................10

Hardware.........................................................................................................................11

Type Plate........................................................................................................................12

2 Safety Precautions ........................................................................................................13

3 General Instructions......................................................................................................14

Waste disposal ................................................................................................................14

Handling of KeTop...........................................................................................................14

4 Connection.....................................................................................................................16

Cable Entrance Area .......................................................................................................16

Cable Routing in Cable Entrance Area............................................................................17

Power Supply...................................................................................................................18

Emergency Stop Button and grey Stop Button................................................................20

Enabling Switch...............................................................................................................22

Foreseeable Misuse of Enabling Switch..........................................................................28

Ethernet...........................................................................................................................30

RS-422-A.........................................................................................................................32

Serial port female connector S2 for Debug Interface (RS-232-C)...................................34

PC Card Slot for PC Cards I, II, III...................................................................................35

5 Membrane Keypad.........................................................................................................38

Standard..........................................................................................................................38

Numbering of LEDs .........................................................................................................44

6 Display............................................................................................................................45

Touch Screen ..................................................................................................................45

7 Software..........................................................................................................................46

Windows CE....................................................................................................................46

Generation of Program for Windows CE .........................................................................48

KeTop API Design...........................................................................................................49

Functions.........................................................................................................................51

Update API Design..........................................................................................................65

Initialising.........................................................................................................................66

Program for Starting the Application and KeTop API ......................................................70

User's Manual, version: 3.1 / material no.: 57448 5

Page 8

Contents KeTop T100

RDP – Connection via Remote Desktop Protocol...........................................................73

KVC – KEBA Virtual Channel..........................................................................................80

Remote Software ActiveSync..........................................................................................90

Test tool (VC++ Demo)....................................................................................................91

8 KeTop - Specific Operating Instructions.....................................................................95

Setting of Date and Time.................................................................................................95

KeTop Configuration Tool (ConfigTool)...........................................................................96

Checking the Operating and Control Elements.............................................................103

Installation of Programs.................................................................................................104

Saving Files...................................................................................................................104

Transfering Files............................................................................................................104

9 Options.........................................................................................................................107

Override Potentiometer .................................................................................................107

Electronic Handwheel....................................................................................................107

Illuminated Push-Button ................................................................................................108

Key Switch.....................................................................................................................108

Selector Switch..............................................................................................................108

Joystick..........................................................................................................................108

10 Accessories .................................................................................................................109

Wall bracket KeTop WB090 and KeTop WB095...........................................................109

Wall Bracket with Height Adjustment plate KeTop WBxxx............................................111

KeTop CB211 Connection Box......................................................................................113

Connection Cable KeTop TTxxx....................................................................................120

Intermediate Cable KeTop ICxxx...................................................................................121

Download Cable KeTop XD040.....................................................................................122

11 Transport Conditions..................................................................................................123

12 Technical Data.............................................................................................................124

13 CE Conformity, Directives and Standards................................................................127

European Union Directives............................................................................................127

Machinery Safety...........................................................................................................128

Electromagnetic Compatibility.......................................................................................139

List of the appropriate EC directives and applied standards.........................................150

6 User's Manual, version: 3.1 / material no.: 57448

Page 9

Handheld Terminal Brief Description

1 Brief Description

Target group of this manual

This manual is directed at designing and project engineers which apply this product for their machines. For end users such as operators however, se- perate manuals must be provided by the machine and plant manufacturer.

General information

The handheld terminal KeTop T100 is a portable operating and display de- vice with rugged design and Windows-CE compatible electronics. Using a high-performance Intel StrongARM processor and providing a se- rial interface or Ethernet, the KeTop T100 is ideal for a great variety of ap- plications (see next chapt. “

All tasks can be solved graphically and in color, and operation is intuitive using a touch screen.

Instead of rotating mass memories such as floppy disk and hard disk drives that are not suitable for rough environmental conditions, the KeTop T100 uses scalable FLASH and RAM banks.

The functionality of the handheld terminal can easily be expanded by using Compact Flash cards of the type I.

The KeTop T100 provides a Windows CE platform for applications gener- ated with common visualization tools or with C#, Visual Basic.NET or Visual C++.

Moreover, the KeTop T100 can be connected as a client to a Win NT, Win 2000 or Windows XP server.

Through the use of optional operating and control elements, the KeTop T100 can easily be adapted to the specific application.

Intended Use of the Handheld Terminal”).

Intended Use of the Handheld Terminal

The intended use of the Handheld Terminal covers tasks like watching and parametrizing up to operating of machines e.g.:

z Injection moulding machine z Robots z Machine tools z Textile machines

User's Manual, version: 3.1 / material no.: 57448 7

Page 10

Brief Description KeTop T100

z Printing machines z Theater backdrops z and similar.

in normal operating modes

z Automatic

as well as

z Setting, z Teaching, z Testing, z and similar.

in half automatic or manual mode. Enabling switches and an emergency stop button are the safety elements

of the device. The Handheld Terminal KeTop T50-ADP is intended for fixed connection to

a robot. Handheld Terminals for temporary connection must not have a red- yellow emergency stop button.

To meet the safety category 3 in accordance with EN 954-1, the safety functions are realized with 2 circuits.

The selection of the Handheld Terminal which is suitable for the machine and the projecting of the additional functions must obey the necessary haz- ard analyses and risk assessment bounded by law.

For intended use of the Handheld Terminal also please pay attention to chapter “

CE Conformity, Directives and Standards”.

8 User's Manual, version: 3.1 / material no.: 57448

Page 11

Handheld Terminal Brief Description

Construction

1................... override potentiometer (option)

2................... electronic handwheel or joystick (option)

3................... emergency stop switch (twin circuit) or stop switch

(option)

4a................. 2 status LEDs (standard)

4b................. further status LEDs (option)

5................... membrane keypad with tactile feedback

6................... color STN LC display with touch screen:

7.7" VGA resolution 640 x 480 or

8.4" SVGA resolution 800 x 600 (option)

7................... 2 locations for (option):

illuminated push-button, momentary 0 illumniated push-button, momentary I illuminated push-button, maintaining I/0

8................... 1 location for (option):

illuminated push-button, momentary 0 illuminated push-button, momentary I illuminated push-button, maintaining I/0 3-position key switch I-0-II / 0-I-II 3-position selector switch I-0-II / 0-I-II

9.....................two 3-position enabling switches (left and right),

twin circuit

10...................multigrip handle

11...................PC card cover

12...................strain relief for connection cable (delivered with

the cable)

13...................cable entrance area

14...................blind plug for cable outlet not used

(to meet protection degree IP54)

NOTICE: All optional operating elements are described in the chapter „Options" on page 107.

Construction of KeTop T100

User's Manual, version: 3.1 / material no.: 57448 9

Page 12

Brief Description KeTop T100

Ergonomic Features

z Multigrip handle z Round housing z Different holding positions z Operation by right-handed and left-handed people z Desk top operation z Operation in wall bracket z The cable outlet can be on the left or right side of the housing. z Easy-to-read display

Housing

z Vibration- and shock resistance z Housing made of non-flammable material (UL 94-V0), impact-resistant,

withstands water, cleaning agents (alcohol and tensides), oil, drilling oils, grease and lubricants

z Double-walled, extremely sturdy ABS housing. Drop-tested on industrial

flooring from a height of 1.0 m (39.4 in).

Operating and Display Panel

z Membrane keys with tactile feedback z 2 status LEDs z Buzzer in upper part of housing z Resistive touch screen, to be operated with finger or stylus

z Backlit color STN LC display

7.7“ VGA (640x480 pixels) or

8.4“ SVGA (800x600 pixels)

10 User's Manual, version: 3.1 / material no.: 57448

Page 13

Handheld Terminal Brief Description

Hardware

z CPU Intel StrongARM SA-1110/206 MHz z Memory:

z DRAM: 16 MB, FLASH: 32 MB or z DRAM: 64 MB, FLASH: 64 MB

z Interfaces:

z Ethernet z Serial interface:

RS-422-A (option), RS-232-C (debug interface in device)

z PC card slot, with dust protection cover to guarantee IP54 when the

device is closed: For connection of various PC card components, type I-III (flash cards, network cards, etc.).

User's Manual, version: 3.1 / material no.: 57448 11

Page 14

Brief Description KeTop T100

Type Plate

Sample of a KEBA type plate:

KeTop T100 - TFT - 002 - CES / 67830 / 05 Use CLASS 2 Source

24 VDC/0,3 A

6 7

P54941 - 01894

Ser. Nr.:

1 Serial number 2 Material name 3 Material number 4 Revision number of device 5 Further information (optional) 6 Technical data (here: power supply) 7 Bar code 8 CE marking 9 Advice for electronic scrap regulation 10 UL marking 11 NSBIV marking 12 Date of production (month/year)

Description of a KEBA type plate

03/06

USC

LISTED

IND. CONT. EQ

21YA

mm/yy:

12 User's Manual, version: 3.1 / material no.: 57448

Page 15

Handheld Terminal Safety Precautions

2 Safety Precautions

The device was developed, manufactured, tested and documented in ac- cordance with the applicable safety standards. If you follow the instructions regarding safety and use as described in this manual (see chap. „ Use of the Handheld Terminal“), the product will, in the normal case, nei- ther cause personal injury nor damage to machinery and equipment.

The instructions contained in this manual must be precisely followed in all circumstances. Failure to do so could result in the creation of potential sources of danger or the disabling of safety features integrated in the handheld terminal.

Apart from the safety instructions given in this manual, the safety precau- tions and accident prevention measures appropriate to the situation in question must also be observed.

WARNING

Intended

• For the right projecting of the Handheld Terminal the manufactorer must enforce

a hazard and risk analysis. The following safety aspects must be considered:

- Right cable length for limitation of workspace.

- Is an emergency stop button necessary and permissible?

- Is the safety category for the application sufficient

• The device may be operated in faultless condition only and the operating in-

structions must be observed.

• The operator must have a sufficient educational level and must know details of

intended use described in the user’s manual.

• The safety advices in the following chapters must be considered absolutely.

• Further informations to safety and EMC are included in chapt. „

Directives and Standards“. They must be considered absolutely.

CE Conformity,

User's Manual, version: 3.1 / material no.: 57448 13

Page 16

General Instructions KeTop T100

3 General Instructions

Waste disposal

Observe the national regulations when disposing of electronic components!

Handling of KeTop

You have chosen a high-quality KeTop that is equipped with highly sensi- tive state-of-the-art electronics. To avoid malfunctions or damage through improper handling, follow these instructions during operation.

CAUTION

• Turn off the power supply before opening the cable entrance area of the KeTop.

Otherwise the components could be destroyed or undefined signals could oc- cur.

• Make sure that nobody can fall over the cable to avoid that the device falls to

ground.

• Take care not to squeeze and thus damage the cable with any object.

• Do not lay the cable over sharp edges to avoid damaging the cable sheath.

• If you do not use the device, hang it into the wall bracket KeTop WBxxx provided

for storage.

• Do not lay down the device with the operating side facing down to avoid damag-

ing the operating elements.

• Never lay the device onto unstable surfaces. It could fall to ground and thus be

damaged.

• Never lay the device close to heat sources or into direct sunlight.

• Avoid exposing the device to mechanical vibrations, excessive dust, humidity or

to strong magnetic fields.

• Never clean the device, operating panel and operating elements with solvents,

scouring agent or scrubbing sponges. For cleaning the device, use a soft cloth and a bit of water or a mild cleaning agent.

• Make sure that no foreign objects or liquids can penetrate into the device. Check

at regular intervals the protective covers of the device, if all housing screws are firmly tightened and if the housing or the cable entry is damaged.

• If the device shows any defect, please send it, including a detailed error descrip-

tion, to your supplier or the relevant after-sales service office.

14 User's Manual, version: 3.1 / material no.: 57448

Page 17

Handheld Terminal General Instructions

• If the KeTop is equipped with a touch screen, then operate the touch scre en with

fingers or use a touch-pen. Never use sharp objects (e.g. screwdriver,...) for op- erating the touch screen. This could damage the touch screen.

When the cable entrance area is open, the KeTop is sen- sitive to electrostatic discharge.

Note

• Should the device fall to the ground, make sure that the PC card cover

is correctly closed.

• If a PC card is used in the KeTop, make sure that the card is correctly

seated in case of a severe shock, e.g. if the KeTop has been dropped.

(Although the PC card cover remains closed after a shock, the card it- self can become dislodged from its socket in the mounting slot, so that

the electrical contacts are interrupted.)

User's Manual, version: 3.1 / material no.: 57448 15

Page 18

Connection KeTop T100

4 Connection

Cable Entrance Area

Blind plug

must be used to ensure impermeability!

Serial port female connector S2 for debug interface (RS-232-C)

for downloading software and locating errors

Main connector (male)

for power supply and control lines

Ethernet connector

for data exc hange

Reset button

for reboot ing Windows CE. ATTENTION: All data not saved get lost.

Dip switches RS-422-A:

ON:

OFF:

B2, B3, B4, B6

Serial port

S19

Ethernet

Dip switches

to select the RS-422-A inte rf ace (for the setti n g, see the adhes ive label for KeTops wi th RS-422-A interface)

Adhesive label

for CPU serial number and Ether net (MAC) - addres s (see below )

Reset

B5 B4

00:60:B5:06:00:01

Location of

dip switches:

AABBCCDDEEFF

2250-00001

B2 B6 B3

RS-42 2- A co nnector

for data exc hange

B2 B6 B3

S6,

COM-Modul

Strain relief

for connecting cable (on left or right side) ATTENTION: Use blind plug on cable outlet not used.

Adhesive label for KeTops with RS-422-A i n t er f ace

with lo cation and position of dip switches for thi s interf ace

Or adhesive label for KeTops with Ethernet int erfa ce

only identification of serial port and reset button:

Serial port

Reset

Cable entrance area of KeTop T100

Adhesive label for CPU serial number and Ethernet (MAC)-address

Adhesive label for CPU serial number and Ethernet-address

16 User's Manual, version: 3.1 / material no.: 57448

00:60:B5:06:00:01

2250-00001

KeTop-T100 CPU serial number

Ethernet (MAC) address

ID for KEBA ID for KeTop-T100 KeTop-T100 CPU serial number (the last five digits, hex-coded)

Page 19

Handheld Terminal Connection

Cable Routing in Cable Entrance Area

After opening the cable entrance area, the connecting lines can be routed as described in the following chapters. Before opening the KeTop please pay attention to the following safety instructions:

Instructions for opening the cable entrance area:

• Lay the KeTop with the display facing down onto a plane and clean ta-

ble (preferable on ESD pad) and take care not to damage the KeTop and its operating elements.

• For opening and closing the cable entrance area use the following type

of screwdriver: „Phillips size 2“.

Instructions for modifications in the cable entrance area:

• Unplug the main connector (S19) by pulling on its wires with your fin-

gers. Do not use any sharp objects.

• For unplugging the RJ-45 jack (S4 / S6), actuate the locking lever:

S4 / S6

S19S19

Make sure that the connectors S19 and S6 correctly snap in when you plug them in. Otherwise the emergency stop functionality (S19) or the correct shielding (S4/S6) might not be given any more.

Instructions for closing the cable entrance area: Make sure that

• the sealing is clean, not damaged and correctly positioned in the cable

entrance area,

• no cables are squeezed in,

• the cover of the cable entrance area is attached again with all 6 screws

(torque: 0.4 bis 0.5 Nm). Otherwise the protection degree cannot be guaranteed.

User's Manual, version: 3.1 / material no.: 57448 17

Page 20

Connection KeTop T100

Cable outlet RS-422-A

S6,

COM-Modul

S19

Dummy plug

S19

Dummy plug

COM-Modul

Right Left

Cable outlet on left and right side if the RS-422-A interface is used.

Cable outlet Ethernet

S19

Right Left

Cable outlet on left and right side if the Ethernet interface is used.

Dummy plug

S6,

COM-Modul

S19

Dummy plug

S6,

COM-Modul

Power Supply

• The device meets the safety class III in accordance with EN61131-2 and EN50178.

The 24V power supply for the equipment must be guaranteed through safe iso- lation of the extra low-voltage circuits from dangerous-contact voltage circuits (e.g. by safety transformers or similar facilities).

18 User's Manual, version: 3.1 / material no.: 57448

WARNING

Page 21

Handheld Terminal Connection

CAUTION

• The power supply circuit must be protected with a fuse of a maximum o f 3.15 A

Notice

• When planning the power supply, take into account the voltage drop on

the KeTop TTxxx connection cable:

Specification of power supply lines in the KeTop TTxxx connection ca- ble:

Cross section: AWG24 (0.24mm²) Material: zinc-coated copper strand Line resistance: ≤ 90 Ohm/km (≤ 145 Ohm/mile)

• The nominal supply voltage directly on the handheld terminal (without

KeTop TTxxx connection cable) is: +24 VDC (supply voltage range: 18-32 VDC).

• Power consumption:

7.2 W (400 mA at 18 V DC, 300 mA at 24 V DC)

• Maximum interruption time of supply voltage:

≤

10 ms (lt. IEC 61131)

User's Manual, version: 3.1 / material no.: 57448 19

Page 22

Connection KeTop T100

Emergency Stop Button and grey Stop Button

The emergency stop button respectively the grey stop button used on the KeTop features two circuits. The contacts are normally closed.

The red-yellow emergency stop button of the handheld terminal meets the requirements of the EN 418. It must be designed as an emergency stop of category 0 or category 1 (see EN 60204-1 chapter 9.2.5.4.2) on the basis of the risk assessment for the machine. The connection of the positive- break contacts to an appropriate monitoring system must meet the safety category which is defined by means of the risk assessment (in accordance with EN 954-1) of the machine.

Optionally the KeTop T50-ADP is also availabel with a grey stop button in- stead of the red-yellow emergency stop button. In principal the grey stop button has the same functionality as the red-yellow emergency stop button. If the handheld terminal is not plugged in, the grey color of the stop button should avoid the usage of the non-effective (emergency) stop button in dangerous situations.

The grey stop button fulfils also all mechanical aspects of the EN 418 and differs from the emergency stop button only by its color.

WARNING

• Not fully functional emergency stop devices may have fatal consequences!

Emergency stop switches which are red-yellow marked must be effective under all circumstances in all operating modes of a machine or plant.

Store handheld terminals with not operational red-yellow emergency stop switches on a place where the operator cannot see it, so that he can not mistake the device.

Handheld terminals which are plugged in and out frequently for temporarely use, must not have a red-yellow emergency stop switch. Such devices must be equipped with a grey stop switch.

• Resetting an activated emergency stop facility must not result in uncontrolled

start-up of machines or installations.

• The emergency stop button does not replace other safety facilities.

• The emergency stop button on the handheld terminal does not replace the

emergency stop buttones to be mounted directly on the machine

• Some mechanical errors in emergency stop switches can be recognized at op-

eration only. Test the function of the emergency stop switch when the device had been ex-

posed to mechanical shock (e.g. it had been fallen on the ground) Note for maintenance:

Additionally the emergency stop switch must be tested cyclic (6 monthly). Watch the machine stopping after the emergency stop switch had been pushed.

20 User's Manual, version: 3.1 / material no.: 57448

Page 23

Handheld Terminal Connection

• For further informations to emergency stop switch observe chapt. “CE Confor-

mity, Directives and Standards“.

Connection values

z Connection voltage: 24 VDC z Maximum current: 500 mA z Minimum current: 10 mA

User's Manual, version: 3.1 / material no.: 57448 21

Page 24

Connection KeTop T100

Enabling Switch

The KeTop is equipped with two enabling switches, one at the left and one at the right side of the device. This allows a left- and right-hand operation of the enabling switch. Both enabling switches are equivalent and parallel switched. So for enabling only one of both enabling switches must be acti- vated.

The enabling switch consists of a 3-position operating element and an separated evaluation electronics. An essential feature are the continuous two-channel circuits beginning from the actuating elements up to the con- necting terminals. For the evaluation circuits different technologies and cir- cuits are used. Due to the electronic switching contacts, their lifetime does not depend on the load provided the nominal values of the load (ohmic, in- ductive and capacitive) are not exceeded.

Functioning

The actuating element consists of two symmetrically arranged slides. The position of these slides is detected by electrical switches and transmitted to the evaluation electronics.

Positions of enabling switch:

Enabling

Position Function Enabling switch Contacts

1 home position is not pressed enabling outputs are open 2 enabling is pressed enabling outputs are closed 3 panic is pressed strong enabling outputs are open

For the enabling switch, the following switching sequences are possible:

Home position

enabling

home position

12 3

OFF OFF ON

OFF ON OFF ON

Enabling

switch

123

Evaluation electronics

Circuit 1Circuit 2

Circuit 1 Circuit 2

x ... L (Left) or R (Right) Contact travel diagram for enabling

22 User's Manual, version: 3.1 / material no.: 57448

Page 25

Handheld Terminal Connection

Panic

The pushing of the actuating elements into the panic position is evaluated in a way that the enabling position is skipped when the actuating elements are released.

Home position

enabling u panic

12 3

home position

Enabling

switch

x ... L (Left) or R (Right) Contact travel diagram for panic

Evaluation electronics

123

Circuit 1Circuit 2

123

Circuit 1 Circuit 2

OFF OFF

ON ON

OFF OFF OFF OFF OFF OFF

OFF OFF

Notice

• At the KeTop, the enabling switches always feature two circuits.

To meet the safety category 3 in accordance with EN 954-1:1996, the ena- bling switch must be realized with 2 circuits.

The safety category 3 means, that one failure must not lead to the loss of the safety function, and whenever possible, the single failure is detected.

The chapters „

Example of Connection with ELAN SRB-NA-R-C.27/S1 Control Relay”

“ show how the safety category 3 can be fulfilled with the KeTop and its safety-related parts. The entire concept of the machine must be laid out ac- cording to the principles of safety category 3.

The monitoring of the simultaneity by the control relay is necessary, be- cause otherwise maybe a failure culmination would not be recognised and this would cause the loss of safeness:

If one circuit of the enabling device switches to the enabled state as a result of a failure and after some time the second circuit also switches to the en- abled state as a result of an failure, then no de-energisation by the enabling device would be possible.

Example of Connection with PILZ PST1 Control Relay“ and

User's Manual, version: 3.1 / material no.: 57448 23

Page 26

Connection KeTop T100

Further the EN 60204-1:1997 prescribes that the enabling switches shall be connected to a category 0 stop or a category 1 stop, that means the energy must be switched off.

24 User's Manual, version: 3.1 / material no.: 57448

Page 27

Handheld Terminal Connection

Example of Connection with PILZ PST1 Control Relay

KeTop

(2 enabling switches with

3 positions and 2 circuits each)

123

321

Control cabinet

+24 VDC

F1 1A

Feedback

control loop

4A(t) 6A(f)

123

converter

S19:

K3:

DC/DC

67 67

Evaluation electronics

Cir cuit 1 Circuit 2

12 34 12 34

7 8 12 17K1: 1 2

K1:

K3:

+24V GND ED1+ ED1- ED2+ ED2-

7 8 12 1712

321

Connect ion cable KeTop TTxxx

17-pin coninvers jack

Intermediate cable KeTop ICxxx

Terminal block socket K3 on connection box

Male connector X1 on connection box

Connect ion box

+24V GND ED1+ ED1- ED2+ ED2-K4:

GND

4A(t)

6A(f)

3,15A

Male connector X2 on conncec tion box

Terminal block socket K4 on connection box

KA KB

A1(+) 23 S11

X1 X2

PILZ PST1

A2(-)

GND

Suggested wiring of enabling switches to fulfill safety category 3 with PILZ control relay. Also follow the instructions described in the PILZ operating manual about the PST1 device.

User's Manual, version: 3.1 / material no.: 57448 25

14 24 S23 S24

KA KB

GND GND

S12

L1 L2 L3

Note: All contacts of KA and KB must be forced-guided!

Enabling of

dangerous movement!

Page 28

Connection KeTop T100

Functional procedure:

z Only if both channels are activated „simultaneously“ (by pressing one of

the enabling switches) both output relays K1 and K2 will energize and the output contacts 13-14 and 23-24 will close.

z The output relays K1 and K2 will not energize if

z only one enabling channel is activated (in case of a defect), z the tolerance value for the simultaneity period is exceeded, z the feedback control loop X1-X2 is open.

z If one enabling channel is deactivated after being simultaneously acti-

vated (by releasing the enabling switch or in case of a defect), the out- put relays K1 and K2 will return to their initial position again. The forced-guided output contacts 13-14 and 23-24 will open. The out- put relays will energize again only after both enabling channels have been deactivated and simultaneously activated once again.

In this way the enabling switches avoid that one single error makes the safety function inoperational. A single error will be recognized at the next cycle at the latest.

26 User's Manual, version: 3.1 / material no.: 57448

Page 29

Handheld Terminal Connection

Example of Connection with ELAN SRB-NA-R-C.27/S1 Control Relay

KeTop

(2 enabling switch es with

3 positions and 2 circuits each)

123

321

123

DC/DC

converter

S19:

K3:

K1:

+24V GND ED1+ ED1- ED2+ ED2-

K3:

+24V GND ED1+ ED1- ED2+ ED2-K4:

+24VDC

Cir cuit 1 Circuit 2

12 34 12 34

7 8 12 17K1: 1 2 7 8 12 1712

GND

Evaluation electronics

321

Connection cable KeTop TTxxx

17-pin coninvers jack

Intermediate cable KeTop ICxxx

Terminal block socket K3 on connec tion box

Male connector X1

on connec tion box Connection box Male connector X2

on connc ec tion box Terminal block socket K4

on connec tion box min. 0,3 mm² Cu

Control ca binet

+24VDC

C C1 S11 S12 S13 S21 S41 13 23 33 41

Rear side of

component

GND

L13D

Suggested wiring of enabling switches for safety category 3 with the ELAN SRB-NA-R-C.27/S1 control relay. In addition follow the instructions of the operating manual about the SRB-NA-R-C.27/S1.

User's Manual, version: 3.1 / material no.: 57448 27

KA KB

S1K1K2

L11

K1K1K2

L14D2

Short-circuit

detection

K3K2K1

KA KB

Notes: 1) Al l cont acts of KA and KB must be forced-guided.

2) S4 and S1 on the rear side of the component must be set to the position 0.

L1 L2 L3

Enabling of dangerous movement!

Page 30

Connection KeTop T100

Functional procedure:

z Only if both channels are activated „simultaneously“ (by pressing one of

the enabling switches) both output relays K2 and K3 will energize and the output contacts 13-14, 23-24 and 33-34 will close.

z The output relays K2 and K3 will not energize if

z only one enabling channel is activated (in case of a defect), z the tolerance value for the simultaneity period is exceeded, z the feedback control loop S11-S12 is open.

z If one enabling channel is deactivated after being simultaneously acti-

vated (by releasing the enabling switch or in case of a defect), the out- put relays K2 and K3 will return to their initial position again. The forced-guided output contacts 13-14 and 23-24 will open. The out- put relays will energize again only after both enabling channels have been deactivated and simultaneously activated once again.

In this way the enabling switches avoid that one single error makes the safety function inoperational. A single error will be recognized at the next cycle at the latest.

Foreseeable Misuse of Enabling Switch

Foreseeable misuse means the not allowed fixing of the enabling switch in the enabling position. The foreseeable misuse of the enabling switch must be restricted. The following measures causing the stop of the machine in the manual mode are recommended:

z Inquiry of the enabling switch when turning on the machine/plant and

inquiry of the enabling switch when changing the operating mode from automatic to manual (The enabling switch must not be in the enabling position.).

z The enabling switch must be released within a defined period and

pushed into the enabling position again. The length of the period must be defined according to the activity.

28 User's Manual, version: 3.1 / material no.: 57448

Page 31

Handheld Terminal Connection

Technical Data of Switching Elements of Enabling Switches

Nominal voltage 24 V DC (typ.) 32 V DC (max.) Nominal current 500 mA (typ.) Short-circuit current circuit 1: max. 1,9 A circuit 2: max. 600 mA Max. inductive load (at 500 mA) circuit 1: max. 1H circuit 2: max. 320 mH Max. capacitive load circuit 1: no limit since the transistor is protected thermally circuit 2: max. 500 µF

The switching elements of the enabling switches are protected against re- versed polarity. The outputs of both circuits are protected against short cir- cuits and excess load.

Circuit 1: thermal protective circuit Circuit 2: fold back line

WARNING

• The enabling switch is only suitable as safety function if the operator activating

the enabling switch recognizes the dangerous situation in time so that he can immediately take the necessary measures to avoid such situations. As additional measure reduced speed of the movement can be necessary. The allowed speed must be determined by means of a risk assessment.

• The enabling switch is only used to enable commands for performing dangerous

movements. The commands themselves must be activated by a separate oper- ating element (key on handheld terminal).

• Only the person who operates the enabling switch is allowed to work in the dan-

gerous area.

• For further informations regarding the enabling switch please pay attention to

chapter „

CE Conformity, Directives and Standards“.

User's Manual, version: 3.1 / material no.: 57448 29

Page 32

Connection KeTop T100

Ethernet

The standard version of the KeTop is equipped with an Ethernet interface. This interface is based on the 10BaseT specification and suitable for the half-duplex mode.

The data communication for these interfaces takes place via the Ethernet connector S4 in the cable entrance area of the KeTop.

The following interface parameters are defined and cannot be changed:

z 10 Mbaud z TCP/IP protocol

The Ethernet interface is selected under Windows CE as follows:

Start -> Settings -> Control Panel -> Network and Dial-up Connections:

Here you can select the Ethernet on-board interface SMSC91C9X.

WARNING

• If the KeTop and the control do not communicate via a point-to-point connection,

it may happen that the keypad data, for example, are transmitted with a delay. Therefore it is advisable to establish the connection between the contro l and

the KeTop only via an Ethernet switch which enables a point-to-point connec- tion.

If an Ethernet PC card is inserted into the PC card slot, the internal Ethernet interface must be deactivated.

The selection between the internal Ethernet or the PC card Ethernet inter- face is made in the „ConfigTool“. See chapter „ (ConfigTool“ on page

96).

KeTop Configuration Tool

The positions of the Dip switches in the cable entrance area are not rele- vant for this interface.

30 User's Manual, version: 3.1 / material no.: 57448

Page 33

Handheld Terminal Connection

1 2 3

Connection cable

KeTop TTxxx

pink

black

brown-green

white-green

grey-pink

red-blue

brown yellow green

grey

violet

blue

white

orange

red

1 2 3 4 5 6 7 8

12 17 11

13 14 15

Intermediate cable

KeTop IC 2 x x

1 2

brown-green

white-green

grey-pink

red-blue

6 7

8 12 17 11

13 14

orange

15 16

pink

black

brown yellow green

grey

violet

blue

white

red

not used

E-STOP_ES1+

E-STOP_ES1-

E-STOP_ES2+

E-STOP_ES2-

ENABLE_ED1+

ENABLE_ED1-

ENABLE_ED2+

ENABLE_ED2-

+24 V DC

GND

RD+ RD- TD+ TD-

SHIELD)

24 VDC GND_IN

2 3

Emergency stop, circuit 1 Emergency stop, circuit 1

4 5

Emergency stop, circuit 2

Enabling switch, circui t 1, pos.

Enabling switch, circui t 1, neg.

Enabling switch, circui t 2, pos.

Enabling switch, circui t 2, neg.

Ethernet

1 2 3 4 5 6

External device

RJ45

Hub / PC

3 (RD+) / 6 (RD-) / 1 (TD+) / 2 (TD-) /

Pin numbering RJ45:

Top:

e.g.:

1 (TD+) 2 (TD-) 3 (RD+) 6 (RD-)

KeTop Connection Box KeTop CB211

S19 K3

6 7 8 9 10 11 1 2 3 4 5

TD+

TD-

RD+

RD-

Wiring diagram: KeTop T100 with Ethernet via connection box KeTop CB211

Front:

User's Manual, version: 3.1 / material no.: 57448 31

Page 34

Connection KeTop T100

RS-422-A

The serial data communication for this interface requires the installation of an optional module in the KeTop. The communication takes place via the COM module connector S6 in the cable entrance area of the KeTop.

Notice

• The simultaneous use of the Ethernet interface and the RS-422-A inter-

face is not possible.

The RS-422-A interface assigned to the COM 5 interface port is in the soft- ware. The interface parameters are set via the WIN32API in the Windows operating system.

6 7 8 9 10 11 1 2 3 4 5

1 2 3

Connection cable

KeTop TTxxx

pink

black

brown-green

white-green

grey-pink

red-blue

brown yellow green

grey

violet

blue

white

orange

red

3 4 5 6 7 8 12 17 11

Intermediate cable

KeTop IC 2 x x

black

brown-green

white-green

grey-pink

red-blue

brown yellow green

grey

violet

13 14 15 16

white

orange

pink

blue

red

E-STOP_ES1+

E-STOP_ES1-

E-STOP_ES2+

E-STOP_ES2-

ENABLE_ED1+

ENABLE_ED1-

ENABLE_ED2+

ENABLE_ED2-

13 14 15 16

+24 V DC

GND

A' (RXD-)

B' (RXD+)

A (TXD-)

B (TXD+)

SHIELD

24 VDC GND_IN

2 3

Emergency stop, circuit 1 Emergency stop, circuit 1

4 5

Emergency stop, circuit 2

Enabling switch, circui t 1, pos.

Enabling switch, circui t 1, neg.

Enabling switch, circui t 2, pos.

Enabling switch, circui t 2, neg.

RS-422-A

1 2 3 4 5 6

External device

A (TxD-) B (TxD+) A' (RxD-) B' (RxD+)

KeTop Connection box KeTop CB21 1

S19 K3

A (TXD-) B (TXD+) A'(RXD-)

B'(RXD+)

Dip switches for RS-422-A:

B2 B3 B4 B5 B6

OFF OFF OFF ON OFF

Wiring diagram: Connection of KeTop T100 with RS-422-A via connection box KeTop CB211

32 User's Manual, version: 3.1 / material no.: 57448

Page 35

Handheld Terminal Connection

General information about the RS-422-A interface

z The A terminal of the generator shall be negative with respect to the B

terminal for a binary 1 (MARK or OFF) state.

z The A terminal of the generator shall be positive with respect to the B

terminal for a binary 0 (SPACE or ON) state.

To identify the lines, the voltage between the lines A and B can be meas- ured by means of a voltameter.

User's Manual, version: 3.1 / material no.: 57448 33

Page 36

Connection KeTop T100

Serial port female connector S2 for Debug Interface (RS-232-C)

Using the „Boot-Loader“ software, the „serial port“ interface can be used for debugging and for downloading software. Using the remote software Ac- tiveSync, it can be used for adjusting and transmitting data from and to a PC.

For that purpose, the download cable KeTop XD040 is available. The following interface parameters are defined and cannot be changed:

z 38400 baud z 8 data bits z 1 stop bit z No parity z No handshake

The debug interface is assigned to the COM 1 interface port in the soft- ware.

The positions of the Dip switches in the cable entrance area are not rele- vant for this interface.

34 User's Manual, version: 3.1 / material no.: 57448

Page 37

Handheld Terminal Connection

PC Card Slot for PC Cards I, II, III

The following list gives an overview about the tested PC cards and their manufactors. These PC cards are recommended for the use in the KeTop.

ATA flash cards:

• Manufacturer: Kingston, SanDisk, Kingmax, Viking Type: All PC cards type II Memory sizes: 8 MB and more

PC card adapter for CompactFlash (CF) cards:

• Manufacturer: Hama Type: PC card adapter CF type II, Hama art. no. 56949

• Manufacturer: Kingston Type: CF/ADP Compact Flash PC card adapter

• Manufacturer: Ultron Type: UPA-150 PCMCIA adapter for compact flash card

Ethernet cards:

• Manufacturer: Socket ( Name: LP-E Ethernet Card Type: PC cards type II Transmission rate: 10 Mbit/s Special features: NE2000 compatible

• Manufacturer: Orinoco ( Name: WaveLan Silber IEEE 802.11 Transmission rate: 11 Mbit/s Special features: Wireless LAN-Card

Modem cards:

• Manufacturer: TDK ( Name: Global Freedom 5660 Type: PC card type II

Notice

http://www.tdksys.com/Products/5660.html)

http://www.socketcom.com)

http://www.wavelan.com)

• The KeTop does not support CardBus cards.

• PC cards which use 12 V programming voltage are not supported by

the KeTop.

• SRAM cards are not supported by Windows CE.

User's Manual, version: 3.1 / material no.: 57448 35

Page 38

Connection KeTop T100

Inserting the PC Card

Lay the KeTop with the display facing down onto a plane and clean table (preferably on ESD pad) and take care not to damage the KeTop and its operating elements.

1) Open the cover.

2) Insert the PC card as shown.

ATTENTION:

Take care that this corner is inserted into the slot on the side of the ejection button.

Ejection button

Unlock the PC card cover as shown (until the locking lever is released).

ATTENTION:

Check the condition and the position of the sealing before closing the PC card cover.

Insert the PC card until it locks in and the ejection button jumps out.

1) Close the cover.

2) and 3) Lock t he cover as shown.

Press down the cover until it snaps in completely to meet the protection degree IP54.

Must snap in completely!

36 User's Manual, version: 3.1 / material no.: 57448

Page 39

Handheld Terminal Connection

Removing the PC Card

1 2

1) Open the PC card co ve r. Unlock the PC card cover as shown (until the locking lever is released).

2) Press the ej ection button of th e PC card slot.

3) Remove the PC card.

3 4

1) Close the cover.

2) and 3) Lock t he cover as shown.

Press down the cover until it snaps in completely to meet the protection degree IP54.

Must snap in completely!

User's Manual, version: 3.1 / material no.: 57448 37

Page 40

Membrane Keypad KeTop T100

5 Membrane Keypad

Standard

General Membrane Keypad

Keypad Assignment

The keypad assignment is stored in the registry and defined for the general membrane keypad as follows:

Key Labelling Windows Virtual Key

Code

ESC Menü Numpad figures 0-9 Dot (.) Minus (-) Enter Backspace Tabulator

Page Down Page Up Cursor Up Cursor Left Cursor Right Cursor Down

Illuminated push-button, left Key switch/selector switch, left Key switch/selector switch, right Illuminated push-button, right

Depending on the size of the display, two general membrane keypads are available:

K_ESCAPE 0x1B 27 K_MENU 0x12 18 K_0-9 0x30 - 0x39 48 - 57 K_PERIOD 0xBE 190 K_OEM_MINUS 0xBD 189 K_RETURN 0x0D 13 K_BACK 0x08 8 K_TAB 0x09 9

K_NEXT 0x22 34 K_PRIOR 0x21 33 K_UP 0x26 38 K_LEFT 0x25 37 K_RIGHT 0x27 39 K_DOWN 0x28 40

K_F13 0x7C 124 K_F14 0x7D 125

K_F15 0x7E 126 K_F16 0x7F 127

Hex Dez

38 User's Manual, version: 3.1 / material no.: 57448

Page 41

Handheld Terminal Membrane Keypad

a) 7.7“ display (640x480 pixels)

ESC key

ESC

Run-LED, green (LED No. = 3)

Error-LED, red (LED No. = 4)

Numeric keypad

Enter and backspace

Tabulator

General membrane keypad for 7.7“ display

7 8 9 4 5 6 1 2

KeTop

Page down/u p

Arrow keys

User's Manual, version: 3.1 / material no.: 57448 39

Page 42

Membrane Keypad KeTop T100

b) 8.4“ display (800x600 pixels)

ESC key

ESC

Run-LED, green (LED No. = 3)

Error-LED, red (LED No. = 4)

Numeric keypad

Enter and backspace

Tabulator

General membrane keypad for 8.4“ display

7 4

8 9 5 6

1 2 3

KeTop

Page down/u p

Arrow keys

40 User's Manual, version: 3.1 / material no.: 57448

Page 43

Handheld Terminal Membrane Keypad

Robotics Membrane Keypad

Keypad Assignment

The keypad assignment is stored in the registry and defined for the robotics membrane keypad as follows:

Key Labelling Windows Vitual

Hex Dez

Key Code

Page Down VK_NEXT 0x22 34 Page Up VK_PRIOR 0x21 33 Cursor Up VK_UP 0x26 38 Cursor Left VK_LEFT 0x25 37 Cursor Right VK_RIGHT 0x27 39 Cursor Down VK_DOWN 0x28 40 Menue VK_MENU 0x12 18 Enter VK_RETURN 0x0D 13 Delete VK_DELETE 0x2E 46 ESC VK_ESCAPE 0x1B 27 Help (?) VK_SHIFT +

VK_SLASH

0x10 + 0xBF

16 +

191 Start VK_1 0x31 49 Stop VK_0 0x30 48

V- no VK Code defined 0xC1 193 V+ no VK Code defined 0xC2 194 A1- no VK Code defined 0xC3 195 A1+ no VK Code defined 0xC4 196 A2- no VK Code defined 0xC5 197 A2+ no VK Code defined 0xC6 198 A3- no VK Code defined 0xC7 199 A3+ no VK Code defined 0xC8 200 A4- no VK Code defined 0xC9 201 A4+ no VK Code defined 0xCA 202 A5- no VK Code defined 0xCB 203 A5+ no VK Code defined 0xCC 204 A6- no VK Code defined 0xCD 205 A6+ no VK Code defined 0xCE 206 Z+ no VK Code defined 0xCF 207 Z- no VK Code defined 0xD0 208

Depending on the size of the display, two robotics membrane keypads are available:

User's Manual, version: 3.1 / material no.: 57448 41

Page 44

Membrane Keypad KeTop T100

a) 7.7“ display (640x480 pixels)

Run-LED, green (LED No. = 1)

Error-LED, red (LE D No. = 2)

Page up, arrow key, menu

rrow and

enter key

Page down, arrow key, delete key

Help menu, ESC key

Start, stop keys

Enter

ESC

StopStart

rro

DEL

Speed

Axis group 1

Axis group 2

Auxili ar y axis

Robotics membrane keypad for 7.7“ display

KeTop

42 User's Manual, version: 3.1 / material no.: 57448

Page 45

Handheld Terminal Membrane Keypad

b) 8.4“ display (800x600 pixels)

Page up, arrow key, menu

Run-LED, green (LED No. = 1)

Error-LED, red (LED No. = 2)

Speed

Axis group 1

Arrow and enter key

Page down, arrow key, delete key

Help menu, ESC key

Start, stop keys

Robotics membrane keypad for 8.4” display

Enter

ESC

StopStart

DEL

KeTop

Axis group 2

Auxiliary axis

User's Manual, version: 3.1 / material no.: 57448 43

Page 46

Membrane Keypad KeTop T100

Numbering of LEDs

This chapter describes the numbering of the keyboard LEDs and push- button LEDs. The LED number is needed for activating the LED.

A LED can be activated in two ways:

z Via KeTop API design

(see chapter „Fehler! Verweisquelle konnte nicht gefunden werden.“

-> „

KtpSetKeyboardLed“ on page 57)

z Via KVC – KEBA Virtual Channel

(see chapter „

Example: Interface on Server“ on page 84)

e.g. general membrane keypad: Run-LED, green

(LED No. = 3)

Error-LED, red (LED No. = 4)

Illuminated push button, left (LED No. = 7)

Numbering of LEDs on KeTop

Key switch/ selector switch

Option: Illuminated push button (LED No. = 6)

r E

KETOP

Illuminated push button, right (LED No. = 5)

44 User's Manual, version: 3.1 / material no.: 57448

Page 47

Handheld Terminal Display

6 Display

The KeTop is available with two displays which differ as to their resolution and screen diagonals:

Type: graphics-capable color STN

LCD Size: 7.7“ (160 x 120 mm) 8.4“ (175 x 130 mm) Resolution: VGA 640 x 480 pixels SVGA 800 x 600 pixels Representation: 256 colors 256 colors Background lighting: CCFT cold cathode tube CCFT cold cathode tube Touch screen: analog-resistive analog-resistive

The lifetime of the background lighting (40,000 h) can be increased through the activation of a screen saver via the control panel.

Procedure:

Start -> Settings -> Control Panel -> Display -> Folder Backlight Select the function „Automatically turn off backlight while on external power“

Here you can enter the turn-off time (30s to 30min).

Display 7.7“ Display 8.4“

graphics-capable b/w STN LCD

Touch Screen

If the touch screen is not operated with the finger, we recommend using a touch stylus, for example touch styluses of PDAs by PALM or SONY.

The touch screen is already calibrated when the KeTop is delivered. No fur- ther calibration is required. If a re-calibration is required for any reason (humidity of air, temperature, etc.), perform the calibration procedure under Windows CE as follows:

Start -> Settings -> Control Panel -> Stylus -> Calibration -> Recalibrate

For the calibration you can also use the ConifgTool. See chapter „ and Touch Screen Settings“ on page

Display

98.

User's Manual, version: 3.1 / material no.: 57448 45

Page 48

Software KeTop T100

7 Software

Windows CE

The KeTop T100 is delivered with pre-installed software that is stored in the flash of the device. This software is also called "Image" since it combines all software contents in one file. The image contains the Windows CE oper- ating system core and possibly additional applications. The image is cre- ated by means of the MS Platformbuilder for Windows CE. This description is valid for images from version 2.10. (Get image version on KeTop as follows: Start -> Programs -> KeTop -> Version)

Software of Standard KeTop T100

Operating system Windows CE 4.2:

z System control z Command Prompt z Windows Explorer z Pocket Internet Explorer

Flash File System:

z IPSM (Intel Persistent Storage Manager)

Pre-installed application programs:

z Pocket Notepad z RDP-Client (Remote Desktop Connection) z Pocket Registry Editor (\windows\regedit.exe) z Active Sync

Pre-installed drivers:

z PC card wireless LAN card type Orinoco PC Card Silver 11Mbit/s IEEE

802.11b

z PC card for Windows CE standard modem

KeTop-specific software (see: Start -> Programs -> KeTop):

z KeTop Configuration Tool z KebaVirtualChannel KVC z Registry Backup

46 User's Manual, version: 3.1 / material no.: 57448

Page 49

Handheld Terminal Software

z SetTime, temporary time and date entry z System check, testing tool for KeTop spezific functions z TouchClean, Touch Cleaning Application z Version, overview of versions z Toggle sip (software keyboard) z KeTop tools (extension in system control for configuration of contrast,

background lighting, screensaver, touch screen and joystick calibration, onboard Ethernet on/off, clearing of registry, image update, ..)

z System check, test tool for KeTop spezific functions

Test tools

z TestSerial, test program for serial interfaces (\windows\testserial.exe) z Reset (\windows\reset.exe)

User's Manual, version: 3.1 / material no.: 57448 47

Page 50

Software KeTop T100

Generation of Program for Windows CE

The user can easily generate programs for Windows CE. Programming is similar to an application for a standard MS Windows NT PC. Under Win- dows CE, only the number of available WIN32-APIs is limited.

Prerequisites for Application Programming

z Microsoft eMbedded Visual C++ 4.0 z SDK (Software Development Kit) by manufacturer of Windows CE de-

vice (KEBA). The SDK provides to the programming environment the processor- dependent header and library files of the OEM adaptation.

z If special hardware-dependent functions of the KeTop should be used,

the SDK of the KeTop must be installed subsequently since the deliv- ered SDK for HPC (Handheld PC) and HPC Pro (Handheld PC Profes- sional) does not take into account certain customer-specific adapta- tions.

48 User's Manual, version: 3.1 / material no.: 57448

Page 51

Handheld Terminal Software

KeTop API Design

The entire SDK is implemented in a single dynamic link library (DLL). All functions described in this document are exported from this DLL. For Visual Basic, the module file KeTopAPI.bas must be imported into the Visual Basic project. This file and the corresponding SDK are contained on the CD „KeTop SK001“.

The following platform names are assigned to the KeTops: KeTop T100: KETOPT100 KeTop T50: KETOPT50 KeTop T50VGA: KETOPT50VGA KeTop T41: KETOPT41

► System files that are copied to \windows directory by Visual Studio re-

main stored permanently. For this reason, these files must be copied manually to the directory \IPSM\windows (must be created by the user if necessary).

In case of a restart of Windows CE, these files are automatically copied to the \windows directory. Therefore these files will be available for the operating system and after a restart.

User's Manual, version: 3.1 / material no.: 57448 49

Page 52

Software KeTop T100

Common data types

This section contains a detailed description of the common data types for the communication with the handheld terminal. For further information, see TpuHwDataTypes.h.

INT8 Signed 8 bit integer variable. UINT8 Unsigned 8 bit integer variable. BacklightStat Enum, displays the backlight status JoystickPos Struct, for joystick data. Status Struct Describes the startup state of the device. EventMsg Enum, describes the event message received. EventMsgDomains Enum, describes the events a handler has been subscribed to. eventCallback Function pointer to callback function.

Handling of Errors

Rules

Defines

z All functions expecting any input parameter check if the parameter is

located inside the range and if its data type is correct. If a parameter is located outside the range the function will return INVALID_ARG_RANGE.

z All functions expecting a pointer for output data as parameter check if

the pointer is valid, i.e. the pointer must not be NULL. If the pointer is invalid, the function will return INVALID_ARG_INVALID_PTR.

z All functions having any string as parameter check if the pointer to the

string is valid. If the pointer is invalid, the function will return INVALID_ARG_INVALID_STR_PTR.

SUCCESS 0 OK 0 FAIL 1 INVALID_ARG_RANGE 2 INVALID_ARG_PTR 3 INVALID_ARG_STR_PTR 4 INVALID_ARG_UNKNWN_COOKIE 5 INVALID_ARG_UNKNWN_DOMAIN 6 INVALID_NOT_CALIBRATED 7 INVALID_POTI_NOT_CALIBRATED 8 UNSAVE_DLL_TERMINATION -100 API_NOT_INIT -101

50 User's Manual, version: 3.1 / material no.: 57448

Page 53

Handheld Terminal Software

Functions

Functions for starting and closing

This chapter describes functions that are needed for starting and closing the KetopApi.dll.

KtpAPIInit

Declaration Description Arguments

KtpAPIDeinit

Declaration Description Arguments

UINT8 KtpAPIInit(void); This method initializes the KetopAPI.

void KtpAPIDeinit(void); This method cancels all initializations of the KtpAPIInit.

User's Manual, version: 3.1 / material no.: 57448 51

Page 54

Software KeTop T100

Functions for Configuration

This section describes the functions that are available for the configuration of the device. All functions return one of the above defines as error code.

KtpSetBrightness

Declaration Description Arguments

KtpSetBrightnessPercent

Declaration

Description

Arguments

UINT8 KtpSetBrightness(/*[in]*/UINT8 u8_Brightness); This method sets the brightness of the LC display on the device. 0-7, 0 = min, 7 = max

UINT8 KtpSetBrightnessPer- cent(/*[in]*/UINT8u8_Brightness);

This method sets the brightness of the LC display on the device in per- cent. 0-100%

KtpSetContrast

Declaration Description Arguments

KtpSetContrastPercent

Declaration Description Arguments

UINT8 KtpSetContrastPercent(/*[in]*/UINT8u8_Contrast) This method sets the contrast of the LC display on the device in percent. 0-100%

KtpSwitchBacklight

Declaration Description Arguments

KtpSetScreenSaverTimeOutMin

Declaration

Description Arguments

UINT8 KtpSetContrast(/*[in]*/UINT8 u8_Contrast); This method sets the contrast of the LC display on the device. 0-31, 0 = min, 31 = max

(Ketop T50: 0-63, 0 = min, 63 = max)

UINT8 KtpSwitchBacklight(/*[in]*/BacklightStat backLight);

Turns on/off the backlight of the LC display on the device. BACKLIGHT_ON, BACKLIGHT_OFF

UINT8 SetScreenSaverTimeOutMin(/*[in]*/UINT8 u8_ScreenSaverTO);

Sets the timeout value of the screensaver in minutes. 0-255, 0 = off, 255 = max

52 User's Manual, version: 3.1 / material no.: 57448

Page 55

Handheld Terminal Software

KtpSetScreenSaverTimeOutSec

Declaration

Description Arguments

KtpSetBuzzerVolume

Declaration Description Arguments

UINT8 SetScreenSaverTimeOut- Min(/*[in]*/UINT16u16_ScreenSaverTO);

Sets the timeout value of the screensaver in seconds. 0-65535, 0 = off, 65535 = max

UINT8 KtpSetBuzzerVolume(/*[in]*/UINT8 u8_Volume); Sets the volume of the buzzer. 0-16, 0 = off, 16 = max

User's Manual, version: 3.1 / material no.: 57448 53

Page 56

Software KeTop T100

Functions for Reading the Configuration

These functions return the current value of the configuration parameters. None of the functions need any parameter. These functions do not enable checking for errors since the return value of the function is the value of the configuration parameter.

KtpGetBrightness

Declaration Description Arguments

KtpGetBrightnessPercent

Declaration

Description Arguments

KtpGetContrast

Declaration Description Arguments

UINT8 KtpGetBrightness(void);

Gets the current brightness value of the LC display.

UINT8 KtpGetBrightnessPercent(/*[out]*/UINT8 *u8_Brightness);

Gets the current brightness value of the LC display in percent. UINT8 *u8_Brightness: brightness value 0-100%

UINT8 KtpGetContrast(void);

Gets the current contrast value of the LC display.

KtpGetContrastPercent

Declaration Description Arguments

KtpGetBacklight

Declaration Description Arguments

KtpGetScreenSaverTimeoutMin

Declaration Description Arguments

KtpGetScreenSaverTimeoutSec

Declaration Description Arguments

KtpGetBuzzerVolume

Declaration Description Arguments

UINT8 KtpSetContrastPercent(/*[out]*/UINT8 *u8_Contrast);

Gets the current contrast value of the LC display in percent. UINT8 *u8_Contrast: contrast value 0-100%

TKtpBacklightStat KtpGetBacklight(void);

Gets the current status of the background lighting.

UINT8 GetScreenSaverTimeOutMin(void);

Gets the current timeout value of the screensaver in minutes.

UINT8 GetScreenSaverTimeOutSec(void);

Gets the current timeout value of the screensaver in seconds.

UINT8 KtpGetBuzzerVolume(void);

Gets the current volume value of the buzzer.

54 User's Manual, version: 3.1 / material no.: 57448

Page 57

Handheld Terminal Software

Peripheral Functions

KtpJoystickIsInstalled

Declaration Description

Arguments

KtpWheelIsInstalled

Declaration Description Arguments

KtpPotiIsInstalled

Declaration Description

Arguments

UINT8 KtpJoystickIsInstalled(void);

Returns the number of joystick axes. If no joystick is installed on the device, 0 will be returned.

UINT8 KtpWheelIsInstalled(void);

Returns 1 if an handwheel is installed on the device, otherwise 0.

UINT8 KtpPotiIsInstalled(void);

Returns 1 if an override potentiometer is installed on the device, otherwise 0.

KtpGetJoystickPos

Declaration Description Arguments

Remarks

KtpGetJoystickPosEx

Declaration

Description Arguments Remarks

KtpGetJoystickPosRaw

Declaration

Description Arguments Remarks

UINT8 KtpGetJoystickPos (/*[out]*/TKtpJoystickPos *p_jPos);

Gets the current joystick position. TKtpJoystickPos structure. Each component in the structure may only

range between -15 and 15. Calling this function is only allowed if a joystick is installed on the de- vice. If no joystick is installed the values of the components are unde- fined.

UINT8 KtpGetJoystickPosEx(/*[out]*/int *posX, int *posY, int *posZ);

Gets the current joystick position. Each component in the structure may only range between -15 and 15. Calling this function is only allowed if a joystick is installed on the de-

vice. If no joystick is installed the values of the components are unde- fined.

UINT8 KtpGetJoystickPosRaw (/*[out]*/TktpJoystickPosRaw *p_jPos);

Gets the actual raw data of the joystick.

- Calling this function is only allowed if a joystick is installed on the de-

vice. If no joystick is installed the values of the components are unde- fined.

User's Manual, version: 3.1 / material no.: 57448 55

Page 58

Software KeTop T100

KtpGetJoystickPosRawEx

Declaration

Description Arguments Remarks

KtpSetJoystickCalibData

Declaration

Description Arguments

Remarks

UINT8 KtpGetJoystickPosEx(/*[out]*/UINT16 *posX, UINT16 *posY, UINT16 *posZ);

Gets the actual raw data of the joystick.

- Calling this function is only allowed if a joystick is installed on the de-

vice. If no joystick is installed the values of the components are unde- fined.

UINT8 KtpSetJoystickCalibData(/*in*/TKtpJoystickChannel ch UINT16 rawMin, UINT16 rawCenter , UINT16 rawMax, UINT16 calibRange);

Calibrates the axis of the joystick. TktpJoystickChannel ch: channel to be calibrated.

UINT16 rawMin: value for smallest raw value UINT16 ramCenter: average value for raw data UINT16 rawMax: maximum value of raw data UINT16 calibRange: maximum range of joystick This function may only be called if a joystick is installed on the device. If no joystick is installed, the value of the components are undefined.

KtpGetOverridePoti

Declaration Description Arguments

Remarks

KtpGetOverridePotiRaw

Declaration Description Arguments

Remarks

KtpGetEnablingDevice

Declaration

Description

Arguments

Remarks

UINT8 KtpGetOverridePoti(/*out*/UINT8 *p_pos);

Gets the current value of the override potentiometers. Pointer to the variable containing the current value of the override po-

tentiometer. This function may only be called if a override potentiometer is installed on the device. If no override potentiometer is installed, the value of the components are undefined.

UINT8 KtpGetOverridePotiRaw(/*out*/UINT16 *p_pos);

Gets the uncalibrated value from the override potentiometer. Pointer to the variable containing the current value of the override po-

tentiometer. This function may only be called if a override potentiometer is installed on the device. If no override potentiometer is installed, the value of the components are undefined.

UINT8 KtpGetEnablingDevice(/*in*/TKtpEnablingDeviceCircuit circuit);

Circuit is the value of the enabling switch to be read out when it is pressed completely (panic position). Returns the current value of the enabling switch transferred in the cir- cuit. This function may only be called if a enabling switch is installed on the device. If no enabling switch is installed, the value of the components are undefined.

56 User's Manual, version: 3.1 / material no.: 57448

Page 59

Handheld Terminal Software

KtpSetPotiCalibData

Declaration

Description

Arguments

KtpGetWheelValue

Declaration Description Arguments Remarks

KtpSetWheelValue

Declaration Description

Arguments Remarks

UINT8 KtpSetPotiCalibData(/*in*/ UINT16 rawMin, UINT16 rawMax, UINT16 calibRange);

Calibration of override potentiometer. This function may only be called if a override potentiometer is installed on the device. If no override potentiometer is installed, the value of the components are undefined. UINT16 rawMin: value for smallest raw value UINT16 rawMax: maximum raw value UINT16 calibRange: maximum range of overridepoti

UINT8 KtpGetWheelValue(/*out*/UINT16 *p_val);

Gets the actual value of the handwheel. Pointer to the variable containing the current value of the handwheel. This function may only be called if a handwheel is installed on the de-

vice. If no handwheel is installed, the value of the components are undefined.

UINT8 KtpSetWheelValue(/*in*/UINT16 val);

Sets the current position of the handwheel to the value transferred in val. val is the value the handwheel should be set to.

This function may only be called if a handwheel is installed on the de- vice. If no handwheel is installed, the value of the components are undefined.

LED Functions

Because the SxTPU2 is not equipped with LEDs, following functions are not relevant.

KtpSetKeyboardLed

Declaration

Description Arguments

KtpGetKeyboardLed

Declaration Description Arguments

UINT8 KtpSetKeyboardLed(/*in*/UINT8 ledNr, TLedState led- State);

Switches the set LED to the desired state. UINT8 ledNr: number of LED to be set.

UINT ledState: state, the LED is set to.

TLedState KtpGetKeyboardLed(/*in*/UINT8 ledNr);

Returns the state of the desired LED. UINT8 ledNr: number of LED.

User's Manual, version: 3.1 / material no.: 57448 57

Page 60

Software KeTop T100

Other Functions

These functions perform various actions on the device.

KtpGetStatus

Declaration Description Arguments

KtpWriteToFlash

Declaration Description Arguments

KtpReset

Declaration Description Arguments

UINT8 KtpGetStatus(/*[out]*/Status *p_tpuStatus);

Gets the start-up state of the handheld terminal. Status *p_tpuStatus, pointer to memory area that will receive a copy of

the status structure.

UINT8 WriteToFlash(void);

Writes the registry of the device to the flash.

UINT8 KtpReset(void);

Restarts the device new.

KtpGetVersionString

Declaration

Description Arguments

KtpGetEEPromData

Declaration Description Arguments

KtpWriteByteToEEProm

Declaration Description Arguments

UINT8 KtpGetVersionString(/*out*/TCHAR *wszVersionString, unsigned int bufferLen);

Returns the state of the KeTop during start-up. TCHAR *wszVersionString: pointer to buffer for the versions string

unsigned int bufferSize: length of transferred buffer.

UINT8 KtpGetEEPromData(/*out*/TEEPromData *data);

Read the data from the EEProm TEEPromData data: data structure for the data contained in the

EEProm

UINT8 KtpWriteByteToEEProm (/*in*/UINT16 addr, UINT8 data);

Writes a byte to the EEProm location transferred in addr. UINT16 addr: address of memory location

UINT8 data: data for saving

58 User's Manual, version: 3.1 / material no.: 57448

Page 61

Handheld Terminal Software

KtpReadByteFromEEProm

Declaration

Description Arguments

KtpLaunchTouchScreenCalibApp

Declaration Description Arguments

KtpGetTemperature

Declaration Description Arguments

KtpPlaySound

Declaration Description Arguments

UINT8 KtpReadByteFromEEProm (/*in*/UINT16 addr, /*out*/ UINT8 *pData);

Reads a byte from the EEProm location transferred in addr. UINT16 addr: address of memory location

UINT8 *pData: data from the EEProm

UINT8 KtpLaunchTouchScreenCalibApp (void);

Starts the touch-screen calibration tool.

UINT8 KtpGetTemperature (void);

Returns the current temperature of the KeTop.

UINT8 KtpPlaySound (/*in*/ UINT16 soundNr);

Plays the system sound in soundNr. UINT16 soundNr: number of system sound.

KtpDoBeep

Declaration Description Arguments

KtpGetVariantData

Declaration Description Arguments

UINT8 KtpDoBeep (/*in*/ UINT8 beepTime10ms);

Is active for beepTime10ms * 10 ms UINT8 beeptime10ms: duration of beeps in n* 10ms

UINT8 KtpGetVariantData (/*out*/ TKtpVariantData *data);

Reads the device configuration from the EEProm. TKtpVariantData data: data structure for VariantData.

User's Manual, version: 3.1 / material no.: 57448 59

Page 62

Software KeTop T100

Functions for Subscribing Events

These functions are used to subscribe/unsubscribe callback functions for different events. Joystick, override potentiometer, handwheel and keypad can be used as events.

KtpInstallWheelEventCallback

Declaration

Description

Arguments

KtpInstallWheelEventMessage

Declaration Description

Arguments

UINT8 KtpInstallWheelEventCallback (/*in*/TktpWheelEventCallback pWheelProc, int *cookie);

Subscribes a callback function for the WheelEvent and returns an index (cookie) for the callback function. TKtpWheelEventCallback pWheelProc: callback function to be called when the event occurs. int cookie: The index for the callback function is required for removing the callback function.

UINT8 KtpInstallWheelEventMessage (HWND hWnd, int *cookie);

Subscribes a WindowHandler for the WheelEvent and returns an index (cookie). HWND hWnd: WindowHandler, where the message is sent to. int cookie: Index, is required for removing the WindowHandler.

KtpRemoveWheelEventCallback

Declaration Description Arguments

KtpRemoveWheelEventMessage

Declaration Description Arguments

KtpInstallOvrEventCallback

Declaration

Description

Arguments

UINT8 KtpRemoveWheelEventCallback (int cookie); Removes the WheelEventCallback function. int cookie: index for the callback function to be removed.

UINT8 KtpRemoveWheelEventMessage (int cookie)

Removes the WindowHandler. int cookie: index for the WindowHandler to be removed.

UINT8 KtpInstallOvrEventCallback (/*in*/ TKtpOvrEventCall- back pOvrProc, /*out*/ int *cookie);

Subscribes a callback function for the OverrideEvent and returns an index (cookie) for the callback function. TKtpOvrEventCallback pOvrProc: callback function to be called when the event occurs. int cookie: The index for the callback function is required for removing the callback function.

60 User's Manual, version: 3.1 / material no.: 57448

Page 63

Handheld Terminal Software

KtpInstallOvrEventMessage

Declaration Description

Arguments

KtpRemoveOvrEventCallback

Declaration Description Arguments

KtpRemoveOvrEventMessage

Declaration Description Arguments

UINT8 KtpInstallOvrEventMessage (HWND hWnd, int *cookie);

Subscribes a WindowHandler for the OverrideEvent and returns an index (cookie) for the WindowHandler. HWND hWnd: WindowHandler, where the message is sent to. int cookie: Index, is required for removing the WindowHandler.

UINT8 KtpRemoveOvrEventCallback (int cookie);

Removes the OverrideEventCallback function. int cookie: index for the callback function to be removed.

UINT8 KtpRemoveOvrEventMessage (int cookie);

Removes the WindowHandler. int cookie: index for the WindowHandler to be removed.

KtpInstallKbdEventCallback

Declaration

Description

Arguments

KtpInstallKbdEventMessage

Declaration Description

Arguments

KtpRemoveKbdEventCallback

Declaration Description Arguments

UINT8 KtpInstallKbdEventCallback (/*in*/ TktpKbdEventCall- back pKbdProc, /*out*/ int *cookie);

Subscribes a callback function for the KeyboardEvent and returns an index (cookie) for the callback function. TktpKbdEventCallback pKbdProc: callback function to be called when the event occurs. int cookie: The index for the callback function is required for removing the callback function.

UINT8 KtpInstallKbdEventMessage (HWND hWnd, int *cookie);

Subscribes a WindowHandler for the KeyboardEvent and returns an index (cookie) for the WindowHandler. HWND hWnd: WindowHandler, where the message is send to. int cookie: The index for removing the WindowHandler.

UINT8 KtpRemoveKbdEventCallback (int cookie);

Removes the WheelEventCallback function. int cookie: index for the callback function to be removed

KtpRemoveKdbEventMessage

Declaration Description Arguments

User's Manual, version: 3.1 / material no.: 57448 61

UINT8 KtpRemoveKbdEventMessage (int cookie);

Removes the WindowHandler. int cookie: index for the WindowHandler to be removed

Page 64

Software KeTop T100

KtpInstallJoyEventCallback

Declaration

Description

Arguments

KtpInstallJoyEventMessage

Declaration Description

Arguments

KtpRemoveJoyEventCallback

Declaration Description Arguments

UINT8 KtpInstallJoyEventCallback (/*in*/ TktpJoyEventCall- back pJoyProc, /*out*/ int *cookie);

Subscribes a callback function for the JoystickEvent and returns an index (cookie) for the callback function, if a joystick is installed. TktpJoyEventCallback pJoyProc: callback function to be called when the event occurs. int cookie The index for the callback function is required for removing the callback function.

UINT8 KtpInstallJoyEventMessage (HWND hWnd, int *cookie);

Subscribes a WindowHandler for the JoystickEvent and returns an index (cookie) for the WindowHandler. HWND hWnd: WindowHandler, where the message is send to. int cookie: index for the WindowHandler to be removed

UINT8 KtpRemoveJoyEventCallback (int cookie);

Removes the JoyEventCallback function, if a joystick is installed. int cookie: index for the callback function.

KtpRemoveJoyEventMessage

Declaration Description Arguments

KtpLaunchJoystickCalibApp

Declaration Description Arguments

KtpGetDispalyRotation

Declaration Description Arguments

KtpSetDisplayRotation

Declaration Description

Arguments

UINT8 KtpRemoveJoyEventMessage (int cookie);

Removes the WindowHandler. int cookie: index for the WindowHandler to be removed

UINT8 KtpLaunchJoystickCalibApp(HANDLE *pProcHandle);

Starts the joystick calibration tool. HANDLE *pProcHandle: Handle for the started program.

TKtpDispalyRot KtpGetDisplayRotation (void)

Returns the state for the DisplayRotation (for left or right handers).

UINT8 KtpSetDisplayRotation(TKtpDisplayRot dispRot);

Changes the design of the display for left or right handers. Maybe for some devices no changes. TKtpDisplayRot dispRot: eKtpDisplayLeft for left handers, eKtpDisplayRight for right handers

62 User's Manual, version: 3.1 / material no.: 57448

Page 65

Handheld Terminal Software

KtpEraseRegistry

Declaration Description Arguments

KtpErasePSM

Declaration Description Arguments

KtpGetPowerFailState

Declaration Description Arguments

KtpForcePressedHardbuttons

Declaration Description

Arguments

UINT8 KtpEraseRegistry(void);

Deletes the registry of the device during next startup.

UINT8 KtpErasePSM(void);

Deletes the flash file system of the device during next startup.

UINT8 KtpGetPowerFailState(void); Returns the actually state of the powerFail input.

UINT8 KtpForcePressedHardbuttons (void);

A WM_KEYDOWN message will be send for each pressed keyswitch and the KeyboardCallback function will be activated. This function will be activated also for the initializing of the KetopApi and for the installa- tion of the KeyboardCallback function.

KtpIsJoystickCalibrated

Declaration Description

Arguments

KtpIsPotiCalibrated

Declaration Description

Arguments

UINT8 KtpIsJoysstickCalibrated (void);

Returns OK (0) if all joystick axes are calibrated. If one or more axes are not calibrated, it returns INVALID_NOT_CALIBRATED (7). If no joystick exists, it returns INVALID_NOT SUPPORTED (6).

UINT8 KtpIsPotiCalibrated (void);

Returns OK (0) if the override potentiometer is calibrated. Returns INVALID_NOT_CALIBRATED (7), if it is not calibrated. Returns INVALID_NOT_SUPPORTED (6) if no override potentiometer is installed.

User's Manual, version: 3.1 / material no.: 57448 63

Page 66

Software KeTop T100

KtpRestoreMemorySettings

Declaration Description

Arguments

KtpStoreCurrentMemorySettings

Declaration Description

Arguments

UINT8 KtpRestoreMemorySettins(void);

Saves the registry-value of the path "System\MemorySettings\ Store- Pages" as storage memory. If the registry-value is in a range where memory for storage respectively for program memory is reserved, these settings wont be changed and IVALID_ARG_RANGE will be returned. If it is not allowed to save the memory settings ("Sys- tem\MemorySettings\MemorySaveEnable"=0), INVALID_NOT_SUPPORTED will be returned.

UINT8 KtpStoreCurrentMemorySettins(void);

Saves the memory settings of the registry ("Sys- tem\MemorySettings\StorePages"), if it is allowed. If it is not allowed to save, INVALID_NOT_SUPPORTED will be re- turned.

KtpShowInputPanel

Declaration Description

Arguments

UINT8 KtpShwoInputPanel(UINT8 show);

Opens (show=1) or closes (show=0) the input panel on the display and returuns OK or FAIL.

64 User's Manual, version: 3.1 / material no.: 57448

Page 67

Handheld Terminal Software

Update API Design

All required methods for an image update are implemented in one single dynamic link library (update.dll). All functions described in this document are exported from this DLL. For running the update.dll the appropriate KetopAPI.dll will be necessary. Both DLL files must exist in the image and correspond with each other.

Handling of Errors

Rules

z All functions expecting any input parameter check if the parameter is lo-

cated inside the range and if its data type is correct. If a parameter is lo- cated outside the range the function will return ERROR_INVALID_RANGE.

Defines

OK 0 SUCCESS 0 FAIL 1 ERROR_INVALIDE_RANGE 100 ERROR_IMGUPD_INIT 101 ERROR_IMGUPD_FILEOPEN 102 ERROR_IMGUPD_WRONGIMG 103 ERROR_IMGUPD_PROGRAMERROR 104 ERROR_IMGUPD_TOMUCHUPD 105 ERROR_PROGRAM_FLASH_BURN 106 ERROR_PROGRAM_FLASH_ERASE 107 ERROR_IMGUPD_NOTEQUAL 108 ERROR_IMGUPD_FILEWRITE 109 ERROR_IMGUPD_FILEREAD 110 ERROR_WRONG_FILE_HEADER 111

User's Manual, version: 3.1 / material no.: 57448 65

Page 68

Software KeTop T100

Initialising

All required initialisation will be carried out by starting respectively by load- ing the update.dll.

Functions

UpdStartImageUpdate

Declaration

Description

Arguments

BOOL UpdStartImageUpdate (LPCTSTR fileName, BOOL eraseRegPSM, TUpdProgressCallback pCallback)

With this method the file handed over by fileName will be stored to the FLASH memory of the device. If eraseRegPSM is set, the registry respectively the PSM will be deleted, after the FLASH has been written successfully. If a method is handed over with pCallback, the method will be exe- cuted depending of the program progress. The method returns OK or the corresponding error message.

LPCTSTR fileName: Name of the image file BOOL eraseRegPSM: Flag for deleting the registry respectively the

PSM TUpdProgressCallback pCallback: Callback function for pro- gram progress or 0

UpdPartialImageUpdate

Declaration

Description

Arguments

BOOL UpdPartialImageUpdate (LPCTSTR fileName, unsigned long from, unsigned long to, BOOL eraseRegPSM, TUpdProgressCallback pCallback)

With this method the file handed over by fileName will be stored from the address vice. If eraseRegPSM is set, the registry respectively the PSM will be de- leted, after the FLASH has been written successfully. If a method is handed over wirh pCallback, the method will be exe- cuted depending of the program progress. The method returns OK or the corresponding error message.

LPCTSTR fileName: Name of image file unsigned long from: First address for overwriting unsigned long to: Address, out of overwriting

BOOL eraseRegPSM: Flag for deleting the registry respectively the PSM

TUpdProgressCallback pCallback: Callback function for program pro- gress or 0

from to the address to to the FLASH memory of the de-

66 User's Manual, version: 3.1 / material no.: 57448

Page 69

Handheld Terminal Software

UpdCheckFile

Declaration

Visual C: Visual Basic:

Description

Arguments

UpdCompareFile

Declaration

Description

Arguments

BOOL UpdCheckFile(LPCTSTR fileName, TupdProgressCallback pCallback) UINT8 KtpSetBrightness(/*[in]*/UINT8 u8_Brightness); KtpSetBrightness(ByVal brightness As Byte) As Byte

UpdCheckFile verifys the image file and if the image file corresponds

to the device. If a method is handed over wirh pCallback, the method will be exe- cuted depending of the program progress. The method returns OK or the corresponding error message.

LPCTSTR fileName: Name of the image file TUpdProgressCallback pCallback: Callback function for pro-

gram progress or 0

BOOL UpdCompareFile(LPCTSTR fileName, TUpdProgressCallback pCallback)

UpdCompareFile compares the handed over image file with the en-

tries of the FLASH memory. If a method is handed over wirh pCallback, the method will be exe- cuted depending of the program progress. The method returns OK or the corresponding error message.

LPCTSTR fileName: Name of the image file TUpdProgressCallback pCallback: Callback function for pro-

gram progress or 0.

UpdSetFlashLock

Declaration

Description

Arguments

UpdResetFlashLock

Declaration Description

Arguments

BOOL UpdSetFlashLock(long from, long to)

This method sets the lock bits of the FLASH chips from the address

from

to the address to. So, this address area can’t be overwritten. After an image update, the lock bits are reset. One lock bit locks one whole FLASH block. So the saved area can differ from the handed over addresses.

long from: First address for locking bits. long to: Address as far as the lock bits are set.

BOOL UpdResetFlashLock(long from, long to)

This method resets the lock bits of the FLASH chips from the address from to the address to, One lock bit locks one whole FLASH block. So the unsaved area can differ from the handed over addresses.

long from: First address for reset locking bits. long to: Address as far as the lock bits are reset.

User's Manual, version: 3.1 / material no.: 57448 67

Page 70

Software KeTop T100

UpdGetImage

Declaration

Description

Arguments

UpdEraseRegistry

Declaration Description

BOOL UpdGetImage(LPCTSTR fileName, unsigned lont from, unsigned long to, TUpdProgressCallback pCallback);

UpdGetImage creates a copy of the device-image from the address from to the address to and saves it in the file fileName.

If a method is handed over with pCallback, the method will be exe- cuted depending of the program progress. The method returns OK or the corresponding error message.

LPCTSTR fileName: Name of the image file unsigned long from: Starting address stored in the file unsigned long to: Address not stored TUpdProgressCallback pCallback: Callback funktion for program

progress or 0.

BOOL UpdEraseRegistry(); The method UpdEraseRegistry cleares the registry of the device

after the next update.

UpdErasePSM

Declaration Description

UpdResetDevice

Declaration Description

UpdGetFileVersion

Declaration Description

Arguments

UpdGetImageVersion

Declaration Description

Arguments

BOOL UpdErasePSM(); the method UpdErasePSM cleares the PSM of the device after the next

update.

BOOL UpdResetDevice(); The method UpdResetDevice resets the device.

BOOL UpdGetFileVersion(LPCTSTR fileName, LPTSTR version);

UpdGetFileVersion returns the version information stored in the

image file in the string version. The number of characters returned can be defined in VERSION_STRING_LEN. Therefore version has to exceed VERSION_STRING_LEN.

LPCTSTR fileName: Name of the image file LPTSTR version: String for version information

BOOL UpdGetImageVersion(LPTSTR version);

UpdGetImageVersion returns the in the registry stored version in-

formation in the string version. The number of characters returned is defined in VERSION_STRING_LEN. Therefore version has to exceed

VERSION_STRING_LEN. LPTSTR version: String for version information

68 User's Manual, version: 3.1 / material no.: 57448

Page 71

Handheld Terminal Software

TupdProgressCallback

Declaration Description

Arguments

typedef void (* TUpdProgressCallback) (int percent); TUpdProgressCallback is the prototype of the callback functions,

which can be called from the Update API. int percent: Number between 0 and 100 for the progress

User's Manual, version: 3.1 / material no.: 57448 69

Page 72

Software KeTop T100

Program for Starting the Application and KeTop API

This chapter describes the program for starting the application and the Ke- Top API. The program is contained as a StartAPI.exe in the Windows direc- tory.

Functional description

The StartAPI program is started by an entry in the Startup directory or by an entry in the registry under [HKEY_LOCAL_MACHINE\init] when the Ke- Top is started.

When the program is started, the KeTop API will be initialized first and then the programs entered under [HKEY_LOCAL_MACHINE\Autostart] will be started.

The program remains invisible in the memory and handles different input devices, e.g. override potentiometer and handwheel.

Registry entries

[HKEY_LOCAL_MACHINE\Autostart] contains the entries that are read out by the program.

The following entries are possible:

z Startx

z Paramsx

z Delayx

z DependStartx

z DependEndx

string identifying the program to be started. x is a number between 1 and 255.

string containing the parameters for the program identified in Startx. x must have the same value as in Startx.

DWORD containing the waiting time in milliseconds until the next pro- gram is started. x must have the same value as in Startx.

array of 10 bytes containing the numbers of the programs which must have been started so that the program x may start. If there is no such entry or all bytes are 0 then the program x starts and no other programs must have been started.

array of 10 bytes containing the numbers of the programs which must have been stopped before the program x starts. If there is no such entry or all bytes are 0 then the program x starts without waiting of any other programs.

z StartTypex

DWORD affecting the startup of the application.

70 User's Manual, version: 3.1 / material no.: 57448

Page 73

Handheld Terminal Software

StartTypex = 0: The application starts automatically StartTypex = 1: The application wont be started StartTypex = 2: A window with the message „start programm <Yes> / <No>“ appears. The user can decide, if the application should be started or not. x must have the same value as Startx.

Example

Example of a possible configuration in the registry: [HKEY_LOCAL_MACHINE \ Autostart]

Start1 = "cmd.exe" Params1 = "/c copy \ipsm\windows\*.* \windows" Delay1 = dword:0x000003e8 (1000)

Start10 = "pvbload.exe" Params10 = "\ipsm\vb\TestProjectVB1.vb" Delay10 = dword:0x00002710 (10000)

Start20 ="SetTime.exe" Params20 ="" Delay20 = dword:0

Start30 ="ReadCorrectTime.exe" Params30 ="" Delay30 = dword:0 DependStart30 = hex: a, 0, 0, 0, 0, 0, 0, 0, 0, 0 DependEnd30 = hex:14, 0, 0, 0, 0, 0, 0, 0, 0, 0

When the StartAPI is started, the KeTop API will be initialized first and then the program cmd.exe will be called with the parameters "/c copy \ipsm\windows\*.* \windows".

cmd.exe /c copy \ipsm\windows\*.* \windows This program copies the data from the directory \ipsm\windows to the nor-

mal Windows directory. After the call of cmd.exe, the system waits for 1000 millliseconds (Delay1) until the next program is started even if the cmd.exe has not been com- pleted before.

After the delay, the program pvbload.exe will be started with the parame- ters "\ipsm\TestProjectVB1.vb".

pvbload.exe \ipsm\TestProjectVB1.vb This program starts the VisualBasicScript TestProjectVB1.vb.

User's Manual, version: 3.1 / material no.: 57448 71

Page 74

Software KeTop T100

After a waiting time of 10000 milliseconds (Delay10), the program with the next higher entry will be started.

SetTime starts a program for setting the time. This program will be started without parameter and delay.

Afterwards it will be checked if the program 10 (DependStart30 a,.. ) has been started and the SetTime program (DependEnd30 14,..) has been fin- ished already. If all conditions are meet the program ReadCorrectTime will be started.

If no more entries are available, the starting of the applications will be fin- ished. Programs started by the StartAPI will not be finished.

72 User's Manual, version: 3.1 / material no.: 57448

Page 75

Handheld Terminal Software

RDP – Connection via Remote Desktop Protocol

The Remote Desktop Protocol (Abbreviated as"RDP“) is a specification by Microsoft for remote control of applications. Microsoft has replaced the earlier name “M (Abbreviated as “MSTSC”) by the term RDP-Client. A detailed description of this term can be found on Microsoft's website. Likewise, it can also be found in the Windows-Help feature using the search criteria “mstsc” and “rdp”.

Operating principle (highly simplified):

RDP-Client:

(

Rem

icrosoft Terminal Server Client”

RDP-Server

the

)

(Remote-PC)

)

RDP-Client:

KeTop T100

ESC

7 8 9 4 5 6 1 2 3

. 0

KETOP

(

RDP-Client <-> RDP-Server

Programs and data are stored on the remote computer. This is where the program is executed and the data is accessed. This remote computer (Re- mote PC) is identified as ”RDP-Server.“

However, data is entered and displayed on the monitor of the local “RDP- Client.”

The exchange of data between the client and the server takes place as per the "Remote Desktop Protocol."

User's Manual, version: 3.1 / material no.: 57448 73

Page 76

Software KeTop T100

RDP-Server (Remote-PC)

The RDP-Server (Remote-PC) requires one of the following operating sys- tems:

z Windows NT4 Terminal server z Windows 2000 Server z Windows Server 2003 z Windows XP Professional (Not Windows XP Home !) z Windows XP embedded (The Server-functionality is integrable.)

Note

When using Windows XP Professional, the RDP-access on the PC in use,

must be enabled using the path below: "Control Panel -> System -> Re- mote" (The option "(x) Remotedesktop" must be activated.)

RDP-Client (PC)

To start the RDP-Client on the PC, the file <mstsc.exe> must be invoked. In Windows XP, this can be found in the Windows directory or under “Start -> All Programs -> Accessories -> Communication -> Remote Desktop Con- nection.“ For other operating systems such as Windows 95/98/NT, the appropriate files can be obtained from the Microsoft website.

RDP-Client (KeTop)

When starting the client on the KeTop, the file cetsc.exe must be in- voked. This is located in the Windows directory and can be accessed using the path “Start-> Programs -> Remote Desktop Connection.”

Starting a RDP-Connection manually

► Start the RDP-client using the file cetsc.exe and the login window

shown below, appears:

74 User's Manual, version: 3.1 / material no.: 57448

Page 77

Handheld Terminal Software

► Enter the IP-Address of the destination computer in the field “Com-

puter.”

In case the network name is to be used in place of the IP-Address, then resolution of the name must be ensured either via the DNS-server or by an entry in the file “hosts.ini.”

Note

The “Input panel” in this case must be enabled on the KeTop, as access to this feature is blocked during the logging process:

► Click the button “Connect” to establish connection with the destination

computer.

Clicking the “Cancel” button disrupts the connection set up. Once the connection has been established, the login window of the destina-

tion computer is displayed with a trapezoidal title bar that is treated as an identifier of the RDP-Connection.

User's Manual, version: 3.1 / material no.: 57448 75

Page 78

Software KeTop T100

► Enter the username and the password and confirm by clicking OK.

The Windows screen of the destination computer is displayed once login is successful.

If the trapezoidal title bar shows any errors when being used with certain applications, it can be deactivated when logging in the next time, by simply clicking the symbol at the top left.

76 User's Manual, version: 3.1 / material no.: 57448

Page 79

Handheld Terminal Software

If this symbol is displayed, the title bar automatically disappears after the next login.

By invoking “Start->Logout,” you can logout of the destination computer.

Saving the settings of a RDP-Connection

► Clicking the button “Options >>” on the login window of the RDP-Client

displays an expanded window with the current settings.

User's Manual, version: 3.1 / material no.: 57448 77

Page 80

Software KeTop T100

► Click the button “Save As….” and save all these settings in a file of the

type “rdp”

Starting the RDP-Connection automatically via an entry in the registry

Connection with the destination compute can be established automatically on starting the KeTop with the help of an entry in the registry under [HKEY_LOCAL_MACHINE\Autostart]. (Also refer the chapter “Program for starting the application and the KeTop API”)

Startx = "\windows\cetsc.exe " Paramsx = "\ipsm\default.rdp"

While doing so, the precise RDP-settings must be saved in the file “\ipsm\default.rdp.”

78 User's Manual, version: 3.1 / material no.: 57448

Page 81

Handheld Terminal Software

Starting a RDP-Connection via TSCDialog

KEBA has produced TSCDialog.exe, an upgraded version of the RDP- Client with further enhancements. This program can be used to regulate the operator’s access to Windows CE. Moreover, the login screen can be designed as desired.

The following entry must exist in the registry in order to invoke the TSCDia- log.exe when the KeTop is turned on:

HKEY_LOCAL_MACHINE\Autostart\Startx = "\windows\tscdialog.exe" While doing so, the precise RDP-settings must be saved in the file

“\ipsm\rdpfiles\default.rdp.” To customize the login screen as required, individual elements of the login

screen may be replaced by customer-specific elements. The customization is controlled using the file

\ipsm\rdpfiles\resources\TSCDialog.ini TakeUserLogo:i:1

ProgTitle:s:title (Title) LogoFileName:s:logo.bmp (Logo right top, in place of “KEBA”) ImgFileName:s:bitmap.bmp (Image to the left, in place of the woman

in green)

Likewise, the files “logo.bmp" and "bitmap.bmp" must also be entered in the directory “\ipsm\rdpfiles\resources\".

User's Manual, version: 3.1 / material no.: 57448 79

Page 82

Software KeTop T100

KVC – KEBA Virtual Channel

The protocol "KEBA Virtual Channel" (KVC) is used to transmit control and operating element data between a control and one or more KeTop hand- held terminals.

The following data can be transmitted via the KVC:

Data Direction

ST Ù HT

Override potentiometer Electronic handwheel

Joystick Lighting for button be-

low display LEDs on keypad Contrast, brightness

Time for screensaver State of screensaver Volume Background lighting WriteToFlash

PlaySound KeepAlive

Ù Ù Ù

Õ Ù Ù

Ö Ù

The data transmission between the control and the handheld terminals is based on an Ethernet connection (TCP/IP protocol, Listening Port

0xCEBA). All devices must be identified by their IP address. Several handheld terminals may be connected to one control, but one

handheld terminal can only be connected to one control. The KVC protocol is an event-driven protocol, i.e. each station can send data at any time without request.

To monitor the functioning of the KeTop T100 in the control, the KVC offers the possibility to use KeepAlive data packages that are periodically sent from the client to the server. The intervals at which the data packages are sent can be set in milliseconds.

Value range

0..127 1 Event in case of modification and

-32000 ..

32000

–63..63

flashing

off

0..255 2 As command from the control and as

0..255 1 As command from the control and as

0..1 1 Event or as request from the client to

0..255 1 As command from the control and as

0..1 1 As command from the control and as

- - Command

0..255 1 Command

0..65535 2 Command and KeepAliveEvent if

Size

Transmission

[bytes]

upon request of the control

2 Event in case of modification, upon

request of the control, and as set command for adjusting

2 2 As com mand from the control and as

Event in case of 0-Pos and ≠ 0-Pos, then request of control

request from the client to the control.

request from the client to the control request from the client to the control the control request from the client to the control request from the client to the control

parameterized by the server

80 User's Manual, version: 3.1 / material no.: 57448

Page 83

Handheld Terminal Software

Events Causing the Client to Send Data

z Modification of value of override potentiometer z Modification of handwheel value z Modification of key status of a key z The joystick or the space mouse reaches the 0 position. z The joystick or space mouse leaves the 0 position. z Data inquiry of server

With each event, the client sends to the server a data package containing the information about the type of event as well as the current data of all op- erating elements. If the client produces several events one after the other, and the server cannot process all of them at once (e.g. quick rotation of handwheel and simultaneous movement of joystick), the server will send one message containing all events.

Events of Server

By sending a package to the client, the server can influence the status of the LEDs on the client, set the current value of the handwheel, or request the current values (position of joystick, handwheel and override potentiome- ter, as well as state of keys). The server can also read the current states of the values which can be modified by the server.

User's Manual, version: 3.1 / material no.: 57448 81

Page 84

Software KeTop T100

Data Transmission

Each of the two socket connections between the client and the server con- stitutes a channel for the data transmission in each direction. The data structures relevant for the corresponding data direction are described in this chapter.

Client Æ Server

typedef enum {

eKVCJoystickIsZero 0x0001 eKVCJoystickNotZero 0x0002 eKVCSpaceMouseIsZero 0x0004 eKVCSpaceMouseNotZero 0x0008 eKVCHandWheelChanged 0x0010 eKVCOverrideChanged 0x0020 eKVCKeyPressed 0x0040 eKVCKeyReleased 0x0080 eKVCLedValue 0x0100 eKVCContrast 0x0200 eKVCBrightness 0x0300 eKVCVolume 0x0400 eKVCScreensaverTime 0x0500 eKVCScreensaverState 0x0600 eKVCBacklightState 0x0700 eKVCLed 0x0800 eKVCJoystickResp 0x0900 eKVCSpaceMouseResp 0x0A00 eKVCHandWheelResp 0x0B00 eKVCOverrideResp 0x0C00 eKVCAlive 0xFE00 eKVCClientDisconnect 0xFF00

} TKVCEvent; typedef struct {

UINT16 event; struct { UINT8 overrideVal; UINT8 keyVal; TKVCJostickData joystickVal; SINT16 handWheelVal; TKVCSpaceMouseData spaceMouseVal; } data; } TKVCClientData;

typedef enum {

eKtpKeyboardLedOff = 1, eKtpKeyboardLedOn = 2, eKtpKeyboardLedBlink = 3

} TKtpLedState; typedef struct {

char posX; char posY;

82 User's Manual, version: 3.1 / material no.: 57448

Page 85

Handheld Terminal Software

char posZ; } TKVCJostickData;

typedef struct { UINT16 posX; UINT16 posY; UINT16 psoZ; } TKVCSpaceMouseData;

typedef struct { SINT16 absVal; SINT16 dynVal; }TKVCHandWheelData;

Server Æ Client

typedef enum { eKVCSetWheelValue, eKVCSetLed

eKVCSetContrast, eKVCSetBrightness, eKVCSetVolume, eKVCSetScreensaver,

eKVCGetLed, eKVCGetContrast, eKVCGetBrightness, eKVCGetVolume, eKVCGetScreensaverTime, eKVCGetJostickValue,

eKVCGetSpaceMouseValue,

eKVCGetOverrideValue,

eKVCGetWheelValue,

eKVCSwtichBacklight,

eKVCGetBacklightState,

eKVCPlaySound,

eKVCWriteFlash

eKVCDisconnect } TKVCCommand;

typedef struct { TKVCCommand command; SINT16 param; } TKVCServerData;

User's Manual, version: 3.1 / material no.: 57448 83

Page 86

Software KeTop T100

Example: Interface on Server

On the server side, the KVC protocol is represented by two classes:

CKVCServer and CKVCConnection. An object of the CKVCServer class

represents the actual server (the "listener") and an object of the

CKVCConnection class represents a connection to a client.

"Server class"

class CKVCServer { public: virtual int Init(); virtual int Exit(); virtual CKVCConnection* OnClientConnect(SOCKET socket, sockaddr_in &sockAdr); virtual int OnClientDisconnect(CKVCConnection *pConnection, TDisconInfo info);

POSITION ConnectionListHeadPos(); CKVCConnection* ConnectionListGetNext(POSITION pos); int ConnectionListGetCount();

}; int Init();

Initalizes the server and opens the port 0xCEBA for incoming connections.

int Exit(); Finishes all connections and closes the port 0xCEBA.

CKVCConnection* OnClientConnect(SOCKET socket, sockaddr_in &sockAdr);

This method is always called when a teach pendant establishes a connec- tion to the control. The parameters nection parameters of the teach pendant. This function must return a pointer to an object of the class cates that the control rejects the logon of the teach pendant.

int OnClientDisconnect(CKVCConnection *pConnection, TDisconInfo info);

This method will be called if the server cannot reach the client any more. The cause of the logoff is specified in info.

POSITION ConnectionListHeadPos();

This method returns the position of the first entry in the OpenConnection list.

CKVCConnection* ConnectionListGetNext(POSITION pos);

This method returns a pointer to the ConnectionObject that is stored on the postiion pos in the OpenConnection list.

int ConnectionListGetCount();

This method returns the number of connections that are stored in the OpenConnection list.

socket and sockAdr specify the con-

CKVCConnection. A return value of 0 indi-

84 User's Manual, version: 3.1 / material no.: 57448

Page 87

Handheld Terminal Software

Connections

For details about the LED numbering (ledNr) needed for the following func- tions, refer to the chapter „

class CKVCConnection { private: char *pIpAdr; public:

virtual int Init(CKVCServer *pServer, SOCKET socket, SOCKADDR_IN &socketAdr); virtual int Exit(); virtual int OnOverrideChange(SINT16 val); virtual int OnWheelChange(SINT16 wheelAbsVal); virtual int OnKeypadEvent(TKVCEvent keyEvent, UINT8 keyNum); virtual int OnJoystickEvent(TKVCEvent event, TKVCJoystickData *pJData); virtual int OnSpaceMouseEvent(TKVCEvent event, TKVCSpaceMouseData *pSMData); virtual int OnDisconnect();

virtual int GetWheelVal(TKVCHandWheelData &hwData); virutal int GetOverrideVal(SINT8 &overrideVal); virtual int GetJoystickPos(TKVCJoystickData &jData); virtual int GetSpaceMousePos(TKVCSpaceMouseData &smData); virtual int GetLedState(UINT8 ledNum,UINT8 &state); virtual int GetContrast(UINT8 &contrast); virtual int GetBrightness(UINT8 &brightness); virtual int GetVolume(UINT8 &volume); virutal int GetScreensaverTime(UINT16 &time); virtual int GetScreensaverState(UINT8 &state);

virtual int SetWheelVal(SINT16 val); virtual int SetLed(UINT8 ledNum, TKVCLedMode mode); virtual int SetContrast(UINT8 contrast); virtual int SetBrightness(UINT8 brightness); virtual int SetVolume(UINT8 volume); virtual int SetScreenSaver(UINT16 screenSaverTime); virtual int SwitchBacklight(UINT8 backlightOnOff);

virtual int WriteToFlash(); virtual int PlaySound(UINT16 soundNr); sockaddr_in GetSocketAdr(); SOCKET GetSocket();

};

The methods OnOverrideChange, OnWheelChange, OnKeypadEvent, OnJoystickEvent and OnSpacemouseEvent will be called if an event has occurred at the corresponding operating element on the client.

int CKVCConnection::OnOverrideChange(SINT16 val); This method will be called if the value of the override potentiometer has changed on the client. The current value is specified in the parameter val.

int CKVCConnection::OnWheelChange(SINT16 wheelAbsVal); The method OnWheelChange will be called if the value of the handwheel has changed. The current value is transferred as an absolute value in the parameter wheelAbsVal.

virtual int OnKeypadEvent(TKVCEvent keyEvent, int keyNum);

Robotics Membrane Keypad“ on page 41.

User's Manual, version: 3.1 / material no.: 57448 85

Page 88

Software KeTop T100

The method OnKeypadEvent will be called if a key has been pressed/released. The key number is specified in keyNum, the state of the key (make, break) in keyEvent.

int CKVCConnection::OnJoystickEvent(TKVCEvent event, TKVCJoystickData *pJData); The method OnJoystickEvent is called when the joystick is moved from the 0 position and reaches the 0 position. The current position is transferred in the parameter event, and the current values in the parameter pJData.

int CKVCConnection::OnSpacemouseEvent(TKVCEvent event, TKVCSpaceMouseData *pSMData); The method OnSpacemouseEvent is called when the space mouse is moved from the 0 position and reaches the 0 position. The current position is transferred in the parameter event, and the current values in the parameter pSMData.

int CKVCConnection::OnDisconnect(int val); The method OnDisconnect will be called if the client terminates the connection with the disconnect message.

int CKVCConnection::GetWheelVal(TKVCHandWheelData &hwData); The method GetWheelVal returns the current position value of the wheel in hwData.absVal, and the modification value since the last call in hwData.dynVal.

int CKVCConnection::GetOverrideValue(SINT16 &overrideVal); The method GetOverrideValue returns the current value of the override potentiometers in the variable overrideVal.

int CKVCConnection::GetJoystickPos(TKVCJoystickData &jData); The method GetJoystickPos returns the current joystick position in the variable jData.

int CKVCConnection::GetSpaceMousePos(TKVCSpaceMouseData &smData); The method GetSpaceMousePos returns the current space mouse position in the variable smData.

int CKVCConnection::GetLedState(UINT8 ledNr , UINT8 &state); The method GetLedState is used to request the current state of the LED transferred in ledNr. The result is returned in state.

int CKVCConnection::GetContrast(UINT8 &contrast); The method GetContrast returns the current value of the contrast setting in the variable contrast.

int CKVCConnection::GetBrightness(UINT8 &brightness); The method GetBrightness returns the current value of the brightness setting in the variable brightness.

int CKVCConnection::GetVolume(UINT8 &volume); The method GetVolume returns the current value of the volume setting in the variable volume.

int CKVCConnection::GetScreensaverTime(UINT16 &screensaverTime); The method GetScreensaverTime returns the current value of the screensaver setting in the variable screensaverTime.

int CKVCConnection::GetScreensaverState(UINT8 &state); The method GetScreensaverstate returns the current state of the screensaver in the variable state.

int CKVCConnection::GetBacklightState(UINT8 &state);

86 User's Manual, version: 3.1 / material no.: 57448

Page 89

Handheld Terminal Software

The method GetBacklightState returns the current state of the background lighting in the variable state.

int CKVCConnection::SetWheel(SINT16 value);

This method sets the value of the handwheel to the value specified in value and returns the last value. This value is the initial value for the absolute value returned by OnWheelChange.

int CKVCConnection::SetLed(UINT8 ledNum, TKVCLedeMode mode); Calling the method SetLed sets the LED defined in ledNum to the mode transferred in mode.

int CKVCConnection::SetContrast(UINT8 contrast); Calling the method SetContrast changes the value of the contrast setting on the client.

int CKVCConnection::SetBrightness(UINT8 brightness); Calling the method SetBrightness changes the value of the brightness setting on the client.

int CKVCConnection::SetVolume(UINT8 volume); Calling the method SetVolume changes the value of the volume setting on the client.

int CKVCConnection::SetScreensaver(UINT16 screensaverTime); Calling the method SetScreensaver changes the response time of the screensaver on the client.

int CKVCConnection::SwitchBacklight(UINT8 backlightOnOff); Calling the method SwitchBacklight switches on and off the background lighting on the client (backlightOnOff = 1 / backlightOnOff = 0).

int CKVCConnection::WriteToFlash(); Calling the method WriteToFlash saves the contents of the Client Windows Registry in the flash memory.

int CKVCConnection::PlaySound(UINT16 soundNr); Calling the method PlaySound starts the reproduction of the sound with the number transferred in soundNr.

sockaddr_in GetSocketAdr(); The method GetSocketAdr returns the features of the connection;

SOCKET GetSocket(); The method GetSocket returns the current socket of the connection with the client.

User's Manual, version: 3.1 / material no.: 57448 87

Page 90

Software KeTop T100

Server Implementation

The base of the server are the two classes

CKVCConnection. The class CKVCServer establishes and manages the

connections. The class

CKVCConnection constitutes the actual connection.

To correctly implement a server, a derivation of the class needed.

class CKVCTestServer: public CKVCServer{ public: CKVCTestServer(); virtual ~CKVCTestServer();

CKVCConnection* OnClientConnect(SOCKET socket, sockaddr_in &sockAdr); int OnClientDisconnect(CKVCConnection *pConnection, TKVCDisconInfo info); };

In this class, the method In this method, a

CKVCConnection* CKVCTestServer::OnClientConnect(SOCKET socket, sockaddr_in &sockAdr){ CKVCTestConnection *pConnect = 0; ... pConnect = new CKVCTestConnection(); if (pConnect != 0){ pConnect->Init(this, socket, sockAdr); } ... return pConnect; }

CKVCConnection object must be created and initialized.

OnClientConnect must be overwritten.

The method anteed that the method

OnClientDisconnect can be overwritten. But it must be guar-

CKVCServer::OnClientDisconnect is called in

this derivation.

int CKVCTestServer::OnClientDisconnect(CKVCConnection *pConnection, TKVCDisconInfo info){ ... return CKVCServer::OnClientDisconnect(pConnection, info); }

In the derivation of the class CKVCConnection, only the Event and Change method must be derived. The Get methods can be derived, but it must be guaranteed that the method of the base class is called before the data are used.

class CKVCTestConnection: public CKVCConnection{ public: CKVCTestConnection(); virtual ~CKVCTestConnection();

virtual int OnOverrideChange (SINT16 val); virtual int OnWheelChange (SINT16 wheelAbsVal); virtual int OnKeypadEvent (TKVCEvent keyEvent, UINT8 keyNum);

CKVCServer and

CKVCServer is

88 User's Manual, version: 3.1 / material no.: 57448

Page 91

Handheld Terminal Software

virtual int OnJoystickEvent (TKVCEvent event, TKVCJoystickData *pJData); virtual int OnSpaceMouseEvent (TKVCEvent event, TKVCSpaceMouseData *pSMData); virtual int OnAliveMsg (); virtual int OnDisconnect (); virtual int GetWheelVal (TKVCHandWheelData &hwData); virtual int GetOverrideVal (SINT8 &overrideVal); virtual int GetJoystickPos (TKVCJoystickData &jData); virtual int GetSpaceMousePos (TKVCSpaceMouseData &smData); virtual int GetLedState(UINT8 ledNum, UINT8 &state); virtual int GetContrast (UINT8 &contrast); virtual int GetBrightness (UINT8 &brightness); virtual int GetVolume (UINT8 &volume); virtual int GetScreensaverTime(UINT16 &screeTime); virtual int GetScreensaverState(UINT8 &state); virtual int GetBacklightState (UINT8 &state); };

int CKVCTestConnection::OnOverrideChange (SINT16 val){ cout << "OnOverrideChange: " << (int)val << endl << flush; return true; }

int CKVCTestConnection::GetOverrideVal (SINT8 &overrideVal){ CKVCConnection::GetOverrideVal(overrideVal); cout << "GetOverrideVal: " << (int)overrideVal << endl << flush; return true; }

User's Manual, version: 3.1 / material no.: 57448 89

Page 92

Software KeTop T100

Remote Software ActiveSync

This software is used as a debug interface and to adjust and transmit data from and to a PC.

The remote software ActiveSync is a product by Microsoft and can be downloaded free of charge from the following download address:

http://www.microsoft.com/windowsmobile//downloads/activesync38.mspx

The data connection from the KeTop to the PC is established as follows:

► 1. Remove the cover of the cable entrance area on the KeTop. ► 2. Plug in the Download Cable KeTop XD 040 ► 3. Start the ActiveSync software on the PC

a) select 'File' -> 'Delete Partnership' ...

b) deactivate '( ) Allow serial cable or ... ' -> <OK>

c) activate '(x) Allow serial cable or ... ' -> <OK>

► 4. Start the ActiveSync-Software on the KeTop:

Start -> Programs -> Communication -> Active Sync

► 5. At the PC:

- Connect KeTop as a "Guest' (Set Up a Partnership -> No).

Now the data connection between the KeTop and the PC is established. In case of communication problems, check the following conditions:

z Max. time delay between step 3c) and step 4. = 30s. z For further attempts repeat steps 3. to 5. z The ActiveSync software must be started manually.

(Plugging in the connection cable does not start ActiveSync!)

z The factory-set baudrate for the remote connection is 115 kBaud.

In case of communication problems the baudrate can be reduced.

The baudrate can be changed as follows:

- Start -> Programs -> Communication -> Remote Networking

- select "com1_115k"

- File -> Properties

- SP1 on COM1: -> Configure -> Port Setttings

(...change Baud Rate...)

- Close all Windows with <OK>

(optional: Start -> Programs -> KeTop -> Registry Backup -> <OK>)

90 User's Manual, version: 3.1 / material no.: 57448

Page 93

Handheld Terminal Software

Test tool (VC++ Demo)

Requirements

The reader must have knowledge of object-oriented programming, embed- ded C++ and MFC. The graphs are displayed in UML standard according to OMT.

Task of the test tool

The test tool is a C++ demo and is used to display values that are made available by the KetopAPI, such as wheel values, potentiometer values, key states and LED states, on the screen. These values are transmitted to the control by the SER protocol (CP001 data profile), immediately read out again from the control and also dis- played on the screen.

This test tool has been realized in embedded Visual C++ 3.0 plication of the MFC

® (for WinCe).

® with the ap-

Description of the classes

Class hierarchies

User's Manual, version: 3.1 / material no.: 57448 91

Page 94

Software KeTop T100

Class relations

TestToolApp

This class is the actual application that is displayed on the screen. The Init method creates and administrates the dialog (represented by the class TestToolDlg). So that the application can be accessed in a simple way dur- ing the running time of the program, this class always contains a member variable at both the SerCp and Ketop levels of abstraction.

TestToolDlg

HTKeysPPG

LedsPPG

PottiPPG

WheelPPG

SerConfigDlg

This dialog class contains the individual tabs that are realized by the Prop- ertyPage classes.

This class represents the HTKeys tab and is used for visualization of the keystrokes.

This class is responsible for administration of the LEDs and is displayed as the LED tab.

This class takes care of all values of the potentiometer and is visualized in the Potentiometer tab.

This class displays all changes to the wheel in the Wheel tab.

This class implements the functionality of the "configuration dialog" (see fol- lowing figure) that is displayed on the screen when the application is started. This enables the user to enter his own port configuration.

92 User's Manual, version: 3.1 / material no.: 57448

Page 95

Handheld Terminal Software

Since the values of this dialog must already be available for the initialization of the port, the dialog is held by the SerCp class as, from a design point of view, it fits best here.

SerCp

This class forms a level of abstraction above the CP001 driver and should simplify communication with the control for the application.

The Constructor loads the SerCp001.dll. Moreover, function pointers to the method of the SerCp001.dll that is used are immediately created and the Callback function that is used for reading out values to the control, is hung up. The Destructor closes the port and releases the Dll. This class provides a "simplified" interface for communicating with the control.

Ketop

This class also forms a level of abstraction above the KetopAPI and, thus, should simplify access to it. It provides a somewhat "simplified" interface to the outside world.

The Constructor loads the KetopAPI.dll. Also in this case, function pointers to the required method are retrieved (however, in a somewhat different manner than in the SerCp class) and a Callback function, which is called automatically by the KetopAPI during modification, is hung up.

Procedure using the example of the test tool

The Init of the TestToolApp class firstly initializes the member variable (mSerCp) of the SerCp class that sees to the configuration of the driver. At the same time, the configuration dialog (SerConfigDlg) is called, the en- tered values are stored and, with them, the port to the control is opened and configured. The TestToolDialog is then called (in the TestToolApp class) and displayed on the screen. This starts with the start of a timer that issues a cyclical write command with the read command to the control. (Without the timer, the application would never be informed about modifica- tions to the control because, in this test example, the control never be- comes active by itself.)

User's Manual, version: 3.1 / material no.: 57448 93

Page 96

Software KeTop T100

If, for example, the wheel is now rotated, the Callback function of the Keto- pAPI is called automatically. There, a Windows message is sent, and re- ceived and processed by the test tool application which, in this case, is synonymous with a graphical update of the tab that is currently active. This modified value is then sent to the control by a write command.

The started timer cyclically informs the control that it would like to read. The control calls the Callback function registered with it and thus triggers a Window message. This, in turn, is received by the application. In the next step, a read command is sent to the control and the tab that is currently ac- tive is determined. The modified values are handed over to this tab and only this tab carries out an update of the screen.

General procedure for communicating with the control using the SerCp001.dll

1. Load the library (SerCp001.dll)

2. Retrieve the function pointers to the required method

3. Install the Callback function

4. Open and configure the port

5. Use the methods that are made available by the Dll

6. Close the port again

7. Release the library

94 User's Manual, version: 3.1 / material no.: 57448

Page 97

Handheld Terminal KeTop - Specific Operating Instructions

8 KeTop - Specific Operating Instructions

This chapter describes the KeTop-specific settings and the differences to standard Windows CE devices.

Notice

• The date and the time are not stored in the KeTop and, if needed, must

be set anew after turning off/on. The date and the time may be very im- portant for the log data for example.

Notice

• At settings that have not been made with the ConfigTool, the modifica-

tions must be saved as follows:

Start -> Programs -> KeTop -> Registry Backup (or in the explorer with the command „\windows\regflush.exe“)

Setting of Date and Time

During start-up the KeTop shows automatically the window for setting date and time:

Should the window for date and time not be shown, the checkbox has to be deactivated. This must be saved in the registry ("Start -> Programs -> Ke- Top -> Registry Backup").

The KeTop is not equipped with a real time clock. So, if you use the time it must be set during each star-up.

User's Manual, version: 3.1 / material no.: 57448 95

Page 98

KeTop - Specific Operating Instructions KeTop T100

KeTop Configuration Tool (ConfigTool)

The ConfigTool is used to calibrate the operating elements, to control the functionality of the operating elements, to select the Ethernet interface and to set start-up functions.

To activate the tool, select the following item:

Start -> Programs -> KeTop -> KeTop Configuration Tool

(or by double-clicking on the file „Configuration_Tool.exe“ in the Windows directory).

Notice

• The appearance of the Config tool depends on the operating elements

installed in KeTop (the menus for override potentiometer, joystick and

handwheel are only displayed when the operating elements are in-

stalled in the device).

After carrying out modifications on the configuration and quitting the pro- gram, you can save all modifications in the registry. A window with the fol- lowing message and options appears:

Data has changed! Do you want to write the registry to the flash? Yes/No

With „No“, the settings are contained in the DRAM and will not be stored therefore. They will get lost when the KeTop is turned off.

„Yes“ saves the calibration in the flash. The settings are preserved after a restart of the device. The device is blocked during the saving procedure (takes approx. 10 s).

96 User's Manual, version: 3.1 / material no.: 57448

Page 99

Handheld Terminal KeTop - Specific Operating Instructions

Calibration of Joystick

A number is displayed next to the slide bar. During calibration, this number specifies the current value of the ADC (value range: 0..1024) and only con- trols the function. After calibration, the number specifies the current value of the joystick/potentiometer (value range: -15 .. 15 for each joystick axis). This value is also the value the KeTop API function KtpGetJoystickPos supplies to the application.

Calibration of Potentiometer

A number is displayed next to the slide bar. During calibration, this number specifies the current value of the ADC (value range: 0..1024) and only con- trols the function. After calibration, the number specifies the current value of the potentiometer (value range: 0 ...127). This value is also the value the KeTop API function KtpGetOverridePoti supplies to the application.

User's Manual, version: 3.1 / material no.: 57448 97

Page 100

KeTop - Specific Operating Instructions KeTop T100

Display and Touch Screen Settings

In this window, the brightness and the contrast for the display are set.

In this window you can also calibrate the touch screen.

Setting the Handwheel to Zero

The handwheel outputs a 16-bit value which can be processed in the cus- tomer application as needed (e.g.: 0-65535, +-32767, ...). In the dialog box, the value from 0 to 65535 is displayed. When the device is turned on, the value of the handwheel will be set to 0. If the key „Set“ is pressed, the current value of the handwheel will be re- placed by the start value.

98 User's Manual, version: 3.1 / material no.: 57448