espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-02 16:11:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update the application examples in i2s

Browse Source
This commit is contained in:
shenmengjing
2024-07-09 16:18:29 +08:00
parent ea5a48836d
commit 255a39dd2d
2 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/en/api-reference/peripherals/i2s.rst
View File

@@ -292,6 +292,9 @@ The examples of the I2S driver can be found in the directory :example:`periphera
Standard TX/RX Usage
^^^^^^^^^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_codec/i2s_es8311` demonstrates how to use the I2S ES8311 audio codec with {IDF_TARGET_NAME} to play music or echo sounds, featuring high performance and low power multi-bit delta-sigma audio ADC and DAC, with options to customize music and adjust mic gain and volume.
- :example:`peripherals/i2s/i2s_basic/i2s_std` demonstrates how to use the I2S standard mode in either simplex or full-duplex mode on {IDF_TARGET_NAME}.
Different slot communication formats can be generated by the following helper macros for standard mode. As described above, there are three formats in standard mode, and their helper macros are:
- :c:macro:`I2S_STD_PHILIPS_SLOT_DEFAULT_CONFIG`
@@ -548,6 +551,8 @@ Here is the table of the data received in the buffer with different :cpp:member:
PDM TX Usage
^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_basic/i2s_pdm` demonstrates how to use the PDM TX mode on {IDF_TARGET_NAME}, including the necessary hardware setup and configuration.
For PDM mode in TX channel, the slot configuration helper macro is:
- :c:macro:`I2S_PDM_TX_SLOT_DEFAULT_CONFIG`
@@ -644,6 +649,9 @@ Here is the table of the data received in the buffer with different :cpp:member:
PDM RX Usage
^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_recorder` demonstrates how to record audio from a digital MEMS microphone using the I2S peripheral in PDM data format and save it to an SD card in ``.wav`` file format on {IDF_TARGET_NAME} development boards.
- :example:`peripherals/i2s/i2s_basic/i2s_pdm` demonstrates how to use the PDM RX mode on {IDF_TARGET_NAME}, including the necessary hardware setup and configuration.
For PDM mode in RX channel, the slot configuration helper macro is:
- :c:macro:`I2S_PDM_RX_SLOT_DEFAULT_CONFIG`
@@ -727,6 +735,9 @@ Here is the table of the data received in the buffer with different :cpp:member:
TDM TX/RX Usage
^^^^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_codec/i2s_es7210_tdm` demonstrates how to use the I2S TDM mode on {IDF_TARGET_NAME} to record four MICs connected to ES7210 codec, with the recorded voice saved to an SD card in ``wav`` format.
- :example:`peripherals/i2s/i2s_basic/i2s_tdm` demonstrates how to use the TDM mode in simplex or full-duplex mode on {IDF_TARGET_NAME}.
Different slot communication formats can be generated by the following helper macros for TDM mode. As described above, there are four formats in TDM mode, and their helper macros are:
- :c:macro:`I2S_TDM_PHILIPS_SLOT_DEFAULT_CONFIG`