Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
OVMS3-idf/docs/en/hw-reference/get-started-pico-kit-v3.rst

78 lines
3.8 KiB
ReStructuredText
Raw Normal View History

Merge make-related documents: 1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder; 2. Deleted get-started files, 7 documents in total, in get-started folder; 3. Updated links in get-started-cmake/index.rst and in get-started/index.rst; 4. Modified descriptions for build system in these files.
2019-07-04 05:16:18 +00:00
ESP32-PICO-KIT V3 Getting Started Guide
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 01:29:49 +00:00
=======================================
Doc/review get st pico
2019-03-26 08:11:11 +00:00
:link_to_translation:`zh_CN:[中文]`
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Doc/review get st pico
2019-03-26 08:11:11 +00:00
This guide shows how to get started with the ESP32-PICO-KIT V3 mini development board. For the description of other ESP32-PICO-KIT versions, please check :doc:`../hw-reference/index`.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
What You Need
-------------
Doc/review get st pico
2019-03-26 08:11:11 +00:00
* ESP32-PICO-KIT V3 mini development board
* USB 2.0 A to Micro B cable
* Computer running Windows, Linux, or macOS
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Doc/review get st pico
2019-03-26 08:11:11 +00:00
You can skip the introduction sections and go directly to Section `Start Application Development`_.
Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section.
2019-02-04 20:51:50 +00:00
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Overview
--------
Doc/review get st pico
2019-03-26 08:11:11 +00:00
ESP32-PICO-KIT V3 is an ESP32-based mini development board produced by `Espressif <https://espressif.com>`_. The core of this board is ESP32-PICO-D4 - a System-in-Package (SiP) module.
The development board features a USB-UART Bridge circuit, which allows developers to connect the board to a computer's USB port for flashing and debugging.
All the IO signals and system power on ESP32-PICO-D4 are led out to two rows of 20 x 0.1" header pads on both sides of the development board for easy access.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Functional Description
----------------------
Doc/review get st pico
2019-03-26 08:11:11 +00:00
The following figure and the table below describe the key components, interfaces, and controls of the ESP32-PICO-KIT V3 board.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
.. figure:: ../../_static/esp32-pico-kit-v3-layout.jpg
:align: center
:alt: ESP32-PICO-KIT V3 board layout
:figclass: align-center
ESP32-PICO-KIT V3 board layout
Doc/review get st pico
2019-03-26 08:11:11 +00:00
Below is the description of the items identified in the figure starting from the top left corner and going clockwise.
================== =================================================================================================================================
Key Component Description
================== =================================================================================================================================
ESP32-PICO-D4 Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT V3 board. The complete ESP32 system on a chip (ESP32 SoC) has been integrated into the SiP module, requiring only an external antenna with LC matching network, decoupling capacitors, and a pull-up resistor for EN signals to function properly.
LDO 5V-to-3.3V Low dropout voltage regulator (LDO).
USB-UART bridge Single-chip USB-UART bridge provides up to 1 Mbps transfers rates.
Micro USB Port USB interface. Power supply for the board as well as the communication interface between a computer and the board.
Power On LED This red LED turns on when power is supplied to the board.
I/O All the pins on ESP32-PICO-D4 are broken out to pin headers. You can program ESP32 to enable multiple functions, such as PWM, ADC, DAC, I2C, I2S, SPI, etc.
BOOT Button Download button. Holding down **Boot** and then pressing **EN** initiates Firmware Download mode for downloading firmware through the serial port.
EN Button Reset button.
================== =================================================================================================================================
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Start Application Development
Introduced installation steps to improve navigation through the installation process. Included some updates from GNU make section.
2019-02-04 20:51:50 +00:00
-----------------------------
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Update IDF getting started sections for make and cmake as well as IDF monitor…
2019-03-13 16:10:26 +00:00
Before powering up your ESP32-PICO-KIT V3, please make sure that the board is in good condition with no obvious signs of damage.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
docs: Functional renaming commit for CMake-as-default Rename all the files which will be edited substantially in the next commit, without changing their contents Docs will not build for this ocmmit. This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-06-25 01:29:49 +00:00
After that, proceed to :doc:`index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an example project onto your board.
docs: Copy CMake docs to a separate set of directories Required first step before merging back to mainline.
2018-08-08 07:58:00 +00:00
Related Documents
-----------------
* `ESP32-PICO-KIT V3 schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit-v3_schematic.pdf>`_ (PDF)
* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)
* :doc:`../hw-reference/index`
Reference in a new issue Copy permalink