https://github.com/bschwind/esp32-template
A github template for starting projects based on the ESP-IDF.
https://github.com/bschwind/esp32-template
Last synced: about 1 year ago
JSON representation
A github template for starting projects based on the ESP-IDF.
- Host: GitHub
- URL: https://github.com/bschwind/esp32-template
- Owner: bschwind
- Created: 2022-04-17T12:23:00.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-17T13:08:58.000Z (about 4 years ago)
- Last Synced: 2025-03-20T17:51:46.264Z (about 1 year ago)
- Language: Makefile
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# esp32-template
A github template for starting projects based on the ESP-IDF.
## Clone
* Use the `--recursive` flag when cloning to pick up the ESP-IDF
## Dependencies
* ESP-IDF Tools
* `cd esp-idf`
* `export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets"`
* `./install.sh`
## Configure
```bash
$ make menuconfig
```
or
```bash
$ idf.py menuconfig
```
## Build
```bash
$ make -j8 # Or pick your favorite parallel number
```
or
```bash
$ idf.py build
```
## Run (and see serial output)
```bash
$ make -j8 flash monitor
```
or
```bash
$ idf.py flash monitor
```
## Monitor Serial Output
```bash
$ make monitor
```
or
```bash
$ idf.py monitor
```
Exit with `Ctrl + ]`.
## Erase Flash
```bash
$ make erase_flash
```
or
```bash
$ idf.py erase-flash
```
## Code Format
-----------
`clang-format` is used for code formatting.
```bash
$ make format
```