fix: Cardputer-Adv I2S sound (#9963)

* fix cardputer sound

* Add I2S BLEEBLEs

* MenuHandler ifdefs

* add generic tone -> I2S RTTTL conversion

* not needed

---------

Co-authored-by: Jonathan Bennett <jbennett@incomsystems.biz>

src/buzz/buzz.cpp

@@ -6,6 +6,11 @@
 #include "Tone.h"
 #endif
 
+#if defined(HAS_I2S)
+#include "main.h"
+#include <unordered_map>
+#endif
+
 #if !defined(ARCH_PORTDUINO)
 extern "C" void delay(uint32_t dwMs);
 #endif
@@ -50,6 +55,50 @@ const int DURATION_1_2 = 500;  // 1/2 note
 const int DURATION_3_4 = 750;  // 3/4 note
 const int DURATION_1_1 = 1000; // 1/1 note
 
+#ifdef HAS_I2S
+void playTonesRTTTL(const ToneDuration *tone_durations, int size)
+{
+    // translate ToneDuration[] to RTTTL string and play using audioThread
+    static std::unordered_map<int, std::string> freqToNote = {
+        {NOTE_C3, "c4"},   {NOTE_CS3, "c#4"}, {NOTE_D3, "d4"},   {NOTE_DS3, "d#4"}, {NOTE_E3, "e4"},   {NOTE_F3, "f4"},
+        {NOTE_FS3, "f#4"}, {NOTE_G3, "g4"},   {NOTE_GS3, "g#4"}, {NOTE_A3, "a4"},   {NOTE_AS3, "a#4"}, {NOTE_B3, "b4"},
+        {NOTE_C4, "c5"},   {NOTE_E4, "e5"},   {NOTE_G4, "g5"},   {NOTE_A4, "a5"},   {NOTE_C5, "c6"},   {NOTE_E5, "e6"},
+        {NOTE_G5, "g6"},   {NOTE_F5, "f6"},   {NOTE_G6, "g7"},   {NOTE_E7, "e8"}};
+
+    char rtttl[128] = "tone:d=32,o=4,b=200:"; // default duration and octave
+    for (int i = 0; i < size; i++) {
+        const auto &td = tone_durations[i];
+        std::string note = "b4";
+        if (freqToNote.find(td.frequency_khz) != freqToNote.end()) {
+            note = freqToNote[td.frequency_khz];
+        }
+        int dur = 32; // default duration
+        if (td.duration_ms >= 1000)
+            dur = 1;
+        else if (td.duration_ms >= 500)
+            dur = 2;
+        else if (td.duration_ms >= 250)
+            dur = 4;
+        else if (td.duration_ms >= 125)
+            dur = 8;
+        else if (td.duration_ms >= 62)
+            dur = 16;
+        else
+            dur = 32;
+
+        char noteStr[64];
+        snprintf(noteStr, sizeof(noteStr), "%s,%d", note.c_str(), dur);
+        strncat(rtttl, noteStr, sizeof(rtttl) - strlen(rtttl) - 1);
+
+        audioThread->beginRttl(rtttl, strlen(rtttl));
+        while (audioThread->isPlaying()) {
+            delay(10);
+        }
+        return;
+    }
+}
+#endif
+
 void playTones(const ToneDuration *tone_durations, int size)
 {
     if (config.device.buzzer_mode == meshtastic_Config_DeviceConfig_BuzzerMode_DISABLED ||
@@ -57,7 +106,13 @@ void playTones(const ToneDuration *tone_durations, int size)
         // Buzzer is disabled or not set to system tones
         return;
     }
-#ifdef PIN_BUZZER
+#ifdef HAS_I2S
+    if (moduleConfig.external_notification.use_i2s_as_buzzer && audioThread) {
+        playTonesRTTTL(tone_durations, size);
+        return;
+    }
+#endif
+#if defined(PIN_BUZZER)
     if (!config.device.buzzer_gpio)
         config.device.buzzer_gpio = PIN_BUZZER;
 #endif

src/graphics/draw/MenuHandler.cpp

@@ -2204,9 +2204,9 @@ void menuHandler::traceRouteMenu()
 void menuHandler::testMenu()
 {
 
-    enum optionsNumbers { Back, NumberPicker, ShowChirpy };
-    static const char *optionsArray[4] = {"Back"};
-    static int optionsEnumArray[4] = {Back};
+    enum optionsNumbers { Back, NumberPicker, ShowChirpy, TestAnnounce };
+    static const char *optionsArray[5] = {"Back"};
+    static int optionsEnumArray[5] = {Back};
     int options = 1;
 
     optionsArray[options] = "Number Picker";
@@ -2214,6 +2214,10 @@ void menuHandler::testMenu()
 
     optionsArray[options] = screen->isFrameHidden("chirpy") ? "Show Chirpy" : "Hide Chirpy";
     optionsEnumArray[options++] = ShowChirpy;
+#ifdef HAS_I2S
+    optionsArray[options] = "Test Announce";
+    optionsEnumArray[options++] = TestAnnounce;
+#endif
 
     BannerOverlayOptions bannerOptions;
     bannerOptions.message = "Hidden Test Menu";
@@ -2228,6 +2232,10 @@ void menuHandler::testMenu()
             screen->toggleFrameVisibility("chirpy");
             screen->setFrames(Screen::FOCUS_SYSTEM);
 
+        } else if (selected == TestAnnounce) {
+#ifdef HAS_I2S
+            audioThread->readAloud("This is a test of the emergency broadcast system. This is only a test.");
+#endif
         } else {
             menuQueue = SystemBaseMenu;
             screen->runNow();

variants/esp32s3/m5stack_cardputer_adv/platformio.ini

@@ -8,15 +8,17 @@ upload_protocol = esptool
 build_flags = 
   ${esp32s3_base.build_flags}
   -D M5STACK_CARDPUTER_ADV
-  -D BOARD_HAS_PSRAM
   -D ARDUINO_USB_CDC_ON_BOOT=1
   -I variants/esp32s3/m5stack_cardputer_adv
+build_src_filter =
+  ${esp32s3_base.build_src_filter}
+  +<../variants/esp32s3/m5stack_cardputer_adv>
 lib_deps =
   ${esp32s3_base.lib_deps}
   # renovate: datasource=git-refs depName=meshtastic-st7789 packageName=https://github.com/meshtastic/st7789 gitBranch=main
   https://github.com/meshtastic/st7789/archive/9ee76d6b18b9a8f45a2c5cae06b1134a587691eb.zip
-#  # renovate: datasource=github-tags depName=pschatzmann_arduino-audio-driver packageName=pschatzmann/arduino-audio-driver
-#  https://github.com/pschatzmann/arduino-audio-driver/archive/v0.2.1.zip
+  # renovate: datasource=github-tags depName=pschatzmann_arduino-audio-driver packageName=pschatzmann/arduino-audio-driver
+  https://github.com/pschatzmann/arduino-audio-driver/archive/v0.2.1.zip
   # renovate: datasource=git-refs depName=ESP8266Audio packageName=https://github.com/meshtastic/ESP8266Audio gitBranch=meshtastic-2.0.0-dacfix
   https://github.com/meshtastic/ESP8266Audio/archive/343024632ee78d6216907b2353fc943a62422d80.zip
   # renovate: datasource=custom.pio depName=ESP8266SAM packageName=earlephilhower/library/ESP8266SAM

variants/esp32s3/m5stack_cardputer_adv/variant.cpp

@@ -0,0 +1,40 @@
+#include "AudioBoard.h"
+#include "configuration.h"
+
+DriverPins PinsAudioBoardES8311;
+AudioBoard board(AudioDriverES8311, PinsAudioBoardES8311);
+
+// M5stack Cardputer ADV specific init
+
+void lateInitVariant()
+{
+    // AudioDriverLogger.begin(Serial, AudioDriverLogLevel::Debug);
+    //  I2C: function, scl, sda
+    PinsAudioBoardES8311.addI2C(PinFunction::CODEC, Wire);
+    // I2S: function, mclk, bck, ws, data_out, data_in
+    PinsAudioBoardES8311.addI2S(PinFunction::CODEC, DAC_I2S_MCLK, DAC_I2S_BCK, DAC_I2S_WS, DAC_I2S_DOUT, DAC_I2S_DIN);
+
+    // configure codec
+    CodecConfig cfg;
+    cfg.input_device = ADC_INPUT_LINE1;
+    cfg.output_device = DAC_OUTPUT_ALL;
+    cfg.i2s.bits = BIT_LENGTH_16BITS;
+    cfg.i2s.rate = RATE_44K;
+    board.begin(cfg);
+
+    // extra ES8311 init
+    auto es8311_write_reg = [](uint8_t reg, uint8_t val) {
+        Wire.beginTransmission(0x18); // ES8311 i2c address
+        Wire.write(reg);
+        Wire.write(val);
+        Wire.endTransmission();
+    };
+    es8311_write_reg(0x00, 0x80); // reset, power on
+    es8311_write_reg(0x01, 0xB5); // MCLK = BCLK
+    es8311_write_reg(0x02, 0x18); // CLOCK_MANAGER/ MULT_PRE=3
+    es8311_write_reg(0x0D, 0x01); // analog power up
+    es8311_write_reg(0x12, 0x00); // DAC power up
+    es8311_write_reg(0x13, 0x10); // enable HP drive
+    es8311_write_reg(0x32, 0xBF); // DAC volume (0dB)
+    es8311_write_reg(0x37, 0x08); // EQ bypass
+}