diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 26b44d849..6a0ddf1e1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,7 +9,7 @@ assignees: '' *Before creating a new issue please check that you have:* -* *searched the existing [issues](https://github.com/proddy/EMS-ESP/issues) (both open and closed)* +* *searched the existing [issues](https://github.com/emsesp/EMS-ESP32/issues) (both open and closed)* * *searched the [documentation help section](https://emsesp.github.io/docs)* *Completing this template will help developers and contributors to address the issue. Try to be as specific and extensive as possible. If the information provided is not enough the issue will likely be closed.* diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 192572738..696d63d8c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,7 +7,7 @@ assignees: '' --- -*Before creating a new feature request please check that you have searched the existing [issues](https://github.com/proddy/EMS-ESP/issues) (both open and closed)* +*Before creating a new feature request please check that you have searched the existing [issues](https://github.com/emsesp/EMS-ESP32/issues) (both open and closed)* *Completing this template will help developers and contributors evaluating the feature. If the information provided is not enough the issue will likely be closed.* diff --git a/.github/ISSUE_TEMPLATE/questions---troubleshooting.md b/.github/ISSUE_TEMPLATE/questions---troubleshooting.md index b2cde7b75..fa26a177b 100644 --- a/.github/ISSUE_TEMPLATE/questions---troubleshooting.md +++ b/.github/ISSUE_TEMPLATE/questions---troubleshooting.md @@ -9,7 +9,7 @@ assignees: '' *Before creating a new issue please check that you have:* -* *searched the existing [issues](https://github.com/proddy/EMS-ESP/issues) (both open and closed)* +* *searched the existing [issues](https://github.com/emsesp/EMS-ESP32/issues) (both open and closed)* * *searched the [documentation help section](https://emsesp.github.io/docs)* *Completing this template will help developers and contributors help you. Try to be as specific and extensive as possible. If the information provided is not enough the issue will likely be closed.* diff --git a/CHANGELOG_LATEST.md b/CHANGELOG_LATEST.md index e6aa45de2..8835f871c 100644 --- a/CHANGELOG_LATEST.md +++ b/CHANGELOG_LATEST.md @@ -42,7 +42,7 @@ - Updated to the latest ArduinoJson library - some names of mqtt-tags like in v2.2.1 - new ESP32 partition side to allow for smoother OTA and fallback -- Network Gateway IP is optional ([#682](https://github.com/proddy/EMS-ESP/issues/682)) +- Network Gateway IP is optional (#682) - moved to a new GitHub repo https://github.com/emsesp/EMS-ESP32 ### Removed diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30686acb8..f72d11fae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,10 +43,10 @@ A Pull Request (PR) is the process where code modifications are managed in GitHu The process is straight-forward. - Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0) - - Fork the EMS-ESP Repository [git repository](https://github.com/proddy/EMS-ESP). + - Fork the EMS-ESP Repository [git repository](https://github.com/emsesp/EMS-ESP32). - Write/Change the code in your Fork for a new feature, bug fix, new sensor, optimization, etc. - Ensure tests work. - - Create a Pull Request against the [**dev**](https://github.com/proddy/EMS-ESP/tree/dev) branch of EMS-ESP. + - Create a Pull Request against the [**dev**](https://github.com/emsesp/EMS-ESP32/tree/dev) branch of EMS-ESP. 1. All pull requests must be done against the dev branch. 2. Make sure code is formatting per the `.clang-format` diff --git a/README.md b/README.md index 3421837f4..afbedddbc 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,23 @@ # ![logo](media/EMS-ESP_logo_dark.png) -**EMS-ESP** is an open-source firmware for the Espressif microcontroller that communicates with **EMS** (Energy Management System) based equipment from manufacturers like Bosch, Buderus, Nefit, Junkers, Worcester and Sieger. +**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 ESP32 version. - - -[![license](https://img.shields.io/github/license/proddy/EMS-ESP.svg)](LICENSE) -[![chat](https://img.shields.io/discord/816637840644505620.svg?style=flat-square&color=blueviolet)](https://discord.gg/rqegzSrK) +This is the firmware for the ESP32. +[![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/76ce919e25494cdeab827a6525666be0)](https://www.codacy.com/gh/emsesp/EMS-ESP32/dashboard?utm_source=github.com&utm_medium=referral&utm_content=emsesp/EMS-ESP&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! -[![GitHub stars](https://img.shields.io/github/stars/proddy/EMS-ESP.svg?style=social&label=Star)](https://github.com/proddy/EMS-ESP/stargazers) -[![GitHub forks](https://img.shields.io/github/forks/proddy/EMS-ESP.svg?style=social&label=Fork)](https://github.com/proddy/EMS-ESP/network) +[![GitHub stars](https://img.shields.io/github/stars/emsesp/EMS-ESP32.svg?style=social&label=Star)](https://github.com/emsesp/EMS-ESP32/stargazers) +[![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. @@ -23,6 +28,7 @@ Note, EMS-ESP requires a small hardware circuit that can convert the EMS bus dat ## **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/) @@ -66,13 +72,13 @@ If you're looking for support on **EMS-ESP** there are some options available: ### 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/proddy/EMS-ESP/issues): You might find an answer to your question by searching current or closed issues +* [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/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 +* [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** diff --git a/RELEASENOTES.md b/RELEASENOTES.md index f1ac84fd9..9e4ad89d6 100644 --- a/RELEASENOTES.md +++ b/RELEASENOTES.md @@ -1,4 +1,4 @@ -# ![logo](https://github.com/proddy/EMS-ESP/blob/esp32_dev/media/EMS-ESP_logo_dark.png) +# ![logo](https://github.com/emsesp/EMS-ESP32/blob/main/media/EMS-ESP_logo_dark.png) # Firmware Installation diff --git a/RELEASENOTES_DEV.md b/RELEASENOTES_DEV.md index f538f3a5c..75d8a9422 100644 --- a/RELEASENOTES_DEV.md +++ b/RELEASENOTES_DEV.md @@ -1,4 +1,4 @@ -# ![logo](https://github.com/proddy/EMS-ESP/blob/esp32_dev/media/EMS-ESP_logo_dark.png) +# ![logo](https://github.com/emsesp/EMS-ESP32/blob/main/media/EMS-ESP_logo_dark.png) This is a snapshot of the current "beta" development code and firmware binaries for the ESP32. It has all the latest features and fixes but please be aware that this is still experimental firmware used for testing and thus may contain the odd bug. Use at your own risk and remember to report an issue if you find something unusual. diff --git a/interface/src/project/EMSESPHelp.tsx b/interface/src/project/EMSESPHelp.tsx index 4f6a1e4d4..3ddb857d9 100644 --- a/interface/src/project/EMSESPHelp.tsx +++ b/interface/src/project/EMSESPHelp.tsx @@ -43,7 +43,7 @@ class EMSESPHelp extends Component { - To report an issue or feature request go to {'click here'} + To report an issue or feature request go to {'click here'}