EUCHNER ActiveX Module Ethernet TCP-IP User Manual
Electronic-Key-System
Manual
Software ActiveX
®
Module Ethernet TCP/IP
Order No. 102 030
Manual EKS ActiveX® Module Ethernet TCP/IP
Table of contents
1 General notes...............................................................................................................................................4
1.1 Use of the manual..................................................................................................................................4
1.2 Explanation of symbols..........................................................................................................................4
1.3 Requirements on the user .....................................................................................................................4
1.4 System requirements.............................................................................................................................4
2 Support information, installing and uninstalling .....................................................................................5
3 The EKS Ethernet ActiveX
3.1 EKS type library .....................................................................................................................................6
3.2 EKS control ............................................................................................................................................6
3.3 Overview of the methods, properties and events in the EKS Ethernet ActiveX
3.4 Methods .................................................................................................................................................8
3.4.1 Open ..........................................................................................................................................8
3.4.2 Close ..........................................................................................................................................8
3.4.3 Read...........................................................................................................................................8
3.4.4 Write...........................................................................................................................................8
3.4.5 getData.......................................................................................................................................9
3.4.6 setData.......................................................................................................................................9
3.5 Properties.............................................................................................................................................10
3.5.1 Port...........................................................................................................................................10
3.5.2 IPAddress.................................................................................................................................10
3.5.3 KeyType ...................................................................................................................................10
3.5.4 LastState (ReadOnly) ..............................................................................................................11
3.5.5 StartAdress ..............................................................................................................................12
®
module ..........................................................................................................6
®
module .....................7
3.5.6 CountData ................................................................................................................................12
3.5.7 Opening....................................................................................................................................13
3.5.8 Reading....................................................................................................................................13
3.5.9 Writing ......................................................................................................................................13
3.5.10 KeyState...................................................................................................................................13
3.5.11 Version .....................................................................................................................................13
3.5.12 Data..........................................................................................................................................14
3.5.13 Debug.......................................................................................................................................14
3.6 Constants.............................................................................................................................................15
3.7 Events ..................................................................................................................................................16
3.7.1 OnKey ......................................................................................................................................16
Page 2/20 Subject to technical modifications 102030-02-10/12
Manual EKS ActiveX® Module Ethernet TCP/IP
3.7.2 OnRead....................................................................................................................................16
3.7.3 OnWrite ....................................................................................................................................16
4 Examples....................................................................................................................................................17
4.1 Establishing connection with EKS Electronic-Key adapter..................................................................17
4.2 Example event call in Visual Basic
®
....................................................................................................18
102030-02-10/12 Subject to technical modifications Page 3/20
Manual EKS ActiveX® Module Ethernet TCP/IP
1 General notes
This ActiveX® module supports the integration of the Electronic-Key-System (EKS) Electronic-Key adapter with
Ethernet interface into your PC application. EKS can thus be used, e. g., in conjunction with process
visualization software. Data communication takes place using the TCP/IP protocol. The ActiveX
used here as a protocol driver.
With the aid of the EKS Ethernet ActiveX
EUCHNER Electronic-Key-System (EKS) from programming environments that support ActiveX (e. g. Microsoft
Visual Basic
®
) or user programs (e. g. Microsoft Excel®). For this purpose the ActiveX® module must be installed
®
module, communication can be straightforwardly established with the
and integrated into the related programming environment.
1.1 Use of the manual
This manual explains the functions of the EKS Ethernet ActiveX® module (order no. 100 665), from version
1.0.3.0.
1.2 Explanation of symbols
The following symbols are used in this manual to identify important instructions and useful information:
®
module is
Information!
Important information is provided to the user here.
Attention!
Risk of loss of data.
1.3 Requirements on the user
To be able to use the EKS Ethernet ActiveX® module correctly, you must have knowledge of the utilization of
ActiveX
must have read and understood the manual for the Electronic-Key adapter.
®
modules. To be able to straightforwardly integrate the EKS hardware into your overall system, you
1.4 System requirements
Hardware: Standard PC, with network connection
Software: TCP/IP protocol must be installed.
Operating system: Windows
Windows
Windows
Windows
Windows
Windows
®
XP
®
7 32-Bit
®
7 64-Bit
®
Server 2008 32-Bit
®
Server 2008 64-Bit
®
Server 2008 R2 64-Bit
Page 4/20 Subject to technical modifications 102030-02-10/12
Manual EKS ActiveX® Module Ethernet TCP/IP
2 Support information, installing and uninstalling
To be able to use the EUCHNER EKS Ethernet ActiveX® module, you must first install it. Execute the
corresponding installation file, depending on the present operating system.
For Windows
For Windows
Information!
During the installation you will be prompted to enter an installation folder. Once the installation is
complete this folder will contain:
the ActiveX
this manual in Acrobat PDF format
The installation CD contains:
the programs EKS_Ethernet_ActiveX_Module.msi and EKS_Ethernet_ActiveX_Module_x64.msi
this manual in Acrobat PDF format
programming examples for various programming environments
To uninstall the ActiveX
®
32-Bit: EKS_ActiveX_Module.msi
®
64-Bit: EKS_ActiveX_Module_x64.msi
®
module
®
module or to obtain support information, proceed as follows:
1. In the operating system select Settings | Control Panel | Add/Remove Programs.
2. In the list of programs installed select the entry EUCHNER EKS Ethernet ActiveX Module. You can also
display support information here.
Information!
Always have the support information at hand when contacting EUCHNER.
3. To uninstall, click Change/Remove and follow the instructions in the uninstall dialog box.
102030-02-10/12 Subject to technical modifications Page 5/20
Manual EKS ActiveX® Module Ethernet TCP/IP
3 The EKS Ethernet ActiveX® module
3.1 EKS type library
Description EUCHNER EKS Ethernet ActiveX module
Library EKSEthLib
File name ekseth.ocx
GUID { 36B62232-F5C4-4b46-BA4A-4B1F3F2C7974 }
Control EKSETH
3.2 EKS control
Control name EKSETH
File name ekseth.ocx
GUID { 72484DED-F77A-487c-9DC7-5751D10DBF17 }
Methods 6
Properties 13
Events 3
®
Before you can use the EKS Ethernet ActiveX
your project. To use an application that makes use of the ActiveX
computer.
module in your application, you must add the file ekseth.ocx to
®
module, you must install the module on your
Page 6/20 Subject to technical modifications 102030-02-10/12
Loading...