refactor: keep support for earlier revs

Changed board definitions; ported older revs to latest I2S library; force older revs to only accept pre-v0.4 updates

Author: tcsullivan

noisemeter-device/board.h

@@ -25,7 +25,7 @@
 
 #undef SERIAL
 
-#if defined(BOARD_ESP32_PCB)
+#if defined(BOARD_REV4)
 
 /** Pin number for the board's LED. */
 #define PIN_LED1    GPIO_NUM_17
@@ -45,26 +45,40 @@
 /** Serial instance to use for logging output. */
 #define SERIAL      USBSerial
 
+#define USE_MIC_IM64D130A
+
 #include <HWCDC.h>
 extern HWCDC USBSerial;
 
-#elif defined(BOARD_ESP32_BREADBOARD)
+#elif defined(BOARD_REV123)
+
+#define PIN_LED1    GPIO_NUM_0
+#define PIN_BUTTON  GPIO_NUM_1
+#define I2S_WS      GPIO_NUM_4
+#define I2S_SCK     GPIO_NUM_5
+#define I2S_SD      GPIO_NUM_6
+#define I2S_PORT    I2S_NUM_0
+#define I2S_FORMAT  I2S_CHANNEL_FMT_ONLY_LEFT
+#define SERIAL      USBSerial
+
+#define USE_MIC_SPH0645
+
+#include <HWCDC.h>
+extern HWCDC USBSerial;
 
-// Pin definitions
-#define PIN_LED1    (36) // random choice
-#define PIN_LED2    (39) // random choice
-#define PIN_BUTTON  (5)
-#define I2S_WS      (18)
-#define I2S_SCK     (23)
-#define I2S_SD      (19)
+#elif defined(BOARD_BREADBOARD)
 
-// ESP32 has two I2S peripherals
+#define PIN_LED1    GPIO_NUM_36 // random choice
+#define PIN_LED2    GPIO_NUM_39 // random choice
+#define PIN_BUTTON  GPIO_NUM_5
+#define I2S_WS      GPIO_NUM_18
+#define I2S_SCK     GPIO_NUM_23
+#define I2S_SD      GPIO_NUM_19
 #define I2S_PORT    I2S_NUM_0
 #define I2S_FORMAT  I2S_CHANNEL_FMT_ONLY_RIGHT
-
 #define SERIAL      Serial
 
-#elif defined(BOARD_TESTING)
+#define USE_MIC_SPH0645
 
 #else
 #error "Please select a board from the list in board.h!"

noisemeter-device/noisemeter-device.ino

@@ -34,7 +34,7 @@
 #include <list>
 #include <optional>
 
-#ifdef BOARD_ESP32_PCB
+#if defined(BOARD_REV4) || defined(BOARD_REV123)
 HWCDC USBSerial;
 #endif
 
@@ -211,15 +211,19 @@ void loop()
       }
     }
 
-#if defined(BOARD_ESP32_PCB)
+#if defined(BOARD_REV4) || defined(BOARD_REV123)
     // We have WiFi: also check for software updates
     if (++wakeupCount >= OTA_INTERVAL_SEC / UPLOAD_INTERVAL_SEC) {
       wakeupCount = 0;
       SERIAL.println("Checking for updates...");
 
       const auto ota = api.getLatestSoftware();
       if (ota) {
-        if (ota->version.compareTo(NOISEMETER_VERSION) > 0) {
+        if (ota->version.compareTo(NOISEMETER_VERSION) > 0
+#if defined(BOARD_REV123)
+            && ota->version.startsWith("0.3.")
+#endif // defined(BOARD_REV123)
+        ) {
           SERIAL.print(ota->version);
           SERIAL.println(" available!");
 
@@ -231,7 +235,7 @@ void loop()
         } /*else { SERIAL.println("No new updates."); }*/
       } else { SERIAL.println("Failed to reach update server!"); }
     }
-#endif // BOARD_ESP32_PCB
+#endif // defined(BOARD_REV4) || defined(BOARD_REV123)
   }
 #endif // !UPLOAD_DISABLED
 }

noisemeter-device/secret-store.cpp

@@ -17,7 +17,7 @@
 #include "secret-store.h"
 #include "board.h"
 
-#if defined(BOARD_ESP32_PCB)
+#if defined(BOARD_REV4) || defined(BOARD_REV123)
 
 #include <esp_hmac.h>
 #include <mbedtls/aes.h>
@@ -56,7 +56,7 @@ void SecretStore::decrypt(const uint8_t *in, char *out, unsigned N) const noexce
         in, reinterpret_cast<uint8_t *>(out));
 }
 
-#else // !defined(BOARD_ESP32_PCB)
+#else // BOARD_BREADBOARD
 
 #include <algorithm>
 
@@ -70,5 +70,5 @@ void SecretStore::decrypt(const uint8_t *in, char *out, unsigned N) const noexce
     std::copy(in, in + N, out);
 }
 
-#endif // defined(BOARD_ESP32_PCB)
+#endif
 

noisemeter-device/spl-meter.cpp

@@ -20,10 +20,9 @@
 
 #include <cmath>
 
+#if defined(USE_MIC_IM64D130A)
 /** Sample size time duration to use for Leq calculation (seconds). */
 static constexpr auto LEQ_PERIOD = 1.f;
-/** Number of samples to use for a Leq decibel calculation. */
-static constexpr auto SAMPLES_LEQ = SPLMeter::SAMPLE_RATE * LEQ_PERIOD;
 /** Specifies the type of weighting to use for decibel calculation: dBA, dBC, or None/Z. */
 static constexpr auto& WEIGHTING = A_weighting;
 /** Specifies the microphone's equalization filter. See pre-defined filters or set to 'None'. */
@@ -41,6 +40,19 @@ static constexpr auto MIC_OVERLOAD_DB = 130.f;
 static constexpr auto MIC_NOISE_DB = 30.f;
 /** Linear calibration offset to apply to calculated decibel values. */
 static constexpr auto MIC_OFFSET_DB = 0.f;
+#elif defined(USE_MIC_SPH0645)
+static constexpr auto LEQ_PERIOD = 1.f;
+static constexpr auto& WEIGHTING = A_weighting;
+static constexpr auto& MIC_EQUALIZER = SPH0645LM4H_B_RB;
+static constexpr auto MIC_BITS = 18u;
+static constexpr auto MIC_SENSITIVITY = -26.f;
+static constexpr auto MIC_REF_DB = 94.f;
+static constexpr auto MIC_OVERLOAD_DB = 120.f;
+static constexpr auto MIC_NOISE_DB = 29.f;
+static constexpr auto MIC_OFFSET_DB = 0.f;
+#else
+#error "Unsupported microphone! Use either SPH0645 or IM64D130A."
+#endif
 
 /** Reference amplitude level for the microphone. */
 static constexpr auto MIC_REF_AMPL = std::pow(10.f, MIC_SENSITIVITY / 20.f) * ((1 << (MIC_BITS - 1)) - 1);
@@ -52,9 +64,19 @@ void SPLMeter::initMicrophone() noexcept
     /* Setp 1: Determine the I2S channel configuration and allocate RX channel only
      * The default configuration can be generated by the helper macro,
      * but note that PDM channel can only be registered on I2S_NUM_0 */
-    i2s_chan_config_t rx_chan_cfg = I2S_CHANNEL_DEFAULT_CONFIG(I2S_PORT, I2S_ROLE_MASTER);
+    i2s_chan_config_t rx_chan_cfg = {
+        .id = I2S_PORT,
+        .role = I2S_ROLE_MASTER,
+        .dma_desc_num = 15,
+        .dma_frame_num = 400,
+        .auto_clear_after_cb = false,
+        .auto_clear_before_cb = false,
+        .allow_pd = false,
+        .intr_priority = 0,
+    };
     ESP_ERROR_CHECK(i2s_new_channel(&rx_chan_cfg, nullptr, &rx_chan));
 
+#if defined(USE_MIC_IM64D130A)
     /* Step 2: Setting the configurations of PDM RX mode and initialize the RX channel
      * The slot configuration and clock configuration can be generated by the macros
      * These two helper macros is defined in 'i2s_pdm.h' which can only be used in PDM RX mode.
@@ -71,6 +93,26 @@ void SPLMeter::initMicrophone() noexcept
     };
 
     ESP_ERROR_CHECK(i2s_channel_init_pdm_rx_mode(rx_chan, &pdm_rx_cfg));
+#elif defined(USE_MIC_SPH0645)
+    i2s_std_config_t std_rx_cfg = {
+        .clk_cfg = I2S_STD_CLK_DEFAULT_CONFIG(SAMPLE_RATE),
+        .slot_cfg = I2S_STD_MSB_SLOT_DEFAULT_CONFIG(I2S_DATA_BIT_WIDTH_32BIT, I2S_SLOT_MODE_MONO),
+        .gpio_cfg = {
+            .mclk = I2S_GPIO_UNUSED,
+            .bclk = I2S_SCK,
+            .ws = I2S_WS,
+            .dout = I2S_GPIO_UNUSED,
+            .din = I2S_SD,
+            .invert_flags = {
+                .mclk_inv = false,
+                .bclk_inv = false,
+                .ws_inv = false,
+            },
+        },
+    };
+
+    ESP_ERROR_CHECK(i2s_channel_init_std_mode(rx_chan, &std_rx_cfg));
+#endif
 
     /* Step 3: Enable the rx channels before reading data */
     ESP_ERROR_CHECK(i2s_channel_enable(rx_chan));
@@ -79,26 +121,40 @@ void SPLMeter::initMicrophone() noexcept
 
 std::optional<float> SPLMeter::readMicrophoneData() noexcept
 {
-  i2sRead();
+  const auto bread = i2sRead();
 
+#if defined(USE_MIC_IM64D130A)
   // I2S samples are 16-bit integers stored into samples's memory.
   // These need to be expanded into 32-bit floats for processing.
   // Iterate in reverse to avoid overwriting data.
-  auto src = reinterpret_cast<const int16_t *>(samples.data()) + samples.size();
-  auto dst = samples.data() + samples.size();
-  for (int i = 0; i < samples.size(); i++)
+  const auto sread = bread / sizeof(int16_t);
+  auto src = reinterpret_cast<const int16_t *>(samples.data()) + sread;
+  auto dst = samples.data() + sread;
+  for (int i = 0; i < sread; i++)
       *--dst = *--src;
+#elif defined(USE_MIC_SPH0645)
+  // Convert (including shifting) integer microphone values to floats,
+  // using the same buffer (assumed sample size is same as size of float),
+  // to save a bit of memory
+  const auto sread = bread / sizeof(int32_t) / 2;
+  auto src = reinterpret_cast<const int32_t *>(samples.data());
+  auto dst = samples.data();
+  for (int i = 0; i < sread; i++) {
+      const auto conv = src[i * 2] >> ((sizeof(int32_t) * 8u) - MIC_BITS);
+      dst[i] = conv;
+  }
+#endif
 
   // Apply equalization and calculate Z-weighted sum of squares,
   // writes filtered samples back to the same buffer.
   const auto fptr = samples.data();
-  const auto sum_sqr_SPL = MIC_EQUALIZER.filter(fptr, fptr, samples.size());
+  const auto sum_sqr_SPL = MIC_EQUALIZER.filter(fptr, fptr, sread);
 
   // Apply weighting and calucate weigthed sum of squares
-  const auto sum_sqr_weighted = WEIGHTING.filter(fptr, fptr, samples.size());
+  const auto sum_sqr_weighted = WEIGHTING.filter(fptr, fptr, sread);
 
   // Calculate dB values relative to MIC_REF_AMPL and adjust for microphone reference
-  const auto short_RMS = std::sqrt(sum_sqr_SPL / samples.size());
+  const auto short_RMS = std::sqrt(sum_sqr_SPL / sread);
   const auto short_SPL_dB = MIC_OFFSET_DB + MIC_REF_DB + 20 * std::log10(short_RMS / MIC_REF_AMPL);
 
   // In case of acoustic overload or below noise floor measurement, report infinty Leq value
@@ -110,7 +166,7 @@ std::optional<float> SPLMeter::readMicrophoneData() noexcept
 
   // Accumulate Leq sum
   Leq_sum_sqr += sum_sqr_weighted;
-  Leq_samples += samples.size();
+  Leq_samples += sread;
 
   // When we gather enough samples, calculate new Leq value
   if (Leq_samples >= SAMPLE_RATE * LEQ_PERIOD) {
@@ -124,14 +180,20 @@ std::optional<float> SPLMeter::readMicrophoneData() noexcept
   }
 }
 
-void SPLMeter::i2sRead() noexcept
+size_t SPLMeter::i2sRead() noexcept
 {
   // Block and wait for microphone values from I2S
   //
   // Data is moved from DMA buffers to our 'samples' buffer by the driver ISR
   // and when there is requested ammount of data, task is unblocked
   size_t bread;
-  (void)bread;
+
+#if defined(USE_MIC_IM64D130A)
   i2s_channel_read(i2s_handle, samples.data(), samples.size() * sizeof(int16_t), &bread, portMAX_DELAY);
+#elif defined(USE_MIC_SPH0645)
+  i2s_channel_read(i2s_handle, samples.data(), samples.size() * sizeof(int32_t), &bread, portMAX_DELAY);
+#endif
+
+  return bread;
 }
 

noisemeter-device/spl-meter.h

@@ -19,9 +19,14 @@
 #ifndef SPL_METER_H
 #define SPL_METER_H
 
+#if defined(USE_MIC_IM64D130A)
+#include <driver/i2s_pdm.h>
+#elif defined(USE_MIC_SPH0645)
+#include <driver/i2s_std.h>
+#endif
+
 #include <array>
 #include <cstdint>
-#include <driver/i2s_pdm.h>
 #include <optional>
 
 /**
@@ -44,7 +49,7 @@ class SPLMeter
 
 private:
     /** The number of samples to keep in the sample buffer. */
-    static constexpr auto SAMPLES_SHORT = SAMPLE_RATE / 8u;
+    static constexpr auto SAMPLES_SHORT = SAMPLE_RATE / 16u;
 
     /** Buffer to store microphone samples in for reading and processing. */
     alignas(4)
@@ -58,7 +63,7 @@ class SPLMeter
     i2s_chan_handle_t i2s_handle;
 
     /** Reads enough samples from the microphone to fill the samples buffer. */
-    void i2sRead() noexcept;
+    size_t i2sRead() noexcept;
 };
 
 #endif // SPL_METER_H

platformio.ini

@@ -11,7 +11,7 @@
 [platformio]
 src_dir = noisemeter-device
 include_dir = noisemeter-device
-default_envs = esp32-pcb
+default_envs = rev4
 
 [env]
 extra_scripts = build_hooks.py
@@ -26,7 +26,6 @@ build_unflags =
 build_flags = 
 	-std=gnu++17
 	-DNO_GLOBAL_EEPROM
-        -DNOISEMETER_VERSION=\"0.4.0\"
 	-Wall -Wextra
 
 # Optional build flags:
@@ -37,13 +36,23 @@ build_flags =
 #   Disable WiFi and data upload:
 #     -DUPLOAD_DISABLED
 
-[env:esp32-pcb]
+# v0.3.x is for pre-rev4 hardware (ESP32-C3)
+# v0.4.x and beyond is for rev4 and later (ESP32-S3)
+
+[env:rev4]
 extra_scripts = build_hooks.py
 board = esp32-s3-devkitm-1
 board_build.f_cpu = 80000000L
-build_flags = ${env.build_flags} -DBOARD_ESP32_PCB
+build_flags = ${env.build_flags} -DBOARD_REV4 -DNOISEMETER_VERSION=\"0.4.1\"
+
+[env:rev123]
+extra_scripts = build_hooks.py
+board = esp32-c3-devkitm-1
+board_build.f_cpu = 160000000L
+board_build.flash_mode = qio
+build_flags = ${env.build_flags} -DBOARD_REV123 -DNOISEMETER_VERSION=\"0.3.0\"
 
-[env:esp32-breadboard]
+[env:breadboard]
 board = upesy_wroom
-build_flags = ${env.build_flags} -DBOARD_ESP32_BREADBOARD
+build_flags = ${env.build_flags} -DBOARD_BREADBOARD