diff --git a/README.md b/README.md index a87dfaa3..897b69ec 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ -# AMS <-> MQTT Bridge -Orignally designed and coded by [@roarfred](https://github.com/roarfred), see the original repo at [roarfred/AmsToMqttBridge](https://github.com/roarfred/AmsToMqttBridge) +# AMS MQTT Bridge +This code is designed to decode data from electric smart meters installed in many countries in Europe these days. The data is presented in a graphical web interface and can also send the data to a MQTT broker which makes it suitable for home automation project. Originally it was only designed to work with Norwegian meters, but has since been adapter to read any IEC-62056-7-5 or IEC-62056-21 compliant meters. -This repository contains the code and schematics necessary to build a device to receive and convert data from AMS electrical meters installed in Norway. The code can be used on both ESP8266 and ESP32, both as custom build devices or built from readily available development modules. It reads data from the HAN port of the meter and sends this to a configured MQTT bus. +Later development have added Energy usage graph for both day and month, as well as future energy price. The code can run on any ESP8266 or ESP32 hardware which you can read more about in the [WiKi](https://github.com/gskjold/AmsToMqttBridge/wiki). If you don't have the knowledge to set up a ESP device yourself, have a look at the shop at [amsleser.no](https://amsleser.no/). -There is a web interface available on runtime, showing meter data in real time. -## Setting up your device -Go to the [WiKi](https://github.com/gskjold/AmsToMqttBridge/wiki) for information on how to get your own device! +Go to the [WiKi](https://github.com/gskjold/AmsToMqttBridge/wiki) for information on how to get your own device! And find the latest prebuilt firmware file at the [release section](https://github.com/gskjold/AmsToMqttBridge/releases). ## Building this project with PlatformIO To build this project, you need [PlatformIO](https://platformio.org/) installed. @@ -19,4 +17,4 @@ It is recommended to use Visual Studio Code with the PlatformIO plugin for devel [PlatformIO vscode plugin](https://platformio.org/install/ide?install=vscode) -Copy the ```platformio-user.ini-example``` to ```platformio-user.ini``` and customize to your preference. The code will adapt to the platform and board set in your profile. +For development purposes, copy the ```platformio-user.ini-example``` to ```platformio-user.ini``` and customize to your preference. The code will adapt to the platform and board set in your profile. diff --git a/src/AmsToMqttBridge.ino b/src/AmsToMqttBridge.ino index df551434..c6447a8c 100644 --- a/src/AmsToMqttBridge.ino +++ b/src/AmsToMqttBridge.ino @@ -10,10 +10,6 @@ * @author Gunnar Skjold (@gskjold) * Maintainer of current code * https://github.com/gskjold/AmsToMqttBridge - * - * @author Roar Fredriksen (@roarfred) - * The original developer for this project - * https://github.com/roarfred/AmsToMqttBridge */ #if defined(ESP8266) ADC_MODE(ADC_VCC); diff --git a/webui.png b/webui.png new file mode 100644 index 00000000..afab3bca Binary files /dev/null and b/webui.png differ