Add ESP32-S2-Saola-1 User Guide
This commit is contained in:
Wang Ning
Krzysztof Budzynski
parent
296d095e53
commit
a0c37ae1bd
BIN
docs/_static/esp32-s2-saola-1-v1.2-annotated-photo.png
vendored
Normal file
BIN
docs/_static/esp32-s2-saola-1-v1.2-annotated-photo.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 276 KiB |
BIN
docs/_static/esp32-s2-saola-1-v1.2-block-diags.png
vendored
Normal file
BIN
docs/_static/esp32-s2-saola-1-v1.2-block-diags.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
BIN
docs/_static/esp32-s2-saola-1-v1.2-isometric.png
vendored
Normal file
BIN
docs/_static/esp32-s2-saola-1-v1.2-isometric.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 158 KiB |
|
|
@ -74,7 +74,10 @@ If you have one of {IDF_TARGET_NAME} development boards listed below, you can cl
|
|||
|
||||
.. only:: esp32s2
|
||||
|
||||
There are currently no hardware guides available for ESP32-S2.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
|
||||
|
||||
.. _get-started-step-by-step:
|
||||
|
||||
|
|
|
|||
142
docs/en/hw-reference/esp32s2/user-guide-saola-1-v1.2.rst
Normal file
142
docs/en/hw-reference/esp32s2/user-guide-saola-1-v1.2.rst
Normal file
|
|
@ -0,0 +1,142 @@
|
|||
================
|
||||
ESP32-S2-Saola-1
|
||||
================
|
||||
|
||||
This user guide provides information on ESP32-S2-Saola-1, a small-sized `ESP32-S2 <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_ based development board produced by Espressif.
|
||||
|
||||
.. figure:: ../../../_static/esp32-s2-saola-1-v1.2-isometric.png
|
||||
:align: center
|
||||
:alt: ESP32-S2-Saola-1
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-Saola-1
|
||||
|
||||
The document consists of the following major sections:
|
||||
|
||||
- `Getting started`_: Provides an overview of the ESP32-S2-Saola-1 and hardware/software setup instructions to get started.
|
||||
- `Hardware reference`_: Provides more detailed information about the ESP32-S2-Saola-1's hardware.
|
||||
- `Related Documents`_: Gives links to related documentation.
|
||||
|
||||
Getting Started
|
||||
===============
|
||||
|
||||
This section describes how to get started with ESP32-S2-Saola-1. It begins with a few introductory sections about the ESP32-S2-Saola-1, then Section `Start Application Development`_ provides instructions on how to get the ESP32-S2-Saola-1 ready and flash firmware into it.
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
ESP32-S2-Saola-1 is a small-sized ESP32-S2 based development board produced by Espressif. Most of the I/O pins are broken out to the pin headers on both sides for easy interfacing. Developers can either connect peripherals with jumper wires or mount ESP32-S2-Saola-1 on a breadboard.
|
||||
|
||||
To cover a wide range of users' needs, ESP32-S2-Saola-1 supports:
|
||||
|
||||
- `ESP32-S2-WROVER <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_en.pdf>`_
|
||||
- `ESP32-S2-WROVER-I <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_en.pdf>`_
|
||||
- `ESP32-S2-WROOM <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wroom_esp32-s2-wroom-i_datasheet_en.pdf>`_
|
||||
- `ESP32-S2-WROOM-I <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wroom_esp32-s2-wroom-i_datasheet_en.pdf>`_
|
||||
|
||||
In this guide, we take ESP32-S2-Saola-1 equipped with ESP32-S2-WROVER as an example.
|
||||
|
||||
Contents and Packaging
|
||||
----------------------
|
||||
|
||||
Retail orders
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
If you order a few samples, each ESP32-S2-Saola-1 comes in an individual package in either antistatic bag or any packaging depending on your retailer.
|
||||
|
||||
For retail orders, please go to https://www.espressif.com/en/company/contact/buy-a-sample.
|
||||
|
||||
|
||||
Wholesale Orders
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
If you order in bulk, the boards come in large cardboard boxes.
|
||||
|
||||
For wholesale orders, please check `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)
|
||||
|
||||
Description of Components
|
||||
-------------------------
|
||||
|
||||
.. figure:: ../../../_static/esp32-s2-saola-1-v1.2-annotated-photo.png
|
||||
:align: center
|
||||
:alt: ESP32-S2-Saola-1 - front/back
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-Saola-1 - front
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
:header-rows: 1
|
||||
|
||||
* - Key Component
|
||||
- Description
|
||||
* - ESP32-S2-WROVER
|
||||
- ESP32-S2-WROVER is a powerful, generic Wi-Fi MCU module that integrates ESP32-S2. It has a PCB antenna, a 4 MB external SPI flash and an additional 2 MB PSRAM.
|
||||
* - I/O Connector
|
||||
- All available GPIO pins (except for the SPI bus for flash and PSRAM) are broken out to the pin headers on the board. Users can program ESP32-S2 chip to enable multiple functions such as SPI, I2S, UART, I2C, touch sensors, PWM etc.
|
||||
* - USB to UART Bridge
|
||||
- Single USB-UART bridge chip provides transfer rates up to 3 Mbps.
|
||||
* - Boot Button
|
||||
- Download button. Holding down Boot and then pressing Reset initiates Firmware Download mode for downloading firmware through the serial port.
|
||||
* - Reset Button
|
||||
- Reset button.
|
||||
* - 3.3 V Power On LED
|
||||
- Turns on when the USB power is connected to the board.
|
||||
* - Micro-USB Port
|
||||
- USB interface. Power supply for the board as well as the communication interface between a computer and the ESP32-S2 chip.
|
||||
* - RGB LED
|
||||
- Addressable RGB LED (WS2812), driven by GPIO18.
|
||||
|
||||
|
||||
Start Application Development
|
||||
-----------------------------
|
||||
|
||||
Before powering up your ESP32-S2-Saola-1, please make sure that it is in good condition with no obvious signs of damage.
|
||||
|
||||
Required Hardware
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
- ESP32-S2-Saola-1
|
||||
- USB 2.0 cable (Standard-A to Micro-B)
|
||||
- Computer running Windows, Linux, or macOS
|
||||
|
||||
Software Setup
|
||||
^^^^^^^^^^^^^^
|
||||
|
||||
Please proceed to :doc:`../../get-started/index`, where Section :ref:`get-started-step-by-step` will quickly help you set up the development environment and then flash an application example into your ESP32-S2-Saola-1.
|
||||
|
||||
.. note::
|
||||
|
||||
ESP32-S2 only supports ESP-IDF master or version v4.2 and higher.
|
||||
|
||||
Hardware Reference
|
||||
==================
|
||||
|
||||
Block Diagram
|
||||
-------------
|
||||
|
||||
A block diagram below shows the components of ESP32-S2-Saola-1 and their interconnections.
|
||||
|
||||
.. figure:: ../../../_static/esp32-s2-saola-1-v1.2-block-diags.png
|
||||
:align: center
|
||||
:scale: 70%
|
||||
:alt: ESP32-S2-Saola-1 (click to enlarge)
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-Saola-1 (click to enlarge)
|
||||
|
||||
Power Supply Options
|
||||
^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
There are three mutually exclusive ways to provide power to the board:
|
||||
- Micro USB port, default power supply
|
||||
- 5V and GND header pins
|
||||
- 3V3 and GND header pins
|
||||
|
||||
Related Documents
|
||||
=================
|
||||
* `ESP32-S2-Saola-1 Schematics <https://dl.espressif.com/dl/schematics/ESP32-S2-SAOLA-1_V1.1_schematics.pdf>`_ (PDF)
|
||||
* `ESP32-S2 Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-S2-WROVER & ESP32-S2-WROVER-I Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_en.pdf>`_ (PDF)
|
||||
* `ESP32-S2-WROOM & ESP32-S2-WROOM-I Datasheet <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wroom_esp32-s2-wroom-i_datasheet_en.pdf>`_ (PDF)
|
||||
* `Espressif Product Ordering Information <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_en.pdf>`_ (PDF)
|
||||
|
|
@ -74,6 +74,12 @@
|
|||
ESP32-Ethernet-Kit <../hw-reference/esp32/get-started-ethernet-kit>
|
||||
ESP32-DevKit-S(-R) <../hw-reference/esp32/user-guide-devkits-r-v1.1>
|
||||
|
||||
.. only:: esp32s2
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
ESP32-S2-Saola-1 <../hw-reference/esp32s2/user-guide-saola-1-v1.2>
|
||||
|
||||
.. _get-started-step-by-step:
|
||||
|
||||
|
|
|
|||
143
docs/zh_CN/hw-reference/esp32s2/user-guide-saola-1-v1.2.rst
Normal file
143
docs/zh_CN/hw-reference/esp32s2/user-guide-saola-1-v1.2.rst
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
================
|
||||
ESP32-S2-Saola-1
|
||||
================
|
||||
|
||||
本指南介绍了乐鑫一款基于 `ESP32-S2 <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf>`_ 的小型开发板 ESP32-S2-Saola-1。
|
||||
|
||||
.. figure:: ../../../_static/esp32-s2-saola-1-v1.2-isometric.png
|
||||
:align: center
|
||||
:alt: ESP32-S2-Saola-1
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-Saola-1
|
||||
|
||||
本指南包括如下内容：
|
||||
|
||||
- `入门指南`_: 简要介绍了 ESP32-S2-Saola-1 和硬件、软件设置指南。
|
||||
- `硬件参考`_: 详细介绍了 ESP32-S2-Saola-1 的硬件。
|
||||
- `相关文档`_: 列出了相关文档的链接。
|
||||
|
||||
入门指南
|
||||
========
|
||||
|
||||
本节介绍了如何快速上手 ESP32-S2-Saola-1。开头部分介绍了 ESP32-S2-Saola-1，`开始开发应用`_ 小节介绍了怎样在 ESP32-S2-Saola-1 上安装模组、设置及烧录固件。
|
||||
|
||||
概述
|
||||
----
|
||||
|
||||
ESP32-S2-Saola-1 是乐鑫一款基于 ESP32-S2 的小型开发板。板上的绝大部分管脚均已引出，开发人员可根据实际需求，轻松通过跳线连接多种外围器件，或将开发板插在面包板上使用。
|
||||
|
||||
为了更好地满足不同用户需求，ESP32-S2-Saola-1 支持以下模组：
|
||||
|
||||
- `ESP32-S2-WROVER <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_cn.pdf>`_
|
||||
- `ESP32-S2-WROVER-I <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_cn.pdf>`_
|
||||
- `ESP32-S2-WROOM <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wroom_esp32-s2-wroom-i_datasheet_cn.pdf>`_
|
||||
- `ESP32-S2-WROOM-I <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wroom_esp32-s2-wroom-i_datasheet_cn.pdf>`_
|
||||
|
||||
本指南以搭载 ESP32-S2-WROVER 模组的 ESP32-S2-Saola-1 为例。
|
||||
|
||||
内含组件和包装
|
||||
--------------
|
||||
|
||||
零售订单
|
||||
^^^^^^^^
|
||||
|
||||
如购买样品，每个 ESP32-S2-Saola-1 底板将以防静电袋或零售商选择的其他方式包装。
|
||||
|
||||
零售订单请前往 https://www.espressif.com/zh-hans/company/contact/buy-a-sample。
|
||||
|
||||
批量订单
|
||||
^^^^^^^^
|
||||
|
||||
如批量购买，ESP32-S2-Saola-1 烧录底板将以大纸板箱包装。
|
||||
|
||||
批量订单请参考 `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`__ (PDF)。
|
||||
|
||||
组件介绍
|
||||
--------
|
||||
|
||||
.. figure:: ../../../_static/esp32-s2-saola-1-v1.2-annotated-photo.png
|
||||
:align: center
|
||||
:alt: ESP32-S2-Saola-1 - 正面
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-Saola-1 - 正面
|
||||
|
||||
.. list-table::
|
||||
:widths: 30 70
|
||||
:header-rows: 1
|
||||
|
||||
* - 主要组件
|
||||
- 介绍
|
||||
* - ESP32-S2-WROVER
|
||||
- ESP32-S2-WROVER 集成 ESP32-S2，是通用型 Wi-Fi MCU 模组，功能强大。该模组采用 PCB 板载天线，配置了 4 MB SPI flash 和 2 MB SPI PSRAM。
|
||||
* - I/O 连接器
|
||||
- 所有可用 GPIO 管脚（除 Flash 和 PSRAM 的 SPI 总线）均已引出至开发板的排针。用户可对 ESP32-S2 芯片编程，使能 SPI、I2S、UART、I2C、触摸传感器、PWM 等多种功能。
|
||||
* - USB 至 UART 桥接器
|
||||
- 单芯片 USB 至 UART 桥接器，可提供高达 3 Mbps 的传输速率。
|
||||
* - Boot 键。
|
||||
- 下载按键。按住 Boot 键的同时按一下 EN 键进入“固件下载”模式，通过串口下载固件。
|
||||
* - Reset 键。
|
||||
- 复位按键。
|
||||
* - 3.3 V 电源指示灯
|
||||
- 开发板连接 USB 电源后，该指示灯亮起。
|
||||
* - Micro-USB 接口
|
||||
- USB 接口。可用作开发板的供电电源或 PC 和 ESP32-S2 芯片的通信接口。
|
||||
* - RGB LED
|
||||
- 可寻址 RGB 发光二极管 (WS2812)，由 GPIO18 驱动。
|
||||
|
||||
开始开发应用
|
||||
------------
|
||||
|
||||
通电前，请确保 ESP32-S2-Saola-1 完好无损。
|
||||
|
||||
必备硬件
|
||||
^^^^^^^^
|
||||
|
||||
- ESP32-S2-Saola-1
|
||||
- USB 2.0 数据线（标准 A 型转 Micro-B型）
|
||||
- 电脑 （Windows、Linux 或 macOS）
|
||||
|
||||
软件设置
|
||||
^^^^^^^^
|
||||
|
||||
请前往 :doc:`../../get-started/index`，在 :ref:`get-started-step-by-step` 一节查看如何快速设置开发环境，将应用程序烧录至 ESP32-S2-Saola-1。
|
||||
|
||||
.. 注解::
|
||||
|
||||
ESP32-S2 仅支持 ESP-IDF master 分支或 v4.2 以上版本。
|
||||
|
||||
硬件参考
|
||||
========
|
||||
|
||||
功能框图
|
||||
--------
|
||||
|
||||
ESP32-S2-Saola-1 的主要组件和连接方式如下图所示。
|
||||
|
||||
.. figure:: ../../../_static/esp32-s2-saola-1-v1.2-block-diags.png
|
||||
:align: center
|
||||
:scale: 70%
|
||||
:alt: ESP32-S2-Saola-1 （点击放大）
|
||||
:figclass: align-center
|
||||
|
||||
ESP32-S2-Saola-1 （点击放大）
|
||||
|
||||
电源选项
|
||||
^^^^^^^^
|
||||
|
||||
您可从以下三种供电方式中任选其一给 ESP32-S2-Saola-1 供电：
|
||||
|
||||
- Micro USB 端口供电（默认）
|
||||
- 5V 和 GND 管脚供电
|
||||
- 3V3 和 GND 管脚供电
|
||||
|
||||
建议选择第一种供电方式：Micro USB 端口供电。
|
||||
|
||||
相关文档
|
||||
========
|
||||
* `ESP32-S2-Saola-1 原理图 <https://dl.espressif.com/dl/schematics/ESP32-S2-SAOLA-1_V1.1_schematics.pdf>`_ (PDF)
|
||||
* `ESP32-S2 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_cn.pdf>`_ (PDF)
|
||||
* `ESP32-S2-WROVER & ESP32-S2-WROVER-I 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wrover_esp32-s2-wrover-i_datasheet_cn.pdf>`_ (PDF)
|
||||
* `ESP32-S2-WROOM & ESP32-S2-WROOM-I 技术规格书 <https://www.espressif.com/sites/default/files/documentation/esp32-s2-wroom_esp32-s2-wroom-i_datasheet_cn.pdf>`_ (PDF)
|
||||
* `乐鑫产品订购信息 <https://www.espressif.com/sites/default/files/documentation/espressif_products_ordering_information_cn.pdf>`_ (PDF)
|
||||
Loading…
Reference in a new issue