From bb8ba4ba60e1ae7fd3a4c1c3f42d5f1c826d6c66 Mon Sep 17 00:00:00 2001 From: Florian <1technophile@users.noreply.github.com> Date: Fri, 8 Nov 2019 22:03:52 +0100 Subject: [PATCH] update (#489) add fastled doc add links to bootloaders and boot app0 Arduino IDE upload instructions add add community --- README.md | 9 ++--- docs/.vuepress/config.js | 13 +++++- docs/CONTRIBUTING.md | 37 ------------------ docs/README.md | 6 +-- docs/img/apple-touch-icon.png | Bin 0 -> 9917 bytes docs/img/favicon-16x16.png | Bin 0 -> 570 bytes docs/img/favicon-32x32.png | Bin 0 -> 1301 bytes docs/participate/community.md | 4 ++ .../participate/development.md | 2 +- docs/upload/arduino-ide.md | 26 ++++++++++++ docs/upload/binaries.md | 2 + docs/use/actuators.md | 12 ++++++ 12 files changed, 62 insertions(+), 49 deletions(-) delete mode 100644 docs/CONTRIBUTING.md create mode 100644 docs/img/apple-touch-icon.png create mode 100644 docs/img/favicon-16x16.png create mode 100644 docs/img/favicon-32x32.png create mode 100644 docs/participate/community.md rename CONTRIBUTING.md => docs/participate/development.md (98%) create mode 100644 docs/upload/arduino-ide.md diff --git a/README.md b/README.md index cc42f99..abfb154 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,16 @@ [![Download count](https://img.shields.io/github/downloads/1technophile/OpenMQTTGateway/total.svg)](https://github.com/1technophile/OpenMQTTGateway/releases) [![HitCount](http://hits.dwyl.io/1technophile/https://githubcom/1technophile/OpenMQTTGateway.svg)](http://hits.dwyl.io/1technophile/https://githubcom/1technophile/OpenMQTTGateway) -**Questions, support please don't open an issue, go first to the [wiki](https://github.com/1technophile/OpenMQTTGateway/wiki) and if you not find your answer go to [the community forum](https://community.openmqttgateway.com)** +**Questions, support please don't open an issue, go first to the [docs](https://docs.openmqttgateway.com) and if you not find your answer go to [the community forum](https://community.openmqttgateway.com)** # OpenMQTTGateway -[![](https://github.com/1technophile/OpenMQTTGateway/blob/master/img/OpenMQTTGateway.jpg)](https://github.com/1technophile/OpenMQTTGateway/wiki) - -To know the main functions of the gateway see below -https://1technophile.github.io/OpenMQTTGateway/ +[![](https://github.com/1technophile/OpenMQTTGateway/blob/development/docs/img/OpenMQTTGateway.jpg)](https://community.openmqttgateway.com) Download OpenMQTTGateway from the [releases page](https://github.com/1technophile/OpenMQTTGateway/releases) The reference sheet, with the list of all functions, pinouts is [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=0) -A list of supported 433mhz devices (and others) is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079), door/window sensors, PIR sensors, smoke detectors, weather stations... +A list of supported devices is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079), door/window sensors, PIR sensors, smoke detectors, weather stations... A list of compatible components to build your gateway is available [here](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=1323184277), nodemcu, esp32, emitters and receivers... diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index f98e0e6..53dbdb3 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -3,7 +3,13 @@ module.exports = { lineNumbers: true }, title: 'OpenMQTTGateway', - description: 'One gateway, many technologies', + description: 'One gateway, many technologies: MQTT gateway for ESP8266, ESP32, Sonoff RF Bridge or Arduino with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, beacons detection, mi flora / mi jia / LYWSD02/ Mi Scale compatibility, SMS & LORA.', + head: [ + ['link', { rel: "apple-touch-icon", sizes: "180x180", href: "/img/apple-touch-icon.png"}], + ['link', { rel: "icon", type: "image/png", sizes: "32x32", href: "/img/favicon-32x32.png"}], + ['link', { rel: "icon", type: "image/png", sizes: "16x16", href: "/img/favicon-16x16.png"}], + ['link', { rel: "shortcut icon", href: "/img/apple-touch-icon.png"}], + ], themeConfig: { smoothScroll: true, repo: '1technophile/OpenMQTTGateway', @@ -51,6 +57,7 @@ module.exports = { children: [ 'upload/binaries', 'upload/pio' + 'upload/arduino-ide' ] }, { @@ -82,7 +89,9 @@ module.exports = { title: '6 - Participate 💻', // required sidebarDepth: 1, // optional, defaults to 1 children: [ - 'CONTRIBUTING', + 'participate/development', + 'participate/community', + 'participate/financial_support', ['https://github.com/1technophile/OpenMQTTGateway/blob/development/LICENSE.txt','License'] ] } diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md deleted file mode 100644 index 3ae521a..0000000 --- a/docs/CONTRIBUTING.md +++ /dev/null @@ -1,37 +0,0 @@ -# Contributing - -I like pull requests from everyone. By participating in this project, you -agree to follow the code of conduct below - -[code of conduct]: https://github.com/1technophile/OpenMQTTGateway/blob/master/CODE_OF_CONDUCT.md - -Fork the [development branch](https://github.com/1technophile/OpenMQTTGateway/tree/development), then clone the repo - -Make your modification, -* If you want to add a new gateway, name it `ZgatewayXXX`, `XXX` replaced by your gateway communication type, can be more than three letters -* If you want to add a new sensor, name it `ZsensorYYY`, `YYY` replaced by your sensor type, can be more than three letters -* If you want to add a new actuator, name it `ZactuatorZZZ`, `ZZZ` replaced by your actuator type, can be more than three letters - -Review your code, compile it for Arduino Uno and ESP8266 - -Test it localy on your hardware config - -If you modify `User_config.h` during your developments you need to report your modifications into Test_config.h -https://github.com/1technophile/OpenMQTTGateway/blob/master/tests/Test_config.h -Indeed during the continuous integration process `User_config.h` is replaced by `Test_config.h`. -`Test_config.h` as much more gateway/sensors enabled for the test than the default `User_config.h` - -Emit a pull request - -Verify the travis CI compilation results - -Request for review - -I may suggest some changes or improvements or alternatives. - -Some things that will increase the chance that your pull request is accepted: -* Comment your code -* Ask eventually for design guidelines -* Write a [good commit message][commit]. - -[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html diff --git a/docs/README.md b/docs/README.md index e02a9e4..a26a456 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,9 @@ -OpenMQTTGateway project goal is to concentrate in one gateway different technologies, decreasing by the way the number of proprietary gateways needed and hiding the different technologies singularity behind a simple & wide spread communication protocol; [MQTT](http://mqtt.org/). +OpenMQTTGateway project goal is to concentrate in one gateway different technologies, decreasing by the way the number of proprietary gateways needed, and hiding the different technologies singularity behind a simple & wide spread communication protocol; [MQTT](http://mqtt.org/). ![Overview](./img/OpenMQTTGateway.png) -OpenMQTTGateway support very mature technologies like basic 433mhz/315mhz protocols & infrared so as to make your old dumb devices "smart" and avoid you to throw then away. These devices have also the advantages of having a lower cost compared to Zwave or more sophisticated protocols. -And support also up to date technologies like Bluetooth Low Energy or LORA. +OpenMQTTGateway support very mature technologies like basic 433mhz/315mhz protocols & infrared (IR) so as to make your old dumb devices "smart" and avoid you to throw then away. These devices have also the advantages of having a lower cost compared to Zwave or more sophisticated protocols. +OMG support also up to date technologies like Bluetooth Low Energy (BLE) or LORA. To have an overview of the supported PIR, door, water, smoke sensors, sirens, rings, beacons, switchs & weather stations you can take a look to the [compatible devices list](https://docs.google.com/spreadsheets/d/1_5fQjAixzRtepkykmL-3uN3G5bLfQ0zMajM9OBZ1bx0/edit#gid=2126158079) diff --git a/docs/img/apple-touch-icon.png b/docs/img/apple-touch-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..273d8873568794d1e9c19c89a788c72accc3620a GIT binary patch literal 9917 zcmX9^WmsH26NTdLZUtJPrMP=>ha$zDB8A1ZxGZkP-JQZ>i@Q54Qrz9$_1k{$kK8=> zN$yNC=gcIzldx|}(io_us4y@v7_u@Fs?ZwzuOK5rpF(4Z?9d9h1<7nMhvh-xvF-;zkSZ zzT#TF2SW(H;Y(D#2chO!v#g^YHG^zkgqKd6Tbd8KUFIgD%_b!gx&ko1eMR{6xor*} zx!{gHp1sE{%jvB12fLF6E_L$>J=*mxpR-nf{qqhaFLyGKshg(OUbYh%4kPNvaQ4>uAe za)z;Y|EqDV3r0lTzzdNC%2Qv}Pi9s@4pFHViKzkyw|OP#dS$wJH0JVibuLQN$D)eM zn+}s?jM1zW*F5i!<$p6T#~OVl0%zBrjF~a4I?5n(KPLQ6udrlKjh(3!n3@=s>Q8}X z?Ug7MnIu*F$%X2(O#giHGBqXLD?#%`q4Cq<-XztTcb5!$vsJ(&o__?hrHJ{<^jW?^ zC>zaiNvL)szM>1=2Xix{bBuWG$r5+6eawPn)|NAn!72dZ>g zRM$vS_5*I!>f4&g3k5EJ00Z*!*G6ReLl@Lyxxq1ypxgKc6EsY(8VxDIW@Kv{JeSI_ z9#&RAraGwF4{i%mDY5~v--c|y`6d^A&j)mYEuv0-`TfhD|Jeq$^?pR-_sZDgPWdm+WMXoNL`N0tNv_fni0wfl(pi`+c&>&2`% zYvSDC)>kniFjckP1!>{5gbjSn7Hzd%u*Yo6btb#ctL>k@vS!N3`L~U`!-Y;!=uo~H z>LECpRd{Vr^H1www(W@B0QOk-(@?5XNO#V#@NA`r>h*3E)^pGnl^K>B&(v9rYQOL5 zR?Ss%7+=N#BBzoG*8)MxT```2YyJJ9#>_o0eyOoen~gPY9<2_X;mAZ=A$JYK^U0o~ z2-)$;fy%)$60RLvd5_QKdEzCyyAWs=L<5F!Ny~5l*J@eDHH6L=<{rgL`hz`|MP^to zSys7Rz1(Owoc~6_=%0Y!Y({moTfHcZH1Vc8?JPOpqeG+BZ_U7k+R=U}_|BqFu)E=; zg*g3)xi|26YIrjo?OoVZ2%%@9mW8P%qzq7t!u3wC_^Y8jw0~8vP^0`kZ@k6&4T5lj zBvITepM6uXrlV1jb%7DZMYr>_>x}l0uw?)aK_BAd$L8NeHe9jJ=#=PGouw6wD*A1Zf{&P?4_$(lU zl)y|ZEqQ92)9T#e!npAn(jVn0V|-z+!>VbjmidK$6hj;*j@k971xJszGOl^zCpIA* zYM;g3{Wa&4Ntz}*zjG4VYrcYF90g zwiG7{&(ZnUos-i$M@&Je(fT2&L_@K2Qy~Piaa&KbFFQgvfPo&^8j+VHTE6a##L$kp zDa$TMI`g;x*v_%Zt`_Uv$Ge~_z3;)A>2zai=jI;w?YjYv#+z{#J7YY*YH-I^qyUTB z8jkz^mE-*k0niXlK@ib@0yi`7@%Wq$kS%+xacD=^TmYHb0m{ae*PWR_d1X+}v zp$b9?!giEx0HgMkpj%e~!8{4h!pWAGs`|ht8?_uTfpe^X-8M>O{Go5x9K!A~S%^{)n4b^_N&f7r1o0Y+nVw zP*ukBQPmp=u5$BbGG7S;J5$BSJ~HrDaf@XtCHwFqVR5R@(g;qy_q{Fnt<46sTLoAp z;EffaAAb_zfn2ob#CTDk4oY`UviM(`evN0S<&w0K)q6%<=C!0%0_X=}CA$>PgWjnI zhrP?xG1hi#tHu2*9lrBS;y8v+tw3X!TLo6#Uf!b{S7`(s4=D)W=v)ah!ssX4=06(m zGZ78_x(YxzL*{?8HX1SXhht1Ylg;mr5~~lJCwZn@W&qHoJCxIj=l1x*MS8%8o-kvI zr4KKQ9s9TuSfK%ruz#wTgVHGWP(L|0e^NBD2E?r_h}&j-@uUlkiYB=Bck}=2hMb&7 zXjIsM;S9m8Cgk>?E>m0g9)QE!dpE?l`5wH%aM7K8o9k}PY;`FQeClefGf8a1?~{#S zTE=ZA3)4OrBo=~M0d`O*5H7?<<2WCfuSb09E@U8Rui|yJ2wQ^d_{hX9Fcz$UROH3r z6Efz8VpC2SvB{!26OL%aL>eT}r9!77Ya$;lvXFz0pkxSPw1cgGC0h3i0099{7~mRb zdUt^5&eI7`y0w^|Hz5to~4_>>^jvUd$V?f$MI&ub(xP}h;E33EPBWS(wB!F25tJNtQ*TBiy_(2w* zy^rUB;Jq{_wm`u5?urGPWzzil;zo)f#SVVeluN#0e2v`ExG~B5n^p>$Fpl?n_hTD* z{+0v{jfM@xUmnLSZ}hw5mvp`-diuHPho;&h^a*aDtSjXnN8@s&K4aQzCY~p=s4Sxo ze3r@O31>NXJ+Fvd)Ic=rr{?2+7dD9#N~9ZEvOn2xkFS9^{)4SJa4*2N3@3?CIt*>; z4ZlwkjYJep`(4I^r}pv&F`i#G69RL3acCOBAf+%tnVf&0#peNPxjPA3nr@v{4XFz` ztJZY26Bc*oeS|<=srR8{eS_qMf~Wb@KdLoJ+!&6JYgyX*>u@UGpQ{A#wC$o#n3u(B}qm?UOWKVZT7eALMrwXSNIxvqGC z*QQ<0sa?;sNLGRTD)a&)@SGxy{a);!OXRH;ibN=m(6~y7N!%I_ra<6{ zkn2C|DhbC3Pg}dG?NkaBq@o3GgvY<$sOe0V1h+L3UB{tRY>k4$BR}gkDD&MC zOs@D@&w*_jrnt%&km_H>`7qfY3;K{n1!^I=%=^!kep6zS@3{e>{tB~8$R2CEcb8$J zJ6H%jwI)(>973!;CDwrN3~ZbZ5jTLWjau1cE@)A{FsfvgkUzoYQ@-2mC30~VnzvlO zEf+-pSfiRhdHjB#)i@VTtXXC7!!zzi{$fYqTT9anVRU6e=;R z3>=l86liVXXKxyezmcESu%^(A;q!p7sod(_pobf5??3lwnP z(}U<8EvP^ow1?X}@DexmAQ(PVwF|P>N>OnE^)ZqhQ!3x>$bOS#G-87vt&|I}<#N7e zFT7^SifVp-q83w)gmqBaU=m_+p!gh=b3{rWKNN_x7vPHSjX;V>zjCQzQOD`dCIK8$ zVZ1d!V&cT&+hx^qV745nr()8(@i7y@wk%O~Q+Fqdk{$Lzj>WYGBoa~JZ08E>1(;g^ zUtDr>_{P5Gbkd`D)C#HCWP5N!Q2IDk_X47iCi##1B;LMusxN!AQX`B%d=-l<=PWd~ zjKPh-T!myhiPB@(9!O6wrg}BJI;S(N%rs+kZq0ONCbqX-%ep|1P<$*H-Xm(l_jrz9V z2VrM~CucG$T-(LE&~vNh7bZdi5r_yqA~(gC-o{3E=AYVY&MNWkEQRV|8O=N76JM|c z9rk-I0~@1?Z9fbU&ZRLiRHBWu7CDK=`xDhGU2bsk?heQbr)R12e+Qf*p3%MqXYgIJ z;>$+Z@fG?C53QvzF{RQrwx(*79g#ABr5~$I}?h<$#W?u;Gu4 z^zWkBW-tAO9ZRL{y8wwN#Ami?^hZTvXG^XxdJ*JvkXv zkNdU?JnwrvfF%>3GUX%rpL=#HMR=3m_I#J|CY?rEAI_BkEPJ!uD>*S0$d5xYGhCu4 zYcaz|2&qvN75Y$G@vi0k+sAt1$G(V}Oo(JEVR>N=Ut!lp**9za#r3K`Sv|TTJ^Pif z_qbJ0E<5u?Uc6GAh(XF{`&N*9Jx)!^V18|VQ^=2>pDcq<)6$i5su!y7zMMO-SUTFc`$SGQ}m6M%pA^B>8y@o>Tw2wq&l4ZyJ{1+utQEIO%&WmAer-|Od9y# zkql#UEdrvkcisDkXX9xuhasxIcS!43@;_qd*pgwLX#K<{kqeGYSA{;&g9wrio$&dX!K%*R$fYxd<; zHF0rjPgYuUCW-JWd28B3d_?0P#f&zvbL6y?Z{PEWN6!mqF6K5KP<}J4kJ{5Vzq-)s zM>Uzwsh!xim~2GvkV}=CLm&&%b%?R&Q@|kP^QUG43q6nUy^(QDFjFmHyfq5*67{i^ zb8a>5G!f6z!nUdALv*zON)qA?wDY_|qD%AVRr9Y!p%Avn-OyP(r#q+RdDa+$jvt46 za_wPA&$g44UX9h*Lu`l+cs=_LV87%XB`s@HcjBxjYNRbBct`>UKhr+3C|)$!z=5gC zkaKFSiYI0Dm)~^e|RVK|M^Ni)7xE4)$u0@~7&H?DF}H%AU_}u1#US zgx0ks_hB*-C&9KCE3xsv5T)+Y{J@RqJ3TK6(L`XO2SYfdS2S`R_>Gb*+rqX>r7bmG`J7f1PBxZ_4$AAcXXG6%xbK3tjFDbheAQ_uSL05rM_w`UrsMqBC0<6 z!eJ&HC-^3_Ei){aBLh)jLtGqQ8~DYCb!2)xx>5g>z>m$+Ikb(cZi@#s4&0>&uz5>} zuT7kTawtA6y-Tn~EW?70>X!V8A2r0fAx#`au$|$o_booZc1ys5vTZ>X@F6C<1btWYphpO;ISD8E^K+_yUQ{EfRZmC<* z>7o#uz2fH&32;e*SZ@WT_v#i9o9D$YT!1#0-d5c1yrqp`m|f? z6R0BOUF#LbY$@PMRoSI)cb4Gr({1+gx$Dz?hi>pt(@{Q%eQ>295gr`Hrc_^eE<=VU>xgwJZ6HnKZo;{zq`(;Ct4$`A?po4A$-KQoR#9j z^Zwzc8zU?_vd6HvEvVP>%uVYcz_n*Oo1#F-PyB)SLEP}n%JK6$ZC1?fRZX$U zROg7>VCxqn}6nW%P)w=hS~PICOqG(*-!M zSZ;yOw#{bAraK z0FueTMK*Ba8ODSb516u|3F9M7<_30uX~FCotvwUhu-a2Te7#wXsdk?xW93Sh=;4|* zwYDKV{bu6Kp4HZDN)PiF!JBj&b?p&zL${@NHWC( zW*eXWs=oRCEcMm)z#6uSC?MMmtJ_^$>o{T+Fz9qmv@U5Foq^VXCSesw>P-(MT^y{g-*@WmW)Wl4%sbIbgiU}z)G zMR(hQUppXDl2re1sH5_XSX+ISm)rM3fthwIfNInY*RHg+OvV_Ld=iDm7<^D5w=0B$sjkWKIRrl-X-Jm2<>tGC}do! z0iL$(Fx|{6jVIFQdf71Y+Zuvbt4o$bD^IYK0pi@b#S!TtM3eLW_1E8LKWq+?B@3FY ztXnD)EQ^6~!t!gBJpcRI=DmU?M}Fwv!FQ>$Dq4MDxHyZ1vCQ2^KSPodx}RL53_Tr}Y~npvUH5 zQoT4QE?e@Y_EZ}eQ8#vUJMSi^+$GqOs4)!o+S3J0^q&uLv^z)_>jMpgu6`}WxGjT* zt*53R2Eg9H-=~hwGpYnR@ch`?f$N? zE@)mKEGaCf-<3XM(CJAh0!o5s`RQkf1UP$>Xn0a4meI?r<4ugW} z2w=;-@%*Z`^F=bZGs^TdfgmG(zA-@KQRab~{PRLZQlm5xINA8MuUVXt(-WR#@_p@u zw^n;FYHk0EMo~wzSeSe7R-0mF*~imKgcGwA7V;gsny%$_c}E}S(;OXan#hTEEifbQ zkCZ6_@a7Y0!?5)>N^?%z=pme;m5#;ZH~`&1=#aba1Gw=qa_PsCs2)mTCoJhZr7ulM z*7xpy%$6*wDu%((c*bi*1pLZC3HQ+LL3BSWSSG1yLj z$woOM-o`^(qC|n-(!{Oh(LMOnNscWodM;=KRH9^^NOv%xuNY zf4kTF$?kk+w&6ftifKCIn?X2X>TToGaFNg=np-ey4co(NR1iYdPdTEXN_A&n z+(IV}wi)pG7NeJswkW@yc#>F)(?l8|VLkH!-rL|!NymR~g0EpslD+o;RZ74WAE5qU zPr$I@kvZou3SYMXEj4%rgDgWcjbNF86Ws;ldkOo`r%9-FBtTUVok@)7_48XGtADSb zZI4;OfSFGSDasJjw85ed6cS#8Us}_?yIX(fYFD1{GC1QfelTicyS^)?+`9Qv!e5re z`wzHv!0j=%Jz@p6MeALkg7m9G9(92MPUMyR<&=C-Nkm4?47Gz`e)aAi+8?Bauic2Psfrwz*(pJC$LF9m{7-- z97-63QQKz=Zq)qVvFV?(2`b1stzjF}>g0)EGCJabs4Z{X ziw3MKTS}m!KlBw02S+3&niJVMoH*RbgpmK?FX!_G?*I{m;%a98GrodgxH-K)BN~$) zX1^|&bz3W$-A?hTd7b;WFg0u{T$g%r%1U-f0YcEEj$m($ng6cy^4+Sx6* zQc-*g^AWrZrUf3`q)=B2V3ssDu^R)rfd0OWwJZP4hXh5$B+U?5_2(Rz#vHOK2{}eV zC9;E`EIGCH_vq~55eEjF$kM2ey;|PTF2L-Kt~|iEQMMHEmKYWJe?AnU$7-LpJB4nFKteR0HfDib@G?eGf(JiR z&c99@od@i-BE|-!|*Gl&zVIdgnPRN3L-iO8!N{6%_lv;>BPqMaHp#Q;Vg&o*81& zUsLjKOk$GWrRmEUjB$C>to0KQR$-q1LbvxcA}vR5!ziH>g7-nFJ*~n0t+JKudACv= z0-2#hi=PPIYjI4gw$LRybm{43vRDh`=g~-;KC>07hy8=~<-2@9JbltCQ+zELHnlPv3i)g{)m@{dog@SA9RG1VTzfI+;I5qfO4#me_v=?GM(#G z_-6j!qC<11@K_7jw$%RFZ)z$jelYp5I>!Ge{j6@aJdR!$c> z&oI^oQ?U;DZT3N(Dze65z3AfPmC7V|VXj>(!Ph>0+vHGlvr3zi?zZ^sZ}N-(Rvz!tpaT}`FY@LuMbAvGR2(zb}oXa~ftxf%Ouq71t2AOgpvaJ*7~ zkf0k%2L&n499?Rxmzvqw-8_Zo6Exlb_0*IZIaV4ikP3Y$Q)$S&Wv9@W7=!qn9=K!l z7y7=uI!lmkaeB*lFZGt!%827fK(LI*`ub^ z(FQ$s4A?t7NsBZo?s{3eaAL21raP)aI;nS}{B0W{(j~Q0%ShRm^jv3UIo<}>snA=H zg8yvV@Ad!P<_QvDP&a6=;}?3E%BM7HCbDD6KU|u*%7-w^zFpHYQ72_t7ZgX1nntH- z9dbAvX&Xap)E1-!m!2m@EHiP_&^Vf11(>6`NO|Rn%M-%mvLo}PNKG5wNwmmv>2Q|j zPk-qXDD;fgtf#tA3A4>+=VmaExPN_X--SC!bH;}znM2QReZ!J9Mf|r@IAbX1fDJM2 zTw4u9m}$Y;*=)MpG;L$iTVxln{mHSq&6>9WM>+=O&osH|q8lQBu#0sF5g7+s%Ek{O91o0v9Ot^LX7T0@ydbwcA}r-1alg4N8weD6ZBfmo;Ybh20qF- z2N&fa1>)`qwtjiGhMhe@N$8aZM;Wa)`u0|N^MdO9Tqd3@433CG?eKI{lGJ*BI_tcQ zdpe=qkb&9snstweUpr6L7lT&XlPMwHXW~=~YIEI)B9%qCsBq1geWoIwDoiKt&@}L; z$Ti{1Asfd~Tqa}Piqw;OcBJ%bTU%$el)NM$VYhZ&(`t>EWLZ4$bB{qp)Db2Q6w18@cPXlyVnm+ zz$McP0WvwcV8WmXwweK6DDLsLSG@eF(3?NKo+53LAD3PkLzpLB&ZUjj29F=|$(-&A zL`>b?&UDS7K?jNWZ;@PU(Y!sYA|r_O25p0-!RCvRbS@hI*HUiH z^|88%K?5mf-!77rMcmyZWCjY?)0A`tb{Y=F(EH)ohB6E9K<0gzV(6BsL+0OIqOAAI%f+&Z*?QP$ofL8?b{(BR{3)e48by}^q;)SIO zT7W?Gh6R3+Mbf$)PJjvyon&=LjI#grJtgsq1x*op7PWxiGm1V$6m^bq!OJ;w)XUVC z-E%*o4yR>sRXn}Xrjq+&vHMq~p;~JO0jKb1lEA5ujZp(UR?aI0l8#$VXVDO3y|cpd zdYN%)eQG^C?)CYrfv7Ms=kL6pcs&8+6Dgl8lunr93*SMN@QcEqza<2;!ezv>A49L4 O!N^J~Nr1$R0{#a%?u8!! literal 0 HcmV?d00001 diff --git a/docs/img/favicon-16x16.png b/docs/img/favicon-16x16.png new file mode 100644 index 0000000000000000000000000000000000000000..48c257b45320e60c912d313c462f737cc6bd29bd GIT binary patch literal 570 zcmV-A0>%A_P)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!~g&e!~vBn4jTXf0nbT9K~y+Tjnhp? z6mb{^@Tb{zOmWE%D6sq}$`vFK3>S-qJt!z5Y?>W}zz~EEQK#rCc<7+u&B_joAPBJ~ zq9Ut;x(7cnrO>7n6%vI?)J@iPXLo!Z|NAcE9Ng`9dY*TNm;Veimq>>sHbxhalAa35 zBH{Xj5}vZN1&M6WDs;3P5P8eLOrgC)k>e!Zb0O>H6hwl@B1gk2EV5PPxY#4?_yPY5 zK+XXkj`1bKrtb^VEc(rvHe4$!;whuQi$p`M;y6N&orBpE&k83q2}^H*+IPH8SMdti znc-q6v{|qpjBqnZxKaQdtZ~(?dx6{vE{5AzGqCX|#O)k$jy?y`_%otU)kKPioSljo zpZ7bUQvdu{ZU*B!AXR@$vWRDDI_B`mk&6~*9$pVLV{88>N^g{7;nzHF=GgJZ?TOte z)?8p>IZ97^-Q-ieJc$|n)<-WtHj13^JGgKE2idBks<@sfF?DyFa1h$VaU`U_!~}fb zhvB+Y$IYy=*o~>Rk;Dtqt<8 literal 0 HcmV?d00001 diff --git a/docs/img/favicon-32x32.png b/docs/img/favicon-32x32.png new file mode 100644 index 0000000000000000000000000000000000000000..5c7d04e8c2b12b400e0d38afb33dd079db82a47b GIT binary patch literal 1301 zcmV+w1?u{VP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!~g&e!~vBn4jTXf1gc3yK~z{rt(R*| z(^nYAAKC)tei3U81pM=MDI?c8Edc{ zz*8Rmqhy`sHKc6R9Y4<&^afIn5l{|~7;ElE^1+u$*^p(YLft+<$}t-fKY3(Dz3Z zRBeNhWyxWlU%+5pI~0faBP4bU&2Wq@fXM)qNq|Km5G)4fX1Es!`qi$jB1oyj2$#6~c@GMgl{Y}a>)&S=d z7;7!IT-ssMGIo+r(~XefoGG1=Wfs*ljc$P)=LlfprRHmfw2!GK&miKBfernL5b!4U#@@oyiQ4%B@~)-#MZ@YAr!5Bn}MTqBPRLeGSblyj_&=*??D zTN!ZUFt5g{54N2GO0uEJtH#j_8WE{m6>nhnR3)JN9V*Kr$I7|`tWf;dS8U&R+gRu0d*rN5(?BhIqd0|~sXIZAhd)Thcyp@hxr&1H zkFZ_(9Jy{+M@s+ zV=a6`1wa-SOO9*810?YG4aEJ?I~MIxfC=p=0)2x?xsNnh2DRSW`aKFD_V(jT;9kdD z%`{*Ca6fA^^C&>V<{g+b>S0_mlH(pzdKKa#k}TIA1;~oe#UeA}TE_))TywFt3?h*? zUP(M)(H;emOBG0xC{WdU4*CTxxoe}E9mCbOpRg->4}U(ySWW5&>t;yP%W_V~v16Cs zW2Pk&x%L=MMs~F7ZT9Nv7&fULCwBun;W9154J_}66!uohPIg^+i9OLz(g+v6 zoRf$Oi=$6i*{}dB{5#r+UR4Lid5>7Wvy88Ge8hI7%U+-vs{#H4@Z66q>^6K800000 LNkvXXu0mjfiKSNT literal 0 HcmV?d00001 diff --git a/docs/participate/community.md b/docs/participate/community.md new file mode 100644 index 0000000..d8494b6 --- /dev/null +++ b/docs/participate/community.md @@ -0,0 +1,4 @@ +# Community participation +The first entry step for participating to OMG is sharing and discussing with the [community](https://community.openmqttgateway.com), by sharing your experiences and answering to other questions you are giving back what the others gave to you. + +You can use the forum to ask questions, post answers, suggest features and discuss about home automation or Internet of things in a more general way. \ No newline at end of file diff --git a/CONTRIBUTING.md b/docs/participate/development.md similarity index 98% rename from CONTRIBUTING.md rename to docs/participate/development.md index 3ae521a..1d1e7eb 100644 --- a/CONTRIBUTING.md +++ b/docs/participate/development.md @@ -1,4 +1,4 @@ -# Contributing +# Development contributions I like pull requests from everyone. By participating in this project, you agree to follow the code of conduct below diff --git a/docs/upload/arduino-ide.md b/docs/upload/arduino-ide.md new file mode 100644 index 0000000..ece91c9 --- /dev/null +++ b/docs/upload/arduino-ide.md @@ -0,0 +1,26 @@ +# Upload with Arduino IDE + +* First download the last version of the Arduino IDE from the arduino [website](https://www.arduino.cc/en/Main/Software) +* Add ESP32 boards by following this [tutorial](https://github.com/espressif/arduino-esp32/blob/master/docs/arduino-ide/boards_manager.md) +* Add ESP8266 boards by following this [tutorial](https://github.com/esp8266/Arduino#installing-with-boards-manager) +* Download OpenMQTTGateway code from the [release page](https://github.com/1technophile/OpenMQTTGateway/releases) +* Download the libraries package corresponding to your board and module wished into the same page (example esp32-m5stick-c-ble-libraries.zip) +* Unzip the libraries into your arduino libraries folder (example D:/Users/XXXX/Documents/Arduino/libraries) +* Open the file main.ino from OpenMQTTGateway/main folder +* Change the settings and the desired gateways into user_config.h (uncomment the modules you want) + +*Example for the use of RF gateway* +```C++ +#define ZgatewayRF "RF" //ESP8266, Arduino, ESP32 +//#define ZgatewayIR "IR" //ESP8266, Arduino, Sonoff RF Bridge +//#define ZgatewayLORA "LORA" //ESP8266, Arduino, ESP32 +//#define ZgatewayPilight "Pilight" //ESP8266, Arduino, ESP32 +//#define ZgatewayBT "BT" //ESP8266, ESP32 +``` + +* Change the pins or parameters corresponding to the modules choosen, for RF you can change the pins into config_RF.h +* Choose the board on the Arduino IDE +* Select the port corresponding to the board +* Open the serial monitor and set 115200 bauds +* Upload ➡️ +* You should see the logs into the serial monitor diff --git a/docs/upload/binaries.md b/docs/upload/binaries.md index 5ff03ed..a5361cc 100644 --- a/docs/upload/binaries.md +++ b/docs/upload/binaries.md @@ -5,6 +5,8 @@ Nevertheless you will not be able to change advanced parameters, if you want to Download the binary corresponding to your board and gateway [here](https://github.com/1technophile/OpenMQTTGateway/releases) from github and uncompress it. ## ESP32 +* Download the bootloader [here](https://github.com/espressif/arduino-esp32/raw/master/tools/sdk/bin/bootloader_dio_80m.bin) +* Download the boot_app0 from [here](https://github.com/espressif/arduino-esp32/raw/master/tools/partitions/boot_app0.bin) * Download the flash tool utility from espressif: https://www.espressif.com/en/products/hardware/esp32/resources * Uncompress the package diff --git a/docs/use/actuators.md b/docs/use/actuators.md index b7b908b..c8c35b3 100644 --- a/docs/use/actuators.md +++ b/docs/use/actuators.md @@ -20,6 +20,18 @@ ON command `mosquitto_pub -t home/OpenMQTTGateway_MEGA/commands/MQTTtoONOFF -m '{"pin":15,"state":1}'` ## FASTLED +### The FASTLED module support 2 different operation modes +1. control one specific RGB LED +* Set color +* Set blink + +2. Start fire animation (Fire2012) + +### Hardware wiring +Theoreticaly it should be possible to use every free IO pin. But after some tests only pin D2 works at WEMOS D1. Other platforms can work. +The default setting use NEOPIXEL (WS2812B). The simplest wiring is direct connect D2 to data pin of LED stripe and connect VCC/GND to power source. You should also add an capacitor. + +