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 PF1550, through the
host port host_pf1550_port.hpp. No hardware:
cmake -S examples/host -B build-example && cmake --build build-example && ./build-example/pf1550_host_example
The host tests build it with warnings as errors and run it (CTest pf1550_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_pf1550_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 |
|---|---|---|---|
pf1550_basic_example |
Start the PF1550, write the configuration, log the charger state and LDO1 once a second | pf1550_basic_example.cpp |
yes |
pf1550_interrupt_example |
Charge with the charger watchdog serviced every 10 s and react to INTB events | pf1550_interrupt_example.cpp |
yes |
Build and flash one (from examples/esp32, ESP-IDF environment loaded):
./scripts/build_app.sh pf1550_basic_example Release
./scripts/flash_app.sh flash_monitor pf1550_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 configuration with limits and every Result checked |
pf1550_basic_example.cpp |
| React to INTB and service the charger watchdog | pf1550_interrupt_example.cpp |
| Write an ESP-IDF port with STANDBY, INTB and the failure report | esp32_pf1550_port.hpp |
| Take the limits from menuconfig | pf1550_kconfig.hpp and _config/Kconfig |