synchronize with esp32 template

README.md

@@ -36,7 +36,8 @@ Note that we do not subscribe to this topic, we only publish to it.
 
 ### Importance of `ClientName` Setting
 Note that the `ClientName` configured in the `platformio.ini` file will also be used as the hostname reported to your DHCP server when the ESP fetches an IP-address. This is especially important, as OTA-flashing will also require your networking environment to be able to resolve this hostname to the ESP's IP-address!  
-See `upload_port`setting in the `platformio.ini` file. If you're having troubles with OTA-flashing, you might want to check that first by pinging the configured `ClientName`.
+See `upload_port`setting in the `platformio.ini` file. If you're having troubles with OTA-flashing, you might want to check that first by pinging the configured `ClientName`.  
+**ATTENTION:** `ClientName` must not contain dashes.
 
 ### Compiling and flashing walkthrough
 I will give a rough walkthrough on the first steps, assuming you have a working PlatformIO environment:
@@ -110,4 +111,6 @@ ATTN: OTA flashing did not work due to an error in macro handling!
 - Major code cleanup
 
 ## Release 1.0.3
-- Moved user specific stuff into dedicated files / functions (`user_setup` and `user_loop`)
+- Moved user specific stuff into dedicated files / functions (`user_setup` and `user_loop`)
+- Added `MqttDelay` function which handles MQTT connection/subscriptions while delaying
+- README update on `ClientName` limitation

include/common-functions.h

@@ -14,6 +14,7 @@ extern void MqttCallback(char *topic, byte *payload, unsigned int length);
 extern bool MqttSubscribe(const char *Topic);
 extern bool MqttConnectToBroker();
 extern void MqttUpdater();
+extern void MqttDelay(uint32_t delayms);
 #ifdef OTA_UPDATE
 extern bool OTAUpdateHandler();
 #endif

include/mqtt-ota-config.h

@@ -21,6 +21,7 @@ extern unsigned int SubscribedTopics;
 extern unsigned int ReceivedTopics;
 
 // MQTT Topic Tree prepended to all topics
+// ATTN: Must end with "/"!
 #define TOPTREE "HB7/Test/"
 
 // MQTT Topics and corresponding local vars

include/user_setup.h

@@ -9,7 +9,7 @@
 // Don't forget to add them into platformio.ini
 //#define <user_lib.h>
 
-// Declare user setup and main loop functions
+// Declare user setup, main and custom functions
 extern void user_setup();
 extern void user_loop();
 

src/common-functions.cpp

@@ -115,6 +115,33 @@ void MqttUpdater()
     }
 }
 
+// Function to periodically handle MQTT stuff while delaying
+// This causes some inaccuracy in the delay of course.
+void MqttDelay(uint32_t delayms)
+{
+    //unsigned long md_start = millis();
+    // Call MqttUpdater every 200ms
+    int Counter = delayms / 200;
+    if (Counter == 0)
+    {
+        // Delay less than 200ms requested, just run delay and return
+        delay(delayms);
+        return;
+    }
+    else
+    {
+        for (int i = 0; i < Counter; i++)
+        {
+            MqttUpdater();
+            delay(200);
+        }
+    }
+    //unsigned long real_delay = millis() - md_start;
+    //DEBUG_PRINTLN("MqttDelay requested: " + String(delayms));
+    //DEBUG_PRINTLN("MqttDelay Counter: " + String(Counter));
+    //DEBUG_PRINTLN("MqttDelay duration: " + String(real_delay));    
+}
+
 // Function to handle OTA flashing (called in main loop)
 // Returns TRUE while OTA-update was requested or in progress
 #ifdef OTA_UPDATE