fix compilation issues; closes #40

Author: stas-sl

.github/workflows/ci.yaml

@@ -11,12 +11,12 @@ jobs:
     name: ${{ matrix.name }}
     runs-on: ubuntu-latest
     env:
-      ESPHOME_VERSION: 2024.9.0
+      ESPHOME_VERSION: 2025.7.2
       PLATFORMIO_LIBDEPS_DIR: ~/.platformio/libdeps
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.11"]
+        python-version: ["3.13"]
 
     steps:
       - uses: actions/checkout@v4

README.md

@@ -23,6 +23,7 @@ i2s:
   din_pin: 19
   sample_rate: 48000            # default: 48000
   bits_per_sample: 32           # default: 32
+  mclk_multiple: 256            # default: 256
   dma_buf_count: 8              # default: 8
   dma_buf_len: 256              # default: 256
   use_apll: true                # default: false
@@ -264,9 +265,9 @@ I'm not so familiar with assembler and it is hard to understand and maintain, so
 
 ### Supported platforms
 
-Tested with ESPHome version 2024.9.0, platforms:
-- [x] ESP32 (Arduino v2.0.6, ESP-IDF v4.4.5)
-- [x] ESP32-IDF (ESP-IDF v4.4.7)
+Tested with ESPHome version 2025.7.2, platforms:
+- [x] ESP32 (Arduino v3.1.3, ESP-IDF v5.3.2)
+- [x] ESP32-IDF (ESP-IDF v5.3.2)
 
 ### Sending data to sensor.community
 

components/i2s/__init__.py

@@ -18,6 +18,7 @@
 CONF_DOUT_PIN = "dout_pin"
 CONF_SAMPLE_RATE = "sample_rate"
 CONF_BITS_PER_SAMPLE = "bits_per_sample"
+CONF_MCLK_MULTIPLE = "mclk_multiple"
 CONF_DMA_BUF_COUNT = "dma_buf_count"
 CONF_DMA_BUF_LEN = "dma_buf_len"
 CONF_USE_APLL = "use_apll"
@@ -31,6 +32,15 @@
     "right": i2s_channel_fmt_t.I2S_CHANNEL_FMT_ONLY_RIGHT,
 }
 
+
+def validate_mclk_divisible_by_3(config):
+    if config[CONF_BITS_PER_SAMPLE] == 24 and config[CONF_MCLK_MULTIPLE] % 3 != 0:
+        raise cv.Invalid(
+            f"{CONF_MCLK_MULTIPLE} must be divisible by 3 when bits per sample is 24"
+        )
+    return config
+
+
 CONFIG_SCHEMA = cv.All(
     cv.Schema(
         {
@@ -41,6 +51,8 @@
             cv.Optional(CONF_DOUT_PIN): pins.internal_gpio_output_pin_schema,
             cv.Optional(CONF_SAMPLE_RATE, 48000): cv.positive_not_null_int,
             cv.Optional(CONF_BITS_PER_SAMPLE, 32): cv.one_of(8, 16, 24, 32, int=True),
+            cv.Optional(CONF_MCLK_MULTIPLE, default=256):
+                cv.one_of(128, 192, 256, 384, 512, 576, 768, 1024, 1152, int=True),
             cv.Optional(CONF_DMA_BUF_COUNT, 8): cv.positive_not_null_int,
             cv.Optional(CONF_DMA_BUF_LEN, 256): cv.positive_not_null_int,
             cv.Optional(CONF_USE_APLL, False): cv.boolean,
@@ -49,6 +61,7 @@
         }
     ).extend(cv.COMPONENT_SCHEMA),
     cv.has_at_least_one_key(CONF_DIN_PIN, CONF_DOUT_PIN),
+    validate_mclk_divisible_by_3
 )
 
 
@@ -69,6 +82,7 @@ async def to_code(config):
         cg.add(var.set_dout_pin(dout_pin))
     cg.add(var.set_sample_rate(config[CONF_SAMPLE_RATE]))
     cg.add(var.set_bits_per_sample(config[CONF_BITS_PER_SAMPLE]))
+    cg.add(var.set_mclk_multiple(config[CONF_MCLK_MULTIPLE]))
     cg.add(var.set_dma_buf_count(config[CONF_DMA_BUF_COUNT]))
     cg.add(var.set_dma_buf_len(config[CONF_DMA_BUF_LEN]))
     cg.add(var.set_use_apll(config[CONF_USE_APLL]))

components/i2s/i2s.cpp

@@ -1,4 +1,5 @@
 #include "i2s.h"
+#include "esp_timer.h"
 
 namespace esphome {
 namespace i2s {
@@ -13,6 +14,8 @@ void I2SComponent::set_sample_rate(uint32_t sample_rate) { this->sample_rate_ =
 uint32_t I2SComponent::get_sample_rate() const { return this->sample_rate_; }
 void I2SComponent::set_bits_per_sample(uint8_t bits_per_sample) { this->bits_per_sample_ = bits_per_sample; }
 uint8_t I2SComponent::get_bits_per_sample() const { return this->bits_per_sample_; }
+void I2SComponent::set_mclk_multiple(uint32_t mclk_multiple) { this->mclk_multiple_ = mclk_multiple; }
+uint32_t I2SComponent::get_mclk_multiple() const { return this->mclk_multiple_; }
 void I2SComponent::set_dma_buf_count(int dma_buf_count) { this->dma_buf_count_ = dma_buf_count; }
 int I2SComponent::get_dma_buf_count() const { return this->dma_buf_count_; }
 void I2SComponent::set_dma_buf_len(int dma_buf_len) { this->dma_buf_len_ = dma_buf_len; }
@@ -30,8 +33,9 @@ void I2SComponent::dump_config() {
   LOG_PIN("  BCK Pin: ", this->bck_pin_);
   LOG_PIN("  DIN Pin: ", this->din_pin_);
   LOG_PIN("  DOUT Pin: ", this->dout_pin_);
-  ESP_LOGCONFIG(TAG, "  Sample Rate: %u", this->sample_rate_);
+  ESP_LOGCONFIG(TAG, "  Sample Rate: %lu", this->sample_rate_);
   ESP_LOGCONFIG(TAG, "  Bits Per Sample: %u", this->bits_per_sample_);
+  ESP_LOGCONFIG(TAG, "  MCLK Multiple: %lu", this->mclk_multiple_);
   ESP_LOGCONFIG(TAG, "  DMA Buf Count: %u", this->dma_buf_count_);
   ESP_LOGCONFIG(TAG, "  DMA Buf Len: %u", this->dma_buf_len_);
   ESP_LOGCONFIG(TAG, "  Use APLL: %s", YESNO(this->use_apll_));
@@ -143,7 +147,7 @@ void I2SComponent::setup() {
                              .use_apll = this->use_apll_,
                              .tx_desc_auto_clear = false,
                              .fixed_mclk = 0,
-                             .mclk_multiple = I2S_MCLK_MULTIPLE_DEFAULT,
+                             .mclk_multiple = i2s_mclk_multiple_t(this->mclk_multiple_),
                              .bits_per_chan = i2s_bits_per_chan_t(0)};
 
   i2s_pin_config_t i2s_pin_config = {

components/i2s/i2s.h

@@ -20,6 +20,8 @@ class I2SComponent : public Component {
   uint32_t get_sample_rate() const;
   void set_bits_per_sample(uint8_t bits_per_sample);
   uint8_t get_bits_per_sample() const;
+  void set_mclk_multiple(uint32_t mclk_multiple);
+  uint32_t get_mclk_multiple() const;
   void set_dma_buf_count(int dma_buf_count);
   int get_dma_buf_count() const;
   void set_dma_buf_len(int dma_buf_len);
@@ -46,6 +48,7 @@ class I2SComponent : public Component {
 
   uint32_t sample_rate_{48000};
   uint8_t bits_per_sample_{32};
+  uint32_t mclk_multiple_{256};
   uint8_t port_num_{0};
   int dma_buf_count_{8};
   int dma_buf_len_{256};

components/sound_level_meter/sound_level_meter.cpp

@@ -37,8 +37,8 @@ optional<float> SoundLevelMeter::get_offset() { return this->offset_; }
 void SoundLevelMeter::dump_config() {
   ESP_LOGCONFIG(TAG, "Sound Level Meter:");
   ESP_LOGCONFIG(TAG, "  Buffer Size: %u (samples)", this->buffer_size_);
-  ESP_LOGCONFIG(TAG, "  Warmup Interval: %u ms", this->warmup_interval_);
-  ESP_LOGCONFIG(TAG, "  Task Stack Size: %u", this->task_stack_size_);
+  ESP_LOGCONFIG(TAG, "  Warmup Interval: %lu ms", this->warmup_interval_);
+  ESP_LOGCONFIG(TAG, "  Task Stack Size: %lu", this->task_stack_size_);
   ESP_LOGCONFIG(TAG, "  Task Priority: %u", this->task_priority_);
   ESP_LOGCONFIG(TAG, "  Task Core: %u", this->task_core_);
   LOG_UPDATE_INTERVAL(this);
@@ -117,7 +117,7 @@ void SoundLevelMeter::task(void *param) {
       auto sr = this_->get_sample_rate();
       if (process_count >= sr * (this_->update_interval_ / 1000.f)) {
         auto t = uint32_t(float(process_time) / process_count * (sr / 1000.f));
-        ESP_LOGD(TAG, "Processing time per 1s of audio data (%u samples): %u ms", sr, t);
+        ESP_LOGD(TAG, "Processing time per 1s of audio data (%lu samples): %u ms", sr, t);
         process_time = process_count = 0;
       }
     }

components/sound_level_meter/sound_level_meter.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "esp_timer.h"
 #include <mutex>
 #include <condition_variable>
 #include <algorithm>

configs/advanced-example-config.yaml

@@ -20,6 +20,7 @@ i2s:
   din_pin: 19
   sample_rate: 48000            # default: 48000
   bits_per_sample: 32           # default: 32
+  mclk_multiple: 256            # default: 256
   dma_buf_count: 8              # default: 8
   dma_buf_len: 256              # default: 256
   use_apll: true                # default: false

configs/sensor-community-example-config.yaml

@@ -40,6 +40,7 @@ i2s:
   din_pin: 19
   sample_rate: 48000
   bits_per_sample: 32
+  mclk_multiple: 256
   dma_buf_count: 8
   dma_buf_len: 256
   use_apll: true