Added new user mod for Wemos shield (#701)

usermods/Wemos_D1_mini+Wemos32_mini_shield/readme.md

@@ -0,0 +1,23 @@
+# Wemos D1 mini and Wemos32 mini shield
+## Project repository
+-   [Original repository](https://github.com/srg74/WLED-wemos-shield) - WLED Wemos shield repository
+-   [Wemos shield project Wiki](https://github.com/srg74/WLED-wemos-shield/wiki)
+-   [Precompiled WLED firmware](https://github.com/srg74/WLED-wemos-shield/tree/master/resources/Firmware)
+## Features
+-   SSD1306 128x32 or 128x64 I2C OLED display
+-   On screen IP address, SSID and controller status (e.g. ON or OFF, recent effect)
+-   Auto display shutoff for saving display lifetime
+-   Dallas temperature sensor
+-   Reporting temperature to MQTT broker
+-   Relay for energy saving
+
+## Hardware
+![Shield](https://github.com/srg74/WLED-wemos-shield/blob/master/resources/Images/Assembly_8.jpg)
+
+## Functionality checked with
+-   Wemos D1 mini original v3.1 and clones
+-   Wemos32 mini
+-   PlatformIO
+-   SSD1306 128x32 I2C OLED display
+-   DS18B20 (temperature sensor)
+-   Push button (N.O. momentary switch)

usermods/Wemos_D1_mini+Wemos32_mini_shield/wled06_usermod.ino

@@ -0,0 +1,216 @@
+#include <U8x8lib.h> // from https://github.com/olikraus/u8g2/
+#include <DallasTemperature.h> //Dallastemperature sensor
+#ifdef ARDUINO_ARCH_ESP32 //ESP32 boards
+uint8_t SCL_PIN = 22; 
+uint8_t SDA_PIN = 21; 
+OneWire oneWire(23);
+#else //ESP8266 boards
+uint8_t SCL_PIN = 5;
+uint8_t SDA_PIN = 4;
+OneWire oneWire(13);
+#endif
+//The SCL and SDA pins are defined here.
+//ESP8266 Wemos D1 mini board use SCL=5 SDA=4 while ESP32 Wemos32 mini board use SCL=22 SDA=21
+#define U8X8_PIN_SCL SCL_PIN
+#define U8X8_PIN_SDA SDA_PIN
+
+// Dallas sensor
+DallasTemperature sensor(&oneWire);
+long temptimer = millis();
+long lastMeasure = 0;
+#define Celsius // Show temperature mesaurement in Celcius otherwise is in Fahrenheit 
+
+// If display does not work or looks corrupted check the
+// constructor reference:
+// https://github.com/olikraus/u8g2/wiki/u8x8setupcpp
+// or check the gallery:
+// https://github.com/olikraus/u8g2/wiki/gallery
+// --> First choise of cheap I2C OLED 128X32 0.91"
+U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
+// --> Second choise of cheap I2C OLED 128X64 0.96" or 1.3"
+//U8X8_SSD1306_128X64_NONAME_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
+// gets called once at boot. Do all initialization that doesn't depend on
+// network here
+void userSetup() {
+  sensor.begin(); //Start Dallas temperature sensor
+  u8x8.begin();
+  u8x8.setPowerSave(0);
+  u8x8.setFlipMode(1);
+  u8x8.setContrast(10); //Contrast setup will help to preserve OLED lifetime. In case OLED need to be brighter increase number up to 255
+  u8x8.setFont(u8x8_font_chroma48medium8_r);
+  u8x8.drawString(0, 0, "Loading...");
+}
+
+// gets called every time WiFi is (re-)connected. Initialize own network
+// interfaces here
+void userConnected() {}
+
+// needRedraw marks if redraw is required to prevent often redrawing.
+bool needRedraw = true;
+
+// Next variables hold the previous known values to determine if redraw is
+// required.
+String knownSsid = "";
+IPAddress knownIp;
+uint8_t knownBrightness = 0;
+uint8_t knownMode = 0;
+uint8_t knownPalette = 0;
+
+long lastUpdate = 0;
+long lastRedraw = 0;
+bool displayTurnedOff = false;
+// How often we are redrawing screen
+#define USER_LOOP_REFRESH_RATE_MS 5000
+
+void userLoop() {
+
+//----> Dallas temperature sensor MQTT publishing
+  temptimer = millis();  
+// Timer to publishe new temperature every 60 seconds
+  if (temptimer - lastMeasure > 60000) 
+  {
+    lastMeasure = temptimer;    
+//Check if MQTT Connected, otherwise it will crash the 8266
+    if (mqtt != nullptr)
+    {
+      sensor.requestTemperatures();
+//Gets prefered temperature scale based on selection in definitions section
+      #ifdef Celsius
+      float board_temperature = sensor.getTempCByIndex(0);
+      #else
+      float board_temperature = sensor.getTempFByIndex(0);
+      #endif
+//Create character string populated with user defined device topic from the UI, and the read temperature. Then publish to MQTT server.
+      char subuf[38];
+      strcpy(subuf, mqttDeviceTopic);
+      strcat(subuf, "/temperature");
+      mqtt->publish(subuf, 0, true, String(board_temperature).c_str());
+    }
+  }
+
+  // Check if we time interval for redrawing passes.
+  if (millis() - lastUpdate < USER_LOOP_REFRESH_RATE_MS) {
+    return;
+  }
+  lastUpdate = millis();
+  
+  // Turn off display after 3 minutes with no change.
+  if(!displayTurnedOff && millis() - lastRedraw > 3*60*1000) {
+    u8x8.setPowerSave(1);
+    displayTurnedOff = true;
+  }
+
+  // Check if values which are shown on display changed from the last time.
+  if (((apActive) ? String(apSSID) : WiFi.SSID()) != knownSsid) {
+    needRedraw = true;
+  } else if (knownIp != (apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP())) {
+    needRedraw = true;
+  } else if (knownBrightness != bri) {
+    needRedraw = true;
+  } else if (knownMode != strip.getMode()) {
+    needRedraw = true;
+  } else if (knownPalette != strip.getSegment(0).palette) {
+    needRedraw = true;
+  }
+
+  if (!needRedraw) {
+    return;
+  }
+  needRedraw = false;
+  
+  if (displayTurnedOff)
+  {
+    u8x8.setPowerSave(0);
+    displayTurnedOff = false;
+  }
+  lastRedraw = millis();
+
+  // Update last known values.
+  #if defined(ESP8266)
+  knownSsid = apActive ? WiFi.softAPSSID() : WiFi.SSID();
+  #else
+  knownSsid = WiFi.SSID();
+  #endif
+  knownIp = apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP();
+  knownBrightness = bri;
+  knownMode = strip.getMode();
+  knownPalette = strip.getSegment(0).palette;
+  u8x8.clear();
+  u8x8.setFont(u8x8_font_chroma48medium8_r);
+
+  // First row with Wifi name
+  u8x8.setCursor(1, 0);
+  u8x8.print(knownSsid.substring(0, u8x8.getCols() > 1 ? u8x8.getCols() - 2 : 0));
+  // Print `~` char to indicate that SSID is longer, than owr dicplay
+  if (knownSsid.length() > u8x8.getCols())
+    u8x8.print("~");
+
+  // Second row with IP or Psssword
+  u8x8.setCursor(1, 1);
+  // Print password in AP mode and if led is OFF.
+  if (apActive && bri == 0)
+    u8x8.print(apPass);
+  else
+    u8x8.print(knownIp);
+
+  // Third row with mode name
+  u8x8.setCursor(2, 2);
+  uint8_t qComma = 0;
+  bool insideQuotes = false;
+  uint8_t printedChars = 0;
+  char singleJsonSymbol;
+
+  // Find the mode name in JSON
+  for (size_t i = 0; i < strlen_P(JSON_mode_names); i++) {
+    singleJsonSymbol = pgm_read_byte_near(JSON_mode_names + i);
+    switch (singleJsonSymbol) {
+    case '"':
+      insideQuotes = !insideQuotes;
+      break;
+    case '[':
+    case ']':
+      break;
+    case ',':
+      qComma++;
+    default:
+      if (!insideQuotes || (qComma != knownMode))
+        break;
+      u8x8.print(singleJsonSymbol);
+      printedChars++;
+    }
+    if ((qComma > knownMode) || (printedChars > u8x8.getCols() - 2))
+      break;
+  }
+  // Fourth row with palette name
+  u8x8.setCursor(2, 3);
+  qComma = 0;
+  insideQuotes = false;
+  printedChars = 0;
+  // Looking for palette name in JSON.
+  for (size_t i = 0; i < strlen_P(JSON_palette_names); i++) {
+    singleJsonSymbol = pgm_read_byte_near(JSON_palette_names + i);
+    switch (singleJsonSymbol) {
+    case '"':
+      insideQuotes = !insideQuotes;
+      break;
+    case '[':
+    case ']':
+      break;
+    case ',':
+      qComma++;
+    default:
+      if (!insideQuotes || (qComma != knownPalette))
+        break;
+      u8x8.print(singleJsonSymbol);
+      printedChars++;
+    }
+    if ((qComma > knownMode) || (printedChars > u8x8.getCols() - 2))
+      break;
+  }
+
+  u8x8.setFont(u8x8_font_open_iconic_embedded_1x1);
+  u8x8.drawGlyph(0, 0, 80); // wifi icon
+  u8x8.drawGlyph(0, 1, 68); // home icon
+  u8x8.setFont(u8x8_font_open_iconic_weather_2x2);
+  u8x8.drawGlyph(0, 2, 66 + (bri > 0 ? 3 : 0)); // sun/moon icon
+}