2022-06-02 07:00:24 +02:00
|
|
|
I2S Audio Media Player
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
.. seo::
|
2023-04-12 01:53:24 +02:00
|
|
|
:description: Instructions for setting up I²S based media players in ESPHome.
|
2022-06-02 07:00:24 +02:00
|
|
|
:image: i2s_audio.svg
|
|
|
|
|
|
|
|
|
|
The ``i2s_audio`` media player platform allows you to play media from webservers and web streams
|
2023-04-12 01:53:24 +02:00
|
|
|
via the :doc:`/components/i2s_audio`. This platform only works on ESP32 based chips.
|
2022-06-02 07:00:24 +02:00
|
|
|
|
|
|
|
|
.. code-block:: yaml
|
|
|
|
|
|
|
|
|
|
# Example configuration entry
|
|
|
|
|
media_player:
|
|
|
|
|
- platform: i2s_audio
|
|
|
|
|
name: ESPHome I2S Media Player
|
|
|
|
|
dac_type: external
|
|
|
|
|
i2s_dout_pin: GPIO22
|
|
|
|
|
mode: mono
|
|
|
|
|
|
|
|
|
|
Configuration variables:
|
|
|
|
|
------------------------
|
|
|
|
|
|
2022-08-31 03:55:05 +02:00
|
|
|
- **dac_type** (**Required**, enum):
|
2022-06-02 07:00:24 +02:00
|
|
|
|
2022-06-29 22:29:03 +02:00
|
|
|
- ``external``: Use an external DAC, for example the NS4168, or UDA1334A.
|
2022-06-02 07:00:24 +02:00
|
|
|
- ``internal``: Use the internal DAC
|
|
|
|
|
|
|
|
|
|
- All other options from :ref:`Media Player <config-media_player>`
|
|
|
|
|
|
|
|
|
|
External DAC
|
|
|
|
|
************
|
|
|
|
|
|
2023-04-12 01:53:24 +02:00
|
|
|
- **i2s_dout_pin** (**Required**, :ref:`Pin Schema <config-pin_schema>`): The GPIO pin to use for the I²S DOUT (Data Out) signal.
|
|
|
|
|
- **mode** (*Optional*, string): The mode of the I²S bus. Can be ``mono`` or ``stereo``. Defaults to ``mono``.
|
2022-06-02 07:00:24 +02:00
|
|
|
|
2022-07-05 09:33:03 +02:00
|
|
|
For best results, keep the wires as short as possible.
|
|
|
|
|
|
2022-06-02 07:00:24 +02:00
|
|
|
Internal DAC
|
|
|
|
|
************
|
|
|
|
|
|
|
|
|
|
- **mode** (**Required**, enum): The channel mode of the internal DAC.
|
|
|
|
|
|
|
|
|
|
- ``left``
|
|
|
|
|
- ``right``
|
|
|
|
|
- ``stereo``
|
|
|
|
|
|
|
|
|
|
See also
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
- :doc:`index`
|
|
|
|
|
- :ghedit:`Edit`
|
