From df5d3ea692e8c9d774c9a938062f831295e1bf2f Mon Sep 17 00:00:00 2001 From: Krzysztof Budzynski Date: Thu, 16 Aug 2018 05:24:40 +0800 Subject: [PATCH] Provided a table with development boards by Espressif together with USB-to-serial driver names --- docs/en/api-reference/peripherals/adc.rst | 15 +++++------ .../establish-serial-connection.rst | 26 ++++++++++++++++--- .../modules-and-boards-previous.rst | 7 +++-- docs/en/hw-reference/modules-and-boards.rst | 8 +++--- 4 files changed, 36 insertions(+), 20 deletions(-) diff --git a/docs/en/api-reference/peripherals/adc.rst b/docs/en/api-reference/peripherals/adc.rst index 972c1f0c9..55b613a8c 100644 --- a/docs/en/api-reference/peripherals/adc.rst +++ b/docs/en/api-reference/peripherals/adc.rst @@ -4,16 +4,15 @@ Analog to Digital Converter Overview -------- -ESP32 integrates two 12-bit SAR (`Successive Approximation Register `_) ADCs (Analog to Digital Converters) and supports measurements on 18 channels (analog enabled pins). Some of these pins can be used to build a programmable gain amplifier which is used for the measurement of small analog signals. +The ESP32 integrates two 12-bit SAR (`Successive Approximation Register `_) ADCs supporting a total of 18 measurement channels (analog enabled pins). -The ADC driver API supports ADC1 (8 channels, attached to GPIOs 32 - 39), and ADC2 (10 channels, attached to GPIOs 0, 2, 4, 12 - 15 and 25 - 27). -However, there're some restrictions for the application to use ADC2: +The ADC driver API supports ADC1 (8 channels, attached to GPIOs 32 - 39), and ADC2 (10 channels, attached to GPIOs 0, 2, 4, 12 - 15 and 25 - 27). However, the usage of ADC2 has some restrictions for the application: -1. The application can use ADC2 only when Wi-Fi driver is not started, since the ADC is also used by the Wi-Fi driver, which has higher priority. -2. Some of the ADC2 pins are used as strapping pins (GPIO 0, 2, 15), so they cannot be used freely. For examples, for official Develop Kits: +1. ADC2 is used by the Wi-Fi driver. Therefore the application can only use ADC2 when the Wi-Fi driver has not started. +2. Some of the ADC2 pins are used as strapping pins (GPIO 0, 2, 15) thus cannot be used freely. Such is the case in the following official Development Kits: - - :ref:`ESP32 Core Board V2 / ESP32 DevKitC `: GPIO 0 cannot be used due to external auto program circuits. - - :ref:`ESP-WROVER-KIT V3 `: GPIO 0, 2, 4 and 15 cannot be used due to external connections for different purposes. + - :ref:`ESP32 DevKitC `: GPIO 0 cannot be used due to external auto program circuits. + - :ref:`ESP-WROVER-KIT `: GPIO 0, 2, 4 and 15 cannot be used due to external connections for different purposes. Configuration and Reading ADC ----------------------------- @@ -29,7 +28,7 @@ Then it is possible to read ADC conversion result with :cpp:func:`adc1_get_raw` .. note:: Since the ADC2 is shared with the WIFI module, which has higher priority, reading operation of :cpp:func:`adc2_get_raw` will fail between :cpp:func:`esp_wifi_start()` and :cpp:func:`esp_wifi_stop()`. Use the return code to see whether the reading is successful. -It is also possible to read the internal hall effect sensor via ADC1 by calling dedicated function :cpp:func:`hall_sensor_read`. Note that even the hall sensor is internal to ESP32, reading from it uses channels 0 and 3 of ADC1 (GPIO 36 and 39). Do not connect anything else to these pins and do not change their configuration. Otherwise it may affect the measurement of low value signal from the sesnor. +It is also possible to read the internal hall effect sensor via ADC1 by calling dedicated function :cpp:func:`hall_sensor_read`. Note that even the hall sensor is internal to ESP32, reading from it uses channels 0 and 3 of ADC1 (GPIO 36 and 39). Do not connect anything else to these pins and do not change their configuration. Otherwise it may affect the measurement of low value signal from the sensor. This API provides convenient way to configure ADC1 for reading from :doc:`ULP <../../api-guides/ulp>`. To do so, call function :cpp:func:`adc1_ulp_enable` and then set precision and attenuation as discussed above. diff --git a/docs/en/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst index e54345d83..8a337af8f 100644 --- a/docs/en/get-started/establish-serial-connection.rst +++ b/docs/en/get-started/establish-serial-connection.rst @@ -10,13 +10,31 @@ Connect ESP32 to PC Connect the ESP32 board to the PC using the USB cable. If device driver does not install automatically, identify USB to serial converter chip on your ESP32 board (or external converter dongle), search for drivers in internet and install them. -Below are the links to drivers for ESP32 boards produced by Espressif: +Below are the links to drivers for ESP32 and other boards produced by Espressif: -* ESP32-PICO-KIT and ESP32-DevKitC - `CP210x USB to UART Bridge VCP Drivers `_ -* ESP32-WROVER-KIT and ESP32 Demo Board - `FTDI Virtual COM Port Drivers `_ +.. csv-table:: + :header: Development Board, USB Driver, Remarks + :widths: 40, 20, 40 -Above drivers are primarily for reference. They should already be bundled with the operating system and installed automatically once one of listed boards is connected to the PC. + :ref:`ESP32-DevKitC `, `CP210x`_ + `ESP32-LyraT `_, `CP210x`_ + `ESP32-LyraTD-MSC `_, `CP210x`_ + :ref:`ESP32-PICO-KIT `, `CP210x`_ + :ref:`ESP-WROVER-KIT `, `FTDI`_ + :ref:`ESP32 Demo Board `, `FTDI`_ + `ESP-Prog`_, `FTDI`_, Programmer board (w/o ESP32) + `ESP32-MeshKit-Sense `_, n/a, Use with `ESP-Prog`_ + `ESP32-Sense Kit `_, n/a, Use with `ESP-Prog`_ + +.. _CP210x: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers +.. _FTDI: http://www.ftdichip.com/Drivers/VCP.htm +.. _ESP-Prog: https://github.com/espressif/esp-iot-solution/blob/master/documents/evaluation_boards/ESP-Prog_guide_en.md#introduction-to-the-esp-prog-board + +* CP210x: `CP210x USB to UART Bridge VCP Drivers `_ +* FTDI: `FTDI Virtual COM Port Drivers `_ + +The drivers above are primarily for reference. Under normal circumstances, the drivers should be bundled with and operating system and automatically installed upon connecting one of the listed boards to the PC. Check port on Windows diff --git a/docs/en/hw-reference/modules-and-boards-previous.rst b/docs/en/hw-reference/modules-and-boards-previous.rst index 8044b7df0..863955e79 100644 --- a/docs/en/hw-reference/modules-and-boards-previous.rst +++ b/docs/en/hw-reference/modules-and-boards-previous.rst @@ -8,8 +8,7 @@ This sections contains overview and links to documentation of previous version E To see the latest development boards, please refer to section :ref:`esp-modules-and-boards`. - -.. _esp-modules-and-boards-esp32-pico-pit-v4: +.. _esp-modules-and-boards-esp32-pico-kit-v4: ESP32-PICO-KIT V4 ================= @@ -32,7 +31,7 @@ Documentation * `ESP32-PICO-KIT V4 Schematic `_ (PDF) * `ESP32-PICO-D4 Datasheet `_ (PDF) -.. _esp-modules-and-boards-esp32-pico-pit-v3: +.. _esp-modules-and-boards-esp32-pico-kit-v3: ESP32-PICO-KIT V3 ================= @@ -130,7 +129,7 @@ Documentation * `FTDI Virtual COM Port Drivers`_ -.. _esp-modules-and-boards-esp32-demo-board-v2: +.. _esp-modules-and-boards-esp32-demo-board: ESP32 Demo Board V2 =================== diff --git a/docs/en/hw-reference/modules-and-boards.rst b/docs/en/hw-reference/modules-and-boards.rst index 245675172..c786aac8d 100644 --- a/docs/en/hw-reference/modules-and-boards.rst +++ b/docs/en/hw-reference/modules-and-boards.rst @@ -123,7 +123,7 @@ Documentation * `ESP32-WROVER Reference Design `_ containing OrCAD schematic, PCB layout, gerbers and BOM -.. _esp-modules-and-boards-esp32-pico-pit-v4.1: +.. _esp-modules-and-boards-esp32-pico-kit: ESP32-PICO-KIT V4.1 =================== @@ -150,8 +150,8 @@ Documentation Previous Versions ----------------- -* :ref:`esp-modules-and-boards-esp32-pico-pit-v4` -* :ref:`esp-modules-and-boards-esp32-pico-pit-v3` +* :ref:`esp-modules-and-boards-esp32-pico-kit-v4` +* :ref:`esp-modules-and-boards-esp32-pico-kit-v3` .. _esp-modules-and-boards-esp32-devkitc: @@ -182,7 +182,7 @@ Previous Versions * :ref:`esp-modules-and-boards-esp32-devkitc-v2` -.. _esp-modules-and-boards-esp-wrover-kit-v3: +.. _esp-modules-and-boards-esp-wrover-kit: ESP-WROVER-KIT V3 =================