Updated documentation

.github/workflows/release.yml

@@ -51,15 +51,6 @@ jobs:
         release_name: Release ${{ github.ref }}
         draft: false
         prerelease: false
-    - name: Upload esp12e binary to release
-      uses: actions/upload-release-asset@v1.0.1
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      with:
-        upload_url: ${{ steps.create_release.outputs.upload_url }}
-        asset_path: .pio/build/esp12e/firmware.bin
-        asset_name: ams2mqtt-esp12e-${{ steps.release_tag.outputs.tag }}.bin
-        asset_content_type: application/octet-stream
     - name: Upload hw1esp12e binary to release
       uses: actions/upload-release-asset@v1.0.1
       env:
@@ -69,6 +60,15 @@ jobs:
         asset_path: .pio/build/hw1esp12e/firmware.bin
         asset_name: ams2mqtt-hw1esp12e-${{ steps.release_tag.outputs.tag }}.bin
         asset_content_type: application/octet-stream
+    - name: Upload esp12e binary to release
+      uses: actions/upload-release-asset@v1.0.1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: .pio/build/esp12e/firmware.bin
+        asset_name: ams2mqtt-esp12e-${{ steps.release_tag.outputs.tag }}.bin
+        asset_content_type: application/octet-stream
     - name: Upload d1mini binary to release
       uses: actions/upload-release-asset@v1.0.1
       env:
@@ -87,6 +87,15 @@ jobs:
         asset_path: .pio/build/esp32/firmware.bin
         asset_name: ams2mqtt-esp32-${{ steps.release_tag.outputs.tag }}.bin
         asset_content_type: application/octet-stream
+    - name: Upload lolind32 binary to release
+      uses: actions/upload-release-asset@v1.0.1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+        asset_path: .pio/build/lolind32/firmware.bin
+        asset_name: ams2mqtt-lolind32-${{ steps.release_tag.outputs.tag }}.bin
+        asset_content_type: application/octet-stream
     - name: Upload featheresp32 binary to release
       uses: actions/upload-release-asset@v1.0.1
       env:

README.md

@@ -1,14 +1,21 @@
 # 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)
 
-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 modules. It reads data from the HAN port of the meter and sends this to a configured MQTT bus.
+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.
+
+There is also a web interface available on runtime, showing meter data in real time.
+
+<img src="webui.jpg" width="480">
 
 ## Release binaries
 
 In the [Release section](https://github.com/gskjold/AmsToMqttBridge/releases) of this repository, you will find precompiled binaries for some common boards.
 
-- _esp12e_ :: General ESP8266 board with 12E or 12F chip, ex NodeMCU board.
-- _hw1esp12e_ :: First version hardware with ESP 12E of 12F chip.
+- _hw1esp12e_ :: First version custom hardware with ESP 12E of 12F chip
+- _esp12e_ :: General ESP8266 board with 12E or 12F chip
+- _d1mini_ :: Wemos D1 mini
+- _esp32_ :: General ESP32 board
+- _lolind32_ :: Wemos D32
 - _featheresp32_ :: Adafruit ESP32 feather
 
 ### Flashing binaries with [esptool.py](https://github.com/espressif/esptool)
@@ -18,3 +25,15 @@ Linux:
 
 Windows:
 ```esptool.py --port COM1 write_flash 0x0 binary-file.bin```
+
+
+## Building this project with PlatformIO
+To build this project, you need [PlatformIO](https://platformio.org/) installed.
+
+It is recommended to use Visual Studio Code with the PlatformIO plugin for development.
+
+[Visual Studio Code](https://code.visualstudio.com/download)
+
+[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. If you are using the original board design by [@roarfred](https://github.com/roarfred) use build flag -D HW_ROARFRED=1

hardware/README.md

@@ -12,9 +12,20 @@ Building this project will require some skills in ordering and assembling electr
 *The completed board mounted in a [3D printed enclosure](/Enclosure)*
 
 ## Assembly of readily available modules
-Use a ESP based developmentboard and a M-bus module.
+You can also use a ESP based development board and combine this with a M-Bus module. Here are a few boards that have been tested, each one has a dedicated firmware file in the releases section. 
 
-[Adafruit Feather M0 WiFi w/ATWINC1500](https://www.adafruit.com/product/3010)
+### ESP8266 based boards
+
+[Wemos D1 mini](https://docs.wemos.cc/en/latest/d1/d1_mini.html) - M-Bus connected to GPIO 5
+
+### ESP32 based boards
+
+[Wemos D32](https://docs.wemos.cc/en/latest/d32/d32.html) - M-Bus connected to GPIO 21
+
+[Adafruit HUZZAH32](https://www.adafruit.com/product/3405) - M-Bus connected to RX
+
+
+Combine one of above board with an M-Bus module. Connect 3.3v and GND together between the boards and connect the TX pin from the M-Bus board to the dedicated M-Bus pin on the ESP board.
 
 [TSS721 M-BUS module board](https://www.aliexpress.com/item/TSS721/32751482255.html)
 

platformio.ini

@@ -6,15 +6,6 @@ extra_configs = platformio-user.ini
 framework = arduino
 lib_deps = HanConfigAp@1.0.0, HanReader@1.0.0, HanToJson@1.0.0, ArduinoJson@^6.0.0, MQTT@^2.4.0, DallasTemperature@^3.8.0, EspSoftwareSerial@^6.7.1
 
-[env:esp12e]
-platform = espressif8266
-board = esp12e
-framework = ${common.framework}
-lib_deps = ${common.lib_deps}
-extra_scripts =
-    pre:scripts/addversion.py
-    scripts/makeweb.py
-
 [env:hw1esp12e]
 platform = espressif8266
 board = esp12e
@@ -26,9 +17,18 @@ extra_scripts =
     pre:scripts/addversion.py
     scripts/makeweb.py
 
-[env:featheresp32]
-platform = espressif32
-board = featheresp32
+[env:esp12e]
+platform = espressif8266
+board = esp12e
+framework = ${common.framework}
+lib_deps = ${common.lib_deps}
+extra_scripts =
+    pre:scripts/addversion.py
+    scripts/makeweb.py
+
+[env:d1mini]
+platform = espressif8266
+board = d1_mini
 framework = ${common.framework}
 lib_deps = ${common.lib_deps}
 extra_scripts =
@@ -44,9 +44,18 @@ extra_scripts =
     pre:scripts/addversion.py
     scripts/makeweb.py
 
-[env:d1mini]
-platform = espressif8266
-board = d1_mini
+[env:lolind32]
+platform = espressif32
+board = lolin_d32
+framework = ${common.framework}
+lib_deps = ${common.lib_deps}
+extra_scripts =
+    pre:scripts/addversion.py
+    scripts/makeweb.py
+
+[env:featheresp32]
+platform = espressif32
+board = featheresp32
 framework = ${common.framework}
 lib_deps = ${common.lib_deps}
 extra_scripts =