Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge branch 'feature/docs_small_updates' into 'master'

Browse source 
Small updates of documentation

See merge request !1443
This commit is contained in:
Ivan Grokhotkov 2017-11-02 14:18:09 +08:00
parent 79f206be47 d637952555
commit 67c202f52b
7 changed files with 173 additions and 75 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api-guides/jtag-debugging/configure-wrover.rst
View file

@ -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:

4
docs/api-reference/peripherals/uart.rst
View file

@ -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

18
docs/get-started/get-started-devkitc.rst
View file

@ -7,7 +7,7 @@ This user guide shows how to get started with ESP32-DevKitC development board.
What You Need
-------------
* 1 × ESP32-DevKitC board
* 1 × :ref:`ESP32-DevKitC board <get-started-esp32-devkitc-board-front>`
* 1 × USB A / micro USB B cable
* 1 × PC loaded with Windows, Linux or Mac OS
@ -34,6 +34,8 @@ USB
I/O
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.
.. _get-started-esp32-devkitc-board-front:
.. figure:: ../_static/esp32-devkitc-functional-overview.png
:align: center
:alt: ESP32-DevKitC board layout
@ -42,6 +44,20 @@ I/O
ESP32-DevKitC board layout
Power Supply Options
--------------------
There following options are available to provide power supply to the ESP32-PICO-KIT V4:
1. Micro USB port, this is default power supply connection
2. 5V / GND header pins
3. 3V3 / GND header pins
.. warning::
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.
Start Application Development
------------------------------

18
docs/get-started/get-started-pico-kit.rst
View file

@ -7,7 +7,7 @@ This user guide shows how to get started with the ESP32-PICO-KIT V4 mini develop
What You Need
-------------
* 1 × ESP32-PICO-KIT V4 mini development board
* 1 × :ref:`ESP32-PICO-KIT V4 mini development board <get-started-pico-kit-v4-board-front>`
* 1 × USB A / Micro USB B cable
* 1 × PC loaded with Windows, Linux or Mac OS
@ -40,6 +40,8 @@ EN Button
BOOT Button
Holding down the Boot button and pressing the EN button initiates the firmware download mode. Then user can download firmware through the serial port.
.. _get-started-pico-kit-v4-board-front:
.. figure:: ../_static/esp32-pico-kit-v4-layout.jpg
:align: center
:alt: ESP32-PICO-KIT V4 board layout
@ -48,6 +50,20 @@ BOOT Button
ESP32-PICO-KIT V4 board layout
Power Supply Options
--------------------
There following options are available to provide power supply to the ESP32-PICO-KIT V4:
1. Micro USB port, this is default power supply connection
2. 5V / GND header pins
3. 3V3 / GND header pins
.. warning::
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.
Start Application Development
------------------------------

203
docs/get-started/get-started-wrover-kit.rst
View file

@ -3,13 +3,13 @@ ESP-WROVER-KIT V3 Getting Started Guide
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`.
If you like to start using this board right now, go directly to section :ref:`esp-wrover-kit-start-development`.
If you like to start using this board right now, go directly to section :ref:`get-started-esp-wrover-kit-start-development`.
What You Need
-------------
* 1 × ESP-WROVER-KIT V3 board
* 1 × :ref:`ESP-WROVER-KIT V3 board <get-started-esp-wrover-kit-board-front>`
* 1 x Micro USB 2.0 Cable, Type A to Micro B
* 1 × PC loaded with Windows, Linux or Mac OS
@ -70,7 +70,7 @@ Boot
USB
USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32 module.
Power Select
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.
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.
Power Key
Power on/off button: toggling to the right powers the board on; toggling to the left powers the board off.
5V Input
@ -82,11 +82,13 @@ Camera
RGB
Red, green and blue (RGB) light emitting diodes (LEDs), which may be controlled by pulse width modulation (PWM).
I/O
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.
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.
Micro SD Card
Micro SD card slot for data storage.
LCD
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`.
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`.
.. _get-started-esp-wrover-kit-board-front:
.. figure:: ../_static/esp32-wrover-kit-layout-front.jpg
:align: center
@ -95,7 +97,7 @@ LCD
ESP-WROVER-KIT board layout - front
.. _esp-wrover-kit-board-back:
.. _get-started-esp-wrover-kit-board-back:
.. figure:: ../_static/esp32-wrover-kit-layout-back.jpg
:align: center
@ -105,7 +107,7 @@ LCD
ESP-WROVER-KIT board layout - back
.. _esp-wrover-kit-setup-options:
.. _get-started-esp-wrover-kit-setup-options:
Setup Options
^^^^^^^^^^^^^
@ -116,7 +118,7 @@ There are five jumper headers available to set up the board functionality. Typic
| Header | Jumper Setting | Description of Functionality |
+--------+------------------+--------------------------------------------------+
| JP7 | |jp7-ext_5v| | Power ESP-WROVER-KIT board from an external |
| | | power supply |
| | | | power supply |
+--------+------------------+--------------------------------------------------+
| JP7 | |jp7-usb_5v| | Power ESP-WROVER-KIT board from an USB port |
+--------+------------------+--------------------------------------------------+
@ -135,60 +137,116 @@ 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.
Main I/O Connector / JP1
""""""""""""""""""""""""
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.
+----------------------+------+------+----------------------+
| Shared With | I/O | I/O | Shared With |
+======================+======+======+======================+
| | 3.3V | GND | |
+----------------------+------+------+----------------------+
| NC/XTAL | IO32 | IO33 | NC/XTAL |
+----------------------+------+------+----------------------+
| JTAG, MicroSD | IO12 | IO13 | JTAG, MicroSD |
+----------------------+------+------+----------------------+
| JTAG, MicroSD | IO14 | IO27 | Camera |
+----------------------+------+------+----------------------+
| Camera | IO26 | IO25 | Camera, LCD |
+----------------------+------+------+----------------------+
| Camera | IO35 | IO34 | Camera |
+----------------------+------+------+----------------------+
| Camera | IO39 | IO36 | Camera |
+----------------------+------+------+----------------------+
| JTAG | EN | IO23 | Camera, LCD |
+----------------------+------+------+----------------------+
| Camera, LCD | IO22 | IO21 | Camera, LCD, MicroSD |
+----------------------+------+------+----------------------+
| Camera, LCD | IO19 | IO18 | Camera, LCD |
+----------------------+------+------+----------------------+
| Camera, LCD | IO5 | IO17 | PSRAM |
+----------------------+------+------+----------------------+
| PSRAM | IO16 | IO4 | LED, Camera, MicroSD |
+----------------------+------+------+----------------------+
| LED, Boot | IO0 | IO2 | LED, Camera, MicroSD |
+----------------------+------+------+----------------------+
| JTAG, MicroSD | IO15 | 5V | |
+----------------------+------+------+----------------------+
Legend:
* NC/XTAL - :ref:`32.768 kHz Oscillator <get-started-esp-wrover-kit-xtal>`
* JTAG - :ref:`JTAG / JP8 <get-started-esp-wrover-jtag-header>`
* Boot - Boot button / SW2
* Camera - :ref:`Camera / JP4 <get-started-esp-wrover-camera-header>`
* LED - :ref:`RGB LED <get-started-esp-wrover-rgb-led-connections>`
* MicroSD - :ref:`MicroSD Card / J4 <get-started-esp-wrover-microsd-card-slot>`
* LCD - :ref:`LCD / U5 <get-started-esp-wrover-lcd-connector>`
* PSRAM - ESP32-WROVER's PSRAM, if ESP32-WROVER is installed
.. _get-started-esp-wrover-kit-xtal:
32.768 kHz Oscillator
"""""""""""""""""""""
+---+---------------+
| | ESP32 Pin |
+===+===============+
| 1 | GPIO32 |
+---+---------------+
| 2 | GPIO33 |
+---+---------------+
+---+-----------+
| | ESP32 Pin |
+===+===========+
| 1 | GPIO32 |
+---+-----------+
| 2 | GPIO33 |
+---+-----------+
.. note::
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.
.. _get-started-esp-wrover-spi-flash-header:
SPI Flash / JP13
""""""""""""""""
+---+---------------+
| | ESP32 Pin |
+===+===============+
| 1 | CLK / GPIO6 |
+---+---------------+
| 2 | SD0 / GPIO7 |
+---+---------------+
| 3 | SD1 / GPIO8 |
+---+---------------+
| 4 | SD2 / GPIO9 |
+---+---------------+
| 5 | SD3 / GPIO10 |
+---+---------------+
| 6 | CMD / GPIO11 |
+---+---------------+
+---+--------------+
| | ESP32 Pin |
+===+==============+
| 1 | CLK / GPIO6 |
+---+--------------+
| 2 | SD0 / GPIO7 |
+---+--------------+
| 3 | SD1 / GPIO8 |
+---+--------------+
| 4 | SD2 / GPIO9 |
+---+--------------+
| 5 | SD3 / GPIO10 |
+---+--------------+
| 6 | CMD / GPIO11 |
+---+--------------+
.. _get-started-esp-wrover-jtag-header:
JTAG / JP8
""""""""""
+---+---------------+----------------+
| | ESP32 Pin | JTAG Signal |
+===+===============+================+
| 1 | CHIP_PU | TRST_N |
+---+---------------+----------------+
| 2 | MTDO / GPIO15 | TDO |
+---+---------------+----------------+
| 3 | MTDI / GPIO12 | TDI |
+---+---------------+----------------+
| 4 | MTCK / GPIO13 | TCK |
+---+---------------+----------------+
| 5 | MTMS / GPIO14 | TMS |
+---+---------------+----------------+
+---+---------------+-------------+
| | ESP32 Pin | JTAG Signal |
+===+===============+=============+
| 1 | EN | TRST_N |
+---+---------------+-------------+
| 2 | MTDO / GPIO15 | TDO |
+---+---------------+-------------+
| 3 | MTDI / GPIO12 | TDI |
+---+---------------+-------------+
| 4 | MTCK / GPIO13 | TCK |
+---+---------------+-------------+
| 5 | MTMS / GPIO14 | TMS |
+---+---------------+-------------+
.. _get-started-esp-wrover-camera-header:
Camera / JP4
""""""""""""
@ -227,20 +285,24 @@ Camera / JP4
+----+--------------+----------------------+
.. _get-started-esp-wrover-rgb-led-connections:
RGB LED
"""""""
+---+---------------+----------------+
| | ESP32 Pin | RGB LED |
+===+===============+================+
| 1 | GPIO0 | Red |
+---+---------------+----------------+
| 2 | GPIO2 | Blue |
+---+---------------+----------------+
| 3 | GPIO4 | Green |
+---+---------------+----------------+
+---+-----------+---------+
| | ESP32 Pin | RGB LED |
+===+===========+=========+
| 1 | GPIO0 | Red |
+---+-----------+---------+
| 2 | GPIO2 | Blue |
+---+-----------+---------+
| 3 | GPIO4 | Green |
+---+-----------+---------+
.. _get-started-esp-wrover-microsd-card-slot:
MicroSD Card / J4
"""""""""""""""""
@ -263,30 +325,31 @@ MicroSD Card / J4
+---+---------------+----------------+
.. _get-started-esp-wrover-lcd-connector:
LCD / U5
""""""""
+---+---------------+----------------+
| | ESP32 Pin | LCD Signal |
+===+===============+================+
| 1 | GPIO18 | RESET |
+---+---------------+----------------+
| 2 | GPIO19 | SCL |
+---+---------------+----------------+
| 3 | GPIO21 | D/C |
+---+---------------+----------------+
| 4 | GPIO22 | CS |
+---+---------------+----------------+
| 5 | GPIO23 | SDA |
+---+---------------+----------------+
| 6 | GPIO25 | SDO |
+---+---------------+----------------+
| 7 | GPIO5 | Backlight |
+---+---------------+----------------+
+---+-----------+------------+
| | ESP32 Pin | LCD Signal |
+===+===========+============+
| 1 | GPIO18 | RESET |
+---+-----------+------------+
| 2 | GPIO19 | SCL |
+---+-----------+------------+
| 3 | GPIO21 | D/C |
+---+-----------+------------+
| 4 | GPIO22 | CS |
+---+-----------+------------+
| 5 | GPIO23 | SDA |
+---+-----------+------------+
| 6 | GPIO25 | SDO |
+---+-----------+------------+
| 7 | GPIO5 | Backlight |
+---+-----------+------------+
.. _esp-wrover-kit-start-development:
.. _get-started-esp-wrover-kit-start-development:
Start Application Development
-----------------------------

1
docs/hw-reference/index.rst
View file

@ -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>

2
docs/hw-reference/modules-and-boards.rst
View file

@ -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%