From de5f74f7e280e031a9069052280d8e1618b401f7 Mon Sep 17 00:00:00 2001 From: Paul Date: Sat, 15 Jun 2019 09:24:22 +0200 Subject: [PATCH] updated doc --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ff0eb4222..2e32ecec8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ # EMS-ESP -EMS-ESP is a project to build an electronic controller circuit using an Espressif ESP8266 microcontroller to communicate with EMS (Energy Management System) based Boilers and Thermostats from the Bosch range and compatibles such as Buderus, Nefit, Junkers etc. +EMS-ESP is a open-source system to communicate with **EMS** (Energy Management System) based boilers, thermostats and other modules from manufacturers like Bosch, Buderus, Nefit, Junkers and Sieger. -There are 3 parts to this project, first the design of the circuit, secondly the code for the ESP8266 microcontroller firmware with telnet and MQTT support, and lastly an example configuration for Home Assistant to monitor the data and issue direct commands via a MQTT broker. +The code is writen for the Espressif **ESP8266** microcontroller and supports a telnet console for real-time monitoring and configuration and customizable MQTT support for publishing the information to a home automation system such as Home Assistant or Domoticz. + +----------- Please refer to the [Wiki](https://github.com/proddy/EMS-ESP/wiki) for further documentation. + +**An example of the Home Assistant integration:** + +![ha](https://github.com/proddy/EMS-ESP/raw/dev/doc/home_assistant/ha.png) + +**Using BBQKees' EMS Gateway circuit:** + +| ![on boiler](https://github.com/proddy/EMS-ESP/raw/dev/doc/ems%20gateway/on-boiler.jpg) | ![kit](https://github.com/proddy/EMS-ESP/raw/dev/doc/ems%20gateway/ems-kit-2.jpg) | ![basic circuit](https://github.com/proddy/EMS-ESP/raw/dev/doc/ems%20gateway/ems-board-white.jpg) | +| - | - | - | + +**Example of the Telnet console:** + +| ![telnet menu](https://github.com/proddy/EMS-ESP/raw/dev/doc/telnet/telnet_menu.jpg) | ![telnet menu](https://github.com/proddy/EMS-ESP/raw/dev/doc/telnet/telnet_stats.PNG) | +| - | - |