mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-07 00:09:51 +03:00
added 2.0.1
This commit is contained in:
proddy
60
README.md
60
README.md
@@ -1,19 +1,25 @@
|
||||
# 
|
||||
|
||||
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)
|
||||
<br />
|
||||
[](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)
|
||||
<br>
|
||||
|
||||
EMS-ESP is a open-source firmware for the Espressif ESP8266 microcontroller that can communicate with **EMS** (Energy Management System) based boilers, thermostats and other modules from manufacturers like Bosch, Buderus, Nefit, Junkers, Worcester and Sieger.
|
||||
If you like **EMS-ESP**, please give it a star, or fork it and contribute!
|
||||
|
||||
EMS-ESP is the software. It still requires a hardware circuit that can convert the EMS data into Serial data. These can be purchased via https://bbqkees-electronics.nl/.
|
||||
[](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 purchased at https://bbqkees-electronics.nl/.
|
||||
|
||||
<img src="media/gateway-integration.jpg" width=40%>
|
||||
|
||||
@@ -21,7 +27,7 @@ EMS-ESP is the software. It still requires a hardware circuit that can convert t
|
||||
|
||||
## **New Features in version 2**
|
||||
|
||||
- Supporting both ESP8266 and ESP32 microcontrollers
|
||||
- Support for both ESP8266 and ESP32 modules
|
||||
- A new multi-user Web interface (based on React/TypeScript)
|
||||
- A new Console, accessible via Serial and Telnet
|
||||
- Tighter security in both Web and Console. Admin privileges required to access core settings and commands.
|
||||
@@ -38,7 +44,7 @@ EMS-ESP is the software. It still requires a hardware circuit that can convert t
|
||||
| <img src="media/web_devices.PNG"> | <img src="media/web_mqtt.PNG"> |
|
||||
<img src="media/console.PNG" width=100% height=100%>
|
||||
|
||||
## **Migrating from version 1.9**
|
||||
## **Migrating from previous versions**
|
||||
|
||||
EMS-ESP will attempt to automatically migrate the 1.9 settings.
|
||||
|
||||
@@ -165,7 +171,6 @@ thermostat
|
||||
|
||||
```
|
||||
|
||||
----------
|
||||
## **MQTT commands**
|
||||
|
||||
All commands must be written as `{"cmd":<cmd> ,"data":<data>, "id":<n>}`.
|
||||
@@ -221,3 +226,44 @@ topic = *system_cmd*
|
||||
send <"0B XX XX ..">
|
||||
pin <gpio> <on|off|1|0|true|false>
|
||||
```
|
||||
|
||||
## Support Information
|
||||
|
||||
For a list of the EMS devices currently supported see BBQKees's [EMS device compatibility list](https://bbqkees-electronics.nl/ems-device-compatibility/).
|
||||
|
||||
If you're looking for support on **EMS-ESP** there are some options available:
|
||||
|
||||
### Documentation
|
||||
|
||||
* [Documentation Site](https://emsesp.github.io/docs): For information on how to build and upload the firmware
|
||||
* [FAQ and Troubleshooting](https://bbqkees-electronics.nl/wiki/gateway/troubleshooting.html): For information on common problems and solutions
|
||||
|
||||
### 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
|
||||
|
||||
## Contribute
|
||||
|
||||
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 missing [documentation](https://emsesp.github.io/docs) for features and devices
|
||||
|
||||
## 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
|
||||
|
||||
Reference in New Issue
Block a user