Improve offline responsiveness

hard-wired button checking is no longer inside the wifi loop - the
button now works even if the network (or mqtt broker) drops out

PrawnBot-ESP.ino

@@ -1,123 +1,106 @@
+// In your secrets.h file, define the following:
+// char ssid[] = "";
+// char password[] = "";
+// const char *mqttUsername = "";
+// const char *mqttPassword = "";
+// const int port = 1883;
+// IPAddress server(192, 168, 1, 2);
+
 #include <Bounce2.h>
-#include <SPI.h>
 #include <ESP8266WiFi.h>
 #include <PubSubClient.h>
 #include "secrets.h"
-const int feedButtonPin = 0;
+const unsigned int motorPin = 14;
-const int motorPin = 14;
+const unsigned int feedButtonPin = 0;
-const int motorSwitchPin = 12;
+const unsigned int motorSwitchPin = 12;
-const int dispenseTimeout = 2000;
-const int debounce = 100;
-boolean motorJammed = false;
-char clientName[] = "PrawnBot-ESP";
-boolean somethingToSay = false;
-String messageToReport;
-long modeStartTime = 0;
-unsigned int lastAnnounced = 5;
-int botMode = 0; // 0: Listening; 1: Dispensing; 2: Jam
-void callback(char* topic, byte* incoming, unsigned int length);
-Bounce motorSwitchDebounced = Bounce();
 Bounce feedButtonDebounced = Bounce();
-
+Bounce motorSwitchDebounced = Bounce();
+const unsigned int jamTimeout = 2000;
+const unsigned int networkTimeout = 5000;
+const unsigned int debounce = 50;
+const char myName[] = "PrawnBot-ESP";
+const char *controlTopic = "devices/prawnbot";
+char statusTopic[] = "devices/prawnbot/status";
+long modeStartTime = 0;
+long lastWifiConnectAttempt = 0;
+long lastMQTTConnectAttempt = 0;
+int botMode = 0; // 0: Listening; 1: Dispensing; 2: Jam
 
 WiFiClient wifiClient;
-PubSubClient mqttclient(server, 1883, callback, wifiClient);
+PubSubClient mqttClient(server, 1883, MQTTReceived, wifiClient);
 
-void callback(char* theTopic, byte* incoming, unsigned int length) {
+void MQTTReceived(char* incomingTopic, byte* incomingPayload, unsigned int payloadLength){
-  String incomingMessage = String((char *)incoming);
+  String incomingString = String((char *)incomingPayload);
-  incomingMessage = incomingMessage.substring(0, length);
+  incomingString = incomingString.substring(0, payloadLength);
-  Serial.print(String(theTopic));
+  Serial.println(String(incomingTopic) + ": " + incomingString);
-  Serial.print(": ");
+  if(incomingString == "ping") mqttClient.publish(incomingTopic, (char*)("pong"));
-  Serial.println(incomingMessage);
+  if(incomingString == "feed" && botMode != 2) botMode = 1;  //if not jammed
-  if (incomingMessage == "feed") botMode = 1;
-  else if (incomingMessage == "ping") mqttclient.publish(topic, (char*)("pong"));
 }
 
-void setup() {
+void setup(){
   pinMode(motorPin, OUTPUT);
   pinMode(feedButtonPin, INPUT_PULLUP);
   pinMode(motorSwitchPin, INPUT_PULLUP);
   motorSwitchDebounced.attach(motorSwitchPin);
   feedButtonDebounced.attach(feedButtonPin);
-  motorSwitchDebounced.interval(50);
+  motorSwitchDebounced.interval(debounce);
-  feedButtonDebounced.interval(50);
+  feedButtonDebounced.interval(debounce);
   Serial.begin(115200);
-  delay(10);
+  delay(10); //wait for serial
+}
+
+void connectWifi(){
   WiFi.begin(ssid, password);
+   while (WiFi.status() != WL_CONNECTED){
+    delay(250);
+    Serial.print("-");
+  }
+  Serial.println("WiFi OK. IP: " + WiFi.localIP());
 }
 
-void getOnline(){
+boolean connectMQTT(){
-   while (WiFi.status() != WL_CONNECTED) {
+  if(mqttClient.connect(myName, mqttUsername, mqttPassword, statusTopic, 2, true, (char*)("offline"))){
-    delay(500);
+    mqttClient.publish(statusTopic, (byte*)("online"), 6, true);
-    Serial.print(":) ");
+    mqttClient.subscribe(controlTopic);
-  }
-  Serial.println("");
-  Serial.println("WiFi connected");  
-  Serial.println("IP address: ");
-  Serial.println(WiFi.localIP());
-  if (mqttclient.connect(clientName)) {
-    mqttclient.publish(topic, (char*)("WiFi GO"));
-    mqttclient.subscribe(topic);
   }
 }
 
-void loop() {
+void loop(){
-  if(WiFi.status() != WL_CONNECTED) getOnline();
+  if(WiFi.status() != WL_CONNECTED){
-  if (!mqttclient.connected()) mqttclient.connect(clientName);
+    if(millis() - lastWifiConnectAttempt > networkTimeout){
+      lastWifiConnectAttempt=millis();
+      connectWifi();
+    }
+  } else if(!mqttClient.loop()){
+    if(millis() - lastMQTTConnectAttempt > networkTimeout){
+      lastMQTTConnectAttempt=millis();
+      connectMQTT();
+    }
+  }
   feedButtonDebounced.update();
   motorSwitchDebounced.update();
-  mqttclient.loop(); //
+  switch (botMode){
-  if (motorJammed == true) botMode = 3;
-  switch (botMode) {
     case 0: // Listening
-      if(lastAnnounced != 0) {
+      if(feedButtonDebounced.fell()){
-        Serial.println("Listening");
-        lastAnnounced = 0;
-      }
-      if (feedButtonDebounced.fell()){
         Serial.println("Button pressed");
         botMode = 1;
-        modeStartTime = 0;
       }
     break;
-    
     case 1: // Dispensing
       modeStartTime=millis();
-      if(lastAnnounced != 1) {
-        Serial.println("Dispensing");
-        lastAnnounced = 1;
-      }
       digitalWrite(motorPin, HIGH);
-      if (motorSwitchDebounced.fell()){
+      if(motorSwitchDebounced.fell()){
         digitalWrite(motorPin, LOW);
         botMode = 0;
         modeStartTime = 0;
-        somethingToSay = true;
+        Serial.println("Fed");
-        messageToReport="fed";
+        mqttClient.publish(controlTopic, (char*)("fed"));
       }
-      else if (millis() - modeStartTime > dispenseTimeout) {
+      else if(millis() - modeStartTime > jamTimeout){
-        botMode = 3;
+        botMode = 2; //jammed
-        modeStartTime = 0;
-      }
-    break;
-
-    case 2: // Jammed
-      if(lastAnnounced != 2) {
         Serial.println("Jammed");
-        lastAnnounced = 2;
+        mqttClient.publish(statusTopic, (char*)("jam"));
       }
-      if (messageToReport != "jam") somethingToSay = true;
-      motorJammed = true;
-      messageToReport="jam";
     break;
   }
-  
-  if (somethingToSay) {
-    Serial.println("Send MQTT");
-    int messageLength = messageToReport.length() + 1;
-    char messageChar[messageLength];
-    messageToReport.toCharArray(messageChar, messageLength);
-    mqttclient.publish(topic, messageChar);
-    somethingToSay = false;
-  }
 }