From 41b2a6702a810bd4084661ad5d3fa7c2947ecc5c Mon Sep 17 00:00:00 2001 From: ErikUmble Date: Thu, 25 Apr 2024 02:40:06 +0000 Subject: [PATCH] deploy: 11614d3dfa5b9249eb8db2d24924ed2dbc36c7e4 --- .buildinfo | 4 + .doctrees/bluetooth.doctree | Bin 0 -> 4883 bytes .doctrees/environment.pickle | Bin 0 -> 43354 bytes .doctrees/index.doctree | Bin 0 -> 4158 bytes .doctrees/movement.doctree | Bin 0 -> 3062 bytes .doctrees/usage.doctree | Bin 0 -> 11966 bytes .nojekyll | 0 .../nanonav.py | 108 ++ _sources/bluetooth.rst.txt | 30 + _sources/index.rst.txt | 19 + _sources/movement.rst.txt | 12 + _sources/usage.rst.txt | 22 + _static/alabaster.css | 708 ++++++++++++++ _static/basic.css | 925 ++++++++++++++++++ _static/check-solid.svg | 4 + _static/clipboard.min.js | 7 + _static/copy-button.svg | 5 + _static/copybutton.css | 94 ++ _static/copybutton.js | 248 +++++ _static/copybutton_funcs.js | 73 ++ _static/custom.css | 1 + _static/doctools.js | 156 +++ _static/documentation_options.js | 13 + _static/file.png | Bin 0 -> 286 bytes _static/language_data.js | 199 ++++ _static/minus.png | Bin 0 -> 90 bytes _static/plus.png | Bin 0 -> 90 bytes _static/pygments.css | 84 ++ _static/searchtools.js | 619 ++++++++++++ _static/sphinx_highlight.js | 154 +++ bluetooth.html | 138 +++ genindex.html | 107 ++ index.html | 132 +++ movement.html | 122 +++ objects.inv | Bin 0 -> 303 bytes search.html | 124 +++ searchindex.js | 1 + usage.html | 230 +++++ 38 files changed, 4339 insertions(+) create mode 100644 .buildinfo create mode 100644 .doctrees/bluetooth.doctree create mode 100644 .doctrees/environment.pickle create mode 100644 .doctrees/index.doctree create mode 100644 .doctrees/movement.doctree create mode 100644 .doctrees/usage.doctree create mode 100644 .nojekyll create mode 100644 _downloads/e6ffb4613247059f19b76a508c48412c/nanonav.py create mode 100644 _sources/bluetooth.rst.txt create mode 100644 _sources/index.rst.txt create mode 100644 _sources/movement.rst.txt create mode 100644 _sources/usage.rst.txt create mode 100644 _static/alabaster.css create mode 100644 _static/basic.css create mode 100644 _static/check-solid.svg create mode 100644 _static/clipboard.min.js create mode 100644 _static/copy-button.svg create mode 100644 _static/copybutton.css create mode 100644 _static/copybutton.js create mode 100644 _static/copybutton_funcs.js create mode 100644 _static/custom.css create mode 100644 _static/doctools.js create mode 100644 _static/documentation_options.js create mode 100644 _static/file.png create mode 100644 _static/language_data.js create mode 100644 _static/minus.png create mode 100644 _static/plus.png create mode 100644 _static/pygments.css create mode 100644 _static/searchtools.js create mode 100644 _static/sphinx_highlight.js create mode 100644 bluetooth.html create mode 100644 genindex.html create mode 100644 index.html create mode 100644 movement.html create mode 100644 objects.inv create mode 100644 search.html create mode 100644 searchindex.js create mode 100644 usage.html diff --git a/.buildinfo b/.buildinfo new file mode 100644 index 0000000..99eac29 --- /dev/null +++ b/.buildinfo @@ -0,0 +1,4 @@ +# Sphinx build info version 1 +# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. +config: 2a63537479357844bf1192f560225979 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/.doctrees/bluetooth.doctree b/.doctrees/bluetooth.doctree new file mode 100644 index 0000000000000000000000000000000000000000..c7a9dbb1ab745effe51f283a942b31511fd7be31 GIT binary patch literal 4883 zcmd^D&1)pb71yqIB+W<~N&6u}v~t>O981KS3B-X!VT0Ejk;ASfd;O7<)6{g=OqJB# z)vl`6$HAarY$B+eJLHm_4Zaxs|K#FR{*3%ye@$zMH(oIK5W%3SSFc{Z_v-h)=Cbp* zr8{%QpIbAjkjeRgg<+yXZgRI2svwJbV)HNZ-M{3Y``0-w|EcvC>AowdJ~RMH#nBS&-vqNV%{xO`W?DkkxY1gn2nh0F>AFPWfpdk9rH3Yr1N4BF=If) z_fEp%^4n6FrPIZT1t*%1i6?W5mQ83Y7i(fmtcd$!UTnMH4TXyNP-jWP_3%vTli?vt z)FC@<{zFAGEL9thYC{Lwz=D^a+{{KWw+oZlM6*=1-SX%IBa?~OILCXc&b$NMGr90~ z-gsjRmDvq;62F!BrOj_Yt!M#d_LFvv-_X9|(ybsfdrRj&_C33L%8N4c9#;d)8 z&#U;nhR-fMCVnCI#I|@HR?gQRgSE>gpr(jeuL*AT-Ao22-oZJGQy`?k!saY>s>qw) zUlDq;hb4QV&_dz%)ks>dS>%r*6`ZtPug6-&UV@iQ*r_MuRB7wM<-Oi3-eb+l*{t<2 zYIF?1_eK%-9unIQ0p;O?>KPvF_GoKhcoOcs@vGgQ<|b8%A!edOUbwScoBLy2UHTM0 zddEEHMP2tij`mH;C=CrG+cE6tQHIu?c7k>4g)DPF4>4TNOG$m6At!xg#%VYtJ?6U8!fE$YK&E)>4|5sCZw#5>Av|`A=@CqA~_T|eOry>G+w@IdurX) zi&^)1%etRJwLufG|Nf9^sWRimg$5o=Q{y2!d+e0Sh*3NM8?78gDi>Mmza_PS_b2XY zP8ki6;yoqM5TAD@WFR~V(bvR|P%u1s^q$AS{U`~wlHs8D{?Q+f_Ps}8=$Sxso*1Dl zPJ%@y#_FsnOs3MS@gp*6D{*>Rk$D>pnne2lWAGF$fB*hysq_7P#A1P(Yhk?^G`QU( z-0qdA$)~~5;wX{ba6Bhk0LfPF=r$#`CHER}M$~)@-KfUjUC^5TLcH$oTFnv@F=}%B zRI3S+VcB1FtgXfl4rdTYO7y7v61j}Bv%yfj+ zs#Sqc-45;I;tn*_7rDDVMpKq3%UhdIZn#xy?~*L`&k@~m4oV-9B~!l)U27n6tEBLV zQy*!3ih959xo~53plZSn-HPT^Wc`Sra=7oN>j@S$%Z}UN=MrAC%x0!$>bOqGN7)3| z_0O12;5BfdoW`JZ;r@V=QTbn8UncO8&yzrf;6h)S+40_Q_Kd{$``0&puC>y>K+1@? zhQ~?Oz~*kP^mI!~r;w7n?U|h!5#nF2UkaTnP#?X2ePiaNTPFhmG$Y`jsHnWFb(Mv? zLzLQ^Xu{nc%9}d$L!JUAxJCjahi(BOH-?RHhYSH!K9=XXSa5xoS>;bj?xqB`R>Le# z{RV&VYC({Io=#Xq0@n&kfoyvFDJeBP3zd%!0bJ|+JXMDK?UMyW0_&ejBTIa)`Jpsa zBw$FTS1SpJTEN%Yw`fIMA^3;b@I6^Wg9JWG~5rgg&8SW>-+SKe1haj6l+0zV^o(yw$ zk2nhj!0B6#mKEVfjS)}xUj5}8@Mm9-gBkHenTr2;Egq4|2(Kqx4DDfC_?hi%aeW;5zYnjBdimcuHBePn=tTgKq)}WVrWJF4r#>u1ljHywHyOMhO}|B zSfCKX1PS^g5zFs8;v4a`I2IG}skjthi7zwPrCocGLR}h=zPS>|SK`wv@zqr(UM9-d zm?0+^N-jk#z7(HlZngcO#SN>01T08J+*(p7Zfm~Mls2X0gMk1*JW^4Ek%IN^46)(v zUX$3ZZ!Hepz9t{}S6fQ>_hw~PJ1Bd|DuK!U<#m5!>3;5)-{23wy zgD+wY(>JxrbRnkUzPT`nr<&T7y6MO`?LdEhK*<`do%etgEegy7uY7TN%J+LRIc1Ry zJ(ZFYn71(LHSOGQo73N3{-Zhn?d3oJw}hrYI(~d(Ztg`|q^;vOaRPnxQPW5NaWL?j z>-YET!E-e#n;Xu_W6<(nv_Mjj=?#r~A&_d(|)X z?Uppy0+U^g#$3R}O$b>+!s1Ofo6RoSJidK|B#TEQZxTDDt3N4;68*eJN@RJDG*6?Bf}E7h_5$(GX>bmYcacPr@5 z>MHzJqjd;{{Ca`4Io%nj$64Ymb$XpX6j+38K9j4>dcoFt3)RYmJJ||)HD>0$W2Z_8 zo3q%r8%=4DeY#;+e79QhTgQNINSD)%Y`)p3qLx;$LV?Q_sCI%ytgL`3xKmMxpMY#p*L3~uL1yUsSZ zoQ*+e-7eXA-)49*8l0bEs9Qq0iE;x?SyHMN@+CWmejt^CPWA4$^1(XLyIHq$h8VdC zw`5oH?C!OX)~nUVne3w`?aZSf_L){-P1=nHg1LODR6UiOXujeVQ@KVxU-3)%hV;aA za82wz2P#a~L7`lsl=pqxZ%qe1<-Fgp>pAJ4#cri&pJulUGvxf{#Dseqd>bsv)_pQI zN;m4wLIbE4S#`?~mg&rPrBE%p6>v>=voSGz%dk%lT5g{%l$u4GY>j#pcR0&}?jugK zJnmi}pmmS!(3!)shWzuFDsTXmzE)#-f5c z2A^ZIU1x*kOeQK>fUT-~0qQD?yhv*s~&rh}zYP%$Z~+gF>Kq(}feH>L#Vl@7SCL=FtQ8hoG| z21bpNt2Nb!pnhM&F4xefwlC6wtkaVV<3O2Z<|Q{?cZ(QGV?pn6+pgtKLhBBH?Wm@TPgIR z+yR^9CQ5l!d=^9i)$;Wz@R%awg4z@qLk;to*g!*Qr zoybFyqm74E$hwZbuSO<%=^l47D^ZIZc?cdz=p+17xT0Cz{||83?i0TwXVN;fY;n(&~7U z9=pDfr`w1h5nT(sJov6lCL72=5FK+HdJm#P{-rdw>`Mb%NLqW0FHew##^jki9@2$mNiEX`H*)T(4_2xf`va~kDRt^jcw zMky?f$P1%;1t8>%X1|3RH^yN0JR5`=e9TCgL0%H53Nhw#7&{mcAlGVv0%lTCxl?YD zygX0iD+3wBhAit=$YBs1f+AQUrzAV%q5vt{exdG)fFUtdBqn)`U(CyxU=g`Oa-OQY z%Ic{@|aY61i0>|?tCdfE>lS>SQaIO@@i!)F4lhvh7pe4k_ob;3Z7jm zFBAEbE)c_eue^IPYA=@^^)aHi7_1)hcc$iOTE$R>uj)2Rm*u-!32~tXAPjFn z4zes)AzWFnB{;RJ>D$(E(j zE-A9~NKZ&rg%1m6RFNT5jUg_W!*5uHQng}RJ9Klh^2!Egu>Q6|Oj1+j$qTMnky>1} zO-u=GOYTYA0;bYk?u3=mR5X>a7Xd-xXfPO}jpISTodUsT6|Bf_HX9 zyk+)wHNRMcu1;lIQfQk3Utspd(bjSm}W`xRIJH*eq3@32SH6l zyM<+~nrlPKveP9=0I8Cdfd;FBpetH##i}+NwPqvMjj|})2}D&_qBT1yj4F*GL0@5i zP~;GE451+yO7`g*`g9^+@}aj<))0cqwU2^^9ghAT(jB8xqF54UH$_V_Gi3^EHzH*x zBnlw)_YYZ=A-k%DU6ddaWfOq-U{f*#ev@jUPnVwD}5W|hG<=&IGAJmi96L=uy1@$j*z_f*U8sW#CQ zn#ZEV$!a6k0m6WZ#E9UrG*u&scWu&)=3JwH0R+h$C9Ai*oI~K*H*s02}-W2>{fzGnznYO=s$?b zNSe=1iA#q;*vMjIQkdAlVuPi3v?a#R#7CemX*wZMk`T~e5ieaEy@eTdqgl(fGf2QR zInP6i7_^jdL@!AzXp_hcT03^^um%P$6uKJSq14&K#esnJ^+b;;NO2BCC8W=Uj6O_E z70YX4w1UPKRHjK6D}7Z?AQ}>f!z$~;vYR={NfZyDDzkhXTh32c3l&sfE@p`H@7-=_L#7ELkF5snVLFbRX4z zSn-U_ak1DOQC{>2SgoMT!NdkT3>V-^=~6Zz8d)%qvmfP87UMiS{^%e~wPBH>3tBo>B7RMw(la;n~0plB~0qH1X#MXTVdM!6mG>?l#4m31zO&V~fgO%o;46OG&&IVV7 zv5|hQR@q{)xxyrirfw|bRcJ|9-gE!Heb(6M{@vE?yZ4Xo*>~6Iu3d+AA3l5sH1?>J z+NgkDnJ4BCt9#*2o1fzZO;|P8PcT$t*Mni*4Mr$9*sV-db4ey&ZlV)RW+L18cZErbad4N}fx*}`$(1UsBn`}R zVB98ZUuO~u^(rj1;Z_aFPnZpZGgTOHYUjos!>{bW;Sp?pNvfVGk+P^+!OlmpN}{=| z6iy>Dvlv*~e4m(EdQQVY42w&nK{M8}Le4Gbuni_gR$#uvgOjQ;TiJ(DHyCQ{MrgYn4ejM;Y9#oPgx! zwn9-h#`Heobg)5ZI$s0&bv`{ka_nGi!7yvrVfQtAZL2UoO15K{YM92jgAFdBK#!t} z_DLEmWov4&T^VkI1J*^!x|G>R3FdEx;Xg{&=JVxI%<*x(y%wv38V*DV7bs)F6;WQb z3ur_aCZQ;)>{c)n*2~dG*4ijh%3-CYmL|(antpv`+^vi_F1;LD@hZ4;#;q}(cSV@j zBw(jI0t{ku(~aW;+sULO27qjja492XOd6qOc_;A{b7tuW|q#V)fOzxm#`f+ZewES zvfv7nOF;>@2mz<;o`!gia+uxk*aGcpQyTRst7gR4kT?+vTxGgt%6276y2ndR8ibs&kGFM^vIuFthau&`d+0tr)wr4Orc$O>sSTSgW}9AF0BG0Zm@tip5* z<8Z?%rxs*@i^(WPCT7O&r;BB>OxEk#py-+IhOWn?=Z0`*cIcLjB`DFZWh8@sP#n48E`V*&&{7V55Yl{T|^FM z{0+{K_f{1@>})hyvQcm(3T_%R>Fb>hCb-$zVuD+pZ6UNhUnaP*2L`zLoW_Pd!2nId4GtKrp=ULInZ3qy~DxaFO3Q~J6w zXCp{eaEkJ4hq))FC1TQX5&7&~i3Ntlm6tjzjmx&@-9!xPX{Z{#MQqb30EtZ<61i z)xS?WZ!(Q&4VuuK!_dz;Z!wWS@4Qt9y`RNU@t(#*K)ucRMU&_4dl#DEFNGxg<%pr) zVd&)i+r9Hl&UZS`#2UhdfZjV7=)a;7{Z;+@@10+h`2XPix?!&W==_EW{wL=@>!8^! z7orAhwa1=iK`x20T$cf5-V< z6a25ve>1`V9+vta&hMGXcRRmtf`4$Q`9K)@U>N#y=Pyj*PdcA6!B2(AV?=T`;}Hz@yR1vnHk_;pl@BS%f|*8G6EkOAtCMaZ3^Mdhw9AJ_J&)Age7j1&1$`lj)FSVUP|mxWnXWNKUck2(nztA6%`$J-@~z*z zt>@bY^L8Bqd*=%d*E9G+2@Wv0Sb`Y@RhtJ9@;2fj@k0mM*%vyyFYz%?n<107hx7&uuHVQsj;jjO*h38}#mX{eoS>bOVEn4?ktaN?U-9 zcOxFs+O2%sX5MZ>K(+m5#@}M%Z$&`0WqX+8Hs-jU549lkb})QLEaFat&9L+CV!~)F z_3n7;PA2S%rS4|;`a4Br=vcnQKrz<7t4a5$EFgyH*R5f3o@U@YRL2#4h#!i#F) z%fisZ@eD^9ZCZLP{_^s8wp=VFSQF`BTI1A9il948!LrhOL?FBly^5DSUc7NWbVPyS zVl2W&cuc3pm0l>R==&mkjU%ocZW%BWu~Ob-{Kdh`w8`eiQi7PG?Zb$w>?&9@E6m_A z9O~g>6v5gjOj{PEsbx{H)C`pSphFt8f~%u^MtOxcPv=BffWlVBboVfqa+W=2AbB1z z_m1zoyn^9JV-b%rd?pt0 zN`%9q_$nqm9!q_K;n&6@&N4h5i+GaZ*To_NhF>3xcmu*=4R4IUJcSoCbf_zusr$p> zqTnyXg~Ug~&_}}%)JanWTBQj>ximrOm?j8SQwO~_q1rG{vpF90svQ*ZON2axSsMOd z+*8pp%7Dn-rVi{DP)8qgt`GY3fsRnDb{^CM)*R_@RykKdMRL+Jaoi;Zq6oK1@?Z9%6uv=xngGh9eFX zNn*F852@M!MYNw)B;ckTPEPePXKWJyroQ?_Ay)Q!Qx@L4d05`za8}Q{c4I;SfUQO- zKnaQE5|H}b3S7gYy=dpopbrIPqR5@5&5A_h7Kz^+PsXk=8z*o-oZvR_ab)dr@;Kun zdwkqMS}W#E7p}Ij$l)jkG~ z;GdqI(2=dD{GdyFqZC`-iiH@mtMOo|pck9t+{wt7PUWZk)*GQJ=Xhp>+wklL>=5u= zgkzI4*QwoeCbT80*5f>rI?)G46Gu>>i`=5515tg9ue+Wu9O3Thh+aO0zrYr5 z_u_Rvl9~~A0MgzC&2dG7ZZtCwht8T4_J+_k7`>nBh!s-K+E+bg?S`l6SvewxkvrnCqGT^#rXC1;o+?D_A)HwSvV8rL9!c=L$Pd{`8Fj}g5H-jF=(var}NxM zOp+p%mS|RvIK(>pVwx4P(9smsSW`O;C-j<~Go1qJ;J;;oOu(ks(Ou(dm@aP7ye4>>I3 zZ+~?h2ZE9VW425QlKyI{@t20A&!nKnNO~0-x*y3gVHtekfqdPCu?goY*bHt$!_OUF zo^UpBaoi127#eU8H**TxEwjo@lMs$C&|jUoAx5lyJOj*p@Vayh4$nCx!H#2d)^ZOV z7FYJsO0f=i&1}z+1G^4vw?>ONF9R2N9Kdp_4dr}~<&+%F=8{X}6?O*PJ+Y;2COUYf z64MZa)WrAyPqPy&_d6-(xEPjeo1d>yk}1i6Ge|+4%rc!e%n>xKSg(~H*0FqQq=otB zHqOERZ4x=A*QcvbB%Py1uK(hTgV=z>g6={VKH&uw0wP##oHwZv!I&Y}8i=-us~31W z6~|(GOdcppd!gQ|rPF$#6!aCEbu8D7X#*}VOHGVgBYWR~dV{lbW+{)p;Hd`atsM{K zF=+j8@fmc${}1{f%zIqEj0N2|a}5U{9=^j14}-$>s?0kwmS{tY=y^DztzVVTO)sw@ z;L@6@P>kT{)1VL6O5^MnON5!AmzpC_v?~P@F@4IfNy!(QdxEP~jB&KXfnoR)n*}}& z)an9y#ZQ%3dH-qEbAi`^2GNHRj(i{$^x~!;>7|RsH4D}BncD*ZkB+fuH5F)_c*R-x zv)%##fl7Q$QcKQ>r$!D|6nH$rEvAFW(AK+5kuy@KF|+YH3EaMrN=bq6z9l`Y;I=!4 zUz1Eo6%Lk%USRrYSj+1n;v0fhl-YIYl5quh%vpzKMm7y-b^ij6@xDd2=`A+Pa4<7A z5Ku@W;3y*=OYE9u5+e*s13?s3gOhl%n!`#Axo~*~j+}D?Iw~pM4A=IP@Xk>@whV5U z$|p)008y~hoby$qWhwn{Fe@vg6nb87Jcb9?y-u_hcL+eM4ebkHDLT5EdkU0yX>0%T z0q=)so#qL%03_P$Gji0$UJsaH~fRm0roCh zDwg|GI8}Z+7p^Pe+K3a7lPzxvQS-X+^txH}1>vDH#fzYhpb5K%_y~Fnkqf2|j9uA% zG6Te0#CY%9#Nj)9d>4;t?|XQj^%hGSEz(fP-~=NB0ep!*fMrg+TD9L2)n4AEF%E(@ zpyxyWz`7wGODhwxN?|?&GC)}lUpnwYT^sS(1}obtobf&c1iTOOah8wQ@bL~l-pjXQ^!9I@{8@L55@$HFI*49l|Cy}Mut9r3ik(;O+qN_ z(@J!D#kg%Z{m*z_w4Zp3tnIfH|KLFG_8zx#5-x5ugn7aWLOXUh8;!EXwvspPxBrV>)-O`G8mKwK(zwOEi z(%&v`Iy3m#sTPqthcS#9CfC!GR2426R7Duog2QORg(=3~88-iw93^TEQBIIUE12yo zsH6&;)L4VXdX`;?3sd0vhzWo9p+g5?&s0{ry{nTe9$oWY>{KzbokKlbLkl17;=wt4 zPA-OvWjrkjqeZ$cF}E%80v`7Go z?1aQS@efS+W>RJUH&UgFuu-`Z9tA#bNsZM+!$F*1Zck%H>I zh7m%9&KXP=TXxE6eXNv)i??GDwEYp;Cw&B0T*!V5M+3Zoao+~!QrxOwL~h0tvv*$- z0_I8CUQj~kEh%imHhTS#4BU^yVhP)Yr?Fs2PMX2eI4-76nQfhC65_&pCo9PS9%f@f zN!zdznEc9Yn9QP7W`ae66gHf&(;0N)$%_hFwzo^wG?NzljB52eP}hZOs~`Zui`Wdh z^L`V+cvs+rlKKmo3kz>tC3hNk_F(P9y;QtXslpx~iyDV{O$R*{{1O0R>WTQF zJL)5FhEQ(Zteu`9=B(YCwh5eTM$>3%(?=UxNk+b)@!JKnBCiziL$;B|MbU}IeE0%6 z;~WeS+td2<6x0~qm!dJUmDj~7hX=rutRK#jYLIm5NoBT7&wVpU^|$y(bkbVDo!4Wn z%$TtSKLPb6W~t$8s(bAZ#*JUW6tpl=a_HONS;d` zMC(_P1s{W$r9S$%_=U6mC*&t?l=D7`s4?$T@}&9Adlo^hWPDCy#lYr$Uc!Gb&o9XH zi}L&up58z3@nt-4{NgL>=O6Ji=6zM3Uz6w8nPALY-aqkevG>oC^bL7_6HjBg^8N)c zVqEgR&CqxF_-+{YJ%+x|#}D}UAs@ir97s_*yJQvHe zL!O=T?7~y^LASj3@O=p%VzTj;B8aB;;%5fajMvAU%lJrHV7%olNYjhAg2^lSNSRu^ zRfwEc_7rb5^Ur_oMig%i3XFMc@x(m74nJpF-c{=78ujx+^<&9T##_4>D6Hb6kB=pI zG`;><;=6PD%Y#@H6IB)yoNa30Jq64aB=_HeKlg_S3rd8}GTqdMJucOni5e z27<<|2*KgwA{-2&1?cT5sKNFNTe>G5_hjKpUyiip4KIwDesCzSEtev&B|TEW<~vdGzHa* zn##@dwBhGPGx=F$vswCCaIZ4CWIJze)j%~rmx0M#4K?1YAbaB;3*M^{k@ixEnr6Hd z5{+-4?=Gd6LXu;!9Eh+1q0=*MY~_}o^rJQ1IcIhXg}8W#)i>w8I6?XH%pUFiTP&(V$)p4&-j~ApVkY!x=6i1ns`nm7NTXWV1X{e zvTbA69cJz#?j)zPy9GO#3T=Nxt7!0Wwr;1#bHeHQjz>bfwLYz(t~5YT zDoNwsM^fz%sjBQ2D-GU}_j}TW5o~<2+eAUn9=HhkF{t^AVo*q5(vNX&v0c%|BG_A|>4rPPt>6axriqF1tv7AHam&`5H*LFhV)L!zH{X=sw&|9_ z)?2o2-cpD=)N6yw$5Aa-9ucE=s&;9EICGJ z7?oQO&>;^4io=ov5SRGk<0#mYg-Il@cZMKvaI0@L`a*7$2G0#df)w2ymrhh`jUyt3 zw)3`;LTr!=VOL8Iqu|EdaRoTc{WwvxqaXIXVaKNL;dX1=rjyQX7F5jo1V}VIwVghN zIJa?I{~bw+%n5=bh~lR!L5~Yt%Hy*e`mz^wD@xlQ>=gi+VBICEsy4EuG?tg%ux#GE z9?@Fhz!|^k#(0UxF2BJcvMCDf9_>ILo=i{x^p!ZK;6b-CWF35P|ByAhYv&OB^6V3) zpw6j_MfdHPqOdJu15($5`*wOvn76r6m)Zrl5uA?3emc0Cb0*B;Rt8KCCv>``^7?Q6 z`2xAGI>c05LB*-tvhg(^9M7o~rUrX*dk*AwjvgGnd(XZ-M;^-U+H?5ezR`zr2gde2 z1gCbXBC`qE?%6kbZ|>0U(OpsO=}nt9Z81p?9@=wccQWl3LO=A9+|J!&M-Gkd%k4Zc zHnw}`kuVdk0ZpW%?sOJ{Cy0ATj~qFiOV$DR`yO#KATg9bL4SY0_!W%ey6aMHqFJ(N z3dW?HubcZ=g>t;>2bV2c<}!94_o3QFhyw7M2#g2exCMV-m=|z$xSn+dvZ(>CKB2cl zhKIJWnT%l-QkxDBnZY5*7CAmJI(EQ1ba2b2t(*D>6{>WGSZ^KXSF=!3-@#;2LeXmw zM^(6mu1=`H%#Q6F!B}u$(cIzPhaT9ob9e6k`}eR*LJ(O-WHz1Nylu;kgQx)@aGRki zZ^7lnv@uaZ1ehk5yK(i;&ih6W8R(grz;8qI6kDi%c}%~NNmz5}p2ctA6xu7$EdcVF zL~Dld-iE}`;1FS&j)M$Gubjk@Y9-&z_2a6lur78?Hb?(#IiJxUpXEnya7q0U-lac7 zGWZ`SX)|F8Nk5JwkULmlC=rb-7t1q5L$qMO6&I4vkmgo*oMZTf&}Tx-t)CFK%jOV@ zGGuh5a;Frc?Euj<6|$2!?Iqv40G)XItzs%a6A@f@%Ftj0Qxyj##G{{1(ckfKqTge8Vyh|*7<@w@q=lrwbqXwvE*;1Zs5_2jI7a!I3m5Iv z_X~M(iQkTGkX4&D#m1hh0;~a|)I#ZRXJUnh*pM90f$mVbbqgVP$OlrV=?5(DdANGW zV)j@y>n+t4(EwE$!v^67Xeo)yo~?v5)S@tw7OXP_=Qj)ZUI8Rri85OEObC=&8Li!F z*^pvgZfR3N(2jT}@~b9B!2B!<@mhBSMK_zUaij2TXh%YP7R=$Jsw+uUAFBvr1^=EK zj_N}8B$~v~{Haz&oN?|(#HN`f_6h8S{WNK3!V~(kvijNTa~BXB-jd$2{H+XrkwPaI598omMy6h;$6PzVATO_lP!*!=5d65Y+#^Mk_oc?o{ z&(i-DA6e>`!4+fs8R4N@XMl&#T~->Ii2<^<^{AkACN)e6O{0yxS!$zNT1fUbiGkbB z@!?7w&gKvG0?ZbvajwBhuZJW}_j;z^kfZ$En6^K8s`;|=d|7$EtUSy85g3KxFl*Oa zu|B-4JX6Z)zst(=W#yTya9MeVwV+MszpOlSQGQu@7GZf=dA2Vr&%U~+?6UHFS$U?- z`?B(^*OBJu{}tsqz6m}!hfQ#O$6zpYey8iWJHr_`V99~yHb2+^zBcMpif6S;EIwGL zV)WU1U%O!NkaJ>#ec3DGmyuM?0B}8DbNZ(p37lw4GLyWv>O5H1+x-&3zbydD|ZP&CaY4oqr>; z(lVLOs&IOfyBN-0^97w?S6IF2BC(QFPv^!eeR4@v{Pv5iSe&xYUGWTF)vE4azqq=a zK@V>!N^=D}SoIQ#s?LM4mCApdbvAMB2d=!07)iYMmW*R(-&Wr(PI~c0j3pVn`DNoA zz9d+lC0j;0?XKXFWPS;GmRobvV0jK57o*|2&%~MhD4Tdl&cfCoM7u7Gt$C|6oHg(n zKOA+Zr);zCw$v5yJ?fi-;@j$M)cpTvq@j4?zMnL_pc~{gh(8WN{E>k0-i@Ew@+E9) z#(VE9Dc+yVmhgeu5`=6s9_CWb`7#PVFQg0l)+aAkZKLEDQT0Vq^7C^A@g5XZ1o*6g zxa1^HT-T~P(fo?_G#m0} zlgeb`#>_T8ADJr!BZ)CIR}kq=NUH(Q!6W|n!l9z%)*L`YSp5E62Q0BL3y|3a=d6P` zGgrYmhsBI{i8xMf*Er8yG&xtch&Zb#AZDG5E7*Ki7ymS6T9Fe0+=a=V7n@Cp zc>LnAP#k_ySmZAT3rHSn07b_>4!TfG@Jnwn+ZaTnQElrVk2; z3l~gt74_#>BmdL$MY;2@k-vKJg#7YcK}56m7v~Bhk_DBV4yQ7GE_k8c#t zs`+p1x-eE)vrfF392>gCBA@KEM?8u>?*v zsaxITLTHJ?QK?wea(x{e?({8`nz(ozHZB2(tLf7B%lW}_xqFV^>#N)2O?*X5EMi~B z$_QTqlVVTFeRR8dWCG5)Nxp@w2tgzT%O_1eBZ^F&MT9n<2Xl)Tk*{M-8^-S_r>!0PXzD{ zG@M#ASL^a~dFmU8`jmaJ%=Hi9EMk;r8sG4We^;zG$L}!jjJ`C6i^@CIcZ*13XBgi& z2)f~0t-nji)^+OFFuluMuFb}?h{xNn&_U|DtY)yVfbSC`&3gm*E4V66k6JCHi1!q7 zgjPbKhSx&WnD=Hrc{@Hh>p=YgKYh>#OJ$88Pd><#A-wK>sfiio_k+f~w@A^SmnYZ3 z_zo$;)7~%OiHo=1CO?=yc(tEyt#hks1ef7NnjeouW-iU~L-xfF*%zNGYX%EEWp8~u zVDbL-GCnWMiw_O)7RlEX2}kGX#i^W}eWEG1Q>e16VOlDf7WmTwe!3~-cgCZ_-n*q1 z)h!G8)x{`HNAf08L(|0FXd|1rk&E*oc0E zV)Ri|1C2?Fdw+$OVCjCLmlX%l;oJFo!D)G)7OZ9{wdAnmunzLOpsLnHRo>@RdsZEs z!foKZ=$V}oRssV%**+qLv|kee9~k}^N_!s{5O^aN8Wp?|vIhS|OL_=j+q3z#1zZHx z3_9csl=#%f5=}~ewGVgK-=nWoxF1Jocd0KHf)HZ(ld>i`|}?$Xysu!R01 z$P6DZq_83nKIQ!oTHX^aKUi6PTs-S zSQV`ySJ8pFaLXaMBAGx8sSvQ0!J1@R85d+iSTW`5WQu^x#nRU$)A^OisLE7fg;6w* X;0ufiTp^`+NJTJePcq0h$Fu(z-_mOo literal 0 HcmV?d00001 diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree new file mode 100644 index 0000000000000000000000000000000000000000..17fc10d66afd348185d5bd5577e8734a1b0f4000 GIT binary patch literal 4158 zcmds4QI8w95q5l*bkg1FPIjCoNQ`b9IF?)A$#xPnxR=84Q+u$A7DbB!HP+NFB@&{R z8X3>IZLsc~8fkGDKr``b&}Wsrxs z>m&9a+hO;{?Ebiz5cWMpm%Rmiy^ZG%p6}!N!E;xzyKDsY2c?-kp#{?m`@Rw(-(y%GeEhzy}!6cAUn_(H+8^N93(Iy21@$WIN z=je94et~$MeOFLz8^`urZ7V>6O!Ll_ZG*edVhGxjrfFJ!8VlRQDT2KLQYM*kI2rr!yPpEeu>Xu!#jOWIyz`e7}w zyH7!IsA^rNWY7?--GBP(&~HcBBl435BKHF#cRlgSB1;>HDC-N5=~RsR^1D|-A3m7v z;M9r-dKr%E5P#vuwmT68HQ;LI{Bn08&uM5sUpQ*_d6tMGrM|;>{u#2rvwyIEQmBz- zN^@-b`G4^T9z*N!j4-x0Wx`TqYhPDk7zq6uXRBDrzFTQ~4ym+XrbN;tFYkS)0Tqzf z+Iwxc-mqePHnguBMKUeI3F2JI8M;QQ8!q_wLHw|OVRE3CwS=zrLz?NPi)wV&Wd12g`jR3qEMH3=MDv!bxvkQoH zkz=t}I*j3Ej%BY}7D`}sfP}}sCHl8;-12C-boS;H7|x`jjhAPy*#l43fLpwrO0{s1 z^fd}0kENb1_ygS!ZagiGZ5x$1#T^k2o&u;Kouy-K z+b4yQ@mgfBb71QrEf#sa!XKg<1RV6NG9tXe!ypOh_qkt-a!rd=#u%lbb%cf_HI17) z14I%NpL5Mid>+Or*JL96MXFPF>bgLU?c*{Ul~9&BAXBNuHF4TE{4Y4cz~*@piSgD_ zZHJ{^r9 z)+hO;VKO_BYBqBAw$}^?fM#qc#(I>SpCD;|eD~o8h-Y6-lP&XJvNr!-Z61|MJYMHi zop5TV!3U~;#LPm#S=W#WN+?BdINP;%0LVqWs?F5};&O<+vPb$7-wex`@fj0%!mKGh z?)UWqgH`--fuhz3)UB{Cm$8ruDSMK=lQ2wh2@+ox8=@RSh~4udM^EveSfR;OB!G?t z3D2g$K+Os_Jx}OjvZcot9=t-5vK0LkJa@nh+EqWKtC*IYc4c>HcJ45++TD^%P`rR5hN$qB6qln=nD_@c6rg25u7C|%vFC1k zb3sj8p)LvwMjY0_jFT(Lg#+EBTj*)aUM3s0DlxpsMgO=I8y= i;fh8!#Ct1oNZ?*I=m0P?|3%kJJ=0aB;Cpv5Ir$&lvQN4I literal 0 HcmV?d00001 diff --git a/.doctrees/movement.doctree b/.doctrees/movement.doctree new file mode 100644 index 0000000000000000000000000000000000000000..7f3127f3e9c2866cd1d99a1a5b2496ce52c4ba6d GIT binary patch literal 3062 zcma)8OK%%D5KiJqmSjt|^Fo2diGmH|(l0?Xa zYVSIUjBQ4R@gMz@pZz=k*mV^-)zYe%dUpvLG2>~XsPM178w7R3Q$4EAZ)+MGE=6;k zwOE^NzxIz=*R>2cDP7xgofq5(sxy5)v{r}oGD-&TqhaEN+bMm=G7 z12*g)0Acrm_XGSM;`a!@CrFlk#*Ww_dx{9R>SPh=PT2{oQtsCR*ZZ-{N`mH+kfhn(Zc(8`d_ee-DQ?O(>V#W=;VrOs!s6Pn#sVFbJt0Um|HT3teu}3 z22QvE<8zkcXCk8Jp)mvGlM3=qow1$Lrbe#+HXwXND}+g1v}$9x+E}Y%udZHY8sM#& z?9}b(SJu{L8-}*ls({A*=l*G!$ey|zMiHS?5{5yPD>(;3B@SdsI&+c&rXo<7(n|6%9QdrSyaX zzALWBNZKr0?tm^iP&33>T`RR*E1^?6hr7WkQ39wzLs61J(gpl64N3W5+<*&U6j2e& z1X|v8t(hHtd89eM?_AuBs8UizjEE$q3W$eLW8>XkiS(M4R$;}v!;PH{6YO_4D2=WH zsE^*cxUq54?S}-=Xqo|^w4h_ZrXJu?WQ4H+ zt$n)8rKZvP$)ZJK6P<9)%l_Pp60XTKrAVZTa=YdQIJS#qG?-A33`YBvS~TNnd9U3H zUvPrqR1lGhU@bwtcW|qtPURB)c@W5jwh?o5VahXZ{EPiZZjjSF0w@%ej0?bagJen& zdtiq9gc+0TXX7!%dQ=X&kyP`scQ=D(5dbtJLvcfZZed!|{OIB5UjWa6n#CLDgJfm? z)7m_kN5Dl3{4L6$vqH@xGd~=hpStOIO(H#~ck1f`R=~5*S+Rl|ipdN?vqy6Tlt!f7s9Og$XZI}+;?Zh%o0W)&I1+x8hCI1K%KKLKN1-u5q qD!fQFs$V*6#>fTnP9rV~xWh%9+9Wj0Jk+k2gh^Kog>ZM<>F6)JwX!h) literal 0 HcmV?d00001 diff --git a/.doctrees/usage.doctree b/.doctrees/usage.doctree new file mode 100644 index 0000000000000000000000000000000000000000..4b4b1b8c595e76e4be01550ada83ceb834bd1ff1 GIT binary patch literal 11966 zcmeHNTXP)66*jgdSu0t-0IpQPq>+ng6;>yIs?^gV5$lCePTRmHIpo**DqzU$QT=ww#R3r%9N`7SH4fNLY^R z*)b2Y&oVhf;==WkZr*<);g)d2pzQ99Ipfa6XIa~slw-mb9*QzQTA0S5xEM%Y)XcCS0@WLEWZi$lCJsE(}x2 zs6CqT(J=N9_1_;AYdH=T03YzJV3#3}slhkhAalm$1g^wh1VDc(r|_HaMxJZABKun1 zdTPc&wy*ji&_gaVdEr3(VBx^^xXKIpI)7s@=-+tb>h)_kZY|w>b8z*|{;fC6n@hK? z8@F#1EA7mG&N=+1-Z>?A6(W{DMtp7+-5I~u;1eqLWa7ud9) z98q)R_#ljZ6Zkpp2;Tz?cYSX;iA-8f&O|X!c)Y_EApV+1YpOBNvw3P6eJ`}OYcu}C z>*r3KXbs}fXMK+wri~d2H*td@bNwic1*XAdnp%TC>*W8H?gV(yy*DA z4La<>;}1J*_0C#{4PySJ=$K39-CTGw+7nI~6kV+lb-NIbqie0=w{U&lYF%M>_<%-w z@7_8vM>ReW32Os_D70AGSP%*Z?`&hKumMHPEw_}xkxV&`@xcJOin_Ho-!eAt8*8f% zR^QvWx3Tq!acAS)oN z*yAwv>|$|gj9~KtGYmIyg<-T4?hQJGqLtFyT@2Hn?;!Jiso>-%9~uTY0hquFdnwn_$;6L`ZlH!&Dk1?aJYKP&)IKPTd`z z2=v}Ofin{>+M^PAiNxJQ3TIm-0{z!1f|#s)+KBsSqY4W(d~~QC6Ge?eI%m$cl$%sK zR`NO_u@GZ|re~zd%1zX&rKMW#)twTR)t|R(ojNoT!#0JvqNVd0qV5n5)R;vau#4Tn zrnbXKyf(}grbAIBs1_`P>kf1STUlX;Rm-Yc(3qvVB(*G_pu%}nqw~m=N=cNOjT{G< zh#ecWU!ytMF?>gMHslY4nI7xfH7)tHNjLYNX?9h_pJBP}Cb`9p;cEk-tl-~IvoYpA zwkAz8$-?5JXH_BN=tlFNQ*B)jid{dLBMfiYko7&0PE9{X%wPPmONAdtG zmn#ImQR)sUamD$UQo^_2q!$S^A${q)WBOTr!>ezh%r4t zZc(`=j8yur)=iz3>ABF?-Im!F7S>V&4cjdduuRx2S7tk?x)_Jwmc%PSyZ1A;zaVa=c9d;#kG&Hl9K^7KhRVld{7W3 zj);+{wq`|tcSUF@eeJ6qHrscHvsIZRVU>L_u{Ew4-$0z2av7*m{1KFSb7j(F)+%Ytfl=y+3YDl* zwKA(rsBf6+(c8qk zIvVx%Y~c?7r-62MK7ZIher!H|Y(9Q$E}qNF1UvY|ik;!{V>8va{B!)+eEireGi}F@ADdONJbrBE$B)g4as1eP{MdZ_*i3Kx{+}P4%X9939evJSaHKjv zP712i3I6WtZ#snL6jyr zmETnis=Lo6#PRuOevnR7rGhZ*f)4r)sn( zu&y*D6Mpb@&ez*p*&_I(xea?lVdjTr$Y=kL)0XA4H9@S=c8p3?zcEiic-W4 z;3Gr5T89+)Ch7&?LgM20%gvjHdUc#11jX<;nQDQma!z}?re#cN$>imcJ0mKb|H>Jy zv@)RR`f~HeNKbj5CIFx%4*cUOdd%6P8o=E)O2SEyF6Hwe$c3?O*gOJEFpLX~^yE0U z-Z<$dceply3YN((@w{ft6bBeplRW7HTW4+XBXE42;}2d{4S0pgc$;X|oaUDbS$GOW^YYB^O{541q$=#i4%o;rTf^6Y;2G z`_W{ksikkicFGL-3rC13SzcU3a{{^|aeBI8JY3A=izKNGfTSU~kMIb^UgFWhYfCra z&zX2&ji{%VO8u`3^>l1Yc-`i4*X3fM#z6Kj5<3cmO$xJ*6tabr-8~~O1CYK^<|gs< z6kXBK1gd>`KG_2kbJr*r2Jo!BkZ?bp_^5)$lN3o!Ysd5IT3;HVQkl7HFPAUzb+WyLl1V2YN!w4FFH$}_r_a4Lf5 z-9WQP4b50oz_|dU04)KMGGK#O7i!VG*k~nEgKCDhL3u&^Nn#6Qjh&!I{k!e_;C%0V z=X{&WNou7d8?_ubKkPf-?WfMG#J&9x1^}_-I3ptJ*hXwK= z!VQOF0hw6K+rNRQzREU{3pg`IR>7x4ch&=zWu(zORW_>tPPu{Qr8WU(NW| literal 0 HcmV?d00001 diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/_downloads/e6ffb4613247059f19b76a508c48412c/nanonav.py b/_downloads/e6ffb4613247059f19b76a508c48412c/nanonav.py new file mode 100644 index 0000000..94914cd --- /dev/null +++ b/_downloads/e6ffb4613247059f19b76a508c48412c/nanonav.py @@ -0,0 +1,108 @@ + +from ble_advertising import advertising_payload +import bluetooth +from machine import Pin, PWM, ADC, freq +import machine +from micropython import const +import rp2 + +import time + +# Define BLE constants (these are not packaged in bluetooth for space efficiency) +_IO_CAPABILITY_DISPLAY_ONLY = const(0) +_FLAG_READ = const(0x0002) +_FLAG_WRITE = const(0x0008) +_IRQ_CENTRAL_CONNECT = const(1) +_IRQ_CENTRAL_DISCONNECT = const(2) +_IRQ_GATTS_WRITE = const(3) + +class BLE: + """ + A helpful wraper around the BLE service functions needed for the Wumpus World project + """ + def __init__(self, ble=bluetooth.BLE(), name="NANO RP2040"): + # Setup bluetooth low energy communication service + _SERVICE_UUID = bluetooth.UUID(0x1523) # unique service id for the communication + _NanoBot_CHAR_UUID = (bluetooth.UUID(0x1525), _FLAG_WRITE | _FLAG_READ) # characteristic + _NanoBot_SERVICE = (_SERVICE_UUID, (_NanoBot_CHAR_UUID,),) # service to provide the characteristic + + self._ble = ble + self._ble.active(True) + self._ble.config( + bond=True, + mitm=True, + le_secure=True, + io=_IO_CAPABILITY_DISPLAY_ONLY + ) + self._ble.irq(self._irq) + ((self._handle,),) = self._ble.gatts_register_services((_NanoBot_SERVICE,)) + self._connections = set() + self._payload = advertising_payload(name=name, services=[_SERVICE_UUID]) + self._advertise() + self.value = b'a' + + def _advertise(self, interval_us=500000): + self._ble.gap_advertise(interval_us, adv_data=self._payload) + + def _irq(self, event, data): + # handle bluetooth event + if event == _IRQ_CENTRAL_CONNECT: + # handle succesfull connection + conn_handle, addr_type, addr = data + self._connections.add(conn_handle) + + elif event == _IRQ_CENTRAL_DISCONNECT: + # handle disconnect + conn_handle, _, _ = data + self._connections.remove(conn_handle) + self._advertise() + + elif event == _IRQ_GATTS_WRITE: + conn_handle, value_handle = data + if conn_handle in self._connections: + # Value has been written to the characteristic + self.value = self._ble.gatts_read(value_handle) + + + def send(self, value): + """ + Send value to the bluetooth characteristic. + + :param value: The value to send. + :type value: bytes, int, str + :raise ValueError: If the value is not bytes, int, or str. + + """ + if not isinstance(value, bytes): + if isinstance(value, int): + value = value.to_bytes(1, "big") + elif isinstance(value, str): + value = value.encode('utf-8') + else: + raise ValueError("send value should be type bytes, int, or string") + self.value = value + self._ble.gatts_write(self._handle, value) + + def read(self, as_type="bytes"): + """ + Return the current value of the bluetooth characteristic, or None if an error occurred. + + :param as_type: The type to return the value as. Must be one of 'bytes', 'str', or 'int'. + :type as_type: str + :return: The value of the characteristic. + :rtype: bytes, str, int, None + :raise ValueError: If as_type is not 'bytes', 'str', or 'int'. + """ + value = self.value # try using the last value written to characteristic + try: + if as_type == "bytes": + return value + elif as_type == "str": + return value.decode("utf-8") + elif as_type == "int": + print(f'read {value}') + return int.from_bytes(value, "big") + except Exception as e: + return None + + raise ValueError("as_type must be one of 'bytes', 'str', or 'int'") \ No newline at end of file diff --git a/_sources/bluetooth.rst.txt b/_sources/bluetooth.rst.txt new file mode 100644 index 0000000..2e53b67 --- /dev/null +++ b/_sources/bluetooth.rst.txt @@ -0,0 +1,30 @@ +Bluetooth +========= +Using Bluetooth Low Energy (BLE) to communicate with the NanoNav. + +Quick Example +------------- + +.. code-block:: python + + from nanonav import BLE + + # Create a Bluetooth object + ble = BLE(name="NanoNav") + + ble.send(43) + response = ble.read() + +Usage +----- +.. autoclass:: nanonav.BLE + :members: + .. automethod:: __init__ + + +Connecting from Mobile +---------------------- + +Various mobile apps are available for communicating with Bluetooth Low Energy. We recommend LightBlue which is available for both iOS and Android. +TODO: Add screenshots and instructions for connecting to the NanoNav using LightBlue. + diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..0393474 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,19 @@ +.. NanoNav documentation master file, created by + sphinx-quickstart on Mon Apr 15 12:52:38 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to NanoNav's documentation. +=================================== + +Check out the :doc:`usage` section to get started. + +Contents +-------- + +.. toctree:: + + usage + bluetooth + movement + diff --git a/_sources/movement.rst.txt b/_sources/movement.rst.txt new file mode 100644 index 0000000..6d873b9 --- /dev/null +++ b/_sources/movement.rst.txt @@ -0,0 +1,12 @@ +Movement +========= +Working with NanoNav's motors. + +Quick Example +------------- + +.. code-block:: python + + from nanonav import ... + + # TODO \ No newline at end of file diff --git a/_sources/usage.rst.txt b/_sources/usage.rst.txt new file mode 100644 index 0000000..f371617 --- /dev/null +++ b/_sources/usage.rst.txt @@ -0,0 +1,22 @@ +Quick Start +=========== + +Installation +------------ + +To use the NanoNav supplementary code, either download :download:`nanonav.py ` to your project directory + +Or copy the code below into a file called nanonav.py + +.. raw:: html + +
+ +.. literalinclude:: /../../nanonav.py + :language: python + :linenos: + +.. raw:: html + +
+ diff --git a/_static/alabaster.css b/_static/alabaster.css new file mode 100644 index 0000000..e3174bf --- /dev/null +++ b/_static/alabaster.css @@ -0,0 +1,708 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: Georgia, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar { + max-height: 100%; + overflow-y: auto; +} + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: Georgia, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: Georgia, serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox input[type="text"] { + width: 160px; +} + +div.sphinxsidebar .search > div { + display: table-cell; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: Georgia, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: Georgia, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin-left: 0; + margin-right: 0; + margin-top: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: 50px -30px -20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Hide ugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 0000000..e5179b7 --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,925 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: inherit; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a:visited { + color: #551A8B; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +nav.contents, +aside.topic, +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +nav.contents, +aside.topic, +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +nav.contents::after, +aside.topic::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/_static/check-solid.svg b/_static/check-solid.svg new file mode 100644 index 0000000..92fad4b --- /dev/null +++ b/_static/check-solid.svg @@ -0,0 +1,4 @@ + + + + diff --git a/_static/clipboard.min.js b/_static/clipboard.min.js new file mode 100644 index 0000000..54b3c46 --- /dev/null +++ b/_static/clipboard.min.js @@ -0,0 +1,7 @@ +/*! + * clipboard.js v2.0.8 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1 + + + + diff --git a/_static/copybutton.css b/_static/copybutton.css new file mode 100644 index 0000000..f1916ec --- /dev/null +++ b/_static/copybutton.css @@ -0,0 +1,94 @@ +/* Copy buttons */ +button.copybtn { + position: absolute; + display: flex; + top: .3em; + right: .3em; + width: 1.7em; + height: 1.7em; + opacity: 0; + transition: opacity 0.3s, border .3s, background-color .3s; + user-select: none; + padding: 0; + border: none; + outline: none; + border-radius: 0.4em; + /* The colors that GitHub uses */ + border: #1b1f2426 1px solid; + background-color: #f6f8fa; + color: #57606a; +} + +button.copybtn.success { + border-color: #22863a; + color: #22863a; +} + +button.copybtn svg { + stroke: currentColor; + width: 1.5em; + height: 1.5em; + padding: 0.1em; +} + +div.highlight { + position: relative; +} + +/* Show the copybutton */ +.highlight:hover button.copybtn, button.copybtn.success { + opacity: 1; +} + +.highlight button.copybtn:hover { + background-color: rgb(235, 235, 235); +} + +.highlight button.copybtn:active { + background-color: rgb(187, 187, 187); +} + +/** + * A minimal CSS-only tooltip copied from: + * https://codepen.io/mildrenben/pen/rVBrpK + * + * To use, write HTML like the following: + * + *

Short

+ */ + .o-tooltip--left { + position: relative; + } + + .o-tooltip--left:after { + opacity: 0; + visibility: hidden; + position: absolute; + content: attr(data-tooltip); + padding: .2em; + font-size: .8em; + left: -.2em; + background: grey; + color: white; + white-space: nowrap; + z-index: 2; + border-radius: 2px; + transform: translateX(-102%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); +} + +.o-tooltip--left:hover:after { + display: block; + opacity: 1; + visibility: visible; + transform: translateX(-100%) translateY(0); + transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1); + transition-delay: .5s; +} + +/* By default the copy button shouldn't show up when printing a page */ +@media print { + button.copybtn { + display: none; + } +} diff --git a/_static/copybutton.js b/_static/copybutton.js new file mode 100644 index 0000000..2ea7ff3 --- /dev/null +++ b/_static/copybutton.js @@ -0,0 +1,248 @@ +// Localization support +const messages = { + 'en': { + 'copy': 'Copy', + 'copy_to_clipboard': 'Copy to clipboard', + 'copy_success': 'Copied!', + 'copy_failure': 'Failed to copy', + }, + 'es' : { + 'copy': 'Copiar', + 'copy_to_clipboard': 'Copiar al portapapeles', + 'copy_success': '¡Copiado!', + 'copy_failure': 'Error al copiar', + }, + 'de' : { + 'copy': 'Kopieren', + 'copy_to_clipboard': 'In die Zwischenablage kopieren', + 'copy_success': 'Kopiert!', + 'copy_failure': 'Fehler beim Kopieren', + }, + 'fr' : { + 'copy': 'Copier', + 'copy_to_clipboard': 'Copier dans le presse-papier', + 'copy_success': 'Copié !', + 'copy_failure': 'Échec de la copie', + }, + 'ru': { + 'copy': 'Скопировать', + 'copy_to_clipboard': 'Скопировать в буфер', + 'copy_success': 'Скопировано!', + 'copy_failure': 'Не удалось скопировать', + }, + 'zh-CN': { + 'copy': '复制', + 'copy_to_clipboard': '复制到剪贴板', + 'copy_success': '复制成功!', + 'copy_failure': '复制失败', + }, + 'it' : { + 'copy': 'Copiare', + 'copy_to_clipboard': 'Copiato negli appunti', + 'copy_success': 'Copiato!', + 'copy_failure': 'Errore durante la copia', + } +} + +let locale = 'en' +if( document.documentElement.lang !== undefined + && messages[document.documentElement.lang] !== undefined ) { + locale = document.documentElement.lang +} + +let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT; +if (doc_url_root == '#') { + doc_url_root = ''; +} + +/** + * SVG files for our copy buttons + */ +let iconCheck = ` + ${messages[locale]['copy_success']} + + +` + +// If the user specified their own SVG use that, otherwise use the default +let iconCopy = ``; +if (!iconCopy) { + iconCopy = ` + ${messages[locale]['copy_to_clipboard']} + + + +` +} + +/** + * Set up copy/paste for code blocks + */ + +const runWhenDOMLoaded = cb => { + if (document.readyState != 'loading') { + cb() + } else if (document.addEventListener) { + document.addEventListener('DOMContentLoaded', cb) + } else { + document.attachEvent('onreadystatechange', function() { + if (document.readyState == 'complete') cb() + }) + } +} + +const codeCellId = index => `codecell${index}` + +// Clears selected text since ClipboardJS will select the text when copying +const clearSelection = () => { + if (window.getSelection) { + window.getSelection().removeAllRanges() + } else if (document.selection) { + document.selection.empty() + } +} + +// Changes tooltip text for a moment, then changes it back +// We want the timeout of our `success` class to be a bit shorter than the +// tooltip and icon change, so that we can hide the icon before changing back. +var timeoutIcon = 2000; +var timeoutSuccessClass = 1500; + +const temporarilyChangeTooltip = (el, oldText, newText) => { + el.setAttribute('data-tooltip', newText) + el.classList.add('success') + // Remove success a little bit sooner than we change the tooltip + // So that we can use CSS to hide the copybutton first + setTimeout(() => el.classList.remove('success'), timeoutSuccessClass) + setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon) +} + +// Changes the copy button icon for two seconds, then changes it back +const temporarilyChangeIcon = (el) => { + el.innerHTML = iconCheck; + setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon) +} + +const addCopyButtonToCodeCells = () => { + // If ClipboardJS hasn't loaded, wait a bit and try again. This + // happens because we load ClipboardJS asynchronously. + if (window.ClipboardJS === undefined) { + setTimeout(addCopyButtonToCodeCells, 250) + return + } + + // Add copybuttons to all of our code cells + const COPYBUTTON_SELECTOR = 'div.highlight pre'; + const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR) + codeCells.forEach((codeCell, index) => { + const id = codeCellId(index) + codeCell.setAttribute('id', id) + + const clipboardButton = id => + `` + codeCell.insertAdjacentHTML('afterend', clipboardButton(id)) + }) + +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} + + +var copyTargetText = (trigger) => { + var target = document.querySelector(trigger.attributes['data-clipboard-target'].value); + + // get filtered text + let exclude = '.linenos'; + + let text = filterText(target, exclude); + return formatCopyText(text, '', false, true, true, true, '', '') +} + + // Initialize with a callback so we can modify the text before copy + const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText}) + + // Update UI with error/success messages + clipboard.on('success', event => { + clearSelection() + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success']) + temporarilyChangeIcon(event.trigger) + }) + + clipboard.on('error', event => { + temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure']) + }) +} + +runWhenDOMLoaded(addCopyButtonToCodeCells) \ No newline at end of file diff --git a/_static/copybutton_funcs.js b/_static/copybutton_funcs.js new file mode 100644 index 0000000..dbe1aaa --- /dev/null +++ b/_static/copybutton_funcs.js @@ -0,0 +1,73 @@ +function escapeRegExp(string) { + return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string +} + +/** + * Removes excluded text from a Node. + * + * @param {Node} target Node to filter. + * @param {string} exclude CSS selector of nodes to exclude. + * @returns {DOMString} Text from `target` with text removed. + */ +export function filterText(target, exclude) { + const clone = target.cloneNode(true); // clone as to not modify the live DOM + if (exclude) { + // remove excluded nodes + clone.querySelectorAll(exclude).forEach(node => node.remove()); + } + return clone.innerText; +} + +// Callback when a copy button is clicked. Will be passed the node that was clicked +// should then grab the text and replace pieces of text that shouldn't be used in output +export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") { + var regexp; + var match; + + // Do we check for line continuation characters and "HERE-documents"? + var useLineCont = !!lineContinuationChar + var useHereDoc = !!hereDocDelim + + // create regexp to capture prompt and remaining line + if (isRegexp) { + regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)') + } else { + regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)') + } + + const outputLines = []; + var promptFound = false; + var gotLineCont = false; + var gotHereDoc = false; + const lineGotPrompt = []; + for (const line of textContent.split('\n')) { + match = line.match(regexp) + if (match || gotLineCont || gotHereDoc) { + promptFound = regexp.test(line) + lineGotPrompt.push(promptFound) + if (removePrompts && promptFound) { + outputLines.push(match[2]) + } else { + outputLines.push(line) + } + gotLineCont = line.endsWith(lineContinuationChar) & useLineCont + if (line.includes(hereDocDelim) & useHereDoc) + gotHereDoc = !gotHereDoc + } else if (!onlyCopyPromptLines) { + outputLines.push(line) + } else if (copyEmptyLines && line.trim() === '') { + outputLines.push(line) + } + } + + // If no lines with the prompt were found then just use original lines + if (lineGotPrompt.some(v => v === true)) { + textContent = outputLines.join('\n'); + } + + // Remove a trailing newline to avoid auto-running when pasting + if (textContent.endsWith("\n")) { + textContent = textContent.slice(0, -1) + } + return textContent +} diff --git a/_static/custom.css b/_static/custom.css new file mode 100644 index 0000000..2a924f1 --- /dev/null +++ b/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 0000000..4d67807 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,156 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Base JavaScript utilities for all Sphinx HTML documentation. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", +]); + +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); + } +}; + +/** + * Small JavaScript module for the documentation. + */ +const Documentation = { + init: () => { + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } + }, + + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; + }, + + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); + }, + + /** + * Initialise the domain index toggle buttons + */ + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); + }, + + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.altKey || event.ctrlKey || event.metaKey) return; + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } + }); + }, +}; + +// quick alias for translations +const _ = Documentation.gettext; + +_ready(Documentation.init); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/_static/language_data.js b/_static/language_data.js new file mode 100644 index 0000000..367b8ed --- /dev/null +++ b/_static/language_data.js @@ -0,0 +1,199 @@ +/* + * language_data.js + * ~~~~~~~~~~~~~~~~ + * + * This script contains the language-specific data used by searchtools.js, + * namely the list of stopwords, stemmer, scorer and splitter. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"]; + + +/* Non-minified version is copied as a separate JS file, if available */ + +/** + * Porter Stemmer + */ +var Stemmer = function() { + + var step2list = { + ational: 'ate', + tional: 'tion', + enci: 'ence', + anci: 'ance', + izer: 'ize', + bli: 'ble', + alli: 'al', + entli: 'ent', + eli: 'e', + ousli: 'ous', + ization: 'ize', + ation: 'ate', + ator: 'ate', + alism: 'al', + iveness: 'ive', + fulness: 'ful', + ousness: 'ous', + aliti: 'al', + iviti: 'ive', + biliti: 'ble', + logi: 'log' + }; + + var step3list = { + icate: 'ic', + ative: '', + alize: 'al', + iciti: 'ic', + ical: 'ic', + ful: '', + ness: '' + }; + + var c = "[^aeiou]"; // consonant + var v = "[aeiouy]"; // vowel + var C = c + "[^aeiouy]*"; // consonant sequence + var V = v + "[aeiou]*"; // vowel sequence + + var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 + var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 + var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 + var s_v = "^(" + C + ")?" + v; // vowel in stem + + this.stemWord = function (w) { + var stem; + var suffix; + var firstch; + var origword = w; + + if (w.length < 3) + return w; + + var re; + var re2; + var re3; + var re4; + + firstch = w.substr(0,1); + if (firstch == "y") + w = firstch.toUpperCase() + w.substr(1); + + // Step 1a + re = /^(.+?)(ss|i)es$/; + re2 = /^(.+?)([^s])s$/; + + if (re.test(w)) + w = w.replace(re,"$1$2"); + else if (re2.test(w)) + w = w.replace(re2,"$1$2"); + + // Step 1b + re = /^(.+?)eed$/; + re2 = /^(.+?)(ed|ing)$/; + if (re.test(w)) { + var fp = re.exec(w); + re = new RegExp(mgr0); + if (re.test(fp[1])) { + re = /.$/; + w = w.replace(re,""); + } + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = new RegExp(s_v); + if (re2.test(stem)) { + w = stem; + re2 = /(at|bl|iz)$/; + re3 = new RegExp("([^aeiouylsz])\\1$"); + re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re2.test(w)) + w = w + "e"; + else if (re3.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + else if (re4.test(w)) + w = w + "e"; + } + } + + // Step 1c + re = /^(.+?)y$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(s_v); + if (re.test(stem)) + w = stem + "i"; + } + + // Step 2 + re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step2list[suffix]; + } + + // Step 3 + re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = new RegExp(mgr0); + if (re.test(stem)) + w = stem + step3list[suffix]; + } + + // Step 4 + re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + re2 = /^(.+?)(s|t)(ion)$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + if (re.test(stem)) + w = stem; + } + else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = new RegExp(mgr1); + if (re2.test(stem)) + w = stem; + } + + // Step 5 + re = /^(.+?)e$/; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = new RegExp(mgr1); + re2 = new RegExp(meq1); + re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) + w = stem; + } + re = /ll$/; + re2 = new RegExp(mgr1); + if (re.test(w) && re2.test(w)) { + re = /.$/; + w = w.replace(re,""); + } + + // and turn initial Y back to y + if (firstch == "y") + w = firstch.toLowerCase() + w.substr(1); + return w; + } +} + diff --git a/_static/minus.png b/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/_static/plus.png b/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/_static/pygments.css b/_static/pygments.css new file mode 100644 index 0000000..04a4174 --- /dev/null +++ b/_static/pygments.css @@ -0,0 +1,84 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } +.highlight .hll { background-color: #ffffcc } +.highlight { background: #f8f8f8; } +.highlight .c { color: #8f5902; font-style: italic } /* Comment */ +.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */ +.highlight .g { color: #000000 } /* Generic */ +.highlight .k { color: #004461; font-weight: bold } /* Keyword */ +.highlight .l { color: #000000 } /* Literal */ +.highlight .n { color: #000000 } /* Name */ +.highlight .o { color: #582800 } /* Operator */ +.highlight .x { color: #000000 } /* Other */ +.highlight .p { color: #000000; font-weight: bold } /* Punctuation */ +.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #8f5902 } /* Comment.Preproc */ +.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #a40000 } /* Generic.Deleted */ +.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #000000 } /* Generic.EmphStrong */ +.highlight .gr { color: #ef2929 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #888888 } /* Generic.Output */ +.highlight .gp { color: #745334 } /* Generic.Prompt */ +.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */ +.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */ +.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */ +.highlight .ld { color: #000000 } /* Literal.Date */ +.highlight .m { color: #990000 } /* Literal.Number */ +.highlight .s { color: #4e9a06 } /* Literal.String */ +.highlight .na { color: #c4a000 } /* Name.Attribute */ +.highlight .nb { color: #004461 } /* Name.Builtin */ +.highlight .nc { color: #000000 } /* Name.Class */ +.highlight .no { color: #000000 } /* Name.Constant */ +.highlight .nd { color: #888888 } /* Name.Decorator */ +.highlight .ni { color: #ce5c00 } /* Name.Entity */ +.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #000000 } /* Name.Function */ +.highlight .nl { color: #f57900 } /* Name.Label */ +.highlight .nn { color: #000000 } /* Name.Namespace */ +.highlight .nx { color: #000000 } /* Name.Other */ +.highlight .py { color: #000000 } /* Name.Property */ +.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #000000 } /* Name.Variable */ +.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */ +.highlight .pm { color: #000000; font-weight: bold } /* Punctuation.Marker */ +.highlight .w { color: #f8f8f8 } /* Text.Whitespace */ +.highlight .mb { color: #990000 } /* Literal.Number.Bin */ +.highlight .mf { color: #990000 } /* Literal.Number.Float */ +.highlight .mh { color: #990000 } /* Literal.Number.Hex */ +.highlight .mi { color: #990000 } /* Literal.Number.Integer */ +.highlight .mo { color: #990000 } /* Literal.Number.Oct */ +.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */ +.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */ +.highlight .sc { color: #4e9a06 } /* Literal.String.Char */ +.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */ +.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */ +.highlight .se { color: #4e9a06 } /* Literal.String.Escape */ +.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */ +.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */ +.highlight .sx { color: #4e9a06 } /* Literal.String.Other */ +.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */ +.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */ +.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */ +.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #000000 } /* Name.Function.Magic */ +.highlight .vc { color: #000000 } /* Name.Variable.Class */ +.highlight .vg { color: #000000 } /* Name.Variable.Global */ +.highlight .vi { color: #000000 } /* Name.Variable.Instance */ +.highlight .vm { color: #000000 } /* Name.Variable.Magic */ +.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_static/searchtools.js b/_static/searchtools.js new file mode 100644 index 0000000..92da3f8 --- /dev/null +++ b/_static/searchtools.js @@ -0,0 +1,619 @@ +/* + * searchtools.js + * ~~~~~~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for the full-text search. + * + * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ +"use strict"; + +/** + * Simple result scoring code. + */ +if (typeof Scorer === "undefined") { + var Scorer = { + // Implement the following function to further tweak the score for each result + // The function takes a result array [docname, title, anchor, descr, score, filename] + // and returns the new score. + /* + score: result => { + const [docname, title, anchor, descr, score, filename] = result + return score + }, + */ + + // query matches the full name of an object + objNameMatch: 11, + // or matches in the last dotted part of the object name + objPartialMatch: 6, + // Additive scores depending on the priority of the object + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, + // Used when the priority is not in the mapping. + objPrioDefault: 0, + + // query found in title + title: 15, + partialTitle: 7, + // query found in terms + term: 5, + partialTerm: 2, + }; +} + +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, searchTerms, highlightTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + const contentRoot = document.documentElement.dataset.content_root; + + const [docName, title, anchor, descr, score, _filename] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = contentRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = contentRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + anchor; + linkEl.dataset.score = score; + linkEl.innerHTML = title; + if (descr) { + listItem.appendChild(document.createElement("span")).innerHTML = + " (" + descr + ")"; + // highlight search terms in the description + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + } + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, anchor) + ); + // highlight search terms in the summary + if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js + highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted")); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + "Search finished, found ${resultCount} page(s) matching the search query." + ).replace('${resultCount}', resultCount); +}; +const _displayNextItem = ( + results, + resultCount, + searchTerms, + highlightTerms, +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), searchTerms, highlightTerms); + setTimeout( + () => _displayNextItem(results, resultCount, searchTerms, highlightTerms), + 5 + ); + } + // search finished, update title and status message + else _finishSearch(resultCount); +}; +// Helper function used by query() to order search results. +// Each input is an array of [docname, title, anchor, descr, score, filename]. +// Order the results by score (in opposite order of appearance, since the +// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically. +const _orderResultsByScoreThenName = (a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { + // same score: sort alphabetically + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional + } + return leftScore > rightScore ? 1 : -1; +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings +} + +/** + * Search Module + */ +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString, anchor) => { + const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html'); + for (const removalQuery of [".headerlinks", "script", "style"]) { + htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() }); + } + if (anchor) { + const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`); + if (anchorContent) return anchorContent.textContent; + + console.warn( + `Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.` + ); + } + + // if anchor not specified or not found, fall back to main content + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent) return docContent.textContent; + + console.warn( + "Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template." + ); + return ""; + }, + + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); + }, + + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), + + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); + } + }, + + hasIndex: () => Search._index !== null, + + deferQuery: (query) => (Search._queued_query = query), + + stopPulse: () => (Search._pulse_status = -1), + + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { + Search._pulse_status = (Search._pulse_status + 1) % 4; + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; + pulse(); + }, + + /** + * perform a search for something (or wait until index is loaded) + */ + performSearch: (query) => { + // create the required interface elements + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); + + // index already loaded, the browser was quick! + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); + }, + + _parseQuery: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; + + // stem the word + let word = stemmer.stemWord(queryTermLower); + // select the correct list + if (word[0] === "-") excludedTerms.add(word.substr(1)); + else { + searchTerms.add(word); + highlightTerms.add(queryTermLower); + } + }); + + if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js + localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" ")) + } + + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); + + return [query, searchTerms, excludedTerms, highlightTerms, objectTerms]; + }, + + /** + * execute search (requires search index to be loaded) + */ + _performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + const allTitles = Search._index.alltitles; + const indexEntries = Search._index.indexentries; + + // Collect multiple result groups to be sorted separately and then ordered. + // Each is an array of [docname, title, anchor, descr, score, filename]. + const normalResults = []; + const nonMainIndexResults = []; + + _removeChildren(document.getElementById("search-progress")); + + const queryLower = query.toLowerCase().trim(); + for (const [title, foundTitles] of Object.entries(allTitles)) { + if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) { + for (const [file, id] of foundTitles) { + let score = Math.round(100 * queryLower.length / title.length) + normalResults.push([ + docNames[file], + titles[file] !== title ? `${titles[file]} > ${title}` : title, + id !== null ? "#" + id : "", + null, + score, + filenames[file], + ]); + } + } + } + + // search for explicit entries in index directives + for (const [entry, foundEntries] of Object.entries(indexEntries)) { + if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) { + for (const [file, id, isMain] of foundEntries) { + const score = Math.round(100 * queryLower.length / entry.length); + const result = [ + docNames[file], + titles[file], + id ? "#" + id : "", + null, + score, + filenames[file], + ]; + if (isMain) { + normalResults.push(result); + } else { + nonMainIndexResults.push(result); + } + } + } + } + + // lookup as object + objectTerms.forEach((term) => + normalResults.push(...Search.performObjectSearch(term, objectTerms)) + ); + + // lookup as search terms in fulltext + normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms)); + + // let the scorer override scores with a custom scoring function + if (Scorer.score) { + normalResults.forEach((item) => (item[4] = Scorer.score(item))); + nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item))); + } + + // Sort each group of results by score and then alphabetically by name. + normalResults.sort(_orderResultsByScoreThenName); + nonMainIndexResults.sort(_orderResultsByScoreThenName); + + // Combine the result groups in (reverse) order. + // Non-main index entries are typically arbitrary cross-references, + // so display them after other results. + let results = [...nonMainIndexResults, ...normalResults]; + + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + return results.reverse(); + }, + + query: (query) => { + const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query); + const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms); + + // for debugging + //Search.lastresults = results.slice(); // a copy + // console.info("search results:", Search.lastresults); + + // print the results + _displayNextItem(results, results.length, searchTerms, highlightTerms); + }, + + /** + * search for object names + */ + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; + } + + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); + return results; + }, + + /** + * search for full-text terms in the index + */ + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const titles = Search._index.titles; + + const scoreMap = new Map(); + const fileMap = new Map(); + + // perform the search on the required terms + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, + ]; + // add support for partial matches + if (word.length > 2) { + const escapedWord = _escapeRegExp(word); + if (!terms.hasOwnProperty(word)) { + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + } + if (!titleTerms.hasOwnProperty(word)) { + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord)) + arr.push({ files: titleTerms[term], score: Scorer.partialTitle }); + }); + } + } + + // no match but word was a required one + if (arr.every((record) => record.files === undefined)) return; + + // found search word in contents + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); + }); + + // create the mapping + files.forEach((file) => { + if (!fileMap.has(file)) fileMap.set(file, [word]); + else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word); + }); + }); + + // now check if the files don't contain excluded terms + const results = []; + for (const [file, wordList] of fileMap) { + // check if all requirements are matched + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; + if ( + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; + + // ensure that none of the excluded terms is in the search result + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; + + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); + } + return results; + }, + + /** + * helper function to return a node containing the + * search summary for a given text. keywords is a list + * of stemmed words. + */ + makeSearchSummary: (htmlText, keywords, anchor) => { + const text = Search.htmlToText(htmlText, anchor); + if (text === "") return null; + + const textLower = text.toLowerCase(); + const actualStartPosition = [...keywords] + .map((k) => textLower.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("p"); + summary.classList.add("context"); + summary.textContent = top + text.substr(startWithContext, 240).trim() + tail; + + return summary; + }, +}; + +_ready(Search.init); diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/_static/sphinx_highlight.js @@ -0,0 +1,154 @@ +/* Highlighting utilities for Sphinx HTML documentation. */ +"use strict"; + +const SPHINX_HIGHLIGHT_ENABLED = true + +/** + * highlight a given string on a node by wrapping it in + * span elements with the given class name. + */ +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; + + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } + + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + const rest = document.createTextNode(val.substr(pos + text.length)); + parent.insertBefore( + span, + parent.insertBefore( + rest, + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + /* There may be more occurrences of search term in this node. So call this + * function recursively on the remaining fragment. + */ + _highlight(rest, addItems, text, className); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); + } + } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); + } +}; +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; + +/** + * Small JavaScript module for the documentation. + */ +const SphinxHighlight = { + + /** + * highlight the search words provided in localstorage in the text + */ + highlightSearchWords: () => { + if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight + + // get and clear terms from localstorage + const url = new URL(window.location); + const highlight = + localStorage.getItem("sphinx_highlight_terms") + || url.searchParams.get("highlight") + || ""; + localStorage.removeItem("sphinx_highlight_terms") + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); + + // get individual terms from highlight string + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do + + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + localStorage.removeItem("sphinx_highlight_terms") + }, + + initEscapeListener: () => { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return; + + document.addEventListener("keydown", (event) => { + // bail for input elements + if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return; + // bail with special keys + if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return; + if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) { + SphinxHighlight.hideSearchWords(); + event.preventDefault(); + } + }); + }, +}; + +_ready(() => { + /* Do not call highlightSearchWords() when we are on the search page. + * It will highlight words from the *previous* search query. + */ + if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords(); + SphinxHighlight.initEscapeListener(); +}); diff --git a/bluetooth.html b/bluetooth.html new file mode 100644 index 0000000..9f9daa5 --- /dev/null +++ b/bluetooth.html @@ -0,0 +1,138 @@ + + + + + + + + Bluetooth — NanoNav documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Bluetooth

+

Using Bluetooth Low Energy (BLE) to communicate with the NanoNav.

+
+

Quick Example

+
from nanonav import BLE
+
+# Create a Bluetooth object
+ble = BLE(name="NanoNav")
+
+ble.send(43)
+response = ble.read()
+
+
+
+
+

Usage

+
+
+

Connecting from Mobile

+

Various mobile apps are available for communicating with Bluetooth Low Energy. We recommend LightBlue which is available for both iOS and Android. +TODO: Add screenshots and instructions for connecting to the NanoNav using LightBlue.

+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Erik Umble, Joel McCandless, & Chris Kurbiel. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html new file mode 100644 index 0000000..e56bbe7 --- /dev/null +++ b/genindex.html @@ -0,0 +1,107 @@ + + + + + + + Index — NanoNav documentation + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ + +

Index

+ +
+ +
+ + +
+ +
+
+ +
+
+
+ ©2024, Erik Umble, Joel McCandless, & Chris Kurbiel. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..704e447 --- /dev/null +++ b/index.html @@ -0,0 +1,132 @@ + + + + + + + + Welcome to NanoNav’s documentation. — NanoNav documentation + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Welcome to NanoNav’s documentation.

+

Check out the Quick Start section to get started.

+
+

Contents

+
+ +
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Erik Umble, Joel McCandless, & Chris Kurbiel. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/movement.html b/movement.html new file mode 100644 index 0000000..9381fdf --- /dev/null +++ b/movement.html @@ -0,0 +1,122 @@ + + + + + + + + Movement — NanoNav documentation + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Movement

+

Working with NanoNav’s motors.

+
+

Quick Example

+
from nanonav import ...
+
+# TODO
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Erik Umble, Joel McCandless, & Chris Kurbiel. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv new file mode 100644 index 0000000000000000000000000000000000000000..a7626df8dff42d3282cd1de0d9c83fa796bdd97c GIT binary patch literal 303 zcmY#Z2rkIT%&Sny%qvUHE6FdaR47X=D$dN$Q!wIERtPA{&q_@$u~P6$%**#nECULK zL8Pq|fb5WrRE46{+{Dbhl++@H{4|A?BW`)iMLERaW{#i@fy0Tb%rt4Sb*Jfgwf@l3!G&P!DeZ;WYRc_9fmgAkN zZuLU1CYtQZoxol=y{cMbYsKXwwYpXb2mMX|X9y~l^X=X9sqM(z8|*BXdOraGCyabC literal 0 HcmV?d00001 diff --git a/search.html b/search.html new file mode 100644 index 0000000..7aa6127 --- /dev/null +++ b/search.html @@ -0,0 +1,124 @@ + + + + + + + Search — NanoNav documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + +
+ + +
+ +
+
+ +
+
+
+ ©2024, Erik Umble, Joel McCandless, & Chris Kurbiel. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + +
+ + + + + + \ No newline at end of file diff --git a/searchindex.js b/searchindex.js new file mode 100644 index 0000000..80e412f --- /dev/null +++ b/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles": {"Bluetooth": [[0, "bluetooth"]], "Connecting from Mobile": [[0, "connecting-from-mobile"]], "Contents": [[1, "contents"]], "Installation": [[3, "installation"]], "Movement": [[2, "movement"]], "Quick Example": [[0, "quick-example"], [2, "quick-example"]], "Quick Start": [[3, "quick-start"]], "Usage": [[0, "usage"]], "Welcome to NanoNav\u2019s documentation.": [[1, "welcome-to-nanonav-s-documentation"]]}, "docnames": ["bluetooth", "index", "movement", "usage"], "envversion": {"sphinx": 61, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["bluetooth.rst", "index.rst", "movement.rst", "usage.rst"], "indexentries": {}, "objects": {}, "objnames": {}, "objtypes": {}, "terms": {"": 2, "0": 3, "0x0002": 3, "0x0008": 3, "0x1523": 3, "0x1525": 3, "1": 3, "2": 3, "3": 3, "43": 0, "500000": 3, "8": 3, "A": 3, "If": 3, "Or": 3, "The": 3, "To": 3, "_": 3, "__init__": 3, "_advertis": 3, "_ble": 3, "_connect": 3, "_flag_read": 3, "_flag_writ": 3, "_handl": 3, "_io_capability_display_onli": 3, "_irq": 3, "_irq_central_connect": 3, "_irq_central_disconnect": 3, "_irq_gatts_writ": 3, "_nanobot_char_uuid": 3, "_nanobot_servic": 3, "_payload": 3, "_service_uuid": 3, "activ": 3, "adc": 3, "add": [0, 3], "addr": 3, "addr_typ": 3, "adv_data": 3, "advertising_payload": 3, "an": 3, "android": 0, "app": 0, "ar": [0, 3], "around": 3, "as_typ": 3, "avail": 0, "b": 3, "been": 3, "below": 3, "big": 3, "ble": [0, 3], "ble_advertis": 3, "bluetooth": [1, 3], "bond": 3, "both": 0, "byte": 3, "call": 3, "characterist": 3, "check": 1, "class": 3, "code": 3, "commun": [0, 3], "config": 3, "conn_handl": 3, "connect": [1, 3], "const": 3, "constant": 3, "copi": 3, "creat": 0, "current": 3, "data": 3, "decod": 3, "def": 3, "defin": 3, "directori": 3, "disconnect": 3, "download": 3, "e": 3, "effici": 3, "either": 3, "elif": 3, "els": 3, "encod": 3, "energi": [0, 3], "error": 3, "event": 3, "exampl": 1, "except": 3, "f": 3, "file": 3, "freq": 3, "from": [1, 2, 3], "from_byt": 3, "function": 3, "gap_advertis": 3, "gatts_read": 3, "gatts_register_servic": 3, "gatts_writ": 3, "get": 1, "ha": 3, "handl": 3, "help": 3, "i": [0, 3], "id": 3, "import": [0, 2, 3], "instal": 1, "instruct": 0, "int": 3, "interval_u": 3, "io": [0, 3], "irq": 3, "isinst": 3, "last": 3, "le_secur": 3, "lightblu": 0, "low": [0, 3], "machin": 3, "micropython": 3, "mitm": 3, "mobil": 1, "motor": 2, "movement": 1, "must": 3, "name": [0, 3], "nano": 3, "nanonav": [0, 2, 3], "need": 3, "none": 3, "object": 0, "occur": 3, "one": 3, "out": 1, "packag": 3, "param": 3, "pin": 3, "print": 3, "project": 3, "provid": 3, "pwm": 3, "py": 3, "quick": 1, "rais": 3, "read": [0, 3], "recommend": 0, "remov": 3, "respons": 0, "return": 3, "rp2": 3, "rp2040": 3, "rtype": 3, "screenshot": 0, "section": 1, "self": 3, "send": [0, 3], "servic": 3, "set": 3, "setup": 3, "should": 3, "space": 3, "start": 1, "str": 3, "string": 3, "succesful": 3, "supplementari": 3, "time": 3, "to_byt": 3, "todo": [0, 2], "true": 3, "try": 3, "type": 3, "uniqu": 3, "us": [0, 3], "usag": 1, "utf": 3, "uuid": 3, "valu": 3, "value_handl": 3, "valueerror": 3, "variou": 0, "we": 0, "which": 0, "work": 2, "world": 3, "wraper": 3, "written": 3, "wumpu": 3, "your": 3}, "titles": ["Bluetooth", "Welcome to NanoNav\u2019s documentation.", "Movement", "Quick Start"], "titleterms": {"": 1, "bluetooth": 0, "connect": 0, "content": 1, "document": 1, "exampl": [0, 2], "from": 0, "instal": 3, "mobil": 0, "movement": 2, "nanonav": 1, "quick": [0, 2, 3], "start": 3, "usag": 0, "welcom": 1}}) \ No newline at end of file diff --git a/usage.html b/usage.html new file mode 100644 index 0000000..722e856 --- /dev/null +++ b/usage.html @@ -0,0 +1,230 @@ + + + + + + + + Quick Start — NanoNav documentation + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+ +
+

Quick Start

+
+

Installation

+

To use the NanoNav supplementary code, either download nanonav.py to your project directory

+

Or copy the code below into a file called nanonav.py

+
  1
+  2from ble_advertising import advertising_payload
+  3import bluetooth
+  4from machine import Pin, PWM, ADC, freq
+  5import machine
+  6from micropython import const
+  7import rp2
+  8
+  9import time
+ 10
+ 11# Define BLE constants (these are not packaged in bluetooth for space efficiency)
+ 12_IO_CAPABILITY_DISPLAY_ONLY = const(0)
+ 13_FLAG_READ = const(0x0002)
+ 14_FLAG_WRITE = const(0x0008)
+ 15_IRQ_CENTRAL_CONNECT = const(1)
+ 16_IRQ_CENTRAL_DISCONNECT = const(2)
+ 17_IRQ_GATTS_WRITE = const(3)
+ 18
+ 19class BLE:
+ 20    """
+ 21    A helpful wraper around the BLE service functions needed for the Wumpus World project
+ 22    """
+ 23    def __init__(self, ble=bluetooth.BLE(), name="NANO RP2040"):
+ 24        # Setup bluetooth low energy communication service
+ 25        _SERVICE_UUID = bluetooth.UUID(0x1523) # unique service id for the communication
+ 26        _NanoBot_CHAR_UUID = (bluetooth.UUID(0x1525), _FLAG_WRITE | _FLAG_READ) # characteristic
+ 27        _NanoBot_SERVICE = (_SERVICE_UUID, (_NanoBot_CHAR_UUID,),) # service to provide the characteristic
+ 28
+ 29        self._ble = ble
+ 30        self._ble.active(True)
+ 31        self._ble.config(
+ 32            bond=True,
+ 33            mitm=True,
+ 34            le_secure=True,
+ 35            io=_IO_CAPABILITY_DISPLAY_ONLY
+ 36        )
+ 37        self._ble.irq(self._irq)
+ 38        ((self._handle,),) = self._ble.gatts_register_services((_NanoBot_SERVICE,))
+ 39        self._connections = set()
+ 40        self._payload = advertising_payload(name=name, services=[_SERVICE_UUID])
+ 41        self._advertise()
+ 42        self.value = b'a'
+ 43
+ 44    def _advertise(self, interval_us=500000):
+ 45        self._ble.gap_advertise(interval_us, adv_data=self._payload)
+ 46
+ 47    def _irq(self, event, data):
+ 48        # handle bluetooth event
+ 49        if event == _IRQ_CENTRAL_CONNECT:
+ 50            # handle succesfull connection
+ 51            conn_handle, addr_type, addr = data
+ 52            self._connections.add(conn_handle)
+ 53
+ 54        elif event == _IRQ_CENTRAL_DISCONNECT:
+ 55            # handle disconnect
+ 56            conn_handle, _, _ = data
+ 57            self._connections.remove(conn_handle)
+ 58            self._advertise()
+ 59
+ 60        elif event == _IRQ_GATTS_WRITE:
+ 61            conn_handle, value_handle = data
+ 62            if conn_handle in self._connections:
+ 63                # Value has been written to the characteristic
+ 64                self.value = self._ble.gatts_read(value_handle)
+ 65
+ 66
+ 67    def send(self, value):
+ 68        """
+ 69        Send value to the bluetooth characteristic.
+ 70
+ 71        :param value: The value to send.
+ 72        :type value: bytes, int, str
+ 73        :raise ValueError: If the value is not bytes, int, or str.
+ 74
+ 75        """
+ 76        if not isinstance(value, bytes):
+ 77            if isinstance(value, int):
+ 78                value = value.to_bytes(1, "big")
+ 79            elif isinstance(value, str):
+ 80                value = value.encode('utf-8')
+ 81            else:
+ 82                raise ValueError("send value should be type bytes, int, or string")
+ 83        self.value = value
+ 84        self._ble.gatts_write(self._handle, value)
+ 85
+ 86    def read(self, as_type="bytes"):
+ 87        """
+ 88        Return the current value of the bluetooth characteristic, or None if an error occurred.
+ 89
+ 90        :param as_type: The type to return the value as. Must be one of 'bytes', 'str', or 'int'.
+ 91        :type as_type: str
+ 92        :return: The value of the characteristic.
+ 93        :rtype: bytes, str, int, None
+ 94        :raise ValueError: If as_type is not 'bytes', 'str', or 'int'.
+ 95        """
+ 96        value = self.value  # try using the last value written to characteristic
+ 97        try:
+ 98            if as_type == "bytes":
+ 99                return value
+100            elif as_type == "str":
+101                return value.decode("utf-8")
+102            elif as_type == "int":
+103                print(f'read {value}')
+104                return int.from_bytes(value, "big")
+105        except Exception as e:
+106            return None
+107
+108        raise ValueError("as_type must be one of 'bytes', 'str', or 'int'")
+
+
+
+
+ + +
+ +
+
+ +
+
+
+ ©2024, Erik Umble, Joel McCandless, & Chris Kurbiel. + + | + Powered by Sphinx 7.3.7 + & Alabaster 0.7.16 + + | + Page source +
+ + + + + + \ No newline at end of file