From c461dcfd35ad70f9bdf5763956ec1edd77dc3b21 Mon Sep 17 00:00:00 2001 From: Paul Date: Sun, 12 Jan 2020 13:29:18 +0100 Subject: [PATCH] updated to point to wiki --- README.md | 46 ++++++++++++++++------------------------------ 1 file changed, 16 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index ad79ab171..774b1a468 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![logo](docs/_media/logo/EMS-ESP_logo_dark.png) +![logo](https://emsesp.github.io/docs/_media/logo/EMS-ESP_logo_dark.png) [![version](https://img.shields.io/github/release/proddy/EMS-ESP.svg?label=Latest%20Release)](https://github.com/proddy/EMS-ESP/blob/master/CHANGELOG.md) [![release-date](https://img.shields.io/github/release-date/proddy/EMS-ESP.svg?label=Released)](https://github.com/proddy/EMS-ESP/commits/master) @@ -10,42 +10,28 @@
[![gitter](https://img.shields.io/gitter/room/EMS-ESP/EMS-ESP.svg)](https://gitter.im/EMS-ESP/community)
-------------- -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. - -The code is written 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 reference the [Wiki](https://emsesp.github.io/docs) for further details and instructions on how to build and configure the firmware. - ---- +EMS-ESP is a open-source system built for the Espressif ESP8266 microcontroller to communicate with **EMS** (Energy Management System) based boilers, thermostats and other modules from manufacturers like Bosch, Buderus, Nefit, Junkers and Sieger. ## Features -#### A web interface for easy configuration and real-time monitoring of the EMS bus - -| ![web menu](docs/_media/web/system_status.PNG) | ![web menu](docs/_media/web/ems_dashboard.PNG) | -| -------------------------------------------------------- | ---------------------------------------------------------- | - -#### MQTT support for Home Assistant and Domoticz - -![ha](docs/_media/home%20assistant/ha.png) - -#### Telnet for advanced configuration and verbose traffic logging - -| ![telnet menu](docs/_media/telnet/telnet_menu.jpg) | ![telnet menu](docs/_media/telnet/telnet_stats.PNG) | -| ------------------------------------------------------------ | -------------------------------------------------------- | - -## Supported EMS devices - -More than **50** EMS 1.0 and 2.0 devices are currently supported. See the [complete list](https://proddy.github.io/EMS-ESP/#/Supported-EMS-Devices). +* Supporting more than [50 EMS devices](https://proddy.github.io/EMS-ESP/#/Supported-EMS-Devices) (EMS 1.0, 2.0 and Heatronics). +* A web interface for easy configuration and real-time monitoring of the EMS bus. +* Telnet for advanced configuration and verbose traffic logging. +* Configurable MQTT, with templates for Home Assistant and Domoticz. +* Includes an simple schematic for a test breadboard interface board. +* Native compatibility with bbqkees' [EMS Gateway](https://bbqkees-electronics.nl/) interface board. +Please reference the [Wiki](https://emsesp.github.io/docs) for further details and instructions on how to build and configure the firmware. --- -## Native compatibility with bbqkees' **EMS Gateway** +| ![web menu](https://emsesp.github.io/docs/_media/web/system_status.PNG) | ![web menu](https://emsesp.github.io/docs/_media/web/ems_dashboard.PNG) | +| - | - | +![ha](https://emsesp.github.io/docs/_media/home%20assistant/ha.png) -All firmware versions fully support BBQKees' [EMS Gateway](https://bbqkees-electronics.nl/) board with integrated Wemos D1 ESP8266. +| ![telnet menu](https://emsesp.github.io/docs/_media/telnet/telnet_menu.jpg) | ![telnet menu](https://emsesp.github.io/docs/_media/telnet/telnet_stats.PNG) | +| - | - | -| ![on boiler](docs/_media/ems%20gateway/on-boiler.jpg) | ![kit](docs/_media/ems%20gateway/ems-kit-2.jpg) | ![basic circuit](docs/_media/ems%20gateway/ems-board-white.jpg) | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- | +| ![on boiler](https://emsesp.github.io/docs/_media/ems%20gateway/on-boiler.jpg) | ![kit](https://emsesp.github.io/docs/_media/ems%20gateway/ems-kit-2.jpg) | ![basic circuit](https://emsesp.github.io/docs/_media/ems%20gateway/ems-board-white.jpg) | +| - | - | - |