stephen/ota_template
1
0
Fork 0
Code Issues Pull Requests Actions Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
stephen
2025-07-17 17:39:47 -06:00
parent 27729f73d7
commit 0283d87aca
1 changed files with 24 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -25,7 +25,8 @@ A reusable template for ESP32-S3 projects featuring WiFi connectivity and Over-T
│ ├── wifi_manager.c/h # WiFi connection management │ ├── wifi_manager.c/h # WiFi connection management
│ ├── ota_server.c/h # OTA update server │ ├── ota_server.c/h # OTA update server
│ ├── led_strip.c/h # RGB LED driver │ ├── led_strip.c/h # RGB LED driver
│ └── CMakeLists.txt # Component configuration │ ├── CMakeLists.txt # Component configuration
| └── Kconfig.projbuild # To store wifi ssid and pass
├── partitions.csv # Flash partition table (4MB) ├── partitions.csv # Flash partition table (4MB)
├── sdkconfig # Project configuration (auto-generated) ├── sdkconfig # Project configuration (auto-generated)
├── .gitignore # Git ignore rules ├── .gitignore # Git ignore rules
@ -47,10 +48,29 @@ A reusable template for ESP32-S3 projects featuring WiFi connectivity and Over-T
git clone <your-repo-url> git clone <your-repo-url>
cd esp32-s3-template cd esp32-s3-template
# Edit WiFi credentials in main/main.c # Create the file main/Kconfig.projbuild
#define WIFI_SSID "YourWiFiNetwork" touch main/Kconfig.projbuild
#define WIFI_PASSWORD "YourPassword"
``` ```
Fill it in with the following:
```
menu "Wi-Fi Configuration"
config WIFI_SSID
string "WiFi SSID"
default ""
help
The SSID of the WiFi network.
config WIFI_PASSWORD
string "WiFi Password"
default ""
help
The password of the WiFi network.
endmenu
```
Then fill in your SSID and Password
A new project can be started with: A new project can be started with:
```bash ```bash
docker run --user $(id -u):$(id -g) --rm -v $PWD:/project -w /project -it espressif/idf:latest idf.py create-project <project-name> docker run --user $(id -u):$(id -g) --rm -v $PWD:/project -w /project -it espressif/idf:latest idf.py create-project <project-name>