mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-06 07:49:52 +03:00
138 lines
7.4 KiB
Markdown
138 lines
7.4 KiB
Markdown
# 
|
|
|
|
**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 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.
|
|
|
|
[](https://github.com/emsesp/EMS-ESP32/blob/main/CHANGELOG.md)
|
|
[](https://github.com/emsesp/EMS-ESP32/commits/main)
|
|
[](LICENSE)
|
|
[](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)
|
|
[](https://github.com/emsesp/EMS-ESP32/releases)
|
|
[](https://discord.gg/3J3GgnzpyT)
|
|
|
|
If you like **EMS-ESP**, please give it a star, or fork it and contribute!
|
|
|
|
[](https://github.com/emsesp/EMS-ESP32/stargazers)
|
|
[](https://github.com/emsesp/EMS-ES32P/network)
|
|
[](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>.
|
|
|
|
<img src="media/gateway-integration.jpg" width=40%>
|
|
|
|
---
|
|
|
|
# **Features**
|
|
|
|
- Compatible with both ESP8266 and ESP32
|
|
- A multi-user secure web interface to change settings and monitor the data
|
|
- A console, accessible via Serial and Telnet for more monitoring
|
|
- Native support for Home Assistant via [MQTT Discovery](https://www.home-assistant.io/docs/mqtt/discovery/)
|
|
- 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
|
|
|
|
| | |
|
|
| ---------------------------------- | -------------------------------- |
|
|
| <img src="media/web_settings.png"> | <img src="media/web_status.png"> |
|
|
| <img src="media/web_devices.png"> | <img src="media/web_mqtt.png"> |
|
|
|
|
## Telnet Console
|
|
|
|
<img src="media/console.png" width=80% height=80%>
|
|
|
|
## In Home Assistant
|
|
|
|
<img src="media/ha_lovelace.png" width=80% height=80%>
|
|
|
|
# **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)
|
|
|
|
# **Support Information**
|
|
|
|
If you're looking for support on **EMS-ESP** there are some options available:
|
|
|
|
## 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)
|
|
|
|
## 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
|
|
|
|
## 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
|
|
|
|
# **Contributors ✨**
|
|
|
|
EMS-ESP is a project originally created by [proddy](https://github.com/proddy) with the main contributors and owners:
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tr>
|
|
<td align="center">
|
|
<a href="https://derbyshire.nl"><img src="https://avatars.githubusercontent.com/u/1230712?v=3?s=100" width="100px;" alt=""/>
|
|
<br/><sub><b>proddy</b></sub></a>
|
|
<br/>
|
|
</a> <a href="https://github.com/emsesp/EMS-ESP/commits?author=proddy" title="v2 Commits">v2</a>
|
|
<a href="https://github.com/emsesp/EMS-ESP32/commits?author=proddy" title="v3 Commits">v3</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://github.com/MichaelDvP"><img src="https://avatars.githubusercontent.com/u/59284019?v=3?s=100" width="100px;" alt=""/><br /><sub><b>MichaelDvP</b></sub></a><br /></a> <a href="https://github.com/emsesp/EMS-ESP/commits?author=MichaelDvP" title="v2 Commits">v2</a>
|
|
<a href="https://github.com/emsesp/EMS-ESP32/commits?author=MichaelDvP" title="v3 Commits">v3</a>
|
|
</td>
|
|
|
|
</tr>
|
|
</table>
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
You can also 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)
|
|
|
|
# **Libraries used**
|
|
|
|
- [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**
|
|
|
|
This program is licensed under GPL-3.0
|