From 2a7ec448b123754ef349562767d1b68b9a8603c8 Mon Sep 17 00:00:00 2001 From: renpeiying Date: Mon, 19 Aug 2024 12:00:02 +0800 Subject: [PATCH] docs: remove obsolete descriptions for ESP32-WROVER --- .../get-started-esp32-lyrat-v4.2.rst | 25 ++++++++--------- .../dev-boards/get-started-esp32-lyrat-v4.rst | 27 ++++++++++--------- 2 files changed, 27 insertions(+), 25 deletions(-) diff --git a/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.2.rst b/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.2.rst index ccfbbc3dc..6a04cfc8e 100644 --- a/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.2.rst +++ b/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.2.rst @@ -22,7 +22,7 @@ Overview The ESP32-LyraT V4.2 is an audio development board produced by `Espressif `_ built around ESP32. It is intended for audio applications, by providing hardware for audio processing and additional RAM on top of what is already onboard of the ESP32 chip. The specific hardware includes: -* **ESP32-WROVER Module** +* **ESP32-WROVER Module**\ :sup:`*` * **Audio Codec Chip** * Dual **Microphones** on board * **Headphone** input @@ -34,6 +34,8 @@ The ESP32-LyraT V4.2 is an audio development board produced by `Espressif `_. See :ref:`get-started-esp32-lyrat-v4.2-jtag-header` for pinout details. Before using **JTAG** signals to the header, **Function DIP Switch** should be enabled. Please note that when **JTAG** is in operation, **MicroSD Card** cannot be used and should be disconnected because some of JTAG signals are shared by both devices. + Provides access to the **JTAG** interface of **ESP32-WROVER Module**\ :sup:`*`. It may be used for debugging, application upload, as well as implementing several other functions, e.g., `Application Level Tracing `_. See :ref:`get-started-esp32-lyrat-v4.2-jtag-header` for pinout details. Before using **JTAG** signals to the header, **Function DIP Switch** should be enabled. Please note that when **JTAG** is in operation, **MicroSD Card** cannot be used and should be disconnected because some of JTAG signals are shared by both devices. UART Header - Serial port: provides access to the serial TX/RX signals between **ESP32-WROVER Module** and **USB-UART Bridge Chip**. + Serial port: provides access to the serial TX/RX signals between **ESP32-WROVER Module**\ :sup:`*` and **USB-UART Bridge Chip**. I2C Header - Provides access to the I2C interface. Both **ESP32-WROVER Module** and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4.2-i2c-header` for pinout details. + Provides access to the I2C interface. Both **ESP32-WROVER Module**\ :sup:`*` and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4.2-i2c-header` for pinout details. MicroSD Card The development board supports a MicroSD card in SPI/1-bit/4-bit modes, and can store or play audio files in the MicroSD card. See :ref:`get-started-esp32-lyrat-v4.2-microsd-card-slot` for pinout details. Note that **JTAG** cannot be used and should be disconnected by setting **Function DIP Switch** when **MicroSD Card** is in operation, because some of signals are shared by both devices. I2S Header - Provides access to the I2S interface. Both **ESP32-WROVER Module** and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4.2-i2s-header` for pinout details. + Provides access to the I2S interface. Both **ESP32-WROVER Module**\ :sup:`*` and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4.2-i2s-header` for pinout details. Left Microphone Onboard microphone connected to IN1 of the **Audio Codec Chip**. AUX Input @@ -91,15 +93,15 @@ PA Chip Boot/Reset Press Keys Boot: holding down the **Boot** button and momentarily pressing the **Reset** button initiates the firmware upload mode. Then user can upload firmware through the serial port. Reset: pressing this button alone resets the system. Touch Pad Buttons - Four touch pads labeled *Play*, *Sel*, *Vol+* and *Vol-*. They are routed to **ESP32-WROVER Module** and intended for development and testing of a UI for audio applications using dedicated API. + Four touch pads labeled *Play*, *Sel*, *Vol+* and *Vol-*. They are routed to **ESP32-WROVER Module**\ :sup:`*` and intended for development and testing of a UI for audio applications using dedicated API. Audio Codec Chip - The Audio Codec Chip, `ES8388 `_, is a low power stereo audio codec with a headphone amplifier. It consists of 2-channel ADC, 2-channel DAC, microphone amplifier, headphone amplifier, digital sound effects, analog mixing and gain functions. It is interfaced with **ESP32-WROVER Module** over I2S and I2S buses to provide audio processing in hardware independently from the audio application. + The Audio Codec Chip, `ES8388 `_, is a low power stereo audio codec with a headphone amplifier. It consists of 2-channel ADC, 2-channel DAC, microphone amplifier, headphone amplifier, digital sound effects, analog mixing and gain functions. It is interfaced with **ESP32-WROVER Module**\ :sup:`*` over I2S and I2S buses to provide audio processing in hardware independently from the audio application. EN Header Install a jumper on this header to enable automatic loading of application to the ESP32. Install or remove jumpers together on both IO0 and EN headers. IO0 Header Install a jumper on this header to enable automatic loading of application to the ESP32. Install or remove jumpers together on both IO0 and EN headers. Function Press Keys - Two key labeled *Rec* and *Mode*. They are routed to **ESP32-WROVER Module** and intended for developing and testing a UI for audio applications using dedicated API. + Two key labeled *Rec* and *Mode*. They are routed to **ESP32-WROVER Module**\ :sup:`*` and intended for developing and testing a UI for audio applications using dedicated API. USB-UART Bridge Chip A single chip USB-UART bridge provides up to 1 Mbps transfers rate. USB-UART Port @@ -447,7 +449,6 @@ Related Documents * `ESP32 LyraT V4.2 schematic`_ (PDF) * `ESP32 Datasheet `_ (PDF) -* `ESP32-WROVER Datasheet `_ (PDF) * `JTAG Debugging `_ * :doc:`get-started-esp32-lyrat-v4` diff --git a/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.rst b/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.rst index 870babf7a..49378d1b2 100644 --- a/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.rst +++ b/docs/en/design-guide/dev-boards/get-started-esp32-lyrat-v4.rst @@ -22,7 +22,7 @@ Overview The ESP32-LyraT V4 is an audio development board produced by `Espressif `_ built around ESP32. It is intended for audio applications, by providing hardware for audio processing and additional RAM on top of what is already onboard of the ESP32 chip. The specific hardware includes: -* **ESP32-WROVER Module** +* **ESP32-WROVER Module**\ :sup:`*` * **Audio Codec Chip** * Dual **Microphones** on board * **Headphone** input @@ -34,7 +34,9 @@ The ESP32-LyraT V4 is an audio development board produced by `Espressif `_. See :ref:`get-started-esp32-lyrat-v4-jtag-header` for pinout details. Before using **JTAG** signals to the header, **Function DIP Switch** should be enabled. Please note that when **JTAG** is in operation, **MicroSD Card** cannot be used and should be disconnected because some of JTAG signals are shared by both devices. + Provides access to the **JTAG** interface of **ESP32-WROVER Module**\ :sup:`*`. May be used for debugging, application upload, as well as implementing several other functions, e.g., `Application Level Tracing `_. See :ref:`get-started-esp32-lyrat-v4-jtag-header` for pinout details. Before using **JTAG** signals to the header, **Function DIP Switch** should be enabled. Please note that when **JTAG** is in operation, **MicroSD Card** cannot be used and should be disconnected because some of JTAG signals are shared by both devices. UART Header - Serial port provides access to the serial TX/RX signals between **ESP32-WROVER Module** and **USB-UART Bridge Chip**. + Serial port provides access to the serial TX/RX signals between **ESP32-WROVER Module**\ :sup:`*` and **USB-UART Bridge Chip**. I2C Header - Provides access to the I2C interface. Both **ESP32-WROVER Module** and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4-i2c-header` for pinout details. + Provides access to the I2C interface. Both **ESP32-WROVER Module**\ :sup:`*` and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4-i2c-header` for pinout details. MicroSD Card The development board supports a MicroSD card in SPI/1-bit/4-bit modes, and can store or play audio files in the MicroSD card. See :ref:`get-started-esp32-lyrat-v4-microsd-card-slot` for pinout details. Note that **JTAG** cannot be used and should be disconnected by setting **Function DIP Switch** when **MicroSD Card** is in operation, because some of the signals are shared by both devices. I2S Header - Provides access to the I2S interface. Both **ESP32-WROVER Module** and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4-i2s-header` for pinout details. + Provides access to the I2S interface. Both **ESP32-WROVER Module**\ :sup:`*` and **Audio Codec Chip** are connected to this interface. See :ref:`get-started-esp32-lyrat-v4-i2s-header` for pinout details. Left Microphone Onboard microphone connected to IN1 of the **Audio Codec Chip**. AUX Input @@ -91,11 +93,11 @@ PA Chip Boot/Reset Press Keys Boot: holding down the **Boot** button and momentarily pressing the **Reset** button initiates the firmware upload mode. Then user can upload firmware through the serial port. Reset: pressing this button alone resets the system. Touch Pad Buttons - Four touch pads labeled *Play*, *Sel*, *Vol+* and *Vol-*. They are routed to **ESP32-WROVER Module** and intended for development and testing of a UI for audio applications using dedicated API. + Four touch pads labeled *Play*, *Sel*, *Vol+* and *Vol-*. They are routed to **ESP32-WROVER Module**\ :sup:`*` and intended for development and testing of a UI for audio applications using dedicated API. Audio Codec Chip - The Audio Codec Chip, `ES8388 `_, is a low-power stereo audio codec with headphone amplifier. It consists of 2-channel ADC, 2-channel DAC, microphone amplifier, headphone amplifier, digital sound effects, analog mixing and gain functions. It is interfaced with **ESP32-WROVER Module** over I2S and I2S buses to provide audio processing in hardware independently from the audio application. + The Audio Codec Chip, `ES8388 `_, is a low-power stereo audio codec with headphone amplifier. It consists of 2-channel ADC, 2-channel DAC, microphone amplifier, headphone amplifier, digital sound effects, analog mixing and gain functions. It is interfaced with **ESP32-WROVER Module**\ :sup:`*` over I2S and I2S buses to provide audio processing in hardware independently from the audio application. Function Press Keys - Two key labeled *Rec* and *Mode*. They are routed to **ESP32-WROVER Module** and intended for developing and testing a UI for audio applications using dedicated API. + Two key labeled *Rec* and *Mode*. They are routed to **ESP32-WROVER Module**\ :sup:`*` and intended for developing and testing a UI for audio applications using dedicated API. USB-UART Bridge Chip A single chip USB-UART bridge provides up to 1 Mbps transfer rate. Micro USB Port @@ -421,7 +423,6 @@ Related Documents * `ESP32 LyraT V4 schematic`_ (PDF) * `ESP32 Datasheet `_ (PDF) -* `ESP32-WROVER Datasheet `_ (PDF) * `JTAG Debugging `_ .. _ESP32 LyraT V4 schematic: https://dl.espressif.com/dl/schematics/esp32-lyrat-v4-schematic.pdf