Skip to content

Commit 2a30ec0

Browse files
committed
docs(tutorials): add ESP32 tutorial
1 parent e44ad91 commit 2a30ec0

File tree

3 files changed

+77
-1
lines changed

3 files changed

+77
-1
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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/).

docs/get_started/tutorials/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,5 @@ Pick a tutorial based on your host platform and a development kit you want to us
1515

1616
- :fontawesome-brands-linux: Linux
1717
- [:fontawesome-solid-microchip: Raspberry Pi / Arduino devkit (raw SPI interface)](linux/arduino_rpi_shield.md)
18-
- [:fontawesome-brands-usb: USB devkit](linux/usb_devkit.md)
18+
- [:fontawesome-brands-usb: USB devkit](linux/usb_devkit.md)
19+
- [ESP32](esp32/index.md)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ nav:
6565
- Linux:
6666
- RPi / Arduino Devkit: get_started/tutorials/linux/arduino_rpi_shield.md
6767
- USB Devkit: get_started/tutorials/linux/usb_devkit.md
68+
- ESP32: get_started/tutorials/esp32/index.md
6869
- Libtropic Architecture: get_started/libtropic_architecture.md
6970
- Integrating Libtropic:
7071
- get_started/integrating_libtropic/index.md

0 commit comments

Comments
 (0)