-
Notifications
You must be signed in to change notification settings - Fork 7.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'doc/hw-reference/esp32-s2/kaluga-kit' into 'master'
Add user guides for ESP32-S2-Kaluga-1-Kit See merge request espressif/esp-idf!8668
- Loading branch information
Showing
12 changed files
with
795 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
113 changes: 113 additions & 0 deletions
113
docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-cam-v1.0.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
============= | ||
ESP-LyraP-CAM | ||
============= | ||
|
||
: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. | ||
|
||
The ESP-LyraP-CAM extends the functionality of your main board by adding a camera. | ||
|
||
.. 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.0-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 (however, support for OV3660 is not yet implemented in software); 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. | ||
|
||
.. 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 | ||
========================= | ||
|
||
No previous versions available. | ||
|
||
|
||
Related Documents | ||
================= | ||
|
||
- `ESP-LyraP-CAM Schematic <https://dl.espressif.com/dl/schematics/ESP-LyraP-CAM_V1.0_SCH_20200302.pdf>`_ (PDF) | ||
- `ESP-LyraP-CAM PCB Layout <https://dl.espressif.com/dl/schematics/ESP-LyraP-CAM_V1.0_PCB_20200302.pdf>`_ (PDF) | ||
|
||
For other design documentation for the board, please contact us at sales@espressif.com. |
124 changes: 124 additions & 0 deletions
124
docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-lcd32-v1.1.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
=============== | ||
ESP-LyraP-LCD32 | ||
=============== | ||
|
||
: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. | ||
|
||
The ESP-LyraP-LCD32 extends the functionality of your main board by adding an LCD graphic display. | ||
|
||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-lcd32-v1.1-3d.png | ||
:align: center | ||
:scale: 90% | ||
: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.1-layout-front.png | ||
:align: center | ||
:scale: 90% | ||
:alt: ESP-LyraP-LCD32 - front | ||
:figclass: align-center | ||
|
||
ESP-LyraP-LCD32 - front (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 | ||
* - 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.1-block-diagram.png | ||
:align: center | ||
:alt: ESP-LyraP-LCD32 block diagram | ||
:figclass: align-center | ||
|
||
ESP-LyraP-LCD32 block diagram | ||
|
||
|
||
Hardware Revision Details | ||
========================= | ||
|
||
No previous versions available. | ||
|
||
|
||
Related Documents | ||
================= | ||
|
||
- `ESP-LyraP-LCD32 Schematic <https://dl.espressif.com/dl/schematics/ESP-LyraP-LCD32_V1_1_SCH_20200324A.pdf>`_ (PDF) | ||
- `ESP-LyraP-LCD32 PCB Layout <https://dl.espressif.com/dl/schematics/ESP-LyraP-LCD32_V1_1_PCB_20200324AC.pdf>`_ (PDF) | ||
|
||
For other design documentation for the board, please contact us at sales@espressif.com. |
112 changes: 112 additions & 0 deletions
112
docs/en/hw-reference/esp32s2/user-guide-esp-lyrap-toucha-v1.1.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
================ | ||
ESP-LyraP-TouchA | ||
================ | ||
|
||
: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. | ||
|
||
The ESP-LyraP-TouchA extends the functionality of your main board by adding touch buttons. | ||
|
||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-toucha-v1.1-3d.png | ||
:align: center | ||
:alt: ESP-LyraP-TouchA | ||
:figclass: align-center | ||
|
||
ESP-LyraP-TouchA | ||
|
||
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-LyraP-TouchA's hardware. | ||
- `Hardware Revision Details`_: Covers revision history, known issues, and links to user guides for previous versions of the ESP-LyraP-TouchA. | ||
- `Related Documents`_: Gives links to related documentation. | ||
|
||
|
||
Overview | ||
======== | ||
|
||
The ESP-LyraP-TouchA has six touch buttons and is mainly designed for audio applications. However, the touch buttons can also be used for any other purposes. | ||
|
||
|
||
Description of Components | ||
------------------------- | ||
|
||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-toucha-v1.1-layout-front.png | ||
:align: center | ||
:alt: ESP-LyraP-TouchA | ||
:figclass: align-center | ||
|
||
ESP-LyraP-TouchA | ||
|
||
.. list-table:: | ||
:widths: 30 70 | ||
:header-rows: 1 | ||
|
||
* - Key Component | ||
- Description | ||
* - Main Board Touch FPC Connector | ||
- Connect to main board's Touch FPC Connector. | ||
* - Touchpad | ||
- Capacitive touch electrode. | ||
* - Guard Ring | ||
- Connected to a touch sensor, the guard ring triggers an interrupt if wet (Water rejection). It indicates that the sensor array is also wet and most (if not all) touchpads are unusable due to the false detection of touches. After receiving this interrupt, the user might consider disabling all the touch sensors via software. | ||
|
||
|
||
Start Application Development | ||
----------------------------- | ||
|
||
Before powering up your ESP-LyraP-TouchA, please make sure that it is in good condition with no obvious signs of damage. | ||
|
||
|
||
Required Hardware | ||
^^^^^^^^^^^^^^^^^ | ||
|
||
- Board with a Touch FPC connector (e.g., ESP32-S2-Kaluga-1) | ||
- ESP-LyraP-TouchA extension board | ||
- FPC cable | ||
- Computer running Windows, Linux, or macOS | ||
|
||
|
||
Hardware Setup | ||
^^^^^^^^^^^^^^ | ||
|
||
Connect the two FPC connectors with the FPC cable. | ||
|
||
|
||
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 ESP-LyraP-TouchA and their interconnections. | ||
|
||
.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp-lyrap-toucha-v1.1-block-diagram.png | ||
:align: center | ||
:alt: ESP-LyraP-TouchA-v1.1 block diagram | ||
:figclass: align-center | ||
|
||
ESP-LyraP-TouchA-v1.1 block diagram | ||
|
||
|
||
Hardware Revision Details | ||
========================= | ||
|
||
No previous versions available. | ||
|
||
|
||
Related Documents | ||
================= | ||
|
||
- `ESP-LyraP-TouchA Schematic <https://dl.espressif.com/dl/schematics/ESP-LyraP-TouchA_V1.1_SCH_20200325A.pdf>`_ (PDF) | ||
- `ESP-LyraP-TouchA PCB Layout <https://dl.espressif.com/dl/schematics/ESP-LyraP-TouchA_V1.1_PCB_20200325AA.pdf>`_ (PDF) | ||
|
||
For other design documentation for the board, please contact us at sales@espressif.com. |
Oops, something went wrong.