diff --git a/README.md b/README.md index 73c68a250..8d8f8ab59 100644 --- a/README.md +++ b/README.md @@ -2,22 +2,22 @@ **EMS-ESP** is an open-source firmware for the Espressif ESP8266 and ESP32 microcontroller that communicates with **EMS** (Energy Management System) based equipment from manufacturers like Bosch, Buderus, Nefit, Junkers, Worcester and Sieger. -This is the firmware for the ESP32. Compared to version 2 on the ESP8266, this version has - - Ethernet Support - - Pre-configured board layouts - - Writing values directly from the Web UI - - Mock API server for faster offline development - - Expose to more commands, via MQTT - - Improvements to Dallas sensors, Shower service +This is the firmware for the ESP32. Compared to version 2 for the ESP8266, this release has + +- Ethernet Support +- Pre-configured board layouts +- Writing values directly from the Web UI +- Mock API server for faster offline development +- Expose to more commands, via MQTT +- Improvements to Dallas sensors, Shower service + +This version is the latest development track, where as v2 is in maintenance mode. [![version](https://img.shields.io/github/release/emsesp/EMS-ESP32.svg?label=Latest%20Release)](https://github.com/emsesp/EMS-ESP32/blob/main/CHANGELOG.md) [![release-date](https://img.shields.io/github/release-date/emsesp/EMS-ESP32.svg?label=Released)](https://github.com/emsesp/EMS-ESP32/commits/main) [![license](https://img.shields.io/github/license/emsesp/EMS-ESP32.svg)](LICENSE) -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9441142f49424ef891e8f5251866ee6b)](https://www.codacy.com/gh/emsesp/EMS-ESP32/dashboard?utm_source=github.com&utm_medium=referral&utm_content=emsesp/EMS-ESP32&utm_campaign=Badge_Grade) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/9441142f49424ef891e8f5251866ee6b)](https://www.codacy.com/gh/emsesp/EMS-ESP32/dashboard?utm_source=github.com&utm_medium=referral&utm_content=emsesp/EMS-ESP32&utm_campaign=Badge_Grade) [![downloads](https://img.shields.io/github/downloads/emsesp/EMS-ESP32/total.svg)](https://github.com/emsesp/EMS-ESP32/releases) -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/emsesp/EMS-ESP32.svg)](http://isitmaintained.com/project/emsesp/EMS-ESP32 "Average time to resolve an issue") -[![Percentage of issues still open](http://isitmaintained.com/badge/open/emsesp/EMS-ESP32.svg)](http://isitmaintained.com/project/emsesp/EMS-ESP32 "Percentage of issues still open") -
[![chat](https://img.shields.io/discord/816637840644505620.svg?style=flat-square&color=blueviolet)](https://discord.gg/3J3GgnzpyT) If you like **EMS-ESP**, please give it a star, or fork it and contribute! @@ -26,13 +26,13 @@ If you like **EMS-ESP**, please give it a star, or fork it and contribute! [![GitHub forks](https://img.shields.io/github/forks/emsesp/EMS-ESP32.svg?style=social&label=Fork)](https://github.com/emsesp/EMS-ES32P/network) [![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.com/paypalme/prderbyshire/2) -Note, EMS-ESP requires a small hardware circuit that can convert the EMS bus data to be read by the microcontroller. These can be ordered at https://bbqkees-electronics.nl. +Note, EMS-ESP requires a small hardware circuit that can convert the EMS bus data to be read by the microcontroller. These can be ordered at . --- -## **Features** +# **Features** - Compatible with both ESP8266 and ESP32 - A multi-user secure web interface to change settings and monitor the data @@ -41,67 +41,97 @@ Note, EMS-ESP requires a small hardware circuit that can convert the EMS bus dat - Can run standalone as an independent WiFi Access Point or join an existing WiFi network - Easy first-time configuration via a web Captive Portal - Support for more than [70 EMS devices](https://emsesp.github.io/docs/#/Supported-EMS-Devices) (boilers, thermostats, solar modules, mixer modules, heat pumps, gateways) + +## **Demo** + +See a live demo on [here](https://ems-esp.derbyshire.nl). The data you see is static and any username/password is accepted. + +# **Screenshots** + +## Web Interface + +| | | +| ---------------------------------- | -------------------------------- | +| | | +| | | + +## Telnet Console + + + +## In Home Assistant + + -## **Screenshots** - -### Web Interface: - -| | | -| --- | --- | -| | | -| | | - -### Telnet Console: - - -### In Home Assistant: - - -## **Installing** +# **Installing** Refer to the [official documentation](https://emsesp.github.io/docs) to how to install the firmware and configure it. The documentation is being constantly updated as new features and settings are added. You can choose to use an pre-built firmware image or compile the code yourself: -* [Uploading a pre-built firmware build](https://emsesp.github.io/docs/#/Uploading-firmware) -* [Building the firmware from source code and flashing manually](https://emsesp.github.io/docs/#/Building-firmware) +- [Uploading a pre-built firmware build](https://emsesp.github.io/docs/#/Uploading-firmware) +- [Building the firmware from source code and flashing manually](https://emsesp.github.io/docs/#/Building-firmware) -## **Support Information** +# **Support Information** If you're looking for support on **EMS-ESP** there are some options available: -### Documentation +## Documentation -* [Official EMS-ESP Documentation](https://emsesp.github.io/docs): For information on how to build and upload the firmware -* [FAQ and Troubleshooting](https://emsesp.github.io/docs/#/Troubleshooting): For information on common problems and solutions. See also [BBQKees's wiki](https://bbqkees-electronics.nl/wiki/gateway/troubleshooting.html) +- [Official EMS-ESP Documentation](https://emsesp.github.io/docs): For information on how to build and upload the firmware +- [FAQ and Troubleshooting](https://emsesp.github.io/docs/#/Troubleshooting): For information on common problems and solutions. See also [BBQKees's wiki](https://bbqkees-electronics.nl/wiki/gateway/troubleshooting.html) -### Support Community +## Support Community -* [Discord Server](https://discord.gg/3J3GgnzpyT): For support, troubleshooting and general questions. You have better chances to get fast answers from members of the community -* [Search in Issues](https://github.com/emsesp/EMS-ESP32/issues): You might find an answer to your question by searching current or closed issues +- [Discord Server](https://discord.gg/3J3GgnzpyT): For support, troubleshooting and general questions. You have better chances to get fast answers from members of the community +- [Search in Issues](https://github.com/emsesp/EMS-ESP32/issues): You might find an answer to your question by searching current or closed issues -### Developer's Community +## Developer's Community -* [Bug Report](https://github.com/emsesp/EMS-ESP32/issues/new?template=bug_report.md): For reporting Bugs -* [Feature Request](https://github.com/emsesp/EMS-ESP32/issues/new?template=feature_request.md): For requesting features/functions -* [Troubleshooting](https://github.com/emsesp/EMS-ESP32/issues/new?template=questions---troubleshooting.md): As a last resort, you can open new *Troubleshooting & Question* issue on GitHub if the solution could not be found using the other channels. Just remember: the more info you provide the more chances you'll have to get an accurate answer +- [Bug Report](https://github.com/emsesp/EMS-ESP32/issues/new?template=bug_report.md): For reporting Bugs +- [Feature Request](https://github.com/emsesp/EMS-ESP32/issues/new?template=feature_request.md): For requesting features/functions +- [Troubleshooting](https://github.com/emsesp/EMS-ESP32/issues/new?template=questions---troubleshooting.md): As a last resort, you can open new _Troubleshooting & Question_ issue on GitHub if the solution could not be found using the other channels. Just remember: the more info you provide the more chances you'll have to get an accurate answer -## **Contributing** +# **Contributors ✨** + +EMS-ESP is a project originally created by [proddy](https://github.com/proddy) with the main contributors and owners: + + + + + + + + + + +
+ +
proddy
+
+ v2 + v3 +
+
MichaelDvP

v2 + v3 +
+ + + +You can also contribute to EMS-ESP by -You can contribute to EMS-ESP by - providing Pull Requests (Features, Fixes, suggestions) - testing new released features and report issues on your EMS equipment - contributing to missing [Documentation](https://emsesp.github.io/docs) -## **Credits** +# **Libraries used** -A shout out to the people helping EMS-ESP get to where it is today... -- **@MichaelDvP** for all his amazing contributions and patience. Specifically for the improved uart library, thermostat and mixer logic. -- **@BBQKees** for his endless testing and building the awesome circuit boards -- **@rjwats** for his [esp8266-react](https://github.com/rjwats/esp8266-react) framework that provides the new Web UI -- **@nomis** for his core [console](https://github.com/nomis/mcu-uuid-console), telnet and syslog core libraries -- plus everyone else providing suggestions, PRs and the odd donation that keeps this project open source. Thanks! +- [esp8266-react](https://github.com/rjwats/esp8266-react) by @rjwats for the framework that provides the Web UI +- [uuid-\*](https://github.com/nomis/mcu-uuid-console) from @nomis. The console, syslog, telnet and logging is based on these libraries +- [ArduinoJson](https://github.com/bblanchon/ArduinoJson) +- [AsyncMqttClient](https://github.com/marvinroger/async-mqtt-client) for MQTT, with modifications from @bertmelis +- ESPAsyncWebServer and AsyncTCP for the Web and TCP backends, with custom modifications for performance -## **License** +# **License** This program is licensed under GPL-3.0 diff --git a/media/console.png b/media/console.png new file mode 100644 index 000000000..8b4a79ccb Binary files /dev/null and b/media/console.png differ diff --git a/media/ha_lovelace.PNG b/media/ha_lovelace.png similarity index 100% rename from media/ha_lovelace.PNG rename to media/ha_lovelace.png diff --git a/media/web_devices.PNG b/media/web_devices.PNG deleted file mode 100644 index 84d13bf3d..000000000 Binary files a/media/web_devices.PNG and /dev/null differ diff --git a/media/web_devices.png b/media/web_devices.png new file mode 100644 index 000000000..2528424ff Binary files /dev/null and b/media/web_devices.png differ diff --git a/media/web_mqtt.PNG b/media/web_mqtt.PNG deleted file mode 100644 index 16e3a2cea..000000000 Binary files a/media/web_mqtt.PNG and /dev/null differ diff --git a/media/web_mqtt.png b/media/web_mqtt.png new file mode 100644 index 000000000..96e450eaf Binary files /dev/null and b/media/web_mqtt.png differ diff --git a/media/web_settings.PNG b/media/web_settings.PNG deleted file mode 100644 index d47d96561..000000000 Binary files a/media/web_settings.PNG and /dev/null differ diff --git a/media/web_settings.png b/media/web_settings.png new file mode 100644 index 000000000..0fe812c8b Binary files /dev/null and b/media/web_settings.png differ diff --git a/media/web_status.PNG b/media/web_status.PNG deleted file mode 100644 index 5ddbae124..000000000 Binary files a/media/web_status.PNG and /dev/null differ diff --git a/media/web_status.png b/media/web_status.png new file mode 100644 index 000000000..a7646ba45 Binary files /dev/null and b/media/web_status.png differ