- Legal information
- Document information
- 1Preface
- 2Tutorial: Creating a custom application with the SIMATIC Automation Tool SDK
- 2.1Introduction to the example application
- 2.2Example 1: Selecting a CPU from a network interface and changing the CPU operating mode
- 2.3Example 2: Reading and changing a CPU's IP address, subnet and gateway
- 2.4Example 3: Reading and writing a CPU's PROFINET name
- 2.5Example 4: Resetting a CPU to factory defaults
- 2.6Example 5: Updating a CPU's firmware
- 2.7Example 6: Backing up a CPU and restoring a CPU from a backup file
- 2.8Distributing an application to your user
- 3SIMATIC Automation Tool API for .NET framework
- 3.1Introduction to the API
- 3.2API software and version compatibility
- 3.3Designing a user interface application for fail-safe devices and safety-relevant operations
- 3.4Architectural overview
- 3.5Referencing the API in a user interface application
- 3.6Requirement for S7 communications
- 3.7Common support classes
- 3.8Common support interfaces
- 3.9Network class
- 3.10The HealthCheck class
- 3.11IProfinetDeviceCollection class
- 3.12IProfinetDevice interface
- 3.13IModuleCollection class and module properties
- 3.14ICPU interface
- 3.14.1Identifying CPU devices in an IProfinetDeviceCollection
- 3.14.2ICPU properties
- 3.14.3ICPU flags
- 3.14.4ICPU methods
- 3.14.4.1Protected CPUs and passwords
- 3.14.4.2SetPassword method
- 3.14.4.3SetProgramFolder method
- 3.14.4.4SetProgramPassword method
- 3.14.4.5ProgramUpdate method
- 3.14.4.6SetBackupFile method
- 3.14.4.7SetBackupFilePassword method
- 3.14.4.8Restore method (ICPU interface)
- 3.14.4.9Backup method (ICPU interface)
- 3.14.4.10DownloadRecipe method
- 3.14.4.11DeleteDataLog method
- 3.14.4.12DeleteRecipe method
- 3.14.4.13GetCurrentDateTime method
- 3.14.4.14GetDiagnosticsBuffer method
- 3.14.4.15MemoryReset method
- 3.14.4.16ResetToFactoryDefaults method
- 3.14.4.17SetOperatingState method
- 3.14.4.18SetCurrentDateTime method
- 3.14.4.19UploadDataLog method
- 3.14.4.20UploadRecipe method
- 3.14.4.21UploadServiceData method
- 3.14.4.22FormatMemoryCard method
- 3.14.4.23DetermineConfirmationMessage
- 3.14.5RemoteInterfaces properties
- 3.15The ICPUClassic interface
- 3.16IHMI interface
- 3.17IScalance interface
- 3.18ISNMPProfile interface
- 3.19SNMPProfile class
- 3.19.1SNMPProfile class properties
- 3.19.2SNMPProfile class methods
- 3.19.2.1SetProfileName
- 3.19.2.2SetSNMPVersion
- 3.19.2.3SetServerIP method
- 3.19.2.4SetServerPort method
- 3.19.2.5SetReadCommunity method
- 3.19.2.6SetWriteCommunity method
- 3.19.2.7SetUserName method
- 3.19.2.8SetContextName method
- 3.19.2.9SetSecurityLevel method
- 3.19.2.10SetAuthAlgorithm method
- 3.19.2.11SetPrivAlgorithm method
- 3.20IScalance and ISNMP firmware update code examples
- 3.21Exceptions
- 3.22API enumerations
- 3.22.1DataChangedType
- 3.22.2DeviceFamily
- 3.22.3ConfirmationType
- 3.22.4ErrorCode
- 3.22.5Language
- 3.22.6OperatingState
- 3.22.7OperatingStateREQ
- 3.22.8ProgressAction
- 3.22.9RemoteInterfaceType
- 3.22.10FeatureSupport
- 3.22.11ProtectionLevel
- 3.22.12ConfirmationType
- 3.22.13FailsafeOperation
- 3.22.14RemoteFolderType
- 3.22.15SNMPVersion
- 3.22.16SNMPSecurityLevel
- 3.22.17SNMPAuthAlgorithm
- 3.22.18SNMPPrivAlgorithm
- 3.22.19ScanErrorType
- 3.22.20HMITransferChannel
- 3.22.21BackupType
- 3.22.22HealthCheckResultType
- 3.23Network example
- Glossary
- Index
Combine search queries with whitespace
0-9
- 0-9
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
- K
- L
- M
- N
- O
- P
- Q
- R
- S
- T
- U
- V
- W
- X
- Y
- Z
- #
- 0-9
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
- K
- L
- M
- N
- O
- P
- Q
- R
- S
- T
- U
- V
- W
- X
- Y
- Z
- #
0-9
- 0-9
- A
- B
- C
- D
- E
- F
- G
- H
- I
- J
- K
- L
- M
- N
- O
- P
- Q
- R
- S
- T
- U
- V
- W
- X
- Y
- Z
- #
- 0-9
- A
- Adding items to a collection (API)
- API (application programming interface), architectural overview
- API (application programming interface), designing UI
- API (application programming interface), files and installation
- API (application programming interface), provided safety features
- API (application programming interface), S7 communications
- API (application programming interface), version compatibility
- B
- Backing up and restoring a CPU
- Backup (API method, ICPU interface)
- Backup (API method, IHMI interface)
- BackupType (API enumeration)
- C
- Changing CPU operating mode
- Changing IP address, subnet, and gateway
- Clear (API method)
- Color coding safety fields in UI development
- Color coding safety fields in UI development, CPU device icon
- Color coding safety fields in UI development, CPU password
- Color coding safety fields in UI development, device data
- Color coding safety fields in UI development, program folder
- Color coding safety fields in UI development, program password
- ConfirmationType (API enumeration )
- ConfirmationType (API enumeration)
- Connecting to a CPU on the network
- CopyUserData (API method)
- Creating a custom application with the SDK
- Creating a project that uses the SIMATIC Automation Tool API
- CriticalInternalErrorException
- CurrentNetworkInterface (API property)
- D
- DataChanged (API event)
- DataChangedEventArgs (API class)
- DataChangedType (API enumeration)
- Decentralized modules
- DeleteDataLog (API method)
- DeleteRecipe (API method)
- DetermineConfirmationMessage (API method)
- DeviceFamily (API enumeration)
- DiagnosticsItem (API class)
- Displaying CPU information on user interface
- DownloadRecipe (API method)
- E
- EncryptedString (API class)
- ErrorCode (API enumeration)
- Example network
- Example program, Backing up and restoring a CPU
- Example program, Changing CPU IP address, subnet, and gateway
- Example program, reading and writing PROFINET name
- Example program, Resetting CPU to factory defaults
- Example program, selecting CPU and changing operating mode
- Example program, Updating CPU firmware
- Examples, SNMP profiles, Version 1
- Examples, SNMP profiles, Version 2
- Examples, SNMP profiles, Version 3
- ExportDeviceDiagnostics (API method)
- ExportDeviceInformation (API method)
- ExportPCData (API method)
- F
- FailSafeOperation (API enumeration)
- FeatureSupport (API enumeration)
- FilterByDeviceFamily (API method)
- FilterOnlyCPUs (API method)
- FindDeviceByIP (API method)
- FindDeviceByMAC (API method)
- FirmwareUpdate (API method)
- FirmwareUpdate (API method, IScalance interface)
- FormatMemoryCard (API method)
- G
- GetCommunicationsTimeout (API method)
- GetCurrentDateTime (API method)
- GetDiagnosticsBuffer (API method, ICPU interface)
- GetDiagnosticsBuffer (API method, ICPUClassic interface)
- GetEmptyCollection (API method)
- GetEnumerator (API method)
- H
- Hamming codes
- HealthCheck (API class)
- HealthCheckResultType (API enumeration)
- HMITransferChannel (API enumeration)
- I
- IBaseDevice (API interface)
- ICPU (API interface)
- ICPU (API), feature flags
- ICPU (API), program update flags
- ICPU (API), properties
- ICPU (API), restore flags
- ICPUClassic (API interface)
- Identify (API method)
- IHardware (API interface)
- IHardwareCollection (API interface)
- IHMI (API interface)
- IHMI (API), feature flags
- IHMI (API), program update flags
- IHMI (API), properties
- IHMI (API), restore flags
- IModule (API interface)
- IModule (API), modules property and IModuleCollection class
- IModuleCollection (API interface)
- IModuleCollection (API), using
- InsertDeviceByIP (API method)
- InsertDeviceByMAC (API method)
- Inserting items into a collection (API)
- IProfinetDevice (API), collection items
- IProfinetDevice (API), properties
- IProfinetDeviceCollection (API class), count property
- IProfinetDeviceCollection class (API), [ ] property
- IProfinetDeviceCollection class (API), GetEnumerator method
- IProfinetDeviceCollection class (API), iterating collection items
- IRemoteFile (API interface)
- IRemoteFolder (API interface)
- IRemoteInterface (API interface)
- IRemoteInterface (API), properties
- IScalance (API interface)
- IScalance (API interface), methods
- IScalance (API interface), properties
- IScanErrorCollection (API class)
- IScanErrorEvent (API class)
- ISNMPProfile (API interface), method
- ISNMPProfile (API interface), properties
- J
- K
- L
- Language (API enumeration)
- license terms and conditions
- M
- MemoryReset (API method)
- N
- Network constructor (API)
- Network example
- Network interface, selecting
- O
- OperatingState enumeration (API)
- OperatingStateReq (API)
- P
- Password protection of CPUs (API)
- Programming guidelines using API
- ProgramUpdate (API method)
- ProgramUpdate (API method, IHMI interface)
- ProgressAction (API enumeration)
- ProgressChanged (API event)
- ProgressChangedEventArgs (API class)
- ProtectionLevel (API enumeration)
- Q
- QueryNetworkInterfaceCards (API method)
- R
- ReadFromStream (API method)
- Reading and writing a PROFINET name
- RefreshStatus (API method)
- RemoteFolderType (API enumeration)
- RemoteInterfaces (API)
- RemoteInterfaceType (API enumeration)
- Remove (API method)
- ResetCommunicationParameters (API method, IProfinetDevice interface)
- Resetting a CPU to factory defaults
- ResetToFactoryDefaults (API method)
- Restore (API method, ICPU interface)
- Restore (API method, IHMI interface)
- Result (API class)
- S
- Safety-relevant operations in UI design with the API
- ScanErrorType (API enumeration)
- ScanNetworkDevices (API method)
- Selecting an avalable network interface
- Serialization (API methods)
- SetAuthAlgorithm (API method, SNMPProfile class)
- SetBackupFile (API method)
- SetBackupFile (API method, IHMI interface)
- SetBackupFilePassword (API method)
- SetCommunicationsTimeout (API method)
- SetContextName (API method, SNMPProfile class)
- SetCurrentDateTime (API method)
- SetCurrentNetworkInterface (API method)
- SetIP (API method)
- SetOperatingState (API method)
- SetPassword (API method)
- SetPrivAlgorithm (API method, SNMPProfile class)
- SetProfile (API method, IScalance interface)
- SetProfileName (API method, SNMPProfile class)
- SetProfinetName (API method)
- SetProgramFolder (API method)
- SetProgramFolder (API method, IHMI interface)
- SetProgramPassword (API method)
- SetReadCommunity (API method, SNMPProfile class)
- SetSecurityLevel (API method, SNMPProfile class)
- SetServerIP (API method, SNMPProfile class)
- SetServerPort (API method, SNMPProfile class)
- SetSNMPVersion (API method, SNMPProfile class)
- SetTransferChannel (API method, IHMI interface)
- SetUserName (API method, SNMPProfile class)
- SetWriteCommunity (API method, SNMPProfile class)
- SNMP Version 1, API example
- SNMP Version 2, API example
- SNMP Version 3, API example
- SNMPAuthAlgorithm (API enumeration)
- SNMPPrivAlgorithm (API enumeration)
- SNMPProfile (API class), methods
- SNMPProfile (API class), properties
- SNMPSecurityLevel (API enumeration)
- SNMPVersion (API enumeration)
- T
- Tutorial, creating a custom application
- Tutorial, example program to back up and restore a CPU
- Tutorial, example program to change CPU IP address, subnet, and gateway
- Tutorial, example program to read and write PROFINET name
- Tutorial, example program to reset CPU to factory defaults
- Tutorial, example program to select CPU and change operating mode
- Tutorial, example program to update CPU firmware
- U
- Updating CPU firmware
- UploadDataLog (API method)
- UploadRecipe (API method)
- UploadServiceData (API method)
- V
- Validate (API method, ISNMPProfile interface)
- ValidateIPAddress (API method)
- ValidatePROFINETName (API method)
- W
- WriteToStream (API method)
- X
- Y
- Z
- #