From dfb02251e15c3291bbace4b9bddfd6d0a577c988 Mon Sep 17 00:00:00 2001 From: f4exb Date: Sat, 11 May 2019 01:15:26 +0200 Subject: [PATCH] Updated main window readme with recent changes in channel top bar controls --- doc/img/MainWindow_channel_01.png | Bin 0 -> 2039 bytes doc/img/MainWindow_channel_01.xcf | Bin 0 -> 6209 bytes doc/img/MainWindow_channel_02.png | Bin 0 -> 2204 bytes sdrgui/readme.md | 32 ++++++++++++++++++++---------- 4 files changed, 22 insertions(+), 10 deletions(-) create mode 100644 doc/img/MainWindow_channel_01.png create mode 100644 doc/img/MainWindow_channel_01.xcf create mode 100644 doc/img/MainWindow_channel_02.png diff --git a/doc/img/MainWindow_channel_01.png b/doc/img/MainWindow_channel_01.png new file mode 100644 index 0000000000000000000000000000000000000000..28f4f68b3de31d79592f97c7800d6b3e5d857c41 GIT binary patch literal 2039 zcmVWFU8GbZ8()Nlj2>E@cM*00&!1L_t(|+U=TsOjK7I zho6C|0zyaEVJhQ{5UVk=hPpG^!LL>#b;LlFV9Zw99j5O1f$2u*Y80%vv72ozCNPPS zS|_d;G}b605x2XhtZoU|!4XRR{#J^BMn;qw9TD&TfjbInW+1qQ?s<}v%-nn4bKacy zci(gFIadZq2>$O05JMmkLJ$Zc2!s#>LI?sO1c4BOKnOt~gdh+?5C|a%gb)Nm2m&Dl zfe?Z~2tgo(AP_)pe@;yXxbV7Fhi1FD)&N zDf#(SW@Ly6_P42Fs?|#SgbDn$puq1yN+!i zOq%qPh0tXYG{<3XWN zuw=;+Qd3jewr$&hed5|~+~7;CmPZdB{IWAbcPthQSFc_rGcyyb)yjee3(#t{KJ7Fb z4Rv*Ocsw2eT3cJ$ym>SG_U-GnFPdr7c)zleg{MzruB$`;%-Z7h$Vldum9ea`kw2V0 z%LKF8drzN{!NN0VSbX_1zpt)FJ$bUvz9I|;J~(!ag=fyN=;B3YSgi!e<%Fu$EUm9c z9u!3A$dP2;zt68tCX$PbNvo|Tv8V`H!1LjVu~_)<)G30)!v~%a!otEBJ9aGP<>g3{ zM00a9t5&U|p`pR2ZFO}uX0sWi(TG;7MJAKc*49RAYiqB389a0-bBl}l{`1e-79Gvr zgaiyLR}y730x)~~cA6ayHmlVXCnYf>FOTq;7$OV?rmkDZp7?ma8am=`g9`SeYZ=!HxpvuAVv)~$iJj}RIf3V_?~ewrHF+WfNJwQCm_E?hvb*OQQtfLt!8rly9Hk`kOw zXODdu6&J^YmKH9SmU>h4h5h?^GbxGYni@3Irg1Pe6(kAg#fxkmGX_sjQH`>F(XT-ptU_(gJ`|sl@GecM->n_e>=0b~|>v9e|M|N0OYJ zOlD>#IXO8!_9aB6!rkp@x_|pNzZy4=;Nimo@H`{1`?qg*4oq+`lRxz~(0s>GfmE`2)5bk51Qz#S|42CY(8X6inaNq!HwVJ_$2lw2UrY1sE zs;=S)569Kiv1(TA(P2^ z?6>p$dCHeBXV|!L=sx;r;7kpd9bJzOolYltd3k=<|L+?@Zf-7f=FDN%tXatAa@yP5 zsjaPL)22;6eMl}Y?y?_$^M@ZOijActC57o@#L> z-_D>X>!fSt<2aOk{b#4Av;QTVQi7i;BWQIJ^(U4SH7bGJbPdBI z)GtqYjW@V={V)7<_MhH!hMrl=+m=FgumBG69==u08ETrR)rwzaj9mGyLip;Rha zzkWSsWn~;be3*j=50agoO-M+HU+vACH_!V!Iy##1;u|L+B8^>`-;>b3I zOxx@sbwk=A7>L&-tQ1IDsm2PcCea2hO-N{1XVMnZ1{%_2gbwEkd5|=AuFt-6ANDnv z4aPvKwiA6h-}`*`yXSY0@3q=0stlXi5<`it+`_=v0`zUlz?cW5P{6+oAk8W-!%%{e z350;OKsu49eha|=DVS5Okaihsuc)w8xAasKxm7PHGzY}jOTl^ULU`nfgKau4rn zt1w$F%d8GtG1Y;$g2{8bs>>|~r@h=(oS&3eVrA{+c84L4pO!hS>&=Gc4=?9O9A<@R z%7@VPaY7}#;l>ON-R!I~v$jgBVTH67D68WsMcuNEl{S~bR>_uHoHX8EQsT6@A_dau z>s5j#Hk9^39ExU!QQP4Tyayeg5|sM;M5A=SXor(mzhZHeo2y@5ZlqSF=#l_4y;}rG zBl6Up-aV?PBO6HKlVp6dj8BpAsWLttc$!xliNHv?@uYe}Erd`Dl|4+VIR9_R^6QV+BdLRK1~YEjRT;g& z2!F6yp9F&EAwLZ8pQ4HmY1hXBb_F%X11iT6(S=Q4N%g)3J-`ttX^9Wzmwq1 zW0+8u@y(N@fP{>vwmxsxm{Zql*^FYfCG_UjAO8lYV6LN=BoeOo1kS~?Ctt)EWHp%u z8Fw6KwJdl1L!5(yq=<@%YzV|&Hkl3gf;I%&UhtXg#e`L`UpqQ3PmZ;205(jp0&~;v zU_G9#C*Vfy!B@H_2j2i@jtKtU&1J0P+=(0cPkr&{;-7x)VOhbQoAiPwXLrc`Rk-`$ zrLmC@FmC9ZzWg4>AB;^5{vL~KvQ@;vvUZD$B7i6rWl;Np7!_|I&jflEVSDPF-|IeW~q>FO3C0qdw|mF%pW zlu=peF_dtGmN58fXDw;Kcz5l|fgSjOEJe`Ob#-_jEIUD4$vS5KP{vlZe;HfH#a%P+ z;QHye@r6^{cF#0+oxwXkBVN9f@|(QnlZol^*2ql=PluJ^3jzGrKSoEIFs|#HxzdF9 z4v!8r4qfJBPw?BOtv$MJW??_z4~1>kjxjjEHUozo%z-5hb6}%evK_W0N1iQuyr_^o zVG0qG$=aZ82wP1L^Flw-l5jr=L9ncwf{>}nbtco(M~AKq9$slmG)-?cnO^>h=~?oa zDZ>=XT2kc11vs>1-l%0Tr}%kgb>I80g#cem4`qr z%0WS#O+^ZUTI8n?@Pjr4T0ez=A6*9lq(I!rYNSWA1_Ex^KtS-9Lm-ZS6au_^ECfV< z73wbh=!?%?2tDxr@cCkdTs;>){vHz7ltDnKAPNC7UWxiL$JU~p!Dmq0uhe;y#)8Ql z^z+Xn2_y&z14iPX;r#5!vkNg`0Lw7|LKFia z+yn-6X-P~06VfH+Mlg_;a~%efZioRUE(Sm=Z;$*K5L?S*0Nic~1ET+JVSvwZI~WiW z+ztkW4F5R>#5P2afm_FbnBulD06FA0`PMK1!ErDE+8ba1EZ1Ow;W5Af1{gU8K!{=h zgnx?xx4MNGNuottl3~@BDs6729*4bHgXiku_*Dy2mZ0Lcy@nHH8YK=K2#k$))_`jr zcl7*l_cj{TH0r|(XoM0E4m4r!nMTn1NGskxbqKh_;|*9Rn1{N*JWzw-Xa_SK)EArT z$-(hG@FR&29@=?gXy(**-U`1V29DK}$%$IQs>Y+chyNls?K^W`Fez}L=F)y#)88yN zdv}aBOUnk143CeWhNB#o6%%{${@MN5%^b$YA|r7#ev=Wa?$u}M7D7W%I0b3YoBGx^CH8-^W-L8WPG^q4k7Fs|flxVQ66s7Ea6tr1nGfKMj z3~+1u7a^Ts9y)mRF%5zTeab@m*lxEP$g00Dg(H&>9-8;d(__1md21#@tz`ysaX=?n z)o66d8N1wM-21LzQlNn5Z;v3&u`0PaCH-8Lv}|B)SAYMWlo&Jm&iEq;8iI`3MraH) zg!z9%q=qoGA#UWOpZ>lJL_g=zA-&P_A0bwm*$q~QePd-YHO2b~aVOrK=vs8ddvj6= zCi-9ZmdHyb!<& m4`dP@M4SFo&^-Y3Al19oIm~>r^uI)IMLOTd7ij9ZUHT{D@UgN0 literal 0 HcmV?d00001 diff --git a/doc/img/MainWindow_channel_02.png b/doc/img/MainWindow_channel_02.png new file mode 100644 index 0000000000000000000000000000000000000000..fac110f4b32486b65d552d44d1d44c49c940bb22 GIT binary patch literal 2204 zcmV;N2xIq&P)WFU8GbZ8()Nlj2>E@cM*00;m{L_t(|+U=TqOjB7N z$3KNC4_m8JSV1~8K7zWeW9(W4oz)B@VjyTVW>;nw&@C#H*$lWC1xHMrWM>>V10+Vr zp>frqnIVd3#LR{a(Om+H%fcX|;uAz{s}ZK!A_Z&r4@dtsGPu)qA$8yNs%h@K1aE#u2$tC?Txy~GRv<@@jbL=4m=Uum^4 z&Gb+V?YA)_Ob&R&@uO0-w{8Ns<8|Ni~tq^DzS6b>A6Zw-TSDDceep-?DT zv0?>Nr%pvGmD1DG!};^)DK0LitKS}EqDF&J|D@dPzhq%DT;_UN*=z4Kd1xqWZrq?i zF6WUO`yx-u4951562j9C4G0JzIXRiIurNA1J2`psB$btwF72eHrC~4_*t~f&Hk%EF zLc!X#Ye`B-dSX3$%5{U$h#e&&v9#mU=#*AS}NeO4a{F1%X zr*k+i4()~wsAFRRSiEl^rrKI|g@jO&kih$Sc?8awL9kZK+^t(Fj)~#hi4(b8QbO#W zJud6}-S+J?==JQKHjTeWL@;91C<1597?8)_-Hn%2ihocLrOTF4q}8IDKcBDKM|@nRm{y*oUXhW^N8G5|U|p9GjJ7K>YD4;?zhl`B`!Xf(vd#UYhSsjI7_ zw6v6tjt-C8^3H+xt}R9x&7#xK{dFypWUz4eZseh%TsU};e{S0J+`P8FegbgV?MS@6o$2@k2XHtX zbl$l$eD?@etCgmvCSqe_@$&LQsZ^4in@gaJbxxsBpw(&z+-qxVt>&Ye8Wd_ZvXBsdxps{ntCbO>Mlmxz9f_A0Qa`^JccxUzht<^t&729qgVt88 zMk5l5#N&2%T)s@jr=K!5Je*mdd@_8NhU>KhkN!G3I>^h*^T>wTY-Y!f9V8|uvS`sF zXB?rvzMh>sce*UUw4`J}JpRs4KT#AJN$Ij>%>U{u=5ODQ!)~W?%NANsodV!wN(ze# z3;Eb!z-Bh{ubdoAb#?qZFOT@5B33mv(rGerYQqKs-+h;q`g)3EVxC+7<42D;`^6V5 z-nWmDefy-AiV7O^di<11kNdR8YNaeGiQiXLaI3PCJN5OiO$aY_`snx@tjZ51!e}Jw z>#woToXP(E``w5v)&WqZmoQ#;Zcu@!ob+^z`q@P598O!+dT$XTeA_cZ_4@Th=jW4? zp6zH`jeWPilMR+iSXahd~2xc7pQp=Q93)(I?n~ve+e>FR&pjQ zizuCN;E)l*UAY`j&VDAz%s}t=2;=6AV3N!SQ*$<^W@z}%13MXhjEk@Vy@y_RWHK7Z zD}+bi)*iuQ)QB&X{ugHi?f0`i%AXeBMwYtva&MD%gZ@&;siN4Ir#hgyJc_r^5xFo)2B~o+O%l^1O)|AQ&Ypp ekt2ntUGQHr+x4h49&j=M00006.1. Basic channel settings + +![Channel control 01](../doc/img/MainWindow_channel_01.png) + With most channel types some common basic settings can be set with a popup dialog. This dialog is opened by clicking on the small grey square on the top left of the channel window. The settings are as follows: ![Basic channel settings](../doc/img/BasicChannelSettings.png) -

6.1: Window title

+
6.1.1: Window title
Changes the channel window title -

6.2: Channel color

+
6.1.2: Channel color
Changes the color of the window title bar and spectrum overlay. To change the color click on the color square to open a color chooser dialog. The hex rgb value is displayed next to the color square. -

6.3: Frequency scale display type

+
6.1.3: Frequency scale display type
When the mouse is over the channel window or over the central line in the spectrum a channel parameter is displayed on the frequency scale. This parameter can be: @@ -694,7 +698,7 @@ When the mouse is over the channel window or over the central line in the spectr - AdSnd: UDP address and send port - AdRcv: UDP address and receive port -

6.4: Toggle reverse API feature

+
6.1.4: Toggle reverse API feature
Use this checkbox to toggle on/off the reverse API feature. With reverse API engaged the changes in the channel settings are forwarded to an API endpoint given by address (6.5), port (6.6), device index (6.7) and channel index (6.8) in the same format as the SDRangel REST API channel settings endpoint. With the values of the screenshot the API URL is: `http://127.0.0.1:8888/sdrangel/deviceset/0/channel/0/settings` The JSON payload follows the same format as the SDRangel REST API channel settings. Using the same example this would be: @@ -727,30 +731,38 @@ Note that the PATCH method is used. The full set of parameters is sent only when More details on this feature can be found on the corresponding Wiki page. -

6.5: API address

+
6.1.5: API address
This is the IP address of the API endpoint -

6.6: API port

+
6.1.6: API port
This is the IP port of the API endpoint -

6.7: Device index

+
6.1.7: Device index
This is the targeted device index -

6.8: Channel index

+
6.1.8: Channel index
This is the targeted channel index -

6.9: Cancel changes and exit dialog

+
6.1.9: Cancel changes and exit dialog
Do not make any changes and exit dialog -

6.10: Validate and exit dialog

+
6.1.10: Validate and exit dialog
Validates the data (saves it in the channel marker object) and exits the dialog +

6.2 Device stream assignment

+ +![Channel control 02](../doc/img/MainWindow_channel_02.png) + +The bigger square next to the leftmost "c" square is the device stream assignment control. With single Rx (source device set) and single Tx devices (sink device set) this is inactive because the channel is simply connected to the single stream as shown by the "S" letter. + +This is in place for future MIMO devices and channels support (v.5). +

7. Spectrum from device

This shows the spectrum in the passband returned from the sampling device possibly after decimation. The actual sample rate is shown in the device control at the left of the frequency display (2.3)