X-Tools configuration to connect with OPC servers and clients

Size: px

Start display at page:

Download "X-Tools configuration to connect with OPC servers and clients"

Godfrey Booker
6 years ago
Views:

1 Application description 6/2016 X-Tools configuration to connect with OPC servers and clients CMS X-Tools / V

2 Warranty and liability Warranty and liability Note The Application Examples are not binding and do not claim to be complete regarding the circuits shown, equipping and any eventuality. The Application Examples do not represent customer-specific solutions. They are only intended to provide support for typical applications. You are responsible for ensuring that the described products are used correctly. These application examples do not relieve you of the responsibility to use safe practices in application, installation, operation and maintenance. When using these Application Examples, you recognize that we cannot be made liable for any damage/claims beyond the liability clause described. We reserve the right to make changes to these Application Examples at any time without prior notice. If there are any deviations between the recommendations provided in these application examples and other Siemens publications e.g. Catalogs the contents of the other documents have priority. We do not accept any liability for the information contained in this document. Any claims against us based on whatever legal reason resulting from the use of the examples, information, programs, engineering and performance data etc., described in this Application Example shall be excluded. Such an exclusion shall not apply in the case of mandatory liability, e.g. under the German Product Liability Act ( Produkthaftungsgesetz ), in case of intent, gross negligence, or injury of life, body or health, guarantee for the quality of a product, fraudulent concealment of a deficiency or breach of a condition which goes to the root of the contract ( wesentliche Vertragspflichten ). The damages for a breach of a substantial contractual obligation are, however, limited to the foreseeable damage, typical for the type of contract, except in the event of intent or gross negligence or injury to life, body or health. The above provisions do not imply a change of the burden of proof to your detriment. Any form of duplication or distribution of these Application Examples or excerpts hereof is prohibited without the expressed consent of the Siemens AG. Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants, solutions, machines, equipment and/or networks. They are important components in a holistic industrial security concept. With this in mind, Siemens products and solutions undergo continuous development. Siemens recommends strongly that you regularly check for product updates. For the secure operation of Siemens products and solutions, it is necessary to take suitable preventive action (e.g. cell protection concept) and integrate each component into a holistic, state-of-the-art industrial security concept. Third-party products that may be in use should also be considered. For more information about industrial security, visit To stay informed about product updates as they occur, sign up for a productspecific newsletter. For more information, visit Entry-ID: , V1.0, 06/2016 2

3 Table of contents Siemens 2015 All rights reserved Table of contents Warranty and liability Preface Overview Basic knowledge required Required software Required hardware Scope of delivery Further information Terms How to connect a OPC UA client to the X-Tools server X-Tools settings Setup Start the OPC UA server Client settings How to connect a OPC UA server to the X-Tools client Setup of a OPC UA sample server X-Tools settings How to connect a OPC DA server to the X-Tools client Setup of a OPC DA Sample Server Setup of a OPC UA Gateway Setup wizard Settings of Administration Interface ConfigurationTool interface settings X-Tools settings Contact information History Entry-ID: , V1.0, 06/2016 3

4 1 Preface 1 Preface 1.1 Overview OPC (for Open Platform Communications) is a series of standards and specifications for industrial telecommunication, mostly used in the automation industry. OPC specifies the communication of real-time plant data between control devices from different manufacturers. The current standard is the OPC Unified Architecture (OPC UA), but the former standard OPC DA is also used. Unfortunately, X-Tools cannot be directly connected with an OPC DA Server. This tutorial is divided into three main parts: First, we will explain how to configure the X-Tools software as a server for an OPC UA client. Second, we will explain how to connect the X-Tools client to an OPC UA server. Third, we will explain how to configure a gateway to connect X-Tools client to an OPC DA Server using a gateway. 1.2 Basic knowledge required In order to understand this application description, you need general knowledge of automation technology and the software packages CMS X-Tools (in the following, X-Tools). In addition, you must be familiar with network technology (UDP/IP), the basics of the OPC communication protocol, and using computers with Windows. 1.3 Required software This document is valid for the following software: CMS X-Tools Professional V If different software versions are used, this can lead to variations in the steps described below. As far as the OPC software is concerned, you can use any OPC UA client or server; in this tutorial, we have used the following that are both downloadable freeware and can support your training: OPC UA client: UaExpert V (go to for download). OPC UA sample server: OPC Unified Architecture Technology sample applications V OPC foundation (go to for download). OPC DA Sample Server : Matrikon OPC Server for simulation (go to for download). OPC UA Gateway : UAGateway Wrapper and Proxy V1.4.1 (trial version go to for download. Please note, the trial license is not valid for a long time). Entry-ID: , V1.0, 06/2016 4

5 1 Preface 1.4 Required hardware PC with Microsoft Windows (see the following document : CMS X-Tools (All Editions) User Manual 01 Introduction.EN.pdf / Page 25 for more details about compatible hardware configurations for CMS X-Tools). NOTE The X-Tools client and server can also be installed on different systems. 1.5 Scope of delivery No files are delivered with this tutorial. 1.6 Further information 1.7 Terms This document will not provide a detailed description of all features. More information can be found in: CMS X-Tools User Manual Information about the X-Tools setup and the required software configuration in part 01-Introduction CMS X-Tools (All Editions) Release Notes Page 8 : information about OPC UA connection The following terms are used in this document: SW Definition Software Description Entry-ID: , V1.0, 06/2016 5

$1 Setup Before starting, you must ensure that the folder Example Location has been extracted to the hard drive: CMS X-Tools Pro\Server\User\Example Location The Example Location folder contains$

6 2 How to connect a OPC UA client to the X-Tools server 2 How to connect a OPC UA client to the X- Tools server 2.1 X-Tools settings Setup Before starting, you must ensure that the folder Example Location has been extracted to the hard drive: CMS X-Tools Pro\Server\User\Example Location The Example Location folder contains sample data and simulation programs so that you can check to see if your final settings are working. Launch X-Tools and connect to the X-Tools server with your usual account once the pop-up window appears Start the OPC UA server In order to enable the OPC UA server in X-Tools, proceed as follows (figure 2-0): Go to the MMS Explorer Open the Server Global Options Enable the OPC UA server Figure 2-0 The port will be required for the setup of the OPC UA client. Entry-ID: , V1.0, 06/2016 6

On your X-Tools server, go to the Example location, which you may have to add.

7 2 How to connect a OPC UA client to the X-Tools server To acquire data to monitor,you can launch one of the simulation files delivered with the X-Tools setup. Go to the Device Management System. On your X-Tools server, go to the Example location, which you may have to add. At this location, start by right clicking: - An Interface Profile File : Simulation T001 (figure 2-1) - A Device Profile File : ION SIMATIC S7 PN (figure 2-2) - Figure 2-1 Figure 2-2 Entry-ID: , V1.0, 06/2016 7

You can also check out the corresponding Online Data in the MDS Explorer, all

8 2 How to connect a OPC UA client to the X-Tools server The simulation is now running. You will notice that the corresponding virtual hardware appeared in DMS Explorer. You can also check out the corresponding Online Data in the MDS Explorer, all displayable in the monitoring system workspace (just drag and drop): Entry-ID: , V1.0, 06/2016 8

You will see the following information (figure 2-3) : Figure 2-3 In this example, the IP address is 146.254.181.240, corresponding to the X-Tools server.

9 2 How to connect a OPC UA client to the X-Tools server 2.2 Client settings We will now explain how to connect to the enabled OPC UA server to a client. In this case, we are connecting the client to a local server (the X-Tools server). First check out your IP configuration: Enter ipconfig into the command window. You will see the following information (figure 2-3) : Figure 2-3 In this example, the IP address is , corresponding to the X-Tools server. Start UA Expert Client to set up the connection to the OPC UA server. On the home page, click the plus sign to add a new server (figure 2-4): Figure 2-4 Entry-ID: , V1.0, 06/2016 9

Figure 2-5 Figure 2-6 Just type in the URL of the server using the following syntax

10 2 How to connect a OPC UA client to the X-Tools server To add a server whose IP Address you know, choose Custom Discovery (Figure 2-5). Figure 2-5 Figure 2-6 Just type in the URL of the server using the following syntax (figure 2-6): opc.tcp://ip-address of the OPC UA Server : Port of the OPC UA Server Entry-ID: , V1.0, 06/

2 How to connect a OPC UA client to the X-Tools server In this example, it will show (figure 2-7): opc.tcp://146.254.181.

11 2 How to connect a OPC UA client to the X-Tools server In this example, it will show (figure 2-7): opc.tcp:// :4841 Figure 2-7 You don t need to set up a secured authentication: Choose the Anonymous setting. Entry-ID: , V1.0, 06/

You can monitor your online data inside your OPC UA client using

12 2 How to connect a OPC UA client to the X-Tools server You can now connect to your server and browse the data (figure 2-8): Figure 2-8 You can monitor your online data inside your OPC UA client using drag and drop (figure 2-9): Figure 2-9 Entry-ID: , V1.0, 06/

13 3 How to connect a OPC UA server to the X-Tools client 3 How to connect a OPC UA server to the X- Tools client 3.1 Setup of a OPC UA sample server If you don t have a real server, you can download a sample program by following the link given in the Preface. Once the software package is installed, launch the Sample Server app (as administrator), and the following windows will appear (figure 3-1): Figure 3-1 The syntax of the server URL has the following structure in this sample software: opc.tcp://ip or Name of the computer/port of the OPC UA Sample Server/UA/Sample Server The port will be required for the setup of the X-Tools client. Entry-ID: , V1.0, 06/

Figure 3-2 Save it to the relevant location (File/Save As).

14 3 How to connect a OPC UA server to the X-Tools client 3.2 X-Tools settings Go on to the Device Management System. First you need to create an Interface Profile file: Right-click on the corresponding interface in the Device Management System and select New Interface Profile (figure 3-2). Figure 3-2 Save it to the relevant location (File/Save As). You now need to check the settings of the Interface Profile file corresponding to the OPC UA server (figure 3-3): drag and drop it to the workspace. Figure 3-3 In the field Target IP or name, type in the IP address of the server you want to connect with X-Tools. In this example, we are connecting to a local server: You can also type localhost in this field. In the field Port, type in the relevant port to connect to your OPC server (see chapter 3.1). Entry-ID: , V1.0, 06/

that the connection has been reported to the sample server

15 3 How to connect a OPC UA server to the X-Tools client Start the Interface Profile file (figure 3-4): Figure 3-4 Make sure that the connection has been reported to the sample server interface (figure 3-5): Figure 3-5 Entry-ID: , V1.0, 06/

3 How to connect a OPC UA server to the X-Tools client The corresponding connected device has

16 3 How to connect a OPC UA server to the X-Tools client The corresponding connected device has appeared in the X-Tools DMS Explorer, so now you can create a new Device Profile (figure 3-6). Figure 3-6 Save your device profile to the relevant location (figure 3-7). Figure 3-7 Explore your server, choose the data you want to be displayed, and add it as a Device Profile Input Data (figure 3-8). To make sure that your settings are correct, choose a dynamic data so that you will be able to monitor its variations. Figure 3-8 Entry-ID: , V1.0, 06/

17 3 How to connect a OPC UA server to the X-Tools client Once you have added all the data you want to monitor, save every Device Profile Input Data and go to the DMS Explorer. Start the Device Profile file you just created (figure 3-9): Figure 3-9 The corresponding data are now displayed as Online Data in the MDS Explorer (figure 3-10). Figure 3-10 Entry-ID: , V1.0, 06/

18 3 How to connect a OPC UA server to the X-Tools client Note that once your Device Profile is started, a Subscription is reported to the interface of your sample server, showing that a client is currently reading data on the server (figure 3-11). Figure 3-11 Go on to the Monitoring System and drag and drop the data file to the workspace. The data read on your OPC Server are now displayed in X-Tools (figure 3-12). To set the scale, you can select Fit to Charts. Figure 3-12 Entry-ID: , V1.0, 06/

4 How to connect a OPC DA server to the X-Tools client 4 How to connect a OPC DA server to the X- Tools client X-Tools cannot be directly connected with OPC DA servers but only with OPC UA servers

19 4 How to connect a OPC DA server to the X-Tools client 4 How to connect a OPC DA server to the X- Tools client X-Tools cannot be directly connected with OPC DA servers but only with OPC UA servers (as almost every recent software), which is the latest standard now in use. However, the former OPC DA Standard is still widely used in industrial applications, and you should very likely have to connect a DA server to the X-Tools client to monitor and analyze data. To solve this compatibility issue, you just have to configure an OPC UA gateway to which you will connect the X-Tools client, as if it was a OPC UA server. Shortly, the UA gateway is an adapter to connect a UA client to almost every OPC server standard in use. 4.1 Setup of a OPC DA Sample Server In this chapter we use the Matrikon OPC Server for Simulation (freeware see the preface for the download link) as an example. The first step is to carry out the setup of this software on your computer. Administrator rights will be required. Once the setup is completed, launch the software: Figure 4-1 Entry-ID: , V1.0, 06/

4 How to connect a OPC DA server to the X-Tools client 4.2 Setup of a OPC UA Gateway In this tutorial we have used the Unified Automation Gateway v1.4.1 (trial version see the preface for the download link) as an example.

20 4 How to connect a OPC DA server to the X-Tools client 4.2 Setup of a OPC UA Gateway In this tutorial we have used the Unified Automation Gateway v1.4.1 (trial version see the preface for the download link) as an example. This gateway provides a connection interface for all standards of OPC servers. The gateway will perform as an OPC UA Server for the client which will be connected. Shortly: it is an adapter to connect to any OPC server standard if your client is only connectable to OPC UA servers Setup wizard First, download the UaGateway software (see the preface for the download link). Run the setup wizard. Pay attention to this step (figure 4-2): Figure 4-2 Select the desired port keep the default setting if the port is available Check the Add to firewall option Entry-ID: , V1.0, 06/

(therefore click Administrate UaGateway, figure 4-3) : Figure 4-3 Go to the tab General to create an account

21 4 How to connect a OPC DA server to the X-Tools client Settings of Administration Interface Once the setup is completed, launch the Administration interface (therefore click Administrate UaGateway, figure 4-3) : Figure 4-3 Go to the tab General to create an account with your Windows login/password (figure 4-4), so that the gateway will be allowed to run for the currently logged in user. Figure 4-4 Entry-ID: , V1.0, 06/

22 4 How to connect a OPC DA server to the X-Tools client Following, this message must be displayed (figure 4-5): Figure 4-5 Go to the tab UA Endpoints. You will find all the required network information to connect the gateway to the X-Tools client (figure the same procedure as in chapter 3 with the OPC UA server): Figure 4-6 Entry-ID: , V1.0, 06/

Figure 4-7 You can now start the gateway (figure 4-8).

23 4 How to connect a OPC DA server to the X-Tools client Go on to the tab channels. Tick the COM DA Channel option (figure 4-7). Figure 4-7 You can now start the gateway (figure 4-8). Following up you can open the ConfigurationTool (figure 4-9). Figure 4-8 Figure 4-9 Entry-ID: , V1.0, 06/

already displayed we will add it manually: Figure 4-10 Browse the Local location

24 4 How to connect a OPC DA server to the X-Tools client ConfigurationTool interface settings In the case a configured gateway is not already displayed we will add it manually: Figure 4-10 Browse the Local location (figure 4-11), and choose the desired security setting. Figure 4-11 Entry-ID: , V1.0, 06/

Don t forget to save the project before you connect to UaGateway (figure 4-12):

25 4 How to connect a OPC DA server to the X-Tools client Now, the gateway has been displayed. Don t forget to save the project before you connect to UaGateway (figure 4-12): Figure 4-12 We will now connect the gateway to the OPC DA server: click on Activate Device Plugin (figure 4-13). Figure 4-13 Entry-ID: , V1.0, 06/

ConfigurationTool interface are now displayed below (figure 4-14, in blue).

26 4 How to connect a OPC DA server to the X-Tools client Following the several servers you checked before in the Channel- tab in the ConfigurationTool interface are now displayed below (figure 4-14, in blue). Click on Add Server (figure 4-14, in red). Figure 4-14 Entry-ID: , V1.0, 06/

Choose the server you installed in the step before (Matrikon.OPC.Simulation.

27 4 How to connect a OPC DA server to the X-Tools client The wizard is automatically browsing the Local location and displays the available servers. Choose the server you installed in the step before (Matrikon.OPC.Simulation.1 figure 4-15): Figure 4-15 The server is now connected to the gateway; Now you can browse the online data (figure 4-16) Figure 4-16 Entry-ID: , V1.0, 06/

28 4 How to connect a OPC DA server to the X-Tools client X-Tools settings If you closed it, restart the Administration interface of UAGateway. Go on to the tab UA Endpoints (figure 4-17). Here, the required network parameters for the settings of the X-Tools client are displayed: IP Address Port Figure 4-17 Entry-ID: , V1.0, 06/

4 How to connect a OPC DA server to the X-Tools client Launch the X-Tools

go to the tab Main Management System, and open Edit global options (figure

29 4 How to connect a OPC DA server to the X-Tools client Launch the X-Tools client. The following steps are similar to chapter 3.2. go to the tab Main Management System, and open Edit global options (figure 4-18). Make sure that the OPC option in X-Tools is enabled (figure 4-19). Figure 4-18 Figure 4-19 Create a new Interface profile for the OPC UA Interface in the tab Device Management System (figure 4-20) : Figure 4-20 Entry-ID: , V1.0, 06/

4 How to connect a OPC DA server to the X-Tools client Enter

30 4 How to connect a OPC DA server to the X-Tools client Enter the IP Address and Port for the OPC UA gateway you just configured in Step (figure 4-21): Figure 4-21 IP Address or localhost Port Save the Interface Profile to the desired location (figure 4-22), Start the Interface Profile (figure 4-23). Figure 4-22 Figure 4-23 Entry-ID: , V1.0, 06/

(figure 4-24): Figure 4-24 Choose one of the dynamic sample data available on the server

31 4 How to connect a OPC DA server to the X-Tools client The Gateway appears in the X-Tools Explorer as an available hardware interface, so now you can create a New Device Profile (figure 4-24): Figure 4-24 Choose one of the dynamic sample data available on the server Select Add as Device Profile Imput Data (figure 4-25). Figure 4-25 Entry-ID: , V1.0, 06/

Figure 4-26 Figure 4-27 Start the Device

The selected data should be displayed as

32 4 How to connect a OPC DA server to the X-Tools client Rename the Device Profile Imput Data (figure 4-26) and save the device profile (figure 4-27). Figure 4-26 Figure 4-27 Start the Device profile. The selected data should be displayed as Online Data into the MDS Explorer (figure 4-28): Figure 4-28 Entry-ID: , V1.0, 06/

33 4 How to connect a OPC DA server to the X-Tools client To monitor your data, go to the tab Monitoring System and drag and drop data to the workspace (figure 4-29): Figure 4-29 Entry-ID: , V1.0, 06/

34 5 Contact information 5 Contact information Should you have any questions concerning the software application, please refer to the Industry Sector Technical Support. Department Siemens AG Industry Sector Phone +49 (0) (Monday to Friday, 9:00 a.m. to 5:00 p.m. CET/CEST) Fax +49 (0) Internet Thank you for using one of the above-mentioned contacts to ensure that your inquiry is registered and can be processed. 6 History Version Date Modifications V1.0 06/2016 First version Entry-ID: , V1.0, 06/

Windows firewall settings for X-Tools Server Pro. CMS X-Tools / V / CPU PN/DP. Application description 6/2016

Application description 6/2016 Windows firewall settings for X-Tools Server Pro CMS X-Tools / V 04.03 / CPU 416-3 PN/DP https://support.industry.siemens.com/cs/ww/en/view/item_number Warranty and liability