Examples¶
One folder per platform under examples/, each with its own port, built by CI on every pull request. The driver
itself has no platform code; Platforms lists what exists.
Host¶
examples/host/ runs the driver on any PC against a simulated display controller,
through the host port host_isf15acp4_port.hpp. No hardware:
cmake -S examples/host -B build-example && cmake --build build-example && ./build-example/isf15acp4_host_example
The host tests build it with warnings as errors and run it (CTest isf15acp4_host_example).
ESP32¶
ESP-IDF applications that run the driver on an ESP32-C6 DevKitC-1; the wiring is in the
example folder's README and the port in
esp32_isf15acp4_port.hpp. The project points
EXTRA_COMPONENT_DIRS at the repository root, which is the driver's ESP-IDF component.
The apps¶
| App | What it shows | Source | CI |
|---|---|---|---|
isf15acp4_basic_example |
Start the ISF15ACP4 from menuconfig values, draw a test picture and follow the button | isf15acp4_basic_example.cpp |
yes |
Build and flash one (from examples/esp32, ESP-IDF environment loaded):
./scripts/build_app.sh isf15acp4_basic_example Release
./scripts/flash_app.sh flash_monitor isf15acp4_basic_example Release
Source of this table: examples/esp32/app_config.yml.
Set up once¶
git submodule update --init examples/esp32/scripts # the ESP-IDF build scripts
cd examples/esp32
. $IDF_PATH/export.sh # ESP-IDF v5.5
./scripts/build_app.sh list # every app and build type
The scripts read app_config.yml (the same file this page's table comes
from) and build each app as its own firmware image.
What to read in an example¶
| You want to | Read |
|---|---|
| See the lifecycle, the drawing calls and the button loop | isf15acp4_basic_example.cpp |
| Write an ESP-IDF port (write-only bus, D/C#, RES#, supply enable, switch) | esp32_isf15acp4_port.hpp |
| Use menuconfig values | isf15acp4_kconfig.hpp and _config/Kconfig |