Transcription

1 SIMATIC Siemens Industry Online Support

2 Siemens AG 2018 All rights reserved Legal information Legal information Use of application examples Application examples illustrate the solution of automation tasks through an interaction of several components in the form of text, graphics and/or software modules. The application examples are a free service by Siemens AG and/or a subsidiary of Siemens AG ( Siemens ). They are nonbinding and make no claim to completeness or functionality regarding configuration and equipment. The application examples merely offer help with typical tasks; they do not constitute customer-specific solutions. You yourself are responsible for the proper and safe operation of the products in accordance with applicable regulations and must also check the function of the respective application example and customize it for your system. Siemens grants you the non-exclusive, non-sublicensable and non-transferable right to have the application examples used by technically trained personnel. Any change to the application examples is your responsibility. Sharing the application examples with third parties or copying the application examples or excerpts thereof is permitted only in combination with your own products. The application examples are not required to undergo the customary tests and quality inspections of a chargeable product; they may have functional and performance defects as well as errors. It is your responsibility to use them in such a manner that any malfunctions that may occur do not result in property damage or injury to persons. Disclaimer of liability Siemens shall not assume any liability, for any legal reason whatsoever, including, without limitation, liability for the usability, availability, completeness and freedom from defects of the application examples as well as for related information, configuration and performance data and any damage caused thereby. This shall not apply in cases of mandatory liability, for example under the German Product Liability Act, or in cases of intent, gross negligence, or culpable loss of life, bodily injury or damage to health, non-compliance with a guarantee, fraudulent non-disclosure of a defect, or culpable breach of material contractual obligations. Claims for damages arising from a breach of material contractual obligations shall however be limited to the foreseeable damage typical of the type of agreement, unless liability arises from intent or gross negligence or is based on loss of life, bodily injury or damage to health. The foregoing provisions do not imply any change in the burden of proof to your detriment. You shall indemnify Siemens against existing or future claims of third parties in this connection except where Siemens is mandatorily liable. By using the application examples you acknowledge that Siemens cannot be held liable for any damage beyond the liability provisions described. Other information Siemens reserves the right to make changes to the application examples at any time without notice. In case of discrepancies between the suggestions in the application examples and other Siemens publications such as catalogs, the content of the other documentation shall have precedence. The Siemens terms of use ( shall also apply. Security information Siemens provides products and solutions with industrial security functions that support the secure operation of plants, systems, machines and networks. In order to protect plants, systems, machines and networks against cyber threats, it is necessary to implement and continuously maintain a holistic, state-of-the-art industrial security concept. Siemens products and solutions constitute one element of such a concept. Customers are responsible for preventing unauthorized access to their plants, systems, machines and networks. Such systems, machines and components should only be connected to an enterprise network or the Internet if and to the extent such a connection is necessary and only when appropriate security measures (e.g. firewalls and/or network segmentation) are in place. For additional information on industrial security measures that may be implemented, please visit Siemens products and solutions undergo continuous development to make them more secure. Siemens strongly recommends that product updates are applied as soon as they are available and that the latest product versions are used. Use of product versions that are no longer supported, and failure to apply the latest updates may increase customer s exposure to cyber threats. To stay informed about product updates, subscribe to the Siemens Industrial Security RSS Feed at: Entry-ID: , V2.0, 08/2018 2

3 Siemens AG 2018 All rights reserved Table of contents Table of contents Legal information Introduction Overview Principle of operation Sequence of the core functions The PC program "" The TIA portal project Components used Engineering Hardware configuration Components of the TIA Portal project Interface description "TcpClient" Data block "Parameters" Data block "SendArrayData" Parameter assignment Adapting tags Saving and loading the STEP 7 project Operation Operating the TCP file server Operating the TCP client Error handling Useful information Operating principle overview Complete overview Functionality in the S7-CPU (TCP client) Functionality on the PC (TCP file server) Interaction between TCP client and TCP file server Appendix Service and Support Links and Literature Change documentation Entry-ID: , V2.0, 08/2018 3

4 Siemens AG 2018 All rights reserved 1 Introduction 1 Introduction 1.1 Overview Motivation In order to process a large number of PLC data on a PC, SCADA systems are usually used. However, it is often sufficient to store only a few, essential items of data on a PC and to use this data with a PC application. This application example shows you a low-cost alternative to complex SCADA systems in the lower power range. Requirements Production data from various automated systems should be stored in the file system of a server via their assigned controller. The format of the file should be able to be further processed with programs of the command level. Figure 1-1 Command level File server File Control level Production data Field level The following requirements should be met in detail: The format (e.g..csv) and name of the file should be specified in the controller. The files on the server are to be managed in a file system. The server should manage the data of several controllers. In order to be able to process real production data, the program example should be adaptable. Entry-ID: , V2.0, 08/2018 4

5 Siemens AG 2018 All rights reserved 1 Introduction Applicative implementation This application example offers you a more affordable alternative to a SCADA system. The application example consists of the following components: Figure 1-2 PG/PC Files TCP file server Data S S7-300 S TcpClient TcpClient TcpClient PROFINET IE The relevant components of this solution are the STEP-7 "TcpClient" blocks in the individual S7 stations, which process the data and send it to the PC station. The PC program "" receives the data from the SIMATIC stations and saves it line by line in files. Note The solution was implemented for S7-300, S and S CPUs (simple porting to an S7-400 CPU is also possible). Entry-ID: , V2.0, 08/2018 5

6 Siemens AG 2018 All rights reserved 1 Introduction Advantages The solution presented in this document offers you the following advantages: Affordable alternative to SCADA systems for very small applications Easy configuration Individual extensibility through open source code Transmission and storage of any format (CSV, XML, binary, etc.), since formatting is possible in the SIMATIC S7-CPU Note This application example simply creates a CSV string as a file format. If an XML, JSON or other format is required, this must be programmed individually in the control. Entry-ID: , V2.0, 08/2018 6

7 Siemens AG 2018 All rights reserved 1 Introduction 1.2 Principle of operation Sequence of the core functions Relevant components Principle of operation The relevant components of this solution are the STEP-7 "TcpClient" blocks in the individual S7 stations, which process the data and send it to the PC station. The PC program "" receives the data from the SIMATIC stations and saves it line by line in files. The following graphic shows the rough functioning and interaction of the two software components. For more details, see Section 3. Figure 1-3 S7-CPU (TCP client) Computer (TCP file server) Start/Stop Start/Stop Establish connection Accept connection Send file name Send data Create file Write data in file Terminate connection Switch off server File content: If the S7 CPU has established a TCP connection to the server, then the CPU can either send the following to the TCP file server: individual user data with configurable data size. the name of the file to be transferred. For the file name, you can specify a file path on the server. The server saves the transferred data in the file specified with the file name and file path. To save the data in the file, you can choose between two modes: In append mode, the current data is appended to the file. Overwrite mode overwrites the file with the current data. Entry-ID: , V2.0, 08/2018 7

8 Siemens AG 2018 All rights reserved 1 Introduction The PC program "" Programming The server interface The TCP file server was programmed in the.net language C # under Visual Studio 2012 Prof. It uses TCP sockets for communication. The C# code can be adapted to your needs at any time. You can operate the TCP file server via a graphical user interface. In this section you get an insight into the user interface of the TCP file server. The user interface of the server allows you to manage the TCP connections to the S7 stations and their files. Figure 1-4 The following table shows the description of the numbering. Table 1-1 No. Description 1. Local port of the TCP file server. The server is ready for new clients on this port. 2. These buttons start and stop the server. 3. Under "new connection path" you can define a default file path. This file path is adopted as a file deposit for all newly-added clients. You can customize the file path individually for each client and change it at any time. 4. List all clients that have connected to the server. Each client is displayed on a separate line with the following information: Name of the client (customizable) Status IP address of the client Client port number Entry-ID: , V2.0, 08/2018 8

9 Siemens AG 2018 All rights reserved 1 Introduction No. Description Current file mode Filename (customizable) File path (customizable) 5. Log table of the server. All events of the server are recorded here. The default settings. When a new TCP client connects to the server, the TCP client with appears in the list along with its default settings. You can change the default values for each client individually. The default settings affect the following display values: Display name of the client: The default client name is formed from the client IP address and the port from which port the client logged on to the server. File mode: To save the data in the file, you can choose between two modes: The default is "Append". File name: The default file name is formed from the display name of the client, the IP address of the server, and the local server port. File path: The default file path corresponds to the file path stored in the input field "new connection path". In the default setting, the file path corresponds to the directory from which the application was started. Individual client settings You can customize the default settings for each client. To customize the default settings to your environment, double-click a client entry in the display list. The "Edit connection" dialog appears. Figure 1-5 You can adjust the following values in the dialog: Display name of the client: File name File path File mode Entry-ID: , V2.0, 08/2018 9

10 Siemens AG 2018 All rights reserved 1 Introduction The TIA portal project Overview In order to use the S7 station as a TCP client, this application example provides you with a prepared TIA project with the following blocks: Function block "TcpClient" Data block "Parameters" Data block "SendArrayData" The call-up and program structure for the TCP client is defined as follows: Figure 1-6 Main Parameters TcpClient SendArray Data "TcpClient" The function block "TcpClient" has the following tasks: "Parameters" "SendArrayData" Establish and remove the TCP connection to the server. Send file name and data to the server. Monitor existing connection. The file name and all the information required to establish the TCP connection are stored in the data block. The data block contains the data to be sent as an "array of char". The size of the array can be set arbitrarily by a user constant. Entry-ID: , V2.0, 08/

11 Siemens AG 2018 All rights reserved 1 Introduction 1.3 Components used Hardware components This application example was created with these hardware and software components: Table 1-2 Components Qty. Article number Note CPU PN/DP 1 6ES AL01-0AB0 Alternative: All 1500s CPUs. CPU 1214C- DC/DC/DC 1 6ES AD40-0XB0 Alternative: All 1200s CPUs. CPU PN/DP 1 6ES EK14-0AB0 Alternative: All 300s CPUs with PN interface or S7-400 with PN interface. Programming device For the TCP file server and for configuring the S7 stations. The TIA portal must be installed. Software components Table 1-3 Components Qty. Article number Note TIA Portal V15 1 6ES7.. Is required for configuring the S7 stations. Microsoft Visual Studio Express 1 (Optional) Only to change the TCP file server code. We recommend a version from 2012 upwards. This Application Example consists of the following components: Table 1-4 Components _TCPFileserver_PROJ_V2_0.zip _TCPFileserver_DOC_v20_de.pdf Note This zipped file contains the STEP 7 project and the TCP file server (Visual Studio 2012 Project and executable file). This document. Preparation To use the example of application, you must prepare the following points: 1. Unzip the file " _TCPFileserver_ PROJ_V2_0.zip". You will find the STEP 7 project in this file as a "zip file" and the TCP file server as an executable ".exe" file. 2. Unzip the STEP 7 project into a directory of your choice. 3. To start the project in the TIA portal, double-click on the ap15 file, which is located in the just unpacked directory. 4. Assign an IP address from the IP band with the subnet mask to your programming device. For example, the IP address is Entry-ID: , V2.0, 08/

12 Siemens AG 2018 All rights reserved 2 Engineering 2 Engineering 2.1 Hardware configuration The following image shows the hardware configuration of the application: Figure 2-1 PS SIMATIC S SIMATIC S7-300 SIMATIC S PROFINET IE L+ (24 V) M (0 V) TCP file server The S7 CPUs of the project have the following IP addresses: S7-1500: S7-1200: S7-300: Note If you want to use a CPU other than the one specified in the STEP 7 project, then adapt the hardware configuration. Entry-ID: , V2.0, 08/

13 Siemens AG 2018 All rights reserved 2 Engineering 2.2 Components of the TIA Portal project Program Overview In order to use the S7 station as a TCP client, this application example provides you with a prepared TIA project with the following blocks: Function block "TcpClient" Data block "Parameters" Data block "SendArrayData" The call-up and program structure for the TCP client is defined as follows: Figure 2-2 Main Parameters TcpClient SendArray Data Entry-ID: , V2.0, 08/

14 Siemens AG 2018 All rights reserved 2 Engineering Interface description "TcpClient" Note The function block is designed for "optimized block access". Description The function block "TcpClient" is the most important component of this application example. The function block has the following tasks: Establish and remove the TCP connection to the server. Send file name and data to the server. Monitor existing connection. In order to accomplish the tasks above, the following state machines have been implemented in the program: State machine "TCP": Manage and monitor the TCP connection. State machine "SEND": Handle transmission process. The following figure shows you the call-up of the function block: Figure 2-3 Input parameters The following explains the input parameters of the "TcpClient" function block. Table 2-1 Parameters Data type Function enable BOOL The function block is activated with a positive edge. The function block is active as long as "enable" has the status "true". A negative edge terminates the function block and disconnects the TCP connection. sendfilename BOOL A positive edge sends the file name to the server. senddata BOOL A positive edge sends the data stream to the server. userdata "typeparameters" Data area of the TCP connection information and file name. Entry-ID: , V2.0, 08/

15 Siemens AG 2018 All rights reserved 2 Engineering Output parameters The following explains the output parameters of the "TcpClient" function block. Table 2-2 Parameters Data type Function tcpconnected BOOL True if the TCP connection has been established done BOOL True if the data or file name has arrived successfully at the server. It is only on "true" for one cycle. busy BOOL True while the data or file name is being sent to the server error BOOL True if there is an error. It is only on "true" for one cycle. statusid INT State that caused the error. The value is only valid for one cycle. status DWORD Error message. The value is only valid for one cycle. Input and output parameters The function block has the input and output parameter "data". The tag "data" contains the data to be sent. The tag "data" expects an "Array of Char" as data type. The size of the array is determined by the user constant "MAX_DAT_ARR_IDX". The user constant has a default value of "1000". Figure 2-4 Note You must define the size of the array using the user constant, since the size of the internal data buffer in the function block is also declared using this user constant. Note The data to be sent is sent internally to the server with an additional header of four bytes. The header consists of the data size and a telegram identifier. For example, if you want to send an array of 1000 Char characters, then the actual data size that arrives at the server is 1004 bytes. Entry-ID: , V2.0, 08/

16 Siemens AG 2018 All rights reserved 2 Engineering Data block "Parameters" Description Declaration The file name and all the information required to establish the TCP connection are stored in the data block. You can set these parameters according to your specifications. To structure the data clearly, the data type "typeparameters" was created. The following figure illustrates the declaration of the data block for the SIMATIC S7-1500/ SIMATIC S7-1200: Figure 2-5 The following table displays the parameters of the SIMATIC S7-1500/ SIMATIC S7-1200: Table 2-3 Parameters Data type Meaning hwidentifier HW_ANY HW ID of the PROFINET interface of the CPU connectionid CONN_OUC ID of the TCP connection localport UINT Local port number in the CPU remoteport UINT Remote port on the server. ipadressbroker Array[0..3] of INT IP address of the server, e.g. for the address ipadressbroker[0] equal to "192" ipadressbroker[1] equal to "168" ipadressbroker[2] equal to "0" ipadressbroker[3] equal to "1" Filename String[50] File name The server stores the data under this file name. Entry-ID: , V2.0, 08/

17 Siemens AG 2018 All rights reserved 2 Engineering The following figure illustrates the declaration of the data block for the SIMATIC S7-300: Figure 2-6 The following table displays the parameters of the SIMATIC S7-300: Table 2-4 Parameters Data type Meaning deviceid BYTE Slot designation of the PROFINET interface of the CPU. connectionid WORD ID of the TCP connection localport INT Local port number in the CPU remoteport INT Remote port on the server. ipadressbroker Array[0..3] of INT IP address of the server, e.g. for the address ipadressbroker[0] equal to "192" ipadressbroker[1] equal to "168" ipadressbroker[2] equal to "0" ipadressbroker[3] equal to "1" Filename String[50] File name The server stores the data under this file name Data block "SendArrayData" The data block contains the data to be sent as an "array of char". You can set the size of the array using the user constant "MAX_DAT_ARR_IDX". Figure 2-7 Entry-ID: , V2.0, 08/

18 Siemens AG 2018 All rights reserved 2 Engineering 2.3 Parameter assignment Adapting tags "Parameters" The S7 controller takes the role of the TCP client in this application example. The T-blocks are used to establish the connection to the TCP file server. Before you can test the application example, you must set the parameters for the TCP connection and the TCP data exchange to your specifications. All parameters that you can define yourself are in the "Parameters" data block. Above all, you must enter your own value for the following parameters: IPv4 address of the TCP file server. Remote port on which the TCP file server receives the messages. If the stored values of the remaining parameters do not match your environment, e.g. HW-ID of the CPU interface, then you must also adjust these parameters. "SendArrayData" The data block "SendArrayData" is the data store for the data to be sent. The character array in the data block is preset with a size of 1000 characters. You can change the array size using the user constant "MAX_DAT_ARR_IDX". You will find the user constant via the project tree in the menu "PLC tags> Standard tag table" (PLC tags> Standard tag table "). Figure 2-8 Fill in the "Array of Char" with the data you want to send to the TCP file server Saving and loading the STEP 7 project If you have modified the parameters in the data blocks, you must save and compile the project. Fix any errors that occur during compilation. Then download the STEP 7 project to the S7 controller. Entry-ID: , V2.0, 08/

19 Siemens AG 2018 All rights reserved 2 Engineering 2.4 Operation Requirements The following sections will show you how to test the sample application. In order to test the application example, the following points must be fulfilled: You have adapted and set all the necessary parameters in the STEP 7 project to your environment. You have loaded the project into the CPU. The CPU and the TCP file server are connected to each other via Ethernet and can be reached. You started the program "TCP-Fileserver" via the executable file "TCPFileServer.exe" and the user interface is visible Operating the TCP file server User interface You can operate the TCP file server via the graphical user interface. Figure 2-9 Defining the server port The server port is the port on which the TCP file server receives new TCP clients. You can change the server port. Enter the new port number in the "Server port" input box. Figure 2-10 Note The number of server ports must be entered in the TCP client as "Remote Port". Entry-ID: , V2.0, 08/

20 Siemens AG 2018 All rights reserved 2 Engineering Changing the default file path When TCP clients connect to the TC file server, the TCP client is assigned the default file path. You can change the default value. To change the directory, click on the button to the right of the input field and navigate to the desired directory. Figure 2-11 Starting the TCP file server To start the TCP file server, click on the corresponding button in the user interface. Figure 2-12 It can be seen whether the server has started in the following places: The gray rectangle between the Start Server and Stop Server buttons changes to green. Figure 2-13 A corresponding entry appears in the log output. Figure 2-14 Entry-ID: , V2.0, 08/

21 Siemens AG 2018 All rights reserved 2 Engineering Operating the TCP client STEP 7 project You operate the S7 controller as a TCP client via the STEP 7 project. To facilitate operation, use the "TcpClient" operating and monitoring table. Open the operating and monitoring table and go online. Figure 2-15 Establishing TCP connection To establish a TCP communication between CPU and TCP file server, set the tag "enabletcp" to the state "true". If positive, the "TcpClient" function block runs through its internal state machine and a TCP connection to the TCP file server is established. The output tag "tcpconnected" is set and signals an existing TCP connection. Figure 2-16 Entry-ID: , V2.0, 08/

22 Siemens AG 2018 All rights reserved 2 Engineering The TCP file server registers the S7 controller as a new TCP client and updates its connection list. The S7 controller displayed with its default values (See Section 1.2.2) and the status "connected". Figure 2-17 Note The TCP connection to the TCP file server remains only as long as the variable "enabletcp" has the status "true". To establish a TCP communication between the S7 controller and TCP file server, set the tag "enabletcp" to the state "true". Entry-ID: , V2.0, 08/

23 Siemens AG 2018 All rights reserved 2 Engineering Editing the TCP client If a new TCP client has registered with the TCP file server, then you can customize the settings of the TCP client according to your needs. Double-click on the list entry in the TCP file server. The "Edit connection" dialog appears. In the "Edit connection" dialog, you can change the following values: Display name of the client: File name File path File mode Click on the "OK" button to save the changes. Figure 2-18 The TCP client is displayed with the changed settings in the list. Figure 2-19 Entry-ID: , V2.0, 08/

24 Siemens AG 2018 All rights reserved 2 Engineering Transmitting the file name to the server You can transmit a file name to the server from the controller. In the data block "Parameters" in the data structure "userdata", edit the tag "filename" or use the operating and monitoring table. Write the value in the controller. Figure 2-20 To transfer the file name to the TCP file server, trigger the tag "sendfilename" with a positive edge. Figure 2-21 If no errors occurred during the transfer, then the file name was changed in the TCP file server for this TCP client. Figure 2-22 A new entry "Filename received: <file name>" is added to the log table of the TCP file server. Figure 2-23 Entry-ID: , V2.0, 08/

25 Siemens AG 2018 All rights reserved 2 Engineering Sending data The data that you want to send to the TCP file server is read from the "SendArrayData" data block. Figure 2-24 To send data to the TCP file server, trigger the tag "senddata". Figure 2-25 If no errors have occurred during the transfer, the TCP file server has received the data and saved it in the parameterized file. Open the file. There you will see the data transferred from the S7 CPU. Figure 2-26 A new entry "File text (<file name>) ->: <data>" is added to the log table of the TCP file server. Figure 2-27 Note If the data has not been transferred, then check your firewall and network adapter settings. The firewall must allow a connection via the configured ports and the IP addresses of the network adapters must be in the same subnet. Entry-ID: , V2.0, 08/

26 Siemens AG 2018 All rights reserved 2 Engineering Removing TCP connection To disconnect the TCP connection between the S7 controller and the TCP file server, set the tag "enabletcp" to "false". The output tag "tcpconnected" is reset. Figure 2-28 The TCP connection is terminated and the TCP client is displayed in the TCP file server as "disconnect". Figure 2-29 Entry-ID: , V2.0, 08/

27 Siemens AG 2018 All rights reserved 2 Engineering 2.5 Error handling If an error occurs in the program, the current status of the state machines and the cause of the error are written in the output parameters "statusid" and "status". "statusid" "status" The number of the state in which the error occurred is output at the output "statusid". The states are numbered and have the following meaning. Table 2-5 Value -2 TCP_ERROR -1 TCP_DISCONNECT 0 TCP_IDLE 1 TCP_PARAM 2 TCP_CONNECTING 3 TCP_CONNECTED 6 TCP_SEND_WAIT 4 TCP_SEND_FILENAME 5 TCP_SEND_DATA 7 TCP_RCV The output parameter "status" displays the error code: Table 2-6 Description statusid status Description Remedy -1 Status message from the "TDISCON" block 2 Status message from the "TCON" block 3 Status message from the "TRCV" block 4 Status message from the "TSEND" block 5 Status message from the "TSEND" block See manual - See manual See manual See manual - See manual - 5 W#16#8382 The data type of the data is incorrect. 7 W#16#7202 The data or file name was successfully sent to the server. 7 W#16#8382 The server reports an error that the data is incorrect. 7 W#16#8383 The server reports an error that the data length is incorrect. 7 W#16#8385 The server reports an error while writing the data to the file. Check the availability of the server. IP address, port, firewall. Check network connection The data must be in an array of char. Check data format. Check data length. Check file name and path in the server configuration. Entry-ID: , V2.0, 08/

28 Siemens AG 2018 All rights reserved 2 Engineering statusid status Description Remedy W#16#8389 The server reports that the identifier contained in the telegram is incorrect. Check identifier. Entry-ID: , V2.0, 08/

29 Siemens AG 2018 All rights reserved 3 Useful information 3 Useful information 3.1 Operating principle overview Complete overview The following overview shows the individual steps that take place between the S7- CPU and the TCP file server on the PC. In this application example, the S7 CPU sends data to the file server after a positive edge at the "sendfilename" (2) or "senddata" (3) input. Figure 3-1 Connect 1 Create 4 file S7-CPU PC File name TcpClient Send 3 data TCP file server HDD Connection data Table 3-1 Send 2 file name Write 5 data in file No. Action Note 1. Connection setup The "TcpClient" function block in the S7 CPU establishes a TCP connection to the TCP file server. For this, both sides need to know the IP address of each other and use the same port. The socket from the server must be open (for local networks, both IP addresses must be on the same subnet). 2. Sending the file name The file name is transferred in the TCP telegram. 3. Sending of data The data (Array of Char) is transmitted in the TCP telegram. 4. Creating the file Upon arrival of the new data, the TCP file server creates a new file (if a new combination of file path and file name exists). The server uses the last transmitted file name and a file path specified by the server administrator. 5. Write the data to the file The data is now written to the file. If you have selected the write mode "Append" on the server, then the data is appended to the file. If you have selected the write mode "Overwrite" on the server, then the existing file will be overwritten with the new data. Entry-ID: , V2.0, 08/

30 Siemens AG 2018 All rights reserved 3 Useful information Functionality in the S7-CPU (TCP client) Behavior from the application perspective The following is a graphic that explains the behavior of the "TcpClient" function block from the application view. The trapezoids correspond to user actions. Figure 3-2 Positive edge: Enable yes Does a connection exist? no Connect Error outputting yes no Error? Positive edge: sendfilename Positive edge: senddata Negative edge: Enable File name send Data Connection terminate Data send The state machines The state machine "TCP" is started if a positive edge was detected at the input parameter "enable". This state machine has the following functions: It controls the structure of the TCP connection It monitors the existing TCP connection for connection errors, e.g. cable breakage If an error has occurred or no positive edge was detected at the "enable" input parameter, it sets all static variables and the other state machines to a defined state. The state machine "TCP" contains the following states: TCP_IDLE TCP_PARAM TCP_CONNECTING TCP_CONNECTED Entry-ID: , V2.0, 08/

31 Siemens AG 2018 All rights reserved 3 Useful information TCP_DISCONNECT TCP_ERROR The meaning of the states is listed in the following table Table 3-2 IDLE Status TCP_PARAM TCP_CONNECTING TCP_CONNECTED TCP_DISCONNECT TCP_ERROR Description In "IDLE" state, all parameters are reset. The state machine waits in this state until it detects a positive edge at the input parameter "enable". As soon as a positive edge is applied to the input, the state machine is set to the "TCP_PARAM" state. All connection parameters are read in this state. The function block changes to the state "TCP_CONNECTING" without a switching condition. In this state, the TCP connection to the server is established. If the connection with "TCON" has been established successfully, the FB changes to the "TCP_CONNECTED" state and the output variable "tcpconnected" is set. The TCP connection persists until it is terminated with "TDISCON". If an error occurs during connection setup, the state machine switches to the "TCP_ERROR" state. In this state, the function module maintains the state until the following events occur: The "TRCV" block detects a connection abort, e.g. by the network cable being pulled out, and reports an error. The input parameter "enable" is reset and thus initiates the disconnection. If the "TRCV" block detects an error, the state machine changes to the "TCP_ERROR" state. The "TCP_CONNECTED" state is a prerequisite for the processing of the state machine "SEND". The TCP connection is disconnected in this state. If the "TDISCON" block detects an error, the state machine changes to the "TCP_ERROR" state. If an error occurs in the state machine "TCP", the state "TCP_ERROR" is the central point of contact. Here, the required parameters (static variables and output variables) are set or reset. In addition, the following actions are carried out: The error message of the T-block involved is transferred at the output "status". The number of the state in which the error occurred is output at the output "statusid" If there is already a TCP connection, it will be disconnected in advance. The output variable "tcpconnected" is reset. If an existing connection to the server has been interrupted, the FB starts an automatic connection attempt and is set to the "TCP_CONNECTING" state. If the FB detects an error during connection setup, the FB returns to the "TCP_IDLE" state. The state machine "SEND" is set to the state "TCP_SEND_WAIT". Entry-ID: , V2.0, 08/

32 Siemens AG 2018 All rights reserved 3 Useful information Note If an existing connection has been lost, e.g. by pulling the connecting cable, then the function block "TcpClient" is "self-healing". This means that the function module automatically starts a new connection attempt. If the function block throws an error during connection setup, the block reverts back to the "TCP_IDLE" state and remains there until a new positive edge is detected at the "enable" input parameter. State machine "SEND" The state machine "SEND" is automatically started when the state machine "TCP" reaches the state "TCP_CONNECTED". This state machine has the following functions: It waits for a trigger to send filename and data. It starts the send operation It waits for an acknowledgment of the server. The state machine "SEND" contains the following states TCP_SEND_WAIT TCP_SEND_FILENAME TCP_SEND_DATA TCP_RCV The meaning of the states is listed in the following table: Table 3-3 Status TCP_SEND_WAIT TCP_SEND_FILENAME TCP_SEND_DATA TCP_RCV Description In this state, the block remains until it detects a positive edge at the "sendfilename" or "senddata" input. If the "sendfilename" input has been triggered, then the block changes to the "TCP_SEND_FILENAME" state. If the "senddata" input has been triggered, the block changes to the "TCP_SEND_DATA" state. In this state, the file name is read in and the telegram is prepared for the server. The block then activates the send process. If the transmission was error-free, then the block changes to the state "TCP_RCV". In this state, the data is read and the telegram is prepared for the server. The block then activates the send process. If the transmission was error-free, then the block changes to the state "TCP_RCV". In this state, the block waits for the acknowledgment of the server and evaluates the response packet. The response packet may contain either an "OK" or an error message. If the server sends an error message, the cause of the error is output at the "status" output. In both cases, the block returns to the "TCP_SEND_WAIT" state. Entry-ID: , V2.0, 08/

33 Siemens AG 2018 All rights reserved 3 Useful information Functionality on the PC (TCP file server) The following graphic conceptually describes all possible processes within the TCP file server. The trapezoids correspond to user actions. Figure 3-3 Load GUI Close GUI Start logging Loading the configuration of known connections Connection name, file path or write mode changed Indicate port Save connection configuration Start server Stop server Accept connection requests Connection accepted? yes no no Data received? Update connection table File name received? no yes yes Does file exist? no Create file yes Write data to file Depending on write mode Update data table Entry-ID: , V2.0, 08/

34 Disconnection Communication Siemens AG 2018 All rights reserved Connection setup 3 Useful information 3.2 Interaction between TCP client and TCP file server Introduction The following section summarizes how the two software components "TcpClient" on the S7 side and "TCP file server" on the computer side interlock. Overview The graphic shows you which actions lead to which reactions in the entire project. For the abbreviations on the side of the TCP file server, there is a table below the graphic with paths to the corresponding methods. The abbreviations on the side of the S7 CPU describe the names of the called-up blocks. The state diagram shows the relationship between the "TcpClient" block on the S7 CPU and the TCP file server on a computer. At some states of the TCP client, relevant block calls are identified. Figure 3-4 Computer (TCP file server) S7-CPU (TCP client) Not connected TCON no TCP-SYN received? yes EO TCP handshake TCON TCON Send TCP-SYN CW Update connection [Data] TCR TTC no Succeeded? yes yes no TCON TSEND Send file name Received? Receive Communication ready TSEND CU [File name] Write data in file yes no Connection termination? yes Send data CU Update connection Disconnecting TDISCON Not connected Entry-ID: , V2.0, 08/

35 Siemens AG 2018 All rights reserved 3 Useful information Table 3-4 Abbreviation TCR TTC CW CU EO Method path TcpLib/ConnectionState/Read() TcpLib/TcpServer/ConnectionReady_Handler() ClientConnection/writeCSVToFile() ClientConnection/updateClientConnections() EchoServiceProvider/OnAcceptConnection() The table shows the method paths in the C# project to the abbreviations used in the above graphic. Entry-ID: , V2.0, 08/

36 Siemens AG 2018 All rights reserved 4 Appendix 4 Appendix 4.1 Service and Support Industry Online Support Do you have any questions or need assistance? Siemens Industry Online Support offers round the clock access to our entire service and support know-how and portfolio. The Industry Online Support is the central address for information about our products, solutions and services. Product information, manuals, downloads, FAQs, application examples and videos all information is accessible with just a few mouse clicks: Technical Support The Technical Support of Siemens Industry provides you fast and competent support regarding all technical queries with numerous tailor-made offers ranging from basic support to individual support contracts. Please send queries to Technical Support via Web form: SITRAIN Training for Industry We support you with our globally available training courses for industry with practical experience, innovative learning methods and a concept that s tailored to the customer s specific needs. For more information on our offered trainings and courses, as well as their locations and dates, refer to our web page: Service offer Our range of services includes the following: Plant data services Spare parts services Repair services On-site and maintenance services Retrofitting and modernization services Service programs and contracts You can find detailed information on our range of services in the service catalog web page: Industry Online Support app You will receive optimum support wherever you are with the "Siemens Industry Online Support" app. The app is available for Apple ios, Android and Windows Phone: Entry-ID: , V2.0, 08/

37 Siemens AG 2018 All rights reserved 4 Appendix 4.2 Links and Literature Table 4-1 No. \1\ Siemens Industry Online Support Topic \2\ Link to the article page of the application example \3\ 4.3 Change documentation Table 4-2 Version Date Change V2.0 08/2018 Complete revision V1.3 02/2017 Update of application on STEP 7 V14 V1.2 08/2016 Correction of the PC program when transferring data from the FB TcpClientBigSize. V1.1 10/2015 Extension to TcpClientBigSize-FB and improvements of the Windows application V1.0 04/2015 First version Entry-ID: , V2.0, 08/