Electronic-Key-System
Manual
Software ActiveX® Module serial / USB
Order No. 098 655
Manual EKS ActiveX® Module serial / USB
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 ActiveX® module .......................................................................................................................... |
6 |
||
3.1 |
EKS type library ..................................................................................................................................... |
6 |
|
3.2 |
EKS control ............................................................................................................................................ |
6 |
|
3.3 |
Overview of the methods, properties and events in the EKS ActiveX® module .................................... |
7 |
|
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 |
BaudRate ................................................................................................................................. |
10 |
|
3.5.2 |
Port........................................................................................................................................... |
10 |
|
3.5.3 |
KeyType ................................................................................................................................... |
10 |
|
3.5.4 |
LastState (ReadOnly) .............................................................................................................. |
11 |
|
3.5.5 |
StartAdress .............................................................................................................................. |
12 |
|
3.5.6 |
CountData ................................................................................................................................ |
12 |
|
3.5.7 |
BlockSize ................................................................................................................................. |
13 |
|
3.5.8 |
PollingTime .............................................................................................................................. |
13 |
|
3.5.9 |
Opening.................................................................................................................................... |
13 |
|
3.5.10 |
Reading.................................................................................................................................... |
13 |
|
3.5.11 |
Writing ...................................................................................................................................... |
14 |
|
3.5.12 |
KeyState................................................................................................................................... |
14 |
|
3.5.13 |
Version ..................................................................................................................................... |
14 |
|
3.5.14 |
Data.......................................................................................................................................... |
14 |
|
3.5.15 Debug....................................................................................................................................... |
15 |
|
3.6 |
Constants............................................................................................................................................. |
15 |
|
Page 2/20 |
Subject to technical modifications |
098655-03-10/12 |
Manual EKS ActiveX® Module serial / USB
3.7 |
Events |
.................................................................................................................................................. |
16 |
|
3.7.1 ...................................................................................................................................... |
OnKey |
16 |
|
3.7.2 .................................................................................................................................... |
OnRead |
16 |
|
3.7.3 .................................................................................................................................... |
OnWrite |
16 |
4 Examples.................................................................................................................................................... |
|
17 |
|
4.1 |
Establishing ............................................................connection with the EKS Electronic-Key adapter |
17 |
|
4.2 |
Example ....................................................................................................event call in Visual Basic® |
18 |
|
098655-03-10/12 |
Subject to technical modifications |
Page 3/20 |
Manual EKS ActiveX® Module serial / USB
1 General notes
This ActiveX® module supports the integration of the Electronic-Key-System (EKS) Electronic-Key adapter with serial and USB interface into your PC application. EKS can thus be used, e. g., in conjunction with process visualization software. Data communication is in accordance with transfer protocol 3964R. The ActiveX® module is used here as a protocol driver.
With the aid of the EKS ActiveX® module, communication can be straightforwardly established with the 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 and integrated into the related programming environment.
1.1Use of the manual
This manual explains the functions of the EKS ActiveX® module (order no. 098 708), from version 1.0.3.0.
The manual does not apply to earlier software releases or the previous version of the EKS ActiveX® module (order no. 084 708).
1.2Explanation of symbols
The following symbols are used in this manual to identify important instructions and useful information:
Information!
Important information is provided to the user here.
Attention!
Risk of loss of data.
1.3Requirements on the user
To be able to use the EKS ActiveX® module correctly, you must have knowledge of the utilization of ActiveX® modules. To be able to straightforwardly integrate the EKS hardware into your overall system, you must have read and understood the manual for the Electronic-Key adapter.
1.4System requirements
Hardware: Standard PC, no special requirements
Software: |
If you use an EKS Electronic-Key adapter with USB interface, the |
|
EKS-USB driver (order no. 094 376) from version 1.3.0.0 must be installed on the |
|
system. |
Operating system: |
Windows® XP |
|
Windows® 7 32-Bit |
|
Windows® 7 64-Bit |
|
Windows® Server 2008 32-Bit |
|
Windows® Server 2008 64-Bit |
|
Windows® Server 2008 R2 64-Bit |
Page 4/20 |
Subject to technical modifications |
098655-03-10/12 |
Manual EKS ActiveX® Module serial / USB
2 Support information, installing and uninstalling
To be able to use the EUCHNER EKS serial ActiveX® module, you must first install it. Execute the corresponding installation file, depending on the the present operating system.
For Windows® 32-Bit: EKS_ActiveX_Module.msi
For Windows® 64-Bit: EKS_ActiveX_Module_x64.msi
Information!
During the installation you will be prompted to enter an installation folder. Once the installation is complete this folder will contain:
the ActiveX® module
this manual in Acrobat PDF format
The installation CD contains:
the programs EKS_ActiveX_Module.msi and EKS_ActiveX_Module_x64.msi
this manual in Acrobat PDF format
programming examples for various programming environments
To uninstall the ActiveX® 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 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.
098655-03-10/12 |
Subject to technical modifications |
Page 5/20 |
Manual EKS ActiveX® Module serial / USB
3 The EKS ActiveX® module
3.1EKS type library
Description |
EUCHNER EKS ActiveX module |
|
Library |
EKSLib |
|
File name |
eks.ocx |
|
|
GUID |
{ 62A51CD4-76C1-453D-B258-804D12988851 } |
|
Control |
EKS |
3.2EKS control
Control name |
EKS |
File name |
eks.ocx |
GUID |
{ 64CAE8A8-3CB8-4929-A90F-57499A6E83F3 } |
Properties |
15 |
Events |
3 |
Methods |
4 |
Before you can use the EKS ActiveX® module in your application, you must add the file eks.ocx to your project. To use an application that makes use of the ActiveX® module, you must install the module on your computer.
Page 6/20 |
Subject to technical modifications |
098655-03-10/12 |
Loading...