Skip to content

Latest commit

 

History

History
114 lines (91 loc) · 7.99 KB

README.md

File metadata and controls

114 lines (91 loc) · 7.99 KB
Raw

CoCPN-Sim

This is the CoCPN-Sim simulation framework. It enables joint simulations of control systems and the networks they rely on. The different components are located in git submodules. Please consult the documentation on git-submodule in order to learn how to use them.

CoCPN-Sim is developed by the members of the project CoCPN: Cooperative Cyber Physical Networking from the Institute of Telematics (TM) and the Intelligent Sensor-Actuator-Systems Laboratory (ISAS) of the Karlsruhe Institute of Technology (KIT), Germany, within the DFG Priority Programme Cyber-Physical Networking (SPP 1914).

In a nutshell

CoCPN-Sim provides a way to integrate components of a networked control system (NCS), modeled and simulated in MATLAB, into networks modeled with INET. The whole simulator is based on the OMNeT++ simulation framework and has been tested with OMNeT++ 5.6.2 and MATLAB 2019b on Ubuntu 18.04/20.04. It relies on the MATLAB Compiler SDK to create a shared library with mcc, which is then linked into the simulation binary. The examples in ncs-testbench show how to setup and run a simulation with CoCPN-Sim.

Quickstart

A working installation of OMNeT++ 5.6.2 and MATLAB 2019b (or later) is required, in conjunction with the following MATLAB toolboxes:

  • MATLAB Compiler
  • MATLAB Compiler SDK
  • Control System Toolbox
  • Robust Control Toolbox
  • Optimization Toolbox
  • Global Optimization Toolbox
  • Signal Processing Toolbox
  • Statistics and Machine Learning Toolbox
  • Communications Toolbox
  • Curve Fitting Toolbox
  • System Identification Toolbox

Since MATLAB provides its own set of libraries, which may conflict with system libraries (especially with glibc/libstdc++), it may be neccessary to find a MATLAB release which is suitable for your distribution, or to use a hackaround. MATLAB 2019b is known to work with Ubuntu 18.04/20.04 and OMNeT++ 5.6.2, but it may be required to compile OMNeT++ without OpenSceneGraph-Support.

We maintain a patched version of OMNeT++ that prevents an annoying crash at the end of simulations when running in commandline (Cmdenv) mode.

Furthermore, some of the Matlab MEX files require that the Boost C++ libraries are installed on your system. In particular, odeint is necessary.

The script setenv.sh is provided in order to set up the necessary environment variables before launching the OMNeT++ IDE. It requires you to export the variables OPP_ROOT and MCR_ROOT, pointing to the root directory of OMNeT++ and MATLAB. Then, you can source the script and launch the OMNeT++ IDE: . setenv.sh omnetpp

The OMNeT++ IDE will ask you to set up a new working space. Proceed and import all subfolders mentioned below, except the folder matlab. Build the whole workspace. You will then find a working example of a NCS simulation in ncs-testbench/simulations.

Architecture

The key component of CoCPN-Sim is the OMNeT++ module NcsContext. It represents a sensor, a controller and an actuator of an NCS modeled in MATLAB. The interaction with components modeled in MATLAB is driven by a set of API functions which are called from the OMNeT++ simulation context, most of them are event-driven (like the delivery of new messages), others will be called during initialization or as periodic event to drive control computations. Communication between the CPS components in MATLAB is modeled in messages which are fed to the OMNeT++ part of the simulation and thus subject to the network model. Messages which are received from the network are immediately fed back to the MATLAB domain.

Descriptions of the CoCPN-Sim data flow can also be found in

Folders

  • inet contains the INET framework.
  • libncs_matlab contains the definition of the API provided to OMNeT++ by the MATLAB part of the simulation.
  • libncs_omnet contains a set of modules which either interface the MATLAB API or support modelling of CPNs.
  • matlab contains all MATLAB code for the co-simulation
  • matlab-scheduler is not really a special scheduler but provides hooks to initialize and deinitialize the MATLAB environment
  • ncs-testbench this repository shows how to build a MATLAB-OMNeT++/INET co-simulation with the components mentioned beforehand

Unit Tests

  • libncs_matlab: Unit tests for libncs_matlab reside in the tests subfolder and can be run (from Matlab) by calling the function executeTestsLibNcsMatlab.
  • matlab: Unit tests for matlab reside in the Tests subfolder and can be run (from Matlab) by calling the function executeTestsMatlab.

Alternatively, you can execute the script runtests.sh that compiles all mex files within matlaband then conveniently runs all test cases from the shell.

Externals

CoCPN-Sim makes use of the following external libraries/functions which are included in matlab/external.



For additional information regarding YALMIP, Armadillo, and SDPT3, please refer to the corresponding papers:

License

CoCPN-Sim is licensed under the GPLv3 license.

Citation

If you use CoCPN-Sim in your research, please cite its usage as follows.

@misc{cocpnSim,
  Title   = {{CoCPN-Sim}},
  Author  = {Markus Jung and Florian Rosenthal},
  Year    = {2018},
  Url     = {https://github.com/spp1914-cocpn/cocpn-sim}
}

Contact

Lead authors: Markus Jung and Florian Rosenthal

Email: markus.jung(at)kit.edu, florian.rosenthal(at)kit.edu

Contributors

  • Fabio Broghammer
  • Joanna Müller

Some parts of the Matlab code are based on original implementations provided by Jörg Fischer and Maxim Dolgov.