2. Build the firmware

You tell the project which board you have, then build the firmware for it. CrossPad keeps one configuration per board revision, so a bare idf.py build stops with an error on purpose: you always name the revision.

Your board is v2 if the PCB revision printed on its circuit board is r20. This page uses v2. Not sure? Plug the board in before step 2: idf.py board then reads the revision from the board itself.

Note

Board v1 (PCB r16 / r19)? Run idf.py board --set v1, then build with idf.py -B build_v1 -DSDKCONFIG=sdkconfig.v1 build (PowerShell: idf.py -B build_v1 "-DSDKCONFIG=sdkconfig.v1" build). Everything else is the same.

Used the one-line installer?

Skip step 1. crosspad-idf loads CrossPad’s ESP-IDF and runs idf.py in the project folder, so you can type it in any folder in place of idf.py:

Linux

crosspad-idf board --set v2
crosspad-idf -B build_v2 -DSDKCONFIG=sdkconfig.v2 build

macOS

crosspad-idf board --set v2
crosspad-idf -B build_v2 -DSDKCONFIG=sdkconfig.v2 build

Windows

crosspad-idf board --set v2
crosspad-idf -B build_v2 "-DSDKCONFIG=sdkconfig.v2" build

Linux

1. Go to the project and load ESP-IDF. Do this in every new terminal.

   cd ~/CrossPad
   unset IDF_PATH IDF_PYTHON_ENV_PATH
   PATH=$(printf %s "$PATH" | tr : '\n' | grep -v -e /.espressif/ -e /esp-idf | paste -sd: -)
   . "$CROSSPAD_IDF_DIR/export.sh"
   idf.py --version

   You should see: ESP-IDF v5.5.5

   If not: idf.py command not found

2. Choose the board revision, then show what the project remembers.

   idf.py board --set v2
   idf.py board

   You should see: v2 (explicit) from the first command. The second shows v2 (memory), or v2 (device …) when the board is plugged in.

   If not: idf.py board shows no board revision

3. Build the firmware. The first build downloads components and takes several minutes.

   idf.py -B build_v2 -DSDKCONFIG=sdkconfig.v2 build

   You should see: -- CrossPad board profile: v2 near the start, and Project build complete. To flash, run: at the end.

   If not: build stops before Project build complete

macOS

1. Go to the project and load ESP-IDF. Do this in every new terminal.

   cd ~/CrossPad
   unset IDF_PATH IDF_PYTHON_ENV_PATH
   PATH=$(printf %s "$PATH" | tr : '\n' | grep -v -e /.espressif/ -e /esp-idf | paste -sd: -)
   . "$CROSSPAD_IDF_DIR/export.sh"
   idf.py --version

   You should see: ESP-IDF v5.5.5

   If not: idf.py command not found

2. Choose the board revision, then show what the project remembers.

   idf.py board --set v2
   idf.py board

   You should see: v2 (explicit) from the first command. The second shows v2 (memory), or v2 (device …) when the board is plugged in.

   If not: idf.py board shows no board revision

3. Build the firmware. The first build downloads components and takes several minutes.

   idf.py -B build_v2 -DSDKCONFIG=sdkconfig.v2 build

   You should see: -- CrossPad board profile: v2 near the start, and Project build complete. To flash, run: at the end.

   If not: build stops before Project build complete

Windows

1. Go to the project and load ESP-IDF. Do this in every new PowerShell window.

   Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force
   $env:IDF_TOOLS_PATH = "C:\CrossPad\.espressif"
   Remove-Item Env:IDF_PATH, Env:IDF_PYTHON_ENV_PATH -ErrorAction SilentlyContinue
   $env:Path = ($env:Path -split ';' | Where-Object { $_ -notmatch '\\\.espressif\\|\\esp-idf' }) -join ';'
   . "$env:CROSSPAD_IDF_DIR\export.ps1"
   cd C:\CrossPad\firmware
   idf.py --version

   You should see: ESP-IDF v5.5.5

   If not: idf.py command not found

2. Choose the board revision, then show what the project remembers.

   idf.py board --set v2
   idf.py board

   You should see: v2 (explicit) from the first command. The second shows v2 (memory), or v2 (device …) when the board is plugged in.

   If not: idf.py board shows no board revision

3. Build the firmware. The first build downloads components and takes several minutes. PowerShell needs the quotes around the -D argument.

   idf.py -B build_v2 "-DSDKCONFIG=sdkconfig.v2" build

   You should see: -- CrossPad board profile: v2 near the start, and Project build complete. To flash, run: at the end.

   If not: build stops before Project build complete

Later, when you add or remove apps, rebuild from a clean build folder: Install and remove apps shows how.

Next: 3. Flash the board