VSE OPC UA Server VOS050: Software Manual
VSE OPC UA Server VOS050: Software Manual
VSE OPC UA Server VOS050: 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
3
VOS050
1 Preliminary note
4
VOS050
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
8
VOS050
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.
5.2 Logout
u Click on to leave the Configurator.
w The login screen will be displayed.
9
VOS050
10
VOS050
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.
11
VOS050
12
VOS050
13
VOS050
14
VOS050
15
VOS050
16
VOS050
17
VOS050
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
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
u Observe the detailed descriptions of the status codes Good, UncertainLastUsableValue and
BadWaitingForInitialData for the OPC nodes. (Ò Status codes / 24)
23
VOS050
24
VOS050
25
VOS050
26
VOS050
27
VOS050
28
VOS050
29
VOS050
30
VOS050
31
VOS050
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:
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:
34
VOS050
35
VOS050
36
VOS050
6.4.1 CounterTypeEnum
Indicates the VSE device parameter counter type.
6.4.2 CounterStateEnum
Indicates the VSE device parameter counter state.
6.4.3 DeviceTypeEnum
Indicates the VSE device type.
37
VOS050
6.4.4 DigitalAlarmTypeEnum
Indicates the digital alarm type of the VSE device.
6.4.5 InputTypeEnum
Indicates the VSE device parameter input type.
6.4.6 ObjectTypeEnum
Indicates the VSE device parameter object type.
38
VOS050
6.4.7 ObjectStateEnum
Indicates the state of the object parameters of the VSE device.
6.4.8 SystemModeEnum
Indicates the system mode of the VSE device.
39