mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-06 07:49:52 +03:00
91 lines
5.5 KiB
Markdown
91 lines
5.5 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.
|
|
|
|
[](https://github.com/proddy/EMS-ESP/blob/master/CHANGELOG.md)
|
|
[](https://github.com/proddy/EMS-ESP/commits/master)
|
|
[](LICENSE)
|
|
[](https://travis-ci.com/proddy/EMS-ESP)
|
|
[](https://app.codacy.com/app/proddy/EMS-ESP?utm_source=github.com&utm_medium=referral&utm_content=proddy/EMS-ESP&utm_campaign=Badge_Grade_Settings)
|
|
[](https://github.com/proddy/EMS-ESP/releases)
|
|
[](http://isitmaintained.com/project/proddy/EMS-ESP "Average time to resolve an issue")
|
|
[](http://isitmaintained.com/project/proddy/EMS-ESP "Percentage of issues still open")
|
|
<br/>
|
|
[](https://gitter.im/EMS-ESP/community)
|
|
|
|
If you like **EMS-ESP**, please give it a star, or fork it and contribute!
|
|
|
|
[](https://github.com/proddy/EMS-ESP/stargazers)
|
|
[](https://github.com/proddy/EMS-ESP/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**
|
|
|
|
- Support for both ESP8266 and ESP32 modules
|
|
- A multi-user secure Web interface (based on React/TypeScript and Material-UI)
|
|
- A Console, accessible via Serial and Telnet
|
|
- Native support for Home Assistant [MQTT Discovery](https://www.home-assistant.io/docs/mqtt/discovery/) (in development)
|
|
- Can be run standalone as an independent Access Point or join an existing WiFi network
|
|
- Easy first-time configuration via a web Captive Portal
|
|
- Supporting over [70 EMS](https://emsesp.github.io/docs/#/Supported-EMS-Devices) devices (boilers, thermostats, solar modules, mixing modules, heat pumps, gateways)
|
|
|
|
## **Screenshots**
|
|
|
|
| | |
|
|
| --- | --- |
|
|
| <img src="media/web_settings.PNG"> | <img src="media/web_status.PNG"> |
|
|
| <img src="media/web_devices.PNG"> | <img src="media/web_mqtt.PNG"> |
|
|
<img src="media/console.PNG" width=80% height=80%>
|
|
|
|
## **Installing**
|
|
|
|
Refer to the [Official documentation](https://emsesp.github.io/docs) to install the firmware and configure it.
|
|
|
|
* [Uploading a pre-built binary](https://emsesp.github.io/docs/#/Uploading-firmware)
|
|
* [Building the firmware 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 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's Community
|
|
|
|
* [EMS-ESP Support Chat](https://gitter.im/EMS-ESP/community#): 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/proddy/EMS-ESP/issues): You might find an answer to your question by searching current or closed issues
|
|
|
|
### Developers' Community
|
|
|
|
* [Bug Report](https://github.com/proddy/EMS-ESP/issues/new?template=bug_report.md): For reporting Bugs
|
|
* [Feature Request](https://github.com/proddy/EMS-ESP/issues/new?template=feature_request.md): For requesting features/functions
|
|
* [Troubleshooting](https://github.com/proddy/EMS-ESP/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**
|
|
|
|
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**
|
|
|
|
A shout out to the people helping EMS-ESP get to where it is today
|
|
- @MichaelDvP for all his amazing contributions and patience. The core UART code is his.
|
|
- @BBQKees for his endless testing and building the awesome circuits
|
|
- @susisstrolch for writing a first working version of the EMS bridge circuit which I used to design EMS-ESP version 0.1
|
|
- Plus many more providing suggestions, PRs and Donations. Thanks!
|
|
|
|
## **License**
|
|
|
|
This program is licensed under GPL-3.0
|