]> granicus.if.org Git - esp-idf/commitdiff
docs: Included information about ESP32-WROVER module
authorkrzychb <krzychb@gazeta.pl>
Fri, 11 Aug 2017 20:59:34 +0000 (22:59 +0200)
committerkrzychb <krzychb@gazeta.pl>
Tue, 22 Aug 2017 18:08:04 +0000 (20:08 +0200)
docs/hw-reference/modules-and-boards.rst
docs/requirements.txt

index 33631269f4c8c384daa236e57029ea41e6fb2c92..fc1dfd540155e69691f92e65a992aa874e486b00 100644 (file)
@@ -1,3 +1,5 @@
+.. _esp-modules-and-boards:
+
 ESP32 Modules and Boards
 ========================
 
@@ -6,30 +8,56 @@ Espressif designed and manufactured several development modules and boards to he
 For details please refer to documentation below, provided together with description of particular boards.
 
 
+.. _esp-modules-and-boards-esp-wroom-32:
+
 ESP-WROOM-32
 ------------
 
 The smallest module intended for installation in final products. Can be also used for evaluation after adding extra components like programming interface, boot strapping resistors and break out headers.
 
-.. image:: http://dl.espressif.com/dl/schematics/pictures/esp-wroom-32.jpg
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp-wroom-32.jpg
     :align: center
-    :width: 40%
     :alt: ESP-WROOM-32 module (front and back)
+    :width: 40%
+
+    ESP-WROOM-32 module (front and back)
 
 * `Schematic <http://dl.espressif.com/dl/schematics/ESP-WROOM-32-v3.2_sch.pdf>`__ (PDF)
 * `Datasheet <http://espressif.com/sites/default/files/documentation/esp-wroom-32_datasheet_en.pdf>`__ (PDF)
 * `ESP32 Module Reference Design <https://espressif.com/sites/default/files/documentation/esp32_module_reference_design.zip>`_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM
 
+
+.. _esp-modules-and-boards-esp32-wrover:
+
+ESP32-WROVER
+------------
+
+A step upgrade of ESP-WROOM-32 described above with an additional 4 MB SPI PSRAM (Pseudo static RAM). Module is provided in two versions: 'ESP32-WROVER' with PCB antenna (shown below) and 'ESP32-WROVER-I' with an IPEX antenna.
+
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp32-wrover.jpg
+    :align: center
+    :alt: ESP32-WROVER module (front and back)
+    :width: 40%
+
+    ESP32-WROVER module (front and back)
+
+* `Datasheet <http://espressif.com/sites/default/files/documentation/esp32-wrover_datasheet_en.pdf>`__ (PDF)
+* `ESP-PSRAM32 Datasheet <http://espressif.com/sites/default/files/documentation/esp-psram32_datasheet_en.pdf>`__ (PDF)
+
+
+.. _esp-modules-and-boards-esp32-devkitc:
    
 ESP32 Core Board V2 / ESP32 DevKitC
 -----------------------------------
 
-Small and convenient development board with 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. 
+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. 
 
-.. image:: http://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.jpg
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp32-core-board-v2.jpg
     :align: center
-    :width: 50%
     :alt: ESP32 Core Board V2 / ESP32 DevKitC board
+    :width: 50%
+
+    ESP32 Core Board V2 / ESP32 DevKitC board
 
 * `Schematic <http://dl.espressif.com/dl/schematics/ESP32-Core-Board-V2_sch.pdf>`__ (PDF)
 * `ESP32 Development Board Reference Design <https://espressif.com/sites/default/files/documentation/esp32_development_board_reference_design.zip>`_ (ZIP) containing OrCAD schematic, PCB layout, gerbers and BOM
@@ -37,64 +65,95 @@ Small and convenient development board with break out pin headers and minimum ad
 * `CP210x USB to UART Bridge VCP Drivers <http://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
 
 
+.. _esp-modules-and-boards-esp32-demo-board-v2:
+
 ESP32 Demo Board V2
 -------------------
 
 One of first feature rich evaluation boards that contains several pin headers, dip switches, USB to serial programming interface, reset and boot mode press buttons, power switch, 10 touch pads and separate header to connect LCD screen.
 
-.. image:: http://dl.espressif.com/dl/schematics/pictures/esp32-demo-board-v2.jpg
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp32-demo-board-v2.jpg
     :align: center
-    :alt: ESP32 Demo Board V2 board
+    :alt: ESP32 Demo Board V2
+
+    ESP32 Demo Board V2
 
 * `Schematic <http://dl.espressif.com/dl/schematics/ESP32-Demo-Board-V2_sch.pdf>`__ (PDF)
 * `FTDI Virtual COM Port Drivers`_
 
 
-ESP32 WROVER KIT V1 / ESP32 DevKitJ V1
---------------------------------------
+.. _esp-modules-and-boards-esp-wrover-kit:
+
+ESP-WROVER-KIT
+--------------
+
+This section describes several revisions of ESP-WROVER-KIT development board.
+
+All versions of ESP-WROVER-KIT are ready to accommodate an :ref:`esp-modules-and-boards-esp-wroom-32` or :ref:`esp-modules-and-boards-esp32-wrover` module.
 
-Development board that has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. Has SD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. Provides RGB diode for diagnostics. Also, includes 32.768 kHz XTAL for internal RTC to operate it in low power modes.
+ESP-WROVER-KIT has dual port USB to serial converter for programming and JTAG interface for debugging. Power supply is provided by USB interface or from standard 5 mm power supply jack. Power supply selection is done with a jumper and may be put on/off with a separate switch. The board has MicroSD card slot, 3.2” SPI LCD screen and dedicated header to connect a camera. It provides RGB diode for diagnostics. Includes 32.768 kHz XTAL for internal RTC to operate it in low power modes.
 
-.. image:: http://dl.espressif.com/dl/schematics/pictures/esp32-devkitj-v1.jpg
+
+.. _esp-modules-and-boards-esp-wrover-kit-v1:
+
+ESP-WROVER-KIT V1 / ESP32 DevKitJ V1
+""""""""""""""""""""""""""""""""""""
+
+First version of ESP-WROVER-KIT. Shipped with ESP-WROOM-32 on board.
+
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp32-devkitj-v1.jpg
     :align: center
+    :alt: ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board
     :width: 90%
-    :alt: ESP32 WROVER KIT V1 / ESP32 DevKitJ V1 board
+
+    ESP-WROVER-KIT V1 / ESP32 DevKitJ V1 board
+
+The board has red soldermask.
 
 * `Schematic <http://dl.espressif.com/dl/schematics/ESP32-DevKitJ-v1_sch.pdf>`__ (PDF)
 * :doc:`../api-guides/jtag-debugging/index`
 * `FTDI Virtual COM Port Drivers`_
 
 
-ESP32 WROVER KIT V2
--------------------
+.. _esp-modules-and-boards-esp-wrover-kit-v2:
+
+ESP-WROVER-KIT V2
+"""""""""""""""""
 
-This is updated version of ESP32 DevKitJ V1 described above with design improvements identified when DevKitJ was in use.
+This is updated version of ESP32 DevKitJ V1 described above with design improvements identified when DevKitJ was in use, e.g. improved support for SD card. By default board has ESP-WROOM-32 module installed.
 
-.. image:: http://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v2.jpg
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v2.jpg
    :align: center
+   :alt: ESP-WROVER-KIT V2 board
    :width: 90%
-   :alt: ESP32 WROVER KIT V2 board
+
+   ESP-WROVER-KIT V2 board
 
 Comparing to previous version, this board has a shiny black finish and a male camera header.
 
 * `Schematic V2 <http://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-2.pdf>`__ (PDF)
+
+.. * :doc:`../get-started/get-started-wrover-kit-v2`
+
 * :doc:`../api-guides/jtag-debugging/index`
 * `FTDI Virtual COM Port Drivers`_
 
 
-ESP32 WROVER KIT V3
--------------------
+.. _esp-modules-and-boards-esp-wrover-kit-v3:
 
-This revision of ESP32 WROVER KIT introduced several changes to conditioning and interlocking of signals to the bootstrapping pins. A zero Ohm resistor (R166) has been addedd between WROVER/WROOM module and VDD33 net, which can be desoldered or replaced with a shunt resistor for current measurement. This should facilitate power consumption analysis in varius operation modes of ESP32. Refer to schematic - the changes are enclosed in green border. 
+ESP-WROVER-KIT V3
+"""""""""""""""""
 
-.. image:: http://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg
+The first release of ESP-WROVER-KIT shipped with ESP32-WROVER module installed by default. This release also introduced several design changes to conditioning and interlocking of signals to the bootstrapping pins. Also, a zero Ohm resistor (R166) has been added between WROVER/WROOM module and VDD33 net, which can be desoldered, or replaced with a shunt resistor, for current measurement. This is intended to facilitate power consumption analysis in various operation modes of ESP32. Refer to schematic - the changes are enclosed in green border. 
+
+.. figure:: http://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg
    :align: center
+   :alt: ESP-WROVER-KIT V3 board
    :width: 90%
-   :alt: ESP32 WROVER KIT V3 board
 
-The camera header has been changed from male back to female. The board soldermask is matte black.
+   ESP-WROVER-KIT V3 board
 
-All versions of ESP32 WROVER KIT are ready to accommodate an ESP-WROOM-32 or ESP32-WROVER module. On picture above ESP32-WROVER is installed.
+The camera header has been changed from male back to female. The board soldermask is matte black. The board on picture above has ESP32-WROVER is installed.
 
 * `Schematic V3 <http://dl.espressif.com/dl/schematics/ESP-WROVER-KIT_SCH-3.pdf>`__ (PDF)
 * :doc:`../get-started/get-started-wrover-kit`
@@ -103,4 +162,3 @@ All versions of ESP32 WROVER KIT are ready to accommodate an ESP-WROOM-32 or ESP
 
 
 .. _FTDI Virtual COM Port Drivers: http://www.ftdichip.com/Drivers/D2XX.htm
-
index 73429ba7cd61d645d2f63732e67b97555f3dac2b..3c54fef29b97914c97d7b2143a51da487b966a03 100644 (file)
@@ -1,6 +1,6 @@
 # This is a list of python packages used to generate documentation. This file is used with pip:
 # pip install -r requirements.txt
 #
-sphinx==1.5.6
+sphinx==1.6.3
 sphinx-rtd-theme
-breathe==4.6.0
+breathe==4.7.1