Skip to content

Latest commit

 

History

History
105 lines (59 loc) · 3.9 KB

TEMPLATE_EXAMPLE_README_EN.md

File metadata and controls

105 lines (59 loc) · 3.9 KB
Raw

Note that this is a template for an esp-dev-kits example README.md file. When using this template, replace all these emphasized placeholder texts with example-specific content.

Example Title

Link to Chinese Version

中文版本

Introduce the functionality demonstrated by the example. The introduction should preferably answer the following questions:

  • What is this example? What does it do?
  • What features of the board (e.g., USB HOST, sensors, smart panel) does it use?
  • What could someone create based on this example? i.e., applications/use cases/etc.

Getting Started

Prerequisites

Provide the name of the specific board(s) this example is intended to run on.

If any other items are needed, such as server, Bluetooth device, app, second chip, list them here. Include links if applicable. Explain how to set them up.

ESP-IDF Required

Specify the ESP-IDF branch recommended or required by the example. Take the following statement as a reference.

  • This example supports ESP-IDF release/v[x.y] and later branches. By default, it runs on ESP-IDF release/v[x.y].
  • Please follow the ESP-IDF Programming Guide to set up the development environment. We highly recommend you Build Your First Project to get familiar with ESP-IDF and make sure the environment is set up correctly.

Get the esp-dev-kits Repository

Describe the way to clone the repository.

To start from the examples in esp-dev-kits, clone the repository to the local PC by running the following commands in the terminal:

git clone --recursive https://github.com/espressif/esp-dev-kits.git

Configuration

  • Describe important items to configure in menuconfig, such as long file name support for FatFs, selection of compatible audio board, chip type, PSRAM clock, and Wi-Fi/LwIP parameters. Below is an example.

    Run idf.py menuconfig and modify the QWeather and Wi-Fi configuration:

    menuconfig > QWeather > QWEATHER_REQUEST_KEY

  • Describe the configuration of other software if required, such as specifying a patch.

How to Use the Example

Build and Flash the Example

Command to build and flash the example. Below is an example.

Build the project and flash it to the board, then run monitor tool to view serial output (replace PORT with your board's serial port name):

idf.py -p PORT flash monitor

To exit the serial monitor, type Ctrl-].

See the ESP-IDF Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Example Output

Add the expected output effect of the example. Below are two references.

  • The complete log is as follows:

    I (64) boot: Chip Revision: 3
I (35) boot: ESP-IDF v3.3.1-203-g0c1859a5a 2nd stage bootloader
I (35) boot: compile time 21:43:15
I (35) boot: Enabling RNG early entropy source...
I (41) qio_mode: Enabling default flash chip QIO
I (46) boot: SPI Speed      : 80MHz
I (50) boot: SPI Mode       : QIO
I (54) boot: SPI Flash Size : 8MB

  • The following animations show the example running on different development boards.

Troubleshooting

This section is optional. If there are any problems or errors which many users might encounter, mention them here. Remove this section for very simple examples where nothing is likely to go wrong.

Technical Support and Feedback

Please use the following feedback channels:

  • For technical queries, go to the esp32.com forum.
  • For a feature request or bug report, create a GitHub issue.

We will get back to you as soon as possible.