Skip to content

ESP32 project template with build pipeline, enhanced VS Code support and more.

License

Notifications You must be signed in to change notification settings

gfurtadoalmeida/esp32-project-template

Repository files navigation

ESP32 - Project Template

GitHub Release Status Bugs Code Smells Security Rating Quality Gate Status

ESP32 project template with build pipeline, enhanced VS Code support and more.

Characteristics

  • ESP-IDF: v5.1
  • Written in C using just the ESP-IDF Framework.
  • GitHub Workflow with Sonar Cloud integration 🚀
  • VS Code tasks for tests (requires ESP-IDF extension): 🧪
    • Build test
    • Flash test
    • Monitor test
    • Build, flash and start a monitor for the tests
  • Newlib nano formatting enabled for printf/scanf, with the following advantages:
    • Binary size reduction (25KB~50KB) as they are already in ESP32 ROM.
    • Stack usage reduction for functions that call string formatting functions.
    • Increased performance as functions in ROM run faster than functions from flash.
    • Functions in ROM can run when flash instruction cache is disabled.
  • Configurable: with sample Kconfig file for component configuration through menuconfig.
  • Watchdogs disabled when testing.

Documentation

Everything is at the docs folder.

Contributing

To contribute to this project make sure to read our CONTRIBUTING.md file.