Update to ZdisplaySSD1306 to reduce overall resource usage, and enable message queuing (#1417)

docs/use/boards.md

@@ -124,3 +124,21 @@ The mqtt command to change the units is:
 `mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306 -m '{"display-metric":false}'`
 
 Please note that it may take several seconds/display updates for the units to change.  This is due to the queueing of messages for display.
+
+### Flip Display 180 degrees
+
+This allows you to rotate the display 180 degrees.  Can be set at compile time or during use, defaults to true.
+
+The compiler directive is `-DDISPLAY_FLIP=false`
+
+The mqtt command to change display orientation is:
+
+`mosquitto_pub -t home/OpenMQTTGateway/commands/MQTTtoSSD1306 -m '{"display-flip":false}'`
+
+Please note that it may take several seconds/display updates for the display to change.  This is due to the queueing of messages for display.
+
+### Display OpenMQTTGateway Logo when Idle
+
+When this option is enabled the OLED display will show the OpenMQTTGateway Logo when it is idle.  Defaults to false
+
+The compiler directive is `-DDISPLAY_IDLE_LOGO=true`

main/ZdisplaySSD1306.ino

@@ -44,6 +44,7 @@ QueueHandle_t displayQueue;
 boolean logToLCDDisplay = LOG_TO_LCD;
 boolean jsonDisplay = JSON_TO_LCD;
 boolean displayMetric = DISPLAY_METRIC;
+boolean displayFlip = DISPLAY_FLIP;
 
 /*
 Toogle log display
@@ -64,6 +65,7 @@ void setupSSD1306() {
   Log.trace(F("ZdisplaySSD1306 DISPLAY_PAGE_INTERVAL: %d" CR), DISPLAY_PAGE_INTERVAL);
   Log.trace(F("ZdisplaySSD1306 DISPLAY_IDLE_LOGO: %T" CR), DISPLAY_IDLE_LOGO);
   Log.trace(F("ZdisplaySSD1306 DISPLAY_METRIC: %T" CR), displayMetric);
+  Log.trace(F("ZdisplaySSD1306 DISPLAY_FLIP: %T" CR), displayFlip);
 
   Oled.begin();
   Log.notice(F("Setup SSD1306 Display end" CR));
@@ -141,14 +143,23 @@ void MQTTtoSSD1306(char* topicOri, JsonObject& SSD1306data) { // json object dec
       success = true;
     } else if (SSD1306data.containsKey("display-metric")) {
       displayMetric = SSD1306data["display-metric"];
-      Log.notice(F("Set display-metric: %T" CR), jsonDisplay);
+      Log.notice(F("Set display-metric: %T" CR), displayMetric);
+      success = true;
+    } else if (SSD1306data.containsKey("display-flip")) {
+      displayFlip = SSD1306data["display-flip"];
+      Log.notice(F("Set display-flip: %T" CR), displayFlip);
+      if (displayFlip) {
+        Oled.display->flipScreenVertically();
+      } else {
+        Oled.display->resetOrientation();
+      }
       success = true;
     }
     if (success) {
       pub(subjectSSD1306toMQTTset, SSD1306data);
     } else {
       pub(subjectSSD1306toMQTTset, "{\"Status\": \"Error\"}"); // Fail feedback
-      Log.error(F("MQTTtoSSD1306 Fail json" CR), SSD1306data);
+      Log.error(F("[ SSD1306 ] MQTTtoSSD1306 Fail json" CR), SSD1306data);
     }
   }
 }
@@ -166,7 +177,7 @@ Parse json message from module into a format for displaying on screen, and queue
 void ssd1306PubPrint(const char* topicori, JsonObject& data) {
   if (jsonDisplay) {
     displayQueueMessage* message = (displayQueueMessage*)malloc(sizeof(displayQueueMessage));
-
+    if (message != NULL) {
       char* topic = strdup(topicori);
       strlcpy(message->title, strtok(topic, "/"), OLED_TEXT_WIDTH);
       free(topic);
@@ -200,7 +211,7 @@ void ssd1306PubPrint(const char* topicori, JsonObject& data) {
           // Queue completed message
 
           if (xQueueSend(displayQueue, (void*)&message, 0) != pdTRUE) {
-          Log.error(F("ERROR: displayQueue full, discarding signal %s" CR), message->title);
+            Log.error(F("[ SSD1306 ] ERROR: displayQueue full, discarding signal %s" CR), message->title);
           } else {
             // Log.notice(F("Queued %s" CR), message->title);
           }
@@ -271,7 +282,7 @@ void ssd1306PubPrint(const char* topicori, JsonObject& data) {
           // Queue completed message
 
           if (xQueueSend(displayQueue, (void*)&message, 0) != pdTRUE) {
-          Log.error(F("ERROR: displayQueue full, discarding signal %s" CR), message->title);
+            Log.error(F("[ SSD1306 ] displayQueue full, discarding signal %s" CR), message->title);
           } else {
             // Log.notice(F("Queued %s" CR), message->title);
           }
@@ -332,7 +343,68 @@ void ssd1306PubPrint(const char* topicori, JsonObject& data) {
           // Queue completed message
 
           if (xQueueSend(displayQueue, (void*)&message, 0) != pdTRUE) {
-          Log.error(F("ERROR: displayQueue full, discarding signal %s" CR), message->title);
+            Log.error(F("[ SSD1306 ] displayQueue full, discarding signal %s" CR), message->title);
+            free(message);
+          } else {
+            // Log.notice(F("Queued %s" CR), message->title);
+          }
+          break;
+        }
+#  endif
+#  ifdef ZgatewayBT
+        case hash("BTtoMQTT"): {
+          // {"id":"49:22:07:07:1C:F6","mac_type":0,"name":"sps","rssi":-87,"brand":"Inkbird","model":"TH Sensor","model_id":"IBS-TH1","cidc":false,"tempc":0.8,"tempf":33.44,"hum":29.61,"batt":100}
+
+          // Line 1
+
+          strlcpy(message->line1, data["brand"], OLED_TEXT_WIDTH);
+
+          // Line 2
+
+          strlcpy(message->line2, data["model_id"], OLED_TEXT_WIDTH);
+
+          // Line 3
+
+          String line3 = "";
+
+          if (data.containsKey("tempc")) {
+            float temperature_C = data["tempc"];
+            char temp[5];
+
+            if (displayMetric) {
+              dtostrf(temperature_C, 3, 1, temp);
+              line3 = "temp: " + (String)temp + "°C ";
+            } else {
+              dtostrf(convertTemp_CtoF(temperature_C), 3, 1, temp);
+              line3 = "temp: " + (String)temp + "°F ";
+            }
+          }
+
+          float humidity = data["hum"];
+          if (data.containsKey("hum") && humidity <= 100 && humidity >= 0) {
+            char hum[5];
+            dtostrf(humidity, 3, 1, hum);
+            line3 += "hum: " + (String)hum + "% ";
+          }
+
+          line3.toCharArray(message->line3, OLED_TEXT_WIDTH);
+
+          // Line 4
+
+          String rssi = data["rssi"];
+          String battery_ok = data["batt"];
+
+          String line4;
+          if (data.containsKey("batt"))
+            line4 += "batt: " + battery_ok + " ";
+
+          line4 += "rssi: " + rssi;
+          line4.toCharArray(message->line4, OLED_TEXT_WIDTH);
+
+          // Queue completed message
+
+          if (xQueueSend(displayQueue, (void*)&message, 0) != pdTRUE) {
+            Log.error(F("[ SSD1306 ] displayQueue full, discarding signal %s" CR), message->title);
             free(message);
           } else {
             // Log.notice(F("Queued %s" CR), message->title);
@@ -341,7 +413,10 @@ void ssd1306PubPrint(const char* topicori, JsonObject& data) {
         }
 #  endif
         default:
-        Log.error(F("ERROR: unhandled topic %s" CR), message->title);
+          Log.error(F("[ SSD1306 ] unhandled topic %s" CR), message->title);
+      }
+    } else {
+      Log.error(F("[ SSD1306 ] insufficent memory " CR));
     }
   }
 }
@@ -411,9 +486,12 @@ void OledSerial::begin() {
   xSemaphoreGive(semaphoreOLEDOperation);
 
   display->init();
+  if (displayFlip) {
     display->flipScreenVertically();
+  } else {
+    display->resetOrientation();
+  }
   display->setFont(ArialMT_Plain_10);
-
   display->setColor(WHITE);
   display->fillRect(0, 0, OLED_WIDTH, OLED_HEIGHT);
   display->display();

main/ZgatewayBT.ino

@@ -219,6 +219,9 @@ void pubBTMainCore(JsonObject& data, bool haPresenceEnabled = true) {
       topic = BTConfig.extDecoderTopic; // If external decoder, use this topic to send data
     topic = subjectBTtoMQTT + String("/") + topic;
     pub((char*)topic.c_str(), data);
+    if (data.containsKey("model") || data.containsKey("distance")) { // Only display sensor data
+      pubOled((char*)topic.c_str(), data);
+    }
   }
   if (haPresenceEnabled && data.containsKey("distance")) {
     if (data.containsKey("servicedatauuid"))

main/config_SSD1306.h

@@ -59,13 +59,17 @@
 #endif
 
 #ifndef DISPLAY_IDLE_LOGO
-#  define DISPLAY_IDLE_LOGO true // Display the OMG logo when idle
+#  define DISPLAY_IDLE_LOGO false // Display the OMG logo when idle
 #endif
 
 #ifndef DISPLAY_METRIC
 #  define DISPLAY_METRIC true // Units used for display of sensor data
 #endif
 
+#ifndef DISPLAY_FLIP
+#  define DISPLAY_FLIP true // Flip display orientation
+#endif
+
 /*------------------- DEFAULT DISPLAY GEOMETRY ----------------------*/
 
 #define OLED_TEXT_BUFFER 1000