From efbeca3c322fa62a95b51ebc5670a6d446dcdebc Mon Sep 17 00:00:00 2001
From: wakonig_k <klaus.wakonig@psi.ch>
Date: Tue, 23 Jul 2024 18:02:46 +0200
Subject: [PATCH] docs(messaging): added first draft of bec messaging docs

---
 docs/source/assets/messaging_system.drawio    |  40 +++++++++
 docs/source/assets/messaging_system.png       | Bin 0 -> 12575 bytes
 .../developer/data_acess/bec_messaging.md     |  85 ++++++++++++++++++
 3 files changed, 125 insertions(+)
 create mode 100644 docs/source/assets/messaging_system.drawio
 create mode 100644 docs/source/assets/messaging_system.png
 create mode 100644 docs/source/developer/data_acess/bec_messaging.md

diff --git a/docs/source/assets/messaging_system.drawio b/docs/source/assets/messaging_system.drawio
new file mode 100644
index 00000000..c6a679c2
--- /dev/null
+++ b/docs/source/assets/messaging_system.drawio
@@ -0,0 +1,40 @@
+<mxfile host="Electron" modified="2024-07-23T15:44:59.284Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.6.4 Chrome/124.0.6367.207 Electron/30.0.6 Safari/537.36" etag="j0pUm-Lly6YRSlM1o_Rt" version="24.6.4" type="device">
+  <diagram name="Page-1" id="x2sBnHPqiDliDDTYoS2s">
+    <mxGraphModel dx="1242" dy="785" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
+      <root>
+        <mxCell id="0" />
+        <mxCell id="1" parent="0" />
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-1" value="EndpointInfo" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+          <mxGeometry x="340" y="190" width="120" height="60" as="geometry" />
+        </mxCell>
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-2" value="endpoint" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+          <mxGeometry x="210" y="120" width="110" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-5" value="message_op" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+          <mxGeometry x="345" y="120" width="110" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-6" value="message_type" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
+          <mxGeometry x="480" y="120" width="110" height="40" as="geometry" />
+        </mxCell>
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-7" value="" style="endArrow=classic;html=1;rounded=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="fJOnbpTbUHdrzFDHRs04-1" target="fJOnbpTbUHdrzFDHRs04-2">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="210" y="260" as="sourcePoint" />
+            <mxPoint x="260" y="210" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-8" value="" style="endArrow=classic;html=1;rounded=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="fJOnbpTbUHdrzFDHRs04-1" target="fJOnbpTbUHdrzFDHRs04-5">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="350" y="230" as="sourcePoint" />
+            <mxPoint x="275" y="170" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+        <mxCell id="fJOnbpTbUHdrzFDHRs04-9" value="" style="endArrow=classic;html=1;rounded=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" edge="1" parent="1" source="fJOnbpTbUHdrzFDHRs04-1" target="fJOnbpTbUHdrzFDHRs04-6">
+          <mxGeometry width="50" height="50" relative="1" as="geometry">
+            <mxPoint x="410" y="200" as="sourcePoint" />
+            <mxPoint x="410" y="170" as="targetPoint" />
+          </mxGeometry>
+        </mxCell>
+      </root>
+    </mxGraphModel>
+  </diagram>
+</mxfile>
diff --git a/docs/source/assets/messaging_system.png b/docs/source/assets/messaging_system.png
new file mode 100644
index 0000000000000000000000000000000000000000..e4733e3b94e376372abfa83f8a6224f36bcdf489
GIT binary patch
literal 12575
zcmd^m2{_bk+qb0%iAV{BB1;KlFZ(`rAz32JU<$*`*v(iXB}EfSwqztqq=f7#OV&n2
zSqjmpEE(G{yw_OnyZe5g_j#Z1`=0kW?&tZAgPH&Tyw2;qu5-VxpTiY16FpXD9%dRE
z8dj*j_9+?~S`2u;xPt+FI^AlC17EbLQ+k>-kK6f(G&FmlXq_`?uRu4rCyYi|Mr-3q
z7$W6?K%s?Yw1puM9Z#4G8j0`*kAUulaD}_UVXhlv5GjbPgp`5=M8;BDPFO}mmii&3
za9m1B!FGe+$sOjsDaaTR4EOYO5{Br?9hU;4M2($X;NEBi%0pO26TCyc(J)W&4anfr
z)B=2*0l(5xj?!|D3S!_<!^g)HW({*TgrliaWE76e$OE#dp}wWDkuXFHJbS_~z`&Ot
z%;f@tI>i;~6mT4l0PGOi<MPL40ZGdPiSPnUy3&9obzELXUg0=IN&$@guBxt#6m<yD
zES%h&knmrYqgnxmc5>gaK#-odqp_u@iNBAT3rhEtzx8QP^9{}YVMr7lm~GvNTZ>aC
zql0{48&p@AKimcEgi1xZIC*Z8r8g+f2&5|vxxoqS1re6f5th;btkfSFEmydcJJQJu
zym&hSb=H?L1Ll_4oDSdgQ6L1R>8)?(3)l99YinEDAS@uLKTF$^=@qDlbn@{qM!2qf
z!ZmP1EHD(<B6XLpK^qhWMY#=vJ92BC&1I<s3wZFBD(f4ENV)sLU16wAX&W=q2!tmZ
z?(;{Y3&PtQgxen&osdXGz#rM%5T2XbZLaDA6#v5{D#7A!OiHC%!(GuJ;;5mm2mxNF
zszs&i!{F{7TPsV;D{YK;Ic+g-YJ&1`azzAe%>Ns&Y}j$jnn(l!$os`<zYcFPc?D|0
zJgH&7Wyj5RK*ar@&;89B$ltQ=|3#defvLB%kEOGfzAG|VS6lxSN=kMsy!@R!{WeXm
z<L&B$0GSN+b_0pF9?a;VtzbqX{JdS)>jel}%>WNL8fM|+1fpI>I{?HQpn0IZJi(jv
zdKI9~2AP9~ZH3;JgMQa&UCDoJ*58e*2Lri|Mg{?~n-XPYH%+n`%F;@k?*YFDhBQ?G
zbt@jf1cm%2&1o|h-G38J<@{&-1$Z{y{g1a#t;2tciofd$u<p9Oes=|I(-nVxH$bE}
z&AH`<EtCK1hAp07-LU1pzm6L=OW`jW;RQpXKuK{#`26)9Ap@HBdKmrtI|B6UKjp)g
zBi4KF`XK5rT$*GR|6_7uv$6h?6MvHlpjK&6TRW)zE}l*(6x`*H&ESun0~QEJp8>4Y
zE<$~_p*|l6=gsvuZEA7f8q%gl^7@N6sQl}bHW;a|)Opla0~#bU==W*sZ(H*=whD9o
zn={3qnh-d(A^ec*y$nqGyCr(FBcq*=?y$|n#oy&yFXjKZEBxK2_Di*t+YFvxi{%y#
z3G;M9!~OqwM*4dd^q<+n?;A0rw*B8*>z`{n<j*a0!(5xQsHyrtcg>B({`)1jmZ16$
zIN`S~Y$>;4`TvV0Wx#a;wCmpv5dYXRo80SN`+ws6=bF3XMil-pWYBL}L(PTXlIGt%
zgVwv)KQ{gEQS_TvAyR*-43gPO*sXAu*-YxKaQ<J&Aca5me}z9S`EQ#+n^(AheFm-f
zkN><Lw0?a0ch4Z%tvkb321)%Xod5M1^yej||H2ux-lzT>U}CG|{SE>B8Vu{BTcFd%
zz~%%hc({R8pr?(_(a`WkLA5n3108;(GnJWiFEs8m7mtojOzafUT02F!%%GB|4?iTF
za|+(c2Rom^$z%3bNF1)dgEiJtTP8`gEypIireiW=IppkA`9j)q25Jy9Uok%$Xg@XJ
z&i1XMC!l~bF#du|+cn9<@ZomxSCu|<*KV`&jZ9DQO7keRX^n6{JY7KOHQ~L?C4T$%
zb(NxS1;W_=LleBj`eS)qBfJJ=sLjdYAlahB@(;A?^AL*L++Nw46XJXCLU-jxq~lAv
z<dVs{FQyHUC4klT<Z$_a8mq~T)uFI8i6n6=0|GWE-H`rd;aF)fa*p-k=jLz2X@@A+
z6b8>Y1QUh(g2vOec;`xous2y1`px!A*b1@o%9AjwU8ZVD?;S#nud9;3cA~T?;SB!o
z_WHRi&s|$_QNpeS!h0U2$a-`NtX*wB6M@6tkY1%MI0h|!NrsgU_}^re@2%a3&&|Zz
zwx66*Uiz9H|8p0f!GBP&$e(tCcPZx5@KeN4_31sAQ+kRnk@7MmE2lM=K3!xR1;4lK
z5LH(4189r#<;jXKvmI*5rm9QY_l;5xwWTT~n`i4n+wRDH`B6G_3)P`wt-AbOMrpEa
z#Pw5c1SD)VbZP!0;>!)agVIUMx20WNbJP8C6_YOv{d=7lm&P;0Mn7CAlp9$EkAxh<
zedXkdhdIu#W09R2jLr3IYR6iVC6iMT)iyi|-pA@=*ph8a&Np{vX~AaO6q4!Ll+9FE
z7hRMl9%PR`X*}5S&^<@4=m{l;A1gW(I(x14wzSrDr7`Y4u&o@^Ox1>r(thMszTmG}
zW8apiYK9hHO4h6#5=rxkwD*0@rTa2FmPa|TsB)%(7x`+pUQ>dgR@BXmp>ag@(tUeW
zo7|XC8PLB)INAOX_%2KtxgwGwrCPK~{?-E26GM%)-q7R6JbSlfNWYqwn}KUNUSV`g
z!tMxIs>bHyX*(}i=mbz$UKQwA_(m{>&w0M~MYcD5n$>wV|KVeZw2Jeq9T!=)cYjHC
z^fu`qPeYkJF<qPiR#*|BEH5bdR`<E3Hv7FlD*_ZOTf|&Xzp}>2A8M9xapoy6qSCy_
z#{B>Yo`BXgN9<D0Oi9q}*#6duo`MS|3w?{tYzixhRT0Yv0{Wdo*=mMh$!A*+R|U^O
zV(BhS&ocGU*0iN5bv@Yk-Z2a_Gh4oRl?%VtZS4sC@uB3J;0eD8A%%XQiz}oq)1Sjv
zB@Jq@l$|MT+)}j(3pVcQuvPn@FG*v)&j$QIHjCw^9Rk5y(RxR&W!t-usVb31{;*2Y
z*SA_G$}`$B2l1<;H%)msYCc7>?3^}Em6yX071$|o;)R%+b}+?k>wMy(r!?CtbIoFA
zWwiNbn=%OARHHkxQ2znH_x7HdvrpkWzI&#Uq_%5C4nONMk-5V4(Iovux1y4Wm}mdv
zvnRFUuJOp>Zknq0ont;CM0w)UXaER1GepwSxVjS`$E!jX<e6&xzV(a+?TCCL##6mK
zd2)8ADjnQDn3(eu_=<OJHZ{|4xg=l+^L`IY!oKLHyBZf=U&nGC=_~S%Wy8^YQ=*W%
zSew~<%}Zq$8=k?tjMB{24}^Swf}HPjZvh7M8oqjo6`GcG)O!9)Ose+_D0d9rIP{cF
zp?x`l-RpVB6$Eo>$Ygor;x359ZT4^MN2Ld<F(D&tPu)A@?KRcZus`ds4RZ~>maI$H
z)|O^THmmh~_Ez`j%4|nVneRw3c^ei4dx-wrME4iq40#OHLr6xoCC5gC9B!n0_60g`
z>6#k1XXAl@M9Jz!&B@AH6AM-xjfW*|0;J(1cKL^KiGC3-iT2n{5^Y%3T#wB4r*l1a
zErm6!=jr%IIOAl+cXBYJZV6!^KHd3N*JRAEX>Jpr8XfjtQ(+;FylR5WnwV{4$h0Uw
z{KS{};!b^rbJ`UPgCWKxTF$+0sa{6sZWh(7t%hj5vz+KtjX5V69Lc_RN6IM@{o_No
zvX-EF_d=^o$8Du)trglwOsk%=BS*2UYp)#hM&VO6Yt_&*i^rlFL{6_<X}I%X^(()h
zAt#YDSwDXdqIYkNx_1s4`#E}Fl*Ju>HTK2?ncOg(L^Qv$&s&{+FbW@^fXNQ7Xc|K9
z2Y2sS1ItK|EAK7mNfD&F76cX-;n<QGpilDIpUV__oo;(gPG{Q~r;yBW_*C~p>v%^m
z4~~u^r+Op%QNkkujQn+TgXhsK`|cR&L&~PAms?Ajg0BzJ=*Z90vG-kasnH{E>jh;I
zmNCP3S>5yF^8)4RT6#j37UQf+Q%r082n?qxLSrKE%-SJHXMQjQ;SwlJvG4y8hBuuS
z9Ox8)<#XptNR9tw(LCbupcTT)#Svx1j_kkxnMGecjl7~Naz+3p-b|kR#(U+ulA_!x
z*-zH8;>ZS<T|HkEYBISVocZ=H&qYX_2c_--{PqIs5ZcBAPv9!vs~5WC_?ugM2_11V
zf#KW?hCIdlwq0=@Z)CHqN_!v>;-j**GTU~g?q;YV)`a$Q+z!T1hO#EH%7!!0w;J@E
zCfo_CgvUcG#&=|Aq9tyUY}g>Xi@9<+Vxh6OGE_p`=9rl2=B<ivD7Gt(#HHE4W+v#Z
z1y7cbw?4_32Z5iGt-!<2pxL#MuM$t9oe!tqC57?bqaPLb^@eK7!Em@kNwllFuAb(h
zUO4xSH*9AWZjx?rRE{T+vMH2iOH#^h&Bvc&<ujpVuMf{|oG!54FBY#GeW{(PJ=B;z
zf^}p@4r2Da;|Akf(>w;HCmN&Mgred|T7EH>+9MhFLl!14kpxFQXR|ey<<Rz_ofT6v
z^YwY0<#b_lp(!<j0)=HwVmL$Pv~}C)^WU4}xUWY}i&|NvJqBuw-Qlj?jZKI2J@-WP
zsp|Cz_G#v)G0!lX>=0$q4_jno;!bjEktmhLuXSp%Ewy*#)fOgIHVwFEV&dXQ;?s^T
zd_<^ek^4d;@ll5&YC@W?V4k>*Hre0d!gp+!;2jlZe2aRb=^xFlSPeUjnHs*t!V$Sg
zOOr3<XZx!woW`B^x{%V1ig7HLmE$vvk~+Q|c!6Xmgn@F>78;i{mC2;9b<Q2teiv{0
zGA6EWcO&CrAwG^1kOOBdvVw})RTF-oa145WQX^kznxZQXm;}VDt(J+=D87{0Yo*%F
zjW?CXd0`zmrZ4F4eiR|cIoi+ViyucO(=;yVZ%g2fs!z+-i*Fac^i(yKVMratrb)IO
zz^<s%Ha4?AN^q&$w^Okjww#6)qR;naJBpJ=vWV!6%9~vHq^q%mm@T{5=E%cn#`o!I
z|3KjOBakCFLCLEL_A8;0uNcegqlF+sZS}iOw(hAH%3HSvgQ9cL{)5@<XDXM>Z~_AJ
z<*4yH2F#zNcCaqN>LR!6vI!jy-d5*(5SjbNMHwPOLrB)e34TNN{~YXcEOu??X}@hl
zq~EJB&3DwW%O6E6{FT}d?&9MuV@7Y;?6<g*?P!vzTE%_TXB^A$Qkz_FT}!uwD6E=)
zLssHCxeqSn$)nM3XDbxC68SR1nZ~hBp^X0?d5o?HfmMr3pg9>Z=^4w+!3AZ87U^8w
zd!)ASs>uE<m01<>HxKN1LJ#jCT2!HiXGa)KXkV3BvySXbySt*ATPtMVDPT1jl;914
zIh95D>Mvg1Cn+x(M>UOi|CE4?%&q`NA4USdj%a3=!7LMVx6u_wHR1hVK0Fe{$iK`v
zR@Y!&X^<oyG2ifZ1$0YUE{hx4so{qs?ta$#<mx|IJ;S4?c3fZajvz~5$M!o#`coGZ
zl=WE1_U|YJ_TKWz{Tw<kmPg{%T3=(1oDOY|mgKT^n_cEB_r7T?FWr2gJX&p$S1%|Z
z*)VqIht)z{iWfGP*@Q`$w*$4Ld$=}FS#W0|k5DbtEKPaZ4`*%PrZY4RG=#lUdd^^1
zxP-Yb8Nmh-^mn#j)rG5LBlxFTre{V+JXf^MYxAV+vOD{ouS&GSyh_e@8(GC~drjF5
z9h&Vc4y9AO_)vdurOqCmr?I5$UUrv2d<Sb~OWW&O6CO#r*vJTL$`1W}vB9)YKMvM3
zY?sZA^u))LM&DP`EaX=zF63A5ZhxV#-*hCc$&5A7BF_4S-gQ3WN%mZtNxG+UBr-Tz
z?G3w%O;Z<@El-=b#i@R7BMK2Mu4pV)wvQvbYOgb#9n~Cc9<Lcz7yrassK|rziPU*~
zxgrk{RVtOceN?`Qk13hIGj?KdR|>NgU7x6hpgut)?FePsCwG>K^*eg_)~oz(1zZvG
z#JEo}!Bk|=XX}E91A}hSKcmRHSpo;JnFi#~UT$riJiR^YP6L|n6dqlCb!WR6(T-kc
zG1}u?OsP$la#ppusD8{)E)E-*YBL+f@LbO9Oey;u>o<WXZW;#U9`)T=L7v{vUZ+J(
zA0YNH6Fx8G;rR#MdX%#wyjb`2NN8i~Pv}3gNx)UhnMFBXX7CS8<$A+8!5bZkUc`tK
zV@gxxOg+xo(MS8Sm=6{0;<&IEk4LcX`MmGmzjmvy@rbrqw4jrOnc#PN!DYSW3Jxuk
z#{;P1aI&t+7;52j*@1e778u9-@O#^5Sc2A;b1FYDchfEE2rh<Y4fDDV6<j?*S@_ti
zvs(BSkxO|=Y~!L;bdjqI`4oJ;NLzd2N>k|W6thGcS*C4FoC;);BjxH7a={TyEKPOK
zX~n(aZ29|kuf*OflnI!sG~Gi-)LNuTFVG;5U+8vJ-0k?RtF_Bf@RfQUt$o9#Dtu-^
z>g?*L6^5&3>B+w6+3+!IZn&RgAleM_DZTJJGuv?O$>Vu+d!i)wFcU3)#7p`n9^Da6
zUlH~h-RiG&R@B!_Q8c;A0vGmhXI_j5^F8)sLhcLsnE3B164r79#q_U|4q_XFC1~t5
z6nj;b%lF|H@+pxs5t@fErXM@Dy+0fg*)&}@Tt{@UT(TeZy)jjl_t~o~!MP5eVA#jU
zSG#?c<>7MRYX^A;pAV|hV_#kUcBnojrt+Co1kQ}rmTNV<u3C6=f7nrR(LKb4g)pAf
zc9yw*XY@h_gvPz1QliY$QFK?vlMY;Oa;Pc)PwTu6<Hl)Hh{;mlaLwH!$!7*N$C6K{
z*BoOhpT$r<9}6ft<|UFs#yEX1i#sb$Ec6oSUSc^cn@AdHP)fy4&0nXVG=ZvBWLb{0
zepMHnypPXxo_=%YMFT>N;S^y(;rhhNB#!Q+1tEZQsF)O@5OBcR+JFq>HS}98_DXCx
zXh4Q*7m(y0V)<z-gef$-wgWnTtLOX;EF^^~vRPJSTdNwjh#VZ&$0g5%yZ<!&YaTw6
zA@Pkvb_1+W-Znc1hgH0o*UsPWAir>$P`W?;+yx7Y>h1JIQj1eAF8)C~f5h%t<tQ9B
zgSN>xxO=Jvu3kWDfh%?|wICD?Gb{<E+b$=xm{C;mbq4;{gpRiGe33D?no!jOe5UEQ
zWQ6y%(w}|CU($Dczois4v9g<2HtTaDi4%g>?s|abzadych;K^JL9%5N!#;4O8;|fo
zp=u`IbWc8?SlIo+0;;CzlHbl>AnkI{7^>z*uP0Rr=-lRV6z;e)&idU4MoNA6$cPg4
zoL(<BbSlO+Ker_|x}51=8hLUdF<YFd2XFIeJVjBp4S6hm2ZxPouu4~R7#UN1fx}*B
zh$H%TPq{!IDLleqTNzHLt6}MrQ4GQqB+v2tjg~d>%|-b{5mz8=*5xbvQ;_OXr(4fj
z)x`JJrqo}^$xM4<HE!D8qv3Xnz~-E@xD3>(xn|X6+S?$U`*d#YN5r<0axdDCvC7?3
zv!4*pl{5|-B_xY^t*k9s7ue=hX6{4ipCd4H89n&OF_k|g5?(&E=eeTBLF0tdJg+Y4
zB+~2{^NgwIZsNzWg&E$V;{A!FS(eMjCu(q5EJm=WPeKp_cCVw<`^kV@_kB-*Brh5(
zOer&OA6eX+P(85_^hynNUKnE-ex@oe^xKL7d45rI^l0;8B8U{FJLRko@R_NUd)O11
z!Jst0^RSh5$k12IT=l#$_ro?8SA90H=uRk+I&DeQ_2?UV>a_jAZ+GGG`~@o6d=l_<
zN2r<s=@{=(CxSI)5VB&`Rmz>fVQ6@2+?rq-?-=C(*Tff+F&?hCF!iI9QLlsk4S2M<
zFr}yo{~(MGpP86>ziGn%xD|BB#NObsI1^RgfoikIRt-kv{Gnu)q!nd6K9j#9IiN?;
z4`}xD9xig+SqLa?5ngkiEJiOTNS!i(HJ_Mp5ulPMByEYgoMnn6kOye8=3Og2BeL(J
z<6VqLZokA`d}amfteoaMssXDLjLr@2fI7}CZ<~%qF$+@^3sPHq&8g}(e@aTWIdllf
zn~ijMb`ylqg^ti`dtWbuu_aB(h#(Yo3!Js0d18sAo5kpr+0lFu8;$YigKkX`B-Gr)
z${#i&?cTJ)m{R4#`@j~5BplDUD14z#J3wL*#xQD}t;+fN70B}@NA_7M={wGa=utGF
zL+0nMUarZ!{LF@;7SO)4$e5bV1{adqsb;j**j45&ObNea056pa1_5iJv8(udIG(@3
zG1BNE=Ge1vTy^wa?MnPzs(!C7mBPztz`QEs@YiK~g(=+EF7$Q6h%0$Q6mT)L6SvBD
zP03p;P2<NdYMg)f;KssSk_NE)_<^j^y}(jw1zxxFo-HhK9;RUC`}Ew}?v&h8X;)qL
zEFZaklI|ms3N+m}PJNSa^^i{OW}okeXK*TXv;<HU0}OU$afa~7Mh4z_HzJfw%so};
zpc1r3S%AeH@Sn!)Dpp&WuBRR}e^TMJ3m9|NQ7y2v9(*)0E(f2<arcn@{Y>vvQQ{Q9
zFbLpWEcd(w;6W|-Q@wctAC}`(U#-+J^6R(Uk}yn10j%X#HD>wETRnaW!&}F0c$E%3
zHzI`1yxx~%_3-r1kBFLP^0z|%KvQ48R!y)<Bh0g<(TY&YclY+KWaDwuL{hx+PkrJ*
z#e(feyK-bs0=tPC1zrB-mR(esqkkU^Igyupr#fC`{<eL{kCNi{6W^Lvm!~AbMXM^0
z1W+lrC4id2R#%pOZURb&E;6$1<!GjYF76pY_o+x$F|gU2g3>{8KrF2USQWBO?tK%d
zsj?uzH%dbR?)I};B(o_|%mNSaBFOo7qB0Fu)@Oz7yh@V#0Sf_KiJb{+GmZRhmDhL`
zZhfwgF)XkxasAqvRZK+<G#C#Ef$Q;On?`Vv`2t`s$nu%zo+&m906lBH4K3lI#?Prs
zr9KCRF)SKTA85*nuzPsNQtz|yp=t_`ofo(|=fwhWNvjVa6W89!_<ujMUkQm{0h;Pw
z(y&zmFxXBpNAz2rpL6dWc?nZ}Pjmahz5bHXjkEeZq?03YGCR!=)1SpIefims>SzYR
zah!VkCR`PnB7J*r%CL)1l%8Q{Lc0G4C@|o$+3{YN_$2=yADW>e>8>1&00BH@L}phU
z9R$GBY}G1d*$_ZI#sq;YR7`N}0tefb&y}<7H-Q;V7+86Pj-Gy$kn9lL91^DL-y{RF
zXSuh)YhjxK*?;8btBFb%Y<bB{(N*m($7ddIZIdRyzRhOM(j<4~nkLJ8eYia_@USQE
z6QbgWe9*Uo($+-w&_ai*SZJm==I3bhScpqQob;=ZX5r-9=XuX!vaiWQhFp}Zt)IHJ
z$?1nR#O;qfrgd23?vNU(Q)^gc3Y@2T0PKE#Om*zGORIg{_PU!7xUYsi#quoB0>}$8
zf)dxi$8|$ht#Ib$#8Rbe=BsxnVqkmC2&Fp{lqDM3!-6EW>mTnYEZhv}tQExI=(tX>
zzSMkPPQ0Ir51yNNom>SVP3hoDYa*hkjzQNut1UytZoVI7x?kS&Hgwk%z?EhoDK!?k
zCIme6CfFg7kfZxDOORJum0$|TX9n$Fd2_UoyYKRxD^4{x8i0u0<*^NU(Itl@eVw6T
zXR9>AD?*RF7Wme!H#)(Q6!7K{1zcWxEh#DZHGmVosSKKps)1X61|Y4bG;s}t00e-f
zvns2TUAggbyb30}PJWmAOt=+7v!fh9!}rBS>RjKP^dJw;YCx$1<WH!y#goc81>nB?
z8g^wqSwXy)mt#TTO74!MuguMCI)TQm*r`L+*0_6%BekJ5;MPYduq&0DzyAFtOf(5A
zPl$O}zAYWVS8u<9+u<>wt;7)wjwZ^s90@!8^j)FjP(S0eZYO~6MRU`Tu|(4^6w1O-
zOKXY@{SDRbMR;zy+awcYXfWdY#e`LWWQzgm^7~$-LCQM6jMjbeJ_U{zVul~p;&Ig!
zZsC%b+EBHRA!NM+eu;O#xgW-$Lr1xrRzUhG$P+uWE<$NCD(h8h0RZe#UHa{D#T!t@
zB<#G)bAqxjWzwp5>4k~xMo$f%g$#9#A1ZatQ45%~w@A-!o^4=Hej{{rN`*qu&x|6J
zT(CwlpTh`=PVPTLpWOZE+7sM)>fdNStOg~Lel&{aaUIbmmwR76UjeSArz-q^3}*#~
zFjlPre<o53PXWuR!COn;pLQ6{#b+FR?h8@ht9eKqVOJem4n47wU`<fdd4zX#c-J3d
z0v%E@YN^P6mw<iF8jLs9dF<uIB1(K{9S8!^+Hv|=!g)fbEF71&8q{WyimN7v*KAKD
zb)QTVz(hYmvv}kb9=w-SO;(4p;9n4|6_ZHajFC2=rJwT`k8&^|@5+9ZR9*k+Qa?Cf
z>0eapKMNgl@<}2cU{DzCNhE3Uw0@ohOcx*Gr=-dROYh_P3FmeNSQ7%c?S(Nhb*$xb
z!juFCR9OWM2oWcq-09s^AV!Rly<I;*6=F@5rsWMhgs<b9d`uNWmBx#_U_cgR9rFpG
z3b6vx`V;Id2yAevn2Mu7$YZLs|39{5tyHNn@F8q(XP~ud!WyHt7^iabIHMK#j|Up4
Mj*0eT&2y3e1#L_eFaQ7m

literal 0
HcmV?d00001

diff --git a/docs/source/developer/data_acess/bec_messaging.md b/docs/source/developer/data_acess/bec_messaging.md
new file mode 100644
index 00000000..bcba3413
--- /dev/null
+++ b/docs/source/developer/data_acess/bec_messaging.md
@@ -0,0 +1,85 @@
+(developer.bec_messaging)=
+# Introduction to the BEC messaging system
+The BEC messaging system is the backbone of the BEC system and is responsible for the communication between the different components of the BEC system. The following sections provide an overview of its components: the Redis server, the Python-based Redis connector, the BECMessage classes and the EndpointInfo class.
+
+Redis is an open-source, in-memory data structure store that can be used as a database, cache, and message broker. Every entry is associated with a unique channel name, e.g. `internal/devices/readback/samx`. Depending on the stored data, it supports various operations such as get, set, delete, publish/subscribe as well as stream operations and many more. To learn more about the core functionality of Redis, visit the [Redis website](https://redis.io/). 
+
+For storing and retrieving data in BEC, there are three building blocks to describe any communication:
+- `RedisConnector`
+    A wrapper around the `redis-py` package to simplify the interaction with the Redis server.
+- `BECMessage`
+    A set of classes that provide a uniform way to send and receive data irrespective of the data type.
+- `EndpointInfo`
+    A class that provides a mapping between the Redis channel, the BECMessage class and the supported operations for the channel. 
+
+Sending a message to Redis typically involves using an already existing instance of the `RedisConnector` class, creating a new instance of a `BECMessage` class and sending it to the desired endpoint using corresponding method of the EndpointInfo class and the `RedisConnector` class.
+The mapping between the Redis channel, the BECMessage class and the supported operations for the channel is provided by the `EndpointInfo` class:
+
+```{figure} ../../assets/messaging_system.png
+:name: messaging_system
+:align: center
+
+The EndpointInfo class provides a mapping between the endpoint in Redis, the supported operations of the redis channel and the message type, i.e. what kind of BECMessage class is used to generate the data.
+```
+
+
+````{dropdown} View tutorial: Example of a communication with Redis
+:icon: code-square
+:animate: fade-in-slide-down
+
+```{note}
+Please note that the following tutorial also includes the sending of messages to Redis. Under normal circumstances, the messages are sent by the BEC system itself and not by the user. This tutorial is intended to show how the BEC messaging system works and therefore includes the sending of messages.
+```
+
+Let's assume we want to send a new file event message to Redis to inform other services about a new file being created for the device "samx". To this end, we will use the `file_event` endpoint:
+
+```python
+from bec_lib.endpoints import MessageEndpoints
+
+MessageEndpoints.file_event("samx")
+```
+
+Executing the code above will return the following output:
+
+```
+• demo [11/10] ❯❯ MessageEndpoints.file_event("samx")
+Out[11]: EndpointInfo(endpoint='public/file_event/samx', message_type=<class 'bec_lib.messages.FileMessage'>, message_op=<MessageOp.SET_PUBLISH: ['register', 'set_and_publish', 'delete', 'get', 'keys']>)
+```
+
+As we can see, the `file_event` endpoint is associated with the Redis channel `public/file_event/samx` and the message type `FileMessage`. The message operations supported by this endpoint are `register`, `set_and_publish`, `delete`, `get`, and `keys`.
+
+In order to send a message to this endpoint, we need to create a new instance of the `FileMessage` class and send it to the Redis server using the `set_and_publish` operation:
+
+```python
+from bec_lib.endpoints import MessageEndpoints
+from bec_lib import messages
+
+# create a new instance of a BECMessage class, e.g. a FileMessage
+msg = messages.FileMessage(file_path='path/to/file', done=False, successful=True, metadata={'scan_id': "1234"})
+
+bec.connector.set_and_publish(MessageEndpoints.file_event("samx"), msg)
+
+```
+
+Another service listening to the `public/file_event/samx` channel will receive the message and can act accordingly.
+If we simply want to retrieve the last message from the `public/file_event/samx` channel, we can use the `get` operation:
+
+```python
+from bec_lib.endpoints import MessageEndpoints
+
+# get the last message from the 'public/file_event/samx' channel
+out = bec.connector.get(MessageEndpoints.file_event("samx"))
+out
+```
+
+````
+
+## BECMessage classes
+The BECMessage classes are used to create messages that can be sent to Redis. Upon initialization, a BECMessage class validates the input against the predefined schema and raises an error in case of a mismatch. This ensures that the data sent to Redis is always in the correct format. The BECMessage classes are defined in the `bec_lib.messages`:
+
+````{dropdown} View code: BECMessage classes
+```{literalinclude} ../../../../bec_lib/bec_lib/messages.py
+```
+````
+
+Every instance of a BECMessage provides the attributes `content` and `metadata`, both returning dictionaries. The `content` attribute contains the actual data that is sent to Redis, while the `metadata` attribute contains additional information about the message.