Universal Parameter Server

Size: px

Start display at page:

Download "Universal Parameter Server"

Janis Maxwell
6 years ago
Views:

1 Library Description 10/2015 Universal Parameter Server SIMATIC S

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 this Application Example and other Siemens publications e.g. Catalogs the contents of the other documents shall 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 fundamental contractual obligations ( 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 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, 10/2015 2

3 Table of Contents Table of Contents Warranty and Liability Motivation Use of IPARSERV as an ipar-server Task and solution Function and explanation Interaction between OB 56 FB IPARSERV Explanation of the Update Alarm (OB 56) The RALRM statement The IPARSERV Block in Detail Flowchart and function Parameter assignment and feedback Data types and auxiliary blocks Important Information about the Data Blocks General rule The iparameter data block References History Entry ID: , V1.0, 10/2015 3

4 1 Motivation 1 Motivation Motivation Aside from the parameters defined by the GSD file, many field devices require additional technology-specific parameters ( iparameters ) that cannot be transferred before the field device is in operation. For this purpose, manufacturers offer additional tools to assign the iparameters to the field device. Therefore, device replacement, for example due to a defect, always requires the appropriate manufacturer tool for setting the iparameters or replacing the memory card. Often, users would like to implement quick device replacement during repair without using additional manufacturer tools for parameterizing the device functions. To meet this requirement, the standardized universal parameter server method ipar-server is used that provides appropriate services for saving (uploading) and restoring (downloading) iparameters. The ipar-server can be provided as a function block or as a system function within the non-safety-related part of the safe PLC. For the solution described in this document, a function block was developed as an ipar-server. Note What you get The developer of a device/module is responsible for defining the criteria for triggering the Back up / Restore request. This document describes the IPARSERV_S71500 block library with the IPARSERV function block. This block is used to generally provide the ipar-server functionality for new generation CPUs (S7-1500). Entry ID: , V1.0, 10/2015 4

5 2 Use of IPARSERV as an ipar-server 2 Use of IPARSERV as an ipar-server 2.1 Task and solution Task Solution It should be possible to save the iparameters of a field device (e.g., the definition of the monitoring fields of a laser scanner) in the SIMATIC controller and restore them, if necessary (e.g., module replacement) without any additional manufacturer tools. The IPARSERV function block allows you to save and back up ( upload ) parameter assignment data ( iparameters ) upon request of a PROFINET device or a module used in it in a DB and restore it due to maintenance or repair ( download ). The DB is stored on the PN IO controller. Both standard and safety stations/modules are supported. With PROFINET IO, a device sends a request to the controller via Upload&Retrieval a newly introduced diagnostic alarm for ipar (OB 56: Update Alarm ) to back up (upload) or restore (download) iparameters. Note The RALRM diagnostics alarm block is used to detect and react to this diagnostic alarm. It is integrated in the IPARSERV function block. For this reason, the function block must be additionally called and parameterized also within OB 56 (of the Update Alarm OB). Entry ID: , V1.0, 10/2015 5

6 2 Use of IPARSERV as an ipar-server 2.2 Function and explanation Principle of operation Figure 2-1 The figure below demonstrates this principle; the components can be standard or safety-related components. ipar-server Load/ 4 ipar_crc IPARSERV initialize Call 2 1 Engineering tool Parameter tool iparameters OB56 IO F-controller PROFINET with PROFIsafe F_iPar_CRC iparameters 3 Parameterize and verify Explanation IO F-device with ipar function Due to the request ( Update&Retrieval ) for upload ( back up request ), the function block reads the data record with the iparameter out of the component. The data is stored in a data block as a data record. Due to the request for download ( restore request"), the function block uses the data block and writes the data record to the component. For safety-related components, this mechanism can be supplemented by special protection that protects against incorrect or corrupted iparameter data. This protection is achieved by the F_iPar_CRC F-parameter defined by PROFIsafe. It holds the CRC signature across all the iparameters, including the necessary identification and type information of the F-components. F_iPar_CRC is part of the parameter assignment frame sent from the IO controller to the F-components when starting. Then the components are able to check their local iparameter set against the received F_iPar_CRC. Entry ID: , V1.0, 10/2015 6

7 2 Use of IPARSERV as an ipar-server 2.3 Interaction between OB 56 FB IPARSERV Explanation of the Update Alarm (OB 56) Description Upload&Retrieval The operating system of the S CPU calls the Update Alarm OB when it has received an update alarm. Among other things, an update alarm is generated when a parameter change was made on a slot of a slave or device. The introduction of the ipar-server has added a new type to the PROFINET IO alarm model Upload&Retrieval (alarm type: 30). Within this new alarm type, USI: 0x8201 identifies the special ipar-server alarm. In the case of a PROFINET IO device, the function block must be additionally called within OB 56 (of the Update Alarm OB) to detect this new diagnostic alarm The RALRM statement Description Note The RALRM statement allows you to receive an alarm from a module, including the associated information. This information provides the statement at its output parameters (AINFO, TINFO). The data structure of the AINFO destination area corresponds to the data structure of PROFINET IO. Information on the exact data structure can be found in the TIA Online Help. Call of RALRM RALRM is already integrated in the IPARSERV function block and parameterized accordingly. It is only called when the Update Alarm was enabled. ipar-server alarm information The structure of the alarm information of an ipar-server request is defined in the specification of the PNO (PROFIBUS User Organization) and includes the following information: Table 2-1 Variable Name Size Description ipar0 ipar_req_header 4 bytes ipar alarm type (Upload/Download) ipar1 Max_Seg_Size 4 bytes Maximum allowed net data size for a segment. ipar2 Transfer_Index 4 bytes Data record index for RDREC/WRREC. ipar3 Total_iPar_Size 4 bytes Total size of the iparameters. Entry ID: , V1.0, 10/2015 7

8 3 The IPARSERV Block in Detail 3 The IPARSERV Block in Detail 3.1 Flowchart and function Function Due to the upload request ( back up request ), the function block reads out the data record with the component-specific iparameters and stores them in a defined data block that is unique across the project. The user defines this data block via an input variable. If the specified data block does not exist, the function block automatically generates a data block and the generated DB number is displayed on an output variable. Due to the download request ( restore request"), the function block reads the saved iparameters out of the data block and writes the data record to the component. Depending on the iparameter size, data transfer from/to the component can take place in different ways: Read/write iparameters in one call Segmented read/write (push-pull method) of iparameters Note The user must use a unique DB number for each component from which iparameters are to be saved. The DB number is assigned via the dbnr input variable. If a data block with the specified DB number does not exist, a data block is automatically created in the DB number range Entry ID: , V1.0, 10/2015 8

9 3 The IPARSERV Block in Detail Flowchart The following flowchart shows the detailed process: Figure 3-1 IPar-Server alarm Upload Upload or download Download DB exists? no Generate new DB Abort no DB exists? yes yes DB size OK? yes Read data from component no Abort Write data to component iparameter DB iparameter DB Entry ID: , V1.0, 10/2015 9

10 3 The IPARSERV Block in Detail 3.2 Parameter assignment and feedback Call The IPARSERV function block is called in the cyclic program (OB 1) and in the Update Alarm OB (OB 56) and instantiated once per component. The following figure shows the call: Figure 3-2 Parameter description The following table lists the parameters used: Table 3-1 Parameter Declaration Data type Description Assignment moduladdr Input INT Hardware ID of the module dbnr Input DB_Any The number must be unique for each component from which you want to save iparameters uploadbusy Output BOOL Signals a new upload process of the iparameters downloadbusy Output BOOL Signals a new download process of the iparameters createdbnr Output UINT Number of the generated data block errorcode Output INT Error code retval Output INT Return value of an application call HW ID of your module (see system variables in the TIA project) Number of the data block for the iparameters. Entry ID: , V1.0, 10/

11 3 The IPARSERV Block in Detail Note The call, the parameter assignment and the number of the instance data block are per block call/component identical in OB 1 and OB 56. To avoid errors, copy the call of the pre-configured function block from OB 1 and paste it into OB 56. Feedback Internally, the IPARSERV function block uses multiple system functions. If an error occurs, the retval output variable provides possible error information of these internal calls. The meaning of this error information is described in the TIA Online Help. The following table contains all possible error codes ( errorcode output variable), the respective explanation and the system function that has caused the error. The exact cause of the error is stored in the retval output variable. Table 3-2 error Code 0 No error Explanation 1 It was not possible to create the data block for iparameter backup. 2 Data block ( dbnr ) too small for iparameter storage. 3 Error while reading the alarm information. 4 Invalid request from the component. Possible reasons: No request for upload or download of iparameters Data size too big 5 Error while reading the iparameters from the component (upload). 6 Wrong segment while reading segmented iparameters. 7 Error while writing the iparameters to the component (download). 8 Version ID within data block ( dbnr ) invalid. 9 Error while checking whether the component is connected to PROFIBUS, PROFINET or centrally. This error prevents the function block from completing the upload or System function Remedy CREATE_DB Check and eliminate the error using the error information provided by retval. RALRM RDREC WRREC LOG2GEO Check the required minimum length of your data block. Check and eliminate the error using the error information provided by retval. Check and eliminate the error using the error information provided by retval. Check and eliminate the error using the error information provided by retval. The first two bytes of the data block for the iparameters are reserved for the version ID and must not be changed. Check and eliminate the error using the error information provided by retval. Entry ID: , V1.0, 10/

12 3 The IPARSERV Block in Detail error Code Explanation download process. 10 Error while checking the existence of the DB with the dbnr number. 11 Error while writing a data record: The target data block does not exist. System function ATTR_DB Remedy Check and eliminate the error using the error information provided by retval. Check whether the data block with the iparameters exists. Make sure that for an automatically generated data block ( createdbnr output) this number is also stored at the dbnr input. A displayed errorcode (except number 9) has no influence on the execution of the FB. An error code is displayed until it is overwritten by another one after successful transfer of the iparameters from or to the component. The request to read or write a data record is reset. Entry ID: , V1.0, 10/

13 3 The IPARSERV Block in Detail 3.3 Data types and auxiliary blocks Overview of the data types used Internally, FB IPARSERV uses a number of data types for clear, structured programming. The following table provides an overview and shows how they are used: Table 3-3 PLC data type typestructainfo typestructanypointer typestructiparam typestructralam Use Data structure for the alarm information (AINFO) on RALRM. Structure to create an ANY pointer. Data structure for the ipar information from the special ipar-server alarm. Structure for the information from RALRM. Overview of the auxiliary blocks used To implement the function as an ipar-server, the block internally uses more statements. The following table provides an overview and shows how they are used: Table 3-4 Statement LOG2GEO RDREC WRREC ATTR_DB Function Determine the slot information of a component. Read a data record from a component. Write a data record to a component. Determine information via a data block. CREATE_DB Create a new data block in the number range PEEK / POKE RALRM Read/write from/to a memory address. Read out the alarm information of a component. Entry ID: , V1.0, 10/

14 4 Important Information about the Data Blocks 4 Important Information about the Data Blocks Two different data block types are used for the ipar-server function: 4.1 General rule Instance data block for FB IPARSERV. Global data block for saving the iparameters. All data blocks that are used for the ipar-server function must follow this rule: The optimized property must be unchecked for all data blocks. The retain property must be checked for all data blocks. Note After generating the data blocks, change the block properties following this rule. 4.2 The iparameter data block Important note Data block size The iparameter data block is used to save the iparameters of a component. A unique data block must be used for each component from which iparameters are to be saved. If a data block with the number specified at the dbnr input parameter does not exist, a data block is automatically created in the DB number range The data block for storing the iparameters must be of an appropriate minimum size as administrative data is stored in addition to the iparameters. The rules for the data block length are defined as follows for non-segmented iparameters (read or write data record): iparameter length + 6 bytes ( Header ) for segmented iparameters (push-pull method): iparameter length + 6 bytes ( Header ) + 6 bytes ( LoadRegion ) + maximum segment size (buffer area for segment processing) Note When creating the iparameter data block, make sure to provide enough space (DB length) for all possible data blocks. Entry ID: , V1.0, 10/

15 4 Important Information about the Data Blocks Structure The structure of the iparameter data block differs depending on the transfer variant. For a non-segmented data transfer, the structure is defined as follows: Table 4-1 Byte Explanation 0 Version ID for the structure of the data block 1 Reserved 2 5 Total length of the iparameter data ( Total_iPar_Size ) 6 iparameters (without the header for Load Region ). e.g., 31 Important note For a segmented data transfer, the structure is defined as follows: Table 4-2 Byte Explanation 0 Version ID for the structure of the data block 1 Reserved 2 5 Total length of the iparameter data ( Total_iPar_Size ) 6 iparameters (without the header for Load Region ) e.g., 31 e.g., 32.. e.g., 96 Segmented read/write data records via PUSH / PULL requires this additional space as a cache for processing the data records, including the Load Region headers: Maximum segment length + 6 byte Load Region header. iparameter data blocks created automatically by the function block are initially only available online on the controller. They are only available offline after a download from the controller to your project. Entry ID: , V1.0, 10/

16 5 References 5 References Table 5-1 Subject Title \1\ Siemens Industry Online Support \2\ Download page of the entry \3\ PNO (PROFIBUS User Organization) \4\ PNO literature list ure-list-order-form/display 6 History Table 6-1 Version Date Modifications V1.0 10/2015 First version Entry ID: , V1.0, 10/

Cover. Universal-Parameter-Server (FB 24) SIMATIC S7. Function Block Description November Applikationen & Tools. Answers for industry.

Cover. Universal-Parameter-Server (FB 24) SIMATIC S7. Function Block Description November Applikationen & Tools. Answers for industry. Cover Universal-Parameter-Server (FB 24) SIMATIC S7 Function Block Description November 2010 Applikationen & Tools Answers for industry. Industry Automation and Drives Technologies Service & Support Portal