Setup Environment

This page assumes you have already installed the Arduino IDE on your computer and have successfully uploaded an Arduino sketch to the development board you're attempting to add to WipperSnapper.

WipperSnapper is distributed as an Arduino Library. This page will take you through the process of installing a fork of the WipperSnapper library on your computer so you can modify its detection code to add a new board.

Find Sketchbook Library Folder

On Linux machines, the folder is named "Sketchbook" and it is typically located in /home/

On Windows and Macintosh machines, the default name of the folder is "Arduino" and is located in your Documents folder.

Once you've located this folder, make a note of its location and continue with the steps below.

Fork and Clone WipperSnapper to the Arduino Sketchbook Library Folder

Create a fork of Adafruit_WipperSnapper_Arduino on your GitHub account.

On your computer, navigate to the Arduino Library Sketchbook Folder and locally clone your fork (Note - this guide uses the adafruit repository for WipperSnapper Arduino in the command below, so change adafruit to your GitHub username).

git clone [email protected]:adafruit/Adafruit_Wippersnapper_Arduino.git

Install Arduino-CLI

Install arduino-cli on your computer by following the step-by-step instructions on this page.

Install CI-Arduino

WipperSnapper utilizes a build script within the Adafruit/CI-Arduino repository, build_platforms.py, to install library dependencies and compile WipperSnapper for a specific platform.

First, create a fork of ci-arduino on your GitHub Account

Then, locally clone your fork to your computer using the command below (Note - we're using the adafruit repository in the command below, so change adafruit to match your GitHub username).

git clone [email protected]:adafruit/ci-arduino.git

Initial Build

Verify that all the steps above work properly by building WipperSnapper for an already-supported development board.

From the Arduino Library Sketchbook folder, navigate to the WipperSnapper folder you created above.

Next, check out the main branch to make sure you're building from the latest code.

# Build using the latest code on the main branch.
git checkout main

To build WipperSnapper, call the build_platform.py script from the root of Adafruit_WipperSnapper_Arduino. You'll need to provide the script with the board you're compiling the library for.

This guide uses the Adafruit Feather ESP32-S3 as an example, so you'll attempt to build WipperSnapper using the next closest board - the feather_esp32s2.

python3 /Users/brent/Desktop/github/ci-arduino/build_platform.py feather_esp32s2

The script should first install all the required dependencies to build the WipperSnapper library.

Then, it will compile the WipperSnapper_demo.ino sketch for the listed platform.

Once the script completes, it'll give you a location for you to find the compiled binaries.

In this example, these files are located within the directory Adafruit_Wippersnapper_Arduino/examples/Wippersnapper_demo/build/esp32.esp32.adafruit_feather_esp32s2/

Now that you've successfully set up and tested the WipperSnapper build environment, let's make some modifications to WipperSnapper to detect your board.

This guide was first published on May 04, 2022. It was last updated on 2022-05-04 10:39:33 -0400.

This page (Build WipperSnapper) was last updated on May 19, 2022.

Text editor powered by tinymce.