Skip to content

Commit

Permalink
[es7243e] Add docs for ES7243E audio ADC (#4597)
Browse files Browse the repository at this point in the history
  • Loading branch information
kbx81 authored Jan 22, 2025
1 parent a35555c commit 2a650cd
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 0 deletions.
68 changes: 68 additions & 0 deletions components/audio_adc/es7243e.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
ES7243E
=======

.. seo::
:description: Instructions for using ESPHome's ES7243E platform to configure microphone inputs.
:image: es7243e.svg
:keywords: ES7243E, Audio, ADC, I2S, ESP32

The ``es7243e`` platform allows your ESPHome devices to use the ES7243E high performance four channel audio ADC
(`datasheet <https://www.lcsc.com/datasheet/lcsc_datasheet_2410121611_Everest-semi-Everest-Semiconductor-ES7243E_C2929446.pdf>`__).
This allows attached microphones to be used as a microphone input via :doc:`/components/microphone/i2s_audio`.

The :ref:`I²C bus <i2c>` is required in your configuration as this is used to communicate with the ES7243e.

.. code-block:: yaml
# Example configuration entry
audio_adc:
- platform: es7243e
.. _config-es7243e:

Configuration variables:
------------------------

- **mic_gain** (*Optional*, enum): The gain applied to the ADC microphones. One of ``0DB``, ``3DB``, ``6DB``, ``9DB``,
``12DB``, ``15DB``, ``18DB``, ``21DB``, ``24DB``, ``27DB``, ``30DB``, ``33DB``, ``34.5DB``, ``36DB``, or ``37.5DB``.
Defaults to ``24DB``.
- **address** (*Optional*, int): The I²C address of the driver. Defaults to ``0x40``.
- **i2c_id** (*Optional*): The ID of the :ref:`I²C bus <i2c>` the ES7243e is connected to.
- All other options from :ref:`Audio ADC <config-audio_adc>`.

Automations
-----------

All :ref:`Audio ADC Automations <automations-audio_adc>` are supported by this platform.

Configuration Examples
----------------------

**ESP32 S3 Box Lite**:

.. code-block:: yaml
audio_adc:
- platform: es7243e
id: es7243e_adc
i2s_audio:
- id: i2s_audio_bus
i2s_lrclk_pin: GPIO47
i2s_bclk_pin: GPIO17
i2s_mclk_pin: GPIO2
microphone:
- platform: i2s_audio
id: box_mic
sample_rate: 16000
i2s_din_pin: GPIO16
bits_per_sample: 16bit
adc_type: external
See Also
--------

- :doc:`index`
- :apiref:`es7243e/es7243e.h`
- :ghedit:`Edit`
1 change: 1 addition & 0 deletions images/es7243e.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -740,6 +740,7 @@ Audio ADC Components

Audio ADC Core, components/audio_adc/index, audio_adc.svg
ES7210, components/audio_adc/es7210, es7210.svg
ES7243E, components/audio_adc/es7243e, es7243e.svg

Audio DAC Components
--------------------
Expand Down

0 comments on commit 2a650cd

Please sign in to comment.