diff --git a/documentation/clients/File.md b/documentation/clients/File.md index 24aa6176a..abc646266 100644 --- a/documentation/clients/File.md +++ b/documentation/clients/File.md @@ -1 +1,34 @@ -# File \ No newline at end of file +# File + +The `file` node-type can be used to log or replay sample values to disk. + +## Configuration + +Every `file` node supports the following settings: + +`in` specifies the path to a file which contains data for replaying. + +`out` specifies the path to a file where samples will be dumped. + +`mode` + +`rate` + +### Example + +@todo Add extract of example.conf + +## File Format + +This node-type uses a simple human-readable format to save samples: +The format is similiar to a conventional CSV (comma seperated values) file. +Every line in a file correspondents to a message / sample of simulation data. +The columns of a line are seperated by whitespaces (tabs or spaces). +The columns are defined as follows: + + 1. Floating point timestamp in seconds since 1970-01-01 00:00:00 (aka Unix Epoch ). + 2. Up to `MSG_VALUES` floating point values per sample. The values are seperated by whitespaces as well. + +### Example + +@todo Add example dump diff --git a/documentation/clients/GTFPGA.md b/documentation/clients/GTFPGA.md index 4352e515d..6235fa811 100644 --- a/documentation/clients/GTFPGA.md +++ b/documentation/clients/GTFPGA.md @@ -8,6 +8,14 @@ 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. +## Configuration + +`slot` + +`id` + +`rate` + ## Source Code The source code for the PowerPC is located at: diff --git a/documentation/clients/OPAL.md b/documentation/clients/OPAL.md index 0a03cc71f..81bc4e68c 100644 --- a/documentation/clients/OPAL.md +++ b/documentation/clients/OPAL.md @@ -5,6 +5,13 @@ Asynchronous programs are are a feature of RT-LAB. They are used to exchange dat For this purpose the C program handels IP/UDP communication via BSD sockets. +## Configuration + +`send_id` + +`recv_id` + +`reply` ## Arguments for OPAL-RT block diff --git a/documentation/clients/Socket.md b/documentation/clients/Socket.md index 40bc49994..a76c19b43 100644 --- a/documentation/clients/Socket.md +++ b/documentation/clients/Socket.md @@ -1,12 +1,38 @@ # Socket -The socket node type is the most comprehensive one. It allows to send / receive simulation data over the network. -Internally it uses the well known BSD sockets. +The socket node-type is the most comprehensive and complex one. +It allows to send and receive simulation data over the network. +Internally it uses the well known BSD socket API. -The implementation allows to chose the OSI layer which should: +Please note that only datagram / packet, connection-less based network protocols are supported. +This means that there's currently no support for TCP! + +The implementation supports multiple protocols / OSI layers: - Layer 1: Raw Ethernet Frames (no routing!) - Layer 2: Raw IP (internet / VPN routing possible) - Layer 3: UDP encapsulation - - \ No newline at end of file + +## Configuration + +`local` + +`remote` + +`netem` + +`layer` + +### Example + +@todo Add excerpt from example.conf + +## Packet Format + +@todo add DIA figure here + +### Example + +@todo add screenshot of wireshark dump + +## Network Emulation