From ba77705837d84dcbb4315f76f4ec7d91cf7665ab Mon Sep 17 00:00:00 2001 From: "p.loedige" Date: Fri, 8 Jan 2021 15:01:37 +0100 Subject: [PATCH] generated documentation --- documentation/build/.doctrees/app.doctree | Bin 0 -> 12060 bytes .../build/.doctrees/environment.pickle | Bin 10819 -> 21726 bytes .../build/.doctrees/interface_handler.doctree | Bin 0 -> 50777 bytes documentation/build/.doctrees/modules.doctree | Bin 0 -> 2618 bytes .../build/.doctrees/ring_buffer.doctree | Bin 0 -> 7052 bytes .../build/.doctrees/xml_reader.doctree | Bin 0 -> 21370 bytes documentation/build/_sources/app.rst.txt | 7 + .../build/_sources/interface_handler.rst.txt | 7 + documentation/build/_sources/modules.rst.txt | 10 + .../build/_sources/ring_buffer.rst.txt | 7 + .../build/_sources/xml_reader.rst.txt | 7 + documentation/build/app.html | 159 ++++++++ documentation/build/genindex.html | 173 +++++++++ documentation/build/interface_handler.html | 340 ++++++++++++++++++ documentation/build/modules.html | 100 ++++++ documentation/build/objects.inv | Bin 269 -> 680 bytes documentation/build/py-modindex.html | 137 +++++++ documentation/build/ring_buffer.html | 113 ++++++ documentation/build/searchindex.js | 2 +- documentation/build/xml_reader.html | 193 ++++++++++ documentation/documentation/build/app.rst | 7 + .../documentation/build/interface_handler.rst | 7 + documentation/documentation/build/modules.rst | 10 + .../documentation/build/ring_buffer.rst | 7 + .../documentation/build/xml_reader.rst | 7 + documentation/source/app.rst | 7 + documentation/source/conf.py | 6 +- documentation/source/interface_handler.rst | 7 + documentation/source/modules.rst | 10 + documentation/source/ring_buffer.rst | 7 + documentation/source/xml_reader.rst | 7 + 31 files changed, 1333 insertions(+), 4 deletions(-) create mode 100644 documentation/build/.doctrees/app.doctree create mode 100644 documentation/build/.doctrees/interface_handler.doctree create mode 100644 documentation/build/.doctrees/modules.doctree create mode 100644 documentation/build/.doctrees/ring_buffer.doctree create mode 100644 documentation/build/.doctrees/xml_reader.doctree create mode 100644 documentation/build/_sources/app.rst.txt create mode 100644 documentation/build/_sources/interface_handler.rst.txt create mode 100644 documentation/build/_sources/modules.rst.txt create mode 100644 documentation/build/_sources/ring_buffer.rst.txt create mode 100644 documentation/build/_sources/xml_reader.rst.txt create mode 100644 documentation/build/app.html create mode 100644 documentation/build/interface_handler.html create mode 100644 documentation/build/modules.html create mode 100644 documentation/build/py-modindex.html create mode 100644 documentation/build/ring_buffer.html create mode 100644 documentation/build/xml_reader.html create mode 100644 documentation/documentation/build/app.rst create mode 100644 documentation/documentation/build/interface_handler.rst create mode 100644 documentation/documentation/build/modules.rst create mode 100644 documentation/documentation/build/ring_buffer.rst create mode 100644 documentation/documentation/build/xml_reader.rst create mode 100644 documentation/source/app.rst create mode 100644 documentation/source/interface_handler.rst create mode 100644 documentation/source/modules.rst create mode 100644 documentation/source/ring_buffer.rst create mode 100644 documentation/source/xml_reader.rst diff --git a/documentation/build/.doctrees/app.doctree b/documentation/build/.doctrees/app.doctree new file mode 100644 index 0000000000000000000000000000000000000000..e650f0bad7cd2b81e27e7017293307c631570352 GIT binary patch literal 12060 zcmcIqTZklA8J?Y;Tkp*D&TbsVnQYP$V|q539Rm?Ii=x43aMz467h}L!RCk^3Q?=Dq zm8$BUSxqoegk3lfk(3WUNFWbBDA9mh0IGHPWY6Vk61gleNV&lSw6?-A5NN>oQ>_+WrZnm#0-K)&$s#* zCMW>S+|PE2TxssBi6jnW$HiP=f?S;N6@G{x7IP^x+hWGGJ(g_uTPD`VacH;tF@zwd z58GA*2E}~aHKPcF_&w{HJ@sqB>IeBp%WR(yS%+ZyVm>yzG?nl=U*n5Jk*|wex47S9 zTY5T2`v!S=+PNZb2zZ zU;G64=GQ|d@4?><_`4B*H<1hwKC~t0O-OHhT_{g1ktUl;l^al=`n8GCgwJiqiP`5H z{FZ_Yr-#Zw>;@OlK$HkXyl%tqG-%8W>{QH%L^;%N@lE9rnSrY@%x@Pb3b>jZji&9T z9zcY^`q4e~hVj46uZ5-g&0+?Q+TNqSCT8k1V?;I#827`H-$5^0o~AONL1sSFfY`S* zTK!Ikk@)g^L%JqmT#^{ccH|OSNbp%PLp&=FUQIu8mz{&wA5xy9xHd=Ys05ZP8fkQ-FRNZa?~V%f;D1eJjr8L1nZ0WTWq&X}_Xe1Q8_qvMB-keL=G zAk(uNJE0xZ@7R~0ozU+!2pm*A)Ej1{Zi3uIMPyZ69b~zIehf)}Sk2o>G0&q$TuF?c zI|O>)CwlO!DRHD@GuJW(Vxv%3<$OVz`Bb`eFwl?OlLeesS#c;AoO0K%$9X1+`zrvw z#Mj9O&P^3LZu!>5J#0as#TFci#iJ#vk*tOtv)YQ;nfh*OQsYnOw^+CW4Y_ih*88n*$p$ zvgGpse{+H^`CkC^Cz$oGnd7Eb%pLhIT`+Pt-r>lFENmbZdVVZDSwUrft$eg$NAU1R z`Yb{kOnv*UjF6~l#F;-7MzmJI&zf`B1XF8kk^4FymC(aHIGu790Fm*b1a_7SLzA5J za}(GpIO#(ZK#NZ5+yLOJPWpMkYOzx%%_Sf7(|l%_tLC$}9mulUSmI#oQ=9F}wVjVl z&@6>O>fPhx@Rmld|mN49{hU%FKFb^cS?tFj{%&brRO z^eS=ZzOO2VYC>KZoY#E6YlMhdG>)9t!6ws4ZMtgAWYXarT#(LLAOw=PFJ`=@sb$m^ zP=*MHyrGD47kB;+E$Y)=`jsB|__r_f@2E2#e-;$K>nws3a$}t9oVT?43k*J2X0XZg zEzD+mbi)yiPHqj;b>*JLykOd{*>YLB{g(SQotpQ#N^9P^g_O4DoUE*Tm9W;YnlI52 z&ABNhk9zd8LDgJ&f%-6+WBfjyj$Y0OiHr5rO!5FWx<;*0jT�aUj|NVjL8Bx@Vt; zS#$2LAT3oAlD0x6ac-Az26|-_hRsAKsN_=47Rb9zCP{tQBA+oxi50vBP6-|25<~C!P z3U$t~^Ls*Y;6gnNQSNlki$IRj;nY z64Gcos=9W;_3-NYB+a}H)%7|&v>I_}dJ$fFhgH}Ws<1_%gI3vk5lJ(9Oy0-&`CCvy zwal6oE~>Q8=vCtOeO1~byLjuT_u~A}yi}f5o96OhIi6n7Z0x7%=FB_K6M_R*-C>Aw zXLP;^r>WMQ ze^<~2RS?oel?w953i#-JmKnHu1sN7xdC(44Dp^6~L3elsIXN@7g5-#srLHO2f3}&n zLa>ZzsVhzQPEa(|aMOHPrD=Xrb$g9|V%1%1{3NYCBS{A|H``J+qPp6|Ld0Tf zf4I2Alf)C3?H(YG?0(>kgGI)UZ&g1h) z`q>X%d@aX*+n_EungzL8YBd#qmjP2Uc zRgA{2C)>f4NjN-l}I?FIeVU|!p&NA^V2`f+FT z^d?%x5^-&L(vb0NaI~SgEQFqk)pm?FH9YB*vCK*=i8wJZGl0T*5DqEo3UAKC>;w0I zeDgHumnQ}mixrX~f}%K7}82Lt@&7Q!QKlUSMd)gJR`?4WA1=(ni4T0u*IA2Fl2QhG@{HZItatz7h|Vc8Mg6+;k8uUI&r1q44SmLN=o5Rh+b zm|IT43|Td)rL!Kez<^8)q12Z0qLCtiyMi?NwrKD;4x%$#TRS^D=yOD~k$1`uyIXi+ z*#cy=m55bZK^SR;fesXCIhNgcEZDs9{kK6a^{~?(AVVWLnQJpLvG1dq)@E@>lA$92 zNYrApg%Ge}o}60{C*V*$L&uh8-%xFUm&H3JH@1gfK_ixuHQDX?;s7HXmfN1p`|KRVFim( z{xPund_O=#2ek;xHr_PcFT+XvHa$({@qe5$Ley`S;Z|6$g=X0(z6e^Jp$p`)SZ%w$ zdEQ`XAaM=!RifdMx^pjy!_2!tt-NAEWdejAya-QiHvBp^R2zxp_!tPmD`NC5LpK&R z?mmWGRT`z<5IGEN9sMy!-jBXufX~yQ`rUMHrGjw^|M0W?tb8+3|Inq3yr+@dM)^-) z)MzE$Aj?K$xpteMy(Cv$lF*kVB>G&gM@O&1yXb5Z`YAD&_QT{IkJz@*raF82k$`%K zn)mA25h|1HCUU+(sB~{K|4`bVdzRm)*rtax#Wr0*Dc)&Y+!xD5r;~bEM%RuEFLG}+ zLWv=RQwlGRC^$F{T(8&iUG2vb^c@3(8oE}(Sj(u&MaN6{k>kUdipuIBu5<<$vPfGR jtd8bFM0jH*}gk7cU+Qn?smprpU=)6`8dwW#q9ZmJClUuOs8k2ce{IM zy2t(D-OXVL65QRQMzNF*kRb5~A3_MB@S#KqMG%D#At4Y_5Qr~<5)pwSA&`(FB7yi- z)qCANv%T4!xm7G{XZpRWdiAR6)vK!adOkV)nXleH#Q&0ouwy&kX4UfUIf3uBEiX!w zx$lpiR`dOZrcbBmej>e}E+#`}r<2}DCYpXD3M{MX1ZlEdv;DSJ>o_&DV>OMYb8-`)nuVE;b^_nE z8j#AV=Wo6LYGv{HTi2GZ7Uy;@O~xC3XDe{lY=A8+pI^T4ROOZ#w<<6F(HENz$Rs0X z9N9i(HPzid3NDG8G&z(eqk+}3%n;ziA6l+nNRye!YIj;@WQ9h@jBMg~!pPdd=(GsN z2; zXKglGanqvF&?z#S>1?f$9z!FHwpt{T2|H@HjL5dyV0GMVnRTWGeC`NI<&BKvQQ%Pn z*qx_-+iG_$<{OGG(@AXzH5=gu>&KB4?!u-E3Q=#6|nbk}*z@ahn}yNe|A3o!Zac0jjxjn2_c%qT{Xl zB-SnlPn0qUWcv~O{YmAfXH{Ab{=i-vfzu%cR{Yh9vb`z{{<;%3tQHK@^5c*>oUl4^ z-H4nBO0iER3;d`xxazc+^JFr#%%EXcN%Y`whE>!ELnDKj<|en$GQ*_0fxNhlm1nH_ zLEDVj6^w>rX)wxHO*H(bwN!8UjdkF^ z$jNCI@F_?$Du^+<3hTxmh8*ilc!w{B1UryU+l3|_@Jw0llmFDlUEBqxn z8u?9gD^=~uI6oSzZCJiQo|MmI662dK%YY+de=sV~VQLDYQ!*Dr`vVr5*zL*J0^g7B zS6|b8_g{l=xu41a@3fzkFHhKuLTXkmRm;Q7F;}ddI9gr0vJ}Ff3CN5B>6k$Xw*UbM zji>A-0hnr9t8gok5x`Taxg@8|X46=WJzn*&*Z^zQwn7N-O~INYfVSU^F;U_@>v%K@ zoHjJ-N1h*9MqsVNTX+r22s}`Jcvw>p3H}FrxRE(;;aXYkW3>v ziHWi|Ga7!o?PCdJT5yf%XND)>{|u|+wEQ(KKyJcHD>N;zWUz?gdLv`CWnye4&6y5_ zW(HeW;%(D`<37@XrSaHP9yUa{N#0S@8#jobIcY0wJNMCpjw$#Tb}vR8v@|PYo)dMP z#`;#e%|J8i*>Ki8A8YE4;Eu>*)EYXb)+W{?zG46EV6Rv?%uLy@*tdndS*%;z06-mX z-)yxs_B^*+cOfUey7lVN7+3{*`V&zrG_Ywot6REhlA0Q@m>>%EL?%PXD7qWNt}@9j z6xs}v%{5Ji?p}rWV(}d>_A5WeULYCQYm67^5!Zwx8{>$AmI>T*G6ZR2cZ2(lQY)63 z*X;AkxY)t*ex-LM=~yUq6iibLMf%vgCQt6VhtNh{(cWI|2#l}xLTvhx^3j7(k*!v3 zyu$Q2GX`Vz^&*+#mQ@pB7a|E+Irep1eYt7hVnq9byd`N|g+Y1ype&>}?ajh_f*RPh7OMi#|}@8-8R#Ks83u6c?KOy9;sFovJxIoIrsA2 z6Oqo|H6+7|u#B()4;DaX?AesiY4>d!aHwk**vfTsmUUun!Y&+6B3cHuTrxHS2a##F zo55MzA4eNPo@!jB{!p4aXg5H9RFf+xN|vG z;PM`v^%dv_R-0m@?*4~zT!}SIuK`Do_#`87ItOVx9+I}8ZL}iwvuqm-=>RyMGvvFqgaU>H+9^G}X`XJPuQ+_zdq*xqbsAphBcp$S?;IW{j z3`_!|J2|bBIV~0l{0Jwk$!skSgIeA3YPJ(cPAf+#$S|WTIP)2f?#Qt!`9QFG$|ej7 ztpeJ2BHwR81?*m?IfKcw%w6nSA~A;5ruX9e##Cu!nA+LgRi?!WuWOO`=?_`DBwZ3( zBrd{Ycg>tm+6ysaMmNObmR$XWQgGb3B!#WrYX(Oh$5+hZ1G3 zIzUTCV{hH_H(*$rval02WK#EvlNw|67)#ovcJZ7dg9epV(sRY8H2_+=N%0$4S$Zj; z!coVkXj)~a++qKq{jz4s{sDVMphYB+-%z3KkTeU+)Qnn=3db{0Y%d)|l5Z5pL*Ora zOO`nt=c%>fab?fhaGDe=t2qkyyenhDQ!cCAuVyh3h(bh?^~^ElLjEqo>*=S>J8%78_6>E zj8@$Clw(i@BmzODrl}LH(*h4C+_LUjEkl(yC{LF>?zjN-#<9$gqFJz;BOZct-Y5l) zyC~a3lBHaf{fvE?K~4%tA%NB^gu7J{3@JvVWrh@XbMqWUOIW;(^`6{tKJN%D*czhk zmBWlu=!pD|BEBTBn?9+onJK6D^g60Ya*C$j2I;A?;38R+jAqlysL)T(oZ;)lbU|(hK7GQH+ zwcBY?bGoZggk+qPx}(%0vN~Ws=VVM5T10^-GyxCQLMt+z7UJAkSt;R1+6WsqrCZ79 zJKw$ZV~;=iag{AkGl*wxP<)8);n+i&L%iQH?xVaai|ey2oW^C+suIu@?{kbiv5D#~ z$|e!w0Oe&LYIHi1YV9nmFwQ&!G!4{^*}Z`ywc3;8)Wv0~vfg=eA#B;8jKqeHAC8Kp z%Uq5V0Ic6=TU@z7j6@sSgxTuYX5FH~vH+gYfVxPgqZH|WsJA=ct_9%X48U)Mm<7Br z#YARA#Y`oKoEg+Dv4wPy-RCnssVS(cl!Gc>07tKo&**N)!&Z*m6|<6oGUc4shY-e^ z?;}siK{Sz583go)JU64E0nTOsjwi)@2Sp@f!-;GH)>WU!c7UO-br0TmACO_kYB&hE zdTBn9(Ioe3Hc@`#ngErR5T=|vSQ9a2{6?oGsw4pC$d@5G6SFQ0>_*JJ>)`H z4@}Z*YpHd21<@8_39a)ktaWRP!gSr4tD_Mkgm3FLs|#UqTu-JY_2Od?q(3W%lkC(7 zCGKQSok58sL7qtvr+OQ0oJgUl8&Rh|v&%4WB!}kHJvgp;&y>>y>eWYG8i^9jbmd5L zq6e$9g@Y=uY#2H@Dj7YDn$$cZbkdc}adKP*)3k;#d8rJg+sQ&#JHipHtZkHweX69= z)|QN6iWC4z-EWSTJe(MvJ0bkV?6;E>$ivNb!vabRHrAvvFl^<`WU7NoF-82GtR)ql zy>D!6RAo|CKUk|Fda403tl@Z#FbW2ABbf?T8wDDVXd0YaR2?f?Wg1jIAbf)E!k=-x zt}2WjCo@=doS7M$bap~gpx`2m>)ovrwu!<%M<3XIlapLcf>cmdMNo#q4kbIVJ18Bhs-Y{kaWc-ebvjp|6Tej-X+Arf^i!}| zePB2$#|qefc+&_hlbtgk5-0Nx{CTj7!mt7BMU4S&dy@TX9mkb;dXS8v4lPt^B`B&d zKL5A>H~w3Xe*Hu4>XAc-=xO4yi$}ldu4PZr7e4DYv!~6AcU?Ps`tj#xTq}Ee@TG6W z364!DQbcWxq9OZj$)wsM5IoYssML~Sc9_Qyt+7w1Kb5|mF1iiS`Bchm(5$Db)f)aI zN`OJ3%pi|DX33q$q?5K%kqWn7=G2yzMzy1w*yY9QI-NMyuyuv&1`Zqb zU=Miq#KajP(S?k_q0RJ<%cun*56I~QmMD!^PVxcEnEFd6`XElm)b@iU(t{Y?yZA#= zO{P(fgPq_AV#C}DVNS_d8}Sdy&87nN0h$ae<%lNM(R5!lfe*3-e2@v?gLID%Qu=*5 zKIC=94#XuiUV&752&*2|IS^kk1f7V>ordwi+)(vm`)o4Su#wN8aEJ)T{R|NpzKxKH z?BtmbTP>tfRweQ)yH#1f_Q}tN-3J1X!J2p=_j5$;>3tA+#|{$7h@9-D?$3irTsIK` z<*^p6o*@UtBlv+)j-D`2d_OAZefTzpoH>7}!_YVtxdVZXMkc}>I*V6=iR*0g?$2Q) z5fO84pLKr$Es)AD(mW=x4l1(#yC+!eaDN4$?(gCcSayFEpKpa#_qU1K&oVVOf<0I~ zwPS6TGJHA%dsTZX4JZ8nX*d7wm+%ZR{DFLYSw6lZAAigraTlv(sC%$FS-3jWEzYhU z;peYGuOQF9`JolF2R{o1AEJfPWyZ${;8i65tdT^HSD8Y(igiamqf#!%4I%qVu>68 zfzKklDseZH^%$3U9TEhdsvep>7NRHS}P`{knYohJ5^{e0-iiXv2|0Fk++;FdYX@ zDjUFrlqlH8*=J>GCgb_MWXRdRhg6hG1S%BAnW8&{k5V@}g${UMxkaW2><6+Ye6NL~S~7t>Rg-m}Cqb}B%%_WlL0#&*xbF*qH9lP6D{RRy z)jiUcaS`=XEb45B*@v_gKV6Hhs5VRQR{N(_SdKzzn7MMt@KI_2GrM&h+pUAw+QKy{ zdsYxtSNLjG*u7~W#a_oDd94f{xfvY9Ol?d5=0;9_KclsV*k$5sA z@zFs^{BTA>^wPhE-IsZ6arC<`>w{KzF`g=Ja_;ZL@rhV}rbi}w2PoxgrGyKC9iL`) zxl4B;6W&kvJ(g18bVlNhK}n2eBz|&G5=R(OcIfY#3ilU?x_^-=^!NInUb#XkQ`$?R zU+8tkO$Z55YQEL&ts^y)d}aRqTj2t=1kN`5UYUa~%)Js<_usSic?sswpLomHCrxm# z^|{>lSUc8dZBP=qDxVsZgmSW+nSa+*xkr-kek;@D$NQdFxh83Tduj4c-(&62p)5PPz?_lLbi=brE9a2*s9&eIz=(hM z`$z|_`$jU(_qJ{Z zH|c$~8U0?wEjq2lsbVsvTb>VaN`_srX`$d7$kiRZu7=|#j@)k~vrhQ3RqWlyp-!Q= zolF}hE=#>del23LwLLl1REyK-0Dv8rI#IS;`f@&1SXD zR<+Ig+h&{EW|P{EGqKVO6*)Qe${{1;1ucG!C4C)lg3&PyPDs@2hPYPB$;+626NX^u ziX+3US)LW(#9CfWgfXuAW$;rPo|IJvK({fgRC>hKc`u|htddbn!WT(5z6>FPDIL}=^gt(s@}r;C_GdF5jB%NMX#3~>X#2> zItO9(%Lifg%Lifg%Lifg%jH(zpRJY4wLco=V(pJcxm5e3Q7+W}XdHx0%N&3$ire7R2DXOT^>Kw)1TFom^_gNTGT%>w@7er7sUKS?<&PNEsIC5d65GcK^6s(Gy>xxBO2mJ)DOL2}^829bF6Z6!3vr=Z@}Pc*ZV%>BeHQEw(e**fo+k17)>?iiS0@wW4M%=K zgc1o{rBqLJ?T%YU@aq#6UezEHV+iy4gb))0C%DU_ePYqEBsa_eu)I{ z)0gr4qd7%fYoJ^(7bZ(kiShN+4FTFa5j4~Aiig+JOxd_`$5ZdEEFk5l9PLiJxCqH& z?bB~UP|j6Zl)MhVq%tAjme5MCibl{*LSsK#Nc9%aRp1%bwGMhC>|E-81?E|VKS%H- zX# z%Y#w-$8u^H2c!1S<kxK`qVrdB8*pI_ zl~WsVVU3hi8*pKbms1;XVNLZ=6XP9F3A3fd2GqeqDX{@naH5phfEqYeN^C#{JX}g_ zK*x5rl-PiN?XezWSF%J|Vw^qq`HEy_*x;Y&A@yt_XYQNWJ9>y+$~*Qr$PP^F73#=KQ*EG8Z)&OP#TCmX=4J#|yc2A?93AF=wH-E82X#kgpd) z!~!_9eMOJ0B1{D0l&{kq3V_AbKev?UG_J*|Y|ikpJXJ36JFoc7JGT>8to{3cT0XB#cn5LMIFO@dNxa0FLeCw;Jd|H);UmbO36o^I2R9!q1lRo5OfT K2e1FstN#yNdV^5_ delta 1772 zcmb7E-D?v;5YI=O7^_x_h#FE_B%1h*V)a2$AyK4?wH84!oR`ZsckAUY-iNf77^B#z zEPn0!pn?j1p}tuB14Q%>@JXNaLFto%AigTj?xiuN7MhoxnVp&6eC+Iedg^~O)PA<@ z=GIjc?PJk^8hd#;+8+q1k{VPi^jB>8OP>$;RP6`Pe9J|6J-_U!ubJMtp-<*-e^ zcW>j6jW5da5VBTCl?)leV0uIE=CjY|sNJF`I-O&C!vENx$~&^pDUr zz5D$odb&5|AEU2&k8H%F;O%B@GFLZ^e1km?G6siD+MI^G@CdyVU$&tH8nqjr0g_<} zJOY$Nbj@}o%|QjoBUyn;5_rmvPR2L)O$oxO=3}8@WFbRA(|tU%3LRLH+Qwb+I6tcV zcn*h~mGMQOJj`XF8HR~Ru6X2{M{dw}E2946bYlIYGJ`Aplpg}-F>ten5oj(J5D)7R z_XPyL4Wy}LVUHgGAz|pCVfc&>xk7iOl zn@LfjACpTW7g%lFKw7#{RQyAPYHdVPs}jv4^1T%pu+6Y(Bl4{kh;k!FbK_cWz7O;F z8&m2%lz+7xd$*`T?w2F@;eePm^s&5XC8c8L3Y$ei}|W-OX#F4JDO?KSLr2Nn5%dH zV&Rm4tYvB0B7YvIT?D5WQ?WoYNS~y(1&#&jWNJ-10}iB9(&f{ml4Hq+t;-JISvbv$ z3Fnc4ELmryeXo&2Bg}z;#4`8@JhYtJ!nWq|` diff --git a/documentation/build/.doctrees/interface_handler.doctree b/documentation/build/.doctrees/interface_handler.doctree new file mode 100644 index 0000000000000000000000000000000000000000..a49a1249e52a27e56ed51967bf5626022e0c7e14 GIT binary patch literal 50777 zcmcg#3veVydA^sV(>-+Zfess;U~?EwXCukdoqalCOduHJD4ZR0xBzqPjdn+x>Dw2( zv-hwuHbp3}$+*DwnqVph!ovj^!ox{nQo(?+c{o+6!euZCAyiz3!sLZ{79^qa|J^fx z&-C{0^z3T)s&2I1(~tlE`~UvG`=6fao44F`^y?e=KYuJ=&ec7)P@654^LDN2Z^ewF zUGkcDHV?eLd1G_hAFW!aYvp=1XE*%~P$K8Jg?!a6HIFx)4gN^Y&UtRRMCF|!XV@7z z-kgS;L!Rpu?8q(uJh$Z8)m1BJzbWfjrF_AzW{Tx}9ZF#(sI%pmeFl5?&!wVj$#*t6 zWzJBi=KSG`1yp)XXWZH7Z1#r(9*+833U0}69<8rf{x-|=s_shN1KyF>&2GL1eEB1} zf>o5Ms(&UWn4+3UY-&M6n|xr#ey zRqT8=Z=Z5=_FO1p3*|N^$eL?mcD7mr+NYK`)mQvowTk1G&dgf*d@xQ!ZYgh{iAYum z-FY5x;bcIN`{4ii@c%{de;PRgQB+;d$27>oEv|9|>eU!N4z&xF`F3^$>sTmxNRCB{)|iqPR)8LVE!@rFhY z9qA|vdaY_zoT#Apyutz>wUk-n-7TFcuP|`NC-@LeI}`p$aKA}HlvzN>7o++F)?-J- zF6F@{XU~9Ji}tfi*8%$ef(tri6(VJwuX8sJ_C*jQyXN-gQFU0R{VlvVe^ccwnv%0K zLUeZ2d7o=R5v(NZDs91vls70FHti z3TGal!JY+^P3Iow^aYnf?# zc5OCu#no3{CEN|DSN9E&K03by(taM*!}jnFI2wdxLt%A0-B@Tb^0QaNM5FVRV}FYw zX`QuTGs^6X)9UOErX5Ga;SDF@uMIQ&2`y29v3LU&Gnpr_JsUS{FdMbdD8syf?WS7( zoBKCc6f)wIu(uLdo4Md{g)!mt-%KG$xn5CY&q*e)VhcI@0AG8+!Pg!*}kqp(Z$;_T&cG4&Pf zGU_ow^R$Kp>6LIVps{=on(ce`Ox?zo9+RLO3U{FyM(;fGO${K zr6&X}VD$-;V5gi9{a!6Di4--YY;F{?xgo7=*!5UrYI!pVHbQ^59_S_Lsk8GJWu^_i zN`@jKu=>?RBec$AHs~epl8F9LF`N!wX)2*%9!ZjRe1v)w=7iET0yxiPA21ew)Skbe zYWb`E^-of8+)qjGJCu28X8uTs#UK^u?bAf1sjoucD|us|;+husRd+$2^i?92?5l)v z{G6XKh@sp13!+@opt>!&0MkrpKM#!P8j(&{wTk|5umBK#WCT_vVvR6L`i?fXZ;5)gvzF2ZGD_e&G@t*5gv#z@?|a>Ad3P|C2PpRCjTn z^)%HQ5H5iY4K5cBMsW$LI4=K}s5IpbaVdFY|AP%EbI7M4PvTOf)(MyMJYI*>$sZHt zl7`f{)HTu`m+Ud+$o`7F{!{EX|Fu2e!3_`FpY7FWc=>da9psBwYJU9>xg58cjsae1Isc;C>PRsn1JVoFKRbTNA8f{ZOMGW3V zwFZPiU_*yN;*Mib!r(!|;9H4uNkeK3>Kf?* zgAV{r{l(y+fne}Zzc2_5>;0g(A^qSX#aH|zjkc+tA_gC&S_8r$u%TdZ3wXZ8a4ISi zaWD7-qS2HyM4;r1{R=jrAn*~$lL!>4bwc1FLf|)ua!EsK1nL^;0fC!0_Zxv14+Mc1 z_X~m0upWWphD6}S3Ifjq$)=x)PEf4@ArRP55Xj>)7ljZEQgIAU6P0N&D0yT1u>l2x z?h46sdK>;3b5?<3zcn zAvFedjr4%QyMdk34@0TgC8f#B@L-DsB5GL3_b-k^%sMS z1Hm9HU-}b~5$hsNM1~ejK}2Rz!Qk&`v`zICG5Bk$H6RQE8#)ZeqN4L^RCIJp+Ico& zQ1ZsMVgm{Wp8?h-21RO}Ft|t<`~}HZ(vTX1x<-1y;2a2}zZg6+5Ddao=Kf$%JigXo zke+J?7(Ak2@bc7piWq!3)fx~6fej4?57KIv&qdX>?lGd$)V?4FC2#Dt*non;OCe8U zP^8uggGUI1ml5TXhSV6;HPQnHuLqj?gux~L@P!*@ZY9Dc38|r{YorJ0JpwfK33_7F+QL9Ktt~+Ku50jh+V6x7 zYnOq+4O#|5IR{u!B^bx1SP~ro15pC2#C$Y(RnF zV~{5yC{pGSOc=xvgO3yCl7`e6)HTur2FHi`jlqFzP+Ne|L4PnPViHjgD5jj)BY;z4 zPz_hS2qc^Sk;Fc#H6RQE8yXBAianBmR2+jB6P0N&D0yRtumJ^wQ;;VyC{pW$LAgQg z`9!&-AvFedjr4%Q>wu>I`oS*epy@VmFZ41A?Px+qL|XKx50md370hGf`>E8~Q=X8@mY`P%!8~p2VO?trG_21~o>MOBzyRP}fKg z7`zu~>MsTdvOx_u7Wc;wie-_;57K%mz@)l~>+fl_P4yHp_yE-!5C(w_jUSwkJr;yi z+zVo>tN9>oR}4BiiU5`!YOP8gIM)c%$zmo%itpstY~F!&76)L#q^WP{p5 zzc#30!}|50vOx_B#`Sb$xSP4?W~wzH47P4i<9;x<9-LPnx9lM*(_m2Y#wM@<1%tnj zVNj&j34?Nr+6JOr(vTX1x<-1y;H5xQe=#_aEouuecj}KH6q7QIAEen@;0M+D+BG!V zrh1Bg@F>+95C(w_jUU9hy;$ucA|VyGFBVa0${YGY$s0R?4Ja7A67r-U6sdK>pxmOi zOq5F+Qe#lpNDmmi1!(Fo1_!c5Z2{&^{lTD^lxZ+Xv$X(&>U`}U8f{ZOMGW3ewFZPi zU_*n!gS7dF$3@kxKc6BhO?g8MO5WIg*non;Cge#Biqtw`P;OCsFHtUONR2^VBRyd7 zF`%ix7#zqJwFS_b{$NljqXvVdr2z(2J^cxdwyB;X2A`r@1HvG%p~2uht#&KV*?8IE`U6VJ&`iUUgzNp9}B*i2$v+JhMumG9-!v{O?`5I0(xCWV$wmcmq1LX zv1^UP2&_>UCQQaP^ldcIrW%T#?|P~=80fVIVGwQP)kPxC*lk3jDP!pNBxB6S1{CPk zAx}b2q}B&|G6Hj&2$v+JhMumG9-wzW(9~Dxbs2z32R$&=eert21+;oSat#7{YVhS- zG|;9RiqLz6Y7GW@z=Y!Uc(jE!y9TK^_`XL(nzDxAldQ2PumJ^pUx7RcK9O1<@X652 zLqxbFAvO4Pjr0J%-vdp31z(qumvrFkCGgV8@3qEV1llO<5+>ss`s}UUOgYD?)?mQb zCg?)je0b1B-Q@EEA~Fs5Bx`IRHlToSJLF05iPZXlPsUt!65*1B)Zo)K(gXOe1e*E^ zzAi&9>A(jwrM`GRF#~J$d^9r?;8VjbSsG|l4Mop)9n~5P_<#wW=Oe?yJ)auQEfJBX ztfA+Vtg#|Cpn&gM$dlj`sr3P$47R+U2$v+J2A{5x9>CWGn)(X9E?);s2R?XI+!yeP zN6@X{qes&MeCo65Ptrh}YAAy5UaB=1@BtG#@X>0PgHPR3@I@lhlr;pOWQ{$54JhFI zE69`J6RGt9pL`MUBSg3)AvO4Pjr0J%9|BE%1z(r%0j2{VtW){|KC%931s|=81o+f< z0DnaTZK|ONzGtY`V891V=)f17cEVos_>6kXXxbSyf={x>He&+{`2GVpm*5kr^#PxJ z1Mt5{x{`#{;L|nI1NbfgS#$tY@1qYurhmUx-p4+84PlB3{TLE!g2pnUQ@8c_dk-j;Y(tRbIYEO#; zNuri!lx~I_U?MqjP+pZ9lxT03sn$RxYGs+4>9oaEIcDcOCC?T{x`yhwbJA5NjMyo_i~98e?9&dZeRUZw8U z!eKQnPGinIq-T;RUzqySW7UF0MBXb+{ z+hX(3$OOdUiD=z^n0(1Cxn5RCJhiDYdgUb2K^tS!&yViMdQUPp&u`W2NPUgL*&ewa z>SipD6p$ZJ@KIy!3z3XQ=R;Jhue&K?tZ+$nV|FC5?DI&sVs_pSdD85Nl%d(tymS;L zIW#=?khCNL9SqMDw&7X@_j))Y1W&{gP=KF!_F_1u38iS1*|)IwN%jpQ!qm+CCDssT z=HZ~SiJ8%H+pU>-68hDf89`hxW@eEO)mp_Zr#3Q1^BHQsjfv^!d?wO&l7VTb!$L4z z+hX&XNYi3N@2JcnrQ@dMx5gS5H7&oQT78|*NTS8^sT;#0No6D3S`Ev811Hk3h?JpW z(adKg!J%3CIY~-(-@&ZFdB<_Hf*<0DowwAX1dS|v9&$R#_TnFYw6Li;c?QW9=H$Gf zvWYp-aoMdoISl>k&50nc7jtqDjdN;CVss{wF#FNaNVq5xvhQ@L(M7HE2TrJ%#Afk4 z(4`EVLUkZBb6F-2XHm5veoNHrhy-Z^$N6iFRUwM=E2);B?c>T$5FejA_~R<~!l~X7 zu4&p8n9$sa%i;uZ)k&*E3BbXy>`jJcap@$b#jZoaafaZWRDOnT)rPa1;n=ju>A72I zDBAhZtK}k}Sm9xFc>Y|uWM_m*gtM!z>XL-n?Lt=XCW@1U94zey0R?`9 zpC3>L%d`#twpG_I~N%wl1WNB+V|!*D;MUh-B@RXtjI+tuN*&a^&`W|5${{rDu% z(g`yl8}@M_(2wDty}|G=LoG@DN;!YFg~Z4iv$GM*XQsuG?_l(1xFR6^s0cXQjwk{@ zAw4)*I15$ErL{;G{`N?dq2k2y;(UHBflq$!W36K6+*LQ%Y#`fT6>NWr*90VQ%1kSf z+~5|SfhmRtj!+&C>9&g%$Evw8^Dr#<4~Y(waeBX>Kra&bPlCYjCKQdHe=LqaQ;tBU z6O*0KM$bHEKY)hWx8Z`~fYXd88OdVf0lg?D{GrT~H{Y3QcXtmCvSz@EdB0tWp!evs zM_NAhxHqKt3sB?l5=4Vid;rQoQPl2)b2ZsVM9~lNqU@vaCv;i?DA^|>d2m#;<-)<- zG|<#}fUcrl9SKkSuu(LaR{**r>%zj00Y^vBgsL?wAb?P5>~ z;66%XRFrv1Gh%c??Jyi&4ujCt9bC>X(bS9v3nOQjZ^lNV$YrmD%B`o*g6LyEz_D6L{Osp}-rl71t#a|r@N{LVlbD0%@e z%4XqD2ulBm81Al>nUu+2?6xJYVAGCN!E;(#QgyJ542k9aHc7gaJ~tb0;q1nb+BH+c zqNb*?65arnJ1Sw6V!alQz+kzY2GGK3RSVmh7sIAj zVPOlK{>BS%Ce5ayZE3+#!_PP9E$~oi{*63T3_|Fv&}o9VNOV{u*9421K>a8kcUkuv z&>YMeKPwm(%cd5W70j0;%*Jon56go6OPT$Av9SL}fsG0O+#8;}`F(Kf$(!$90+o3m zzYU2SBYL5!JjotL0#bxZCfQdFxC=%ExicCO2-?Fim<+*oF$5WY3~ewBvAp#+g+!W{q|EAib3x|MeOT6{MGLve}&RO3$yXLhuS zxdpMSuAdU(q_3|}2_qfoL-@(jx5N67Mo4yK{g@DhgXI!&8ycioUL2Eu1VT46IblEw zpX$AgYW4N0UW}E2Mdq#r<~l_gLP20;?i$0g7@3noV}FYBLxxx#z(7;Lh#AwHEk<%r z3KJ=@I9=Zor)&w@m9aRHGK|G(o(e^W4Q(49*L*2aE}2&!K}<)2Fq*Jh@Ng3rfF4HZ zR?F3lm05F7*`;VC2Igs9)g@T4cOt2i>>WgLlB|XO-a9}j@W|ZF0fC@JAB<>`@O#tA z6R2pMEu6wfqH!b;XmFCf4?61v3iKj@@4gG^+8YdW@-*tgh;8HHw!~N)dnm$g+SuBs z6Br@a9fs6C!7G4TwT9G!TgsG!{d1JO%@9Bf?J)lxm+M0bV;6;;x zWE494KLZj20R0Y%0)TGEKbp{4EsT3n2&EsPGl&F36SPWy` z<6_U=2{K3<7n=+!0cIm%CQ?0a&!(V^YR}9<66a}Z8iyqILuF+t;XK9Oh9jL67Yoz@ zjqx5%0n#St(W~kgz-8w|T0)4|M)1Pn}K;Nd+2v|(^k?_XePGf}e zRnere9w8O4PLM>49<^_seHbhm`v@+gLHU9}R|H_&4Y~^a2^wo7e-gt4x|VegbTtiV z4jjzwP&CC1?cB)L!q!Khpcd^5kkRc>28Q-yNKmT4*M|+b4MqsLH5#EwX6o@{L9XP$ z*Vhb)4Tk0`C<*h)b7aM+%tB#Ubh|memq1E%63LzbEmh1%s=(Ld37rA>c;M^X$>qZ7 z8_FluV74~`2>l@N6)vUB17EuJZ2PW6;0wj63w(`@^(XLk=yVkxT&CV>cEE)Nc6HUt z*;&Ub#*^g9ve#kpDoePY z4U=)XU!J;$_P`0L!T6aR8Mc6fgtC)0*(Bu27?wyG#;~5#MjvTI*%bE2{gdpvQ}k*d zAKqHVDg_Fh@ycz2RVGDAzHAiBB= z-eCCJM5PiJxMI;8SzR280JeSbs%jVPQx?Q5MQH)%o}yUI1jZ?x6GpM#!z;j~pf!pW z+*0NbsiIh)NFWEtA&6q#n@}`50ZA3bx(^yAws{nbcy5Ve(H(6Ri|#&O-2kQzBmvV; zEDET_cB2kS8n1S7t=kfWg>ns+&hO$yV@u~2ZG9rC zE9c6E%P96LN`lpb{a0wrAmpx7+aX>q^anwTq{7|slL$|{FR=h0y2dD^vn_d5o6P*G0fc4ofGgFke` ztk7U|+Jheg$fx}XvmskRa3 z8-3;Df4Q!_e6muqmpb?4<8R8}ktM3}RvR7nx$K=ZZ&!ms5d0DDK&h@ZKjr7c-h zqJidZ5Gft)0e{y$Lj5%f0*qLjt9a3v+w`vxy4Eu|R8@Ny^wmbyWM86^+~j+EPzhCy zO36qocd>VB_%&0tcWY`ItJ*zKxwEQCf|c!+!C;NT`1+g#U~iFBEu|5X((n(5nwGW+ zBE(qHkoHD`_!1QDWo@5Lq_CZl)yQSNwZ~O2-NTP>f&da9emts?l9_sbT~pIoJs*e4 z9o4hL!;e5ex4{@c#AyKioF)A<8l8w%&V*WNR*^b2)S+Ig6b!Rv%MuW(kF^$FjsFp+Lp9z-^YM5lU$a;||yf>A_?7>%MB zI+I~b`3U8R0kJ`(=Mt1eLZl}$e4Q49T&0xNCRl<_RcPqA)*VeCyW2%!M-t+T#Xn9U z0qg>Q2y;bpx$q$jN;s7|v^OPoZYC)w`MQn9^NB-8%6#d5x0uv@<{()7=zCpa^~6Py`Q z7~b^S2Pes&e>_?ye9Dsv%2-YiHb>52mg8&=IJ*#*rJFj1Tm9i$xn9lLP3J6m`A7X7VNSs<+0CQ=)|%~kU@&V<|D1d|SNGgPZ5Cd;#yy_-raycwu0$hmq>df+ zN7w9dfLy&4u54 z<2SQ5zH%9kJjfYIg-<&8yTlWoNGn6Um8L(X+)QalhW&)}dbSp^)rT|5V*TdLvk%dASx zuII~Hc>NSgjoW7`<(i$1*5q1}^RlPhnk!UvS2pj~td#;Xg72&5_^lSxY zAm!3*xw%$6Is{@FtFGphZZJo7vp4L< zE0+PKuI;VzZXB;zfG$QoYXu;X_nhYPR(}cE zlu;fOd3)75O-TUWcZuRkD`=4h@_&-g`AH%%MC8w2A6DuOSQoz+ThY`a7i|}6dPQE z4KBR~mt2EOt-&SM;L>VvNj12X8eBpRE}aIKOoL0M!6nk*(r9o=G`JKRTmlWweS>q} z;9NI2#|_SHgLB&8TsAm|4bB~WOd*3zalP5j?n3q1;13H$jl2;LlU>}2@jNK&WR5p^ zL3$V;&L{jKw+3?z@xh9X=Ri}F&h}t#aT&}lHo{jrmYrilEq9YzzMs_cY5c|2@(`)z zO{A8O;xDe26Qq_WNG6venwfSC4ReAs3m@* zP^cw-R7|KPe)C7DCBEmw2afNSsQWvk2AJD~ojDig7id(#PKX?Il3_Vve4;s`9GE09 z!^M?yfowW2`fMeWN{_}`91VNrm3GJ4hxty`!wJ@e+E#F9gTEDAI29YKSXJK8^#XWq%&UMS7DjiH|e1y?Tq z8(;kyKg6>zF!aW1Z!#Xk7Bn&;b7r`T@1xiXJSr|UQRj@D zd51Jo*gKM0gcy2RPOXIy?;S;p`mN7=dB2#^?8@+Y(($3^=pt=JF%nP3e)1@uh3_Up z7kpC6$yx@J60H4g_;Ww~d3E|C==Iuk#LAH`4NXCC?mT{2!e z5ifUvG%YJCpe~DC&*EL^3dtC#auIW0B5(bziz<2Mpn@iJE8QhJBxzVT>2ot)$(cA<2 zRZEJ|Gz=D8aYLOpsO*4I(B9Fa#A3g8Lty&~%e`jlO^($N$dN?%v1qvYcyEL`X&!)G7(soTh|@$!E2M=e&}T8|egDH61)Q2bwONh6BS( zZ5+w@HP7SacGwd%ZYXO{qOdK&s3G%3Nm|wc)k;te2u1T`@UW5qT4hu1 z??t8Mo@s(10j(pxEVboi{bWUv%#mwpWzEk+!lb3MJSEaZ*;{pkI1dL%#)ALV6ot`Y zqefN}CyYv7VkBWgA>k_DgCvu&+e$jq|`Zj$8Q&GVHTr!_83$=$qiBV3Wg#lX=S_|MWj z?1xjZsUU4*wc!(6rt;o}PpfF8vfQM(3DPEv7+AcIJGWh;>yGTLa&$?AT!+f8-~y<73KdJkhv4*;FA+@o6sV?f)9V=7 zkVrL0saMT^lE#7cvrWAtjzP}QkGJq8ICrr2B+E6uBD|n7C%D)QukPTFVTY^hbYX{n zJq9qm!6K=c1g{-&)GRp03NGtoI07pizE6M+uAg+Thm#FyeT72|Yx8!|P3*_*4|y*M z>v!=^ytQGF1n#y3SRbNzH?`sg{@;py8;0wps!k6xi7}Mi!(uH-?X=RX!(5ltdI%l` zD`q-xt6!;p@<7;X4>l|gR$i+^CmZ%L7L7}D_{l?C%?`da(Cn?+2wzU<5q$Mn%#qq) Y+tVB3{Z?F+WRImW({yCI`uyzTe~Y#bv;Y7A literal 0 HcmV?d00001 diff --git a/documentation/build/.doctrees/ring_buffer.doctree b/documentation/build/.doctrees/ring_buffer.doctree new file mode 100644 index 0000000000000000000000000000000000000000..4e86319a74059a6ec5a74f15c3c4d79b055b5532 GIT binary patch literal 7052 zcmcIp%Wot{8MnP2+vCUB>y0-^-i=yO7LD21=D;EGfddjK!oopec_vGzrn_dU+dbW# z?rJ}htTs6yt)UQvG-o8l6$lS$LEHc##GQYDD>uZ6m-u~E-96po@veiGmB!mu^;LcE zM}76q?DyZ@oYMbP$Bmp!dO^AqMlMftwLlX?9?JaveCyr(UfxyhgdL|*mN-0DQ-E-U z7q|%z^Sim2Qu8Tyq!)!1yl9CzF@HDjVzDJX8SvVYx|Vq1;5ECK_4_=rhLM|LoxlM- zdxxJ8UbRj@V=&*yH8r9&`3N-^GteY+u_mU)6*X5-e4u6nFXZ__)?;dsNtt-POoCJ5 z?26~6;6lwi0ZUU%;=2{Hq4`>Hvv@SYQFieHy_fe;c;bI^qpAV>&UJykqe)z@Ab>62KU&U#|USXXH+mt#omsb_0vSzWC-%M0t+ zz}M3kBA>+Efw&3t5YMYwxPWs`)?KW0XvI!FXkBJW!=kU(2R2|slyzY)&>g9bS%8A%sV49gf%%eyPK@re>U!rJ9mT zN*Z%bLhgMyLf)E0$hsy3Q3+C!JPACwc}+O&%2W(JrHxe^9tFIiYTKKnzmGt7p^cQ1 zdk+ME`!ayvI>#9w9lp=1=!4HP0JZuaMYJvFSZ(tNGisrq1%U~p_er0x z0NKk%@*{m3>vEz{){{~hHYmxoNo0eB#iA~<>z`tX=zG?lMz{BR)bo+3Uf06ziVZbi ztml>ZMpK~U*L4ek7ca*=bSa9RAPLm*tWH8ec`@*ybr#fM#UFH{gP$8>MyR!)|7lzy zT{Ww*shRkcT>5m|h>q6-J_+uRAo%y=yX!z|9#qTI7?Gh6Ke9USyU~z&VJ`j*74bel zi388^NOf%l^D;O8lrS46b8%nqlPnosxIMl#c-q%Bv=3X z^wiYllv2h{1bctI+NEB8QiV|^7hQ~~ij7&~&e-1fCQWXjY$1pyUt6H?Q4yi!2AROW zbxBwxgBs`lb0h>JcI1Hm3g)V;P>hPiAbxx%e$osO;sbGC{7kK%SE(*rkPrM-LZZv- z5kB#YQVykgj2!xw(J~x5w0OYjCS%FSl7iRWx^(4BLRX^oKTG6n`Y%;fJ+3M%UHSiD zCKS^APZyLRs!gfIzQ+UC9xFABkg$x*jOBVlsxE59&hfHo@$+T*l9nQ?PgQcE{N+0! z2q) zT1gon#)73@TBmLL)l%g6YD)UO$52INe5XOi@0uRte;2Fel$zC*K`8}2XyW_f3$? zt+7KYt+uScyz{Qdjl{4CEu&Z z>xy`2Nq9&i-XOh!qL z0ZJF1N;Zr!STbmkzrsTd7mHz*1Q@Nz$g!yjN2@^BqCOX{MeF@2lIX4Q+T#ASTA{XN zm<{cdev}Mz%yg(V728fUq@p0jk(*|w@YB>j_N1`&6$>N-W3i#=4IZGM!Q&{AcEFE# zknhi^MZtn<*iu*di3eGs&6A}iP)oI3-pd9!uR~WMx2I$juO z(&nKP(M2;??M(K!U)V;|DOWd|i#AV^D6s_#-2fL8C=R?ixRI?!nQWfY(x>F==Ge;E z5&nxXRMj!(j%a9o@y=(qUjY8*!q{fDMm(etlz@l=-GN#OSUAXVw}Ql7+&gE`Fh=W^ zJ5fTdQMyI|4K*qc(D#bMKG=jrJl96+s_&gpgP_AQ8QG&LHRHjkR@`hD+m+!#uzCVb zH=cwnpaWO+45S;Tr2f%Vobt?#Y;?*1wT2sSlybYiQ(K86?ISPsjESz=u9vc2K#UYr z&X*1$ZmVT5lfnf|Zx2>efZ2U70CVWbc48jebialxIhtQI6JnSvP?K#dOGp`~d%L^G z$H!=+;{FuwM9E+m4dh)wrn|Y?pdEA~?XV^4g#eC2O#vQn-}?9`AeK(jcgE1r%m~em z5{--^H2gg-`x=dq!vHASlJ(#Mt`zzHg1QNV8rqd_Rpi^I!FZ;wYihg@T}Enb!){4N zE)01I?*-Kmj<=SchLWAw!W)PHKbYxkK!uoEPKONs^hO5vO|kQu9-E;ZL=Gz?c+(N6 zLmlYXxD_-;@yEvQ!z@O>f}Sz-Q$ykIXE2h;@xne-UHbnzMT9i#HR0Cyu!mlKDo=q+ zaC9}!)P@s8?9k?Djs!MpNwiYwao~Zv!owqaNl*(W62SFfMaVK9>{{BUEuwXP6^LLJ z5^pPzjZ5za_YkWZvs7&BX`I%t2GmNSX9+C`qwCttl^K?7yJ5VrT=8AO;D8g z^qYo;I}rO1^eSp43l9Zm-;%#d+o#lA(Z8vpa`9qQb@nu1b&VT!_Pi7s$W*y+(NWdY zhxlaC)!!F)3~h8n&eTfXfHY4lXfSD4AyYLo1RM#EkdR5qzWpBkI2 zpxccT+a*@LX}xhi;&mb^L2QhlRjf>@1%#jqtb=wVJQuo4sdGdgzFtL|#`ID(tqo<- OrQlb@3ChV?Z|A@9@hq|c literal 0 HcmV?d00001 diff --git a/documentation/build/.doctrees/xml_reader.doctree b/documentation/build/.doctrees/xml_reader.doctree new file mode 100644 index 0000000000000000000000000000000000000000..0c56528b1da89dc2133420a9af1796637e3a54d7 GIT binary patch literal 21370 zcmc&+35+DyS>9{z-Pzf7CWdBy#MD5(&s57<-6(L=MFCR(IFTtJ?0a zc2)K6Y&OfTQ4qW0p*V3zijg89;*t<3KmsH{NB}36BE%s?I1~gM1PF-;kpzq)1mFLz zdR1NBRXsavR@#}Vs(1YN`~LT;{%glR8a{qV{NszQu-Q-icD&vVTV6civvi~5b(6vK zgR{>Lt_*5?E^;r%VLxhm1AYiCn#^yvBCk7mdcY3xnb>P4e%Lkb*%X^*Gfxj{csP~# zN!zm?@zZ;q_WSCQ=eE4a>4dF59#d;HKK6vSN7M3CXp?L5V*^18n<^ZDPxo99lnmGs zJIs#qX+`cfKi2lU-e9}maQVEOB$40fCt#D`O`p#s?k+tVutm1Q7HCGc${*TbVaMC(`5SJ}Yt>uc1;6QSXlc46q76yb zM#|oL6ocq9TSxj0elqSczq_~YwpvOTQ+~JQ?OD>3f@ODteC9xAcj5o*@&6wDuMsPd zLF5YtY7m0o-Gy}d9qD{dO^W<1ge?DBOCJu{^ma0E`|J&D&0_2wg^Z=$)_a#W!Dft^ zySq-f<5-WLGKwTF5BD2vT^f}(l4`uLP41*aIW?g%$M0HGfurRS6Blu{&Cb9m*!}z% ztiCxU;u@YT(vy1ZL)S?^${2AiC8kD`_S}SRI*`Eq&R*O~FV70orom2%!Q5^)OoS;| zGxBN4j&y@%b7@Q-T3=y5D9udL?T!}P9O&7MdoDTaY%lU+FS_6jNT*L>lqZz29+*z0 z5RXglV7TNKI&i>Q7c7-%{xbKnOm?a<$r$sAqw^_8EYJ#_6SU+BnNKyQ>9B8Q$+$8Z z8JCO5I4#IPSb{_nFKYX6bW1R+G3j(B+t3HunSOSHnY>bxequ9^Z5m|rE6dJJ>@fK-2KQqsJeVK=eYMIFLuotq;a?M7~o**bdl_qbSB zHl0l|-R8Nl5n!!6r_{U5XVmjldg(3D@g>^~5krpmylx9Iw!Vj@$e!n9(FC+Kw|$tN z+qT-WzYvQpqKqUaomxbhzsf7F#*c~F_>tZv3MiM>r06_*-66sKB?$iWd~drEp8?g$ zr5@sv5OLj>8RhZj4`(!)08i=RrcSs_M!0~kV4^GUo^hu zC?K>GMoz*!=cz{@abRaV{%${#>x5EQc|+rY!I8s<4zZQs5d9L^q-@bpbRMv1G`IU* z@gIPG>y7@-ju&ASe!o{c>xjixifla%=nf(*3tK<{cc)HnJzvial*2iKPPVEL!M4_o z2C(TS01CjJK*Ap|gPa^9hQRMKAG&Y!Nsbx3zOpiP zAjhf{IHnhW@<32ro^PN!LIB*bx0DxzTrbkqWJH5yKKvjnfj5Jfaq&g-jRh=tW5u>u zSu7a^-$mk5xKPIY$OH82##R7D+Mu)wrHQ|@WIk#{UgmX*;9!e-6w{H0mS6>~%u=VW z)N03m=LY-TOxRI}I&a-F;t`?aSOG6}DE7@7g@tqn{Aw`r(nuTnlLLw3@1yAZ|9d>uE(fNWkn&vQb zFU#Ujm9QwVMcnh6{*K=qTqlk{COIC6o^a(OPA!Xt0`=(6vc3QuwxsFyIz8sbel|RS z8BOs~`a4VMua{6tqU#qUK&n?$NifaY;>+gBr1>lS2TskCG_hI zd0g9!Dy}jnIZA`rE)<+X=UfuP{v&WnGvB~+`b};T%>I-87kgRf6k2@*)czOk5jU6l zn}x$nuB%iS{K5Tcdtk^Y^Cn|>MESP`<>ReZITl%MCCAE4Kt3ijpmIN(c}yWMWh~}8 z>uGN(QMl!4520yhZOeF?Tym}T>`sbkHn7ntnze{Q%Vo_Bxuq?kfk%kM2{N{o;QK1@ zuXINISJK%^P&F7XNF_NUt5=H3+%w#ZuozSzR)xh~l7tOJ#w#nux2B2>RrfDP+}|@Yqi5^XO5O zI*jhcr`1+ZAS612{U^B_G%Yg@ zQu$}YUs)EJ%iW9SPCX&`BF0T~cX?HoyRVF~2$Q_OWC%`qW@D1~b&^2rxWJ6Gyh+Im z+#aWCdI}r0tS0Sdq#7JKDq_na`ZdAAwt5@wOXTPOqXY*NxnP-yG`HG;!INe1oky}Z z9<|`fX%f+@QsYn}p!^^O@GGRljQ-r14j^$nV3L!uZH$ii*k*97dnQ!gO7OZ0Y%5ek zY*$>%PKu`Gy2&7ra#Zs63dAZ@^4(}UfsU+rGYm_L;?H|aNU?FrBpJVod|6=fWXWV2 zm^@bAP6HE?&qT^hV`M?LuYrm7RlV+y?IeInQCJ+^EBG{mL9h$jgWtqoI5HH+34`Fb z>Hc$c|1o}0}pgOb> z5XbK#Z|{hsRL5?S=?SUNVI4YQW&gM{Ov zL*YS!dX&Qe!LQlmiK7A~+=63+yGzI+sj6dxyGokw7eoa2Vqn9zI5sdm4;>qrCxyob z=4tVjkm z4>r-b>PDudBgHpv{n@y&>iGK zT6+2r{4LEYHv5brl%K8LRGnZf)=`ylTM=RYv4HbxXKR07(9_<_NH@j#@Y&ke(K%;( zI9vM%5^CAmnv(n+5Y<-&31IL4_iRm)QMTk5n<2{oxO%%s$tN-s&_YBDVp&hM z*{>mC^_;p0g^w12%&95j6y?9QG}_x9r?*3%k2v9(|^j?%UJ5!#lqIoNAfh(iq0@f@g^Il^`@6 zyu#V6k)?czI%q3G3bWaAByMM}3XI#g4Bx{1K8U%-nIDC1g%h47vR0LL%ahqRXsge@ zD@Pv^(W{mEU2vn%S~i=V)!j|VFgLOsyime{fp|KP{ix_rn8&I|29ZESfG88?vA)W)`xY=#G)#K4Aak;fXIhw@nSq%e;)PhUg&D%73P1|Qu9-bEwXkv)w? zqw?90l!(Vd6l9uqcq8rR#2HUC47`8<)u-^}u)%{JFFgJ{0ia@tG zowdJe$YS2~Iw)je$dj+(r{5J+`Cjgpkj8g_mvN!qMjB^C+gtiXF4&lOzR|9tX(MEl z>Lget^%R^87*nBL1#yuzhVP|*l}_u`#QGD4qPbJ5gDH%gqAGbc392&2p;6V0AvEQ6 z9IASq9s#dFh)=B=mz+L*B~6!)zdeJVDz!Co3x1eLSqa`}D0+oalIBc&W(`8#s|YDX zNflmjurX07OnL^Bjq@D~CUuFfRi&;`FbP`)4Sbe~WKO)XlYTZU5r_ETlAhG@d1J@= zY(PFvw^8^jg|eP25rBak8f9_Op%7)MN4J8qe!hep3uS$xr0Kp<)-PgU!?r+KhUX!a zWu6qGEc0|Uf--(M9%a!;c3?|mQvoCr8`C#R#6yz&aT;|c_@HPST*oi{##wq#JTd~J)l#pZDMbYR6hD1KP4FvrCL{KF}1qF)0^R5cqDwPno2dt6_PsCUSV%0W@N0KO8 z|5MdScq-J83qT{V>y;8x_8UJGP|ik>OC^(OWnL(6r%%L4J`*W(yo0M;U8BM3xq1<_ z9zB)J)jtb|FUr+_13Zn%)khCY^7}mMCS(h8jBYQ;5PLzA3{_`BzR355LMj%9MN%s& zjU;MPt;x~@YpN`Tr%^*u!75XWgqXk)5Nbq;0Ko3UJ|@aNjn1%5^(uBB^*ziNoBfEY zTh&cftK<5PtZv2Wz#tK?{_<0%pclTorh+9c)W~>`+wS9|MFXT4xB1+z*F|j*>?sd$ zK|3CC;&yttSdh~Idw0*{a$a5bqc*Ni;1z;8Rl}mEC>J(G6{k=clj0>$UAC3JFZ{!6IK^hMnE!VR2@{2u5Eri z^5_k&dfU6;wFg^A_&jsl=5mUk^7eel3U!wHv2HZQr&?a4zl-q}sT>GZQNg&L+rgc= zBtp3)Vrp=mFZ$hHKdF1&W=OSG@QGkQ*;#vN4RxRfd^P*9?$I}yb%x#fwiiLpL@M5t zS$32uG0K3S$vw#p5quq1$`|FhDGgIkKJm`AhcJKkL9R1jA|7H0ia|teQ3C2j z+wJc5-CYk7Z=v+c5tMD?cSK$@jHpH#Rg}RrR5ENEg{MU25t4|HB37uJ;_qP-i!ZwU zB&?^m_z@pQb)wbp^y$YjYlj07f+l@*6>8)Pu^;=;bd)8>RgrYBD z?A7g_!b+M+{emC+(nL?zTYl^|+QbOeM?uFK?GWrfejLoiZ~<8~1y-Y))oBM^ly+O} zc|8=BLp2dFEcit|ogT~;Q$fj2=ci_uOqHx1oMr&-n0B-pWw*L^S95!0}w)5a8YiQ9k+ zv=TPhn&oF;P@TH*Ekk}?R`|NXUoEJ?dpur573N^KB%>A#c>z`X%q1LeDZbQA+`T&U zcUc?%VW!90^w~W>9(P>$(=&azZ;YOIh--OSZ--4+N$^aQq3l2t`ju`4jZyrmqxboK z4<&o3n4l>5r`-Jpj3jK*E10SOpQeZq_Z!)EOJ1jeqIq$033D+Ig?(=D zAXa7W(pT%^Hb&bq7t>_@s1JzdGjvn_T?<~KRpdqdU|VcUl;My+=%XI-osW3`RsNuJ zLvfTScD}@qKA)q}=p#2#giwsP&9<(KQLc*-u8ZE+MbGP^7rxVXQ1VaCyAb>lO^^4~ zRS6^$)m7a^Q%_4YG#hSdZ7e^=0w${qW}N^ literal 0 HcmV?d00001 diff --git a/documentation/build/_sources/app.rst.txt b/documentation/build/_sources/app.rst.txt new file mode 100644 index 0000000..897ab98 --- /dev/null +++ b/documentation/build/_sources/app.rst.txt @@ -0,0 +1,7 @@ +app module +========== + +.. automodule:: app + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/build/_sources/interface_handler.rst.txt b/documentation/build/_sources/interface_handler.rst.txt new file mode 100644 index 0000000..c389c4b --- /dev/null +++ b/documentation/build/_sources/interface_handler.rst.txt @@ -0,0 +1,7 @@ +interface\_handler module +========================= + +.. automodule:: interface_handler + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/build/_sources/modules.rst.txt b/documentation/build/_sources/modules.rst.txt new file mode 100644 index 0000000..067d819 --- /dev/null +++ b/documentation/build/_sources/modules.rst.txt @@ -0,0 +1,10 @@ +aped_device +=========== + +.. toctree:: + :maxdepth: 4 + + app + interface_handler + ring_buffer + xml_reader diff --git a/documentation/build/_sources/ring_buffer.rst.txt b/documentation/build/_sources/ring_buffer.rst.txt new file mode 100644 index 0000000..4c02795 --- /dev/null +++ b/documentation/build/_sources/ring_buffer.rst.txt @@ -0,0 +1,7 @@ +ring\_buffer module +=================== + +.. automodule:: ring_buffer + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/build/_sources/xml_reader.rst.txt b/documentation/build/_sources/xml_reader.rst.txt new file mode 100644 index 0000000..ed1b136 --- /dev/null +++ b/documentation/build/_sources/xml_reader.rst.txt @@ -0,0 +1,7 @@ +xml\_reader module +================== + +.. automodule:: xml_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/build/app.html b/documentation/build/app.html new file mode 100644 index 0000000..b698711 --- /dev/null +++ b/documentation/build/app.html @@ -0,0 +1,159 @@ + + + + + + + + app module — APED (API-Documentation) V2.1 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

app module

+
+
+app.api_devices(device_name: str, buffering: str)
+

the method for reading and writing to and from the connected devices

+ +++ + + + + + +
Parameters:
    +
  • device_name (str) – the name of the relevant device
    • +
  • buffering (str) – whether or not the buffer of the device is requested
    • +
+
Returns:

the relevant information about the device in JSON format

+
+
+ +
+
+app.api_general_device_info()
+

method to read all the available device names

+ +++ + + + + + +
Returns:the available device names
Return type:JSON
+
+ +
+
+app.api_root()
+

method for the root of the API

+ +++ + + + + + +
Returns:a welcom message
Return type:html
+
+ +
+
+app.xml_transfer()
+

method for transfering the config.xml files to and from the raspberry

+ +++ + + + +
Returns:the config.xml or the occured errors
+
+ +
+ + +
+
+
+ +
+
+
+ ©2021, Paul Lödige. + + | + Powered by Sphinx 1.8.4 + & Alabaster 0.7.8 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/documentation/build/genindex.html b/documentation/build/genindex.html index 5e1e0c0..9c93e98 100644 --- a/documentation/build/genindex.html +++ b/documentation/build/genindex.html @@ -34,8 +34,181 @@

Index

+ A + | B + | G + | I + | R + | S + | V + | W + | X
+

A

+ + + +
+ +

B

+ + +
+ +

G

+ + + +
+ +

I

+ + + +
+ +

R

+ + + +
+ +

S

+ + +
+ +

V

+ + +
+ +

W

+ + +
+ +

X

+ + + +
+ diff --git a/documentation/build/interface_handler.html b/documentation/build/interface_handler.html new file mode 100644 index 0000000..669f69e --- /dev/null +++ b/documentation/build/interface_handler.html @@ -0,0 +1,340 @@ + + + + + + + + interface_handler module — APED (API-Documentation) V2.1 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

interface_handler module

+
+
+class interface_handler.Interface_handler(xml_reader: xml_reader.Xml_reader)
+

Bases: object

+

handles the access to the various interfaces (e.g. GPIO)

+
+
+class Pin
+

Bases: enum.Enum

+

list of all usable pins

+

enables restricting methods to these pins

+
+
+GPIO_10 = 19
+
+ +
+
+GPIO_11 = 23
+
+ +
+
+GPIO_12 = 32
+
+ +
+
+GPIO_13 = 33
+
+ +
+
+GPIO_14 = 8
+
+ +
+
+GPIO_15 = 10
+
+ +
+
+GPIO_16 = 36
+
+ +
+
+GPIO_17 = 11
+
+ +
+
+GPIO_18 = 12
+
+ +
+
+GPIO_19 = 35
+
+ +
+
+GPIO_2 = 3
+
+ +
+
+GPIO_20 = 38
+
+ +
+
+GPIO_21 = 40
+
+ +
+
+GPIO_22 = 15
+
+ +
+
+GPIO_23 = 16
+
+ +
+
+GPIO_24 = 18
+
+ +
+
+GPIO_25 = 22
+
+ +
+
+GPIO_26 = 37
+
+ +
+
+GPIO_27 = 13
+
+ +
+
+GPIO_3 = 5
+
+ +
+
+GPIO_4 = 7
+
+ +
+
+GPIO_5 = 29
+
+ +
+
+GPIO_6 = 31
+
+ +
+
+GPIO_7 = 26
+
+ +
+
+GPIO_8 = 24
+
+ +
+
+GPIO_9 = 21
+
+ +
+ +
+
+buffering()
+

method that buffers the device outputs

+
+ +
+
+init_buffer()
+

initializes the buffer thread

+
+ +
+
+init_gpio()
+

initializes the GPIO pins

+
+ +
+
+read(device_name: str) → dict
+

reads the current value from the pins of one device

+ +++ + + + + + + + + + +
Parameters:

device_name (string) – the name of the device

+
Raises:
    +
  • NameError – the device cannot be found in the config.xml
    • +
  • ValueError – the device does not support reading
    • +
+
Returns:

{‘pin’: ‘value’}

+
Return type:

dict

+
+
+ +
+
+read_buffer(device_name: str) → dict
+

reads the current buffer content for a given device

+ +++ + + + + + + + + + +
Parameters:

device_name (str) – the name of the device

+
Raises:
    +
  • NameError – the device cannot be found in the config.xml
    • +
  • ValueError – the device has no buffer
    • +
+
Returns:

the buffer of the device

+
Return type:

dict

+
+
+ +
+
+write(device_name: str, output)
+

writes an output to a given device

+ +++ + + + + + + + + + +
Parameters:
    +
  • device_name (str) – the name of the relevant device
    • +
  • value (<type depends on protocol>) – the value to be written
    • +
+
Raises:
    +
  • NameError – the device name could not be found in the config.xml
    • +
  • TypeError – the given Value has the wrong type for the protocol
    • +
  • ValueError – the value cannot be written to the device
    • +
+
Returns:

value if everything worked correctly

+
Return type:

<type depends on protocol>

+
+
+ +
+ +
+ + +
+
+
+ +
+
+
+ ©2021, Paul Lödige. + + | + Powered by Sphinx 1.8.4 + & Alabaster 0.7.8 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/documentation/build/modules.html b/documentation/build/modules.html new file mode 100644 index 0000000..b097d5e --- /dev/null +++ b/documentation/build/modules.html @@ -0,0 +1,100 @@ + + + + + + + + aped_device — APED (API-Documentation) V2.1 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ + + + +
+
+
+ +
+
+
+ ©2021, Paul Lödige. + + | + Powered by Sphinx 1.8.4 + & Alabaster 0.7.8 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/documentation/build/objects.inv b/documentation/build/objects.inv index dfea4f46bf8617b8f853b64c33eb0793a2a5d216..fd67a92a35ccc61fe0e845b224a9f6b322c32959 100644 GIT binary patch delta 557 zcmV+|0@D4B0;mO$hJUq}&2H2%5XbNP6h?4>Lss4J-CLz1vpC(so%grzGR~|2+11A`jJ?=-cx~u~q;%BUJ0<&Nbp`uw>6jw(vHp zdCB0KS75#Www0CRN|M!Hk-F9(!BEjlN-nqR7@1MZJ?3}Qh=0-wBklf zAX@&=(ubBkw14EG{g~(eFK^mycXQ;jzPk^C+bQ<{P%gPE19^6At+|>LYJjr2c?fI& zZg`jOBY{4jX$@1Bl!cmu7S}YhdVo|_YI8Svx89g=24`{(A7X3 z<2=;fD_YhN&uMA-kKz9Q8>MgUByB=Vcp^qC<4%;@PJbRd#uMb%RB%S!<9pC0mRQHm znW{*(?=t-h30Ycn{VtabZtna9-GK0((Hh*>{&lf;>v4(4HxQL-fH*}iiVv6M`9-nL zE>+bwARYBh?u*|)e_6s()02r#cYvQNnz1>qqdkQP}o%RzRN?>NUF5CbQ;BhDrg delta 143 zcmV;A0C4}P1&sobhJQ;>&CAS7Nv%*QE=jSz*Q}ap^OEUBGG#@q0ELKQC7EE%c|oNvOafxMZ+=Q?PAb$H#i@x!$r-3RAYu^3!4Ua?#0d0ME&wWWPHJ(gJkbCE diff --git a/documentation/build/py-modindex.html b/documentation/build/py-modindex.html new file mode 100644 index 0000000..27ed552 --- /dev/null +++ b/documentation/build/py-modindex.html @@ -0,0 +1,137 @@ + + + + + + + + Python Module Index — APED (API-Documentation) V2.1 documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+ + +

Python Module Index

+ +
+ a | + i | + r | + x +
+ + + + + + + + + + + + + + + + + + + + + + +
 
+ a
+ app +
 
+ i
+ interface_handler +
 
+ r
+ ring_buffer +
 
+ x
+ xml_reader +
+ + +
+
+
+ +
+
+
+ ©2021, Paul Lödige. + + | + Powered by Sphinx 1.8.4 + & Alabaster 0.7.8 + +
+ + + + + + \ No newline at end of file diff --git a/documentation/build/ring_buffer.html b/documentation/build/ring_buffer.html new file mode 100644 index 0000000..6cd5bb1 --- /dev/null +++ b/documentation/build/ring_buffer.html @@ -0,0 +1,113 @@ + + + + + + + + ring_buffer module — APED (API-Documentation) V2.1 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

ring_buffer module

+
+
+class ring_buffer.Ring_buffer(size: int)
+

Bases: object

+

manages a list in a ring buffer like manner

+
+
+append(data)
+

appends an element to the ring buffer

+ +++ + + + +
Parameters:data ([type]) – the element to be added
+
+ +
+ +
+ + +
+
+
+ +
+
+
+ ©2021, Paul Lödige. + + | + Powered by Sphinx 1.8.4 + & Alabaster 0.7.8 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/documentation/build/searchindex.js b/documentation/build/searchindex.js index 7134ff5..494c698 100644 --- a/documentation/build/searchindex.js +++ b/documentation/build/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{index:0,modul:0,page:0,search:0},titles:["Welcome to APED (API-Documentation)\u2019s documentation!"],titleterms:{APED:0,api:0,document:0,indic:0,tabl:0,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["app","index","interface_handler","modules","ring_buffer","xml_reader"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["app.rst","index.rst","interface_handler.rst","modules.rst","ring_buffer.rst","xml_reader.rst"],objects:{"":{app:[0,0,0,"-"],interface_handler:[2,0,0,"-"],ring_buffer:[4,0,0,"-"],xml_reader:[5,0,0,"-"]},"interface_handler.Interface_handler":{Pin:[2,2,1,""],buffering:[2,4,1,""],init_buffer:[2,4,1,""],init_gpio:[2,4,1,""],read:[2,4,1,""],read_buffer:[2,4,1,""],write:[2,4,1,""]},"interface_handler.Interface_handler.Pin":{GPIO_10:[2,3,1,""],GPIO_11:[2,3,1,""],GPIO_12:[2,3,1,""],GPIO_13:[2,3,1,""],GPIO_14:[2,3,1,""],GPIO_15:[2,3,1,""],GPIO_16:[2,3,1,""],GPIO_17:[2,3,1,""],GPIO_18:[2,3,1,""],GPIO_19:[2,3,1,""],GPIO_20:[2,3,1,""],GPIO_21:[2,3,1,""],GPIO_22:[2,3,1,""],GPIO_23:[2,3,1,""],GPIO_24:[2,3,1,""],GPIO_25:[2,3,1,""],GPIO_26:[2,3,1,""],GPIO_27:[2,3,1,""],GPIO_2:[2,3,1,""],GPIO_3:[2,3,1,""],GPIO_4:[2,3,1,""],GPIO_5:[2,3,1,""],GPIO_6:[2,3,1,""],GPIO_7:[2,3,1,""],GPIO_8:[2,3,1,""],GPIO_9:[2,3,1,""]},"ring_buffer.Ring_buffer":{append:[4,4,1,""]},"xml_reader.Xml_reader":{get_buffer_size:[5,4,1,""],get_device_names:[5,4,1,""],get_port:[5,4,1,""],set_root:[5,4,1,""],validate:[5,4,1,""]},app:{api_devices:[0,1,1,""],api_general_device_info:[0,1,1,""],api_root:[0,1,1,""],xml_transfer:[0,1,1,""]},interface_handler:{Interface_handler:[2,2,1,""]},ring_buffer:{Ring_buffer:[4,2,1,""]},xml_reader:{Xml_reader:[5,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute","4":"py:method"},terms:{"class":[2,4,5],"enum":2,"int":[4,5],"return":[0,2,5],about:[0,5],access:2,added:4,against:5,all:[0,2,5],api:0,api_devic:0,api_general_device_info:0,api_root:0,app:3,append:4,avail:0,base:[2,4,5],bool:5,buffer:[0,2,4,5],cannot:2,check:5,config:[0,2,5],configur:5,connect:0,content:2,correctli:2,could:2,current:2,data:4,depend:2,devic:[0,2,5],device_nam:[0,2,5],dict:[2,5],doe:2,element:[4,5],enabl:2,error:0,everyth:2,file:[0,5],format:0,found:2,from:[0,2,5],get_buffer_s:5,get_device_nam:5,get_port:5,given:[2,5],gpio:2,gpio_10:2,gpio_11:2,gpio_12:2,gpio_13:2,gpio_14:2,gpio_15:2,gpio_16:2,gpio_17:2,gpio_18:2,gpio_19:2,gpio_20:2,gpio_21:2,gpio_22:2,gpio_23:2,gpio_24:2,gpio_25:2,gpio_26:2,gpio_27:2,gpio_2:2,gpio_3:2,gpio_4:2,gpio_5:2,gpio_6:2,gpio_7:2,gpio_8:2,gpio_9:2,handl:2,has:2,html:0,index:1,inform:[0,5],init_buff:2,init_gpio:2,initi:2,interfac:2,interface_handl:3,json:0,like:4,list:[2,4,5],manag:4,manner:4,messag:0,method:[0,2,5],modul:[1,3],name:[0,2,5],nameerror:[2,5],object:[2,4,5],occur:0,one:2,output:2,page:1,paramet:[0,2,4,5],path:5,pin:[2,5],port:5,protocol:[2,5],rais:[2,5],raspberri:0,read:[0,2,5],read_buff:2,reader:5,relev:[0,2],request:0,restrict:2,result:5,ring:4,ring_buff:3,root:[0,5],search:1,set_root:5,size:[4,5],store:5,str:[0,2,5],string:[2,5],support:2,thread:2,transfer:0,type:[0,2,4,5],typeerror:2,usabl:2,using:5,valid:5,valu:2,valueerror:2,variou:2,welcom:0,whether:0,work:2,write:[0,2],written:2,wrong:2,xml:[0,2,5],xml_path:5,xml_reader:[2,3],xml_transfer:0,xsd:5,xsd_path:5},titles:["app module","Welcome to APED (API-Documentation)\u2019s documentation!","interface_handler module","aped_device","ring_buffer module","xml_reader module"],titleterms:{APED:1,aped_devic:3,api:1,app:0,document:1,indic:1,interface_handl:2,modul:[0,2,4,5],ring_buff:4,tabl:1,welcom:1,xml_reader:5}}) \ No newline at end of file diff --git a/documentation/build/xml_reader.html b/documentation/build/xml_reader.html new file mode 100644 index 0000000..3010eaa --- /dev/null +++ b/documentation/build/xml_reader.html @@ -0,0 +1,193 @@ + + + + + + + + xml_reader module — APED (API-Documentation) V2.1 documentation + + + + + + + + + + + + + + + + + +
+
+
+
+ +
+

xml_reader module

+
+
+class xml_reader.Xml_reader(xml_path: str, xsd_path: str)
+

Bases: object

+

reader for the XML configuration

+
+
+get_buffer_size(device_name: str) → int
+

method to read the buffer size of a given device from the XML

+ +++ + + + + + + + + + +
Parameters:device_name (str) – the name of a device
Raises:NameError – device_name will be checked against the config XML
Returns:the buffer size for the device
Return type:int
+
+ +
+
+get_device_names() → list
+

lists all the device names from the config XML

+ +++ + + + + + +
Returns:all device names as strings
Return type:list
+
+ +
+
+get_port(device_name: str) → dict
+

returns the information about a port of a given device

+ +++ + + + + + + + + + +
Parameters:device_name (str) – the name of a device
Returns:{‘protocol’, [list: pins]}
Return type:dict
Raises:NameError – device_name will be checked against the config XML
+
+ +
+
+set_root(xml_path: str)
+

method to read and store the root element from the XML file

+ +++ + + + +
Parameters:xml_path (str) – the path to the XML file
+
+ +
+
+validate(xml_path: str, xsd_path: str) → bool
+

validates a XML by using a XSD file

+ +++ + + + + + + + +
Parameters:
    +
  • xml_path (str) – the path to the XML file
    • +
  • xsd_path (str) – the path to the XSD file
    • +
+
Returns:

result of the validation

+
Return type:

bool

+
+
+ +
+ +
+ + +
+
+
+ +
+
+
+ ©2021, Paul Lödige. + + | + Powered by Sphinx 1.8.4 + & Alabaster 0.7.8 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/documentation/documentation/build/app.rst b/documentation/documentation/build/app.rst new file mode 100644 index 0000000..897ab98 --- /dev/null +++ b/documentation/documentation/build/app.rst @@ -0,0 +1,7 @@ +app module +========== + +.. automodule:: app + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/documentation/build/interface_handler.rst b/documentation/documentation/build/interface_handler.rst new file mode 100644 index 0000000..c389c4b --- /dev/null +++ b/documentation/documentation/build/interface_handler.rst @@ -0,0 +1,7 @@ +interface\_handler module +========================= + +.. automodule:: interface_handler + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/documentation/build/modules.rst b/documentation/documentation/build/modules.rst new file mode 100644 index 0000000..067d819 --- /dev/null +++ b/documentation/documentation/build/modules.rst @@ -0,0 +1,10 @@ +aped_device +=========== + +.. toctree:: + :maxdepth: 4 + + app + interface_handler + ring_buffer + xml_reader diff --git a/documentation/documentation/build/ring_buffer.rst b/documentation/documentation/build/ring_buffer.rst new file mode 100644 index 0000000..4c02795 --- /dev/null +++ b/documentation/documentation/build/ring_buffer.rst @@ -0,0 +1,7 @@ +ring\_buffer module +=================== + +.. automodule:: ring_buffer + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/documentation/build/xml_reader.rst b/documentation/documentation/build/xml_reader.rst new file mode 100644 index 0000000..ed1b136 --- /dev/null +++ b/documentation/documentation/build/xml_reader.rst @@ -0,0 +1,7 @@ +xml\_reader module +================== + +.. automodule:: xml_reader + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/source/app.rst b/documentation/source/app.rst new file mode 100644 index 0000000..897ab98 --- /dev/null +++ b/documentation/source/app.rst @@ -0,0 +1,7 @@ +app module +========== + +.. automodule:: app + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/source/conf.py b/documentation/source/conf.py index d343b76..b5af60e 100644 --- a/documentation/source/conf.py +++ b/documentation/source/conf.py @@ -12,9 +12,9 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) +import os +import sys +sys.path.insert(0, os.path.abspath('../..')) # -- Project information ----------------------------------------------------- diff --git a/documentation/source/interface_handler.rst b/documentation/source/interface_handler.rst new file mode 100644 index 0000000..c389c4b --- /dev/null +++ b/documentation/source/interface_handler.rst @@ -0,0 +1,7 @@ +interface\_handler module +========================= + +.. automodule:: interface_handler + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/source/modules.rst b/documentation/source/modules.rst new file mode 100644 index 0000000..067d819 --- /dev/null +++ b/documentation/source/modules.rst @@ -0,0 +1,10 @@ +aped_device +=========== + +.. toctree:: + :maxdepth: 4 + + app + interface_handler + ring_buffer + xml_reader diff --git a/documentation/source/ring_buffer.rst b/documentation/source/ring_buffer.rst new file mode 100644 index 0000000..4c02795 --- /dev/null +++ b/documentation/source/ring_buffer.rst @@ -0,0 +1,7 @@ +ring\_buffer module +=================== + +.. automodule:: ring_buffer + :members: + :undoc-members: + :show-inheritance: diff --git a/documentation/source/xml_reader.rst b/documentation/source/xml_reader.rst new file mode 100644 index 0000000..ed1b136 --- /dev/null +++ b/documentation/source/xml_reader.rst @@ -0,0 +1,7 @@ +xml\_reader module +================== + +.. automodule:: xml_reader + :members: + :undoc-members: + :show-inheritance: