This library aims to wrap the Siemens PLCSIM Advanced API for easy usage in simulation applications.
Currently, only Version 5 of the API is being supported!
This library is still WIP and not complete yet.
In order to build the library or use the package, you need to have PLCSIM Advanced installed and add a reference to it's DLL.
You will need to add an reference to the Siemens.Simatic.Simulation.Runtime.Api.x64.dll, normally found in C:\Program Files (x86)\Common Files\Siemens\PLCSIMADV\API\5.0.
You might need to update the reference path for the Siemens.Simatic.Simulation.Runtime.Api.x64.dll, normally found in C:\Program Files (x86)\Common Files\Siemens\PLCSIMADV\API\5.0.
This library uses the PLCSIM Advanced API from Siemens.
All rights about PLCSIM belong to Siemens.
As the library is still at a very early state, there is no documentation yet.
I suggest looking at the included example application as well as at the library's source code - it shouldn't be hard to understand.
The basic usage consists of:
- Creating an
PlcSimAdvInstanceinstance where you can specify a name, a CPU and the communication interface. - Set the instance's
IsSendSyncEventInDefaultModeEnabledproperty to true, to be notified after each program cycle of the virtual controller. - Handle the cycle's completion by subscribing to the instance's
SyncPointReachedevent. a. Read the PLC's output variables. b. Compute the outputs with your simulation logic. c. Write to the PLC's input variables. - Done!
The wrapper will automatically update the tag list on the startup of the CPU.
Reading output variables can be done using e.g. bool result = ReadBool(string tagName);
Writing to input variables can be done using e.g. WriteBool(string tagName, bool value);
The repository includes an example application - the Siemens application example 'SIMATIC S7-PLCSIM Advanced: Co - Simulation via API'. When building the example application, make sure your reference to the API dll is set correctly (see Read first).
To use this example, you will have to download the TIA Portal project, download the plc program to the virtual controller once it's powered on and run the HMI simulation.
All rights and code of this application example / the cosimulation class belong to Siemens!
You can acquire this library either directly via the NuGet package manager or by downloading it from the NuGet Gallery.
Feel free to reach out!
- Implementing the whole api.
- Add 'easy' functions that perform multiple steps at once (setup -> power on -> run).
This library is MIT licensed.