alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/update_examples_in_i2s' into 'master'

Browse Source 
docs: Update the application examples in i2s

Closes DOC-8322

See merge request espressif/esp-idf!31997
This commit is contained in:
Shen Meng Jing 2024-08-06 18:45:35 +08:00
commit cf0925e383
2 changed files with 22 additions and 0 deletions
Show Stats 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`

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

@ -292,6 +292,9 @@ I2S 驱动例程请参考 :example:`peripherals/i2s` 目录。以下为每种模
标准 TX/RX 模式的应用
^^^^^^^^^^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_codec/i2s_es8311` 演示了如何在 {IDF_TARGET_NAME} 上使用 I2S ES8311 音频编解码器来播放音乐或回声，具有高性能和低功耗的多位 delta-sigma 音频 ADC 和 DAC，提供自定义音乐、调整麦克风增益和音量的选项。
- :example:`peripherals/i2s/i2s_basic/i2s_std` 演示了如何在 {IDF_TARGET_NAME} 上以单工或全双工模式使用 I2S 标准模式。
不同声道的通信格式可通过以下标准模式的辅助宏来生成。如上所述，在标准模式下有三种格式，辅助宏分别为：
- :c:macro:`I2S_STD_PHILIPS_SLOT_DEFAULT_CONFIG`
@ -548,6 +551,8 @@ STD RX 模式
PDM TX 模式的应用
^^^^^^^^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_basic/i2s_pdm` 演示了如何在 {IDF_TARGET_NAME} 上使用 PDM TX 模式，包括必要的硬件设置和配置。
针对 TX 通道的 PDM 模式，声道配置的辅助宏为：
- :c:macro:`I2S_PDM_TX_SLOT_DEFAULT_CONFIG`
@ -644,6 +649,9 @@ STD RX 模式
PDM RX 模式的应用
^^^^^^^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_recorder` 演示了如何通过 I2S 外设以 PDM 数据格式用数字 MEMS 麦克风录制音频，并将其以 ``.wav`` 文件格式保存到 {IDF_TARGET_NAME} 开发板上的 SD 卡中。
- :example:`peripherals/i2s/i2s_basic/i2s_pdm` 演示了如何在 {IDF_TARGET_NAME} 上使用 PDM RX 模式，包括必要的硬件设置和配置。
针对 RX 通道的 PDM 模式，声道配置的辅助宏为：
- :c:macro:`I2S_PDM_RX_SLOT_DEFAULT_CONFIG`
@ -727,6 +735,9 @@ STD RX 模式
TDM TX/RX 模式的应用
^^^^^^^^^^^^^^^^^^^^^
- :example:`peripherals/i2s/i2s_codec/i2s_es7210_tdm` 演示了如何在 {IDF_TARGET_NAME} 上使用 I2S TDM 模式来记录连接到 ES7210 编解码器的四个麦克风，并将录制的声音以 ``.wav`` 格式保存到 SD 卡中。
- :example:`peripherals/i2s/i2s_basic/i2s_tdm` 演示了如何在 {IDF_TARGET_NAME} 上以单工或全双工模式使用 TDM 模式。
可以通过以下 TDM 模式的辅助宏生成不同的声道通信格式。如上所述，TDM 模式有四种格式，它们的辅助宏分别为：
- :c:macro:`I2S_TDM_PHILIPS_SLOT_DEFAULT_CONFIG`