I²S Audio Microphone¶
The i2s_audio
microphone platform allows you to receive audio via the the I²S Audio Component.
This platform only works on ESP32 based chips.
Warning
Audio and voice components consume a significant amount of resources (RAM, CPU) on the device.
Crashes are likely to occur if you include too many additional components in your device’s configuration. In particular, Bluetooth/BLE components are known to cause issues when used in combination with Voice Assistant and/or other audio components.
# Example configuration entry
microphone:
- platform: i2s_audio
id: external_mic
adc_type: external
i2s_din_pin: GPIOXX
- platform: i2s_audio
id: adc_mic
adc_type: internal
adc_pin: GPIOXX
Configuration variables:¶
adc_type (Required, enum):
external
: Use an external ADC connected to the I²S bus.internal
: Use the internal ADC of the ESP32. Only supported on ESP32, no variant support.
channel (Optional, enum): The channel of the microphone. One of
left
,right
, orstereo
. Ifstereo
, the output data will be twice as big, with each right sample followed by a left sample. Defaults toright
.sample_rate (Optional, positive integer): I2S sample rate. Defaults to
16000
.bits_per_sample (Optional, enum): The bit depth of the audio samples. Note that while set to
24bit
or32bit
, the samples will be scaled down to 16bit before being forwarded. One of8bit
,16bit
,24bit
, or32bit
. Defaults to32bit
.bits_per_channel (Optional, enum): The bit depth of the audio channels. See the datasheet of your I2S device for details. Defaults to
bits_per_sample
.use_apll (Optional, boolean): I2S using APLL as main I2S clock, enable it to get accurate clock. Defaults to
false
.i2s_mode (Optional, enum): The I²S mode to use. One of
primary
(clock driven by the host) orsecondary
(clock driven by the attached device). Defaults toprimary
.i2s_audio_id (Optional, ID): The ID of the I²S Audio you wish to use for this microphone.
All other options from Microphone
External ADC¶
i2s_din_pin (Required, Pin Schema): The GPIO pin to use for the I²S
DIN/SDIN
(Data In) signal, also referred to asSD/SDATA
(Serial Data) orADCDAT
(Analog to Digital Converter Data).pdm (Optional, boolean): Set this to
true
if your external ADC uses PDM (Pulse Density Modulation) instead of I²S. Defaults tofalse
.Note
PDM microphones are only supported on ESP32 and ESP32-S3.
Internal ADC¶
Note
Internal ADC microphones are only supported on a regular ESP32, not the variants.
adc_pin (Required, Pin Schema): The GPIO pin to use for the ADC input.
Known Devices¶
M5Stack Atom Echo¶
microphone:
- platform: i2s_audio
adc_type: external
i2s_din_pin: GPIOXX
pdm: true
RaspiAudio Muse Luxe¶
microphone:
- platform: i2s_audio
i2s_din_pin: GPIOXX
adc_type: external
pdm: false