/gh-esp-test-template

ESP Project Testing Template (CI Project Template/Demo)

Primary LanguageCCreative Commons Zero v1.0 UniversalCC0-1.0

ESP-IDF Project Template with CI, Wokwi Simulation, and Hardware Testing

This is a template project to be used as a reference for ESP-IDF projects with GitHub CI.

GitHub Workflow Status

The purpose of this project is to provide a good starting point for customers who are developing an application based on Espressif chips and want to run unit or integration tests both in simulation and on real hardware.

You can fork and update this project according to your specific needs.

Note: As default, the hardware testing job is disabled. To enable it, please see the How to setup (HW) documents.

How to setup (Wokwi simulation)

Go to the Wokwi CI Dashboard and create a new CI token. Then add the token to your GitHub repository secrets as WOKWI_CLI_TOKEN (under "Settings" -> "Secrets and Variables" -> "Actions" -> "Repository secrets").

You can also run the tests locally. For more information, please refer to the Wokwi CI documentation.

How to setup (HW)

License

The content of this repository is released into the public domain, or CC0 licensed, at your option.