1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00

updated docs

git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@161 8ec27952-4edc-4aab-86aa-e87bb2611832
This commit is contained in:
Steffen Vogel 2014-07-16 09:34:04 +00:00
parent fa4173432c
commit 22364d2708
3 changed files with 66 additions and 44 deletions

View file

@ -1,6 +1,26 @@
S2SS is a client server application based on UDP/IP to connect simulation equipment.
S2SS is a client/server application based on UDP/IP to connect simulation equipment/software such as:
It's designed with focus on low latency to establish soft-realtime communication.
- OPAL-RT,
- RTDS,
- Simulink,
- LabView,
- custom made equipment,
- and FPGA models.
It's designed with focus on very low latency to achieve almost realtime communication.
S2SS is used in distributed- and co-simulation scenarios and developed for the field of power grid simulation at the EON Energy Research Centre in Aachen, Germany.
## Overview
The project consists of a server and several client applications.
Both server-to-server and direct client-to-client communication is possible.
All communication links use the same message protocol to exchange their measurement values.
### Server
For optimal performance the server is implemented in lowlevel C and makes use of several Linux-specific realtime features.
### Clients
## Contact
@ -9,39 +29,4 @@ This project is developed at the [Institute for Automation of Complex Power Syst
- Steffen Vogel <StVogel@eonerc.rwth-aachen.de>
- Marija Stevic <MStevic@eonerc.rwth-aachen.de>
## Compilation
Install libraries including developement headers for:
- libconfig
Start the compilation with:
$ make
Add `V=5` for a more verbose debugging output.
## Installation
Install the server by executing:
$ sudo make install
Add `PREFIX=/usr/local/` to specify a non-standard installation destination.
**Important:** Please note that the server requires the
[iproute2](http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2)
tools to setup the network emulation and interfaces.
Install these via:
$ sudo yum install iproute2
or:
$ sudo apt-get install iproute2
## Configuration
See [configuration](Configuration.md) for more information.

View file

@ -1,7 +1,42 @@
# Server {#server}
# Server
@subpage configuration
@subpage usage
@subpage netem
## Compilation
Install libraries including developement headers for:
- libconfig
Start the compilation with:
$ make
Add `V=5` for a more verbose debugging output.
## Installation
Install the server by executing:
$ sudo make install
Add `PREFIX=/usr/local/` to specify a non-standard installation destination.
**Important:** Please note that the server requires the
[iproute2](http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2)
tools to setup the network emulation and interfaces.
Install these via:
$ sudo yum install iproute2
or:
$ sudo apt-get install iproute2
## Configuration
See [configuration](Configuration.md) for more information.
@todo Move documentation from Mainpage to Server.

View file

@ -2,17 +2,19 @@
@defgroup opal OPAL-RT
The communication between OPAL-RT models and the S2SS is established by using ansychronus programs.
Asynchronous programs are a feature of RT-LAB.
The communication between OPAL-RT models and the S2SS is established by using ansychronous programs.
Asynchronous programs are are a feature of RT-LAB. They are used to exchange data between Simulink models and custom C programs.
## Source Code
For this purpose the C program handels IP/UDP communication via BSD sockets.
The source code of the asynchronus program is located at:
/clients/opal/models/AsyncIP_sl/s2ss/
## Arguments for OPAL-RT block
RT-LAB already provides a block to establish simple TCP/IP communication: ???
This block is based on a more generic block used for aynchronous programs: ???
@todo Insert name of RT-LAB blocks.
| Param | Description | Example Value |
| :------------- | :------------ |:-------------- |
| FloatParam[0] | Protocol | |