diff --git a/README.md b/README.md new file mode 100644 index 00000000..958d7948 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# OpenDTU + +## Background +This project was started from [this](https://www.mikrocontroller.net/topic/525778) discussion (Mikrocontroller.net). +It was the goal to replace the original Hoymiles DTU (Telemetry Gateway) with their cloud access. With a lot of reverse engineering the Hoymiles protocol was decrypted and analyzed. + + +## Features for end users +* Uses ESP32 mikrocontroller and NRF24L01+ +* Multi-Inverter support +* MQTT support +* Nice and fancy WebApp with visualisation of current data + +## Features for developers +* The mikrocontroller part + * Build with Arduino PlatformIO Framework for the ESP32 + * Uses [ESPAsyncWebserver](https://github.com/me-no-dev/ESPAsyncWebServer) and [Async MQTT client](https://github.com/marvinroger/async-mqtt-client) + +* The WebApp part + * Build with [Vue.js](https://vuejs.org) + +## Building +* Building the WebApp + * The WebApp can be build using yarn + ``` + $ yarn install + $ yarn build + ``` + * The updated output is placed in the 'data' directory + +* Building the mikrocontroller firmware + * Visual Studio Code with the PlatformIO Extension is required for building