1_Note that this is a template for an ESP-IDF example README.md file. When using this template, replace all these emphasised placeholders with example-specific content._
2
3# _Example Title_
4
5(See the README.md file in the upper level 'examples' directory for more information about examples.)
6
7_What is this example? What does it do?_
8
9_What features of ESP-IDF does it use?_
10
11_What could someone create based on this example? ie applications/use cases/etc_
12
13_If there are any acronyms or Espressif-only words used here, explain them or mention where in the datasheet/TRM this information can be found._
14
15## How to use example
16
17### Hardware Required
18
19_If possible, example should be able to run on any commonly available ESP32 development board. Otherwise, describe what specific hardware should be used._
20
21_If any other items (server, BLE device, app, second chip, whatever) are needed, mention them here. Include links if applicable. Explain how to set them up._
22
23### Configure the project
24
25```
26idf.py menuconfig
27```
28
29* _If there is any project configuration that the user must set for this example, mention this here._
30
31### Build and Flash
32
33Build the project and flash it to the board, then run monitor tool to view serial output:
34
35```
36idf.py -p PORT flash monitor
37```
38
39(Replace PORT with the name of the serial port to use.)
40
41(To exit the serial monitor, type ``Ctrl-]``.)
42
43See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.
44
45## Example Output
46
47_Include an example of the console output from the running example, here:_
48
49```
50Use this style for pasting the log.
51```
52
53_If the user is supposed to interact with the example at this point (read/write GATT attribute, send HTTP request, press button, etc. then mention it here)_
54
55_For examples where ESP32 is connected  with some other hardware, include a table or schematics with connection details._
56
57## Troubleshooting
58
59_If there are any likely 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._
60
61## Example Breakdown
62
63_If the example source code is lengthy, complex, or cannot be easily understood, use this section to break down and explain the source code. This can be done by breaking down the execution path step by step, or explaining what each major function/task/source file does. Add sub titles if necessary. Remove this section for very simple examples where the source code is self explanatory._