Small updates of documentation

diff --git a/docs/api-guides/jtag-debugging/configure-wrover.rst b/docs/api-guides/jtag-debugging/configure-wrover.rst
index 1857e7f59ebd78a928d9d73bb212e64104c754b6..6b1d40cf567b148cac5a410328aaf2f38c6a8f93 100644 (file)
--- a/docs/api-guides/jtag-debugging/configure-wrover.rst
+++ b/docs/api-guides/jtag-debugging/configure-wrover.rst
@@ -7,7 +7,7 @@ All versions of ESP32 WROVER KIT boards have JTAG functionality build in. Puttin
 Configure Hardware
 ^^^^^^^^^^^^^^^^^^
 
-1.  Enable on-board JTAG functionality by setting JP8 according to :doc:`../../get-started/get-started-wrover-kit`, section :ref:`esp-wrover-kit-setup-options`. 
+1.  Enable on-board JTAG functionality by setting JP8 according to :doc:`../../get-started/get-started-wrover-kit`, section :ref:`get-started-esp-wrover-kit-setup-options`. 
 
 2.  Verify if ESP32 pins used for JTAG communication are not connected to some other h/w that may disturb JTAG operation:
 

diff --git a/docs/api-reference/peripherals/uart.rst b/docs/api-reference/peripherals/uart.rst
index 4f5cdc78625bdc9e6d5d3fd23241ebd3190d1e20..da75b08432bd8a1a3001f595618b7d64e35adc12 100644 (file)
--- a/docs/api-reference/peripherals/uart.rst
+++ b/docs/api-reference/peripherals/uart.rst
@@ -138,7 +138,9 @@ Application Examples
 
 Configure UART settings and install UART driver to read/write using UART1 interface: :example:`peripherals/uart_echo`.
 
-Demonstration how report report various communication events and how to use patern detection interrupts: :example:`peripherals/uart_events`.
+Demonstration of how to report various communication events and how to use patern detection interrupts: :example:`peripherals/uart_events`.
+
+Transmitting and receiveing with the same UART in two separate FreeRTOS tasks: :example:`peripherals/uart_async_rxtxtasks`.
 
 
 API Reference

diff --git a/docs/get-started/get-started-devkitc.rst b/docs/get-started/get-started-devkitc.rst
index 94c79c2ea0749c530e069e153a6cf90c7dd52649..b5f14ab10e03b3a93ffda96ad8f40744429cd341 100644 (file)
--- a/docs/get-started/get-started-devkitc.rst
+++ b/docs/get-started/get-started-devkitc.rst
@@ -7,7 +7,7 @@ This user guide shows how to get started with ESP32-DevKitC development board.
 What You Need\r
 -------------\r
 \r
-* 1 × ESP32-DevKitC board\r
+* 1 × :ref:`ESP32-DevKitC board <get-started-esp32-devkitc-board-front>`\r
 * 1 × USB A / micro USB B cable \r
 * 1 × PC loaded with Windows, Linux or Mac OS\r
 \r
@@ -34,6 +34,8 @@ USB
 I/O\r
     Most of the pins on the ESP-WROOM-32 are broken out to the pin headers on the board. Users can program ESP32 to enable multiple functions such as PWM,ADC, DAC, I2C, I2S, SPI, etc.\r
 \r
+.. _get-started-esp32-devkitc-board-front:\r
+\r
 .. figure:: ../_static/esp32-devkitc-functional-overview.png\r
     :align: center\r
     :alt: ESP32-DevKitC board layout\r
@@ -42,6 +44,20 @@ I/O
     ESP32-DevKitC board layout\r
 \r
 \r
+Power Supply Options\r
+--------------------\r
+\r
+There following options are available to provide power supply to the ESP32-PICO-KIT V4:\r
+\r
+1. Micro USB port, this is default power supply connection\r
+2. 5V / GND header pins\r
+3. 3V3 / GND header pins\r
+\r
+.. warning::\r
+\r
+    Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.\r
+\r
+\r
 Start Application Development\r
 ------------------------------\r
 \r

diff --git a/docs/get-started/get-started-pico-kit.rst b/docs/get-started/get-started-pico-kit.rst
index 1ae2bd2fb69bde5ecd667dc6e4977e4ccdc142fb..44134e72b3dc50d34cf3d50ab0600a9046b6cdd0 100644 (file)
--- a/docs/get-started/get-started-pico-kit.rst
+++ b/docs/get-started/get-started-pico-kit.rst
@@ -7,7 +7,7 @@ This user guide shows how to get started with the ESP32-PICO-KIT V4 mini develop
 What You Need\r
 -------------\r
 \r
-* 1 × ESP32-PICO-KIT V4 mini development board\r
+* 1 × :ref:`ESP32-PICO-KIT V4 mini development board <get-started-pico-kit-v4-board-front>`\r
 * 1 × USB A / Micro USB B cable\r
 * 1 × PC loaded with Windows, Linux or Mac OS\r
 \r
@@ -40,6 +40,8 @@ EN Button
 BOOT Button\r
     Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.\r
 \r
+.. _get-started-pico-kit-v4-board-front:\r
+\r
 .. figure:: ../_static/esp32-pico-kit-v4-layout.jpg\r
     :align: center\r
     :alt: ESP32-PICO-KIT V4 board layout\r
@@ -48,6 +50,20 @@ BOOT Button
     ESP32-PICO-KIT V4 board layout\r
 \r
 \r
+Power Supply Options\r
+--------------------\r
+\r
+There following options are available to provide power supply to the ESP32-PICO-KIT V4:\r
+\r
+1. Micro USB port, this is default power supply connection\r
+2. 5V / GND header pins\r
+3. 3V3 / GND header pins\r
+\r
+.. warning::\r
+\r
+    Above options are mutually exclusive, i.e. the power supply may be provided using only one of the above options. Attempt to power the board using more than one connection at a time may damage the board and/or the power supply source.\r
+\r
+\r
 Start Application Development\r
 ------------------------------\r
 \r

diff --git a/docs/get-started/get-started-wrover-kit.rst b/docs/get-started/get-started-wrover-kit.rst
index 89effa95d2c5c7d5bf2a6aa6a34747cdf14fd319..25948fc2790c165b4a0e47fb16ac4ad411fcef16 100644 (file)
--- a/docs/get-started/get-started-wrover-kit.rst
+++ b/docs/get-started/get-started-wrover-kit.rst
@@ -3,13 +3,13 @@ ESP-WROVER-KIT V3 Getting Started Guide
 \r
 This user guide shows how to get started with ESP-WROVER-KIT V3 development board including description of its functionality and configuration options. For description of other versions of the ESP-WROVER-KIT check :doc:`../hw-reference/index`.\r
 \r
-If you like to start using this board right now, go directly to section :ref:`esp-wrover-kit-start-development`.\r
+If you like to start using this board right now, go directly to section :ref:`get-started-esp-wrover-kit-start-development`.\r
 \r
 \r
 What You Need\r
 -------------\r
 \r
-* 1 × ESP-WROVER-KIT V3 board\r
+* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-board-front>`\r
 * 1 x Micro USB 2.0 Cable, Type A to Micro B\r
 * 1 × PC loaded with Windows, Linux or Mac OS\r
 \r
@@ -70,7 +70,7 @@ Boot
 USB\r
     USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.\r
 Power Select\r
-    Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`esp-wrover-kit-setup-options`, jumper header JP7.\r
+    Power supply selection interface: the ESP-WROVER-KIT can be powered through the USB interface or the 5V Input interface. The user can select the power supply with a jumper. More details can be found in section :ref:`get-started-esp-wrover-kit-setup-options`, jumper header JP7.\r
 Power Key\r
     Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.\r
 5V Input\r
@@ -82,11 +82,13 @@ Camera
 RGB\r
     Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).\r
 I/O\r
-    All the pins on the ESP32 module are led out to the pin headers on the ESPWROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.\r
+    All the pins on the ESP32 module are led out to the pin headers on the ESP-WROVER-KIT. Users can program ESP32 to enable multiple functions such as PWM, ADC, DAC, I2C, I2S, SPI, etc.\r
 Micro SD Card\r
     Micro SD card slot for data storage.\r
 LCD\r
-    ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`esp-wrover-kit-board-back`.\r
+    ESP-WROVER-KIT supports mounting and interfacing a 3.2” SPI (standard 4-wire Serial Peripheral Interface) LCD, as shown on figure :ref:`get-started-esp-wrover-kit-board-back`.\r
+\r
+.. _get-started-esp-wrover-kit-board-front:\r
 \r
 .. figure:: ../_static/esp32-wrover-kit-layout-front.jpg\r
     :align: center\r
@@ -95,7 +97,7 @@ LCD
 \r
     ESP-WROVER-KIT board layout - front\r
 \r
-.. _esp-wrover-kit-board-back:\r
+.. _get-started-esp-wrover-kit-board-back:\r
 \r
 .. figure:: ../_static/esp32-wrover-kit-layout-back.jpg\r
     :align: center\r
@@ -105,7 +107,7 @@ LCD
     ESP-WROVER-KIT board layout - back\r
 \r
 \r
-.. _esp-wrover-kit-setup-options:\r
+.. _get-started-esp-wrover-kit-setup-options:\r
 \r
 Setup Options\r
 ^^^^^^^^^^^^^\r
@@ -116,7 +118,7 @@ There are five jumper headers available to set up the board functionality. Typic
 | Header | Jumper Setting   | Description of Functionality                     |\r
 +--------+------------------+--------------------------------------------------+\r
 |  JP7   | |jp7-ext_5v|     | Power ESP-WROVER-KIT board from an external      |\r
-|        |                  | power supply                                     |\r
+|        |                  | | power supply                                   |\r
 +--------+------------------+--------------------------------------------------+\r
 |  JP7   | |jp7-usb_5v|     | Power ESP-WROVER-KIT board from an USB port      |\r
 +--------+------------------+--------------------------------------------------+\r
@@ -135,59 +137,115 @@ Allocation of ESP32 Pins
 Several pins / terminals of ESP32 module are allocated to the on board hardware. Some of them, like GPIO0 or GPIO2, have multiple functions. If certain hardware is not installed, e.g. nothing is plugged in to the Camera / JP4 header, then selected GPIOs may be used for other purposes.\r
 \r
 \r
+Main I/O Connector / JP1\r
+""""""""""""""""""""""""\r
+\r
+The JP1 connector is shown in two columns in the middle under "I/O" headers. The two columns "Shared With" outside, describe where else on the board certain GPIO is used. \r
+\r
++----------------------+------+------+----------------------+\r
+|          Shared With | I/O  | I/O  | Shared With          |\r
++======================+======+======+======================+\r
+|                      | 3.3V | GND  |                      |\r
++----------------------+------+------+----------------------+\r
+|              NC/XTAL | IO32 | IO33 | NC/XTAL              |\r
++----------------------+------+------+----------------------+\r
+|        JTAG, MicroSD | IO12 | IO13 | JTAG, MicroSD        |\r
++----------------------+------+------+----------------------+\r
+|        JTAG, MicroSD | IO14 | IO27 | Camera               |\r
++----------------------+------+------+----------------------+\r
+|               Camera | IO26 | IO25 | Camera, LCD          |\r
++----------------------+------+------+----------------------+\r
+|               Camera | IO35 | IO34 | Camera               |\r
++----------------------+------+------+----------------------+\r
+|               Camera | IO39 | IO36 | Camera               |\r
++----------------------+------+------+----------------------+\r
+|                 JTAG | EN   | IO23 | Camera, LCD          |\r
++----------------------+------+------+----------------------+\r
+|          Camera, LCD | IO22 | IO21 | Camera, LCD, MicroSD |\r
++----------------------+------+------+----------------------+\r
+|          Camera, LCD | IO19 | IO18 | Camera, LCD          |\r
++----------------------+------+------+----------------------+\r
+|          Camera, LCD | IO5  | IO17 | PSRAM                |\r
++----------------------+------+------+----------------------+\r
+|                PSRAM | IO16 | IO4  | LED, Camera, MicroSD |\r
++----------------------+------+------+----------------------+\r
+|            LED, Boot | IO0  | IO2  | LED, Camera, MicroSD |\r
++----------------------+------+------+----------------------+\r
+|        JTAG, MicroSD | IO15 | 5V   |                      |\r
++----------------------+------+------+----------------------+\r
+\r
+Legend:\r
+\r
+* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-xtal>`\r
+* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-jtag-header>`\r
+* Boot - Boot button / SW2\r
+* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-camera-header>`\r
+* LED - :ref:`RGB LED <get-started-esp-wrover-rgb-led-connections>`\r
+* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-microsd-card-slot>`\r
+* LCD - :ref:`LCD / U5 <get-started-esp-wrover-lcd-connector>`\r
+* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed\r
+\r
+\r
+.. _get-started-esp-wrover-kit-xtal:\r
+\r
 32.768 kHz Oscillator\r
 """""""""""""""""""""\r
 \r
-+---+---------------+\r
-|   | ESP32 Pin     |\r
-+===+===============+\r
-| 1 | GPIO32        |\r
-+---+---------------+\r
-| 2 | GPIO33        |\r
-+---+---------------+\r
++---+-----------+\r
+|   | ESP32 Pin |\r
++===+===========+\r
+| 1 | GPIO32    |\r
++---+-----------+\r
+| 2 | GPIO33    |\r
++---+-----------+\r
 \r
 .. note::\r
 \r
     As GPIO32 and GPIO33 are connected to the oscillator, to maintain signal integrity, they are not connected to JP1 I/O expansion connector. This allocation may be changed from oscillator to JP1 by desoldering 0R resistors from positions R11 / R23 and installing them in positions R12 / R24.\r
 \r
 \r
+.. _get-started-esp-wrover-spi-flash-header:\r
+\r
 SPI Flash / JP13\r
 """"""""""""""""\r
 \r
-+---+---------------+\r
-|   | ESP32 Pin     |\r
-+===+===============+\r
-| 1 | CLK / GPIO6   |\r
-+---+---------------+\r
-| 2 | SD0 / GPIO7   |\r
-+---+---------------+\r
-| 3 | SD1 / GPIO8   |\r
-+---+---------------+\r
-| 4 | SD2 / GPIO9   |\r
-+---+---------------+\r
-| 5 | SD3 / GPIO10  |\r
-+---+---------------+\r
-| 6 | CMD / GPIO11  |\r
-+---+---------------+\r
-\r
++---+--------------+\r
+|   | ESP32 Pin    |\r
++===+==============+\r
+| 1 | CLK / GPIO6  |\r
++---+--------------+\r
+| 2 | SD0 / GPIO7  |\r
++---+--------------+\r
+| 3 | SD1 / GPIO8  |\r
++---+--------------+\r
+| 4 | SD2 / GPIO9  |\r
++---+--------------+\r
+| 5 | SD3 / GPIO10 |\r
++---+--------------+\r
+| 6 | CMD / GPIO11 |\r
++---+--------------+\r
+\r
+.. _get-started-esp-wrover-jtag-header:\r
 \r
 JTAG / JP8\r
 """"""""""\r
 \r
-+---+---------------+----------------+\r
-|   | ESP32 Pin     | JTAG Signal    |\r
-+===+===============+================+\r
-| 1 | CHIP_PU       | TRST_N         |\r
-+---+---------------+----------------+\r
-| 2 | MTDO / GPIO15 | TDO            |\r
-+---+---------------+----------------+\r
-| 3 | MTDI / GPIO12 | TDI            |\r
-+---+---------------+----------------+\r
-| 4 | MTCK / GPIO13 | TCK            |\r
-+---+---------------+----------------+\r
-| 5 | MTMS / GPIO14 | TMS            |\r
-+---+---------------+----------------+\r
++---+---------------+-------------+\r
+|   | ESP32 Pin     | JTAG Signal |\r
++===+===============+=============+\r
+| 1 | EN            | TRST_N      |\r
++---+---------------+-------------+\r
+| 2 | MTDO / GPIO15 | TDO         |\r
++---+---------------+-------------+\r
+| 3 | MTDI / GPIO12 | TDI         |\r
++---+---------------+-------------+\r
+| 4 | MTCK / GPIO13 | TCK         |\r
++---+---------------+-------------+\r
+| 5 | MTMS / GPIO14 | TMS         |\r
++---+---------------+-------------+\r
+\r
 \r
+.. _get-started-esp-wrover-camera-header:\r
 \r
 Camera / JP4\r
 """"""""""""\r
@@ -227,19 +285,23 @@ Camera / JP4
 +----+--------------+----------------------+\r
 \r
 \r
+.. _get-started-esp-wrover-rgb-led-connections:\r
+\r
 RGB LED\r
 """""""\r
 \r
-+---+---------------+----------------+\r
-|   | ESP32 Pin     | RGB LED        |\r
-+===+===============+================+\r
-| 1 | GPIO0         | Red            |\r
-+---+---------------+----------------+\r
-| 2 | GPIO2         | Blue           |\r
-+---+---------------+----------------+\r
-| 3 | GPIO4         | Green          |\r
-+---+---------------+----------------+\r
++---+-----------+---------+\r
+|   | ESP32 Pin | RGB LED |\r
++===+===========+=========+\r
+| 1 | GPIO0     | Red     |\r
++---+-----------+---------+\r
+| 2 | GPIO2     | Blue    |\r
++---+-----------+---------+\r
+| 3 | GPIO4     | Green   |\r
++---+-----------+---------+\r
+\r
 \r
+.. _get-started-esp-wrover-microsd-card-slot:\r
 \r
 MicroSD Card / J4\r
 """""""""""""""""\r
@@ -263,30 +325,31 @@ MicroSD Card / J4
 +---+---------------+----------------+\r
 \r
 \r
+.. _get-started-esp-wrover-lcd-connector:\r
 \r
 LCD / U5\r
 """"""""\r
 \r
-+---+---------------+----------------+\r
-|   | ESP32 Pin     | LCD Signal     |\r
-+===+===============+================+\r
-| 1 | GPIO18        | RESET          |\r
-+---+---------------+----------------+\r
-| 2 | GPIO19        | SCL            |\r
-+---+---------------+----------------+\r
-| 3 | GPIO21        | D/C            |\r
-+---+---------------+----------------+\r
-| 4 | GPIO22        | CS             |\r
-+---+---------------+----------------+\r
-| 5 | GPIO23        | SDA            |\r
-+---+---------------+----------------+\r
-| 6 | GPIO25        | SDO            |\r
-+---+---------------+----------------+\r
-| 7 | GPIO5         | Backlight      |\r
-+---+---------------+----------------+\r
-\r
-\r
-.. _esp-wrover-kit-start-development:\r
++---+-----------+------------+\r
+|   | ESP32 Pin | LCD Signal |\r
++===+===========+============+\r
+| 1 | GPIO18    | RESET      |\r
++---+-----------+------------+\r
+| 2 | GPIO19    | SCL        |\r
++---+-----------+------------+\r
+| 3 | GPIO21    | D/C        |\r
++---+-----------+------------+\r
+| 4 | GPIO22    | CS         |\r
++---+-----------+------------+\r
+| 5 | GPIO23    | SDA        |\r
++---+-----------+------------+\r
+| 6 | GPIO25    | SDO        |\r
++---+-----------+------------+\r
+| 7 | GPIO5     | Backlight  |\r
++---+-----------+------------+\r
+\r
+\r
+.. _get-started-esp-wrover-kit-start-development:\r
 \r
 Start Application Development\r
 -----------------------------\r

diff --git a/docs/hw-reference/index.rst b/docs/hw-reference/index.rst
index dad6fefc3276a12d4659888873be8316223b6277..4fcb91e24abffe11229dfb702e154ebd9d0d3f1a 100644 (file)
--- a/docs/hw-reference/index.rst
+++ b/docs/hw-reference/index.rst
@@ -11,3 +11,4 @@ ESP32 Hardware Reference
    Silicon Errata (PDF) <https://espressif.com/sites/default/files/documentation/eco_and_workarounds_for_bugs_in_esp32_en.pdf>
    Modules and Boards <modules-and-boards>
    Previous Versions of Modules and Boards <modules-and-boards-previous>
+   Espressif Products Ordering Information (PDF) <http://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>

diff --git a/docs/hw-reference/modules-and-boards.rst b/docs/hw-reference/modules-and-boards.rst
index 4143e68650a930009135a915c2e53b2be2c74083..2bd85e89a7794c98f6ec9e8798be654d5452b041 100644 (file)
--- a/docs/hw-reference/modules-and-boards.rst
+++ b/docs/hw-reference/modules-and-boards.rst
@@ -89,7 +89,7 @@ ESP32 Core Board V2 / ESP32 DevKitC
 
 Small and convenient development board with ESP-WROOM-32 module installed, break out pin headers and minimum additional components. Includes USB to serial programming interface, that also provides power supply for the board. Has press buttons to reset the board and put it in upload mode. 
 
-.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.jpg
+.. figure:: https://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.png
     :align: center
     :alt: ESP32 Core Board V2 / ESP32 DevKitC board
     :width: 50%