Software serial for development boards. Added a few extra boards

.github/workflows/build.yml

@@ -40,6 +40,8 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -U platformio
+    - name: Configure build targets
+      run: echo "[platformio]\ndefault_envs = hw1esp12e, esp12e, esp32" > platformio-user.ini
     - name: PlatformIO lib install
       run: pio lib install
     - name: PlatformIO run

.github/workflows/release.yml

@@ -69,6 +69,24 @@ 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 d1mini 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/d1mini/firmware.bin
+        asset_name: ams2mqtt-d1mini-${{ steps.release_tag.outputs.tag }}.bin
+        asset_content_type: application/octet-stream
+    - name: Upload esp32 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/esp32/firmware.bin
+        asset_name: ams2mqtt-esp32-${{ 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:

lib/HanReader/src/HanReader.cpp

@@ -5,7 +5,7 @@ HanReader::HanReader()
   
 }
 
-void HanReader::setup(HardwareSerial *hanPort, Stream *debugPort)
+void HanReader::setup(Stream *hanPort, Stream *debugPort)
 {
 	han = hanPort;
 	bytesRead = 0;
@@ -13,7 +13,7 @@ void HanReader::setup(HardwareSerial *hanPort, Stream *debugPort)
 	if (debug) debug->println("MBUS serial setup complete");
 }
 
-void HanReader::setup(HardwareSerial *hanPort)
+void HanReader::setup(Stream *hanPort)
 {
 	setup(hanPort, NULL);
 }

lib/HanReader/src/HanReader.h

@@ -18,8 +18,8 @@ public:
 	bool compensateFor09HeaderBug = false;
 
 	HanReader();
-	void setup(HardwareSerial *hanPort);
-	void setup(HardwareSerial *hanPort, Stream *debugPort);
+	void setup(Stream *hanPort);
+	void setup(Stream *hanPort, Stream *debugPort);
 	bool read();
 	bool read(byte data);
 	int getListSize();
@@ -30,7 +30,7 @@ public:
 
 private:
 	Stream *debug;
-	HardwareSerial *han;
+	Stream *han;
 	byte buffer[512];
 	int bytesRead;
 	DlmsReader reader;

platformio-user.ini-example

@@ -7,8 +7,9 @@ board = esp12e
 framework = ${common.framework}
 lib_deps = ${common.lib_deps}
 build_flags =
-    -D HAS_DALLAS_TEMP_SENSOR=0
-    -D IS_CUSTOM_AMS_BOARD=0
+    -D HW_ROARFRED=1
     -D DEBUG_MODE=1
 monitor_speed = 2400
-monitor_flags = --parity E
+monitor_flags = 
+    --parity
+    E

platformio.ini

@@ -4,16 +4,13 @@ extra_configs = platformio-user.ini
 
 [common]
 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
+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}
-build_flags =
-    -D HAS_DALLAS_TEMP_SENSOR=0
-    -D IS_CUSTOM_AMS_BOARD=0
 extra_scripts =
     pre:scripts/addversion.py
     scripts/makeweb.py
@@ -24,8 +21,7 @@ board = esp12e
 framework = ${common.framework}
 lib_deps = ${common.lib_deps}
 build_flags =
-    -D HAS_DALLAS_TEMP_SENSOR=1
-    -D IS_CUSTOM_AMS_BOARD=1
+    -D HW_ROARFRED=1
 extra_scripts =
     pre:scripts/addversion.py
     scripts/makeweb.py
@@ -35,9 +31,24 @@ platform = espressif32
 board = featheresp32
 framework = ${common.framework}
 lib_deps = ${common.lib_deps}
-build_flags =
-    -D HAS_DALLAS_TEMP_SENSOR=0
-    -D IS_CUSTOM_AMS_BOARD=0
+extra_scripts =
+    pre:scripts/addversion.py
+    scripts/makeweb.py
+
+[env:esp32]
+platform = espressif32
+board = esp32dev
+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 =
     pre:scripts/addversion.py
     scripts/makeweb.py

src/AmsToMqttBridge.h

@@ -0,0 +1,64 @@
+#define WIFI_CONNECTION_TIMEOUT 30000;
+
+
+#if defined(ESP8266)
+#include <ESP8266WiFi.h>
+#elif defined(ESP32)
+#include <WiFi.h>
+#endif
+
+// Build settings for custom hardware by Roar Fredriksen
+#if HW_ROARFRED
+#define LED_PIN 2 // The blue on-board LED of the ESP8266 custom AMS board
+#define LED_ACTIVE_HIGH 0
+#define AP_BUTTON_PIN 0
+
+#include <DallasTemperature.h>
+#include <OneWire.h>
+#define TEMP_SENSOR_PIN 5 // Temperature sensor connected to GPIO5
+
+HardwareSerial *hanSerial = &Serial;
+
+// Build settings for Wemos Lolin D32
+#elif defined(ARDUINO_LOLIN_D32)
+#define LED_PIN 5
+#define LED_ACTIVE_HIGH 0
+#define AP_BUTTON_PIN INVALID_BUTTON_PIN
+
+#define SOFTWARE_SERIAL 1
+#include <SoftwareSerial.h>
+SoftwareSerial *hanSerial = new SoftwareSerial(GPIO_NUM_21);
+
+// Build settings for Wemos D1 mini
+#elif defined(ARDUINO_ESP8266_WEMOS_D1MINI)
+#define LED_PIN LED_BUILTIN
+#define LED_ACTIVE_HIGH 0
+#define AP_BUTTON_PIN INVALID_BUTTON_PIN
+
+#define SOFTWARE_SERIAL 1
+#include <SoftwareSerial.h>
+SoftwareSerial *hanSerial = new SoftwareSerial(D1);
+
+// Build settings for Adafruit Feather ESP32
+#elif defined(ARDUINO_FEATHER_ESP32)
+#define LED_PIN LED_BUILTIN
+#define LED_ACTIVE_HIGH 1
+#define AP_BUTTON_PIN INVALID_BUTTON_PIN
+
+HardwareSerial *hanSerial = &Serial;
+
+// Default build settings
+#else
+#define LED_PIN 2
+#define LED_ACTIVE_HIGH 0
+#define AP_BUTTON_PIN INVALID_BUTTON_PIN
+#define SOFTWARE_SERIAL 1
+#include <SoftwareSerial.h>
+SoftwareSerial *hanSerial = new SoftwareSerial(5);
+#endif
+
+
+#if defined TEMP_SENSOR_PIN
+OneWire oneWire(TEMP_SENSOR_PIN);
+DallasTemperature tempSensor(&oneWire);
+#endif

src/AmsToMqttBridge.ino

@@ -4,57 +4,22 @@
  Author:	roarf
 */
 
-
-//#define HAS_DALLAS_TEMP_SENSOR 1		// Set to zero if Dallas one wire temp sensor is not present
-//#define IS_CUSTOM_AMS_BOARD 1			// Set to zero if using NodeMCU or board not designed by Roar Fredriksen
-
+#include "AmsToMqttBridge.h"
 #include <ArduinoJson.h>
 #include <MQTT.h>
 
-#if HAS_DALLAS_TEMP_SENSOR
-#include <DallasTemperature.h>
-#include <OneWire.h>
-#endif
-
-#if defined(ESP8266)
-#include <ESP8266WiFi.h>
-#elif defined(ESP32)
-#include <WiFi.h>
-#endif
-
 #include "web/AmsWebServer.h"
 #include "HanConfigAp.h"
 #include "HanReader.h"
 #include "HanToJson.h"
 
-#define WIFI_CONNECTION_TIMEOUT 30000;
-
-#if IS_CUSTOM_AMS_BOARD
-#define LED_PIN 2 // The blue on-board LED of the ESP8266 custom AMS board
-#define LED_ACTIVE_HIGH 0
-#define AP_BUTTON_PIN 0
-#elif defined(ARDUINO_LOLIN_D32)
-#define LED_PIN 5
-#define LED_ACTIVE_HIGH 0
-#define AP_BUTTON_PIN INVALID_BUTTON_PIN
-#else
-#define LED_PIN LED_BUILTIN
-#define LED_ACTIVE_HIGH 1
-#define AP_BUTTON_PIN INVALID_BUTTON_PIN
-#endif
-
-#if HAS_DALLAS_TEMP_SENSOR
-#define TEMP_SENSOR_PIN 5 // Temperature sensor connected to GPIO5
-
-OneWire oneWire(TEMP_SENSOR_PIN);
-DallasTemperature tempSensor(&oneWire);
-#endif
-
+// Configuration
 configuration config;
 
 // Object used to boot as Access Point
 HanConfigAp ap;
 
+// Web server
 AmsWebServer ws;
 
 // WiFi client and MQTT client
@@ -69,21 +34,23 @@ HanReader hanReader;
 
 // the setup function runs once when you press reset or power the board
 void setup() {
-
-#if DEBUG_MODE
-	debugger = &Serial;
-#endif
-
 	if(config.hasConfig()) {
 		config.load();
 	}
 
-	if(config.meterType == 3) {
-		Serial.begin(2400, SERIAL_8N1);
-	} else {
-		Serial.begin(2400, SERIAL_8E1);
-	}
-	while (!Serial);
+#if DEBUG_MODE
+	debugger = &Serial;
+	#if SOFTWARE_SERIAL
+		debugger->begin(115200, SERIAL_8N1);
+	#else
+		if(config.meterType == 3) {
+			hanSerial->begin(2400, SERIAL_8N1);
+		} else {
+			hanSerial->begin(2400, SERIAL_8E1);
+		}
+	#endif
+	while (!&debugger);
+#endif
 
 	if (debugger) {
 		debugger->println("");
@@ -112,8 +79,25 @@ void setup() {
 			sendMqttData("Connected!");
 		}
 		// Configure uart for AMS data
+#if defined SOFTWARE_SERIAL
+		if(config.meterType == 3) {
+			hanSerial->begin(2400, SWSERIAL_8N1);
+		} else {
+			hanSerial->begin(2400, SWSERIAL_8E1);
+		}
+#else
+		if(config.meterType == 3) {
+			hanSerial->begin(2400, SERIAL_8N1);
+		} else {
+			hanSerial->begin(2400, SERIAL_8E1);
+		}
+#if defined UART2
+		hanSerial->swap();
+#endif
+#endif
+		while (!&hanSerial);
 
-		hanReader.setup(&Serial, debugger);
+		hanReader.setup(hanSerial, debugger);
 
 		// Compensate for the known Kaifa bug
 		hanReader.compensateFor09HeaderBug = (config.meterType == 1);
@@ -234,7 +218,7 @@ void readHanPort()
 		// to keep the data from the meter itself
 		JsonObject data = json.createNestedObject("data");
 
-#if HAS_DALLAS_TEMP_SENSOR
+#if defined TEMP_SENSOR_PIN
 		// Get the temperature too
 		tempSensor.requestTemperatures();
 		data["temp"] = tempSensor.getTempCByIndex(0);