Adds support for MQTT Last Will & Testament settings (#26)

Added a method for setting MQTT last will params. The new method is optional. Default values are used if not called which match the original params.

Author: PaulWieland

examples/ChangeName.cpp

@@ -23,7 +23,8 @@
 void setup() {
 
   Serial.begin(SERIAL_RATE);
-
+  // Optional - setup MQTT last will & testament 
+  bootstrapManager.setMQTTWill("path/for/last/will/message","last will payload",lastWillQOS,lastWillRetain,cleanSession);
   bootstrapManager.bootstrapSetup(manageDisconnections, manageHardwareButton, callback);
 
   // ENTER YOUR CODE HERE

examples/ChangeName.h

@@ -33,6 +33,9 @@ BootstrapManager bootstrapManager;
 /************* MQTT TOPICS **************************/
 const char* CHANGE_ME_TOPIC = "tele/changeme/CHANGEME";
 const char* CHANGE_ME_JSON_TOPIC = "tele/changeme/CHANGEME_JSON";
+static int lastWillQOS = 1;
+boolean lastWillRetain = false;
+boolean cleanSession = false;
 
 
 /********************************** FUNCTION DECLARATION (NEEDED BY PLATFORMIO WHILE COMPILING CPP FILES) *****************************************/

src/BootstrapManager.cpp

@@ -70,6 +70,11 @@ void BootstrapManager::bootstrapLoop(void (*manageDisconnections)(), void (*mana
 
 }
 
+/********************************** SET LAST WILL PARAMETERS IN THE Q MANAGER **********************************/
+void BootstrapManager::setMQTTWill(const char *topic, const char *payload, const int qos, boolean retain, boolean cleanSession){
+  queueManager.setMQTTWill(topic, payload, qos, retain, cleanSession);
+}
+
 /********************************** SEND A SIMPLE MESSAGE ON THE QUEUE **********************************/
 void BootstrapManager::publish(const char *topic, const char *payload, boolean retained) {
 

src/BootstrapManager.h

@@ -51,6 +51,7 @@ class BootstrapManager {
     StaticJsonDocument<BUFFER_SIZE> parseHttpMsg(String payload, unsigned int length); // print the message arriving from HTTP
     void bootstrapSetup(void (*manageDisconnectionFunction)(), void (*manageHardwareButton)(), void (*callback)(char*, byte*, unsigned int)); // bootstrap setup()
     void bootstrapLoop(void (*manageDisconnectionFunction)(), void (*manageQueueSubscription)(), void (*manageHardwareButton)()); // bootstrap loop()
+    void setMQTTWill(const char *topic, const char *payload, const int qos, boolean retain, boolean cleanSession); // set the last will parameters for mqtt
     void publish(const char *topic, const char *payload, boolean retained); // send a message on the queue
     void publish(const char *topic, JsonObject objectToSend, boolean retained); // send a message on the queue
     void unsubscribe(const char *topic); // unsubscribe to a queue topic

src/Helpers.cpp

@@ -42,6 +42,11 @@ String mqttIP = "XXX";
 String mqttPort = "XXX";
 String mqttuser = "XXX";
 String mqttpass = "XXX";
+String mqttWillTopic = "0";
+String mqttWillPayload = "0";
+int mqttWillQOS = 1;
+bool mqttWillRetain = 0;
+bool mqttCleanSession = 1;
 String additionalParam = "XXX";
 
 long previousMillis = 0;     

src/Helpers.h

@@ -51,6 +51,11 @@ extern String mqttIP;
 extern String mqttPort;
 extern String mqttuser;
 extern String mqttpass;
+extern String mqttWillTopic;
+extern String mqttWillPayload;
+extern int mqttWillQOS;
+extern bool mqttWillRetain;
+extern bool mqttCleanSession;
 extern String additionalParam;
 
 // Blink LED vars

src/QueueManager.cpp

@@ -35,6 +35,15 @@ void QueueManager::setupMQTTQueue(void (*callback)(char*, byte*, unsigned int))
 
 }
 
+/********************************** SET LAST WILL PARAMETERS **********************************/
+void QueueManager::setMQTTWill(const char *topic, const char *payload, const int qos, boolean retain, boolean cleanSession){
+  mqttWillTopic = topic;
+  mqttWillPayload = payload;
+  mqttWillQOS = qos;
+  mqttWillRetain = retain;
+  mqttCleanSession = cleanSession;
+}
+
 /********************************** MQTT RECONNECT **********************************/
 void QueueManager::mqttReconnect(void (*manageDisconnections)(), void (*manageQueueSubscription)(), void (*manageHardwareButton)()) {
 
@@ -60,10 +69,23 @@ void QueueManager::mqttReconnect(void (*manageDisconnections)(), void (*manageQu
 
     // Attempt to connect to MQTT server with QoS = 1 (pubsubclient supports QoS 1 for subscribe only, published msg have QoS 0 this is why I implemented a custom solution)
     boolean mqttSuccess;
+
+    Serial.println("MQTT Last Will Params: ");
+    Serial.print("willTopic: ");
+    Serial.println(mqttWillTopic);
+    Serial.print("willPayload: ");
+    Serial.println(mqttWillPayload);
+    Serial.print("qos: ");
+    Serial.println(mqttWillQOS);
+    Serial.print("retain: ");
+    Serial.println(mqttWillRetain);
+    Serial.print("clean session: ");
+    Serial.println(mqttCleanSession);
+
     if (mqttuser.isEmpty() || mqttpass.isEmpty()) {
-      mqttSuccess = mqttClient.connect(helper.string2char(deviceName), 0, 1, 0, 0);
+      mqttSuccess = mqttClient.connect(helper.string2char(deviceName), helper.string2char(mqttWillTopic), mqttWillQOS, mqttWillRetain, helper.string2char(mqttWillPayload));
     } else {
-      mqttSuccess = mqttClient.connect(helper.string2char(deviceName), helper.string2char(mqttuser), helper.string2char(mqttpass), 0, 1, 0, 0, 1);
+      mqttSuccess = mqttClient.connect(helper.string2char(deviceName), helper.string2char(mqttuser), helper.string2char(mqttpass), helper.string2char(mqttWillTopic), mqttWillQOS, mqttWillRetain, helper.string2char(mqttWillPayload), mqttCleanSession);
     }
     if (mqttSuccess) {
 

src/QueueManager.h

@@ -31,6 +31,7 @@ class QueueManager {
 
   public:
     void setupMQTTQueue(void (*callback)(char*, byte*, unsigned int)); // setup the queue
+    void setMQTTWill(const char *topic, const char *payload, const int qos, boolean retain, boolean cleanSession); // set the last will parameters for mqtt
     void mqttReconnect(void (*manageDisconnections)(), void (*manageQueueSubscription)(), void (*manageHardwareButton)()); // manage reconnection on the queue
     void queueLoop(void (*manageDisconnections)(), void (*manageQueueSubscription)(), void (*manageHardwareButton)()); // manage queue loop 
     void publish(const char *topic, const char *payload, boolean retained); // send a message on the queue