diff options
| author | Patrick | 2023-07-13 13:44:26 +0200 |
|---|---|---|
| committer | Patrick | 2023-07-13 13:44:26 +0200 |
| commit | 10325eaf40c80eb91f1c1eceea880c3abd54efd7 (patch) | |
| tree | e160ff671e0b4404148b0e389e3d630b62fc191e /esp32/esp_project/README.md | |
| parent | 6646bd126f9faf1e687b203512d29da243acaa90 (diff) | |
| download | matrix_esp_thesis-10325eaf40c80eb91f1c1eceea880c3abd54efd7.tar.gz matrix_esp_thesis-10325eaf40c80eb91f1c1eceea880c3abd54efd7.zip | |
added esp project
Diffstat (limited to 'esp32/esp_project/README.md')
| -rw-r--r-- | esp32/esp_project/README.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/esp32/esp_project/README.md b/esp32/esp_project/README.md new file mode 100644 index 0000000..079f444 --- /dev/null +++ b/esp32/esp_project/README.md @@ -0,0 +1,53 @@ +| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-C6 | ESP32-H2 | ESP32-S2 | ESP32-S3 |
+| ----------------- | ----- | -------- | -------- | -------- | -------- | -------- | -------- |
+
+# Hello World Example
+
+Starts a FreeRTOS task to print "Hello World".
+
+(See the README.md file in the upper level 'examples' directory for more information about examples.)
+
+## How to use example
+
+Follow detailed instructions provided specifically for this example.
+
+Select the instructions depending on Espressif chip installed on your development board:
+
+- [ESP32 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/stable/get-started/index.html)
+- [ESP32-S2 Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s2/get-started/index.html)
+
+
+## Example folder contents
+
+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).
+
+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).
+
+Below is short explanation of remaining files in the project folder.
+
+```
+├── CMakeLists.txt
+├── pytest_hello_world.py Python script used for automated testing
+├── main
+│ ├── CMakeLists.txt
+│ └── hello_world_main.c
+└── README.md This is the file you are currently reading
+```
+
+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.
+
+## Troubleshooting
+
+* Program upload failure
+
+ * Hardware connection is not correct: run `idf.py -p PORT monitor`, and reboot your board to see if there are any output logs.
+ * The baud rate for downloading is too high: lower your baud rate in the `menuconfig` menu, and try again.
+
+## Technical support and feedback
+
+Please use the following feedback channels:
+
+* For technical queries, go to the [esp32.com](https://esp32.com/) forum
+* For a feature request or bug report, create a [GitHub issue](https://github.com/espressif/esp-idf/issues)
+
+We will get back to you as soon as possible.
|