]> granicus.if.org Git - esp-idf/commitdiff
ESP32-PICO-KIT Getting Started Guide
authorkrzychb <krzychb@gazeta.pl>
Mon, 2 Oct 2017 05:03:24 +0000 (07:03 +0200)
committerkrzychb <krzychb@gazeta.pl>
Wed, 11 Oct 2017 06:02:23 +0000 (08:02 +0200)
docs/_static/esp32-pico-kit-layout.jpg [new file with mode: 0644]
docs/get-started/establish-serial-connection.rst
docs/get-started/get-started-pico-kit.rst [new file with mode: 0644]
docs/get-started/index.rst

diff --git a/docs/_static/esp32-pico-kit-layout.jpg b/docs/_static/esp32-pico-kit-layout.jpg
new file mode 100644 (file)
index 0000000..f912a89
Binary files /dev/null and b/docs/_static/esp32-pico-kit-layout.jpg differ
index 47f736565a6473fc0fd2179bca4fd308f520f53d..f3e15250f1b32b1f8e3e08c4019eba677342befe 100644 (file)
@@ -9,13 +9,14 @@ 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 Windows and MacOS drivers for ESP32 boards produced by Espressif:
+Below are the links to drivers for ESP32 boards produced by Espressif:
 
-* ESP32 Core Board - `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
+* ESP32-PICO-KIT and ESP32-DevKitC - `CP210x USB to UART Bridge VCP Drivers <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>`_
 
-* ESP32 WROVER KIT and ESP32 Demo Board - `FTDI Virtual COM Port Drivers <http://www.ftdichip.com/Drivers/D2XX.htm>`_
+* ESP32-WROVER-KIT and ESP32 Demo Board - `FTDI Virtual COM Port Drivers <http://www.ftdichip.com/Drivers/D2XX.htm>`_
+
+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.
 
-For Linux, suitable drivers should already be bundled with the operating system.
 
 Check port on Windows
 ---------------------
diff --git a/docs/get-started/get-started-pico-kit.rst b/docs/get-started/get-started-pico-kit.rst
new file mode 100644 (file)
index 0000000..236d7a1
--- /dev/null
@@ -0,0 +1,66 @@
+ESP32-PICO-KIT Getting Started Guide\r
+====================================\r
+\r
+This user guide shows how to get started with the ESP32-PICO-KIT mini development board.\r
+\r
+\r
+What You Need\r
+-------------\r
+\r
+* 1 × ESP32-PICO-KIT mini development board\r
+* 1 × USB A / Micro USB B cable\r
+* 1 × PC loaded with Windows, Linux or Mac OS\r
+\r
+\r
+Overview\r
+--------\r
+\r
+ESP32-PICO-KIT is a mini development board based on the ESP32-PICO-D4 SIP module produced by `Espressif <https://espressif.com>`_. All the IO signals and system power on ESP32-PICO-D4 are led out through two standard 20 pin x 0.1" pitch headers on both sides for easy interfacing. The development board integrates a USB-UART Bridge circuit, allowing the developers to connect the development board to a PC's USB port for downloads and debugging.\r
+\r
+\r
+Functional Description\r
+----------------------\r
+\r
+The following list and figure below describe key components, interfaces and controls of ESP32-PICO-KIT board.\r
+\r
+ESP32-PICO-D4\r
+    Standard ESP32-PICO-D4 module soldered to the ESP32-PICO-KIT board. The complete system of the ESP32 chip has been integrated into the SIP module, requiring only external antenna with LC matching network, decoupling capacitors and pull-up resistors for EN signals to function properly.\r
+USB-UART Bridge\r
+    A single chip USB-UART bridge provides up to 1 Mbps transfers rates.\r
+I/O\r
+    All the pins on ESP32-PICO-D4 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
+Micro USB Port\r
+    USB interface. It functions as the power supply for the board and the communication interface between PC and ESP32-PICO-KIT.\r
+EN Button\r
+    Reset button; pressing this button resets the system.\r
+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
+.. figure:: ../_static/esp32-pico-kit-layout.jpg\r
+    :align: center\r
+    :alt: ESP32-PICO-KIT board layout\r
+    :figclass: align-center\r
+\r
+    ESP32-PICO-KIT board layout\r
+\r
+\r
+Start Application Development\r
+------------------------------\r
+\r
+Before powering up the ESP32-PICO-KIT, please make sure that the board has been received in good condition with no obvious signs of damage.\r
+\r
+To start development of applications, proceed to section :doc:`index`, that will walk you through the following steps:\r
+\r
+* :ref:`get-started-setup-toolchain` in your PC to develop applications for ESP32 in C language\r
+* :ref:`get-started-connect` the module to the PC and verify if it is accessible\r
+* :ref:`get-started-build-flash` an example application to the ESP32\r
+* :ref:`get-started-build-monitor` instantly what the application is doing\r
+\r
+\r
+Related Documents\r
+-----------------\r
+\r
+* `ESP32-PICO-KIT schematic <https://dl.espressif.com/dl/schematics/esp32-pico-kit_schematic.pdf>`_ (PDF)\r
+* `ESP32-PICO-D4 Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-d4_datasheet_en.pdf>`_ (PDF)\r
+\r
+.. * `ESP32-PICO-KIT Datasheet <http://espressif.com/sites/default/files/documentation/esp32-pico-kit_datasheet_en.pdf>`_ (PDF)\r
index a19b805e3d3c2aa5a52cfb5b95af9f3e84f8cb19..de1caa84c26b3026efecfff05809ca54c025a804 100644 (file)
@@ -59,6 +59,7 @@ If you have one of ESP32 development boards listed below, click on provided link
 \r
     ESP32 DevKitC <get-started-devkitc>\r
     ESP-WROVER-KIT <get-started-wrover-kit>\r
+    ESP32-PICO-KIT <get-started-pico-kit>\r
 \r
 If you have different board, move to sections below.\r
 \r