mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
Added more documentation
git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@122 8ec27952-4edc-4aab-86aa-e87bb2611832
This commit is contained in:
parent
5dbd9667ee
commit
42c3e2faf8
6 changed files with 13 additions and 25 deletions
4
Doxyfile
4
Doxyfile
|
@ -1026,7 +1026,7 @@ HTML_OUTPUT = html
|
|||
# The default value is: .html.
|
||||
# This tag requires that the tag GENERATE_HTML is set to YES.
|
||||
|
||||
HTML_FILE_EXTENSION = .html
|
||||
HTML_FILE_EXTENSION = .xhtml
|
||||
|
||||
# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
|
||||
# each generated HTML page. If the tag is left blank doxygen will generate a
|
||||
|
@ -2212,7 +2212,7 @@ DIRECTORY_GRAPH = YES
|
|||
# The default value is: png.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_IMAGE_FORMAT = png
|
||||
DOT_IMAGE_FORMAT = svg
|
||||
|
||||
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
||||
# enable generation of interactive SVG images that allow zooming and panning.
|
||||
|
|
|
@ -11,47 +11,33 @@ For bidirectional communication a corresponding path in the reverse direction mu
|
|||
The server is designed to allow multiple outgoing nodes as an extension.
|
||||
@todo This has **not** been implemented at the moment!
|
||||
|
||||
\diafile path_simple.dia
|
||||
@diafile path_simple.dia
|
||||
|
||||
## Path
|
||||
|
||||
@todo Add documentation
|
||||
|
||||
@see path
|
||||
@see path For a detailed descriptions of the fields.
|
||||
|
||||
## Node
|
||||
|
||||
@todo Add documentation
|
||||
|
||||
@see node
|
||||
@see node For a detailed descriptions of the fields.
|
||||
|
||||
## Message
|
||||
|
||||
@todo Add documentation
|
||||
|
||||
@diafile msg_format.dia
|
||||
|
||||
A message contains a variable number of values.
|
||||
Usually a a simulator sends one message per timestep.
|
||||
|
||||
The format of a message is defined by the following structure:
|
||||
|
||||
~~~{.c}
|
||||
struct msg
|
||||
{
|
||||
/** Sender device ID */
|
||||
uint16_t device;
|
||||
/** Message ID */
|
||||
uint32_t sequence;
|
||||
/** Message length (data only) */
|
||||
uint16_t length;
|
||||
/** Message data */
|
||||
double data[MAX_VALUES];
|
||||
} __attribute__((packed));
|
||||
~~~
|
||||
|
||||
@see msg
|
||||
@see msg For a detailed descriptions of the fields.
|
||||
|
||||
## Interface
|
||||
|
||||
@todo Add documentation
|
||||
|
||||
@see interface
|
||||
@see interface For a detailed descriptions of the fields.
|
||||
|
|
|
@ -49,5 +49,5 @@ This are some proposals for the selection of appropriate server hardware:
|
|||
- Server-grade network cards: Intel PRO/1000
|
||||
- These allow offloading of UDP checksumming to the hardware
|
||||
|
||||
\example etc/loopback.conf
|
||||
\example etc/example.conf
|
||||
\example server/etc/loopback.conf
|
||||
\example server/etc/example.conf
|
||||
|
|
2
documentation/Timing.md
Normal file
2
documentation/Timing.md
Normal file
|
@ -0,0 +1,2 @@
|
|||
|
||||
@diafile timing.dia
|
BIN
documentation/figures/msg_format.dia
Normal file
BIN
documentation/figures/msg_format.dia
Normal file
Binary file not shown.
BIN
documentation/figures/timing.dia
Normal file
BIN
documentation/figures/timing.dia
Normal file
Binary file not shown.
Loading…
Add table
Reference in a new issue