mcuw / ESP32-ghbuild-tdisplays3-amoled

ESP32 T-Display S3 Amoled template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

ESP32 T-Display S3 AMOLED project template

Description

This is a project template to create microcontroller apps with automatized firmware builds for esp32, esp32s2 and esp32s3 microcontroller boards. It uses for that GitHub Actions and platformio.

Requirements

GitHub Actions - Workflow

The release build happens in the build & release workflow: build_release.yml. It creates a release, after creation of a new git tag (named it like v1.0.0).

If you want to test the build on all merge w/o creating a tag then the build workflow is what you looking for: build.yml

PlatformIO

PlatformIO is a tool to create microcontroller apps for arduino platforms and compatibles (esp32). You can install the Visual Studio Code extension in the Visual Studio Code IDE.

Python

There is a tiny python script needed to customize the firmware filenames within platformio, see documentation: https://docs.platformio.org/en/stable/scripting/examples/custom_program_name.html

The extra_script.py script gets the platformio env (e.g. lolin32) and the git-tag for the firmware filename. This is required to publish several firmware names in the github artifacts of a release.

CHANGELOG

You can write your changes in the CHANGELOG.md before you create a release. It will be shown under the release page.

Example Release

see Releases on the right sidemenu.

Usage

Use this repository as a template for your own esp32 repository. You can reduce and adapt your required boards in the platformio.ini. Update the CHANGELOG.md file before you are creating a new release. When you create a new git tag then a new release will always includes generated firmwares.


Disclaimer

Contribution and help ... if you find an issue or wants to contribute then please do not hesitate to create a merge request or an issue.

We provide our build template as is, and we make no promises or guarantees about this code.

About

ESP32 T-Display S3 Amoled template

License:MIT License


Languages

Language:C 95.5%Language:C++ 4.4%Language:Processing 0.1%Language:Python 0.0%Language:CMake 0.0%