Fixes after audit, improved docs.

troyhacks · troyhacks · commit 4ae70a4f5f84 · 2026-05-20T17:50:24.000-04:00
diff --git a/usermods/M5Stack_CoreS3_Display/readme.md b/usermods/M5Stack_CoreS3_Display/readme.md
@@ -17,13 +17,20 @@ Reset is controlled via the AW9523B GPIO expander (P1_1). Backlight is powered v
 
 In `platformio_override.ini` for your M5Stack Core S3 environment:
 
-```ini
-build_flags =
+```build_flags =
     -D USERMOD_M5STACK_CORE_S3_DISPLAY
+    ;; For the M5Stack ModuleAudio:
+    -D SR_ENABLE_DEFAULT
+    -D SR_DMTYPE=6
+    -D I2S_SDPIN=13
+    -D I2S_WSPIN=6
+    -D I2S_CKPIN=0
+    -D MCLK_PIN=7
+    -D HW_SDA_PIN=12
+    -D HW_SCL_PIN=11
 
 lib_deps =
-    https://github.com/lovyan03/LovyanGFX
-```
+    https://github.com/lovyan03/LovyanGFX```
 
 ## Features
 
@@ -32,11 +39,25 @@ lib_deps =
 - Real audio reactive data when Audioreactive usermod is enabled
 - Simulated bouncing bars when no audio data
 - Rainbow color per bar (red → violet)
-- Auto sleep after 5 minutes of inactivity
+- Maximum of 100 FPS to match AudioReactive
+- Minimum of 5 FPS so it updates even if you use unlimited FPS mode.
 
 ## Display Notes
 
 - Uses LovyanGFX with `SPI3_HOST` (HSPI)
 - Native landscape 320x240 resolution
 - BGR color order, display inversion enabled
 - Backlight always on (controlled by AXP2101 DLDO1)
+
+## TroyHacks Recommended AudioReactive Settings
+
+For the M5Stack Core S3 + ModuleAudio line-in:
+
+- The ModuleAudio uses an ES8388
+- Squelch & Gain at 1
+- AGC is Normal
+- MicLev is Freeze
+- Mic Quality is Perfect
+- FFT Window is Nutall (or whatever you prefer)
+- Profile is Generic Line-In
+- Limiter is Enabled, with a rise of 1 and a fall of 250 (to 500).
diff --git a/usermods/M5Stack_CoreS3_Display/usermod_m5stack_s3_display.h b/usermods/M5Stack_CoreS3_Display/usermod_m5stack_s3_display.h
@@ -72,23 +72,19 @@ class LGFX_ILI9342_M5StackS3 : public lgfx::LGFX_Device {
 
 static LGFX_ILI9342_M5StackS3 tft;
 
-extern int getSignalQuality(int rssi);
-
 
 //class name. Use something descriptive and leave the ": public Usermod" part :)
 class M5StackCoreS3DisplayUsermod : public Usermod {
   private:
     bool enabled = true;
 
-    bool displayTurnedOff = false;
-    long lastRedraw = 0;
     // 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;
 
-    long lastUpdate = 0;
+    unsigned long lastUpdate = 0;
 
     // GEQ display constants
     static constexpr uint8_t NUM_GEQ_BANDS = 16;
@@ -102,19 +98,19 @@ class M5StackCoreS3DisplayUsermod : public Usermod {
         case  0: return 0xF800;  // red
         case  1: return 0xFC00;  // orange
         case  2: return 0xFC40;  // amber
-        case  3: return 0xFCC0;  // yellow-orange
-        case  4: return 0xFFE0;  // yellow
-        case  5: return 0xC700;  // yellow-green
-        case  6: return 0x07E0;  // green
-        case  7: return 0x07EF;  // green-cyan
-        case  8: return 0x07FF;  // cyan
-        case  9: return 0x041F;  // cyan-blue
-        case 10: return 0x001F;  // blue
-        case 11: return 0x281F;  // blue-indigo
-        case 12: return 0x601F;  // indigo
-        case 13: return 0x781F;  // violet
-        case 14: return 0xF81F;  // magenta
-        case 15: return 0xF81F;  // magenta
+        case  3: return 0xFFC0;  // yellow
+        case  4: return 0x07E0;  // green
+        case  5: return 0x07EF;  // green-cyan
+        case  6: return 0x07FF;  // cyan
+        case  7: return 0x001F;  // blue
+        case  8: return 0x281F;  // blue-indigo
+        case  9: return 0x481F;  // indigo
+        case 10: return 0x701F;  // violet
+        case 11: return 0x881F;  // violet-magenta
+        case 12: return 0xF81F;  // magenta
+        case 13: return 0xF81C;  // magenta-red
+        case 14: return 0xF800;  // red
+        case 15: return 0xF808;  // red-orange
         default: return 0xF800;
       }
     }
@@ -130,11 +126,13 @@ class M5StackCoreS3DisplayUsermod : public Usermod {
     {
         Serial.println("M5StackS3Display: starting setup");
 
-        // Ensure Wire is initialized
+        // Ensure Wire is initialized (safe to call even if WLED already started it)
         if (i2c_sda >= 0 && i2c_scl >= 0) {
             Wire.begin(i2c_sda, i2c_scl);
-            Wire.setTimeout(50);
+        } else {
+            Wire.begin();
         }
+        Wire.setTimeout(50);
 
         // AXP2101 - enable DLDO1 (VCC_BL per user)
         // Read current state first
@@ -217,6 +215,19 @@ class M5StackCoreS3DisplayUsermod : public Usermod {
         Serial.println("M5StackS3Display: init TFT");
         tft.init();
 
+        // Lock SPI pins so they can't be reassigned to other usermods
+        PinManagerPinType pins[] = {
+            { (gpio_num_t)TFT_MOSI, true },
+            { (gpio_num_t)TFT_SCLK, true },
+            { (gpio_num_t)TFT_CS,   true },
+            { (gpio_num_t)TFT_DC,  true }
+        };
+        if (pinManager.allocateMultiplePins(pins, 4, PinOwner::UM_Unspecified)) {
+            Serial.println("M5StackS3Display: SPI pins allocated");
+        } else {
+            Serial.println("M5StackS3Display: SPI pin allocation FAILED");
+        }
+
         Serial.printf("M5StackS3Display: TFT width: %d, height: %d\n", tft.width(), tft.height());
 
         // Dynamic header sizing
@@ -243,59 +254,54 @@ class M5StackCoreS3DisplayUsermod : public Usermod {
      * loop() is called continuously. Here you can check for events, read sensors, etc.
      */
     void loop() {
-        // Faster refresh for bouncing bars
-        if (millis() - lastUpdate < 100)  // 50ms = 20fps
-        {
+        if (!enabled) return;
+
+        unsigned long now = millis();
+
+        // Standard max framerate cap (~100 FPS, matches audio reactive update rate)
+        if (now - lastUpdate < 10) return;
+
+        // Fallback: if LEDs are hogging CPU, only block if we refreshed recently enough
+        // Otherwise punch through to guarantee minimum 5 FPS on display
+        if (strip.isUpdating() && (now - lastUpdate < 200)) {
             return;
         }
-        lastUpdate = millis();
 
-        // Turn off display after 5 minutes with no change.
-        if (!displayTurnedOff && millis() - lastRedraw > 5*60*1000)
-        {
-            displayTurnedOff = true;
-        }
+        lastUpdate = now;
 
-        // Check if values which are shown on display changed from the last time.
-        #if defined(ESP8266)
+        // Skip content/header updates while LEDs are being updated
+        if (!strip.isUpdating()) {
+            // Check if values which are shown on display changed from the last time.
             String currentSsid = apActive ? String(apSSID) : WiFi.SSID();
-        #else
-            String currentSsid = WiFi.SSID();
-        #endif
-        IPAddress currentIp = apActive ? IPAddress(4, 3, 2, 1) : Network.localIP();
-
-        if (currentSsid != knownSsid || currentIp != knownIp)
-        {
-            needRedraw = true;
-            knownSsid = currentSsid;
-            knownIp = currentIp;
-        }
+            IPAddress currentIp = apActive ? IPAddress(4, 3, 2, 1) : Network.localIP();
 
-        if (displayTurnedOff)
-        {
-            displayTurnedOff = false;
-        }
-        lastRedraw = millis();
+            if (currentSsid != knownSsid || currentIp != knownIp)
+            {
+                needRedraw = true;
+                knownSsid = currentSsid;
+                knownIp = currentIp;
+            }
 
-        // === HEADER: Only redraw when needed ===
-        if (needRedraw) {
-            // Gray background
-            tft.fillRect(0, 0, tft.width(), HEADER_HEIGHT, TFT_DARKGREY);
+            // === HEADER: Only redraw when needed ===
+            if (needRedraw) {
+                // Gray background
+                tft.fillRect(0, 0, tft.width(), HEADER_HEIGHT, TFT_DARKGREY);
 
-            // Text vertically centered in header
-            int16_t textY = (HEADER_HEIGHT - tft.fontHeight()) / 2;
-            tft.setTextSize(2);
-            tft.setTextColor(TFT_WHITE);
+                // Text vertically centered in header
+                int16_t textY = (HEADER_HEIGHT - tft.fontHeight()) / 2;
+                tft.setTextSize(2);
+                tft.setTextColor(TFT_WHITE);
 
-            // SSID on left
-            tft.setTextDatum(TL_DATUM);
-            tft.drawString(knownSsid.c_str(), 10, textY);
+                // SSID on left
+                tft.setTextDatum(TL_DATUM);
+                tft.drawString(knownSsid.c_str(), 10, textY);
 
-            // IP on right
-            tft.setTextDatum(TR_DATUM);
-            tft.drawString(knownIp.toString().c_str(), tft.width() - 10, textY);
+                // IP on right
+                tft.setTextDatum(TR_DATUM);
+                tft.drawString(knownIp.toString().c_str(), tft.width() - 10, textY);
 
-            needRedraw = false;
+                needRedraw = false;
+            }
         }
 
         // === 16 BOUNCING BARS - differential drawing ===
@@ -369,20 +375,12 @@ class M5StackCoreS3DisplayUsermod : public Usermod {
     void addToConfig(JsonObject& root)
     {
       JsonObject top = root.createNestedObject("M5StackS3Display");
-      top["CS"] = TFT_CS;
-      top["DC"] = TFT_DC;
-      top["MOSI"] = TFT_MOSI;
-      top["SCLK"] = TFT_SCLK;
       top["enabled"] = enabled;
     }
 
     void appendConfigData()
     {
       oappend(SET_F("addHB('M5StackS3Display');"));
-      oappend(SET_F("addInfo('M5StackS3Display:CS',0,'SPI Chip Select (GPIO3)');"));
-      oappend(SET_F("addInfo('M5StackS3Display:DC',0,'Data/Command (GPIO35)');"));
-      oappend(SET_F("addInfo('M5StackS3Display:MOSI',0,'SPI MOSI (GPIO37)');"));
-      oappend(SET_F("addInfo('M5StackS3Display:SCLK',0,'SPI Clock (GPIO36)');"));
     }
 
     /*
diff --git a/wled00/wled.cpp b/wled00/wled.cpp
@@ -491,7 +491,7 @@ void WLED::setup()
 
   #if ARDUINO_USB_CDC_ON_BOOT && (defined(CONFIG_IDF_TARGET_ESP32S3) || defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32P4))
   Serial.begin(115200);     //  WLEDMM avoid "hung devices" when USB_CDC is enabled; see https://github.com/espressif/arduino-esp32/issues/9043
-  Serial.setTxTimeoutMs(1); // potential side-effect: incomplete debug output, with missing characters whenever TX buffer is full.
+  Serial.setTxTimeoutMs(0); // potential side-effect: incomplete debug output, with missing characters whenever TX buffer is full.
   #else
   Serial.begin(115200);
   #endif
@@ -525,7 +525,7 @@ void WLED::setup()
   #if ARDUINO_USB_CDC_ON_BOOT || ARDUINO_USB_MODE
     #if ARDUINO_USB_CDC_ON_BOOT && (defined(CONFIG_IDF_TARGET_ESP32S3) || defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32P4))
     //  WLEDMM avoid "hung devices" when USB_CDC is enabled; see https://github.com/espressif/arduino-esp32/issues/9043
-    Serial.setTxTimeoutMs(1);    
+    Serial.setTxTimeoutMs(0);    
     #endif
 #if !defined(WLEDMM_NO_SERIAL_WAIT) || defined(WLED_DEBUG)
   if (!Serial) delay(2500);  // WLEDMM: always allow CDC USB serial to initialise
