Skip to content

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 AT25040B, through the host port host_at25040b_port.hpp. No hardware:

cmake -S examples/host -B build-example && cmake --build build-example && ./build-example/at25040b_host_example

The host tests build it with warnings as errors and run it (CTest at25040b_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_at25040b_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
at25040b_basic_example Check the AT25040B, read the first bytes, count boots in the last page, probe once a second at25040b_basic_example.cpp yes

Build and flash one (from examples/esp32, ESP-IDF environment loaded):

./scripts/build_app.sh at25040b_basic_example Release
./scripts/flash_app.sh flash_monitor at25040b_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, a read, a verified write and a probe on every loop at25040b_basic_example.cpp
Write an ESP-IDF port, WP on a GPIO esp32_at25040b_port.hpp
Use menuconfig values at25040b_kconfig.hpp and _config/Kconfig