Siemens SIMATIC S7 User Manual
  1. Manuals
  2. Brands
  3. Siemens Manuals
  4. Controller
  5. SIMATIC S7
  6. User manual

Siemens SIMATIC S7 User Manual

Simatic automation tool v2.1
Hide thumbs Also See for SIMATIC S7:
Table of Contents

Advertisement

Quick Links

See also: System Manual , Equipment Manual
SIMATIC Automation Tool V2.1 user
guide
SIMATIC
S7
SIMATIC Automation Tool V2.1
user guide
Manual
V2.1.1 07/2016
A5E33042676-AC
___________________
Preface
SIMATIC Automation Tool
___________________
overview
Prerequisites and
___________________
communication setup
___________________
Tool operations
___________________
Saving your device table
information
___________________
Menu, toolbar, and shortcut
key reference
___________________
SIMATIC Automation Tool
API for .NET framework
___________________
SIMATIC Automation Tool
device support
___________________
Network example and API
interfaces
1
2
3
4
5
6
7
A

Advertisement

Table of Contents
loading

Related Manuals for Siemens SIMATIC S7

Summary of Contents for Siemens SIMATIC S7

  • Page 1 ___________________ SIMATIC Automation Tool V2.1 user Preface guide SIMATIC Automation Tool ___________________ overview Prerequisites and ___________________ SIMATIC communication setup ___________________ Tool operations SIMATIC Automation Tool V2.1 ___________________ Saving your device table user guide information ___________________ Menu, toolbar, and shortcut key reference Manual ___________________ SIMATIC Automation Tool...
  • Page 2 Note the following: WARNING Siemens products may only be used for the applications described in the catalog and in the relevant technical documentation. If products and components from other manufacturers are used, these must be recommended or approved by Siemens. Proper transport, storage, installation, assembly, commissioning, operation and maintenance are required to ensure that the products operate safely and without any problems.

  • Page 3: Preface

    Siemens products that you are using, they can provide the fastest and most efficient answers to any problems you might encounter.
  • Page 4 Preface SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 5: Table Of Contents

    Table of contents Preface ..............................3 SIMATIC Automation Tool overview ......................9 Managing networks ........................9 Network access ........................13 Network options ........................14 .NET API (application interface) .dll file .................. 16 Prerequisites and communication setup ....................17 PG/PC Operating system requirement ................... 17 Installing the SIMATIC Automation Tool .................
  • Page 6 Table of contents Menu, toolbar, and shortcut key reference ..................... 59 Main menu ..........................59 5.1.1 File menu ..........................59 5.1.2 Edit menu ..........................60 5.1.3 Network menu ........................61 5.1.4 Tools menu ..........................62 5.1.5 Help menu ..........................64 Toolbar icons ..........................
  • Page 7 Table of contents 6.7.3.2 ProgressChanged event ......................95 IModuleCollection class and module properties ..............97 6.8.1 The IModuleCollection class ....................97 6.8.2 The IModule interface ......................98 The ICPU interface ......................... 99 6.9.1 Identifying CPU devices in an IProfinetDeviceCollection ............99 6.9.2 ICPU properties ........................
  • Page 8 Table of contents Network example and API interfaces ....................129 Network example ......................... 129 Index ..............................133 SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 9: Simatic Automation Tool Overview

    SIMATIC Automation Tool overview Managing networks Managing networks of SIMATIC devices After a control program is created and verified with the Siemens TIA Portal software, the SIMATIC Automation Tool can be used in the field for configuring, operating, maintaining, and documenting automation networks.
  • Page 10 SIMATIC Automation Tool overview 1.1 Managing networks SIMATIC device support The SIMATIC Automation Tool supports standard and fail-safe CPUs and I/O modules. The safety relevant operations Reset to factory defaults, Restore from backup file, and Program update are not allowed on fail-safe CPUs. For some devices, some of the SIMATIC Automation Tool operations are not supported.
  • Page 11 SIMATIC Automation Tool overview 1.1 Managing networks Example S7-1200 network installation Panel shop fabrication and initial program load ● Each CPU uses the same hardware configuration and control program ● The CPU PROFINET configuration uses "Set IP Address on the device" and "Set PROFINET device name on the device"...
  • Page 12 SIMATIC Automation Tool overview 1.1 Managing networks Field installation and operations ● Scan a network to find CPUs and modules ● Flash LEDs to identify a device ● Assign IP addresses and PROFINET names for each device, when you set up your network ●...

  • Page 13: Network Access

    SIMATIC Automation Tool overview 1.2 Network access Network access Communicating with Siemens devices PROFINET devices connected directly to a network are discovered by using the MAC (Media Access Control) address. A MAC address is unique to each device, cannot be changed, and is printed on the device.

  • Page 14: Network Options

    SIMATIC Automation Tool overview 1.3 Network options Note IP subnet mask assignment on a local network The PG/PC running the SIMATIC Automation Tool and devices connected to the local network must use the same subnet mask assignment. Network options Local and remote networks The following examples show local and remote networks that the SIMATIC Automation Tool can use.
  • Page 15 SIMATIC Automation Tool overview 1.3 Network options Example 2: S7-1200 remote network Example 3: S7-1200 combined local and remote networks SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 16: Net Api (Application Interface) .Dll File

    SIMATIC Automation Tool overview 1.4 .NET API (application interface) .dll file .NET API (application interface) .dll file The Microsoft .NET API used by the SIMATIC Automation Tool is documented in this user guide. You can create your own application software that uses the API to perform the same device operations as the SIMATIC Automation Tool.

  • Page 17: Prerequisites And Communication Setup

    Prerequisites and communication setup PG/PC Operating system requirement PG/PC operating systems The SIMATIC Automation Tool V2.1 supports the following operating systems. ● Windows 7 Home Premium SP1 (32 and 64 bit) ● Windows 7 Professional SP1 (32 and 64 bit) ●...

  • Page 18: Starting The Simatic Automation Tool

    ● Use the Windows Start button. – Click the Windows start button and "All Programs". – Click the "Siemens Automation" folder, then the "SIMATIC Automation Tool" folder, and finally "Automation Tool". ● Start the Windows command prompt (cmd.exe) and enter the executable file name and optional project parameter.
  • Page 19 Prerequisites and communication setup 2.4 CPU configuration requirements S7-1200 example configuration 1. Click the PROFINET port on the device configuration CPU image, to view the port parameters. 2. On the Properties tab, click the General tab to view the Ethernet addresses options. Click the SET IP address on the device option.
  • Page 20 Prerequisites and communication setup 2.4 CPU configuration requirements Note Default settings of PROFINET IP parameters When you create a new TIA portal project, the default PROFINET parameter options are set to "Set IP address in the project" and "Generate PROFINET device name automatically". With the default options, you cannot set IP addresses or PROFINET device names with the SIMATIC Automation Tool.

  • Page 21: Communication Setup

    Prerequisites and communication setup 2.5 Communication setup Communication setup Identifying the network interface card connected to your device network After you connect your PG/PC to a network, then you can use the Windows control panel to see the name of the network interface card. In the following example, S7-1200 CPUs are connected to a USB port on a PC running Windows 7.
  • Page 22 Start the SIMATIC Automation Tool, click on the Network Interface Card drop-down list, and select the network card that is connected to your Siemens device network. You may see different network cards from those shown in the following image, because the list shows the network interfaces that are available in your PG/PC.
  • Page 23 Prerequisites and communication setup 2.5 Communication setup Both options in the drop-list (auto and fixed) should work. However, some network hardware may require that you use only one of the settings to communicate efficiently. Try the simpler fixed selection without "auto" first. For example, the S7-1200 CPU can communicate at either 10 or 100 Mbit/s (half or full duplex).
  • Page 24 Prerequisites and communication setup 2.5 Communication setup SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 25: Tool Operations

    Tool operations CPU passwords If a CPU is password protected, this password must be entered in the SIMATIC Automation Tool to complete many operations. You provide the password in the main grid column titled Password. The SIMATIC Automation Tool prevents you from legitimating a connection to a fail-safe CPU using the fail-safe password.

  • Page 26: Scan A Network And Use The Device Table

    Tool operations 3.2 Scan a network and use the device table Scan a network and use the device table Basic operation The device table for a new SIMATIC Automation Tool project is empty. You can assign a network interface card, scan a network, and fill the device table automatically. The device table is filled with information collected by a network scan.
  • Page 27 Tool operations 3.2 Scan a network and use the device table Scan the network 1. Select Scan from the Network menu or click the Scan button on the toolbar. 2. The SIMATIC Automation Tool will fill a new device table or update an existing table with information from accessible devices.
  • Page 28 Tool operations 3.2 Scan a network and use the device table Expand the device rows and show local modules and decentralized I/O devices. Click the expand icon to expand a device row. Use the right-click menu or Edit menu to expand/collapse all levels.
  • Page 29 Collapse all rows in the Device column. Insert a new device row Delete selection or checked device(s) Refresh checked devices Open SIEMENS industry support web page for current row's article number. Check for latest device information and firmware up- dates.
  • Page 30 Tool operations 3.2 Scan a network and use the device table Filtering the displayed rows Filtering is supported on the Device, Device Type, and Article number columns. When the mouse cursor hovers over a column that supports filtering, the filter button appears in the column header.
  • Page 31 Tool operations 3.2 Scan a network and use the device table Event log The event log area is below the device table. When you select devices and start an operation, information about successful and unsuccessful results is displayed in the event log.

  • Page 32: Download New Ip, Subnet, And Gateway Addresses

    Tool operations 3.3 Download new IP, subnet, and gateway addresses Download new IP, subnet, and gateway addresses Change IP addresses Use the following steps to update the IP addresses. 1. Click the "IP Address" tab. 2. Click the left-side check box on devices to include in the operation. You can use the top check box, right-click shortcut menu, or the Edit menu for "Select All"...

  • Page 33: Download New Profinet Device Names

    Tool operations 3.4 Download new PROFINET device names Download new PROFINET device names Changing PROFINET device names PROFINET name rules Valid names follow the standard DNS (Domain Name System) naming conventions. A maximum of 63 characters is allowed. Valid characters are the lower case letters "a" through "z", the digits 0 through 9, the hyphen character (minus sign), and the period character.

  • Page 34: Set Cpus To Run Or Stop Mode

    Tool operations 3.5 Set CPUs to RUN or STOP mode Set CPUs to RUN or STOP mode Change CPUs to RUN mode Click the left-side check box on devices to include in the operation. You can use the top check box, right-click shortcut menu, or the Edit menu for "Select All" and "Unselect All"...
  • Page 35 Tool operations 3.5 Set CPUs to RUN or STOP mode Change CPUs to STOP mode Click the left-side check box on devices to include in the operation. You can use the top check box, right-click shortcut menu, or the Edit menu for "Select All"...

  • Page 36: Flash The Leds On Devices

    Tool operations 3.6 Flash the LEDs on devices Flash the LEDs on devices Locate a device by flashing LED lights The Flash button will flash the LEDs of selected devices. The Flash operation helps you physically locate which device has a specific MAC address. You can use the flash LEDs operation in RUN mode or STOP mode.

  • Page 37: Download New Programs To Cpus

    1. Run the SIMATIC Automation Tool and view the Tools>Options setting and note the path assignment for program update files. The default path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Programs. You can modify the path, if you prefer to use another folder. 2. Create folders under the programs path that is assigned in the Options dialog. Create one folder for each program and create a folder name that identifies the program.
  • Page 38 Tool operations 3.7 Download new programs to CPUs Download new programs to a CPU WARNING Verify that the CPU is not actively running a process before downloading a new program Installing a new program causes the CPU to go to STOP mode, which could affect the operation of an online process or machine.
  • Page 39 Example program update The default path in the options dialog for program update is C:\ProgramData\Siemens\SIMATIC Automation Tool\Programs. If you want five different programs available for download, then you must create and name five folders under the path that is assigned in the Options dialog. Copy the entire "SIMATIC.S7S"...

  • Page 40: Install New Firmware In Cpus And Modules

    Tool operations 3.8 Install new firmware in CPUs and modules Install new firmware in CPUs and modules Firmware updates TIA Portal A SIMATIC memory card can install firmware updates in CPUs and modules. Alternative firmware update methods include using the module information page of a CPU's built-in Web server, or using the TIA portal online and diagnostic functions.
  • Page 41 "Check for updates". The Siemens support web page selection is controlled by the article number displayed in a device table row. For example, a "Check for updates" command on article number 6ES7 215-1HG31-0XB0 links to the corresponding S7-1215C web support page (https://support.industry.siemens.com/cs/products/6es7215-1hg31-0xb0/cpu-1215c-...
  • Page 42 1. Run the SIMATIC Automation Tool and view the Tools>Options setting and note the folder assignment for firmware update files. The default path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Firmware. You can modify the default setting. 2. Copy all the .upd files you need to the firmware folder assigned by the Tools>Option command.
  • Page 43 Tool operations 3.8 Install new firmware in CPUs and modules Timeout error message due to slow communication with .upd file storage device If you see the following error message box, then more than 5 seconds has elapsed and the SIMATIC Automation Tool has not completed processing all the .upd files in the firmware storage folder.
  • Page 44 Tool operations 3.8 Install new firmware in CPUs and modules Example firmware update The default path for firmware update is C:\ProgramData\Siemens\SIMATIC Automation Tool\Firmware. ● If you want to have four different firmware versions available for downloading, then you must copy four different .upd files to the firmware subfolder.

  • Page 45: Backup And Restore Cpu Data

    Backup device New CPU data backup files are created and copied to the assigned folder. The default file path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Backup. The backup file name contains the date, time, and PLC name similar to TIA Portal backup file names. You can use these files in the SIMATIC Automation Tool Restore Device operation.
  • Page 46 SIMATIC Automation Tool. Backup files have the extension name "s7pbkp" that must exist or be copied to the backup file path assigned in the Tools>Options menu. The default file path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Backup. The cells in the columns "Restore" are used to enter the restore file name. You can create Backup files using the TIA Portal or the SIMATIC Automation Tool.

  • Page 47: Reset Cpus And Modules To Factory Default Values

    Tool operations 3.10 Reset CPUs and modules to factory default values 3.10 Reset CPUs and modules to factory default values Reset selected devices to factory default values You can reset selected devices to factory default values, except for the IP address. The IP address that exists before the operation is retained, so your network IP assignments are preserved.

  • Page 48: Reset Cpu Memory

    Tool operations 3.11 Reset CPU memory 3.11 Reset CPU memory Reset memory on selected CPUs Use the following steps to reset CPU memory on selected devices. Click the left-side check box on devices to include in the operation. You can use the top check box, right-click shortcut menu, or the Edit menu for "Select All"...

  • Page 49: Upload Service Data From Cpus

    When a CPU enters a defective state, information is logged in the CPU that you can upload. You can send the service data files to Siemens customer support and help determine the cause of a fault. A folder is created under the assigned Fault folder (Default path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Fault).
  • Page 50 Tool operations 3.12 Upload service data from CPUs Service data files The name of the folder is based on the date, time, and PLC name similar to the TIA Portal. Note Uploading service data files from password protected CPUs If a CPU is password protected, then you must provide the CPU's password to upload all the service data files.

  • Page 51: Set Time In Cpus

    Tool operations 3.13 Set time in CPUs 3.13 Set time in CPUs Set time in CPUs to current PG/PC time The Time button will set the time for selected CPUs to your current PG/PC time. Time transformation information for time zone and daylight saving time is not changed and must be modified in the TIA Portal Project.

  • Page 52: Read Diagnostic Buffer In A Cpu

    Tool operations 3.14 Read diagnostic buffer in a CPU 3.14 Read diagnostic buffer in a CPU CPU diagnostic buffer The CPU diagnostics buffer contains an entry for each diagnostic event. Each entry includes the date and time the event occurred, an event category, and an event description. The entries are displayed in chronological order with the most recent event at the top.

  • Page 53: Execution Order Of Operations

    Tool operations 3.15 Execution order of operations 3.15 Execution order of operations Operations are initiated with a toolbar button or menu item. For each toolbar button press, a single operation is added to the operations queue, for each selected device row. For example, if 20 different CPUs are selected and the RUN button is pressed, then 20 RUN operations are added to the queue.
  • Page 54 Tool operations 3.15 Execution order of operations SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 55: Saving Your Device Table Information

    File>Open command to restore this project's device table. ● The .sat file save path is assigned by the Tools>Options command. The default path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Projects. You can modify this path ● You must provide a valid password to save a SIMATIC Automation Tool .sat project file.

  • Page 56: Import/Export - Device Table Loaded From/Stored In Open .Csv Format

    SIMATIC Automation Tool device table. The .csv file path for import and export operations is assigned by the Tools>Options command. The default path is C:\ProgramData\Siemens\SIMATIC Automation Tool\Projects. You can modify this path. SIMATIC Automation Tool V2.1 user guide...
  • Page 57 Saving your device table information 4.2 Import/Export - Device table loaded from/stored in open .csv format Export example The following image shows the text format of a .csv file exported from the SIMATIC Automation Tool. The following image shows the same text file opened in Microsoft Excel. SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...
  • Page 58 Saving your device table information 4.2 Import/Export - Device table loaded from/stored in open .csv format SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 59: Menu, Toolbar, And Shortcut Key Reference

    Menu, toolbar, and shortcut key reference Main menu 5.1.1 File menu Tool Menu command Description icon Creates a new SIMATIC Automation Tool project. Open An "Open" dialog is displayed that can browse to a folder, select an .sat project file, and provide a password to open an encrypted project file. The default path is assigned in the Tools>Options dialog Save The device table data is saved in a .sat file.

  • Page 60: Edit Menu

    Delete current selection in the device table. Selection • Refresh Devices F5 Refresh the checked devices. Check for Updates Open the Siemens support Internet web page for the selected device. SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 61: Network Menu

    Menu, toolbar, and shortcut key reference 5.1 Main menu 5.1.3 Network menu Tool Menu Description icon command Scan Scan the selected network interface for accessible CPUs and mod- ules. Download Download data entered in the SIMATIC Automation Tool to PLCs on the network.

  • Page 62: Tools Menu

    Menu, toolbar, and shortcut key reference 5.1 Main menu 5.1.4 Tools menu Tool Menu Description icon command Options Set file paths for the SIMATIC Automation Tool Path for SIMATIC Automation Tool project files • Path for CPU firmware update files •...
  • Page 63 Menu, toolbar, and shortcut key reference 5.1 Main menu Default options Note Communication problems with the SIMATIC Automation Tool For example, you send an operation command to multiple devices, but a device does not complete the operation and a communication error displayed for that CPU. However, other devices are communicating and executing the operation as expected.

  • Page 64: Help Menu

    Menu, toolbar, and shortcut key reference 5.1 Main menu 5.1.5 Help menu Tool Menu Description icon command View user guide Open the SIMATIC Automation Tool user guide. The user guide is in .pdf format and you must have .pdf viewer software installed to view the user guide.

  • Page 65: Toolbar Icons

    Menu, toolbar, and shortcut key reference 5.2 Toolbar icons Toolbar icons Tool Description icon New: Create a new SIMATIC Automation Tool project file with the ".sat" file name extension. Open: Display an "Open" dialog that can browse to a folder, select a project file, and provide a password to open the encrypted project file.

  • Page 66: Shortcut Keys

    Menu, toolbar, and shortcut key reference 5.3 Shortcut keys Shortcut keys CTRL+PgUp Switches between tabs, from left to right CTRL+PgDn Switches between tabs, from right to left CTRL+A Selects the entire table CTRL+C Copies the selected cells CTRL+O Displays the project open dialog to open a new project file CTRL+S Displays the Save As dialog CTRL+V...

  • Page 67: Simatic Automation Tool Api For .Net Framework

    SIMATIC Automation Tool API for .NET framework API Introduction API (Application Programming Interface) The SIMATIC Automation Tool API allows you to create custom applications based on the functionality available in the SIMATIC Automation Tool application. A custom application can combine operations in a specific sequence and create workflows that are optimized for your industrial automation network.

  • Page 68: Architectural Overview

    SIMATIC Automation Tool API for .NET framework 6.2 Architectural overview Architectural overview Networks The .NET class Network is used to perform functions using a network interface card (NIC) installed on a PG/PC. The Network class is used to scan for available interface cards, and to select the interface card to use.
  • Page 69 SIMATIC Automation Tool API for .NET framework 6.2 Architectural overview ● IProfinetDevice methods – RefreshStatus (Page 87) – FirmwareUpdate (Page 88) – FlashLED (Page 90) – Reset (Page 91) – SetIP (Page 92) – SetProfinetName (Page 93) ● IProfinetDevice events (Page 94) ●...

  • Page 70: Referencing The Api In A Customer Application

    Visual Studio solution. In any source file where the API classes are referenced, you must add the following using statement referencing the API namespace. using Siemens.Automation.AutomationTool.API; In order to compile any of the code samples in this document, the correct statement using must be present in the same source file (*.cs) as the example code.

  • Page 71: Common Support Classes

    SIMATIC Automation Tool API for .NET framework 6.4 Common support classes Common support classes 6.4.1 The EncryptedString class Before describing the operations available through the API, it is important to have an understanding of some common classes that are used in most of the code examples. The EncryptedString class Many API operations require a legitimized connection to an S7 CPU.

  • Page 72: The Fail-Safe Password

    SIMATIC Automation Tool API for .NET framework 6.4 Common support classes 6.4.2 The Fail-Safe password You are not allowed to legitimize a connection to an S7 CPU using the fail-safe password. If you specify a fail-safe password for any method that accepts a password, the SIMATIC ICPU Automation Tool API method will fail and return the error: ErrorCode.LegitimizationFailsafeLevelNotAllowed...

  • Page 73: The Network Class

    SIMATIC Automation Tool API for .NET framework 6.5 The Network class The Network class 6.5.1 Network constructor The .NET class performs functions using a network interface card (NIC) installed on Network the PG/PC. The class is used to scan for available interface cards and to select the Network interface card that communicates with the industrial network.

  • Page 74: Querynetworkinterfacecards Method

    SIMATIC Automation Tool API for .NET framework 6.5 The Network class 6.5.2 QueryNetworkInterfaceCards method Return type Method name Result QueryNetworkInterfaceCards Parameters Name Data type Parameter type Description aInterfaces List<string> A collection of all the network interface cards on the PG/PC listed by name.

  • Page 75: Setcurrentnetworkinterface Method

    SIMATIC Automation Tool API for .NET framework 6.5 The Network class 6.5.3 SetCurrentNetworkInterface method Return type Method name Result SetCurrentNetworkInterface Parameters Name Data type Parameter type Description strInterface string The name of the network interface to use. Normally this will be one of the names returned from the method.

  • Page 76: Scannetworkdevices Method

    SIMATIC Automation Tool API for .NET framework 6.5 The Network class 6.5.5 ScanNetworkDevices method Return type Method name Result ScanNetworkDevices Parameters Name Data type Parameter type Description strFile IProfinetDeviceCollection A collection containing an IProfinetDe- element for each accessible device vice on the industrial network.

  • Page 77: The Iprofinetdevicecollection Class

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class The IProfinetDeviceCollection class 6.6.1 Iterating items in the collection method outputs an object of type . This ScanNetworkDevices IProfinetDeviceCollection class provides the ability to iterate the items in the collection in multiple ways. It also provides methods to "filter"...

  • Page 78: Filtering Items In The Collection

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class 6.6.2 Filtering items in the collection 6.6.2.1 Collection items The collection will contain an item for each device on the industrial Ethernet network. The collection may contain devices from different multiple product families (i.e S7-1200, S7-1500, ET200S, etc).

  • Page 79: Filteronlycpus Method

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class 6.6.2.3 FilterOnlyCPUs method The SIMATIC Automation Tool API supports many operations that are only allowed for CPUs. For this reason, it is useful to filter the collection to include only the CPUs discovered on the network.

  • Page 80: Finding A Specific Device In The Collection

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class 6.6.3 Finding a specific device in the collection 6.6.3.1 FindDeviceByIP method You can search for a specific device in the collection. The following method support this workflow. Two versions of this method are provided, one allows the IP address to be represented as a string, and the other accepts the IP address as an unsigned integer value.

  • Page 81: Finddevicebymac Method

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class 6.6.3.2 FindDeviceByMAC method method can search for a device with a specific MAC address. FindDeviceByMAC Two versions of this method are provided, one allows the MAC address to be represented as a string, and the other accepts the MAC address as an unsigned long integer value.

  • Page 82: Serialization

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class 6.6.4 Serialization 6.6.4.1 Transferring a collection to/from an external data file The following methods are provided to enable serializing and transfer of a collection's contents to/from an external data file. These methods are used by the SIMATIC Automation Tool application to support user project files.

  • Page 83: Readfromstream Method

    SIMATIC Automation Tool API for .NET framework 6.6 The IProfinetDeviceCollection class 6.6.4.3 ReadFromStream method This method is used to re-create the collection from a previously-created serialization file. The following example shows the usage of this method: Return type Method name Result ReadFromStream Parameters...

  • Page 84: The Iprofinetdevice Interface

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface The IProfinetDevice interface 6.7.1 IProfinetDevice properties Each item in the collection is represented by the IProfinetDeviceCollection IProfinetDevice interface. This interface provides access to the data and operations that are common to all devices directly connected to the industrial network.
  • Page 85 SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface Property Name Return Type Description uint The IP Address of the device, represented as an unsigned integer. The encoded IP Address uses one byte to represent each decimal value in the IP Address.
  • Page 86 SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface Property Name Return Type Description SubnetMask uint The subnet mask of the device, represented as an unsigned integer. The encoded subnet mask uses one byte to represent each decimal value in the address.

  • Page 87: Iprofinetdevice Methods

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.2 IProfinetDevice methods 6.7.2.1 RefreshStatus method Return type Method name Result RefreshStatus Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required When the collection is created by calling the...

  • Page 88: Firmwareupdate Method

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.2.2 FirmwareUpdate method Return type Method name Result FirmwareUpdate Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required.
  • Page 89 SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface Using the method, it is also possible to update the firmware for a module on FirmwareUpdate a central station. The following code shows how to search for a CPU at a specific address and then searches the modules on that CPU for a specific article number.

  • Page 90: Flashled Method

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.2.3 FlashLED method Return type Method name Result FlashLED This method flashes the LED on a specific network device. The flashing LED helps identify the physical location of the device. The following example flashes the LED for the device that uses the IP address 192.168.0.1.

  • Page 91: Reset Method

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.2.4 Reset method Return type Method name Result Reset This method is used to reset a device to its factory settings. The following example calls the method for a device at a specific IP address. Reset uint targetIPAddress = 0xC0A80001;...

  • Page 92: Setip Method

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.2.5 SetIP method Return type Method name Result SetIP Parameters Name Data type Parameter type Description uint New encoded IP address nSubnet uint New encoded subnet address nGateway uint New encoded gateway address This method is used to set or modify the IP address of a device.

  • Page 93: Setprofinetname Method

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.2.6 SetProfinetName method Return type Method name Result SetProfinetName Parameters Name Data type Parameter type Description strName string New name for the PROFINET station This method is used to set (or modify) the PROFINET station name for the device. For this operation to be successful, the device port must be configured with the "Set PROFINET device name on the device option".

  • Page 94: Iprofinetdevice Events

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.3 IProfinetDevice events 6.7.3.1 DataChanged event The DataChanged event is supported on the IProfinetDevice interface. This event allows the program to monitor whether changes have occurred to a given device on the network, due to other operations through the API.

  • Page 95: Progresschanged Event

    SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface 6.7.3.2 ProgressChanged event event is supported on the interface. ProgressChanged IProfinetDevice This event allows the program to monitor the progress of methods that take a long time. is one example of such a method. FirmwareUpdate To utilize the event, an event handler is attached to the event.
  • Page 96 SIMATIC Automation Tool API for .NET framework 6.7 The IProfinetDevice interface The ProgressChangedEventArgs class event handler will be passed a object. This ProgressChanged ProgressChangedEventArgs object has the following properties: Property Name Return Type Description Action ProgressAction A description of the current action. See also ProgressAction enumeration (Page 119) Cancel bool...

  • Page 97: Imodulecollection Class And Module Properties

    SIMATIC Automation Tool API for .NET framework 6.8 IModuleCollection class and module properties IModuleCollection class and module properties 6.8.1 The IModuleCollection class interface provides information about any modules (signal modules, IProfinetDevice signal boards, CMs, CPs, etc) plugged on the station. The Modules property returns a collection of these modules.

  • Page 98: The Imodule Interface

    SIMATIC Automation Tool API for .NET framework 6.8 IModuleCollection class and module properties 6.8.2 The IModule interface Each module on the station is represented as an interface. This interface provides a IModule subset of the properties available for a device. interface provides no methods.

  • Page 99: The Icpu Interface

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface The ICPU interface 6.9.1 Identifying CPU devices in an IProfinetDeviceCollection As discussed earlier, the method is called to generate an ScanNetworkDevices . This collection contains an item for every accessible device on IProfinetDeviceCollection the industrial network.

  • Page 100: Icpu Properties

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.2 ICPU properties interface extends by adding the following properties. These ICPU IProfinetDevice properties are read-only. To ensure they will return the current information, your code should first call the RefreshStatus method Property Name Return Type Description...

  • Page 101: Backup Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.2 Backup method Return type Method name Result Backup Parameters Name Data type Parameter type Description Password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required.

  • Page 102: Getcurrentdatetime Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.3 GetCurrentDateTime method Return type Method name Result GetCurrentDateTime Parameters Name Data type Parameter type Description Password EncryptedString This method opens a legitimized connec- tion to the device. Therefore a password may be required.

  • Page 103: Getdiagnosticsbuffer Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.4 GetDiagnosticsBuffer method Return type Method name Result GetDiagnosticsBuffer Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required.

  • Page 104: Getoperatingstate Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface The DiagnosticsItem class method returns a collection of objects. GetDiagnosticsBuffer DiagnosticsItem This class defines the following members: Member name Data type Description TimeStamp System.DateTime Time the diagnostic event was logged. State Byte Ingoing/Outgoing...

  • Page 105: Memoryreset Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.6 MemoryReset method Return type Method name Result MemoryReset Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore a password may be required This method performs a memory reset on the CPU.

  • Page 106: Programupdate Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.7 ProgramUpdate method Return type Method name Result ProgramUpdate Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required strPath string...

  • Page 107: Resettofactory Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.8 ResetToFactory method Return type Method name Result ResetToFactory Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required This method resets a CPU to its factory defaults.

  • Page 108: Restore Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.9 Restore method Return type Method name Result Restore Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required strFile string...

  • Page 109: Setoperatingstate Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.10 SetOperatingState method Return type Method name Result SetOperatingState Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required nRequestState OperatingStateREQ...

  • Page 110: Setcurrentdatetime Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.11 SetCurrentDateTime method Return type Method name Result SetCurrentDateTime Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required time System.DateTime...

  • Page 111: Uploadservicedata Method

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.3.12 UploadServiceData method Return type Method name Result UploadServiceData Parameters Name Data type Parameter type Description password EncryptedString This method opens a legitimized connec- tion to the device. Therefore, a password may be required strPath string...

  • Page 112: Remoteinterfaces Properties

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.4 RemoteInterfaces properties 6.9.4.1 Decentralized I/O modules Each CPU may support multiple decentralized I/O interfaces. Information about the devices attached on these remote interfaces is available through the property. RemoteInterfaces To access information about decentralized IO, it is first necessary to call the RefreshStatus...

  • Page 113: Iremoteinterface Properties

    SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface 6.9.4.2 IRemoteInterface properties interface supports the following properties. These properties are read- IRemoteInterface only. Property Name Return Type Description Devices List<IBaseDevice> A list of any decentralized I/O stations connected to this re- mote interface InterfaceType RemoteInterfaceType...
  • Page 114 SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface FirmwareVersion string The current firmware version of the device HardwareID uint The unique identifier for every device and module in the sta- tion. This is used as the unique identifier when executing a FirmwareUpdate.
  • Page 115 SIMATIC Automation Tool API for .NET framework 6.9 The ICPU interface Using the Devices property of the , it is possible to inspect all the stations IRemoteInterface on the decentralized network. To extend the earlier example: retVal = myNetwork.ScanNetworkDevices(out scannedDevices); if (!retVal.Succeeded) return;...

  • Page 116: Enumerations

    SIMATIC Automation Tool API for .NET framework 6.10 Enumerations 6.10 Enumerations 6.10.1 DataChangedType This enumeration defines the possible argument values for the DataChangedEventHandler (Page 94). OperatingState RackInformation 6.10.2 DeviceFamily This enumeration specifies the product family for a hardware item. CPU1200 CPU1500 ET200AL ET200ECO...

  • Page 117: Errorcode

    SIMATIC Automation Tool API for .NET framework 6.10 Enumerations 6.10.3 ErrorCode This enumeration has all the possible return values for a Result object. There are two categories of values. The following values are only returned from a legitimized CPU connection: AccessDenied ServiceTimeout Disconnected...

  • Page 118: Operatingstate

    SIMATIC Automation Tool API for .NET framework 6.10 Enumerations UpdateProgramVersionGreaterPLCVersion DeviceNotOnNetwork FirmwareFileNotCompatible FirmwareModuleDeactivated FirmwareModuleMaintenanceRequired FirmwareModuleMaintenanceDemanded FirmwareModuleError FirmwareModuleNotReachable FirmwareModuleUnknown FirmwareModuleIOnotAvailable FirmwareModuleNotAccepted FirmwareIDNotFound FailsafeAccessNotAllowed 6.10.4 OperatingState This enumeration defines the possible states that can be returned from a call to the GetOperatingState (Page 104) method. NotSupported StopFwUpdate StopSelfInitialization...

  • Page 119: Progressaction

    SIMATIC Automation Tool API for .NET framework 6.10 Enumerations 6.10.6 ProgressAction This enumeration defines the possible argument values that can be sent to a ProgressChangedEventHandler (Page 95). Invalid Connecting Reconnecting Disconnecting Initializing Updating Processing Downoading Uploading Resetting Rebooting Verifying Finished 6.10.7 RemoteInterfaceType This enumeration defines the possible states that can be returned from a call to the...

  • Page 120: Featuresupport

    SIMATIC Automation Tool API for .NET framework 6.10 Enumerations 6.10.8 FeatureSupport The SIMATIC Automation Tool provides this enumeration to indicate what features each device supports. Uninitialized BackupAllowed ChangeModeAllowed FailsafeSupported FirmwareUpdateAllowed MemoryResetAllowed PasswordAllowed ProgramUpdateAllowed ResetToFactoryAllowed NotFailsafe RestoreAllowed To test whether a device supports a given feature, compare the value of the appropriate property with the value defined for that feature.

  • Page 121: Simatic Automation Tool Device Support

    SIMATIC Automation Tool device support Unrecognized firmware versions and devices The device support tables show the correspondence between SIMATIC Automation Tool V2.1, SIMATIC device model, possible firmware versions, and supported tool operations. If you connect an unrecognized SIMATIC device on your network, then there are two possibilities.

  • Page 122: S7-1500 Cpu Support

    SIMATIC Automation Tool device support 7.3 S7-1500 CPU support S7-1500 CPU support S7-1500 operation support and firmware version A check mark (✓) means that the operation is supported. Standard CPU models have only the firmware version number in the column header. Fail-Safe CPU models have "Fail-Safe" in the column header.

  • Page 123: Et 200Sp Cpu Support (Distributed I/O Controller Based On Et 200Sp And S7-1500)

    SIMATIC Automation Tool device support 7.4 ET 200SP CPU support (Distributed I/O controller based on ET 200SP and S7-1500) ET 200SP CPU support (Distributed I/O controller based on ET 200SP and S7-1500) ET 200SP CPU operation support and firmware version A check mark (✓) means that the operation is supported.

  • Page 124: Et 200Sp Support (Profinet I/O)

    SIMATIC Automation Tool device support 7.5 ET 200SP support (PROFINET I/O) ET 200SP support (PROFINET I/O) ET 200SP operation support and firmware version A check mark (✓) means that the operation is supported. ET 200SP V1.0 V1.1 V2.1 V2.2 V3.0 V3.1 V3.2 Scan for devices...

  • Page 125: Et 200Al Support (Profinet I/O)

    SIMATIC Automation Tool device support 7.7 ET 200AL support (PROFINET I/O) ET 200AL support (PROFINET I/O) ET 200AL operation support and firmware version A check mark (✓) means that the operation is supported. ET 200AL V1.0 Scan for devices ✓ Flash LED ✓...

  • Page 126: Et 200S Support (Profinet I/O)

    SIMATIC Automation Tool device support 7.8 ET 200S support (PROFINET I/O) ET 200S support (PROFINET I/O) ET 200S operation support and firmware version A check mark (✓) means that the operation is supported. ET 200S V3.x V5.x V6.x V7.x Scan for devices ✓...

  • Page 127: Et 200M Support (Profinet I/O)

    SIMATIC Automation Tool device support 7.9 ET 200M support (PROFINET I/O) ET 200M support (PROFINET I/O) ET 200M operation support and firmware version A check mark (✓) means that the operation is supported. ET 200M V2.x V3.x V4.x Scan for devices ✓...

  • Page 128: Et 200Pro Support (Profinet I/O)

    SIMATIC Automation Tool device support 7.11 ET 200pro support (PROFINET I/O) 7.11 ET 200pro support (PROFINET I/O) ET 200pro operation support and firmware version A check mark (✓) means that the operation is supported. ET 200SP V2.x V4.x V5.x V6.x V7.x Scan for devices ✓...

  • Page 129: A.1 Network Example

    Network example and API interfaces Network example This example shows a TIA Portal network configuration and the API interfaces that represent the networked devices. Assume that all the devices in the top row (PLC_1, IO device_1, and PLC_2) are connected to an external Ethernet network (not shown), and so can be directly accessed by the SIMATIC Automation Tool API.
  • Page 130 Network example and API interfaces A.1 Network example The following diagram shows the same network configuration, and the hardware devices on the network. SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...
  • Page 131 Network example and API interfaces A.1 Network example In the diagram above, the "lollipop" notation shows which SIMATIC Automation Tool API interface class best represents each network component. ● CPUs directly connected to the external network are represented by the interface ICPU ●...
  • Page 132 Network example and API interfaces A.1 Network example SIMATIC Automation Tool V2.1 user guide Manual, V2.1.1 07/2016, A5E33042676-AC...

  • Page 133: Index

    Index DataChangedType (API), 116 Decentralized modules, 112 Device support ET 200AL, 125 API (application interface) ET 200eco, 127 Architectural overview, 68 ET 200M, 127 AutomationToolAPI.dll, 16, 70 ET 200MP, 124 version compatibility, 67 ET 200pro, 128 Automation tool overview, 9 ET 200S, 126 ET 200SP, 124 ET 200SP CPU, 123...
  • Page 134 SetCurrentNetworkInterface method (API), 75 SetIP method (API), 92 SetOperatingState method (API)y, 109 SetProfinetName method (API), 93 Network Shortcut keys, 66 access, 13 Siemens technical support, 3 options, 14 STOP mode, 34 Network constructor (API), 73 Support, 3 Network example, 129 Technical support, 3...

Table of Contents