Motivation

Using the ctag-tbd for playing back samples is a wonderful thing. Memory for samples is sadly limited by the overall ROM of the ESP32 and also the size of the ctag-tbd firmware. The tbd-cloud-compiler allows users to reduce the size of the ctag-tbd firmware, therefore making up more free space for samples, by removing one or multiple individual apps that they do not want to use with their module.

Usage

The tbd-cloud-compiler tries to make it as easy as possible for the user to free up more space for samples. Following these steps should guide you through the process of generating your own custom tbd firmware:

1. If you don’t already own a GitHub account go and create one. It is fully free and should be fairly easy.
2. Create a fork of the ctag-tbd repository by clicking on the corresponding button on the top right.
3. Make sure GitHub Actions are activated for your fork by going to the corresponding tab at your fork and clicking on the green button.
4. Generate an OAuth-Token for your account that will allow you to trigger workflows for your repositories.
5. Open the tbd-cloud-compiler, select the apps you want to include in your firmware and enter the url of your ctag-tbd fork and the OAuth token.
6. Click on compile firmware and download it once the job has finished.
7. Flash the firmware to your ctag-tbd and enjoy your newly acquired memory for samples. Make sure to flash the firmware via USB using ESP Tool. Your download should contain a flash script you can run from the downloaded directory with sh ./flash.sh [ESP_TOOL_PATH] [PORT]. This is necessary because bootloader and the overall memory partition also need to be updated which is not possible via the web ui.