Accessing SINAMICS parameters via OPC server

Transcription

1 Application example 04/2015 Accessing SINAMICS parameters via OPC server SIMATIC NET

2 Warranty and liability Warranty and liability Note The application examples in this document are not binding and do not claim to be complete regarding the configuration, equipping, and any eventuality. The application examples do not represent specific customer solutions, but are only intended to provide support for typical applications. You are responsible for the proper operation of the described products. These application examples do not relieve you of your responsibility regarding the safe handling when using, installing, operating, and maintaining the equipment. By using these application examples, you agree that Siemens cannot be made liable for possible damage beyond the mentioned liability clause. We reserve the right to make changes to these application examples at any time and without prior notice. In the case of deviations between the recommendations in this application example and other Siemens publications such as Catalogs, the contents of the other documentation have priority. We give no guarantee that the information contained in this document is complete, accurate, or up-to-date. We accept no liability for any damage or loss caused by the examples, information, programs, configuration or performance data, etc., described in this application example, irrespective of the legal basis for claims arising from such damage or loss, unless liability is mandatory (for example, in accordance with the German Product Liability Act for intent, acts of gross negligence, harm to the life, body or health of human beings, the assumption of a guarantee for a product's characteristics of state, malicious concealment of a defect, or violation of basic contractual obligations). Any compensation for violation of basic contractual obligations, however, shall be limited to the foreseeable damage or loss which is typically envisaged in contracts unless there has been gross negligence or unless liability is mandatory due to endangerment of life, body or health. Any change to the burden of proof to your disadvantage is not covered hereby. Any form of duplication of these application examples or excerpts hereof is not permitted without the express consent of Siemens AG. Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants, solutions, machines, devices, 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 that you inform yourself regularly about 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 receive information about product updates on a regular basis, register for our product newsletter. You can obtain more information Entry ID: , V1.1, 04/2015 2

3 List of contents List of contents Warranty and liability Task Overview Solution Overview of the overall solution Description of the core functionality Hardware and software components used Basic information SINAMICS parameters S7 protocol S7 routing Introduction in OPC Configuring the SINAMICS drive HW Config of the SIMATIC PC station SIMATIC NET component configurator SIMATIC NET configuration Testing the OPC DA server with OPC Scout Testing the OPC UA server with OPC Scout Commissioning the sample project Implementing an OPC client Description of the OPC item syntax for the S7 protocol Program example for OPC DA (Data Access) References Contact person History Entry ID: , V1.1, 04/2015 3

4 1 Task 1 Task 1.1 Overview Introduction This application describes how SINAMICS parameters can be accessed from a PC via SIMATIC NET OPC DA (or UA) server. In SINAMICS there are display parameters (r parameters, e.g. r0063 = speed actual value), which can be read accessed adjustable parameters (p parameters, e.g. p0856 = speed controller enabled), which can be read/write accessed. Drive parameters can be simply and quickly accessed via the SIMATIC NET OPC server, without having to install specific engineering software (STARTER or SIMOTION SCOUT). Communication between the SIMATIC NET OPC DA (or UA) server and SINAMICS drive is based on S7 communication. This application deals with the following key points: Preparing the SINAMICS drive Setting up the SIMATIC NET OPC server Testing the system that has been set up using OPC Scout Tips for creating a small test application to access SINAMICS parameters Note In this example, accessing a SINAMICS S is described. It is also possible to access a SINAMICS G. However, it should be noted that this is not applicable for SINAMICS G firmware V4.x up to and including V4.6. Entry ID: , V1.1, 04/2015 4

5 1 Task Overview of the automation task The following diagram provides an overview of the automation task. Fig. 1-1 Description of the automation task An S7 connection is to be established between a SINAMICS drive and a PC station in order to allow SINAMICS parameters to be accessed. The following steps must be carried out: - Commissioning the drive - Where required, creating the symbol file for the SIMATIC NET OPC server This is only possible for SINAMICS drives, which are assigned to a SIMOTION controller. SIMOTION SCOUT is required to create the symbol file. - Configuring the S7 connection in STEP7 - Checking the S7 communication to the SINAMICS using OPC Scout Note In this example, the connection via Ethernet or PROFINET is shown. A coupling is also possible via PROFIBUS. However, in this case interdependencies with other data communication running on PROFIBUS must be taken into consideration. Entry ID: , V1.1, 04/2015 5

6 2 Solution 2 Solution 2.1 Overview of the overall solution Schematic The following schematic figure shows the most important components of the solution. Fig Table 2-1 No. Description 1. At the SINAMICS S120, as alternative to the described machine interface X127, the PN interfaces X150 (onboard) or X1400 (optionally, CBE20) can also be used. 2. An S7 connection can be configured between the PC and SINAMICS. 3. At the PC, either a standard Ethernet interface or a SIMATIC NET CP is required. 4. For the connection, the SIMATIC NET SOFTNET-IE S7 software package is required (for standard Ethernet interfaces). 5. As software interface, the SIMATIC NET OPC servo for S7 protocol, included in the scope of delivery of SOFTNET, is required. Entry ID: , V1.1, 04/2015 6

7 2 Solution Differentiation This application does not contain a description of the general functions of SINAMICS drives, fundamental information about SIMATIC NET OPC server and its installation, fundamental information about the OPC programming interface. It is assumed that readers have basic knowledge of these topics. Knowledge required It is assumed that readers have basic knowledge about SIMATIC NET or engineering SINAMICS drives with the STARTER or SIMOTION SCOUT. 2.2 Description of the core functionality The parameters in SINAMICS can be read using the S7 protocol; and in the case of p parameters can also be written to. To do this, the addressing schematic described in this document must be strictly complied with. In order to be able to access a drive device with S7 protocol using a Windows PC, the corresponding Softnet or Hardnet software packages of the SIMATIC NET product family are required. NOTICE It is absolutely necessary to have in-depth knowledge about SINAMICS parameters. It is absolutely crucial that an application that has been implemented is subject to in-depth tests in order to avoid damage and undesirable system states. Entry ID: , V1.1, 04/2015 7

8 2 Solution 2.3 Hardware and software components used Hardware components The application was created with the following components: Table 2-2 Component Qty. Order number Note SINAMICS S120 CU320-2 PN PC with Ethernet interface 1 6SL3040-1MA01-0AA0 V Standard software components Table 2-3 Component Qty. /Order number Note STEP7 1 6ES7810-4CC08-0YA5 V5.5 SP2 HF1 STARTER or alternatively SIMOTION SCOUT SIMATIC NET SOFTNET IE S7 Windows 7 64 bit operating system 1 6AU1810-0BA42-1 6GK1704-1CW08-2AA0 V V4.3 SP1 HF1 Note SIMATIC NET PC software V8.2 is used in this application description. Other versions of this software can be used as well as other Windows operating systems. Also refer to the following article "With what is the SIMATIC NET PC software compatible? at Sample files and projects The list below contains all the files and projects used in this example. Table 2-4 Component STEP7_PC_Station_V1_0.zip Accessing_SINAMICS_parameters_via_SIMATIC_NET_ OPC_V1_1_en.pdf Note This zipped file contains the STEP7 project. This document. Entry ID: , V1.1, 04/2015 8

9 3 Basic information 3 Basic information 3.1 SINAMICS parameters A SINAMICS drive is subdivided into several drive objects (DO = Drive Object, e.g. CU = Control Unit, SERVO, ENCODER, etc.). Each drive object has its own parameter list. These parameter lists are divided into display parameters (r parameters, e.g. r0063 = speed actual value), which can be read accessed adjustable parameters (p parameters, e.g. p0856 = speed controller enabled), which can be read/write accessed. Here, it should be noted that the corresponding parameter list is only available if the corresponding drive object was created in the Control Unit. The content and significance of the individual parameters are dependent of the drive object type. Note Detailed information about the individual parameters, their data types and possible parameter values is provided in the STARTER online help (or SIMOTION SCOUT online help) or In the List Manual, refer to the following entry S7 protocol The S7 protocol is a proprietary Siemens protocol. It is also used to establish communications between PGs/PCs and Siemens automation systems (e.g. SIMATIC, SIMOTION), as well as drive systems (e.g. SINAMICS). The S7 protocol is also supported by Ethernet, PROFINET, PROFIBUS and MPI communications systems. Further, the S7 protocol can be arbitrarily routed between communication networks. On the other hand, the standardized data set communication (or data set routing) is only supported by certain Siemens automation systems (see SIOS entry ). SINAMICS G120 from firmware V4.x up to and including V4.6 does not support S7 communication (S7 protocol), but only data set communication. 3.3 S7 routing S7 routing involves a routing technique that is based on configured routing tables. As a consequence, information can also be exchanged between different communication networks (Ethernet, PROFINET, PROFIBUS and MPI). These routing tables can be created as interconnection tables in NetPro. S7 routing does not use IP addresses, but instead what are known as "S7 subnet IDs" within the S7 protocol. Entry ID: , V1.1, 04/2015 9

10 3 Basic information 3.4 Introduction in OPC OPC (OLE for Process Control) allows Windows applications to access process data, making it easy for devices and applications produced by different manufacturers to communicate with one another. OPC not only provides an open, non- proprietary interface, but also an easy-to-use client/server configuration for the standardized data exchange between system controls (e.g. SIMATIC, SIMOTION), field devices (e.g. SINAMICS) and PC-based applications (e.g. HMI or other Windows applications). To access SINAMICS drive parameters,... the SIMATIC NET OPC DA (Data Access) server can be used. This is based on the Microsoft COM/DCOM technology (Distributed Component Object Model). Please refer to Chapter 4.5 for a description of how you can access SINAMICS drive parameters via OPC DA and S7 communication. In addition, SIMATIC NET also supports OPC UA (Unified Architecture), the latest OPC specification from the OPC Foundation. Please refer to Chapter 4.6 for a description of how you can access SINAMICS drive parameters via OPC UA and S7 communication. The SIMATIC NET OPC server supports the following communication services: PROFINET IO PROFINET CBA PROFIBUS DP S7 communication (via PROFIBUS DP or Industrial Ethernet) Open IE/S5-compatible communication (via PROFIBUS DP or Industrial Ethernet) SNMP (via Industrial Ethernet) Entry ID: , V1.1, 04/

11 3 Basic information Fig. 3-1 The OPC server is an integral component of the SIMATIC NET SOFTNET-IE S7 (6GK1704-1CW08-2AA0) software package. This software package extends the protocols known in Windows to include industrial protocols, such as the S7 protocol. OPC Scout OPC Scout is a part of the SIMATIC NET software package. This tool can be used to simply test the access to process variables. As a consequence, it can also be used to check as to whether the OPC DA (or UA) server was successfully configured. OPC Scout indicates the name space of variables. These comprise communication connections and symbolic names. Process variables can be read and written to using OPC Scout. The OPC Scout also shows the status of communication connections. This can be realized using the attributes of process variables or using information variables. If process variables can be accessed using OPC Scout, then the OPC DA (or UA) server has been correctly configured, and you can start to implement your own OPC client (Windows application). OPC Scout is not required to operate a dedicated OPC client. Entry ID: , V1.1, 04/

12 A SINAMICS S120 CU320-2 PN is used in this project example. The integrated Ethernet interface (X127) is used as communication interface. Alternatively, the onboard PROFINET interface (X150) or an optional CBE (X1400) can be used. 4.1 Configuring the SINAMICS drive Table 4-1 No. Action Remark 1. Open STARTER or SIMOTION SCOUT to create a new project. 2. Insert a new drive device. A SINAMICS S120 CU320-2 PN V4.5 is used in this project example. Allocate the IP address for the Ethernet interface (X127) of the SINAMICS. In the project example, the preassigned IP address was kept. IP address: Subnet mask: Completely commission your drive before you continue with the next steps. Only after all of the drive objects that you wish to access have been created and parameterized can you access their parameters. Entry ID: , V1.1, 04/

13 4.2 HW Config of the SIMATIC PC station In order to be able to access a SINAMICS via S7 communication (SIMATIC NET, OPC DA) using a PC, a SIMATIC PC station must first be configured. Table 4-2 No. Action Remark 1. Open STEP7 to create a new project. 2. Assign a project name and storage location. 3. Using menu item "Insert > Station > SIMATIC PC station", enter a new PC station and when necessary, allocate a new station name (in the example, "PC_Station"). Entry ID: , V1.1, 04/

14 No. Action Remark 4. Open the HW Config of the PC station. Position the required PC-based communication module into any free slot in the PC station (e.g. slot 1) by drag&drop. In the example, a PC-based communication module for Industrial Ethernet is used ("IE General" SW V8.2). 5. The following dialog is automatically displayed after the communication module has been inserted in the PC station. Define the IP address of the communication module. In the project example, the PC station has the following IP address: IP address: Subnet mask: Then click on "New" to insert an Ethernet network. 6. The following dialog opens. Define a subnet name and confirm this dialog with "OK." Entry ID: , V1.1, 04/

15 No. Action Remark 7. Check the settings again and then click on "OK" to complete the operation. Note: Please ensure that the IP address, subnet mask and when required also the router IP address precisely match the addresses that have been set in Windows. 8. The "IE General" communication module has now been configured and networked. 9. Drag an OPC server from the hardware catalog and drop at any free slot in the PC station. You can find the required version of the OPC server in the hardware catalog in folder "SIMATIC PC station > User application > OPC server". OPC server SW V8.2 is used in the example. 10. Open NetPro to create an unspecified S7 connection between the SIMATIC PC station and the SINAMICS drive. Entry ID: , V1.1, 04/

16 No. Action Remark 11. Select the OPC server of the PC station, and create a new S7 connection using menu item "Insert > New connection". 12. In the following dialog, select entry "[Unspecified] and as connection type, "S7 connection". Confirm your entry with "OK". Entry ID: , V1.1, 04/

17 No. Action Remark 13. In the entry field "Connection path > Address", configure the IP address of the communication partner. In the example, the IP address of the communication partner is , i.e. the Ethernet interface (X127) of SINAMICS S120. Note: Additional settings are not required to establish an S7 connection to a SINAMICS. Notice! If parameters are then symbolically accessed via "\SYM:" at a later point in time, then the device name of the SINAMICS must be located in the entry field "Connection identification > Local ID". 14. The S7 connection that has just been created is displayed in NetPro in the connection table of the OPC server. 15. Save and compile the NetPro configuration. Note: When "Saving and compiling", in NetPro it is possible that warning messages are output. Warning messages are for information purposes only, and have no functional impact. However, if errors are output, then please check your configuration again. Entry ID: , V1.1, 04/

18 4.3 SIMATIC NET component configurator Proceed as follows to configure and load a PC station via "Import station". Table 4-3 No. Action Remark 1. Start the "Component configurator". 2. Click on the "Import station..." button. 3. If required, exit the OPC server, and confirm the following dialog with "Yes". 4. In the following dialog field, specify the path of the XDB file. The required XDB file is in the relevant STEP7 project in subdirectory "XDBs" (e.g. " _STEP7_PC_Station_V1_0\STEP7_PC_Station_V1_0\OPC-SINAMICS\XDBs"). Entry ID: , V1.1, 04/

19 No. Action Remark 5. Acknowledge the following dialog with "OK". The content of the XDB file is displayed here. 6. The XDB import is now complete and the configuration has been loaded. Note Please ensure that... the firmware versions (e.g. V8.2) of interface "IE General" and the "OPC server" are correct (refer to Chap. 4.2, No. 9 and the actual SIMATIC NET version). Further, it must be ensured that the configured IP address and subnet mask match your SIMATIC NET station! Entry ID: , V1.1, 04/

20 4.4 SIMATIC NET configuration Please ensure that for the OPC settings, the S7 protocol is activated. If you wish to use the SIMATIC NET OPC UA server, then also activate the S7 protocol here, in order to be able to access SINAMICS drive parameters. Fig. 4-1 Entry ID: , V1.1, 04/

21 4.5 Testing the OPC DA server with OPC Scout Table 4-4 No. Action 1. Start the OPC Scout (in the example, V10) using "Start > All programs > Siemens Automation > SIMATIC > SIMATIC NET > OPC Scout V10" 2. By double-clicking on "OPC.SimaticNet", OPC Scout (OPC client) connects with the OPC DA server. 3. Select the S7 connection to the SINAMICS drive. In the example, the connection name is "S7-Connection_1". Entry ID: , V1.1, 04/

22 No. Action 4. On the right-hand side, select the two objects "&statepath()" and "&statepathval(), and drag & drop these into the lower section of the window. The "&statepath()" variable indicates the status of the connection. Explanation of terms: UP = connection established DOWN = connection not established RECOVERY = connection was canceled 5. The item syntax can be adapted by clicking on a variable in the "ID"column. For variable "&statepathval()", click on the column ID in order to obtain the symbol shown to the right. The "Define item" dialog is displayed by clicking again on the symbol. Entry ID: , V1.1, 04/

23 No. Action 6. The OPC DA item syntax is structured as follows. S7:[S7-Connection_1]DB <parameter number>, <data type> <Drive Object ID * subindex> protocol ID connection name and address area p and r parameters are supported. data type oft Drive Object number times the SINAMICS In case of an array the subindex is added. parameter 1. The parameter number corresponds to the number of the expert list from STARTER or SIMOTION SCOUT. 2. You can determine the data type of each individual parameter via the online help in STARTER or SIMOTION SCOUT. Entry ID: , V1.1, 04/

24 No. Action The determined data type must be converted into a data type in conformance with the S7 protocol. The following data types can be requested via the S7 protocol: Entry ID: , V1.1, 04/

25 No. Action 3. For example, you can find the drive object number (drive object ID) in STARTER (or SIMOTION SCOUT) in the project navigator under "Communication > Message frame configuration". Examples: 1. Accessing drive object CU_S S7:[S7-Connection_1]DB2,W1024 DB2 = r2 = operating display (data type = Integer16 = WORD) 1024 = 1 x DO No. = 1 CU_S Subindex = 0 Operating display of the CU 2. Accessing drive object SERVO_2 S7:[S7-Connection_1]DB2,W2048 DB2 = r2 = operating display (data type = Integer16 = WORD) 2048 = 2 x DO No. = 2 SERVO_2 Subindex = 0 Operating display of SERVO 3. Accessing drive object CU_S S7:[S7-Connection_1]DB107,W1026 DB107 = p107 = drive object type (data type = Integer16 = WORD) 1026 = 1 x DO No. = 1 CU_S Subindex = 2 Type of drive object 2 7. Now adapt the OPC DA item syntax as follows: S7:[S7-Connection_1]DB2,W1024 (cp. OPC UA item syntax, Chapter 4.6) Note: Please note that the separator between the parameter number and data type is a comma, not a point! Entry ID: , V1.1, 04/

26 No. Action 8. Activate "Monitoring ON/OFF" as a consequence the OPC server starts/stops reading out the SINAMICS parameters. 9. If you wish to write a value, in the "New value" column, for the appropriate item, enter a new value, and then click on the "Write" button. Note: Only p parameters can be written to. In all other cases an error message is output when writing. In our particular example, we insert parameter p977 "Save parameter" of the CU, and write a value of 1 to save the parameter. Please note that the item monitoring is deactivated. When the parameter has been saved, then parameter p977 is automatically reset to 0. IMPORTANT: SINAMICS only allows one parameter at a time to be written. As a consequence, before you wish to write a new value, empty all fields in the "New value" column, as otherwise only the first parameter is written, and all others will be rejected with an error. Entry ID: , V1.1, 04/

27 4.6 Testing the OPC UA server with OPC Scout Table 4-5 No. Action 1. Start the OPC Scout (in the example, V10) using "Start > All programs > Siemens Automation > SIMATIC > SIMATIC NET > OPC Scout V10" 2. By double-clicking on "UA server", OPC Scout (OPC client) connects with the OPC UA server. 3. Select the S7 connection to the SINAMICS drive. In the example, the connection name is "S7- Connection_1" in subfolder "Objects/S7:". On the right-hand side, select the two objects "connectionstate" and "connectiontype", and drag & drop these into the lower section of the window. Variable "connectionstate" indicates the S7 connection state. In this case: 0x11: STD_DOWN; standard connection is consciously deselected 0x14: STD_OK; standard connection is established Additional states can be taken from the table from Manual \3\ "SIMATIC NET Industrial communication PG/PC Volume 2 - interfaces" in Chapter "S7-specific diagnostic variables". Entry ID: , V1.1, 04/

28 No. Action 4. The item syntax can be adapted by clicking on a variable in the "ID"column. For variable "connectiontype", click on the column ID in order to obtain the symbol shown to the right. The "Defining UA node" dialog is displayed by clicking again on the symbol. Now adapt the OPC UA item syntax as follows: S7: S7-Connection_1.DB2.1024,W (refer to OPC DA item syntax, Chapter 0) Note: Please note: The connection name is not specified in square brackets as is the case for OPC DA. A point is located between the connection name and parameter number! The separator between the parameter number and drive object number (+ subindex) is a point. A comma is located between the drive object number (+ subindex) and the data type. 5. Activate "Monitoring ON/OFF" as a consequence the OPC server starts/stops reading out the SINAMICS parameters. Please note that different item syntaxes must be used for OPC DA and OPC UA. However, the access principle via parameter number, drive object number + subindex and the data type are the same for both OPC servers Additional information, please refer to Chapter 4.5, No. 6. Entry ID: , V1.1, 04/

29 5 Commissioning the sample project 5 Commissioning the sample project Installing the hardware To setup the described application, you require a Windows PC with administrator rights while the software is being installed. SIMATIC NET PC modules for Ethernet or a standard Ethernet interface can be used as Ethernet interface. The standard Ethernet interface must be installed and configured in the operating system so that it functions. In the example, the Ethernet interface should be set using the following Windows IP configuration. To do this, open the properties of your network card under "Start > Control Panel > Network and Internet > Network and Sharing Center > Change Adapter Settings". Right-click on the interface being used and select the properties. You can make the following settings under Properties of the Internet protocol, Version 4: Fig. 5-1 Installing the software Table 5-1 No. Action Remark 1 Install the SIMATIC NET PC software. 2 As software package to be installed, as a minimum select the SIMATIC NET PC software. 3 In addition, STEP7 from Version 5.5 SP2 and STARTER or SIMOTION SCOUT software is required on the engineering system to commission SINAMICS drives. The OPC server is part of the SIMATIC NET PC software. Entry ID: , V1.1, 04/

30 6 Implementing an OPC client 6 Implementing an OPC client 6.1 Description of the OPC item syntax for the S7 protocol Refer to Manual \3\ SIMATIC NET Industrial Communication PG/PC Volume 2 - Interfaces in Chapter 2.5 "S7 communication" for a complete description of the OPC item syntax for the S7 protocol. This manual is part of the SIMATIC NET documentation available under "Start > All programs > Siemens Automation > SIMATIC > Documentation. You can download the manual at the link Program example for OPC DA (Data Access) Program examples for C# and VB.Net applications are included in the SIMATIC NET software installation. You can find these programming samples in the SIMATIC NET installation directory under "OPC2\Samples". Refer to Manual \3\ SIMATIC NET Industrial Communication PG/PC Volume 2 - Interfaces in Chapter 5 "Simatic Computing" for a complete description of the OPC data access programming interface. Entry ID: , V1.1, 04/

31 7 References 7 References Table 7-1 Topic Title \1\ Siemens Industry Online Support \2\ Download page of the article \3\ SIMATIC NET Industrial Communication PG/PC Volume 2 - Interfaces SIOS entry Contact person Siemens AG Industry Sector DF FA PMA APC Frauenauracher Strasse 80 D Erlangen mailto: profinet.team.motioncontrol.i-dt@siemens.com 9 History Table 9-1 Version Date Revision V1.0 09/2013 First Edition V1.1 04/2015 Supplement regarding. OPC UA (see Chapter 4.6) Entry ID: , V1.1, 04/