Manual

Software for efector octavis VSExxx

OPC-Server
UK

E30114
12 / 2007
704305UK / 01
OPC Server Software for efector octavis VSExxx

Content
1 System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
3 Config Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
4 OPC Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.1 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.2 Start . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.3 End . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5 OPC Server tree structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
5.1 Tree elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
[OPC-Server-Octavis] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
[General*] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
[Versions] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
[opcServer] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
[vseDll] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
[restartServer] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[stopService] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[stopService] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[Configuration] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[General**] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[Selftest] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[Monitoring] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
[Parameter] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
[Expert-Config] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
[configuredName] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
[configuredIpAddress] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
[configuredTcpPort] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
[vseId] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
[vseName] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
[macAddress] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
[ipAddress] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
[systemMode] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
[sensorName1...4] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
[actualVariant] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
[rebootVse] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
[result] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
[sensorsNeeded] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
[sensorsConnected] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[doSelftest] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[Objects] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[Object 1...24] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[Analysing-method] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[HFFT:FFT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[isVelocity] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
[Peak:RMS] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
[name] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
[sensorId] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
[ReadState] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
[objectValue] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[damageLevel] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[speed] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[IOs] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[Io1...8] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[ioValue] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[isInput] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
[Out] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
[Out1] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
[isAnalog] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
[isVoltage] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17


 OPC Server Software for efector octavis VSExxx

[Out2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
[Aux] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
[Aux1...2] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
[isCurrentInput] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
[Parameter] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
[Objects] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
[Object1...24] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
[Damping] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
[averages] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
[responseDelay] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
[Limits] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
[yellow] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 UK
[red] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
[Teach] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
[teachValue] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[doTeach] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[readTeach] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[writeTeach] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[name] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[sensorId] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[rpmId] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
[RPM-Objects] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
[RPM-Object1...24] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
[rpmValue] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
[Read] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
[write] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
[unit] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21


OPC Server Software for efector octavis VSExxx

1 System requirements
● PC with Pentium II 266 MHZ processor or higher – Pentium III recommended
● Microsoft Windows NT, 2000, XP, Server 2003
● 128 MB RAM for the operating system and additional 32 MB for the OPC Server
● 256 MB of available hard disk space, including NET Framework and OPC Core Components
● Ethernet 10 / 100 Mbit

2 Installation
� NOTE
Please deinstall any older versions on your computer of the OPC Core Components (e.g. Version 2.0) be-
forehand.

► To install the OPC Server please start the installation wizard „Setup.exe“.
> During the installation the.Net Framework and the OPC Core Components 3.0 will be installed if required.


 OPC Server Software for efector octavis VSExxx

The Default paths are as follows:

● C:\Program Files\ifm electronic\efector octavis\octavis OPC\bin
They contain theEXE files („OctavisOpcServer.exe“, „ConfigTool.exe“) and the „VSE Communication DLL“
(VSExxx.dll).
„OctavisOpcServer.exe“ is a service and is automatically started when an OPC Client has been connected or
in certain cases when the Config Tool has been started.
● C:\Documents and settings\All Users\Application Data\ifm electronic\efector octavis\octavis opc
with two sub-folders
“Config” and “Log”, which contain Logfiles (of the OPC Server and the DLL) as well as the Config Tool confi-
guration files.
UK

3 Config Tool
The Config Tools creates an XML configuration file. This in turn is used as a configuration file for the OPC
Server.


OPC Server Software for efector octavis VSExxx

4 OPC Server
OPC = OLE Proprocess Control

4.1 General
As previously mentioned the OPC Server is started as a service and is included in the list of applications
(→ Windows „Settings“ > „Control panel“ > „Admininstration“ > „Applications“).

4.2 Start
The OPC Server is automatically started by the client.

4.3 End
Under normal use it is not necessary to manually end the software. If required you can exit using the Task
Manager, Services or directly from the OPC Client ([stopService]).

5 OPC Server tree structure

The tree structure is created as follows:
– Nodes: has no own value, e.g. [Objects]
– Element: has own values and is alloted to a node
– Property: the contents belong to an element or a node.
In the following grafics the individual components are recognisable by the designated shape of the symbols:
– Nodes = hexagonal symbols, e.g. [Selftest]
– Elements = rectangular symbols, e.g. [[doSelftest]]
– Properties = oval symbols, e.g. [[sensorsNeeded]].
The following illustration 1 just shows the node model as an overview. To have a better overview the Elements
are shown completely in the following grafics.
After the grafics the tree elements are explained and their position is given in reference to the tree structure.
Node-titles always start with capital letters.
The names of the Elements and Properties start with uncapitalized letters.
The Native datatype is always given according to the Softing standard.


 OPC Server Software for efector octavis VSExxx

UK

Illustration 1: Node overview (tree structure)


OPC Server Software for efector octavis VSExxx

Illustration 2: Expanded nodes


 OPC Server Software for efector octavis VSExxx

UK

Illustration 3: Expert-Config (Not implemented)

5.1 Tree elements

[OPC-Server-Octavis]
Child of [root]
Tree Structure Type Node

[General*]
Child of [OPC-Server-Octavis] (root)
Tree Structure Type Node

Server specific actions or data.

[Versions]
Child of [General*]
Tree Structure Type Node

Server specific actions or data.

[opcServer]
Child of [Versions]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read

[vseDll]
Child of [Versions]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read


OPC Server Software for efector octavis VSExxx

[restartServer]
Child of [General*]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read and write

The server is stopped, all connections to the VSEs are disconnected and then recreated. The service is not
cancelled and the DLL remains in the memory.
To start again the server has to be reconnected.

[stopService]
Child of [General*]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read and write

The service is finished. Here in addition to disconnection the the DLL removed from the memory. To restart
the server has to be reconnected and started.

[stopService]
Child of [OPC-Server-Octavis] (root)
Tree Structure Type Node

Contains all the settings which have been made with the Config Tool.
[stopService] is then the name for a VSE, with which you are connected (if the nodes are not completely
shown this means that the Diagnostic Electronics is not parametised or not available).

[Configuration]
Child of [stopService]
Tree Structure Type Node

All settings which have been made with the Config Tool.
Data update for all the related tags after [restartServer] or [stopService].

[General**]
Child of [stopService]
Tree Structure Type Node

VSE specific settings or conditions.

[Selftest]
Child of [stopService]
Tree Structure Type Node

Refers to each sensor.

[Monitoring]
Child of [stopService]
Tree Structure Type Node

Queries the values of a VSE.

The query cycle can be set using the OPC Server (minimum 100 ms).

10
 OPC Server Software for efector octavis VSExxx

[Parameter]
Child of [stopService]
Tree Structure Type Node

Reduced settings of a VSE parameter set.

The parameters cannot be set for the VSE using the OPC Server. It is only possible to made adjustments.

� NOTE
Parameters can only be changed by the OPC Server if no other client has switched the VSE to the Setup
Mode (→ [systemMode]).
UK
[Expert-Config]
Child of [stopService]
Tree Structure Type Node

Is not supported by this version.

[configuredName]
Child of [Configuration]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read

Name of theVSE, with which the OPC Server communicates (can be set in the Config Tool). The VSE is
shown as a node bearing this name (→ [stopService]).

[configuredIpAddress]
Child of [Configuration]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read

IP-Address (can be set in the Config Tool). Default factory setting value is: 192.168.0.1

[configuredTcpPort]
Child of [Configuration]
Tree Structure Type Element
Native Datatype I4
Access Rights Read

Port (can be set in the Config Tool). Default factory setting value is: 3321

[vseId]
Child of [General**]
Tree Structure Type Element
Native Datatype I4
Access Rights Read

The number the DLL uses to communicate with the VSE results out of the sequence the VSEs activate Vse-
Connect. This facilitates reading the Logfiles.

11
OPC Server Software for efector octavis VSExxx

[vseName]
Child of [General**]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read

Is composed of 5 fields (→ VES003 > Project > Header data) and is used for further identification of the VSE
unit.

[macAddress]
Child of [General**]
Tree Structure Type Element
Native Datatype BST
Access Rights Read

The MAC-Address used to communicate with the VSE (included on the labelling of the VSE).
E.g..: 00-02-01-30-02-81

[ipAddress]
Child of [General**]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read

The IP-Address which is programmed in the VSE can differ to the [configuredIpAddress], if the VSE e.g is
accessed using a router.

[systemMode]
Child of [General**]
Tree Structure Type Element
Native Datatype BST
Access Rights Read

The VSE has one of 4 possible modi for the the clients to which it is connnected:
1. Mode [Selftest] Selftest
2. Mode [Supervise[ Monitoring, i.e. sampling measurement values
3. Mode [Meassurement] Measurement of the spectrum (not possible with the OPC Server)
4. Mode [Setup] Adjusting the parameters

The basic modus is Mode [Supervise] (2).

If the VSE is in a different modus, it does NOT supply any measurement values.
Switching from one to another of the above mentioned modi occurs automatically and the OPC Server resets
automatically into the basic modus.
Example: [doSelftest]
All the clients which are connected to a VSE have the same modus!

[sensorName1...4]
Child of [General**]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read

The name for each sensor (Sensor1 to Sensor4) is shown as means of identification.

12
 OPC Server Software for efector octavis VSExxx

[actualVariant]
Child of [General**]
Tree Structure Type Element
Native Datatype UI2
Access Rights Read and write

Current version of the VSE.

� NOTE
● If the VSE has been programmed with an Event Object of type [ChangeVariant], it is no longer possible to
write the variants. UK
● If the variants are changed the [ReadState] mode for Objects (or subobjects), which are not active for the
new variants, change to „15“.
If [Monitoring] values are sampled the value „zero“ is always given.
The OPC server does not show which variants are active for an object.

[rebootVse]
Child of [General**]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read and write

The VSE has been reset, i. e. the VSE interrupts the connection and reboots. The [Monitoring] settings are
automatically recovered.

[result]
Child of [Selftest]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read

Results of the last Selftest. The results are only shown for the sensors for which the Selftest is activated. This
is NOT shown by the OPC server.

� NOTE
If the Selbsttest has been deactivated for a sensor, and a Selftest is performed then the result is automatical-
ly reported as successful.

[sensorsNeeded]
Child of [result]
Tree Structure Type Property
Native Datatype BOOL ARRAY [4]
Access Rights Read

Sensor inputs required by the parameter set but are recognised as being faulty or not connected. This serves
to facilitate error identification.

13
OPC Server Software for efector octavis VSExxx

[sensorsConnected]
Child of [result]
Tree Structure Type Property
Native Datatype BOOL ARRAY [4]
Access Rights Read

Sensor inputs recognised by the Selftest, i.e. which are not faulty and have been connected to the VSE.

[doSelftest]
Child of [Selftest]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read and write

To trigger a Selfsttest. The value for [doSelftest] remains „1“, untill the Selftest has been completed. Quality of
[result], [sensorsNeeded] and [sensorsConnected] are temporarily changed to „Bad” (waiting for initial data).

[Objects]
Child of [Monitoring]
Tree Structure Type Node

All parameterised Objects are shown (e.g.with parameter software VES003).

[Object 1...24]
Child of [Monitoring] > [Objects]
Tree Structure Type Node

[Analysing-method]
Child of [Monitoring] > [Objects] > [Object n]
Tree Structure Type Node

[HFFT:FFT]
Child of [Analysing-method]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read

If TRUE = HFFT, else FALSE = FFT (→ VES003: Analysis method).

[isVelocity]
Child of [Analysing-method]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read

TRUE („1“) means that the delivered [objectValue] is an integrated measurement value (e.g. vibration velocity
in mm/s).

14
 OPC Server Software for efector octavis VSExxx

[Peak:RMS]
Child of [Analysing-method]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read

If TRUE („1“) Peak, else RMS (→ VES003).

[name]
Child of [Monitoring] > [Objects] > [Object n] UK
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read and write

For Object identification purposes.

[sensorId]
Child of [Monitoring] > [Objects] > [Object n]
Tree Structure Type Element
Native Datatype UI2
Access Rights Read

Gives the allocation to the sensor.

Numbering starts at „0“, i.e. „1“ is the Object allocated to Sensor2.

[ReadState]
Child of [Monitoring] > [Objects] > [Object n]
Tree Structure Type Element
Native Datatype UI4
Access Rights Read

Indicates the current failure condition.

Meaning of the displays:
1 Internal error Results invalid
2 Calculation error Results invalid
3 Speed not within operational During data recording the speed was not within the valid speed range.
range The evaluation of the results is therefore interrupted.
4 Speed deviations are too high During data recording the speed deviates too highly.
The evaluation of the results is therefore interrupted.
5 [teachValue] is not valid The [teachValue] is not valid (NAN or < 1x10-20).
The evaluation of the results is therefore interrupted.
6 No valid reference value for The reference value for signalweighting 1 refers to an entry with the value 0.
signal weighting 1 The evaluation of the results is therefore interrupted.
7 No valid reference value for The reference value for signalweighting 2 refers to an entry with the value 0.
signal weighting 2 The evaluation of the results is therefore interrupted.
8 Deactivated by signalweighting 1 The current entry for signalweighting 1 is 0.
The evaluation of the results is therefore interrupted.
9 Deactivated by signalweighting 2 The current entry for signalweighting 2 is 0.
The evaluation of the results is therefore interrupted.
15 Deactivated by variants Will be set by the DLL (all other values are 0).

� NOTE
[ReadState] can only be used in combination with [speed], [objectValue] or [damageLevel], as else the value
is not updated.

15
OPC Server Software for efector octavis VSExxx

[objectValue]
Child of [Monitoring] > [Objects] > [Object n]
Tree Structure Type Element
Native Datatype R4
Access Rights Read
Deadband Min: 0
Max: Sensor scaling factor

Object results according to the signal weighting.

[damageLevel]
Child of [Monitoring] > [Objects] > [Object n]
Tree Structure Type Element
Native Datatype R4
Access Rights Read
Deadband Min: 0
Max: [Limits.red]

[damageLevel] = [objectValue] / [teachValue]

[speed]
Child of [Monitoring] > [Objects] > [Object n]
Tree Structure Type Element
Native Datatype R4
Access Rights Read
Deadband Min: Speedobject operating range Min
Max: Speedobject operating range Max

[IOs]
Child of [Monitoring]
Tree Structure Type Node

All 8 IOs (configurable in- and outputs) are always shown (even with VSE001). The OPC server only indicates
whether it is an in- or output.

[Io1...8]
Child of [IOs]
Tree Structure Type Node

[ioValue]
Child of [Io1..8]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read

[isInput]
Child of [ioValue]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read

16
 OPC Server Software for efector octavis VSExxx

[Out]
Child of [Monitoring]
Tree Structure Type Node

VSE ouputs.

[Out1]
Child of [Out]
Tree Structure Type Element
Native Datatype BOOL UK
Access Rights Read
Deadband Only if set as analog output *)
Min = [valueAt4mA]
Max = [valueAt20mA[

Output 1 can be programmed as analog or digital output.

*) For VES003 → switching output 4 mA or 20 mA

[isAnalog]
Child of [Out1]
Tree Structure Type Property
Native Datatype BOOL / R4 *)
Access Rights Read

*) Native Datatype is R4, if the switching output is programmed as an analog output (only possible with
[Out1]), else it the datatype BOOL.

[isVoltage]
Child of [Out1]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read

If the switching output is programmed as analog (only possible for [Out1]) it can supply either a voltage value
or a current value.

[Out2]
Child of [Out]
Tree Structure Type Element
Native Datatype BOOL
Access Rights Read

Unlike [Out1] it cannot be programmed as an analog output.

[Aux]
Child of [Monitoring]
Tree Structure Type Node

VSE inputs (e.g. [speed]).

17
OPC Server Software for efector octavis VSExxx

[Aux1...2]
Child of [Aux]
Tree Structure Type Element
Native Datatype R4
Access Rights Read
Deadband Min und Max calculation *)

*) The calculation of Min and Max for the Deadband depends on settings (→ [isCurrentInput])
1 . Analog input:
Input of the minimum and maximum reference point it is possible to span a straight line which can be mea-
sured off at 0 and 20 mA.
2 . Pulse input:
Freely definable values: Min = 0 / Max = 100.000

[isCurrentInput]
Child of [Aux1...2]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read

The inputs can be programmed as analog or pulse inputs.

([isCurrentInput] = FALSE): Pulse input
The number of pulses per revoltion is not visible.
([isCurrentInput] = TRUE): Analog input
It can either be a current or voltage input (not shown by the OPC server).

[Parameter]
Child of [OPC-Server-Octavis] (root)
Tree Structure Type Node

Contains all OPC server settings which can be changed by default.

[Objects]
Child of [Parameter]
Tree Structure Type Node

Maximal 24 objects are shown. An object is only shown if it has been parametised (e.g. with the parameter
software VES003).

[Object1...24]
Child of [Parameter] > [Objects]
Tree Structure Type Node

[Damping]
Child of [Parameter] > [Objects] > [Object1...24]
Tree Structure Type Node

Damping the object results.

18
 OPC Server Software for efector octavis VSExxx

[averages]
Child of [Damping]
Tree Structure Type Element
Native Datatype R4
Access Rights Read and write

The diagnosis object values ([objectValue] and [damageLevel]) are averaged using a so-called „exponentially
weighted moving averages“.
Formula: xn = α * xn-1 + (1 - α) * x
α = [averages]: 0 < α < 1 UK
x = current measurement value
VES003 Averages:
conversion [averages] = 1 - Averages
Beispiel:
Averages = 1/8
→ [averages] = 1 - 1/8 = 1 - 0.125 = 0.875

[responseDelay]
Child of [Damping]
Tree Structure Type Element
Native Datatype UI2
Access Rights Read and write

To avoid alarms caused by deviations in the process it is possible to set a response delay, giving the number
of alarm conditions allowed before signalling alarm.
In this case an alarm condition means the surpassing of a damage level, → [Limits].

[Limits]
Child of [Parameter] > [Objects] > [Object1...24]
Tree Structure Type Node

Limit values

[yellow]
Child of [Limits]
Tree Structure Type Element
Native Datatype R4
Access Rights Read and write

[red]
Child of [Limits]
Tree Structure Type Element
Native Datatype R4
Access Rights Read and write

[Teach]
Child of [Parameter] > [Objects] > [Object1...24]
Tree Structure Type Node

19
OPC Server Software for efector octavis VSExxx

[teachValue]
Child of [Teach]
Tree Structure Type Element
Native Datatype R4
Access Rights Read and write

The values are written in the OPC Cache.

After the implementation of [writeTeach] the set values are transferred to the VSE.

[doTeach]
Child of [teachValue]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read and write

Ás soon as the Teach function has been started the Quality of [teachValue] changes to „Uncertain“. After su-
cessfull completion it changes back to „Good“.

[readTeach]
Child of [teachValue]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read and write

Active sampling of the VSE [teachValue].

[writeTeach]
Child of [teachValue]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read and write

Transfers the [teachValue] (Cache) to the VSE.

[name]
Child of [Parameter] > [Objects] > [Object1...24]
Tree Structure Type Element
Native Datatype BSTR
Access Rights Read and write

[sensorId]
Child of [Parameter] > [Objects] > [Object1...24]
Tree Structure Type Element
Native Datatype UI2
Access Rights Read and write

Sensor allocation begins with „0“ for Sensor 1.

[rpmId]
Child of [Parameter] > [Objects] > [Object1...24]
Tree Structure Type Element
Native Datatype UI2
Access Rights Read

Speed object allocation.

20
 OPC Server Software for efector octavis VSExxx

Each object refers to a speed object. To save resources several objects can refer to the same speed object.
Any changes made to the speed object are also made for the linked objects.
Tip: Using the VES003 to set parameters it is possible to enforce different speed objects which can be given
different speeds (e.g. 3500 for the first and 3501 for the second object).

[RPM-Objects]
Child of [Parameter]
Tree Structure Type Node

Only the speed objects which have been programmed are shown (max. 24).
UK
[RPM-Object1...24]
Child of [RPM-Objects]
Tree Structure Type Node

[rpmValue]
Child of [RPM-Object1...24]
Tree Structure Type Element
Native Datatype R4
Access Rights Read and write

The item [rpmValue] can be changed if the speed object is of type „constant speed“ or „speed via bus“. The
changes made to [rpmValue] can have an effect on other objects, → [rpmId].

[Read]
Child of [rpmValue]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read and write

Automatic update.

[write]
Child of [rpmValue]
Tree Structure Type Property
Native Datatype BOOL
Access Rights Read and write

Transfers the „new“ [rpmValue] from the Cache to the VSE.

[unit]
Child of [RPM-Object1...24]
Tree Structure Type Property
Native Datatype BSTR
Access Rights Read

Speed object unit. Default is RPM, i.e. speed.

21