From 42c3e2faf814ec9fa10ee404a4de9d80d467564b Mon Sep 17 00:00:00 2001 From: Steffen Vogel Date: Fri, 4 Jul 2014 09:44:07 +0000 Subject: [PATCH] Added more documentation git-svn-id: https://zerberus.eonerc.rwth-aachen.de:8443/svn/s2ss/trunk@122 8ec27952-4edc-4aab-86aa-e87bb2611832 --- Doxyfile | 4 ++-- documentation/Concept.md | 28 +++++++-------------------- documentation/Configuration.md | 4 ++-- documentation/Timing.md | 2 ++ documentation/figures/msg_format.dia | Bin 0 -> 5561 bytes documentation/figures/timing.dia | Bin 0 -> 6517 bytes 6 files changed, 13 insertions(+), 25 deletions(-) create mode 100644 documentation/Timing.md create mode 100644 documentation/figures/msg_format.dia create mode 100644 documentation/figures/timing.dia diff --git a/Doxyfile b/Doxyfile index d730fed28..206679c1d 100644 --- a/Doxyfile +++ b/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. diff --git a/documentation/Concept.md b/documentation/Concept.md index 5dff765df..e06dcb3ca 100644 --- a/documentation/Concept.md +++ b/documentation/Concept.md @@ -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. diff --git a/documentation/Configuration.md b/documentation/Configuration.md index aa54de244..26716c34d 100644 --- a/documentation/Configuration.md +++ b/documentation/Configuration.md @@ -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 diff --git a/documentation/Timing.md b/documentation/Timing.md new file mode 100644 index 000000000..337cd101a --- /dev/null +++ b/documentation/Timing.md @@ -0,0 +1,2 @@ + +@diafile timing.dia diff --git a/documentation/figures/msg_format.dia b/documentation/figures/msg_format.dia new file mode 100644 index 0000000000000000000000000000000000000000..996e0a5a970db0e6a14079f84a38fd3419183e2c GIT binary patch literal 5561 zcmV;q6-MeGiwFP!000021MOYkbKAPHe$QW_@p&M+1<$f#(Y)&?eoQLQQZIj zR(CAKgVCFTT7RjhX{YvLY*gw*F~W6wB%OYmtxU z*UHsPJg#Vr|qRr?#*&K zdH%uOx}s&2@6$`Js0|ofqDQ|KVr&-A|`t@6E6GL_CyTVUQ^B}yDFyN9{<+3DU0#{U68y#rMkt9_SI~=`a_3+~EF*2jPFG^ZdY*!23Q4pdC;V9|cIOXF+YA z1<6i+7Ooca`DH$zRPX-intva@)WhFfn6Ze)X7P zRs5LcyEEi&MQh#)f?45#y;F4dt`Ms#@;3N@RULRO-vz<-EO3RsaOHrDS1vYyNi9!9!toXH^F;Ak3Z#v#K{{Eiz_J1G6?5W^ET{En)Ut zm`y!wza;wZ3pSfC5oYrxJN90J0DB(5>i&B#iM{oLr=3>_w5sR9stBv-SUnu%HT|Kg zu%Rk9%*ydYyeifRucQd?$&771gdZe&^Z_=(2N5RtAUk3YMB8U_F*x%Oe30m|2iSxj zM3~Tn?1(%NV$X$G?jiIb(IXGA2|S1}fd|Mgaq)<=3T1LYO%&$j$`}U-ixc zl?m=~3?xuyE7$R>YO+XzSL}fiVPF$R4T#}|u0%YcD^EnEeGrjGC!%yiL^>KGl0-xy zh)5F=4SLqrsUh%6D&0Eo!?AR^QtBqSoOqL5Ei#CbGa^e5t? z5M1OCL1Yv?842cvi~uvyJTX?QGJd#WBZ!8LI0cKs&=C+F4S&;WQy`4I3yMbdpQ4{Akeh7u8=-3nJ7{Z>vjhj`s9IxUsLYg}>S`<`U0TgR?9 z9q)UahmI|%JxR(}${i_R*u%kr-{$Mzc8=rLZwoIvz}=f_=$!~J8L9}n8-6W-E@fhP zL<;EF(}#RAx_5ZI8_#lb0?X z%9x``R%Gvfx7Nq}FCwP^)zi@t$DgT(ie}LGZR68T7jD2l0PV4)V@^N~9e^I& zC-z!^p##tWA%-%jKz1`g*(=bgXTZ)0?mH+xRpI=dq zN{EWslx$nTJk|a+V;Z+JS^CuIUZ(wQ+tEp?+eI>wb^WUcVvJK9nKb*1qo$5rcy^891v&>ID70%=Qx631-yuG3W zSD4N#$}u>5_7Zz?VsE|azbrrMRr@jd{_F?;4bfwj;2|1g(F?0gqppevsjISGWmTNY zss>nA#e0=iIn#jP@^r^krSzZ!0O&dZqM-wTe^Pkrf=CB|bO2)20bo@9AEf$UQdBiu zR8=Y;8+yRs(2K@~9>Q$sp=(1Aw4vYg@zi-Y^r@E(JuaZD9ldSr=pn$4{&_T4Tl$Vm z-qxPJrAkL?9~I5WDhpLXSXrQ>63gm>oj6LGD@V)y->AM{b!GGQj4GRhRW>{5P-$~K zwS>58%qEj&LB{*ZseHYlHw5W=t! z_|TXUs0J>6MH9*ByDKt;V1Xt_qGA~(FbK>aPTd9<>&7n~PLTTqG!Ljn73Cw;lu+^-jAM z=z(itwzPO9S^)yr^v_vB_k z2sh*O^^l+8(a)Hq8mVp zE)rvmb|8r(QGA)NzD>^Q)$cp?zl>+oUz-Dx@zu&AJ%dxi}5{S@G z#_HtsswKU^KNu5;2V;^P`{)9Q7CtQeqxw8v5677se5>jm%cL}z;F*eH#BxaK<&}j83E`ny+w8DDOUeh za{`R;kQ0FFYSc*q&eKpVg~y}-XH}#+NB1>)EQy>AN(`X*A%y|ZJ0e7HJv4a5)xu{R=^M~Nq;GmG>6j2bPbo%E zF?x#8zp-9>BzhAvMsJyi4xNA*nJSZROx4AsicSGbB(L=8qlwVx%WpXa=>u~J1?giA z(xd15w(KG;_aJTw=;D^5;o$>*ENpvChxOy(wS~ee;%kSmM1(Ks){Y$Qzsy^H*#tVD zvckvq78Cp2CS|RULx1H32$7VvKJEdC!wV>;cloNw?(S&|fo}eJEl*D7|J>$(53N(YnNn@+onk@KGn=bAc!6TkrDu+L`E|aiw)G(yUy&bh0n5b(v32o%2*~cN>fi+g+H--{csQ>^1#O*bP@vse)xir0wC4h? z^^j_Y3tH0vtqlfR+XY%nphXAm;eaD&%!50NuInuuY5x*m*js8kO+ySYz9jm0oy}HZ zMEW@EogXI?v&}>{DkdVo2%U*6G0`BHNO?I~MWrGxN-ly&D&kObk%@$g3{erf;42Up z4T6h$XC-ls&P8r`yK#%SP9%%QE#iX62%U^Hkw#Z2EsK_WKG73-) zKx8xoGU}g7h#tBYa+{1)Ok^Y|c8yO)6uce=8Tm;O#U&%NO-42n4KqXCc+ z@16P!=<#b1TVwV%|?6koo0Mpb?EDn-tDe&W5_zaWm6$Y<1x->U}vI{RKW5uD4+mT?e8SOW_k|iLjNkAuU93 zSa#0B53}!QeE4}Wn}i7FF=YTiSdlW2R%rC<4^}xFw%JpFoQ;T_jTED|<1rD$-WlGU z<9ZvMHQWsd;%@X<68Re*{f$Xleo+*WqKMH~X9@}<1`Z?kt`?|1GfczA6V6Kwfps8} zi^LeCYnGcRbD4-avk8iL8ifvpddKW85bY)aFOde!|6-I4K2^QQ(O0dOG2{w(CU>hbS*mk7^ z+hL{zzw`_(|81HtTLI=F=N!E)fllO8lMa)p3T~%DY@Gjgc?7(6)^y+!(|yTynnl|f z=G14UjL}_|pZBVrr`X>72mdVq(7+GSEI!b5186n`&}=tI>{|!g5s`W!Jt$@>{8ogU zrfwQLOn>rvj)~G6iqccA?`zs;&hq(9aZCHl07{A}h3b8U>W{H(%7f&g(C7_IMWd0P zz&?ZSv7}?H8&Ao+k$HPf=53Y#`Zb?lQ2;fB29==0=%5xZ^{{tCwQ%+3t+sIW?hW0- z^;i<^-^jqx{*BCA+y0HrTUhhvMYA4%0~fRty1-2$rVSj~H`>6xT@hija6v7c@zJgh ze*-5Q8#ozY11D(%M+S~IaAe+mw=yI1c9MCk|31rpc6=EZkE~Imv{dGU&Plm H20H=(wqV9R literal 0 HcmV?d00001 diff --git a/documentation/figures/timing.dia b/documentation/figures/timing.dia new file mode 100644 index 0000000000000000000000000000000000000000..fdaec5c0302dced870275ccd8469f1d624d0acc8 GIT binary patch literal 6517 zcma)gcQ{;o*Y=4Z95JFs8_|gpC8CW^l+jB>B6@G5M2pD~B_`2gm;@1wjHn?PQG$ms57EkrZ*+q7dkcA7F(oK1~ zade$&tCU^ag(dm3``YvDtgQ6J^oeg)&=0^Wt)A&z;Y+ut2z3)~c52AdA33IGf<`^1 z7Ftu{)Y|m;G@(_CNTrD5kq>FxXycLj-8Ik6AM#A|n?r&A!9gn44?fACI*V{Lb##UOdWviYZA3T&g4N$&kBOZUS=H#yoJBdg= zc)axqv~;l9larJ*%=pIGGWEo*Mm6ibWzV;%7bVL>jsXfV|Ks3*y@B}ov9Ik1n}>x{ zKl{rT?)IRKQxD>Qx@|z3l5%FV7Y;feH9cIXOO0Qinh)F>Xf3$W@Sz&kS)^)^HdWAg z>=&fG3b+S5D1X=)xxEu1_;s2q2nVdH4Lw*(`|V9khD7*nBzH^uKbZt3SPXG&` zkcCyDsJPf?^+IUR%xa|Y-0H)C)43T(c%~EFnsm2mKJfeaKwJnjww~{v*AII(WCVoQ4gyef<08;H-D_E zJ_1_%TOO2SOJ`sGs5kOvW3%$w!62py_F$b6b24O!X<~C!IgqxQ$v*ML>C4&JiXExI z0+0Tj1@{l(y>A`u>^9)_>cWniM=)cAv8MZmEQ_i02SWoo5jo=Z5xYJt!+q+mixNqv zrVtgIsjCxNrRHC<7FS!xl+UJ)c?3!!b8zh^5`l zsWDa}#5VZ6$Wz+QJP7o!2x~ryf-!%sEUeO;)-7+LBKAy2jv~Sv`Mm8S9_}=iBsOK& zn_1Zey}N?{y|j)c4uo`vt-fEq_CfRpn%vGf!bU)V6{0Wct}mH%KT0)?f?~O(T*Rx` zs9`8>qEgAP_s%K*<-p8RCxBr#B!7|Pt4|;P^k~=4mU!IL+^8s-b85t>B!jNM|9+2l z;`De4hYyfF9ab*u`f>PsDQtJ1rOaA9r(f0ZE(W6~BDx=n#T9oozGwO5>dm3vUemo`;?c|Yf=u`h z@PMmOmg72aBhypKG8T$5BaM4)^#oV)+j_XuKqnUFw7#EL^X~3+Q&98i0vShRmZEkv zX&6>1p6f8@nP@4_RpxMPdZ=2d${m^_m&PKF7gr-rOX7!?97i40Ijm|~iBBAvXxnr< zSkV1N{zSthd`GczxWeJr2;x>q8ecl+^PV9(ew|CNAfm)!LZK_cl~9fGxDeCw0?H<;BGt>L+ z#HaPQ5x7Tz2lL_wF3HDR$;XvF8yg1UnX}sA9MRI`of5NM5}Nq5OY>G&f@!u6ECAM?|*(wTMy7D5hrWay9Z=E++c}1ciKzPQ(a_<|9b={{k>!u)!wH1)&Ye)Qi zNB*;3mnAIl{=�Ornh_CWjPAe6T)sw+5;7D>!^SY?2Qq)hE%yEG$b?(>5DhWmRyNwqsQ-_aWKy2 z+kbBhSzXzy0_Xe=yWsh!N#h2v+jR8=316e;fbsSWOf4=7DllmV$wJdbjNc| z&<@^eX<)!-ay=7KXJ3hoY$R_aza`-Ax34bt$Hp|Ve!-UK)%4H7IOuL6%k+`4{Xx0Z z8tl4z>`Z4{J4#FS^~C+()v zet~r8`3l)h$t$cI3khV|H@i_#|I0zFafvTGvc0>OT1GfiI_b>!pF>qCA{ts?oU`#=4@ zh*qa<)OBlKQurt$Y|SUEZqQ+&DOw)OqM)mYP~>&;(8_y~jI5Km2M&HF&%kt_49 zmYRG8huni`>_fVjarj1S+IL;+hE%K>2GhoB4LOp}ocvgV#42gyxg#$ZsZmy`#d1bo zzLD%HjHX9&3p$A)>>o15aq?&B3Lsw6Bgiz&%rcm&48VX?2&BqnTy}v{(^>ij|Bg~h ztWP4Q(8)9*LAKNFD^lC9C!hDLYlC9arw@!Ae9jbY@AJGgqii`+INciyyn;qu?ch>c zg34J#%2}8Eo!v~^9bGW!R@6rxBWx^dqimakm*$$6rl+t^a3F7?*Vig9oj`1of(Kbqs!5jw->eNMe9gr+`3ACP(@^}evrUJ!3=XWO(^Ro(Meo2h%F z6;^D0eAF^8@&dW^mLBoX_wwPU-E-e3qR6G#%%77F@Hru(^B9Zxhh6P1wK)w}iU#&@ z+~m+vt$mYio1hF-~BoLBAjGJXx}Q4x4H}-3fMnoDN)e{)_frwsj7lmxhWs4o_z1YDbsWiuJ$Wo(QV|wS zXGh4OlwvM$eX{>;QhT>Mmmca7|GRBnjRC&vZd_+PTzvjRHk2y^QOKxdrem1b)dYCS z%C&J{Huq+byQDc>$=nSO1bTSex9CE-K zf0T#4`WA`pZ7JzV?i`>wdy6=T@0`O9EGu71!&0pmTrbPN^pU44avWN3sY7xt>$w^k ziZbcvC7mihlGJcnF?n62xnuzB?i%G87#-5|z@RU7kLLap-9N-Qj}}Zxe8zMoC1nqy zz7Oeg7+nGsW{s4p=~(5BFd8){0t0{7sdF zPEAQroFl6!l_$CXM<+A^)9_1(5s{g&4T9lQ~+3M&!3+wao zQ?%vfDPDKaLUIbj{B;fA_4NaU@4$yGfEop)*kZt=;-m{NWvxNCw1pWj#w3m9wpanT ztbpPPvJHx;2SD&clG-Jj3U!M3Iz>tgZ9WlolMW017Jv|+6}Y z3I$#i@!1PjJ5WR}tX@&Hg9mH{b#4b;F68GcCD(H?u$G%3b0J?#zO=T4aQ>?W1nWV9 zbpR?b*TUR`RKqdZfD@qT2%ntmAe^0i2@5IYul3Co)A)BDqy#Latow~xjB8s&p%RL8 zqZU)xctCg_P#C{qaA|VisP&Ga>EnK7YPZ?t(yNXMk_0SYITy) z^ju3DaIXz0kl>A}xfnM+Cldf4LXf!DwQ|)tslDr)0SG^YkMshy-PZk#768x%lBt~Y zUUC;Dc&t)dqY?&zdxJpb6z_AdRKaNKVfp~%4Wy@tPjDzNWmnrA$|*!1AP0e)QaicG zr11|vNExo<&s|JG-b@RGqw_0e-!hQ97~E!1O6#SXaiE(S;v>m;kxY7datROQ>KJn1 zg!;nIJTU}%qrD-i7zTg%He>=Fa#^P8)_Le1rs?sUl_3+DkWt-^VJf`~QrC-2{=6?N za0zV3Yj$Rei`_GGGEn%?H_)5Z#@6h{GhP7WMEdSFvRq6^s3a7w4Ar4QpK*o4N7hJO zH~ftD0MI=W*P&$P8P3>Wb>*rcVkEcx_CMrEkmT4PpmMK1HmxYO%KMp93ugrGuUdr6V8)qjmuoTWXp zctCm}|4ZHRcl0S_j%H@LOjRae0J2FdFMrq>E)-Q6;`oo)3oivhN>cVQ(iLj|uZ|84 z-_&QSluj9_&|6H1qtTwx&KhYupwEX-B*h+{ia3MwzfZSI%yCks+aP?z>t{r@*xZZ($MUJMRmZo~(wMngMvSi2~O|^5j)8X^(=G=%bx~_zjY}_kWy?&a?bz z9g>!p$eo8jlKSq?ssrCVf`ay4w;@78sl5c!ii6zbADGG&?fepO4T+;d9PlG=_dEvU zLNp$K$)$49qvP1;Mn;pq#dJ@f)az`QU#jf;sm{LfaF~N(;OyrQ;pXhIA8g&tWq)@a z*Q&jgT`!k9zqPWx_s7V36eNemEc>wUaeeKCaDJ9qah0Zb+G?ZDgn1gBNUNnyEXSmW zU9^qUGh)F>NW`l^_TsnKt(Qg6R6K1J@qP`vgkxJC^=1c(CMXt*y8GR!@N>S!-S6XW zJ(E}zlT>L-zP&x|dbrZBJ^Dl}3X3YHjIO3E;;bQ?YPb;!cA33+)M1V^R1PMZ9uQa1 zC&XGJ(>;+7>K|I*SneXPWbO56+#ep-){d{1(=pKQw)AI)UE5(F9px_Z^27f*9T-g> z6fI*Bu}+x-p$LcCUX2HQD|=rSlD+w%Ss`qe`N!kQ=3m96Bi^ewRfiz=hMZ4=FR_j~@PbKxdF_weD*W#+ZGL9yUcE!^KcGHLxOA}B}%a%Kp?Ejfsdp355U8bNCN6x zmLP*(CU>J(ru;ROx3cE$3m*M#yNyRXa^oJ6pq(adctyD{&?f=-$roWVvH*O(HklfqJm&l0c!j`Yudb z>AxTLj7tXZCQ2(+{+&egJPEa@z6mVHfD=d8L95D|8!ibrYFP>&j5oO(vvTD8qcdC* z^1Fp3GPJ5q(WRk&RR%oQT4jw1vJNb$itg5}g=pn}*G+0BlKe)L@Cq^V$8GdpN%S5h&jQ!kRBX zSUED*Pzd-~MQku`X3@{7i4=JiP;LR1Knj@)J8ng8@yWd!rK3Rc{K=LiTq_U;-W_Ju zLM1#9mm-KUmt!ttT7sP2?tXKkiwqjNUkdzg?d?Bw!F;@mL zgD5wieKF$#v#2g1#Ea>BW&;{(0~&1EPp2_T@4|SZQAvmrfn7239Wj{)qPEvb4^H4m z8c8{glxZ$1)3}AQ1P^Q>R|MGcrU_@!U(^P^L}x$6VU)7KMFuKTP<($%7zOaCvi zwe0!pWBNYHo00(^^Rk~tW^-Qx5qiVm>9 z?pZM@XLY)b4oU6#cC5djE*QW16U|X&%PE(|Rd!04&EGa28C&z-+Rpi~u;@XUJ@x;T z(|==T1I8cnlA#{#k)CnCSU*YpIi%N+jLyu;q$d%Q=YvrAjhI-rCUQv+I;%8TJuupD z&JU4J26bZ}ELkUCGh@qva1Dpd^hTQU4=v^42o6*d~<=BM97L%p1sIJ3#w<>Cl-XU(%V1$$e2xeKI6_vfkOt zaJ;=^hgsgT=PCAmNS(;bE?2|E_i@+fPs3AFUm>Qrekqkf@usYk)jmI3h~4m#RP2x*N$B5E?Rih-zb>$=vqylz+25%<#|9b8#gS gA8)zTKRy^a%v^7dpT}>_8=uluY>5%9W61vaA5Rm|z5oCK literal 0 HcmV?d00001