diff --git a/README.md b/README.md index 7b960580..99ad135a 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,57 @@ -# AI-on-the-edge-device +# Welcome to the AI-on-the-edge-device +Artificial intelligence based systems have been established in our every days live. Just think of speech or image recognition. Most of the systems relay on either powerful processors or a direct connection to the cloud for doing the calculations up there. With the increasing power of modern processors the AI systems are coming closer to the end user - which is usually called **edge computing**. +Here this edge computing is brought into a practical oriented example, where a AI network is implemented on a ESP32 device so: **AI on the edge**. -This is an example of Artificial Intelligence (AI) calculations on a very cheap hardware. +This projects allows you to digitalize your **analoge** water, gas, power and other meters using cheap and easily available hardware. -### Details on **function**, **installation** and **configuration** can be found on the **[Wiki Page](https://github.com/jomjol/AI-on-the-edge-device/wiki)** +All you need is an [ESP32 board with a supported camera](wiki/Hardware-Compatibility) and a bit of a practical hand. + + + +## Key features +- **Small** and **cheap** device (3x4.5x2 cm³, < 10 EUR) +- camera and illumination integrated +- Web surface for administration and control +- OTA-Interface to update directly through the web interface +- API for easy integration +- Inline Image processing (feature detection, alignment, ROI extraction) +- Tensorflow Lite (TFlite) integration - including easy to use wrapper + +## Workflow +The device takes a photo of your meter at a defined interval. It then extracts the Regions of Interest (ROI's) out of it and runs them through an artificial inteligence. As a result, you get the digitalized value of your meter. + +There are several options what to do with that value. Either send it to a MQTT broker, write it to an InfluxDb or simply provide it throug a REST API. + + + +## Impressions +### AI-on-the-edge-device on a Water Meter + + +### Web Interface (Water Meter) + + +### AI-on-the-edge-device on a Electrical Power Meter + + + +## Setup +There is a growing [wiki](wiki) which provides you with a lot of information. +Head there to get a start, set it up and configure it. + +## Download +The latest available version is available on the [Releases page](releases). + +Initially you will have to flash it through an USB connection. Later an update is possible directly over the Air (OTA). + +### Casing A 3d-printable housing can be found here: - https://www.thingiverse.com/thing:4573481 (Water Meter) - https://www.thingiverse.com/thing:5028229 (Power Meter) - https://www.thingiverse.com/thing:4571627 (ESP32-Cam housing only) - - - - - - - - - ## Donate - ------- - If you would like to support the developer with a cup of coffee you can do that via [Paypal](https://www.paypal.com/donate?hosted_button_id=8TRSVYNYKDSWL).
@@ -33,9 +63,7 @@ If you have any technical topics, you can file a issue in this repository. In other cases you can contact the developer via email: - ------- -## Change log +## Changelog **General remark:** Besides the file `firmware.bin`, typically the content of `/html` will need to be updated! ------ @@ -99,21 +127,14 @@ In other cases you can contact the developer via email: