alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update redirected links

Browse Source
This commit is contained in:
Marius Vikhammer
2022-04-28 14:34:20 +08:00
parent d7053c38cc
commit 030cb77597
73 changed files with 397 additions and 398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/en/hw-reference/esp32s2/user-guide-devkitm-1-v1.rst
View File

@@ -11,9 +11,9 @@ ESP32-S2-DevKitM-1(U) is a general-purpose development board based on `ESP32-S2F
ESP32-S2-DevKitM-1 is embedded with `ESP32-S2-MINI-1 <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`__ module (on-board PCB antenna), while ESP32-S2-DevKitM-1U with `ESP32-S2-MINI-1U <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`__ module (external antenna connector).
+----------------------+-----------------------+
| |ESP32-S2-DevKitM-1| | |ESP32-S2-DevKitM-1U| |
| |ESP32-S2-DevKitM-1| | |ESP32-S2-DevKitM-1U| |
+----------------------+-----------------------+
| ESP32-S2-DevKitM-1 | ESP32-S2-DevKitM-1U |
| ESP32-S2-DevKitM-1 | ESP32-S2-DevKitM-1U |
+----------------------+-----------------------+
.. |ESP32-S2-DevKitM-1| image:: ../../../_static/esp32-s2-devkitm-1-v1-isometric.png
@@ -35,7 +35,7 @@ This section describes how to get started with ESP32-S2-DevKitM-1(U). It begins
Overview
--------
ESP32-S2-DevKitM-1(U) is entry-level development board equipped with either ESP32-S2-MINI-1 or ESP32-S2-MINI-1U module. Most of the I/O pins on the module are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-DevKitM-1(U) on a breadboard.
ESP32-S2-DevKitM-1(U) is entry-level development board equipped with either ESP32-S2-MINI-1 or ESP32-S2-MINI-1U module. Most of the I/O pins on the module are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-DevKitM-1(U) on a breadboard.
Contents and Packaging
----------------------
@@ -45,7 +45,7 @@ Retail orders
If you order a few samples, each ESP32-S2-DevKitM-1(U) comes in an individual package in either antistatic bag or any packaging depending on your retailer.
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
Wholesale Orders
@@ -74,7 +74,7 @@ Description of Components
ESP32-S2-DevKitM-1U - front
The key components of the board are described in a clockwise direction.
The key components of the board are described in a clockwise direction.
.. list-table::
:widths: 30 70
@@ -101,7 +101,7 @@ The key components of the board are described in a clockwise direction.
* - 5 V to 3.3 V LDO
- Power regulator that converts a 5 V supply into a 3.3 V output.
* - External Antenna Connector
- On **ESP32-S2-MINI-1U** module only. For connector dimensions, please refer to Section External Antenna Connector Dimensions in `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_.
- On **ESP32-S2-MINI-1U** module only. For connector dimensions, please refer to Section External Antenna Connector Dimensions in `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_.
Start Application Development
-----------------------------
@@ -114,7 +114,7 @@ Required Hardware
- ESP32-S2-DevKitM-1(U)
+ For ESP32-S2-DevKitM-1U, an antenna is also required.
- USB 2.0 cable (Standard-A to Micro-B)
- Computer running Windows, Linux, or macOS
@@ -128,7 +128,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 and then flash an application example into your ESP32-S2-DevKitM-1(U).
.. note::
ESP32-S2 series of chips only is only supported in ESP-IDF master or version v4.2 and higher.
Hardware Reference
@@ -168,7 +168,7 @@ The two tables below provide the **Name** and **Function** of the pin headers on
J1
^^^
=== ==== ========== =============================================================
No. Name Type [#]_ Function
No. Name Type [#]_ Function
=== ==== ========== =============================================================
1 3V3 P 3.3 V power supply
2 0 I/O/T RTC_GPIO0, GPIO0
@@ -221,7 +221,7 @@ No. Name Type Function
21 18 I/O/T RTC_GPIO18, GPIO18, U1RXD, ADC2_CH7, DAC_2, CLK_OUT3, RGB LED
=== ==== ===== ========================================================
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
Pin Layout
^^^^^^^^^^^
@@ -232,7 +232,7 @@ Pin Layout
:figclass: align-center
ESP32-S2-DevKitM-1(U) Pin Layout (click to enlarge)
Hardware Revision Details
=========================
@@ -245,6 +245,6 @@ Related Documents
* `ESP32-S2-DevKitM-1(U) Dimensions <https://dl.espressif.com/dl/schematics/ESP32-S2-DevKitM-1_V1_Dimensions.pdf>`_ (PDF)
* `ESP32-S2 Series Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_ (PDF)
* `ESP32-S2-MINI-1 & ESP32-S2-MINI-1U Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-mini-1_esp32-s2-mini-1u_datasheet_en.pdf>`_ (PDF)
* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
* `ESP Product Selector <https://products.espressif.com/#/product-selector?names=>`_
For other design documentation for the board, please contact us at `sales@espressif.com <sales@espressif.com>`_.

6
docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit-v1.2.rst
View File

@@ -114,7 +114,7 @@ Description of Components
:scale: 70%
:alt: ESP32-S2-Kaluga-1 - front
:figclass: align-center
ESP32-S2-Kaluga-1 - front (click to enlarge)
@@ -236,7 +236,7 @@ If you order one or several samples of the kit, each ESP32-S2-Kaluga-1 developme
- Screws (x4)
- Nuts (x4)
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
Wholesale Orders
@@ -296,7 +296,7 @@ If you want to use more than one extension board at the same time, please check
- 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.
- 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

3
docs/en/hw-reference/esp32s2/user-guide-esp32-s2-kaluga-1-kit.rst
View File

@@ -257,7 +257,7 @@ The contents are as follows:
- Screws (x4)
- Nuts (x4)
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
Wholesale Orders
@@ -393,4 +393,3 @@ Related Documents
For other design documentation for the board, please contact us at sales@espressif.com.

42
docs/en/hw-reference/esp32s2/user-guide-s2-devkitc-1.rst
View File

@@ -41,7 +41,7 @@ Description of Components
ESP32-S2-DevKitC-1 - front
The key components of the board are described in a clockwise direction.
The key components of the board are described in a clockwise direction.
.. list-table::
:widths: 30 70
@@ -54,7 +54,7 @@ The key components of the board are described in a clockwise direction.
* - 3.3 V Power On LED
- Turns on when the USB power is connected to the board.
* - USB-to-UART Bridge
- Single USB-to-UART bridge chip provides transfer rates up to 3 Mbps.
- Single USB-to-UART bridge chip provides transfer rates up to 3 Mbps.
* - Pin Headers
- All available GPIO pins (except for the SPI bus for flash) are broken out to the pin headers on the board. For details, please see :ref:`user-guide-s2-devkitc-1-v1-header-blocks`.
* - ESP32-S2 USB Port
@@ -64,7 +64,7 @@ The key components of the board are described in a clockwise direction.
* - Boot Button
- Download button. Holding down **Boot** and then pressing **Reset** initiates Firmware Download mode for downloading firmware through the serial port.
* - USB-to-UART Port
- A Micro-USB port used for power supply to the board, for flashing applications to the chip, as well as the communication with the chip via the on-board USB-to-UART bridge.
- A Micro-USB port used for power supply to the board, for flashing applications to the chip, as well as the communication with the chip via the on-board USB-to-UART bridge.
* - RGB LED
- Addressable RGB LED, driven by GPIO18.
* - 5 V to 3.3 V LDO
@@ -105,7 +105,7 @@ Retail orders
If you order a few samples, each ESP32-S2-DevKitC-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
Wholesale Orders
^^^^^^^^^^^^^^^^
@@ -141,15 +141,15 @@ There are three mutually exclusive ways to provide power to the board:
.. _user-guide-s2-devkitc-1-v1-header-blocks:
Header Block
-------------
The two tables below provide the **Name** and **Function** of the pin headers on both sides of the board (J1 and J3). The pin header names are shown in :ref:`user-guide-s2-devkitc-1-v1-board-front`. The numbering is the same as in the `ESP32-S2-DevKitC-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-S2-DEVKITC-1_V1_20210508.pdf>`_ (PDF).
Header Block
-------------
J1
^^^
The two tables below provide the **Name** and **Function** of the pin headers on both sides of the board (J1 and J3). The pin header names are shown in :ref:`user-guide-s2-devkitc-1-v1-board-front`. The numbering is the same as in the `ESP32-S2-DevKitC-1 Schematic <https://dl.espressif.com/dl/schematics/SCH_ESP32-S2-DEVKITC-1_V1_20210508.pdf>`_ (PDF).
J1
^^^
=== ==== ========== ==========================================================================
No. Name Type [#]_ Function
No. Name Type [#]_ Function
=== ==== ========== ==========================================================================
1 3V3 P 3.3 V power supply
2 3V3 P 3.3 V power supply
@@ -173,13 +173,13 @@ No. Name Type [#]_ Function
20 14 I/O/T RTC_GPIO14, GPIO14, TOUCH14, ADC2_CH3, FSPIWP, FSPIDQS
21 5V P 5 V power supply
22 G G Ground
=== ==== ========== ==========================================================================
J3
^^^
=== ==== ===== ============================================================
No. Name Type Function
=== ==== ========== ==========================================================================
J3
^^^
=== ==== ===== ============================================================
No. Name Type Function
=== ==== ===== ============================================================
1 G G Ground
2 TX I/O/T U0TXD, GPIO43, CLK_OUT1
@@ -204,8 +204,8 @@ No. Name Type Function
21 G G Ground
22 G G Ground
=== ==== ===== ============================================================
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
Pin Layout
^^^^^^^^^^^
@@ -216,7 +216,7 @@ Pin Layout
:figclass: align-center
ESP32-S2-DevKitC-1 Pin Layout (click to enlarge)
Hardware Revision Details
=========================

10
docs/en/hw-reference/esp32s2/user-guide-saola-1-v1.2.rst
View File

@@ -47,7 +47,7 @@ Retail orders
If you order a few samples, each ESP32-S2-Saola-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
For retail orders, please go to https://www.espressif.com/en/contact-us/get-samples.
Wholesale Orders
^^^^^^^^^^^^^^^^
@@ -68,7 +68,7 @@ Description of Components
ESP32-S2-Saola-1 - front
The key components of the board are described in a clockwise direction.
The key components of the board are described in a clockwise direction.
.. list-table::
:widths: 30 70
@@ -115,7 +115,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 and then flash an application example into your ESP32-S2-Saola-1.
.. note::
ESP32-S2 series of chips only supports ESP-IDF master or version v4.2 and higher.
Hardware Reference
@@ -153,7 +153,7 @@ The two tables below provide the **Name** and **Function** of the pin headers on
J2
^^^
=== ==== ========== ======================================
No. Name Type [#]_ Function
No. Name Type [#]_ Function
=== ==== ========== ======================================
1 3V3 P 3.3 V power supply
2 IO0 I/O GPIO0, Boot
@@ -206,7 +206,7 @@ No. Name Type Function
21 IO18 I/O GPIO18, ADC2_CH7, DAC_2, RGB LED
=== ==== ===== ====================================
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
.. [#] P: Power supply; I: Input; O: Output; T: High impedance.
Pin Layout
^^^^^^^^^^^