diff --git a/README.md b/README.md index 22244fc19..a8e8049fc 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 b362866c5..27e1b032c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,6 +3,29 @@ + @@ -34,5 +57,27 @@

Notes:

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 000000000..53eaded3e Binary files /dev/null and b/images/discussion-logo.png differ diff --git a/images/github-logo.png b/images/github-logo.png new file mode 100644 index 000000000..68cd13252 Binary files /dev/null and b/images/github-logo.png differ diff --git a/images/gmail-logo.png b/images/gmail-logo.png new file mode 100644 index 000000000..9eaa1a5c1 Binary files /dev/null and b/images/gmail-logo.png differ diff --git a/images/mail.jpg b/images/mail.jpg deleted file mode 100644 index 41fa094e2..000000000 Binary files a/images/mail.jpg and /dev/null differ diff --git a/sd-card/html/index.html b/sd-card/html/index.html index c9a78ccae..b1aeee590 100644 --- a/sd-card/html/index.html +++ b/sd-card/html/index.html @@ -69,6 +69,30 @@ return ""; } + @@ -146,6 +170,27 @@

An ESP32 all inclusive neural network recognition system for meter Digitizat Loading version... +
+
+ Support & Contact Us + + GitHub + + Email + + + GitHub + + +
+
+ Donations + + PayPal + +
+
+