From dee1ff02183e58d1df8e9a4260c3e5e975aa6040 Mon Sep 17 00:00:00 2001 From: "kirill.chalov" Date: Wed, 22 Jul 2020 16:37:03 +0800 Subject: [PATCH] Add user guide for Kaluga Kit v1.3 --- .../inc/modules-and-boards-esp32s2.rst | 34 +- .../modules-and-boards-previous-esp32s2.rst | 28 +- .../esp32s2/user-guide-esp-lyrap-cam-v1.0.rst | 16 +- .../esp32s2/user-guide-esp-lyrap-cam-v1.1.rst | 131 ++++++ .../user-guide-esp-lyrap-lcd32-v1.1.rst | 16 +- .../user-guide-esp-lyrap-lcd32-v1.2.rst | 154 +++++++ .../user-guide-esp-lyrap-toucha-v1.1.rst | 15 +- .../user-guide-esp-lyrat-8311a_v1.2.rst | 25 +- .../user-guide-esp-lyrat-8311a_v1.3.rst | 161 ++++++++ .../user-guide-esp32-s2-kaluga-1-kit-v1.2.rst | 377 ++++++++++++++++++ .../user-guide-esp32-s2-kaluga-1-kit.rst | 198 ++++++--- .../esp32s2/user-guide-esp-lyrap-cam-v1.0.rst | 2 +- .../esp32s2/user-guide-esp-lyrap-cam-v1.1.rst | 1 + .../user-guide-esp-lyrap-lcd32-v1.1.rst | 2 +- .../user-guide-esp-lyrap-lcd32-v1.2.rst | 1 + .../user-guide-esp-lyrat-8311a_v1.2.rst | 2 +- .../user-guide-esp-lyrat-8311a_v1.3.rst | 1 + .../user-guide-esp32-s2-kaluga-1-kit-v1.2.rst | 297 ++++++++++++++ .../user-guide-esp32-s2-kaluga-1-kit.rst | 297 +------------- 19 files changed, 1382 insertions(+), 376 deletions(-) create mode 100644 docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst create mode 100644 docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst create mode 100644 docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst create mode 100644 docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst create mode 100644 docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst create mode 100644 docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst create mode 100644 docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst create mode 100644 docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst diff --git a/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst index 8ed23bb5c0..e7b3eb565e 100644 --- a/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst +++ b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-esp32s2.rst @@ -1,4 +1,4 @@ -.. _esp-s2-modules: +.. _esp32s2-modules: Modules ======= @@ -17,5 +17,37 @@ ESP32-S2-WROOM-32 ESP32-S2 2 N/A MIFA 16 x 23 x 3 * U.FL - U.FL / IPEX antenna connector +Development Boards +================== + +.. _esp-modules-and-boards-esp32s2-kaluga-1-kit: + +ESP32-S2-Kaluga-1 Kit v1.3 +-------------------------- + +The ESP32-S2-Kaluga-1 kit is a development kit by Espressif that consists of one main board and several extension boards. This kit is intended to provide users with tools for development of human-computer interaction applications based on the ESP32-S2 chip. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-3d.png + :align: center + :width: 2631px + :height: 1966px + :scale: 25% + :alt: ESP32-S2-Kaluga-1 + :figclass: align-center + + ESP32-S2-Kaluga-1 (click to enlarge) + + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32s2/user-guide-esp32-s2-kaluga-1-kit` + +Previous Versions +^^^^^^^^^^^^^^^^^ + +* :ref:`esp32s2-modules-and-boards-previous-esp32s2-kaluga-1-kit-v1.2` + + .. _FTDI Virtual COM Port Drivers: https://www.ftdichip.com/Drivers/VCP.htm .. _Espressif Products Ordering Information: https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf diff --git a/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst index 942a419074..d9ac80122e 100644 --- a/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst +++ b/docs/en/hw-reference/esp32s2/inc/modules-and-boards-previous-esp32s2.rst @@ -1,4 +1,4 @@ -.. _esp-modules-and-boards-previous_esp32s2: +.. _esp32s2-modules-and-boards-previous: Modules ======= @@ -9,4 +9,28 @@ So far, no modules have been updated or discontinued. Development Boards ================== -So far, no development boards have been updated or discontinued. +To see the latest development boards, please refer to section :ref:`esp-modules-and-boards`. + +.. _esp32s2-modules-and-boards-previous-esp32s2-kaluga-1-kit-v1.2: + +ESP32-S2-Kaluga-1 Kit v1.2 +-------------------------- + +The ESP32-S2-Kaluga-1 kit is a development kit by Espressif that consists of one main board and several extension boards. This kit is intended to provide users with tools for development of human-computer interaction applications based on the ESP32-S2 chip. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-3d.png + :align: center + :width: 2631px + :height: 1966px + :scale: 25% + :alt: ESP32-S2-Kaluga-1 + :figclass: align-center + + ESP32-S2-Kaluga-1 (click to enlarge) + + +Documentation +^^^^^^^^^^^^^ + +* :doc:`esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2` + diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst index 11bc4297b8..c878c20b37 100644 --- a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst @@ -1,10 +1,14 @@ -============= -ESP-LyraP-CAM -============= +================== +ESP-LyraP-CAM v1.0 +================== :link_to_translation:`zh_CN:[中文]` -This user guide provides information on the ESP-LyraP-CAM extension board. This extension board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. +This user guide provides information on the ESP-LyraP-CAM extension board. + +This extension board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraP-CAM v1.0 is sold as part of the :doc:`user-guide-esp32-s2-kaluga-1-kit-v1.2`. The ESP-LyraP-CAM extends the functionality of your main board by adding a camera. @@ -48,7 +52,7 @@ Description of Components * - Main Board Camera Header - Mount onto main board's Camera Header * - Power ON LED - - Red LED is on if the power supply voltage is correct + - Red LED is on if the power supply voltage is applied * - Camera Module Connector - Supports OV2640 and OV3660 camera modules; this extension board is supplied with an OV2640 camera module * - Power Regulator @@ -78,7 +82,7 @@ Insert the ESP-LyraP-CAM extension board into your board's female Camera Header. Software Setup ^^^^^^^^^^^^^^ -See Section :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` of the ESP32-S2-Kaluga-1 kit user guide. +See Section :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup` of the ESP32-S2-Kaluga-1 kit user guide. Hardware Reference diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst new file mode 100644 index 0000000000..129ebdc357 --- /dev/null +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst @@ -0,0 +1,131 @@ +================== +ESP-LyraP-CAM v1.1 +================== + +:link_to_translation:`zh_CN:[中文]` + +This user guide provides information on the ESP-LyraP-CAM extension board. + +This extension board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraP-CAM v1.1 is sold as part of the :doc:`user-guide-esp32-s2-kaluga-1-kit`. + +The ESP-LyraP-CAM extends the functionality of your main board by adding a camera. + +.. Image of v1.0 is used as there are no visual changes + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-cam-v1.0-3d.png + :align: center + :alt: ESP-LyraP-CAM + :figclass: align-center + + ESP-LyraP-CAM + +The document consists of the following major sections: + +- `Overview`_: Provides an overview and hardware/software setup instructions to get started. +- `Hardware reference`_: Provides more detailed information about the ESP-LyraP-CAM's hardware. +- `Hardware Revision Details`_: Covers revision history, known issues, and links to user guides for previous versions of the ESP-LyraP-CAM. +- `Related Documents`_: Gives links to related documentation. + + +Overview +======== + +This extension board adds a camera to your main board. + + +Description of Components +------------------------- + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-cam-v1.1-layout-front.png + :align: center + :alt: ESP-LyraP-CAM - front and back + :figclass: align-center + + ESP-LyraP-CAM - front and back + +.. list-table:: + :widths: 30 70 + :header-rows: 1 + + * - Key Component + - Description + * - Main Board Camera Header + - Mount onto main board's Camera Header + * - Power ON LED + - Red LED is on if the power supply voltage is correct + * - Camera Module Connector + - Supports OV2640 and OV3660 camera modules; this extension board is supplied with an OV2640 camera module + * - Power Regulator + - LDO Regulator converting 3.3 V to 2.8 V and 1.5 V + + +Start Application Development +----------------------------- + +Before powering up your ESP-LyraP-CAM, please make sure that it is in good condition with no obvious signs of damage. + + +Required Hardware +^^^^^^^^^^^^^^^^^ + +- Board with a female Camera Header (e.g., ESP32-S2-Kaluga-1) +- ESP-LyraP-CAM extension board +- Computer running Windows, Linux, or macOS + + +Hardware Setup +^^^^^^^^^^^^^^ + +Insert the ESP-LyraP-CAM extension board into your board's female Camera Header. + + +Software Setup +^^^^^^^^^^^^^^ + +See Section :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` of the ESP32-S2-Kaluga-1 kit user guide. + + +Hardware Reference +================== + + +Block Diagram +------------- + +A block diagram below shows the components of the ESP-LyraP-CAM and their interconnections. + +.. Image of v1.0 is used as there are no visual changes + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-cam-v1.0-block-diagram.png + :align: center + :alt: ESP-LyraP-CAM block diagram + :figclass: align-center + + ESP-LyraP-CAM block diagram + + +Hardware Revision Details +========================= + +ESP-LyraP-CAM v1.1 +-------------------- + +* Silk screen updated +* No actual hardware updates + + +ESP-LyraP-CAM v1.0 +-------------------- + +:doc:`Initial release ` + + +Related Documents +================= + +- `ESP-LyraP-CAM Schematic `_ (PDF) +- `ESP-LyraP-CAM PCB Layout `_ (PDF) + +For other design documentation for the board, please contact us at sales@espressif.com. \ No newline at end of file diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst index 2443b2a620..815dd27efa 100644 --- a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst @@ -1,10 +1,14 @@ -=============== -ESP-LyraP-LCD32 -=============== +==================== +ESP-LyraP-LCD32 v1.1 +==================== :link_to_translation:`zh_CN:[中文]` -This user guide provides information on the ESP-LyraP-LCD32 extension board. This board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. +This user guide provides information on the ESP-LyraP-LCD32 extension board. + +This extension board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraP-LCD32 v1.1 is sold as part of the :doc:`user-guide-esp32-s2-kaluga-1-kit-v1.2`. The ESP-LyraP-LCD32 extends the functionality of your main board by adding an LCD graphic display. @@ -58,7 +62,7 @@ In the description of components below, **Reserved** means that the functionalit * - Extension Header - Male Extension Header for mounting onto a female Extension Header * - LCD display - - This version has a 3.2" 320x240 SPI LCD display module + - This version has a 3.2" 320x240 SPI LCD display module; the display driver/controller is Sitronix ST7789V * - Touch Screen Switch - No support for touch screens, keep the switches to OFF to make the pins available for other uses * - Main Board 3.2" LCD FPC Connector @@ -94,7 +98,7 @@ To mount your ESP-LyraP-LCD32 onto the board with a female Extension Header: Software Setup ^^^^^^^^^^^^^^ -See Section :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` of the ESP32-S2-Kaluga-1 kit user guide. +See Section :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup` of the ESP32-S2-Kaluga-1 kit user guide. Hardware Reference diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst new file mode 100644 index 0000000000..4f92a3eef7 --- /dev/null +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst @@ -0,0 +1,154 @@ +==================== +ESP-LyraP-LCD32 v1.2 +==================== + +:link_to_translation:`zh_CN:[中文]` + +This user guide provides information on the ESP-LyraP-LCD32 extension board. + +This extension board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraP-LCD32 v1.2 is sold as part of the :doc:`user-guide-esp32-s2-kaluga-1-kit`. + +The ESP-LyraP-LCD32 extends the functionality of your main board by adding an LCD graphic display. + +.. Image of v1.1 is used as there are no visual changes + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-lcd32-v1.1-3d.png + :align: center + :width: 2243px + :height: 1534px + :scale: 30% + :alt: ESP-LyraP-LCD32 + :figclass: align-center + + ESP-LyraP-LCD32 (click to enlarge) + +The document consists of the following major sections: + +- `Overview`_: Provides an overview and hardware/software setup instructions to get started. +- `Hardware reference`_: Provides more detailed information about the ESP-LyraP-LCD32's hardware. +- `Hardware Revision Details`_: Covers revision history, known issues, and links to user guides for previous versions of the ESP-LyraP-LCD32. +- `Related Documents`_: Gives links to related documentation. + + +Overview +======== + +This extension board adds a 3.2" LCD graphic display with the resolution of 320x240. This display is connected to ESP32-S2 over the SPI bus. + + +Description of Components +------------------------- + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-lcd32-v1.2-layout-front.png + :align: center + :width: 934px + :height: 489px + :scale: 70% + :alt: ESP-LyraP-LCD32 - front + :figclass: align-center + + ESP-LyraP-LCD32 - front (click to enlarge) + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-lcd32-v1.2-layout-back.png + :align: center + :width: 934px + :height: 600px + :scale: 70% + :alt: ESP-LyraP-LCD32 - back + :figclass: align-center + + ESP-LyraP-LCD32 - back (click to enlarge) + + +In the description of components below, **Reserved** means that the functionality is available, but the current version of the kit does not use it. + + +.. list-table:: + :widths: 30 70 + :header-rows: 1 + + * - Key Component + - Description + * - Extension Header + - Male Extension Header for mounting onto a female Extension Header + * - LCD Display + - This version has a 3.2" 320x240 SPI LCD display module; the display driver/controller is either Sitronix ST7789V or Ilitek ILI9341 + * - Touch Screen Switch + - No support for touch screens, keep the switches to OFF to make the pins available for other uses + * - Main Board 3.2" LCD FPC Connector + - (Reserved) Connect to main board's 3.2" LCD FPC connector + * - Control Switch + - Switch to ON to set Reset/Backlight_control/CS to default high or low; switch to OFF to make the pins available for other uses + + +Start Application Development +----------------------------- + +Before powering up your ESP-LyraP-LCD32, please make sure that it is in good condition with no obvious signs of damage. + + +Required Hardware +^^^^^^^^^^^^^^^^^ + +- Board with a female Extension Header (e.g., ESP32-S2-Kaluga-1, ESP-LyraT-8311A) +- ESP-LyraP-LCD32 extension board +- Four mounting bolts (for stable mounting) +- Computer running Windows, Linux, or macOS + + +Hardware Setup +^^^^^^^^^^^^^^ + +To mount your ESP-LyraP-LCD32 onto the board with a female Extension Header: + +1. Install the four mounting bolts onto the board with a female Extension Header +2. Align the ESP-LyraP-LCD32 with the bolts and Extension Header and insert it carefully + + +Software Setup +^^^^^^^^^^^^^^ + +See Section :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` of the ESP32-S2-Kaluga-1 kit user guide. + + +Hardware Reference +================== + +Block Diagram +------------- + +A block diagram below shows the components of the ESP-LyraP-LCD32 and their interconnections. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-lcd32-v1.2-block-diagram.png + :align: center + :alt: ESP-LyraP-LCD32 block diagram + :figclass: align-center + + ESP-LyraP-LCD32 block diagram + + +Hardware Revision Details +========================= + +ESP-LyraP-LCD32 v1.2 +-------------------- + +* LCD backlight default ON, cannot be controlled by MCU +* Touch Driver and related switch removed for major limitations caused by multiplexed pins + + +ESP-LyraP-LCD32 v1.1 +-------------------- + +:doc:`Initial release ` + + +Related Documents +================= + +- `ESP-LyraP-LCD32 Schematic `_ (PDF) +- `ESP-LyraP-LCD32 PCB Layout `_ (PDF) + +For other design documentation for the board, please contact us at sales@espressif.com. \ No newline at end of file diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-toucha-v1.1.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-toucha-v1.1.rst index 887ad2d597..374fbf9625 100644 --- a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-toucha-v1.1.rst +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-toucha-v1.1.rst @@ -1,10 +1,17 @@ -================ -ESP-LyraP-TouchA -================ +===================== +ESP-LyraP-TouchA v1.1 +===================== :link_to_translation:`zh_CN:[中文]` -This user guide provides information on the ESP-LyraP-TouchA extension board. This board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. +This user guide provides information on the ESP-LyraP-TouchA extension board. + +This board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraP-TouchA v1.1 is sold as part of the following kits: + +* :doc:`user-guide-esp32-s2-kaluga-1-kit` +* :doc:`user-guide-esp32-s2-kaluga-1-kit-v1.2` The ESP-LyraP-TouchA extends the functionality of your main board by adding touch buttons. diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst index 74f3286780..091b2c63ff 100644 --- a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst @@ -1,10 +1,14 @@ -=============== -ESP-LyraT-8311A -=============== +==================== +ESP-LyraT-8311A v1.2 +==================== :link_to_translation:`zh_CN:[中文]` -This user guide provides information on the ESP-LyraT-8311A extension board. This board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. +This user guide provides information on the ESP-LyraT-8311A extension board. + +This board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraT-8311A v1.3 is sold as part of the :doc:`user-guide-esp32-s2-kaluga-1-kit-v1.2`. The ESP-LyraT-8311A extends the functionality of your main board by adding sound processing functionality: @@ -35,8 +39,7 @@ The document consists of the following major sections: Overview ======== -The ESP-LyraT-8311A is mainly designed for audio applications. However, it can also be used for other purposes. - +The ESP-LyraT-8311A is mainly designed for audio applications. However, you can use your creativity to come up with any other use cases. Description of Components ------------------------- @@ -45,7 +48,7 @@ Description of Components :align: center :width: 934px :height: 565px - :scale: 80% + :scale: 70% :alt: ESP-LyraT-8311A - front :figclass: align-center @@ -65,11 +68,11 @@ The description of components starts from the top right corner and then goes clo * - Extension Header - Male Extension Header on the flip side is for mounting onto main board's Extension Header; Female Extension Header is for mounting other boards that have a Male Extension Header * - Function Button - - Programmable button + - This board has six programmable buttons * - Microphone - Supports Electret and MEMS microphones; this extension board is supplied with an electret microphone * - Headphone Connector - - 1/8" headphone connector + - 6.3 mm (1/8") stereo headphone connector * - Speaker Connector - Connect an external speaker to the 2-pin connector * - PA @@ -110,10 +113,10 @@ To mount your ESP-LyraT-8311A onto the board with a female Extension Header: Software Setup ^^^^^^^^^^^^^^ -Depending on your application see: +Depending on your application, see: * `ESP-ADF Getting Started Guide `_ if you develop with ESP-ADF (Espressif Audio Development Framework). -* Section :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` of the ESP32-S2-Kaluga-1 kit user guide if you develop directly with ESP-IDF (Espressif IOT Development Framework). +* Section :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup` of the ESP32-S2-Kaluga-1 kit user guide if you develop directly with ESP-IDF (Espressif IOT Development Framework). Hardware Reference diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst new file mode 100644 index 0000000000..65b115805f --- /dev/null +++ b/docs/en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst @@ -0,0 +1,161 @@ +==================== +ESP-LyraT-8311A v1.3 +==================== + +:link_to_translation:`zh_CN:[中文]` + +This user guide provides information on the ESP-LyraT-8311A extension board. + +This board cannot be bought separately and is usually sold together with other Espressif development boards (e.g., ESP32-S2-Kaluga-1), which will be referred to as *main boards* below. + +Currently, ESP-LyraT-8311A v1.3 is sold as part of the :doc:`user-guide-esp32-s2-kaluga-1-kit`. + +The ESP-LyraT-8311A extends the functionality of your main board by adding sound processing functionality: + +- Audio playback/recording +- Processing of audio signals +- Programmable buttons for easy control + +This extension board can be used in many ways. The applications might include voice user interface, voice control, voice authorization, recording and playback of sound, etc. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrat-8311a-v1.3-3d.png + :align: center + :width: 1934px + :height: 1473px + :scale: 30% + :alt: ESP-LyraT-8311A + :figclass: align-center + + ESP-LyraT-8311A (click to enlarge) + +The document consists of the following major sections: + +- `Overview`_: Provides an overview and hardware setup instructions. +- `Hardware reference`_: Provides more detailed information about the ESP-LyraT-8311A's hardware. +- `Hardware Revision Details`_: Covers revision history, known issues, and links to user guides for previous versions of the ESP-LyraT-8311A. +- `Related Documents`_: Gives links to related documentation. + + +Overview +======== + +The ESP-LyraT-8311A is mainly designed for audio applications. However, you can use your creativity to come up with any other use cases. + + +Description of Components +------------------------- + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrat-8311a-v1.3-layout-front.png + :align: center + :width: 934px + :height: 565px + :scale: 70% + :alt: ESP-LyraT-8311A - front + :figclass: align-center + + ESP-LyraT-8311A - front (click to enlarge) + +The description of components starts from the top right corner and then goes clockwise. + +**Reserved** means that the functionality is available, but the current version of the kit does not use it. + + +.. list-table:: + :widths: 30 70 + :header-rows: 1 + + * - Key Component + - Description + * - Extension Header + - Male Extension Header on the flip side is for mounting onto main board's Extension Header; Female Extension Header is for mounting other boards that have a Male Extension Header + * - Function Button + - This board has six programmable buttons + * - Microphone + - Supports Electret and MEMS microphones; this extension board is supplied with an electret microphone + * - Headphone Connector + - 6.3 mm (1/8") stereo headphone connector + * - Speaker Connector + - Connect an external speaker to the 2-pin connector + * - PA + - 3 W Audio signal amplifier for the external speaker + * - External Mic-Matrix Connector + - (Reserved) FPC connector for external Mic-Matrix (microphone boards) + * - ADC + - (Reserved) high-performance ADC/ES7243: 1 channel for microphone, 1 channel for acoustic echo cancellation (AEC) function + * - Mono Audio Codec + - ES8311 audio ADC and DAC; it can convert the analog signal picked up by the microphone or convert digital signal to play it back through a speaker or headphones + + + +Start Application Development +----------------------------- + +Before powering up your ESP-LyraT-8311A, please make sure that it is in good condition with no obvious signs of damage. + + +Required Hardware +^^^^^^^^^^^^^^^^^ + +- Board with a female Extension Header (e.g., ESP32-S2-Kaluga-1) +- ESP-LyraT-8311A extension board +- Four mounting bolts (for stable mounting) +- Computer running Windows, Linux, or macOS + + +Hardware Setup +^^^^^^^^^^^^^^ + +To mount your ESP-LyraT-8311A onto the board with a female Extension Header: + +1. Install the four mounting bolts onto the board with a female Extension Header +2. Align the ESP-LyraT-8311A with the bolts and Extension Header and insert it carefully + + +Software Setup +^^^^^^^^^^^^^^ + +Depending on your application, see: + +* `ESP-ADF Getting Started Guide `_ if you develop with ESP-ADF (Espressif Audio Development Framework). +* Section :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` of the ESP32-S2-Kaluga-1 kit user guide if you develop directly with ESP-IDF (Espressif IOT Development Framework). + + +Hardware Reference +================== + + +Block Diagram +------------- + +A block diagram below shows the components of ESP-LyraT-8311A and their interconnections. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrat-8311a-v1.3-block-diagram.png + :align: center + :alt: ESP-LyraT-8311A block diagram + :figclass: align-center + + ESP-LyraT-8311A block diagram + + +Hardware Revision Details +========================= + +ESP-LyraT-8311A v1.3 +-------------------- + +* ADC/ES7243 and ADC/ES7210 removed as the Mono Audio Codec chip provides all the needed functionality. + + +ESP-LyraT-8311A v1.2 +-------------------- + +:doc:`Initial release ` + + +Related Documents +================= + +- `ESP-LyraT-8311A Schematic `_ (PDF) +- `ESP-LyraT-8311A PCB Layout `_ (PDF) + +For other design documentation for the board, please contact us at sales@espressif.com. \ No newline at end of file diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst b/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst new file mode 100644 index 0000000000..c027b10c75 --- /dev/null +++ b/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst @@ -0,0 +1,377 @@ +========================== +ESP32-S2-Kaluga-1 Kit v1.2 +========================== + +:link_to_translation:`zh_CN:[中文]` + +New version available: :doc:`user-guide-esp32-s2-kaluga-1-kit` + +The ESP32-S2-Kaluga-1 kit v1.2 is a development kit by Espressif that is mainly created to: + +- Demonstrate the ESP32-S2's human-computer interaction functionalities +- Provide the users with the tools for development of human-computer interaction applications based on the ESP32-S2 + +There are many ways of how the ESP32-S2's abundant functionalities can be used. For starters, the possible use cases may include: + +- **Smart home**: From simplest smart lighting, smart door locks, smart sockets, to video streaming devices, security cameras, OTT devices, and home appliances +- **Battery-powered equipment**: Wi-Fi mesh sensor networks, Wi-Fi-networked toys, wearable devices, health management equipment +- **Industrial automation equipment**: Wireless control and robot technology, intelligent lighting, HVAC control equipment, etc. +- **Retail and catering industry**: POS machines and service robots + + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-kit-v1.0-3d.png + :align: center + :width: 3452px + :height: 1590px + :scale: 20% + :alt: ESP32-S2-Kaluga-1-Kit-Assembly + :figclass: align-center + + ESP32-S2-Kaluga-1-Kit Overview (click to enlarge) + + +The ESP32-S2-Kaluga-1 kit consists of the following boards: + +- Main board: *ESP32-S2-Kaluga-1* +- Extension boards: + + - :doc:`user-guide-esp-lyrat-8311a_v1.2` - audio player + - :doc:`user-guide-esp-lyrap-toucha-v1.1` - touch panel + - :doc:`user-guide-esp-lyrap-lcd32-v1.1` - 3.2" LCD screen + - :doc:`user-guide-esp-lyrap-cam-v1.0` - camera board + +Due to the presence of multiplexed pins on ESP32-S2, certain extension board combinations have limited compatibility. For more details, please see :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-ext-board-compatibility`. + +This document is **mostly dedicated to the main board** and its interaction with the extension boards. For more detailed information on each extension board, click their respective links. + +This guide covers: + +- `Getting Started`_: Provides an overview of the ESP32-S2-Kaluga-1 and hardware/software setup instructions to get started. +- `Hardware reference`_: Provides more detailed information about the ESP32-S2-Kaluga-1's hardware. +- `Hardware Revision Details`_: Covers revision history, known issues, and links to user guides for previous versions of the ESP32-S2-Kaluga-1. +- `Related Documents`_: Gives links to related documentation. + + +Getting Started +=============== + + +This section describes how to get started with the ESP32-S2-Kaluga-1. It begins with a few introductory sections about the ESP32-S2-Kaluga-1, then Section `Start Application Development`_ provides instructions on how to do the initial hardware setup and then how to flash firmware onto the ESP32-S2-Kaluga-1. + + +Overview +-------- + +The ESP32-S2-Kaluga-1 main board is the heart of the kit. It integrates the ESP32-S2-WROVER module and all the connectors for extension boards. This board is the key tool in prototyping human-computer interaction interfaces. + +The ESP32-S2-Kaluga-1 board has connectors for boards with: + +- Extension header (ESP-LyraT-8311A, ESP-LyraP-LCD32) +- Camera header (ESP-LyraP-CAM) +- Touch FPC coneector (ESP-LyraP-TouchA) +- LCD FPC connector (no official extension boards yet) +- I2C FPC connector (no official extension boards yet) + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-3d.png + :align: center + :width: 2631px + :height: 1966px + :scale: 25% + :alt: ESP32-S2-Kaluga-1 + :figclass: align-center + + ESP32-S2-Kaluga-1 (click to enlarge) + +All the four extension boards are specially desgined to support the following features: + +* Touch panel control + * Six touch buttons + * Supports acrylic panels up to 5 mm + * Wet hand operation + * Water rejection, ESP32-S2 can be configured to disable all touchpads automatically if multiple pads are simultaneously covered with water and to re-enable touchpads if the water is removed + +* Audio playback + * Connect speakers to play audio + * Use together with the Touch panel to control audio playback and adjust volume + +* LCD display + * LCD interface (8-bit parallel RGB, 8080, and 6800 interface) + +* Camera image acquisition + * Supports OV2640 and OV3660 camera modules + * 8-bit DVP image sensor interface (ESP32-S2 also supports 16-bit DVP image sensors, you can design it yourself) + * Clock frequency up to 40 MHz + * Optimized DMA transmission bandwidth for easier transmission of high-resolution images + + +Description of Components +------------------------- + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-layout-front.png + :align: center + :width: 934px + :height: 645px + :scale: 70% + :alt: ESP32-S2-Kaluga-1 - front + :figclass: align-center + + ESP32-S2-Kaluga-1 - front (click to enlarge) + + +The description of components starts from the ESP32-S2 module on the left side and then goes clockwise. + +**Reserved** means that the functionality is available, but the current version of the kit does not use it. + + +.. list-table:: + :widths: 30 70 + :header-rows: 1 + + * - Key Component + - Description + * - ESP32-S2-WROVER Module + - Module integrating the ESP32-S2 chip that provides Wi-Fi connectivity, data processing power, and flexible data storage. + * - 4.3" LCD FPC Connector + - (Reserved) Connect to a 4.3" LCD extension board using the FPC cable. + * - ESP Prog Connector + - (Reserved) Connection for Espressif's download device (ESP-Prog) to flash ESP32-S2 system. + * - JTAG Switch + - Switch to ON to enable connection between ESP32-S2 and FT2232; JTAG debugging will then be possible using USB-UART/JTAG Port. See also :doc:`../../api-guides/jtag-debugging/index`. + * - Breakout Header 2 + - Some GPIO pins of the ESP32-S2-WROVER module are broken out to this header, see labels on the board. + * - USB-to-UART/JTAG Bridge + - FT2232 adapter board allowing for communication over USB port using UART/JTAG protocols. + * - Camera Header + - Mount a camera extension board here (e.g., ESP-LyraP-CAM). + * - Extension Header + - Mount the extension boards having such connectors here. + * - Reset Button + - Press this button to restart the system. + * - Boot Button + - Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port. + * - USB-UART/JTAG Port + - Communication interface (UART or JTAG) between a PC and the ESP32-S2 module. + * - USB Power Port + - Power supply for the board. + * - Battery Port + - Connect an external battery to the 2-pin battery connector. + * - Power On LED + - Turns on when the USB or an external power supply is connected to the board. + * - Power Switch + - Switch to ON to power the system. + * - RGB Jumper + - To have access to the RGB LED, place a jumper onto the pins. + * - RGB LED + - Programmable RGB LED and controlled by GPIO45. Before using it, you need to put RGB Jumper ON. + * - Power Regulator + - Regulator converts 5 V to 3.3 V. + * - I2C FPC Connector + - (Reserved) Connect to other I2C extension boards using the FPC cable. + * - Breakout Header 1 + - Some GPIO pins of the ESP32-S2-WROVER module are broken out to this header, see labels on the board. + * - Touch FPC Connector + - Connect the ESP-LyraP-TouchA extension board using the FPC cable. + * - Touch Switch + - In OFF position, GPIO1 to GPIO14 are used for connection to touch sensors; switch to ON if you want to use them for other purposes. + * - 3.2" LCD FPC connector + - Connect a 3.2" LCD extension board (e.g., ESP-LyraP-LCD32) using the FPC cable. + + +Start Application Development +----------------------------- + +Before powering up your ESP32-S2-Kaluga-1, please make sure that it is in good condition with no obvious signs of damage. + + +Required Hardware +^^^^^^^^^^^^^^^^^ + +- ESP32-S2-Kaluga-1 +- Two USB 2.0 cables (Standard-A to Micro-B) + + - For power supply + - For UART/JTAG communication + +- Computer running Windows, Linux, or macOS +- Any extension boards of your choice + + +Hardware Setup +^^^^^^^^^^^^^^ + +1. Connect the extension board(s) of your choice (go to their respective user guides if necessary) +2. Plug in both USB cables +3. Turn the **Power Switch** to ON - the Power On LED will light up + + +.. _user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup: + +Software Setup +^^^^^^^^^^^^^^ + +Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment. + +The programming guide and application examples for your ESP32-S2-Kaluga-1 kit can be found in `esp-dev-kits `_ repository on GitHub. + + +Contents and Packaging +---------------------- + +Retail orders +^^^^^^^^^^^^^ + +If you order one or several samples of the kit, each ESP32-S2-Kaluga-1 development kit comes in an individual package containing: + +- Main Board + - ESP32-S2-Kaluga-1 +- Extension Boards: + - ESP-LyraT-8311A + - ESP-LyraP-CAM + - ESP-LyraP-TouchA + - ESP-LyraP-LCD32 +- Connectors + - 20-pin FPC cable (to connect ESP32-S2-Kaluga-1 to ESP-LyraP-TouchA) +- Fasteners + - Mounting bolts (x8) + - Screws (x4) + - Nuts (x4) + +For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample. + + +Wholesale Orders +^^^^^^^^^^^^^^^^ + +If you order in bulk, the boards come in large cardboard boxes. + +For wholesale orders, please check `Espressif Product Ordering Information `_ (PDF) + + +Hardware Reference +================== + + +Block Diagram +------------- + +A block diagram below shows the components of the ESP32-S2-Kaluga-1 and their interconnections. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-block-diagram.png + :align: center + :alt: ESP32-S2-Kaluga-1 block diagram + :figclass: align-center + + ESP32-S2-Kaluga-1 block diagram + + +Power Supply Options +-------------------- + +There are four ways to provide power to the board: + +- Micro USB port, default power supply +- External battery via the 2-pin battery connector +- 5V and GND header pins +- 3V3 and GND header pins + + +.. _user-guide-esp32-s2-kaluga-1-kit-v1.2-ext-board-compatibility: + +Compatibility of Extension Boards +--------------------------------- + +If you want to use more than one extension board at the same time, please check the table given below. + +.. list-table:: + :widths: 20 10 30 40 + :header-rows: 1 + + * - Boards Used + - HW Conflict + - Limitations + - Solution + * - 8311A v1.2 + CAM v1.0 + - I2S Controller, IO46 + - ESP32-S2 has only one I2S interface. But both extension boards require connection via the ESP32-S2's I2S interface (ESP-LyraT-8311A in Standard mode, ESP-LyraP-CAM in Camera mode). If IO46 is used by both extension boards at the same time, ESP-LyraP-CAM experiences interferences when used. + - No ready solution for now. + * - TouchA v1.1 + LCD32 v1.1 + - IO11, IO6 + - Touch actions cannot be triggered because of the multiplexed pin IO11. ESP-LyraP-LCD32 is also affected because its BK (BLCT) pin is connected to pin IO6. + - Do not initialize IO11 (NETWORK) and IO6 (PHOTO) for your ESP-LyraP-TouchA. + * - 8311A v1.2 + LCD32 v1.1 + - IO6 + - The two extension boards can be used at the same time. However, since the BK (BLCT) pin of ESP32-S2-Kaluga-1 is connected to IO6, ESP-LyraT-8311A's pin BT_ADC cannot be used and the board's six buttons will not be available. + - There is a solution that will allow you to use ESP-LyraT-8311A's pin BT_ADC, but will stop you from controlling the display background brightness with software: on your ESP-LyraP-LCD32 board, remove R39, change R41 to 100 Ohm, switch BLCT_L to on. + * - TouchA v1.1 + 8311A v1.2 + - Pin BT_ADC on ESP-LyraT-8311A + - The two extension boards can be used at the same time. However, ESP-LyraP-TouchA cannot be triggered if ESP-LyraT-8311A's pin BT_ADC is used to initialize the board's six buttons. + - If you plan to use ESP-LyraT-8311A's pin BT_ADC, do not initialize pin IO6 (PHOTO) for your ESP-LyraP-TouchA. + * - TouchA v1.1 + CAM v1.0 + - IO1, IO2, IO3 + - Cannot be used simultaneously because of the mentioned multiplexed pins. + - For ESP-LyraP-TouchA, do not initialize IO1 (VOL_UP), IO2 (PLAY), and IO3 (VOL_DOWN). + * - TouchA v1.1 + LCD32 v1.1 + CAM v1.0 + - IO1, IO2, IO3, IO6, IO11 + - Conflicts on the mentioned multiplexed pins. + - **Solution 1**: For ESP-LyraP-TouchA, do not initialize IO1 (VOL_UP), IO2 (PLAY), IO3 (VOL_DOWN), IO6 (PHOTO) and IO11 (NETWORK). **Solution 2**: It will allow you to initialize IO6 (PHOTO) properly, but will stop you from controlling the background brightness with software. On your ESP-LyraP-LCD32, remove R39, change R41 to 100 Ohm, switch BLCT_L to on. + * - TouchA v1.1 + LCD32 v1.1 + 8311A v1.2 + - IO6, IO11 + - IO11 is multiplexed; IO11 is also multiplexed stopping you from using ESP-LyraT-8311A's pin BT_ADC that is needed to initialize the board's six buttons. + - **Solution 1**: For ESP-LyraP-TouchA, do not initialize IO6 (PHOTO) and IO11 (NETWORK). Please note that the six buttons on ESP-LyraT-8311A still cannot be used. **Solution 2**: On your ESP-LyraP-LCD32, remove R39, change R41 to 100 Ohm, switch BLCT_L to on. For your ESP-LyraP-TouchA, do not initialize IO11 (NETWORK). If you want to use the six buttons on your ESP-LyraT-8311A, also do not initialize IO6 (PHOTO). + + +Known issues +============ + +.. list-table:: + :widths: 22 24 32 22 + :header-rows: 1 + + * - Hardware Issue + - Description + - Reason for Failure + - Solution + * - ESP-LyraP-CAM v1.0, pin IO45, IO46 + - Flashing firmware might be impossible with the extension board connected to the main board. + - Incorrect timing sequence is fed to strapping pins IO45 and IO46 when the board is powered on. It stops the board from booting successfully. + - While flashing the main board, keep the extension board disconnected. + * - ESP-LyraP-CAM v1.0, pin IO45, IO46 + - Rebooting the board by pressing Reset might not lead to desired results. + - Incorrect timing sequence is fed to strapping pins IO45 and IO46 when the board is powered on. It stops the board from booting successfully. + - No ready solution for v1.2. This bug is fixed in ESP32-S2-Kaluga-1 V1.3. + * - ESP-LyraT-8311A v1.2, pin IO46 + - Flashing firmware might be impossible with the extension board connected to the main board. + - Incorrect timing sequence is fed to strapping pin IO46 when the board is powered on. It stops the board from booting successfully. + - While flashing the main board, keep the extension board disconnected. + * - ESP-LyraT-8311A v1.2, pin IO46 + - Rebooting the board by pressing Reset might not lead to desired results. + - Incorrect timing sequence is fed to strapping pin IO46 when the board is powered on. It stops the board from booting successfully. + - No ready solution for v1.2. This bug is fixed in ESP32-S2-Kaluga-1 V1.3. + + +Hardware Revision Details +========================= + +No previous versions available. + + +Related Documents +================= + +.. toctree:: + :hidden: + + user-guide-esp-lyrap-cam-v1.0 + user-guide-esp-lyrap-lcd32-v1.1 + user-guide-esp-lyrap-toucha-v1.1 + user-guide-esp-lyrat-8311a_v1.2 + +- `ESP32-S2-WROVER Datasheet `_ (PDF) +- `Espressif Product Ordering Information `_ (PDF) +- :doc:`../../api-guides/jtag-debugging/index` + +- `ESP32-S2-Kaluga-1 Schematic `_ (PDF) +- `ESP32-S2-Kaluga-1 PCB Layout `_ (PDF) +- `ESP32-S2-Kaluga-1 Pin Mapping `_ (Excel) + +For other design documentation for the board, please contact us at sales@espressif.com. \ No newline at end of file diff --git a/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst b/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst index d2b799ca2d..f99f1024f8 100644 --- a/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst +++ b/docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst @@ -1,10 +1,12 @@ -===================== -ESP32-S2-Kaluga-1 Kit -===================== +========================== +ESP32-S2-Kaluga-1 Kit v1.3 +========================== :link_to_translation:`zh_CN:[中文]` -The ESP32-S2-Kaluga-1 kit is a development kit by Espressif that is mainly created to: +Older version: :doc:`user-guide-esp32-s2-kaluga-1-kit-v1.2` + +The ESP32-S2-Kaluga-1 kit v1.3 is a development kit by Espressif that is mainly created to: - Demonstrate the ESP32-S2's human-computer interaction functionalities - Provide the users with the tools for development of human-computer interaction applications based on the ESP32-S2 @@ -16,6 +18,7 @@ There are many ways of how the ESP32-S2's abundant functionalities can be used. - **Industrial automation equipment**: Wireless control and robot technology, intelligent lighting, HVAC control equipment, etc. - **Retail and catering industry**: POS machines and service robots +.. Image of v1.2 is used as there are no visual changes .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-kit-v1.0-3d.png :align: center @@ -33,10 +36,12 @@ The ESP32-S2-Kaluga-1 kit consists of the following boards: - Main board: *ESP32-S2-Kaluga-1* - Extension boards: - - :doc:`ESP-LyraT-8311A ` audio player - - :doc:`ESP-LyraP-TouchA ` touch panel - - :doc:`ESP-LyraP-LCD32 ` 3.2" LCD screen - - :doc:`ESP-LyraP-CAM ` camera board + - :doc:`user-guide-esp-lyrat-8311a_v1.3` - audio player + - :doc:`user-guide-esp-lyrap-toucha-v1.1` - touch panel + - :doc:`user-guide-esp-lyrap-lcd32-v1.2` - 3.2" LCD screen + - :doc:`user-guide-esp-lyrap-cam-v1.1` - camera board + +Due to the presence of multiplexed pins on ESP32-S2, certain extension board combinations have limited compatibility. For more details, please see :ref:`user-guide-esp32-s2-kaluga-1-kit-ext-board-compatibility`. This document is **mostly dedicated to the main board** and its interaction with the extension boards. For more detailed information on each extension board, click their respective links. @@ -60,18 +65,18 @@ Overview The ESP32-S2-Kaluga-1 main board is the heart of the kit. It integrates the ESP32-S2-WROVER module and all the connectors for extension boards. This board is the key tool in prototyping human-computer interaction interfaces. -The ESP32-S2-Kaluga-1 board has connectors for: +The ESP32-S2-Kaluga-1 board has connectors for boards with: -- Boards with the Extension Header (ESP-LyraT-8311A, ESP-LyraP-LCD32) -- Camera board (ESP-LyraP-CAM) -- Touch panel (ESP-LyraP-TouchA) -- LCD displays (no official extension boards yet) -- I2C devices (no official extension boards yet) +- Extension header (ESP-LyraT-8311A, ESP-LyraP-LCD32) +- Camera header (ESP-LyraP-CAM) +- Touch FPC coneector (ESP-LyraP-TouchA) +- LCD FPC connector (no official extension boards yet) +- I2C FPC connector (no official extension boards yet) -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-3d.png +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32s2-kaluga-1-v1.3-3d.png :align: center - :width: 2631px - :height: 1966px + :width: 3089px + :height: 2335px :scale: 25% :alt: ESP32-S2-Kaluga-1 :figclass: align-center @@ -81,7 +86,7 @@ The ESP32-S2-Kaluga-1 board has connectors for: All the four extension boards are specially desgined to support the following features: * Touch panel control - * 14 touch sensors, three of which support distance sensing (proximity mode) + * Six touch buttons * Supports acrylic panels up to 5 mm * Wet hand operation * Water rejection, ESP32-S2 can be configured to disable all touchpads automatically if multiple pads are simultaneously covered with water and to re-enable touchpads if the water is removed @@ -103,7 +108,7 @@ All the four extension boards are specially desgined to support the following fe Description of Components ------------------------- -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-layout-front.png +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.3-layout-front.png :align: center :width: 934px :height: 645px @@ -113,6 +118,16 @@ Description of Components ESP32-S2-Kaluga-1 - front (click to enlarge) +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.3-layout-back.png + :align: center + :width: 934px + :height: 600px + :scale: 70% + :alt: ESP32-S2-Kaluga-1 - back + :figclass: align-center + + ESP32-S2-Kaluga-1 - back (click to enlarge) + The description of components starts from the ESP32-S2 module on the left side and then goes clockwise. @@ -126,49 +141,51 @@ The description of components starts from the ESP32-S2 module on the left side a * - Key Component - Description * - ESP32-S2-WROVER Module - - Module integrating the ESP32-S2 chip that provides Wi-Fi connectivity, data processing power, and flexible data storage + - Module integrating the ESP32-S2 chip that provides Wi-Fi connectivity, data processing power, and flexible data storage. * - 4.3" LCD FPC Connector - - (Reserved) Connect to a 4.3" LCD extension board using the FPC cable + - (Reserved) Connect to a 4.3" LCD extension board using the FPC cable. * - ESP Prog Connector - - (Reserved) Connection for Espressif's download device (ESP-Prog) to flash ESP32-S2 system + - (Reserved) Connection for Espressif's download device (ESP-Prog) to flash ESP32-S2 system. * - JTAG Switch - - Switch to ON to enable connection between ESP32-S2 and FT2232 + - Switch to ON to enable connection between ESP32-S2 and FT2232; JTAG debugging will then be possible using USB-UART/JTAG Port. See also :doc:`../../api-guides/jtag-debugging/index`. * - Breakout Header 2 - - Some GPIO pins of the ESP32-S2-WROVER module are broken out to this header, see labels on the board + - Some GPIO pins of the ESP32-S2-WROVER module are broken out to this header, see labels on the board. * - USB-to-UART/JTAG Bridge - - FT2232 adapter board allowing for communication over USB port using UART/JTAG protocols + - FT2232 adapter board allowing for communication over USB port using UART/JTAG protocols. * - Camera Header - - Mount a camera extension board here (e.g., ESP-LyraP-CAM) + - Mount a camera extension board here (e.g., ESP-LyraP-CAM). * - Extension Header - - Mount the extension boards having such connectors here + - Mount the extension boards having such connectors here. * - Reset Button - Press this button to restart the system * - Boot Button - - Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port + - Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port. * - USB-UART/JTAG Port - - Communication interface (UART or JTAG) between a PC and the ESP32-S2 module + - Communication interface (UART or JTAG) between a PC and the ESP32-S2 module. * - USB Power Port - - Power supply for the board + - Power supply for the board. * - Battery Port - - Connect an external battery to the 2-pin connector + - Connect an external battery to the 2-pin battery connector. + * - Power On LED + - Turns on when the USB or an external power supply is connected to the board. * - Power Switch - - Switch to ON to power the system + - Switch to ON to power the system. * - RGB Jumper - - To have access to the RGB LED, place a jumper onto the pins + - To have access to the RGB LED, place a jumper onto the pins. * - RGB LED - Programmable RGB LED and controlled by GPIO45. Before using it, you need to put RGB Jumper ON. * - Power Regulator - - Regulator converts 5 V to 3.3 V + - Regulator converts 5 V to 3.3 V. * - I2C FPC Connector - - (Reserved) Connect to other I2C extension boards using the FPC cable + - (Reserved) Connect to other I2C extension boards using the FPC cable. * - Breakout Header 1 - - Some GPIO pins of the ESP32-S2-WROVER module are broken out to this header, see labels on the board + - Some GPIO pins of the ESP32-S2-WROVER module are broken out to this header, see labels on the board. * - Touch FPC Connector - - Connect the ESP-LyraP-TouchA extension board using the FPC cable + - Connect the ESP-LyraP-TouchA extension board using the FPC cable. * - Touch Switch - - In OFF position, GPIO1 to GPIO14 are used for connection to touch sensors; switch to ON if you want to use them for other purposes + - In OFF position, GPIO1 to GPIO14 are used for connection to touch sensors; switch to ON if you want to use them for other purposes. * - 3.2" LCD FPC connector - - Connect a 3.2" LCD extension board (e.g., ESP-LyraP-LCD32) using the FPC cable + - Connect a 3.2" LCD extension board (e.g., ESP-LyraP-LCD32) using the FPC cable. Start Application Development @@ -205,7 +222,7 @@ Software Setup Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment. -The programming guide and application examples for your ESP32-S2-Kaluga-1 kit can be found `here `_. +The programming guide and application examples for your ESP32-S2-Kaluga-1 kit can be found in `esp-dev-kits `_ repository on GitHub. Contents and Packaging @@ -214,7 +231,17 @@ Contents and Packaging Retail orders ^^^^^^^^^^^^^ -If you order one or several samples of the kit, each ESP32-S2-Kaluga-1 development kit comes in an individual package containing: +If you order one or several samples of the kit, each ESP32-S2-Kaluga-1 development kit comes in an individual package. + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32s2-kaluga-1-kit-v1.3-package-3d.png + :align: center + :alt: ESP32-S2-Kaluga-1 - package + :figclass: align-center + + ESP32-S2-Kaluga-1 - package + + +The contents are as follows: - Main Board - ESP32-S2-Kaluga-1 @@ -248,6 +275,8 @@ Hardware Reference Block Diagram ------------- +.. Image of v1.2 is used as there are no visual changes + A block diagram below shows the components of the ESP32-S2-Kaluga-1 and their interconnections. .. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-block-diagram.png @@ -264,15 +293,78 @@ Power Supply Options There are four ways to provide power to the board: - Micro USB port, default power supply -- External battery via the 2-pin *BAT* connector +- External battery via the 2-pin battery connector - 5V and GND header pins - 3V3 and GND header pins +.. _user-guide-esp32-s2-kaluga-1-kit-ext-board-compatibility: + +Compatibility of Extension Boards +--------------------------------- + +If you want to use more than one extension board at the same time, please check the table given below. + +.. list-table:: + :widths: 20 15 33 32 + :header-rows: 1 + + * - Boards Used + - HW Conflict + - Limitations + - Solution + * - 8311A v1.3 + CAM v1.1 + - I2S Controller + - ESP32-S2 has only one I2S interface. But both extension boards require connection via the ESP32-S2's I2S interface (LyraT-8311A in Standard mode, ESP-LyraP-CAM in Camera mode). + - Utilize time division multiple access, or use a different audio module that can be connected via other GPIOs or DAC. + * - TouchA v1.1 + LCD32 v1.2 + - IO11, IO6 + - Touch actions cannot be triggered because of the multiplexed pin IO11. ESP-LyraP-LCD32 will not be affected because its BLCT pin will be disconnected fron IO6. + - Do not initialize IO11 (NETWORK) for your ESP-LyraP-TouchA, or configure the BLCT pin to `-1` (= do not use BLCT) for your ESP-LyraP-LCD32. + * - 8311A v1.3 + LCD32 v1.2 + - IO6 + - BLCT pin of ESP32-S2-Kaluga-1 will be disconnected from IO6. + - Configure the BK pin to `-1` (= do not use BLCT) for your ESP-LyraP-LCD32. + * - TouchA v1.1 + 8311A v1.3 + - Pin BT_ADC on ESP-LyraT-8311A + - This pin is required for initialization of the six button on ESP-LyraT-8311A. At the same time, ESP-LyraP-TouchA needs this pin for its touch actions. + - If you plan to use buttons on ESP-LyraT-8311A, do not initialize pin IO6 (PHOTO) for your ESP-LyraP-TouchA. + * - TouchA v1.1 + CAM v1.1 + - IO1, IO2, IO3 + - Cannot be used simultaneously because of the mentioned multiplexed pins. + - For ESP-LyraP-TouchA, do not initialize IO1 (VOL_UP), IO2 (PLAY), and IO3 (VOL_DOWN). + * - TouchA v1.1 + LCD32 v1.2 + CAM v1.1 + - IO1, IO2, IO3, IO11 + - Conflicts on the mentioned multiplexed pins. + - For ESP-LyraP-TouchA, do not initialize IO1 (VOL_UP), IO2 (PLAY), IO3 (VOL_DOWN), and IO11 (NETWORK). + * - TouchA v1.1 + LCD32 v1.2 + 8311A v1.3 + - IO6, IO11 + - If ESP-LyraT-8311A's pin BT_ADC is used to initialize the board's six buttons, IO6 and IO11 will not be available for the other boards. + - Do not initialize IO11 (NETWORK) for your ESP-LyraP-TouchA. Also, if you need to use BT_ADC, do not initialize IO6 (PHOTO). + + + Hardware Revision Details ========================= -No previous versions available. +ESP32-S2-Kaluga-1 Kit v1.3 +-------------------------- + +* The following pins re-assigned to fix the download issue + + * Camera D2： GPIO36 + * Camera D3： GPIO37 + * AU_I2S1_SDI： GPIO34 + * AU_WAKE_INT： GPIO46 + +* RGB pin header moved to the board's edge +* All dip switches moved to the flip side for convenient operation + + +ESP32-S2-Kaluga-1 Kit v1.2 +-------------------------- + +:doc:`Initial release ` Related Documents @@ -281,16 +373,20 @@ Related Documents .. toctree:: :hidden: - user-guide-esp-lyrap-cam-v1.0 - user-guide-esp-lyrap-lcd32-v1.1 - user-guide-esp-lyrap-toucha-v1.1 - user-guide-esp-lyrat-8311a_v1.2 + user-guide-esp32-s2-kaluga-1-kit-v1.2.rst + user-guide-esp-lyrap-cam-v1.1 + user-guide-esp-lyrap-lcd32-v1.2 + user-guide-esp-lyrat-8311a_v1.3 - `ESP32-S2-WROVER Datasheet `_ (PDF) - `Espressif Product Ordering Information `_ (PDF) +- :doc:`../../api-guides/jtag-debugging/index` -- `ESP32-S2-Kaluga-1 Schematic `_ (PDF) -- `ESP32-S2-Kaluga-1 PCB Layout `_ (PDF) -- `ESP32-S2-Kaluga-1 Pin Mapping `_ (Excel) +- `ESP32-S2-Kaluga-1 Schematic `_ (PDF) +- `ESP32-S2-Kaluga-1 PCB Layout `_ (PDF) +- `ESP32-S2-Kaluga-1 Pin Mapping `_ (Excel) -For other design documentation for the board, please contact us at sales@espressif.com. \ No newline at end of file +For other design documentation for the board, please contact us at sales@espressif.com. + + + \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst index ec23dbd9da..4173b9da54 100644 --- a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst @@ -77,7 +77,7 @@ ESP-LyraP-CAM 上电前，请首先确认开发板完好无损。 软件设置 ^^^^^^^^ -请前往 ESP32-S2-Kaluga-1 开发套件用户指南的 :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` 章节。 +请前往 ESP32-S2-Kaluga-1 开发套件用户指南的 :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup` 章节。 硬件参考 diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst new file mode 100644 index 0000000000..efaffb4c7a --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst @@ -0,0 +1 @@ +.. include:: ../../../en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.1.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst index 52c20411b4..9cd9cc0552 100644 --- a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst @@ -94,7 +94,7 @@ ESP-LyraP-LCD32 上电前，请首先确认开发板完好无损。 软件设置 ^^^^^^^^ -请前往 ESP32-S2-Kaluga-1 开发套件用户指南的 :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` 章节。 +请前往 ESP32-S2-Kaluga-1 开发套件用户指南的 :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup` 章节。 硬件参考 diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst new file mode 100644 index 0000000000..5ea0d21dd1 --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst @@ -0,0 +1 @@ +.. include:: ../../../en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.2.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst index 27aae03c60..5813eefa4f 100644 --- a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.2.rst @@ -113,7 +113,7 @@ ESP-LyraT-8311A 上电前，请首先确认开发板完好无损。 请根据您的具体应用，参考以下部分： * ESP-ADF（乐鑫音频开发框架）的用户，请前往 `ESP-ADF 入门指南 `_。 -* ESP32-IDF（乐鑫 IoT 开发框架）的用户，请前往 ESP32-S2-Kaluga-1 开发套件用户指南的 :ref:`user-guide-esp32-s2-kaluga-1-kit-software-setup` 章节。 +* ESP32-IDF（乐鑫 IoT 开发框架）的用户，请前往 ESP32-S2-Kaluga-1 开发套件用户指南的 :ref:`user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup` 章节。 硬件参考 diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst new file mode 100644 index 0000000000..ef19c75c86 --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst @@ -0,0 +1 @@ +.. include:: ../../../en/hw-reference/esp32s2/user-guide-esp-lyrat-8311a_v1.3.rst \ No newline at end of file diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst new file mode 100644 index 0000000000..56001721fa --- /dev/null +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst @@ -0,0 +1,297 @@ +======================= +ESP32-S2-Kaluga-1 套件 +======================= + +:link_to_translation:`en:[English]` + +ESP32-S2-Kaluga-1 是一款来自乐鑫的开发套件，主要可用于以下目的： + +- 展示 ESP32-S2 芯片的人机交互功能 +- 为用户提供基于 ESP32-S2 的人机交互应用开发工具 + +ESP32-S2 的功能强大，应用场景非常丰富。对于初学者来说，可能的用例包括： + +- **智能家居**：从最简单的智能照明、智能门锁、智能插座，到更复杂的视频流设备、安防摄像头、OTT 设备和家用电器等 +- **电池供电设备**：Wi-Fi mesh 传感器网络、Wi-Fi 网络玩具、可穿戴设备、健康管理设备等 +- **工业自动化设备**：无线控制与机器人技术、智能照明、HVAC 控制设备等 +- **零售和餐饮业**：POS 机和服务机器人 + + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-kit-v1.0-3d.png + :align: center + :width: 3452px + :height: 1590px + :scale: 20% + :alt: ESP32-S2-Kaluga-1 套装装配图 + :figclass: align-center + + ESP32-S2-Kaluga-1-Kit 概述（点击放大） + + +ESP32-S2-Kaluga-1 套件包括以下几个开发板： + +- 主板：*ESP32-S2-Kaluga-1* +- 扩展板： + + - :doc:`ESP-LyraT-8311A ` 音频播放器 + - :doc:`ESP-LyraP-TouchA ` 触摸板 + - :doc:`ESP-LyraP-LCD32 ` 3.2" LCD 屏 + - :doc:`ESP-LyraP-CAM ` 摄像头 + +本文档主要介绍** ESP32-S2-Kaluga-1 主板** 及其与扩展板的交互。更多有关具体扩展板的信息，请点击相应的链接。 + +本指南包括： + +- `快速入门`_：提供 ESP32-S2-Kaluga-1 的简要概述及必须了解的硬件和软件信息。 +- `硬件参考`_：提供 ESP32-S2-Kaluga-1 的详细硬件信息。 +- `硬件修订历史`_：提供该开发版的“修订历史”、“已知问题”以及此前版本开发板的用户指南链接。 +- `相关文档`_：提供相关文档的链接。 + + +快速入门 +======== + + +本节介绍如何开始使用 ESP32-S2-Kaluga-1，主要包括三大部分：首先，介绍一些关于 ESP32-S2-Kaluga-1 的基本信息，然后在 `应用程序开发`_ 章节介绍如何进行硬件初始化，最后介绍如何为 ESP32-S2-Kaluga-1 烧录固件。 + + +概述 +---- + +ESP32-S2-Kaluga-1 主板是整个套件的核心。该主板集成了 ESP32-S2-WROVER 模组，并配备连接至各个扩展板的连接器。ESP32-S2-Kaluga-1 是人机交互接口原型设计的关键工具。 + +ESP32-S2-Kaluga-1 主板配备了多个连接器，可连接至以下扩展板： + +- 其他带有相应连接器的拓展板（比如 ESP-LyraT-8311A 和 ESP-LyraP-LCD32) +- 摄像头拓展板 (ESP-LyraP-CAM) +- 触摸板拓展板 (ESP-LyraP-TouchA) +- LCD 显示屏（敬请期待) +- I2C 设备（敬请期待) + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-3d.png + :align: center + :width: 2631px + :height: 1966px + :scale: 25% + :alt: ESP32-S2-Kaluga-1 + :figclass: align-center + + ESP32-S2-Kaluga-1（点击放大） + +所有四个扩展板都经过特别设计，以支持以下功能： + + * 触摸板控制 + * 集成 14 个触摸传感器，其中 3 个支持距离感应（接近模式) + * 支持最大 5 mm 的亚克力板 + * 湿手操作 + * 防水功能，ESP32-S2 可以配置为在多个触摸板同时被水复盖时自动禁用所有触摸板功能，并在去除水滴后重新启用触摸板 + + * 音频播放 + * 连接扬声器，以播放音频 + * 配合触控板使用，可控制音频播放和调节音量 + + * LCD 显示屏 + * LCD 接口（8 位并行 RGB、8080 和 6800 接口) + + * 摄像头图像采集 + * 支持 OV2640 和 OV3660 相机模块 + * 8 位 DVP 图像传感器接口（ESP32-S2 还支持 16 位 DVP 图像传感器，但需要您自行进行二次开发) + * 高达 40 MHz 时钟频率 + * 优化 DMA 传输带宽，便于传输高分辨率图像 + + +组件描述 +-------- + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-layout-front.png + :align: center + :width: 934px + :height: 645px + :scale: 70% + :alt: ESP32-S2-Kaluga-1 - 正面 + :figclass: align-center + + ESP32-S2-Kaluga-1 - 正面（点击放大） + + +下表将从左边的 ESP32-S2 模组开始，以顺时针顺序介绍上图中的主要组件。 + +**保留** 表示该功能可用，但当前版本的套件并未启用该功能。 + + +.. list-table:: + :widths: 30 70 + :header-rows: 1 + + * - 主要组件 + - 描述 + * - ESP32-S2-WROVER 模组 + - 模块集成 ESP32-S2 芯片，提供 Wi-Fi 连接、数据处理和灵活的数据存储 + * - 4.3" LCD FPC 连接器 + - （保留）使用 FPC 电缆连接至 4.3" LCD 拓展板 + * - ESP Prog 连接器 + - （保留）连接乐鑫固件下载设备 (ESP-Prog)，从而向板子上的 ESP32-S2 芯片下载固件 + * - JTAG 开关 + - 切换到 ON 方向，启用 ESP32-S2 和 FT2232 之间的连接 + * - 引出管脚排针 2 + - ESP32-S2-WROVER 模组的部分 GPIO 直接引出至该开发板排针（具体请见开发板上的标记） + * - USB 转 UART/JTAG 桥接器 + - FT2232 适配器板，允许在 USB 端口使用 UART/JTAG 协议进行通信 + * - 相机头排针 + - 用于安装摄像头扩展板（例如 ESP-LyraP-CAM) + * - 扩展板排针 + - 用于安装带有配套连接器的其他扩展板 + * - Reset 复位按钮 + - 重启系统 + * - Boot 按钮 + - 按下 **Boot** 键并保持，同时按一下 **Reset** 键，进入“固件下载”模式，通过串口下载固件。 + * - USB-UART/JTAG 端口 + - PC 和 ESP32-S2 模组之间的通信接口（UART 或 JTAG） + * - USB 电源端口 + - 电路板的电源 + * - 电池端口 + - 2 针连接器，连接外部电源 + * - 电源开关 + - 切换到 ON 方向，为系统供电 + * - RGB 跳线 + - 如需使用 RGB LED，需在该位置增加一个跳线 + * - RGB LED + - 可编程 RGB LED，由 GPIO45 控制。在使用前请先安装 RGB 跳线。 + * - 电源调节器 + - 5 V 转 3.3 V 调压器 + * - I2C FPC 连接器 + - （保留）使用 FPC 电缆连接到其他 I2C 扩展板 + * - 引出管脚排针 1 + - ESP32-S2-WROVER 模组的部分 GPIO 直接引出至该开发板排针（具体请见开发板上的标记） + * - 触摸 FPC 连接器 + - 使用 FPC 电缆连接 ESP-LyraP-TouchA 扩展板 + * - 触摸开关 + - 切换到 OFF 方向，配置 GPIO1 到 GPIO14 连接触摸传感器；切换到 ON 方向，配置 GPIO1 到 GPIO14 用于其他目的。 + * - 3.2" LCD FPC 连接器 + - 通过 FPC 电缆连接主板和 3.2" LCD 扩展板（例如 ESP-LyraP-LCD32） + + +应用程序开发 +------------ + +ESP32-S2-Kaluga-1 上电前，请首先确认开发板完好无损。 + + +硬件准备 +^^^^^^^^ + +- ESP32-S2-Kaluga-1 +- 两根 USB 2.0 电缆（标准 A 转 Micro-B) + + - 电源选项 + - 用于 UART/JTAG 通信 + +- PC（Windows、Linux 或 macOS） +- 您选择的任何扩展板 + + +硬件设置 +^^^^^^^^ + +1. 连接您选择的扩展板（更多信息，请见对应拓展板的用户指南) +2. 插入两根 USB 电缆 +3. 打开 **电源开关** 时，**Power On LED** 应点亮。 + + +.. _user-guide-esp32-s2-kaluga-1-kit-v1.2-software-setup: + +软件设置 +^^^^^^^^ + +请前往 :doc:`../../get-started/index`，在 :ref:`get-started-step-by-step` 一节查看如何快速设置开发环境。 + +您还可以点击 `这里 `_，获取有关 ESP32-S2-Kaluga-1 套件编程指南与应用示例的更多内容。 + + +内容和包装 +---------- + +零售订单 +^^^^^^^^ + +每一个零售 ESP32-S2-Kaluga-1 开发套件均有独立包装，内含以下部分： + +- 主板 + - ESP32-S2-Kaluga-1 +- 扩展板： + - ESP-LyraT-8311A + - ESP-LyraP-CAM + - ESP-LyraP-TouchA + - ESP-LyraP-LCD32 +- 连接器 + - 20 针 FPC 电缆（用于连接 ESP32-S2-Kaluga-1 主板至 ESP-LyraP-TouchA 拓展板) +- 紧固件 + - 安装螺栓 (x 8) + - 螺丝 (x 4) + - 螺母 (x 4) + +零售购买，请前往 https://www.espressif.com/zh-hans/company/contact/buy-a-sample。 + + +批发订单 +^^^^^^^^ + +ESP32-S2-Kaluga-1 开发套件的批发包装为纸板箱。 + +批量订货，请参考 `乐鑫产品订购信息 `_ (PDF)。 + + +硬件参考 +======== + + +功能框图 +-------- + +ESP32-S2-Kaluga-1 的主要组件和连接方式如下图所示。 + +.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-block-diagram.png + :align: center + :alt: ESP32-S2-Kaluga-1 框图 + :figclass: align-center + + ESP32-S2-Kaluga-1 框图 + + +电源选项 +-------- + +开发板可任一选用以下四种供电方式： + +- Micro USB 端口供电（默认） +- 通过 2 针 *BAT* 连接器连接至外接电池 +- 5V / GND 管脚供电 +- 3V3 / GND 管脚供电 + + +硬件修订历史 +============ + +尚无版本升级历史。 + + +相关文档 +======== + +.. toctree:: + :hidden: + + user-guide-esp-lyrap-cam-v1.0 + user-guide-esp-lyrap-lcd32-v1.1 + user-guide-esp-lyrap-toucha-v1.1 + user-guide-esp-lyrat-8311a_v1.2 + +- `ESP32-S2-WROVER 技术规格书 `_ (PDF) +- `乐鑫产品订购信息 `_ (PDF) + +- `ESP32-S2-Kaluga-1 原理图 `_ (PDF) +- `ESP32-S2-Kaluga-1 PCB 布局图 `_ (PDF) +- `ESP32-S2-Kaluga-1 管脚映射表 `_ (Excel) + +有关本开发板的更多设计文档，请联系我们的商务部门 sales@espressif.com。 + diff --git a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst index e7cef7c228..4b21b5961b 100644 --- a/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst +++ b/docs/zh_CN/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst @@ -1,297 +1,10 @@ -======================= -ESP32-S2-Kaluga-1 套件 -======================= +.. include:: ../../../en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst -:link_to_translation:`en:[English]` - -ESP32-S2-Kaluga-1 是一款来自乐鑫的开发套件，主要可用于以下目的： - -- 展示 ESP32-S2 芯片的人机交互功能 -- 为用户提供基于 ESP32-S2 的人机交互应用开发工具 - -ESP32-S2 的功能强大，应用场景非常丰富。对于初学者来说，可能的用例包括： - -- **智能家居**：从最简单的智能照明、智能门锁、智能插座，到更复杂的视频流设备、安防摄像头、OTT 设备和家用电器等 -- **电池供电设备**：Wi-Fi mesh 传感器网络、Wi-Fi 网络玩具、可穿戴设备、健康管理设备等 -- **工业自动化设备**：无线控制与机器人技术、智能照明、HVAC 控制设备等 -- **零售和餐饮业**：POS 机和服务机器人 - - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-kit-v1.0-3d.png - :align: center - :width: 3452px - :height: 1590px - :scale: 20% - :alt: ESP32-S2-Kaluga-1 套装装配图 - :figclass: align-center - - ESP32-S2-Kaluga-1-Kit 概述（点击放大） - - -ESP32-S2-Kaluga-1 套件包括以下几个开发板： - -- 主板：*ESP32-S2-Kaluga-1* -- 扩展板： - - - :doc:`ESP-LyraT-8311A ` 音频播放器 - - :doc:`ESP-LyraP-TouchA ` 触摸板 - - :doc:`ESP-LyraP-LCD32 ` 3.2" LCD 屏 - - :doc:`ESP-LyraP-CAM ` 摄像头 - -本文档主要介绍** ESP32-S2-Kaluga-1 主板** 及其与扩展板的交互。更多有关具体扩展板的信息，请点击相应的链接。 - -本指南包括： - -- `快速入门`_：提供 ESP32-S2-Kaluga-1 的简要概述及必须了解的硬件和软件信息。 -- `硬件参考`_：提供 ESP32-S2-Kaluga-1 的详细硬件信息。 -- `硬件修订历史`_：提供该开发版的“修订历史”、“已知问题”以及此前版本开发板的用户指南链接。 -- `相关文档`_：提供相关文档的链接。 - - -快速入门 -======== - - -本节介绍如何开始使用 ESP32-S2-Kaluga-1，主要包括三大部分：首先，介绍一些关于 ESP32-S2-Kaluga-1 的基本信息，然后在 `应用程序开发`_ 章节介绍如何进行硬件初始化，最后介绍如何为 ESP32-S2-Kaluga-1 烧录固件。 - - -概述 ----- - -ESP32-S2-Kaluga-1 主板是整个套件的核心。该主板集成了 ESP32-S2-WROVER 模组，并配备连接至各个扩展板的连接器。ESP32-S2-Kaluga-1 是人机交互接口原型设计的关键工具。 - -ESP32-S2-Kaluga-1 主板配备了多个连接器，可连接至以下扩展板： - -- 其他带有相应连接器的拓展板（比如 ESP-LyraT-8311A 和 ESP-LyraP-LCD32) -- 摄像头拓展板 (ESP-LyraP-CAM) -- 触摸板拓展板 (ESP-LyraP-TouchA) -- LCD 显示屏（敬请期待) -- I2C 设备（敬请期待) - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-3d.png - :align: center - :width: 2631px - :height: 1966px - :scale: 25% - :alt: ESP32-S2-Kaluga-1 - :figclass: align-center - - ESP32-S2-Kaluga-1（点击放大） - -所有四个扩展板都经过特别设计，以支持以下功能： - - * 触摸板控制 - * 集成 14 个触摸传感器，其中 3 个支持距离感应（接近模式) - * 支持最大 5 mm 的亚克力板 - * 湿手操作 - * 防水功能，ESP32-S2 可以配置为在多个触摸板同时被水复盖时自动禁用所有触摸板功能，并在去除水滴后重新启用触摸板 - - * 音频播放 - * 连接扬声器，以播放音频 - * 配合触控板使用，可控制音频播放和调节音量 - - * LCD 显示屏 - * LCD 接口（8 位并行 RGB、8080 和 6800 接口) - - * 摄像头图像采集 - * 支持 OV2640 和 OV3660 相机模块 - * 8 位 DVP 图像传感器接口（ESP32-S2 还支持 16 位 DVP 图像传感器，但需要您自行进行二次开发) - * 高达 40 MHz 时钟频率 - * 优化 DMA 传输带宽，便于传输高分辨率图像 - - -组件描述 --------- - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-layout-front.png - :align: center - :width: 934px - :height: 645px - :scale: 70% - :alt: ESP32-S2-Kaluga-1 - 正面 - :figclass: align-center - - ESP32-S2-Kaluga-1 - 正面（点击放大） - - -下表将从左边的 ESP32-S2 模组开始，以顺时针顺序介绍上图中的主要组件。 - -**保留** 表示该功能可用，但当前版本的套件并未启用该功能。 - - -.. list-table:: - :widths: 30 70 - :header-rows: 1 - - * - 主要组件 - - 描述 - * - ESP32-S2-WROVER 模组 - - 模块集成 ESP32-S2 芯片，提供 Wi-Fi 连接、数据处理和灵活的数据存储 - * - 4.3" LCD FPC 连接器 - - （保留）使用 FPC 电缆连接至 4.3" LCD 拓展板 - * - ESP Prog 连接器 - - （保留）连接乐鑫固件下载设备 (ESP-Prog)，从而向板子上的 ESP32-S2 芯片下载固件 - * - JTAG 开关 - - 切换到 ON 方向，启用 ESP32-S2 和 FT2232 之间的连接 - * - 引出管脚排针 2 - - ESP32-S2-WROVER 模组的部分 GPIO 直接引出至该开发板排针（具体请见开发板上的标记） - * - USB 转 UART/JTAG 桥接器 - - FT2232 适配器板，允许在 USB 端口使用 UART/JTAG 协议进行通信 - * - 相机头排针 - - 用于安装摄像头扩展板（例如 ESP-LyraP-CAM) - * - 扩展板排针 - - 用于安装带有配套连接器的其他扩展板 - * - Reset 复位按钮 - - 重启系统 - * - Boot 按钮 - - 按下 **Boot** 键并保持，同时按一下 **Reset** 键，进入“固件下载”模式，通过串口下载固件。 - * - USB-UART/JTAG 端口 - - PC 和 ESP32-S2 模组之间的通信接口（UART 或 JTAG） - * - USB 电源端口 - - 电路板的电源 - * - 电池端口 - - 2 针连接器，连接外部电源 - * - 电源开关 - - 切换到 ON 方向，为系统供电 - * - RGB 跳线 - - 如需使用 RGB LED，需在该位置增加一个跳线 - * - RGB LED - - 可编程 RGB LED，由 GPIO45 控制。在使用前请先安装 RGB 跳线。 - * - 电源调节器 - - 5 V 转 3.3 V 调压器 - * - I2C FPC 连接器 - - （保留）使用 FPC 电缆连接到其他 I2C 扩展板 - * - 引出管脚排针 1 - - ESP32-S2-WROVER 模组的部分 GPIO 直接引出至该开发板排针（具体请见开发板上的标记） - * - 触摸 FPC 连接器 - - 使用 FPC 电缆连接 ESP-LyraP-TouchA 扩展板 - * - 触摸开关 - - 切换到 OFF 方向，配置 GPIO1 到 GPIO14 连接触摸传感器；切换到 ON 方向，配置 GPIO1 到 GPIO14 用于其他目的。 - * - 3.2" LCD FPC 连接器 - - 通过 FPC 电缆连接主板和 3.2" LCD 扩展板（例如 ESP-LyraP-LCD32） - - -应用程序开发 ------------- - -ESP32-S2-Kaluga-1 上电前，请首先确认开发板完好无损。 - - -硬件准备 -^^^^^^^^ - -- ESP32-S2-Kaluga-1 -- 两根 USB 2.0 电缆（标准 A 转 Micro-B) - - - 电源选项 - - 用于 UART/JTAG 通信 - -- PC（Windows、Linux 或 macOS） -- 您选择的任何扩展板 - - -硬件设置 -^^^^^^^^ - -1. 连接您选择的扩展板（更多信息，请见对应拓展板的用户指南) -2. 插入两根 USB 电缆 -3. 打开 **电源开关** 时，**Power On LED** 应点亮。 - - -.. _user-guide-esp32-s2-kaluga-1-kit-software-setup: - -软件设置 -^^^^^^^^ - -请前往 :doc:`../../get-started/index`，在 :ref:`get-started-step-by-step` 一节查看如何快速设置开发环境。 - -您还可以点击 `这里 `_，获取有关 ESP32-S2-Kaluga-1 套件编程指南与应用示例的更多内容。 - - -内容和包装 ----------- - -零售订单 -^^^^^^^^ - -每一个零售 ESP32-S2-Kaluga-1 开发套件均有独立包装，内含以下部分： - -- 主板 - - ESP32-S2-Kaluga-1 -- 扩展板： - - ESP-LyraT-8311A - - ESP-LyraP-CAM - - ESP-LyraP-TouchA - - ESP-LyraP-LCD32 -- 连接器 - - 20 针 FPC 电缆（用于连接 ESP32-S2-Kaluga-1 主板至 ESP-LyraP-TouchA 拓展板) -- 紧固件 - - 安装螺栓 (x 8) - - 螺丝 (x 4) - - 螺母 (x 4) - -零售购买，请前往 https://www.espressif.com/zh-hans/company/contact/buy-a-sample。 - - -批发订单 -^^^^^^^^ - -ESP32-S2-Kaluga-1 开发套件的批发包装为纸板箱。 - -批量订货，请参考 `乐鑫产品订购信息 `_ (PDF)。 - - -硬件参考 -======== - - -功能框图 --------- - -ESP32-S2-Kaluga-1 的主要组件和连接方式如下图所示。 - -.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-s2-kaluga-1-v1.2-block-diagram.png - :align: center - :alt: ESP32-S2-Kaluga-1 框图 - :figclass: align-center - - ESP32-S2-Kaluga-1 框图 - - -电源选项 --------- - -开发板可任一选用以下四种供电方式： - -- Micro USB 端口供电（默认） -- 通过 2 针 *BAT* 连接器连接至外接电池 -- 5V / GND 管脚供电 -- 3V3 / GND 管脚供电 - - -硬件修订历史 -============ - -尚无版本升级历史。 - - -相关文档 -======== .. toctree:: :hidden: - user-guide-esp-lyrap-cam-v1.0 - user-guide-esp-lyrap-lcd32-v1.1 - user-guide-esp-lyrap-toucha-v1.1 - user-guide-esp-lyrat-8311a_v1.2 - -- `ESP32-S2-WROVER 技术规格书 `_ (PDF) -- `乐鑫产品订购信息 `_ (PDF) - -- `ESP32-S2-Kaluga-1 原理图 `_ (PDF) -- `ESP32-S2-Kaluga-1 PCB 布局图 `_ (PDF) -- `ESP32-S2-Kaluga-1 管脚映射表 `_ (Excel) - -有关本开发板的更多设计文档，请联系我们的商务部门 sales@espressif.com。 - + user-guide-esp32-s2-kaluga-1-kit-v1.2.rst + user-guide-esp-lyrap-cam-v1.1 + user-guide-esp-lyrap-lcd32-v1.2 + user-guide-esp-lyrat-8311a_v1.3 \ No newline at end of file