From 3f6da6a1a164f680d3b3d376a41aa027518c9006 Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Mon, 14 Jul 2014 11:01:34 +0000 Subject: [PATCH] restructured documentation git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@151 8ec27952-4edc-4aab-86aa-e87bb2611832 --- documentation/Mainpage.md | 40 +--------- documentation/Server.md | 6 ++ documentation/Usage.md | 42 ---------- documentation/clients/GTFPGA.md | 8 ++ documentation/clients/OPAL.md | 27 +++++-- documentation/figures/path_states.dia | Bin 0 -> 1488 bytes documentation/{ => server}/Configuration.md | 2 +- documentation/{ => server}/Netem.md | 2 +- documentation/server/Usage.md | 80 ++++++++++++++++++++ 9 files changed, 117 insertions(+), 90 deletions(-) delete mode 100644 documentation/Usage.md create mode 100644 documentation/figures/path_states.dia rename documentation/{ => server}/Configuration.md (97%) rename documentation/{ => server}/Netem.md (97%) create mode 100644 documentation/server/Usage.md diff --git a/documentation/Mainpage.md b/documentation/Mainpage.md index 51de56a7d..773c834e9 100644 --- a/documentation/Mainpage.md +++ b/documentation/Mainpage.md @@ -1,5 +1,7 @@ S2SS is a client server application based on UDP/IP to connect simulation equipment. +It's designed with focus on low latency to establish soft-realtime communication. + ## Contact This project is developed at the [Institute for Automation of Complex Power Systems](www.acs.eonerc.rwth-aachen.de) (ACS) at the EON Energy Research Center (EONERC) at the [RWTH University](http://www.rwth-aachen.de) in Aachen. @@ -42,42 +44,4 @@ or: See [configuration](Configuration.md) for more information. -## Usage -The S2SS server (`server`) expects the path to a configuration file as a single argument. - - Usage: ./server CONFIG - CONFIG is a required path to a configuration file - - Simulator2Simulator Server 0.1-d7de19c (Jun 4 2014 02:50:13) - Copyright 2014, Institute for Automation of Complex Power Systems, EONERC - Steffen Vogel - -The server requires root privileges for: - - - Enable the realtime fifo scheduler - - Increase the task priority - - Configure the network emulator (netem) - - Change the SMP affinity of threads and network interrupts - -### Examples - - 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 - - 5. Test ping/pong latency: - - $ ./test latency 192.168.1.12:10200 diff --git a/documentation/Server.md b/documentation/Server.md index 7864a4ea1..57a3aa221 100644 --- a/documentation/Server.md +++ b/documentation/Server.md @@ -1,3 +1,9 @@ # Server {#server} +@defgroup server Server + +@subpage Configuration +@subpage Usage +@subpage Netem + @todo Move documentation from Mainpage to Server. diff --git a/documentation/Usage.md b/documentation/Usage.md deleted file mode 100644 index 48e27e32e..000000000 --- a/documentation/Usage.md +++ /dev/null @@ -1,42 +0,0 @@ -# Usage Instructions - -1. Start putty.exe (SSH client for Windows) - - - Should be already installed on most systems - - Or load .exe from this website (no installation required) - http://the.earth.li/~sgtatham/putty/latest/x86/putty.exe - -2. Connect to S2SS server - -| Setting | Value | -| :------- | :------------- | -| IP | 130.134.169.31 | -| Port | 22 | -| Protocol | SSH | -| User | acs-admin | - -3. Go to S2SS directory - - $ cd /home/acs-admin/msv/s2ss/server/ - -4. Edit configuration file - - $ nano etc/opal-test.conf - - - Take a look at the examples and documentation for a detailed description - - Move with: cursor keys - - Save with: Ctrl+X => y => Enter - -5. Start server - - $ sudo ./server etc/opal-test.conf - - - `sudo` starts the server with super user priviledges - -6. Terminate server by pressing Ctrl+C - -7. Logout - - $ exit - - diff --git a/documentation/clients/GTFPGA.md b/documentation/clients/GTFPGA.md index ae6999080..b89a6c419 100644 --- a/documentation/clients/GTFPGA.md +++ b/documentation/clients/GTFPGA.md @@ -1,5 +1,7 @@ # GTFPGA {#gtfpga} +@defgroup gtfpga GTFPGA + The GTFPGA card is an extension card for simulator racks from RTDS. The manufacturer provides a VHDL module to exchange data via fiber optics between the GTFPGA and GPC cards. @@ -8,4 +10,10 @@ This board consists of a Virtex 5 FPGA, Ethernet and Fiberoptic MACs and an inte The PowerPC core is used to forward values between RTDS and the S2SS server. +## Source Code + +The source code for the PowerPC is located at: + + /clients/gtfpga/s2ss/ + @todo Add documentation for GTFPGA card. diff --git a/documentation/clients/OPAL.md b/documentation/clients/OPAL.md index 115782f56..d002c4430 100644 --- a/documentation/clients/OPAL.md +++ b/documentation/clients/OPAL.md @@ -1,14 +1,25 @@ # OPAL-RT {#opal} +@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. + +## Source Code + +The source code of the asynchronus program is located at: + + /clients/opal/models/AsyncIP_sl/s2ss/ + ## Arguments for OPAL-RT block -Param | Description | Example Value ---------------- | ------------- | -------------- -FloatParam[0] | Protocol | -FloatParam[1] | RemotePort | 10200 -FloatParam[2] | LocalPort | 10201 -StringParam[0] | RemoteAddr | 192.168.0.10 -StringParam[1] | LocalAddr | 192.168.0.11 -StringParam[2] | InterfaceName | eth2 +| Param | Description | Example Value | +| :------------- | :------------ |:-------------- | +| FloatParam[0] | Protocol | | +| FloatParam[1] | RemotePort | 10200 | +| FloatParam[2] | LocalPort | 10201 | +| StringParam[0] | RemoteAddr | 192.168.0.10 | +| StringParam[1] | LocalAddr | 192.168.0.11 | +| StringParam[2] | InterfaceName | eth2 | @todo Complete documentation for the OPAL-RT Simulink module. diff --git a/documentation/figures/path_states.dia b/documentation/figures/path_states.dia new file mode 100644 index 0000000000000000000000000000000000000000..804951d9fb672220d871b531bc39f8c50cc1ac35 GIT binary patch literal 1488 zcmV;>1uyy^iwFP!000021MOQ~Z=*OAeebV8>C3Lv5^S)6>9nJ2x1*^vyDRN<=QVP` zCEg)`jFU7k``gzhG->!qnh=<&hDc2nV(zgo_BrPo^8UlqG}Pvlr!0=H2S7Il8jZZz zXHjrH_~+r{r8D?&bN1e6V5 zg=6U`iMil}i8ACkjzdbK6{_GfdOS|*kx)*tUBhZHibp0yyr=(eI z557YYMTg5nFk?PV_e`_xHZ_qZd9&fZtQXt8HZiM11+mT`Lb9Yh5C2JCI?4mCbXv== za85ZI@dTSce|nLWc>FK*L_XS&VZ87rgbVFby9+~>$hE$4BGQL2|9bG3v7NHwAZ0|! zhNYY(@n&LK7r-ngp-drl!N=obY%YgDq9CMsd{cMP1%UGX3OG8%Py%Az!G?1jDh=s$ z^kJf?ndKA(q*rl$9j+#R3(eGCysF@)rpj<6!Nok(H(I#?vItiIPa-^zrQ zrb)%QAU_vupNq>|9fb~^&P$q2S-@=BN^YE_t&F6JyKs_bZzOvoc{(F`|L51+&-eYN zMC(pc8AuGA-br@qB(3KA5xH%`Iz-U!!bwUb$-f&XY3q)K?3SHm?KpRs&L%18o#b0| zk_9&ij65pR}fcd_QST0iEn8)sAxqTlD)$KN|&@4fd0aHujTV5Ws_~i(fo! zn=^pj*aXOw%0=1Y%6H^?a%>4==$3)50Mtzfn2HDh`tkP>5+Wuexs18^<=1{Qq4g&m zinFobL^x<=%(E`lYrwu8*3*!Za~e`|+a)C%sD~GvH7P;Ik(h6Zl;Wi4q^>y0?K$af zaMEWMRo!%Rn{tw}>KC#&Xp@x`1~Lq+a8zAzW$FN|_SPZBsO2K5VuY2q>0}E79a*Qy ztL`PmK2$x(-xog}6+bmw7*0n83~2n2KFp@=(dmEPJq%Zez;rHLHTAEcsoM_DN*L=6 zxP>pOdeQ!%X-WcmCPzluocg_SX#E+x^2F?|!y7DT05}arxh)eER?l;;>KVmQrkT|< q?weq!IOz%MI}uc0+59Nz9-_Xa56Q=F=H%K>z@fUDaU# literal 0 HcmV?d00001 diff --git a/documentation/Configuration.md b/documentation/server/Configuration.md similarity index 97% rename from documentation/Configuration.md rename to documentation/server/Configuration.md index 8cb8b5498..f53be34f7 100644 --- a/documentation/Configuration.md +++ b/documentation/server/Configuration.md @@ -1,4 +1,4 @@ -# Configuration +# Configuration {#Configuration} ## File diff --git a/documentation/Netem.md b/documentation/server/Netem.md similarity index 97% rename from documentation/Netem.md rename to documentation/server/Netem.md index 7179b3d5f..b0b691cca 100644 --- a/documentation/Netem.md +++ b/documentation/server/Netem.md @@ -1,4 +1,4 @@ -# Network Emulation +# Network Emulation {#Netem} S2SS supports the emulation of wide-area network characterisics. diff --git a/documentation/server/Usage.md b/documentation/server/Usage.md new file mode 100644 index 000000000..b2ae02025 --- /dev/null +++ b/documentation/server/Usage.md @@ -0,0 +1,80 @@ +# Usage Instructions {#Usage} + +The S2SS server (`server`) expects the path to a configuration file as a single argument. + + Usage: ./server CONFIG + CONFIG is a required path to a configuration file + + Simulator2Simulator Server 0.1-d7de19c (Jun 4 2014 02:50:13) + Copyright 2014, Institute for Automation of Complex Power Systems, EONERC + Steffen Vogel + +The server requires root privileges for: + + - Enable the realtime fifo scheduler + - Increase the task priority + - Configure the network emulator (netem) + - Change the SMP affinity of threads and network interrupts + +## Step-by-step + +1. Start putty.exe (SSH client for Windows) + + - Should be already installed on most systems + - Or load .exe from this website (no installation required) + http://the.earth.li/~sgtatham/putty/latest/x86/putty.exe + +2. Connect to S2SS server + +| Setting | Value | +| :------- | :------------- | +| IP | 130.134.169.31 | +| Port | 22 | +| Protocol | SSH | +| User | acs-admin | + +3. Go to S2SS directory + + $ cd /home/acs-admin/msv/s2ss/server/ + +4. Edit configuration file + + $ nano etc/opal-test.conf + + - Take a look at the examples and documentation for a detailed description + - Move with: cursor keys + - Save with: Ctrl+X => y => Enter + +5. Start server + + $ sudo ./server etc/opal-test.conf + + - `sudo` starts the server with super user priviledges + +6. Terminate server by pressing Ctrl+C + +7. Logout + + $ exit + +## Examples + + 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 + + 5. Test ping/pong latency: + + $ ./test latency 192.168.1.12:10200