diff --git a/README.md b/README.md index 6bba8ceb..e56dd980 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ There is also a web interface available on runtime, showing meter data in real t +## Hardware options +Look in [hardware section](/hardware) for more details about supported hardware + ## Release binaries In the [Release section](https://github.com/gskjold/AmsToMqttBridge/releases) of this repository, you will find precompiled binaries for some common boards. diff --git a/src/AmsToMqttBridge.ino b/src/AmsToMqttBridge.ino index dae6a981..e9436236 100644 --- a/src/AmsToMqttBridge.ino +++ b/src/AmsToMqttBridge.ino @@ -1,8 +1,20 @@ -/* - Name: AmsToMqttBridge.ino - Created: 3/13/2018 7:40:28 PM - Author: roarf -*/ +/** + * @brief ESP8266 based program to receive data from AMS electric meters and send to MQTT + * + * @details Originally developed by Roar Fredriksen, this program was created to receive data from + * AMS electric meters via M-Bus, decode and send to a MQTT broker. The data packet structure + * supported by this software is specific to Norwegian meters, but may also support data from + * electricity providers in other countries. It was originally based on ESP8266, but have also been + * adapted to work with ESP32. + * + * @author Roar Fredriksen (@roarfred) + * The original developer for this project + * https://github.com/roarfred/AmsToMqttBridge + * + * @author Gunnar Skjold (@gskjold) + * Maintainer of current code + * https://github.com/gskjold/AmsToMqttBridge + */ #include "AmsToMqttBridge.h" #include diff --git a/webui.jpg b/webui.jpg index 14eaa9db..ade99d80 100755 Binary files a/webui.jpg and b/webui.jpg differ