|
| 1 | +| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 | |
| 2 | +| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- | |
| 3 | + |
| 4 | +# Hello World Example |
| 5 | + |
| 6 | +Starts a FreeRTOS task to print "Hello World". |
| 7 | + |
| 8 | +(See the README.md file in the upper level 'examples' directory for more information about examples.) |
| 9 | + |
| 10 | +## How to use example |
| 11 | + |
| 12 | +Follow detailed instructions provided specifically for this example. |
| 13 | + |
| 14 | +Select the instructions depending on Espressif chip installed on your development board: |
| 15 | + |
| 16 | +- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html) |
| 17 | +- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html) |
| 18 | + |
| 19 | + |
| 20 | +## Example folder contents |
| 21 | + |
| 22 | +The project **hello_world** contains one source file in C language [hello_world_main.c](main/hello_world_main.c). The file is located in folder [main](main). |
| 23 | + |
| 24 | +ESP-IDF projects are built using CMake. The project build configuration is contained in `CMakeLists.txt` files that provide set of directives and instructions describing the project's source files and targets (executable, library, or both). |
| 25 | + |
| 26 | +Below is short explanation of remaining files in the project folder. |
| 27 | + |
| 28 | +``` |
| 29 | +├── CMakeLists.txt |
| 30 | +├── pytest_hello_world.py Python script used for automated testing |
| 31 | +├── main |
| 32 | +│ ├── CMakeLists.txt |
| 33 | +│ └── hello_world_main.c |
| 34 | +└── README.md This is the file you are currently reading |
| 35 | +``` |
| 36 | + |
| 37 | +For more information on structure and contents of ESP-IDF projects, please refer to Section [Build System](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/build-system.html) of the ESP-IDF Programming Guide. |
| 38 | + |
| 39 | +## Troubleshooting |
| 40 | + |
| 41 | +* Program upload failure |
| 42 | + |
| 43 | + * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs. |
| 44 | + * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again. |
| 45 | + |
| 46 | +## Technical support and feedback |
| 47 | + |
| 48 | +Please use the following feedback channels: |
| 49 | + |
| 50 | +* For technical queries, go to the [esp32.com](https://esp32.com/) forum |
| 51 | +* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues) |
| 52 | + |
| 53 | +We will get back to you as soon as possible. |
0 commit comments