|
| 1 | +# ESP32 Tutorial |
| 2 | +This tutorial will guide you through the building of the examples in the `examples/esp32/` directory. In this directory, there are multiple subdirectories for each supported ESP32 board. Instructions in this tutorial are common for all of the boards. |
| 3 | + |
| 4 | +## Install Dependencies and Prepare the Repository |
| 5 | +See below for instructions based on your OS. |
| 6 | + |
| 7 | +!!! example "Installation instructions" |
| 8 | + === ":fontawesome-brands-linux: Linux" |
| 9 | + 1. Setup ESP-IDF and its dependencies: |
| 10 | + - Complete the first 4 steps in the [official ESP-IDF setup guide](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html). |
| 11 | + - We recommend getting the 5.5.1 version, but any 5.x.x version should work. |
| 12 | + 2. Get the Libtropic repository: |
| 13 | + - Using git: `git clone https://github.com/tropicsquare/libtropic.git` |
| 14 | + - Or you can download the [latest release](https://github.com/tropicsquare/libtropic/releases/latest). |
| 15 | + |
| 16 | + === ":fontawesome-brands-apple: macOS" |
| 17 | + TBA |
| 18 | + |
| 19 | + === ":fontawesome-brands-windows: Windows" |
| 20 | + TBA |
| 21 | + |
| 22 | +## Start with our Examples! |
| 23 | +Now, let's build and flash the available examples. |
| 24 | + |
| 25 | +### Build and Run Hello World Example |
| 26 | +!!! example "Building and running the Hello World example" |
| 27 | + === ":fontawesome-brands-linux: Linux" |
| 28 | + ```bash |
| 29 | + cd examples/esp32/<your_board>/hello_world/ |
| 30 | + idf.py build flash monitor |
| 31 | + ``` |
| 32 | + |
| 33 | + === ":fontawesome-brands-apple: macOS" |
| 34 | + TBA |
| 35 | + |
| 36 | + === ":fontawesome-brands-windows: Windows" |
| 37 | + TBA |
| 38 | + |
| 39 | +After this, you should see a colored output in your terminal. |
| 40 | + |
| 41 | +### Build and Run Chip Identification Example |
| 42 | +!!! example "Building and running the Identify Chip example" |
| 43 | + === ":fontawesome-brands-linux: Linux" |
| 44 | + ```bash |
| 45 | + cd examples/esp32/<your_board>/identify_chip/ |
| 46 | + idf.py build flash monitor |
| 47 | + ``` |
| 48 | + |
| 49 | + === ":fontawesome-brands-apple: macOS" |
| 50 | + TBA |
| 51 | + |
| 52 | + === ":fontawesome-brands-windows: Windows" |
| 53 | + TBA |
| 54 | + |
| 55 | +After this, you should see a colored output in your terminal. |
| 56 | + |
| 57 | +### Build and Run an Firmware Update Example |
| 58 | +!!! example "Building and running the Identify Chip example" |
| 59 | + === ":fontawesome-brands-linux: Linux" |
| 60 | + ```bash |
| 61 | + cd examples/esp32/<your_board>/fw_update/ |
| 62 | + idf.py build flash monitor |
| 63 | + ``` |
| 64 | + |
| 65 | + === ":fontawesome-brands-apple: macOS" |
| 66 | + TBA |
| 67 | + |
| 68 | + === ":fontawesome-brands-windows: Windows" |
| 69 | + TBA |
| 70 | + |
| 71 | +After this, you should see a colored output in your terminal. |
| 72 | + |
| 73 | +## FAQ |
| 74 | +If you encounter any issues, please check the [FAQ](../../../faq.md) before filing an issue or reaching out to our [support](https://support.desk.tropicsquare.com/). |
0 commit comments