diff --git a/doc/Clients.md b/doc/Clients.md new file mode 100644 index 000000000..380c423c0 --- /dev/null +++ b/doc/Clients.md @@ -0,0 +1,14 @@ +# Clients + +@subpage gtfpga + +Every server needs clients which they serve. In case of S2SS these clients are called _nodes_. + +Its a goal of this project to provide connectors so several proven simulators. +Take a look at the `clients/` directory for them: + + - RTDS UDP Network Card ? + - RTDS via GTFPGA + - OPAL + - Labview + - Simulink diff --git a/doc/Configuration.md b/doc/Configuration.md index 9417ae762..aa54de244 100644 --- a/doc/Configuration.md +++ b/doc/Configuration.md @@ -1,8 +1,21 @@ # Configuration -## Configuration file +## File -Take a look in the 'Examples' section for some configurations. +The server gets exclusively configured by its configuration file. + +The following sections describes the available options. +Take a look in the 'Examples' section for some examples. + +### Global + +- *name*: +- *affinity* + + +### Nodes + +### Paths ## Tuning diff --git a/doc/GTPGA.md b/doc/GTPGA.md new file mode 100644 index 000000000..f3452b3d8 --- /dev/null +++ b/doc/GTPGA.md @@ -0,0 +1,3 @@ +# GTFPGA {#gtfpga} + +Hallo :-) diff --git a/doc/Mainpage.md b/doc/Mainpage.md index bcfc8a1dd..47fbaa294 100644 --- a/doc/Mainpage.md +++ b/doc/Mainpage.md @@ -1,6 +1,4 @@ -# Readme \section Readme - -This is the readme file for the S2SS server. Take a look at the `doc/html` directory for a full documentation. +S2SS is a client server application based on UDP/IP to connect simulation equipment. ## Contact @@ -36,9 +34,7 @@ tools to setup the network emulation and interfaces. Install these via: $ sudo yum install iproute2 - or: - $ sudo apt-get install iproute2 ## Configuration @@ -62,10 +58,22 @@ Afterwards privileges can be dropped by using the `user` and `group` settings in ### Examples - 1. Send/Receive of random data: + 1. Start server: + + $ ./server etc/example.conf + + 2. Receive/dump data to file + + $ ./receive *:10200 > dump.csv + + 3. Replay recorded data: + + $ ./send 4 192.168.1.12:10200 < dump.csv + + 4. Send random generated values: $ ./random 1 4 100 | ./send 4 192.168.1.12:10200 - 2. Ping/Pong Latency + 5. Test ping/pong latency: $ ./test latency 192.168.1.12:10200