VSE OPC UA Server VOS050: Software Manual

Download as pdf or txt
Download as pdf or txt
You are on page 1of 39

Software manual

GB
VSE OPC UA server
VOS050
V1.1.0 or higher
11420264 / 01 05 / 2022
VOS050

Contents
1 Preliminary note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.1 Legal and copyright information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Open source information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.3 Legal notice OPC Foundation SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.4 Purpose of the document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.5 Symbols used . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2 Safety instructions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3 Intended use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
4 Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.1 Supported VSE firmware versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2 OPC UA security settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.1 Supported security guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.2.2 Deactivated security guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
5 VSE OPC UA Server Configurator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.1 Signing in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.2 Logout. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
5.3 Server status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.3.1 Displaying the server status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.3.2 Starting/stopping the server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
5.4 Data sources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.4.1 Adding a device / data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
5.4.2 Deleting a data source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5.4.3 Filtering the data source list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5.4.4 Displaying the status of a data source. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5.5 OPC UA server settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.5.1 Configuring server address settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.5.2 Setting the client access and subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.5.3 Setting VSE device communication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.5.4 Setting VSE device monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.5.4.1 Values for cyclic value calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.5.5 Showing authentication and security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
5.6 Log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5.6.1 Setting the log level. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5.6.2 Setting the storage location and the log file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5.7 User administration / authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.7.1 Changing the password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.7.1.1 Password requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
5.8 Licence management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.8.1 Online licence activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.8.2 Offline licence activation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
5.9 Setting the language: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
6 Address model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6.1 Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
6.2 Data Access Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
6.3 Status codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
6.3.1 DeviceXX > Information > ... (1/1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
6.3.2 DeviceXX > Documentation > ... (1/1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
6.3.3 DeviceXX > Objects > ObjectXX > ... (1/5) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
6.3.4 DeviceXX > Objects > ObjectXX > ... (2/5) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6.3.5 DeviceXX > Objects > ObjectXX > ... (3/5) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
6.3.6 DeviceXX > Objects > ObjectXX > ... (4/5) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.3.7 DeviceXX > Objects > ObjectXX > ... (5/5) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6.3.8 DeviceXX > Counters > CounterXX > ... (1/2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.3.9 DeviceXX > Counters > CounterXX > ... (2/2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.3.10 DeviceXX > Alarms > Analogue > AlarmXX > ... (1/2) . . . . . . . . . . . . . . . . . . . . . . . . 33
6.3.11 DeviceXX > Alarms > Analogue > AlarmXX > ... (2/2) . . . . . . . . . . . . . . . . . . . . . . . . 34
6.3.12 DeviceXX > Alarms > AlarmXX > ... (1/2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

2
VOS050

6.3.13 DeviceXX > Alarms > AlarmXX > ... (2/2) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36


6.4 Enum types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.4.1 CounterTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.4.2 CounterStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.4.3 DeviceTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
6.4.4 DigitalAlarmTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.4.5 InputTypeEnum. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.4.6 ObjectTypeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
6.4.7 ObjectStateEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
6.4.8 SystemModeEnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

3
VOS050

1 Preliminary note

1.1 Legal and copyright information


© All rights reserved by ifm electronic gmbh. No part of these instructions may be reproduced and
used without the consent of ifm electronic gmbh.
All product names, pictures, companies or other brands used are the property of the respective rights
owners.
• Microsoft® is the property of Microsoft Corporation, USA
• Windows® is the property of Microsoft Corporation, USA
• Linux® is the registered trademark of Linus Torvalds in the USA and in other countries.
• Debian is a registered trademark of Software in the Public Interest, Inc., USA

1.2 Open source information


This product can contain Free Software or Open Source Software from various software developers
which is subject to the following licenses: General Public License version 1, version 2 and version 3
(General Public License version 3 in conjunction with the GNU Compiler Collection Runtime Library
Exception version 3.1), Lesser General Public License version 2.1, Lesser General Public License
version 3, Berkeley Software Distribution (BSD-2-Clause, BSD-3-Clause, BSD-4-Clause), MIT-License
(MIT), Python Software Foundation License 2.0, Pearl Artistic License and Artistic License 2.0,
Microsoft Public License, Apache Software License Version 1.0, 1.1 und 2.0, ISC License, libpng
License, zlib Licence, the Academic Free License version 2.1. For the components subject to the
General Public License in their respective versions the following applies:
This program is free software: you can redistribute it and/or modify it under the terms of the GNU
General Public License as published by the Free Software Foundation. If version 1 applies to the
software: either version 1 of the License or (at your option) any later version; if version 2 (or 2.1)
applies to the software: either version 2 (or 2.1) of the License or (at your option) any later version; if
version 3 applies to the software: either version 3 of the License or (at your option) any later version.
The following disclaimer of the software developers applies to the software components that are
subject to the General Public License or the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License and the GNU Lesser General
Public License for more details.
The responsibility of ifm electronic gmbh for ifm products, in the case of product-specific software,
remains unaffected by the above disclaimer. Please note that the firmware for the ifm products is in
some cases provided free of charge.
The price of the ifm products has then to be paid for the respective device itself (hardware) and not for
the firmware. For the latest information on the license agreement for your product please visit
www.ifm.com
For binaries that are licensed under any version of the GNU General Public License (GPL) or the GNU
LGPL you may obtain the complete corresponding source code of the GPL software from us by
sending a written request to: [email protected] or to ifm electronic gmbh, Friedrichstraße 1, 45128
Essen, Germany.
We charge €30 for each request. Please write “source for product Y” in the memo line of your
payment. Your request should include (i) the name of the covered binary, (ii) the name and the version
number of the ifm product, (iii) your name and (iv) your return address.
This offer is valid to anyone in receipt of this information. This offer is valid for at least three years
(from the date you received the GPL/LGPL covered code).

4
VOS050

1.3 Legal notice OPC Foundation SDK


This product includes software under the OPC Redistributables Agreement of Use of the OPC
Foundation in the version current at the time of order.

1.4 Purpose of the document


This software manual describes the VSE OPC UA Server and the VSE OPC UA Server Configurator.
u For better understanding, use this manual along with the opened software.

1.5 Symbols used


ü Condition
u Instruction
w Interim result, interim reaction
w Final result, reaction
[…] Designation of keys, buttons or indications
Ò See link, cross-reference

Important note
Non-compliance may result in malfunction or interference

Information
Supplementary note

5
VOS050

2 Safety instructions
• Read this document before setting up the product and keep it during the entire service life.
• The product must be suitable for the corresponding applications without any restrictions.
• Only use the product for its intended purpose (Ò Intended use).
• If the operating instructions or the technical data are not adhered to, personal injury and/or damage
to property may occur.
• The manufacturer assumes no liability or warranty for any consequences caused by tampering with
the product or incorrect use by the operator.

6
VOS050

3 Intended use
The VSE OPC UA Server provides data values of the integrated ifm VSE diagnostic electronics via the
OPC UA interface for further processing on an OPC UA client (not included in the scope of delivery).
The VSE OPC UA Server Configurator software is used by the user to maintain and configure the VSE
OPC UA Server.

7
VOS050

4 Function
The VSE OPC UA Server Configurator allows the user to perform basic maintenance tasks for the
VSE OPC UA Server, e.g.:
• Starting or stopping the VSE OPC UA Server
• Managing data sources (VSE diagnostic electronics)
• Setting the network configuration and host name of the VSE OPC UA Server
• Setting Client Connections and Subscriptions
• Setting the connection and monitoring of the VSE diagnostic electronics
• Log file configuration
• User management
• Licence management

4.1 Supported VSE firmware versions


The program supports the following VSE firmware versions:
• 0.6.11
• 0.7.x
• 0.11.x
• 0.13.x
• 2.0.x

4.2 OPC UA security settings

4.2.1 Supported security guidelines


The OPC UA server supports all security guidelines and message modes recommended by the OPC
UA Foundation:
• Basic256Sha256 (Sign; Sign&Encrypt)
• Aes128Sha256RsaOaep (Sign; Sign&Encrypt)
• Aes256Sha256RsaPss (Sign; Sign&Encrypt)

4.2.2 Deactivated security guidelines


The following security guidelines are deactivated by default because they are no longer state of the art
and are therefore classified as insecure:
• None (None)
• Basic128Rsa15 (Sign; Sign&Encrypt)
• Basic256 (Sign; Sign&Encrypt)
We are thus following the recommendation of the OPC UA Foundation to no longer offer these
security guidelines in order to ensure the security of the product.

8
VOS050

5 VSE OPC UA Server Configurator

5.1 Signing in
ü Use a recommended browser: Google Chrome, Mozilla Firefox or Microsoft Edge.
u Call the URL of the VSE OPC UA Server Configurator in the browser:
https://<IP or Hostname>:<Configurator-Port>/
Default: https://localhost:44350/
w The login screen will be displayed.
u Log in with the login data assigned during installation.

If an incorrect password to an existing user is entered 3 times, the login for this user will be
blocked for 10 minutes.

w The Configurator interface appears.

5.2 Logout
u Click on  to leave the Configurator.
w The login screen will be displayed.

9
VOS050

5.3 Server status

5.3.1 Displaying the server status


The server status is displayed in the menu bar next to the menu [Server status].
Or:
u Open the menu [Server status].
w The server status is displayed:

Status Colour Description


[Running] Green The server is running.
[Stopped] Red The server is stopped.
[Stop pending] Grey The server will be stopped.
[Start pending] Grey The server will be started.

5.3.2 Starting/stopping the server


u Open the menu [Server status].
u If the server is not running: Click on [Start server] to start the server.
Or:
If the server is running: Click on [Stop server] to stop the server.

10
VOS050

5.4 Data sources


In the section [Datasources], the data sources and their properties are displayed in tabular form.

5.4.1 Adding a device / data source


u Under [Datasources], click on  [Device].
w The dialogue window [Add VSE device] appears.
u Select the option [Scan network] to seach for all available devices in the network.
u Click on [Scan].
w The program searches for available devices.
w The table shows all detected devices.

The option [Scan network] searches for all available devices via broadcast. Not all available
devices in a network environment may be detected, e.g. due to network segmentation, use of
firewalls or routers.
ü If not all devices are found:
u Add all devices with the help of the options [Specific] or [Range], see below.

OR
u Select the option [Specific] and enter the IP address and port of a device.
u Click on [Add to list].
w The program adds the devices to the table.

Only after the device has been added to the view [Datasources] and the server has been
restarted, the program will check whether the device exists in the network.

OR
u Select the option [Range] and enter the start and end address of an IP range and the port.
u Click on [Add to list].
w The program will add all devices of the IP range to the table.

Only after the device has been added to the view [Datasources] and the server has been
restarted, the program will check whether the device exists in the network.

ü Devices are listed in the table.


u Activate the devices in the table that are to be included in the view [Datasources] .
u Deactivate the devices in the table that are not to be included in the view [Datasources] .
u Click on [Add devices] to include the selected devices in the view [Datasources] .
w The view [Datasources] shows all added devices.
w The view [Datasources] shows the available functions (column [Actions]).
u Click on [Upload changes] to upload the changes to the server. For the changes to take effect,
restart the server in the [Server status] area.
OR
u Click on [Upload and Restart] to upload the changes to the server and restart the server.
OR
u Click on [Reset changes] to discard the changes.

11
VOS050

u Optional: Filtering the data source list (Ò / 12)

5.4.2 Deleting a data source


u Under [Datasources] in the row of the data souce in the column [Actions], click on .
w The data source will be deleted from the table.
u Click on [Upload changes] to upload the changes to the server. For the changes to take effect,
restart the server in the [Server status] area.
OR
u Click on [Upload and Restart] to upload the changes to the server and restart the server.
OR
u Click on [Reset changes] to discard the changes.

5.4.3 Filtering the data source list


u Under [Datasources], enter the filter text for the name of the data source in the input field .
w The table only shows data sources whose names (column [Name]) contain the filter text.

5.4.4 Displaying the status of a data source


Under [Datasources], the status of the data source will be displayed in the row of a data source in the
column [Status] .

Status Colour Description


[Connected] green The data source is connected and avail-
able to the program.
[Timeout] red The data source was connected and is
currently not available for the program.
[Pending] grey The data source was not yet connected
and is currently not available for the pro-
gram.
This state is only reached if the data
source has been added and the server
has not yet been restarted. (No initial
connection was established between
server and data source)

12
VOS050

5.5 OPC UA server settings

5.5.1 Configuring server address settings


u Under [OPC UA - Server settings] in the [Server address settings] tab, configure the server address
settings.
The OPC UA server address(URL) consists of:
[Transport protocol]://[Server]:[Port]/[Suffix]

Input field / display field Description


[Transport protocol] Communication protocol for connecting to the OPC UA serv-
er. (Display only)
[Server ports] The port for connections with the OPC UA server.
Value range: 1…65535
Default value: 32210
u Ensure that the configured port is accessible for OPC UA
clients in the network.
[URL suffix] The suffix of the OPC UA server address. (Display only)
[Server address] The complete OPC UA server address. (Display only)

5.5.2 Setting the client access and subscriptions


u Under [OPC UA - Server settings], in the [Clients & subscriptions] tab, configure the settings for
client connections and subscriptions.

Input box Description Possible values


[Maximum clients count] Maximum number of OPC UA clients 1…100
that can connect to the server simultane-
ously.
[Maximum subscriptions count] Maximum number of OPC UA client sub- 1…300
scriptions that the server supports simul-
taneously.

5.5.3 Setting VSE device communication


u Under [OPC UA - Server settings], in the [Device connection] tab, configure the settings for
connections to VSE devices.

Input box Description Possible values


[Timeout] Maximum response time for connected 10...300 000 [milliseconds]
VSE devices. If the response time is ex-
ceeded, the associated nodes of the de-
vice are set to the status BadNoCommu-
nication .
[Connection retry] Setting for reconnecting to a VSE device Default setting Forever :
after connection failure. The server attempts to permanently re-
store the failed connection to a VSE de-
vice.

13
VOS050

5.5.4 Setting VSE device monitoring


u Under [OPC UA - Server settings] in the [Device monitoring] tab, configure the settings for the
monitoring of the VSE devices.

Input box Description Possible values


[Cyclic value computation] All VSE object monitoring values are re- • [On]:
corded cyclically during the specified [Cyclic value computation] activated
time period. • [Off]:
For each cycle, depending on the VSE [Cyclic value computation]
object type, there will then be a resulting deactivated
value or a combination of the resulting
max., min. and/or average values.
[Cycle time] Duration for object monitoring 100...10 000 [milliseconds]

5.5.4.1 Values for cyclic value calculation


The table indicates which value is to be expected depending on the object type if cyclic value
calculation is activated.

Object type Calculation item Value Calculation item Maximum


Unbalance mean value maximum
Bearing mean value maximum
A_RMS_FD mean value maximum
V_RMS_FD mean value maximum
D_RMS_FD mean value maximum
A_RMS_TD mean value maximum
V_RMS_TD mean value maximum
Other mean value maximum
A_PEAK_TD maximum not available
UpperMonitor maximum not available
LowerMonitor minimum not available

5.5.5 Showing authentication and security


At [OPC UA - Server settings] in the [Security] tab, the settings for authentication and security are
displayed.

Display Description Possible values


[Authentication] Setting how the OPC UA clients can au- Default value Anonymous :
thenticate themselves to the server. No restrictions for the connection to the
OPC UA server
[Transport security] The type of transport security used with Default value: Certificate:
OPC UA client-server communication. The server generates a self-signed (non-
CA) certificate for signing and encrypting
messages via the TLS protocol.

14
VOS050

5.6 Log file


The log file settings can be configured in the [Log file] section.

5.6.1 Setting the log level


The log level indicates the scope of the events to be logged.
u Select the required log level in the [Log level] list.

[Log level] Description


[Error] Only error messages will be logged.
[Warning] Warning messages and error messages will be logged.
[Information] Information, warning messages and error messages will be
logged.
[Debug] Debug messages, information, warning messages and error
messages will be logged.

5.6.2 Setting the storage location and the log file


u Go to [Log level and location] and configure the log file settings in the [File logging] section.

Input box Description Possible values


[Storage path of log files] File path for the log files of the OPC UA e.g. C:\LogFile
server
[Max log file count] Maximum number of log files. If the 1…50
number is exceeded, the oldest log file
will be overwritten.
[Max log file size] Maximum file size of a log file in MB. 1…50 [MB]

15
VOS050

5.7 User administration / authentication


The users are displayed and managed in the [User settings / authentication] area.

5.7.1 Changing the password


u Under [User settings / authentication] in the user's row in the column [Actions], click on [Change
password].
w The view [Change password] appears.
u Enter the current password in the field [Enter current password].
u Enter the new password in the field [Enter new password].
u Enter the new password again in the field [Confirm new password].
u Click on [Change & login].
w The password will be changed.
w If required: Log in with the new password.

5.7.1.1 Password requirements


• Minimum length: 8 characters
• Must contain:
– at least one upper case letter
– at least one lower case letter
– At least one number
– At least one special character

16
VOS050

5.8 Licence management


The installed licences are displayed in the [Licences] area.
New licences can be added.

5.8.1 Online licence activation


u Under [Licences], click on [Add licence].
u Select [Online activation].
u Click on [Next].
u Enter the licence activation code (LAC) received via email.
u Click on [Next].
w All activated licences are displayed.

5.8.2 Offline licence activation


If no online activation is possible because there is no Internet connection, licences can also be
activated offline.
u Under [Licences], click on [Add licence].
u Select [Offline activation].
u Click on [Next].
u Make a note of the displayed fingerprint.
OR
click on [Save as .txt file], select the required directory and save fingerprint.txt.
u Open the page https://licensing.ifm.com on a computer with an online connection, click on [Activate
licence], follow the instructions of this page and copy the generated licence key.
u Continue licensing in the program:
Click on [Next].
u Enter the licence key you received.
u Click on [Next].
u Click on [Done].
w All activated licences are displayed.

17
VOS050

5.9 Setting the language:


u Go to [Language] and select the required interface language.

18
VOS050

6 Address model
6.1 Overview ................................................................................................................................ 20
6.2 Data Access Options.............................................................................................................. 23
6.3 Status codes .......................................................................................................................... 24
6.3.1 DeviceXX > Information > ... (1/1).......................................................................................... 24
6.3.2 DeviceXX > Documentation > ... (1/1).................................................................................... 25
6.3.3 DeviceXX > Objects > ObjectXX > ... (1/5) ............................................................................ 26
6.3.4 DeviceXX > Objects > ObjectXX > ... (2/5) ............................................................................ 27
6.3.5 DeviceXX > Objects > ObjectXX > ... (3/5) ............................................................................ 28
6.3.6 DeviceXX > Objects > ObjectXX > ... (4/5) ............................................................................ 29
6.3.7 DeviceXX > Objects > ObjectXX > ... (5/5) ............................................................................ 30
6.3.8 DeviceXX > Counters > CounterXX > ... (1/2)........................................................................ 31
6.3.9 DeviceXX > Counters > CounterXX > ... (2/2)........................................................................ 32
6.3.10 DeviceXX > Alarms > Analogue > AlarmXX > ... (1/2) ........................................................... 33
6.3.11 DeviceXX > Alarms > Analogue > AlarmXX > ... (2/2) ........................................................... 34
6.3.12 DeviceXX > Alarms > AlarmXX > ... (1/2) .............................................................................. 35
6.3.13 DeviceXX > Alarms > AlarmXX > ... (2/2) .............................................................................. 36
6.4 Enum types ............................................................................................................................ 37
6.4.1 CounterTypeEnum ................................................................................................................. 37
6.4.2 CounterStateEnum................................................................................................................. 37
6.4.3 DeviceTypeEnum................................................................................................................... 37
6.4.4 DigitalAlarmTypeEnum .......................................................................................................... 38
6.4.5 InputTypeEnum...................................................................................................................... 38
6.4.6 ObjectTypeEnum ................................................................................................................... 38
6.4.7 ObjectStateEnum ................................................................................................................... 39
6.4.8 SystemModeEnum................................................................................................................. 39

19
VOS050

6.1 Overview
The following table shows the objects of the VSE OPC UA server.
Information on the status codes can be found in this chapter: Status codes (Ò / 24)
Information on the Data Access Options can be found in this chapter: Data Access Options (Ò / 23)

Requires
Node class Data type
Address / name Data type ifm VSE Description Access sub-
OPC UA OPC UA
scription
ifm Object FolderType IfmType r
System Object FolderType SystemType r
Version Object FolderType VersionType r
Driver Property String e.g. "V1.1.0.0" r

VSE Object FolderType VSE r


Device01... Object FolderType VSEDeviceType e.g. Engine_No4 r
DeviceXX
Information Object FolderType DeviceInformation- r
Type
Device Object FolderType DeviceBaseInfoType r
Name Property String e.g. "Fantastic Pump” r
Type Property Enumeration DeviceTypeEnum e.g. VSE100 r
(Ò / 37)
Revision Property String e.g. "AA (Board rev. r
8)"
Serial Property String e.g. "1 1 123456" r
Firmware Property String e.g. "V0.11.12" r
State Object FolderType DeviceStateType r
SystemMode DataVariable Enumeration SystemModeEnum e.g. Measure r
(Ò / 39)
ActiveVariant DataVariable Int32 e.g. 5 r
IP Object FolderType DeviceAddressType r
Hostname Property String e.g. "Machine5" r
DHCP Property Boolean e.g. false r
Address Property String e.g. "72.123.124.2" r
Port Property Int32 65100 r
Gateway Property String "72.123.124.1" r
SubnetMask Property String "72.255.255.255" r
MacAddress Property String "AA:BB:CC:DD:EE:F r
F"
Documentation Object FolderType DeviceDocumenta- r
tionType
Company Property String e.g. "ifm diagnostic" r
Address Property String e.g. "Aicher Str. 1A" r
City Property String e.g. "Rosenheim” r
Location Property String e.g. "First Floor” r
Machine Property String e.g. "MonsterFantas- r
tic"
CreatedBy Property String e.g. "John" r
CreationDate Property DateTime e.g. "2020-04-27 r
08:10:45"

20
VOS050

Requires
Node class Data type
Address / name Data type ifm VSE Description Access sub-
OPC UA OPC UA
scription
LastChange Property DateTime e.g. "2020-04-27 r
08:10:45"
Description Property String Description r
Objects Object FolderType ObjectsType r
Object01… Object FolderType ObjectParameter- r
Object24 Type
Name Property String e.g. "SE01_Unbal- r
ance_01"
Type Property Enumeration ObjectTypeEnum e.g. Unbalance r
(Ò / 38)
ID Property Int32 Objekt-ID, ≥ 1 r
Unit Property String S.I. unit r
e.g. "m / s"
Warning DataVariable Float e.g. 1.23 rw
Damage DataVariable Float e.g. 4.11 rw
Baseline DataVariable Float e.g. 4.11 r
InputID Property Int32 Input ID r
e.g. 1
InputType Property Enumeration InputTypeEnum Input type r
(Ò / 38) e.g. Dynamic
RotValueID Property Int32 ID of the assigned r
RPM object
e.g. 1
RefValueID Property Int32 ID of the assigned r
RPM reference ob-
ject
e.g. 2
Value DataVariable Float e.g. 3.14 yes
RotSpeed DataVariable Float e.g. 5.46 r yes
Maximum DataVariable Float e.g. 6.28 r yes
RefValue DataVariable Float e.g. 6.78 r yes
State DataVariable Enumeration ObjectStateEnum OK r yes
(Ò / 39)
Error DataVariable String e.g. "Speed not sta- r yes
ble”
Counters Object Folder CountersType r
Counter01... Object Folder CounterParameter- r
Counter32 Type
Name Property String e.g. "OB01_Object- r
State_01"
Type Property Enumeration CounterTypeEnum ObjectState r
(Ò / 37)
ID Property Int32 1 r
Unit Property String "s"(time) / "A_String" r
(totaliser)
Limit Property Float 3600.5 (time) / 100.0 r
(totaliser)
Value DataVariable Float 3.14 r yes
State DataVariable Enumeration CounterStateEnum Normal/LimitExceed- r yes
(Ò / 37) ed

21
VOS050

Requires
Node class Data type
Address / name Data type ifm VSE Description Access sub-
OPC UA OPC UA
scription
Alarms Object Folder AlarmsType r
Analogue Object Folder AnalogueAlarm- r
sType
Alarm01 Object Folder AnalogueAlarmPa- r
rameterType
Name Property String "OU01_Ana- r
logue_01"
ID Property Int32 1 r
Unit Property String "km/h" r
Value DataVariable Float 3.14 r yes
Alarm01… Object Folder DigitalAlarmParame- r
Alarm10 terType
Name Property String "OU01_Ana- r
logue_01"
Type Property Enumeration DigitalAlarmTypeE- Damage r
num (Ò / 38)
ID Property Int32 1 r
Value DataVariable Boolean true r yes

Legend:
r = read access only
rw = read access and write access

22
VOS050

6.2 Data Access Options


The elements marked with “yes” in the “Requires subscription” column in the overview only provide
current VSE device data if they have been subscribed to.
Simple reading from an OPC client is still possible at any time, yet only the last available data for the
specified node is retrieved - i.e. it is the current value.

u Observe the detailed descriptions of the status codes Good, UncertainLastUsableValue and
BadWaitingForInitialData for the OPC nodes. (Ò Status codes / 24)

23
VOS050

6.3 Status codes


The detailed OPC status codes apply to states in which a connection to the server has been
established.
Other states, such as BadCommunicationError , fall back on the standard behaviour of the OPC UA
client implementation.

6.3.1 DeviceXX > Information > ... (1/1)


• DeviceXX > Information > Device > Name
• DeviceXX > Information > Device > Type
• DeviceXX > Information > Device > Revision
• DeviceXX > Information > Device > Serial
• DeviceXX > Information > Device > Firmware
• DeviceXX > Information > State > SystemMode
• DeviceXX > Information > State > ActiveVariant
• DeviceXX > Information > IP > Hostname
• DeviceXX > Information > IP > DHCP
• DeviceXX > Information > IP > Address
• DeviceXX > Information > IP > Port
• DeviceXX > Information > IP > Gateway
• DeviceXX > Information > IP > SubnetMask
• DeviceXX > Information > IP > MacAddress
The following status codes apply to the named nodes:

Status code Description


Good The connection to the device is okay.
The property value was set accordingly.
BadWaitingForInitialData The connection to the device was established.
The value of the property has not yet been set.
BadNoCommunication No connection to the device.
The connection was interrupted or not established.

24
VOS050

6.3.2 DeviceXX > Documentation > ... (1/1)


• DeviceXX > Documentation > Company
• DeviceXX > Documentation > Address
• DeviceXX > Documentation > City
• DeviceXX > Documentation > Location
• DeviceXX > Documentation > Machine
• DeviceXX > Documentation > CreatedBy
• DeviceXX > Documentation > CreationDate
• DeviceXX > Documentation > LastChange
• DeviceXX > Documentation > Description
The following status codes apply to the named nodes:

Status code Description


Good The connection to the device is okay.
The property value was set accordingly.
BadWaitingForInitialData The connection to the device was established.
The value of the property has not yet been set.
BadNoCommunication No connection to the device.
The connection was interrupted or not established.

25
VOS050

6.3.3 DeviceXX > Objects > ObjectXX > ... (1/5)


• DeviceXX > Objects > ObjectXX > Name
• DeviceXX > Objects > ObjectXX > Type
• DeviceXX > Objects > ObjectXX > ID
• DeviceXX > Objects > ObjectXX > Unit
• DeviceXX > Objects > ObjectXX > Warning
• DeviceXX > Objects > ObjectXX > Damage
• DeviceXX > Objects > ObjectXX > Baseline
• DeviceXX > Objects > ObjectXX > InputID
• DeviceXX > Objects > ObjectXX > InputType
• DeviceXX > Objects > ObjectXX > RotValueID
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID '1' is configured on the VSE device.
• The value of the property/data variable has been set.
BadWaitingForInitialData The connection with the device was established
The value of the property was not set.
This status is only displayed for a very short time after the connection with the device
has been established, until the value of the property / data variable has been initialised /
set.
BadResourceUnavailable The connection to the device is okay.
The object with e.g. ID '1' is not configured/parameterised on the VSE device.
BadNoCommunication No connection to the device.
The connection was interrupted or not established.

26
VOS050

6.3.4 DeviceXX > Objects > ObjectXX > ... (2/5)


• DeviceXX > Objects > ObjectXX > RefValueID
The following status codes apply to the named node:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID '1' is configured on the VSE device.
The value of the property/data variable has been set.
BadWaitingForInitialData The connection with the device was established
The value of the property was not set.
This status is only displayed for a very short time after the connection with the device
has been established, until the value of the property / data variable has been initialised /
set.
BadResourceUnavailable The connection to the device is okay.
The object with e.g. ID '1' is configured on the VSE device, but no reference value RPM
object is configured.
BadNoCommunication No connection to the device.
The connection was interrupted or not established.

27
VOS050

6.3.5 DeviceXX > Objects > ObjectXX > ... (3/5)


• DeviceXX > Objects > ObjectXX > Value
• DeviceXX > Objects > ObjectXX > RotSpeed
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• An OPC subscription is active for this data variable.
• The value of the data variable was set accordingly (see BadWaitingForInitialData).
• The VSE device is in system mode Supervise or Selftest .
• The object is active in the current variant.
UncertainLastUsableValue All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• The data variable has received at least one Good value from the device.
AND
at least one of the following conditions is met:
• The device is in system mode Measure or Setup .
• The object is not active in the current variant, but was previously active in another
variant and has provided values.
• An error occurred during the ObjectResult calculation.
• An OPC subscription for this data variable existed and was deleted.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• No OPC subscription is or was active for this data variable. (No object monitoring
data was ever received by the OPC server.)
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.
BadResourceUnavailable One of the following conditions is met:
• The object with e.g. ID ‘1’ is not configured on the VSE device.
• The object with e.g. ID '1’ is in the state MonitoringDisabled because it is a fast
measuring cycle object (only time domain objects with a measurement time of <
10.24 ms).

28
VOS050

6.3.6 DeviceXX > Objects > ObjectXX > ... (4/5)


• DeviceXX > Objects > ObjectXX > Maximum
The following status codes apply to the named node:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• An OPC subscription is active for this data variable.
• The value of the data variable was set accordingly (see BadWaitingForInitialData).
• The VSE device is in system mode Supervise or Selftest .
• The object is active in the current variant.
UncertainLastUsableValue All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• The data variable has received at least one Good value from the device.
AND
at least one of the following conditions is met:
• The device is in system mode Measure or Setup .
• The object is not active in the current variant, but was previously active in another
variant and has provided values.
• An error occurred during the ObjectResult calculation.
• An OPC subscription for this data variable existed and was deleted.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• No OPC subscription is or was active for this data variable. (No object monitoring
data was ever received by the OPC server.)
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.
BadResourceUnavailable The connection to the device is okay.
AND
One of the following conditions is met:
• The object with e.g. ID ‘1’ is not configured on the VSE device.
• The object with e.g. ID ‘1’ is in the state MonitoringDisabled because it is a fast
measuring cycle object (Only time domain objects with a measurement time of <
10.24 ms).
• The object with e.g. ID ‘1’ is configured on the VSE device, but the object does not
support maximum value calculation or the monitoring of maximum value calculation is
deactivated (CyclicComputation is deactivated).
The following objects do not support maximum value calculation:
– A_PEAK_TD (Acceleration Peak Time Domain)
– Lower Limit Monitor
– Upper Limit Monitor

29
VOS050

6.3.7 DeviceXX > Objects > ObjectXX > ... (5/5)


• DeviceXX > Objects > ObjectXX > State
• DeviceXX > Objects > ObjectXX > Error
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• An OPC subscription is active for this data variable.
• The value of the data variable was set accordingly (see BadWaitingForInitialData).
UncertainLastUsableValue All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• The data variable has received at least one Good value from the device.
• An OPC subscription for this data variable existed and was deleted.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device is okay.
• The object with e.g. ID ‘1’ is configured on the VSE device.
• No OPC subscription is or was active for this data variable. (No object monitoring
data was ever received by the OPC server.)
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.
BadResourceUnavailable • The object with e.g. ID ‘1’ is not configured on the VSE device.

30
VOS050

6.3.8 DeviceXX > Counters > CounterXX > ... (1/2)


• DeviceXX > Counters > CounterXX > Name
• DeviceXX > Counters > CounterXX > Type
• DeviceXX > Counters > CounterXX > ID
• DeviceXX > Counters > CounterXX > Unit
• DeviceXX > Counters > CounterXX > Limit
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The counter with e.g. ID ‘1’ is configured on the VSE device.
• The value of the property/data variable has been set.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device was established.
• The value of the property was not set.
• This status is only displayed for a very short time after the connection to the device
has been established, until the value of the property/data variable has been
initialised/set.
BadResourceUnavailable All of the following conditions are met:
• The connection to the device is okay.
• The counter with e.g. ID ‘1’ is not configured on the VSE device.
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.

31
VOS050

6.3.9 DeviceXX > Counters > CounterXX > ... (2/2)


• DeviceXX > Counters > CounterXX > Value
• DeviceXX > Counters > CounterXX > State
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The counter with e.g. ID ‘1’ is configured on the VSE device.
• An OPC subscription is active for this data variable.
• The value of the data variable was set accordingly (see BadWaitingForInitialData).
• The VSE device is in system mode Supervise or Selftest .
UncertainLastUsableValue All of the following conditions are met:
• The connection to the device is okay.
• The counter with e.g. ID ‘1’ is configured on the VSE device.
• The data variable has received at least one Good value from the device.
AND
at least one of the following conditions is met:
• The device is in system mode Measure or Setup .
• An OPC subscription for this data variable existed and was deleted.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device is okay.
• The counter with e.g. ID ‘1’ is configured on the VSE device.
• No OPC subscription is or was active for this data variable. (No object monitoring
data was ever received by the OPC server.)
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.
BadResourceUnavailable The following condition is met:
• The counter with e.g. ID ‘1’ is not configured on the VSE device.

32
VOS050

6.3.10 DeviceXX > Alarms > Analogue > AlarmXX > ... (1/2)
• DeviceXX > Alarms > Analogue > AlarmXX > Name
• DeviceXX > Alarms > Analogue > AlarmXX > Type
• DeviceXX > Alarms > Analogue > AlarmXX > ID
• DeviceXX > Alarms > Analogue > AlarmXX > Unit
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is configured on the VSE device.
• The value of the property/data variable has been set.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device was established.
• The value of the property was not set.
This status is only displayed for a very short time after the connection to the device has
been established, until the value of the property/data variable has been initialised/set.
BadResourceUnavailable All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is not configured on the VSE device.
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.

33
VOS050

6.3.11 DeviceXX > Alarms > Analogue > AlarmXX > ... (2/2)
• DeviceXX > Alarms > Analogue > AlarmXX > Value
The following status codes apply to the named node:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The analogue alarm is configured on the VSE device.
• An OPC subscription is active for this data variable.
• The value of the data variable was set accordingly (see BadWaitingForInitialData).
• The VSE device is in system mode Supervise or Selftest .
UncertainLastUsableValue All of the following conditions are met:
• The connection to the device is okay.
• The analogue alarm is configured on the VSE device.
• The data variable has received at least one Good value from the device.
AND
at least one of the following conditions is met:
• The device is in system mode Measure or Setup .
• An OPC subscription for this data variable existed and was deleted.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device is okay.
• The analogue alarm is configured on the VSE device.
• No OPC subscription is or was active for this data variable. (No alarm monitoring
data was ever received by the OPC server.)
BadNoCommunication No connection to the device.
The connection was interrupted or not established.
BadResourceUnavailable The analogue alarm is not configured on the VSE device

34
VOS050

6.3.12 DeviceXX > Alarms > AlarmXX > ... (1/2)


• DeviceXX > Alarms > AlarmXX > Name
• DeviceXX > Alarms > AlarmXX > Type
• DeviceXX > Alarms > AlarmXX > ID
The following status codes apply to the named nodes:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is configured on the VSE device as a digital alarm.
• The value of the property/data variable has been set.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device was established.
• The value of the property was not set.
This status is only displayed for a very short time after the connection to the device has
been established, until the value of the property/data variable has been initialised/set.
BadResourceUnavailable All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is not configured on the VSE device or the alarm is not a
digital alarm.
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.

35
VOS050

6.3.13 DeviceXX > Alarms > AlarmXX > ... (2/2)


• DeviceXX > Alarms > AlarmXX > Value
The following status codes apply to the named node:

Status code Description


Good All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is configured on the VSE device as a digital alarm.
• An OPC subscription is active for this data variable.
• The value of the data variable was set accordingly (see BadWaitingForInitialData).
• The VSE device is in system mode Supervise or Selftest .
UncertainLastUsableValue All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is configured on the VSE device as a digital alarm.
• The data variable has received at least one Good value from the device.
AND
at least one of the following conditions is met:
• The device is in system mode Measure .
• An OPC subscription for this data variable existed and was deleted.
BadWaitingForInitialData All of the following conditions are met:
• The connection to the device is okay.
• The alarm with e.g. ID ‘1’ is configured on the VSE device as a digital alarm.
• No OPC subscription is or was active for this data variable. (No object monitoring
data was ever received by the OPC server.)
BadNoCommunication All of the following conditions are met:
• No connection to the device.
• The connection was interrupted or not established.
BadResourceUnavailable The following condition is met:
• The alarm is not configured on the VSE device or the alarm is not a digital alarm.

36
VOS050

6.4 Enum types

6.4.1 CounterTypeEnum
Indicates the VSE device parameter counter type.

Name Value Displayed name


None 0 None
VSEUptime 1 VSEUptime
AnalogueRuntime 2 AnalogueRuntime
DigitalRuntime 3 DigitalRuntime
ObjectState 4 ObjectState
Totalisator 5 Totalisator
RESERVED_6 6
RESERVED_7 7
RESERVED_8 8
RESERVED_9 9

6.4.2 CounterStateEnum
Indicates the VSE device parameter counter state.

Name Value Displayed name


None 0 None
Normal 1 Normal
LimitExceeded 2 LimitExceeded
RESERVED_3 3
RESERVED_4 4

6.4.3 DeviceTypeEnum
Indicates the VSE device type.

Name Value Displayed name


None 0 None
VSE002 1 VSE002
VSE003 2 VSE003
VSE100 3 VSE100
VSE101 4 VSE101
VSE150 5 VSE150
VSE151 6 VSE151
VSE152 7 VSE152
VSE153 8 VSE153
VSE154 9 VSE154
RESERVED_10 10
RESERVED_11 11
RESERVED_12 12
RESERVED_13 13

37
VOS050

Name Value Displayed name


RESERVED_14 14
RESERVED_15 15
RESERVED_16 16
RESERVED_17 17
RESERVED_18 18
RESERVED_19 19

6.4.4 DigitalAlarmTypeEnum
Indicates the digital alarm type of the VSE device.

Name Value Displayed name


None 0 None
Warning 1 Warning
Damage 2 Damage
Counter 3 Counter
Selftest 4 Selftest
Custom 5 Custom
RESERVED_6 6
RESERVED_7 7
RESERVED_8 8
RESERVED_9 9

6.4.5 InputTypeEnum
Indicates the VSE device parameter input type.

Name Value Displayed name


None 0 None
Analogue 1 Analogue
Dynamic 2 Dynamic
External 3 External
Digital 4 Digital
RESERVED_5 5
RESERVED_6 6
RESERVED_7 7
RESERVED_8 8

6.4.6 ObjectTypeEnum
Indicates the VSE device parameter object type.

Name Value Displayed name


None 0 None
Unbalance 1 Unbalance
Bearing 2 Bearing
A_RMS_FD 3 A_RMS_FD

38
VOS050

Name Value Displayed name


V_RMS_FD 4 V_RMS_FD
D_RMS_FD 5 D_RMS_FD
A_RMS_TD 6 A_RMS_TD
V_RMS_TD 7 V_RMS_TD
A_PEAK_TD 8 A_PEAK_TD
UpperMonitor 9 UpperMonitor
LowerMonitor 10 LowerMonitor
Other 11 Other
RESERVED_12 12
RESERVED_13 13
RESERVED_14 14
RESERVED_15 15

6.4.7 ObjectStateEnum
Indicates the state of the object parameters of the VSE device.

Name Value Displayed name


None 0 None
OK 1 OK
Warning 2 Warning
Damage 3 Damage
Error 4 Error
InactiveByVariant 5 InactiveByVariant
MonitoringDisabled 6 MonitoringDisabled
RESERVED_7 7
RESERVED_8 8
RESERVED_9 9
RESERVED_10 10

6.4.8 SystemModeEnum
Indicates the system mode of the VSE device.

Name Value Displayed name


None 0 None
SelfTest 1 SelfTest
Supervise 2 Supervise
Setup 3 Setup
Measure 4 Measure
Startup 5 Startup
RESERVED_6 6
RESERVED_7 7

39

You might also like