From 53c1d6d84b8d7ba09c970f6c6afbcee6084a766d Mon Sep 17 00:00:00 2001 From: Dong Heng Date: Wed, 30 Jan 2019 15:49:20 +0800 Subject: [PATCH] docs(general_notes): Add general notes to main page of document --- docs/_static/general-notes.gif | Bin 0 -> 7794 bytes docs/en/general-notes/index.rst | 25 +++++++++++++++++++++++++ docs/en/index.rst | 14 +++++++++----- 3 files changed, 34 insertions(+), 5 deletions(-) create mode 100644 docs/_static/general-notes.gif create mode 100644 docs/en/general-notes/index.rst diff --git a/docs/_static/general-notes.gif b/docs/_static/general-notes.gif new file mode 100644 index 0000000000000000000000000000000000000000..6a444da85c06d6f1384403cb8f282a5a713a5d1b GIT binary patch literal 7794 zcmdUUWmg3lI+&zI1Y;Xw>+%>^9xHGsr*Wm6h!2<*aXBb?9yE_DTcb>Wb#ruBf z?zL)lovL$I*WSCTBh^%7u`$Ro;Nak}<>jO_V9&w-U1%t9GqNaYC7t7&A;S>`|CF-!Q#INdQC_e2W)WH~wSuEKB40B&Q@xz@o1c2n z{SD+Ts?kc}z21mUpNmfskE&cp*h(l68o^7YNnSe?J9vMaeHW?z5DkV9xkhr+6TZE~ zz=a!TQI(Kphf@w6*5OBeRoX$4R^qxq4xmNyCZ$DKWQeD7Mv-gMeX-cFB7FElye}74 z5%L8Ev(>^6MZd2x^Y5SLMpt-~mvI&9$osDZp7=#OWex_6xXIW{F~wClt?|_c;w(P;YrZM zKPCi~m>}yQVtnITL~07g_(O4mh}vc9Ovn>DvnkSoRTHYeN$rKSTR;OrkTgMxk-!TJ zWyZsv4!fZv7{aIrWh9{PqK1nnsv)Exl}OObp;QOWOZ2O;e1|^`KPoUTNS^dQ_&kgJ zHOQy%+X2-LvP`$R4)%Pw@|G?qfn|5MGYW)fpZF&km~El5{5UqlV&ag#No= z^&&-9V(9kn!+`>*XW>Tscq5-1bfj%=0E=8{J41f~$9@5^2 zJ?c^#?vVbUhdSK9x%u$2gOq#O2h&VEe^S&rEVA3vc#wj6ZMJ_qpS3tsqNazl_MLW7 z_2l-h4czXCZpnN3L%y!lW0m@=4(6{b2T zPpXnKRpO0Bob_4%BnM*GIN`cq{u_VqV_$uW}KC;xjxKC@FrCO`@w$ z{LuU%_9M?W_(*gPv(lf3a4cd^a%Xye`fi4O>S^wet);DfBTwVc#$MZ8Tgju!Bk-Kr zTzZ9eWxjg)jJlhqPY)jdt zbaLTgS!PYEE?D(ptquNj}y}`(?%BJ1MwK2LO-d1cj*!_z;y?fg6$xLe@ z_wTAQiUQX8wL;%-_l?ws6N((lPF3r=9pC)3pdhGPVAY%8YdV%YN_1j3vz3847TEzQ z68R9;9l0BM40#sW0O=kDAGs(OJvmpbMobfVBLz0uF$IXcma~RGz*>USGz(3sDcdc> zkB65#mfO&3+5V|VsW-+U%}&edZZYTQnGLiLviwp5Ls^?d$GVyAG$#8)YnDI18z45w z`hvRX)gF58V|}A;nJihlU%@L`_G9(qO*PGDjfE>=i@Pg4E09bJ5mw;*o-P#_x+1h} zxp>y>Z(e3gVxI1_V0%BlKAmT0Y!kQ;yuEq;XSuL{>(st#>1C_`_I$%!1F%7S+uNb#Y1)~`lS$?H)jB)seW}xKz_jjN7Lb$=8fA9{$8C{!QW5H|ohJ5LU zgVY!C+JA3kE(;h=7vT(E7a(vQ-oN#$fk z=TdMryPRFiwGR;`QmHqTORJ+6%M^7K^UH`uam6S0Hw=Cr9FMP#ekI+f&?f&BpHI{Y zc=HL-3gIkd!cQm7)=3r+nQ&Tf@_xOh+9w(B?Ci4du1D4;v1J?8@v=<3q8~3Zlh63o z@+(x{Sa2)HcH9{t-1^x&;<$Hh+`s>N+umau@ z**ayjQ=`17T%>%@@9QY4R;iJtzue5^rZ}TDFke(n)5Nyy(P;0nbavWzT7P&Au9NRMCj=yiZp5LP7fEzbWqc zrYWN1gBa==I0EIL{=H3Y7M~7g43fuXQ`QQ76IP!^;{C^i&5N1!j}4v8@KdNtQ*&Em zo`8jGJ!@HQo6%SASnuk`wwc>fia36im!pT{NR_hj((G}5eaF^S+taKW_q(S3 z(`!$^a|7rI)c4hBv7_dh>)y9*-*d#*>njJfxro;@=kwM3{+cHm{~Qmo?*!bK=H`>u86aboz_ckI5A#xl^FCXO^fC`l0TRCkcPSB99MnJ*0O z^Cu%Ud?LDUe97)_ouaka<36!xJ~{0#YOAu#l>cF#w8G3L#)#L)lLyLf{ALpgTe3nHNP>D3yvq$LoSpDgMJGNl->gr48XMK)9l#wf(-?Rq$;!Bq~CEViqy- z3GoG&+U4iZpGA=2>Z z8Wy=_W#W4c!eq6QFrQsJ@6Q9rK-4+g4+_3*Iz(Jd`Q z{o8e$>@y#ClT}Bjie<+#t@3oY2(=k((0-}ri|(}@*Kl)Njq@~ZWAPu zk3vLjZf?#-#w5-#4t$-vIavbVm6$LDNIN_a(gbE;vbS`N=8J78WpEazAuGCU7yS3I z8Hziq$kAaQ@O;Yedbec7zfBUg65N#^_+~RMd@kbp{(7HXp;?yYIxbk&yL9ueq(CVf zN6Dp__Jxb1^QFG6dccg_S%OkLCPR&0<1plEn02qV z^DT)}!9^T{bWvl|?_mpccb?>E__)HzHphN zk46kVU2YtKJfF3%i^^!}b3OrVrWu8wTnM$Ar}9JQ}-&XY5*74a{|g^;>k|bjRMxFns$@Fk2X3x!RJAo%w*n$?)Ph+*~hh= zqBh06IVU)w-W&CwsTKZ>!gxJ0%gIfvp~e7)mATx7g%+{Y2qLNoMPY z&itd;gV&fdoT9gh9f-GozY)j}VFmUd+6w9U`!{SCFv!h(p18Cj;RcQ~6=?O=9$lMa zG(&U|`wEv7PT7FpN0TbZfBnp`%gtf7!};=`0As@5W6eWeM#7Q^WULdcN(sFlQ#D;y zmCJR4tu{t6oi4W)G?ql;_xKm{k8&o=IK-{z!QR)UYw+rr0~emGDjvJhD5TBE7I$Q# zrSOxH7T9OaThgkJCdG=g+{QA2c1nD_FT!~HCZ#g3n&&dHEKF9?7WlB-E{zSb7$I&C z`W)^p2|=?M^DM5q^RvIiz$i-*-kpjnCd+luA{2dpx%T)hqFJxWDUy?6Gm_$e*JaV< zV10q!=P7z4_#>92T0kO*kDk_p-TUdVY|L}R-_vDT>hpk=%Vrj@-ROFU@0h0QSBvHa z^sW8q88qXKj!G}lWl`BBP7*df^YCxnjNCp7oqtIv?7%7pbTQ%$+sw=P2UwT{q=!~v zknblaPdaglV#LhhJR~E#6qxxlGi22QLlF~0&}%X*V&%HkCY<1p#L+3kXcd^udO&k! z>ik4Wq@H2^J8-3>Nq$WNwb7QtOHCsV2f-MyksTH#8toO4~y{GvUo-@ zJ)$Et&o%e-r6z~$r50eZAxUgG0EE#YOSEGVj@Y>bIgJxOEB^^#%`E-ZKZOQ_3SU0# z#IImibiQ0EuAs_GQ=ZrlEo7c`+#9vu@TMqYJmQYoSzQ(pq5j9}`!v)Qj5t;tFKW9H z_kK0P@yRY>ysO_COXiEa1=v1-9NnD+_2y-IiQOdn){n(nA!i! zZ-cHD9O}t?E*ktW?s@xI4HdNoK5UvoX0Z>HU+_ zl6#9@8(s2@V%uTg0ebN*PD&eg5s|E%uXc$s5I)jr_gO1E!-(n%PoaN146S@Iw+i^9 z;apJSf(RdFX5kTV3Ztf+zPqO-#jX+d_LE)u8axj=VAKV6tJ9BdDb_eko=lyO&#;nR z zpRoT?_;gnGN9$2qbek_R`(x!V4*M8Yok_k8?RRhBq$P#TddpLOS`D)(J~{mk>LSU0 zx;v&wnVZd47DbziLhMa#%tHii9amuOlu|yp0Y-wCN(V`f*s&g9hmdf`j)KDr7%>Oo z(m0AC=%yX`;Vc^N|HY+gwzsq6_FVV2nlzJqaM@6Ue#5QSVGP9As6+BpQpt2!hY>~g zr+mL@_T-Y8tYKdqq3sg^fWtD6>xTb*>XY&v9=v;lwtb*18xGBhOf0|4t{ivZo8L7| z7i53+y<-F`5pQX--W|>if_@iXTM(;Ye{IR8|HKw2L-y02Pp{y;yJoi{Y_@sQCM~y! zSQfn89>I7{u{s8jNj+PU3#?W+Wanm^@))v!0M-f?JFfR^cIHnebuy& zf4k6NG!EXMjxp|>T4+Nsc=j1EHBXtFeLP$IVW2|frgH!d208<3%uQ%H3bZhU&zCz@ zzN;v;Ienisj`k9s#9LqiWc84kKk9s(S=1-89=Si78@V}KYyTmSb~Iu0BsVge{BH6@ zAdtwxLyxyd!{u%cqusmbpz4QNz~j$0R05ocLuR(#>}w=1FdMr?WGK$H(@!SIwF!LX#HS1Wv?5RhG)URRoPioB2Qf_XI8c< ziCC6Ff;bgpH(% zYYivZYJv|YX+CpTwQ17^m-nlC9E#e_f8lmJP%eo2p#CjczkDjRBq9eWu zNFt|LccP}pUlJ3PVn^aWRJ9pNq=cv}Y$UNKC`RE3E|%xUtk5cw*Q2aPqId?Atq)up zZku?@Sz_aoa*A)4XVpnoy;hb8r`>Skb=^r}v3P26a|$Ly$+#mlvDFtSYc$w?n7La) zQE(`&9ifkwy-uYI=H~%;nC;WoZx(x_nQVrx)ArO;QK8eL{FTMaB`wcg#PA|lLkxFJ zjM24tXu{JQKF8I2b%WI4-Z4=MLe+1_wMstBB#>NQbiMemafE+L!#&yjR1@w+A*3Z_ z{fd7RRLlAk6+J&E6NAFG`1}sYkX+s#_gC^K?KC1u9KfH65SeM_nDD9v4pgo06OV+n zFj%6sDCsVEvxp?*fd)u01Rk;`%1jeCC|v;31Y7rSjgao+CkXwc`$bsBjUXRg48}Un zKnwd2p+)J_O=A1ApY?yGm0)`NDJsiwAsi28r+Y=8W2a*;5MW1uZ4E2jtx0mbW%IzR z10AN8@(&rYXy|e$7!n!;t^hTz^qUNLr+t!71X-fn+)fJ<;O+Cx?obb{vpTauC780~ zWoW2k9X(C`Bc)ukdDqgJ3xV7 zyI`r`v;R)&H_ETMO&D^}~i=U+$I&h^7?cpqAD{wH=>aVlN!Tr5KC5|+&lr%UAH|E6yh$i`DQ zay-Cvn5*#OR@*1YmZ;B-HE)$cf}VE{dFa>x9-3rSO+swx7h~w^7bD1GTvyBX{G$Ma z=0z}paus9=)t)|fXq`}BLnWJUtSO#s+MO(A4<4oDZu1{8&0r3vsl@bu z4t-qw_KPO#KF4feSj#oSQk#rz^+cvwrlRZva(|F!!^z3>;LzXV{uXB{t=+W=xu#u* z^)6#Az#aSQ8NT{4ERn#1!#QyJ@$_yS&HGNvQm1F<64b1n>i5Ibajio>*5CvI3azzI zUEmq4%jy7{p^`KT1gXxAYduo%J2s3@prx|Xe$2x1V@r$MUv9LkE?`DCY>YcL;-Zm7 zA|!;26vz*s9qx+NBB}&<8~33)lzVUG`9v5|lBO=34aAV`H7*!|OLUEdGh8#}tgUuv z-Ld}+c|DM-mD85P#!LNIHIk+uIs`aBYsx=ZBCYJ!>NS3D_D&W2wnw`3ek+_0hm8K( zzT((EHaiJ4+!%BNoUQBTiT-E5Qe_^5!e3m)- z$-lUNBnfYJN@2vfH=b)J2Go-EkdI>E7Mr1La#*oU`=a}E{jzP$YL~JLrqMC53+2dzm [ ] Bootloader init SPI flash" + +2. Sniffer or Smartconfig +^^^^^^^^^^^^^^^^^^^^^^^^^ + +We moved some functions from IRAM to flash, including `malloc` and `free` fucntions, to save more memory. +In this case, please do not read/write/erase flash during sniffer/promiscuous mode. +You need to disable the sniffer/promiscuous mode at first, then read/write/erase flash. + +3. ESP8285 or ESP8266 + 1MB flash +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +ESP8285 or ESP8266 + 1MB flash can use "Copy OTA Mode" for OTA, more details are in the `examples/system/ota `_. diff --git a/docs/en/index.rst b/docs/en/index.rst index ff329195..c007946c 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -3,11 +3,11 @@ ESP8266\_RTOS\_SDK (IDF Style) Programming Guide This is the documentation for the new `ESP8266_RTOS_SDK `_ which refacted to be ESP-IDF Style. ESP8266\_RTOS\_SDK is the official development framework for the `ESP8266EX `_ chip. -================== ================== ================== -|Get Started|_ |API Reference|_ |API Guides|_ ------------------- ------------------ ------------------ -`Get Started`_ `API Reference`_ `API Guides`_ -================== ================== ================== +================== ================== ================== ================== +|Get Started|_ |API Reference|_ |API Guides|_ |General Notes|_ +------------------ ------------------ ------------------ ------------------ +`Get Started`_ `API Reference`_ `API Guides`_ `General Notes`_ +================== ================== ================== ================== .. |Get Started| image:: ../_static/get-started.gif .. _Get Started: get-started/index.html @@ -18,11 +18,15 @@ This is the documentation for the new `ESP8266_RTOS_SDK API Reference API Guides + General Notes * :ref:`genindex`