Project Template

Simple template for a project can be downloaded from a Git repository at https://github.com/realcharmer/capyboard-starter. It can be easily downloaded by using the following command:

git clone https://github.com/realcharmer/capyboard-starter

Download Zip

File structure

The starter template contains few configuration files and a sample "Hello World" source code.

platformio.ini

[env:esp32-s3-devkitc-1]
platform = espressif32
board = esp32-s3-devkitc-1
framework = arduino
board_build.partitions = partitions.csv
board_upload.flash_size = 4MB
monitor_speed = 115200

This is the configuration of the PlatformIO framework, such as the hardware platform and board specification. It also configures the board memory size.

partitions.csv

# Name,   Type, SubType,  Offset,   Size, Flags
nvs,      data, nvs,      0x9000,   0x5000,
otadata,  data, ota,      0xe000,   0x2000,
app0,     app,  ota_0,    0x10000,  0x200000,
spiffs,   data, spiffs,   0x210000, 0x1E0000,
coredump, data, coredump, 0x3F0000, 0x10000,

This file is needed for the prototype boards, since they are using only 4MB of flash. This results in issues with larger firmwares. It reconfigures the partition scheme of the entire flash memory to expand the space for the firmware itself. Sadly, this change disables OTA (Over-the-air) updates.

Makefile

PROJECT_DIR = $(CURDIR)
PLATFORMIO_BIN = /bin/pio

all: build upload

build:
    $(PLATFORMIO_BIN) run -d $(PROJECT_DIR)

upload:
    $(PLATFORMIO_BIN) run -d $(PROJECT_DIR) -t upload

clean:
    $(PLATFORMIO_BIN) run -d $(PROJECT_DIR) -t clean

monitor:
    $(PLATFORMIO_BIN) device monitor

.PHONY: all build upload clean monitor

The makefile is used to aid with PlatformIO commands. Instead of having to execute separate commands for building and uploading, the makefile provides a simple alternative. Refer to the Usage section for more information on how to use Make.

Source Code

All source code should be placed in the src directory, typically named main.ino. The starter template provides a very simple starting point. The program initializes serial communication and prints "Hello!" to the serial output. This can easily be expanded for further use.

void setup() {
    Serial.begin(115200);
}

void loop() {
    Serial.println("Hello!");
    delay(1000);
}