From 3868cf98f66edb1a571da39bd178a2b74010401c Mon Sep 17 00:00:00 2001 From: SURYANSH RAI <79277130+SURYANSH-RAI@users.noreply.github.com> Date: Thu, 5 Dec 2024 04:03:58 +0530 Subject: [PATCH] Better Footer with social links #3311 (#3361) * Added footer * Update README.md * Update index.html * Update index.html * Add files via upload * Delete images/mail.jpg * Update README.md * Update sd-card/html/index.html * Update docs/index.html --------- Co-authored-by: CaCO3 --- README.md | 89 +++++++++++++++++++++++++++++++------ docs/index.html | 45 +++++++++++++++++++ images/discussion-logo.png | Bin 0 -> 1076 bytes images/github-logo.png | Bin 0 -> 509 bytes images/gmail-logo.png | Bin 0 -> 514 bytes images/mail.jpg | Bin 3509 -> 0 bytes sd-card/html/index.html | 45 +++++++++++++++++++ 7 files changed, 166 insertions(+), 13 deletions(-) create mode 100644 images/discussion-logo.png create mode 100644 images/github-logo.png create mode 100644 images/gmail-logo.png delete mode 100644 images/mail.jpg diff --git a/README.md b/README.md index 22244fc1..a8e8049f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -# AI on the Edge Device: Digitizing Your non-digital meters with an ESP32-CAM +

AI on the Edge Device: Digitizing Your non-digital meters with an ESP32-CAM

+
+
+ +## Table of Contents +- [Key Features πŸš€](#key-features-) +- [Workflow πŸ”§](#workflow-) +- [Impressions πŸ“·](#impressions-) + - [AI-on-the-edge-device on a Water Meter πŸ’§](#ai-on-the-edge-device-on-a-water-meter-) + - [Web Interface (Water Meter) πŸ’»](#web-interface-water-meter-) + - [AI-on-the-edge-device on an Electrical Power Meter ⚑](#ai-on-the-edge-device-on-an-electrical-power-meter-) +- [Setup πŸ› οΈ](#setup-%EF%B8%8F) +- [Download πŸ”½](#download-) +- [Flashing the ESP32 πŸ’Ύ](#flashing-the-esp32-) +- [Flashing the SD Card πŸ’Ύ](#flashing-the-sd-card-) +- [Casing πŸ› οΈ](#casing-%EF%B8%8F) +- [Donate β˜•](#donate-) +- [Support πŸ’¬](#support-) +- [Changes and History πŸ“œ](#changes-and-history-) +- [Build It Yourself πŸ”¨](#build-it-yourself-) +- [Tools πŸ› οΈ](#tools-%EF%B8%8F) +- [Additional Ideas πŸ’‘](#additional-ideas-) +- [Our Contributors ❀️](#our-contributors-%EF%B8%8F) + +

+ + Back to Top + +

+ + + [![made-with-c++](https://img.shields.io/badge/Made%20with-C++-1f425f.svg)](https://github.com/jomjol/AI-on-the-edge-device/tree/main/code) [![Doc](https://img.shields.io/badge/Doc-MkDocs-526CFE.svg)](https://jomjol.github.io/AI-on-the-edge-device-docs/) @@ -20,6 +51,8 @@ All you need is an [ESP32 board with a supported camera](https://jomjol.github.i --- +
+ ## Key Features πŸš€ - πŸ”— **Tensorflow Lite (TFLite) integration** – including an easy-to-use wrapper. - πŸ“Έ **Inline image processing** (feature detection, alignment, ROI extraction). @@ -32,6 +65,8 @@ All you need is an [ESP32 board with a supported camera](https://jomjol.github.i - πŸ“‘ **MQTT protocol** support. - πŸ“₯ **REST API** available for data access. +
+ ## Workflow πŸ”§ The device captures a photo of your meter at set intervals. It then extracts the Regions of Interest (ROIs) from the image and runs them through artificial intelligence. As a result, you get the digitized value of your meter. @@ -46,25 +81,31 @@ There are several options for what to do with that value: --- +
+ ## Impressions πŸ“· -### AI-on-the-edge-device on a Water Meter πŸ’§ -

- -

++ ### AI-on-the-edge-device on a Water Meter πŸ’§ +

+ +

-### Web Interface (Water Meter) πŸ’» -

- -

++ ### Web Interface (Water Meter) πŸ’» +

+ +

-### AI-on-the-edge-device on an Electrical Power Meter ⚑ -

- -

++ ### AI-on-the-edge-device on an Electrical Power Meter ⚑ +

+ +

--- +
+ ## Setup πŸ› οΈ There is growing [documentation](https://jomjol.github.io/AI-on-the-edge-device-docs/) which provides you with a lot of information. Head there to get started, set it up, and configure it. @@ -86,11 +127,15 @@ For further background information, head to: --- +
+ ## Download πŸ”½ The latest available version can be found on the [Releases page](https://github.com/jomjol/AI-on-the-edge-device/releases). --- +
+ ## Flashing the ESP32 πŸ’Ύ Initially, you will have to flash the ESP32 via a USB connection. Later updates are possible directly over the air (OTA using Wi-Fi). @@ -104,6 +149,8 @@ See the [documentation](https://jomjol.github.io/AI-on-the-edge-device-docs/Inst --- +
+ ## Flashing the SD Card πŸ’Ύ The SD card can be set up automatically after the firmware is installed. See the [documentation](https://jomjol.github.io/AI-on-the-edge-device-docs/Installation/#remote-setup-using-the-built-in-access-point) for details. For this to work, the SD card must be FAT formatted (which is the default on a new SD card). @@ -111,6 +158,8 @@ Alternatively, the SD card can still be set up manually. See the [documentation] --- +
+ ## Casing πŸ› οΈ Various 3D-printable housings can be found here: - πŸ’§ [Water Meter](https://www.thingiverse.com/thing:4573481) @@ -120,6 +169,8 @@ Various 3D-printable housings can be found here: --- +
+ ## Donate β˜• If you'd like to support the developer with a cup of coffee, you can do so via [PayPal](https://www.paypal.com/donate?hosted_button_id=8TRSVYNYKDSWL). @@ -129,6 +180,8 @@ If you'd like to support the developer with a cup of coffee, you can do so via [ --- +
+ ## Support πŸ’¬ If you have any technical problems, please search the [discussions](https://github.com/jomjol/AI-on-the-edge-device/discussions). In case you find a bug or have a feature request, please open an [issue](https://github.com/jomjol/AI-on-the-edge-device/issues). @@ -139,27 +192,37 @@ For any other issues, you can contact the developer via email: --- +
+ ## Changes and History πŸ“œ See the [Changelog](Changelog.md) for detailed information. --- +
+ ## Build It Yourself πŸ”¨ See the [Build Instructions](code/README.md) for step-by-step guidance. --- +
+ ## Tools πŸ› οΈ * Logfile downloader and combiner (Thanks to [reserve85](https://github.com/reserve85)) * It can be found at ['/tools/logfile-tool'](https://github.com/jomjol/AI-on-the-edge-device/tree/main/tools/logfile-tool). --- +
+ ## Additional Ideas πŸ’‘ There are some ideas and feature requests which are not currently being pursuedβ€”mainly due to capacity constraints on the part of the developers. These features are collected in the [issues](https://github.com/jomjol/AI-on-the-edge-device/issues) and in [FeatureRequest.md](FeatureRequest.md). --- +
+ ## Our Contributors ❀️ diff --git a/docs/index.html b/docs/index.html index b362866c..27e1b032 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,6 +3,29 @@ + @@ -34,5 +57,27 @@

Installer and Console powered by ESP Web Tools

+ +
+
+ Support & Contact Us + + GitHub + + Email + + + GitHub + + +
+
+ Donations + + PayPal + +
+
+ diff --git a/images/discussion-logo.png b/images/discussion-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..53eaded3ee37a6e83faa1ae8e8424257e95e5e25 GIT binary patch literal 1076 zcmV-41k3x0P)*edw2A~6a| zv1(MjP_gw=X%U}n8#5zVP+zn~BDA%!ctZ;HNn7jAq!^#PK3J<(vDiyyf=DY33N1-i z&cC~<#B7q?Kac(3hn<;o=6rkR%=spY&R_;)v)QXit^+VYGLZa-ohOGplr{G?DQoK>&CQtA;o z5|WQLM1bTr07u%|+Ae5lgYq74N|7q1F00pZVWr?6ic%nx$y`kGILY;OIRfaFYu3@x zadsL4mA(1^9IVTUWRc|C(Hx-t>TB+lT3FS$`{^~iemQ4WPAK2?HPvzVj#9I6VS~2e zCHXCLrZ^1a{9DEj-CecowL{Ca^ILoNgt$7_adT&j5Lo&8&QW8-@5cFiW<%g)<<2KC zZm7$+P?E3L4&Nqo5=h3{hU2I0{9lQk4O^;nnM~$9A#i=6>j`6hzqWqd*zj6ZD%I{0 z07jHjD<(GH6E4>_{A67CaowO#Dq8-z1lKlfp0KlFi_94}ytF#k($cb^(jk{6#Eanp z?ZU}~L@ki~zS7B3BaY+6LO>~%{}0gz%b7TRe3LWKC%t_x2mp8?+HB22kl?%Ju= zwev+|{Rg!OY!GQp5xiB}Fn~8|*%<4!w*J>C7fJ3U`B9_6rTa-8<@5RTYZC~MY3oO( zTm*0gz}o6qDV3S-El@#|Twm$`0KRK&ZM}3lV_o#iwF`g$Z=t1fcSX;oC6n}(v25JO z{Gz2x3U_4k`TTqloH&k`2w9Rp%b82sv)SyqGmw=U=+!P9m};$=zPveAZZh%D8ZUy}psC zT3J}a_NYM^=QkSX4?g)#sWHj#9q{)iV&p=1V+6ui+WJjV8ffb`CBo7`8nyNBYZrE> zA`q2I^AZx)k82m+U2hLxS<6&Z)a)I;$?W>`LKzzyRvR0R8B=OXMFR1we?P0 zZ^}(3tS~OTXj~Xf`hId`eoR}x&p7{?jMsi~XhCWM0#P-QS>ybNqH@w;jP)n93;T@? u?}+p!uPAv(IRC1o-#Gt5;(P{C8UF%&rsW+D(zGl90000*#!_Vxk2K+FRa6LAAl+na5`s^nEtH->>mphEnPi1&`FCI7a~$f$O2H~!Qk z`Lm*vT17N19P|kuQsh`R8O{}kV}j{a$`dyQ-zvcU0l{+B2~%*&V`KSIt>RG8Dy;z5 z5ljtIo>x=wodP@&5IimAxi!OOopgtoGxuoA2F|2iX2gsDSw}4 zH1IcI2bcvqC13t|4%h?U72XWc~*J*R{A{>FLs3i&M5xM@zsr@BoZi?Cf#{bdi7xi}tz`n&iYJgH$Rj zKSo=?mj(C}*aboqQ6X_{R%-q)^D*ls@n`x44qf}Ej+vsH00000NkvXXu0mjf+bGax literal 0 HcmV?d00001 diff --git a/images/gmail-logo.png b/images/gmail-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9eaa1a5c1b509f713ffde60b0ddd30bdb84f6bde GIT binary patch literal 514 zcmV+d0{#7oP))v@`)u6}VxB_1lSXE#}gC{W1q)vF!OKH%s$Hbyiihp1z=ANPztIdhslcPK9ARki%>%bug-VX(TEL1h0#+13 z4~ibRroa^qKG?U^;6)OgXaxFcu8(_%CRi)08ic;zVFeHvU$ zfeQ+}a}7`uoDY3k28*u2As@^rux!2lQ^Eq4<*ekG9&Ld`9e~TqF?i+xrNEdgwqBRPhqwPt54SOudhDFvX}dVWiOWoXS-d|f&Qny0gX_+FxwvgjsO4v07*qoM6N<$ Eg5kK_761SM literal 0 HcmV?d00001 diff --git a/images/mail.jpg b/images/mail.jpg deleted file mode 100644 index 41fa094e24779bc01052da2d91e502302c5187e7..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3509 zcmbW3c{tQx`^P_HjIlF}Wg?P2sW6G`vio6_B1_gn8CopE^tCk+g|8G}(}V1Z$Q~y9 zn2ddAlre^u5zUOHDdN%dJlFHPuHRqJ^LwBB{B`bgpZDv!&vmY|KfAvOh}v1%S^*#s z2*4Z+V1FJs2Y|V_e#e2h4+6pqfpBv}_@Pi9UO|3AK>>aN0U=>AQ6XWNuz-N5q$o@r zE+HWyC?X{-36~awOTd2@0f7(pa6|YY5I(q&fDrt@)_x}d;{}d@c)*~e02d4dhJp5b z0eJubK@QyhHvBJvxDGt>KzaH21r8D#MFB1l7|g{D{_Xl8`;UWlfExx8Q_wQw5qI{5 z9=!$EPRK0eRWz^dk~lxcRMPRgoyf;8DJ6|Kq^zQ zE?#nVyX@{CaP?YXQ1JCT;SrHhnCO^$xcf=T4^mPeXFYkEo%2^NzNomQw5G+{Pf_PQQ^N1| z7{8a+v0D@r9LG!>czy$bpp(u4j)0;k>>%Zg`*V7u6 zOfXw=z*;<3Zhbwj=@&JpWPkJ>V%b6K(#V=VZD)v=@l!sT;Iwo@ zCc^(k)6;Twv{sG*Jue{K*w1G@-Dq7;uM4rN!fAY7wZQ9fEq_l$THi~XF$c=v;wiYZ zek9)6$<)#29UMe)_M9%K51H7qJ|@%D3tQ0Eu8l2ii7ppUy)^Y-kj;LlI_T*mm#kNP zq1Ri!VMyG0l2*^0Ng>$!m$X?{Fj_Sehi+VBXfy0>Ua32O$7v{BNzPXTPpZ|(P45Op z)I6f{DUU@&movBP%NS7}=#Rb-%7en7yd1rdP^ExdS>weV4?1ydQ$D42Bqbtx-f{e{ zQ=BxOVV(2tek3{#s*2Eaah_Zh4g${w)gYPQNoW&SmP%d`BVUH4iYuS8Kar!`5%4GR zF1eJfU@Kd^25GW^y%v!@l;}hew|dt5vpG3DPr#cc+*s=UD`|VezAQ+|)j0-~hxtl^EK!o74<1NN!ho+g^ZbtZSYKRmP*$yS@4z%18#e{mC6K@+50U zVwfQ>(clf{m~;mYOgFB6@S9dB{nEq|$g}$n(~t}`PlP9~55DAEW~+h6UQ~;8?E?s8 zoP>QP#cP%kD>=3K7i4PtX^lsf4iPl00zr(?4ctPleRz*7PKogC-puH8Pr_##^RdEX zbW86A*Lb>FG~HG>KcFBN{8Tid3p4X#>$!-15n;ZUDjO26c?UJVNfp9m5$nF-gzV5< z{VJ*bsY$b6*(%>D=inJwz{>jQ8~KcaL#hO($h|;ji2Gh)8K?4m1CEg|$1W=Py539B zYN%6459D_V*VwpS4hL--NzfJ$(~Sn+QXHL53jF6@E^mEK?;+~0QqDQlq+c_2g&4%P zVJ{MJ%ayv4+91SGM7utRxDW6e7e?_hT^~ja*z5JqxTk0N%FK5^ixLxjTx^@r57Wqe ziFNg>bB|GGLX9SpjS)mZ3^2s=-csQ;X}~w zvt^aVt7pA;mBkEWB8o|n-gOIyV?s^rcYK+yE4*$iN#+~zBB&w)ettV`JYe!f1GYvG zQ|!oc396gtgnsPP!D3;<%Ee-|j^IkGM7u9vp1s~m#NG06 z(&DZP40)v#GOM@Ytn(MzC%7fZfI!2Kh zLY%C=m~1?pp-!9ETd~(9BQ9BI+f25c7w$biyJjkvYkAZ71cz9Tar|UAQ9Ks$HmdjR z(+&!4H2m2`Yy-~!&cNGoy(eN)C+MmPS+<3{!J}Iv0-T4glK8y)Bgy_zQ%LNNuh3S7 z+u$=hNlKI&xvtjg>m-OecEyz1@IA@5ethdjp2n3rX7=;i=-6X#>MbXnOTd0@Kc00e z-QUoa?l;t5b&s(orJY2vB6FWFaN>I1q1!DH;}M6i5Ph2_5vUdmg@IzYVAoX(C3X72 zi%C{1isxs2!+q{x5@M0zoo}DZ3u(|=o(;fYAoS*q~F1ux+&Om+eu%TutN2*hYlhZ>L zzw5s=0$F`nsK6t(!!D%v(wKxSDPzv*O8faUc|`h~Ke0ID$QMZp`pB>%yXA zF0BD?#6z{3xv;o^J!Rwb!XMn>4Bl@OU%IH2(iuK=mML~m?u5#MHtVSy|Qck52UnTXS3$Z(*h4?^-gmNceF=ti-+U zj1sTw0^&B=V&o>awNjheoD6TS{U$Wj=`=(B5W!$+1c6c6=~pmd-`3r3y5cz_4xs9xyr4U2vPIdV_fQxSt0Ze+vl7swG zdEcC&caaUHAhE$)&@1?RYXi!_ooajh#h#0`d^>NZmVvg8ioT(%CQV)@$QZ$jN%TaBhRBb)ODbJN(tO}N7o)>?AtmwmtwWxs-MxUB2sCJIWr8N4UVluF-?@@1VQ zE*xVzd{}S3Rq{MV^@4ShI?kTU5P1Iu!P3;{G6?Mes!*G*^1pnb{zBqLumSe%NXCL+b`%{9dc) zL-V=MoD`aRt>v+jo7Df<>O9|~C=|P-!d#nqU=rxfu{z;9X=or^Xc+THFZ!c;8uH6i z$3IM^jW+Nfm>G$CD!W>v%gmAFB4&PNNog;e!l2}>3`%KL)e#EbHrsez_3>Q6RkR^G zt3T14;-Nhz2cHqEO@=F<(#)ANvEJFr`Ip@+9NyYR!-)oga0Ym7=;eg9~qD|K{U5dT^8a zV%1oia(ZFO6K=cC9jveAy+2)Ye#RD*x|7N;%j-vHW{c=bzBhkqIG>{AvpDnoI+d** zJ8rVg)3^_e^J#o0tAWV`36{7uGcdkgJos#ur{<>zRj)!qEKVU)uS#|ev!Ucu + @@ -146,6 +170,27 @@ Loading version... +
+
+ Support & Contact Us + + GitHub + + Email + + + GitHub + + +
+
+ Donations + + PayPal + +
+
+