Skip to main content

Setting up Arduino IDE for development with Stepdance board

In this class we will be programming a Teensy 4.1 microcontroller, using the Stepdance Software Library -- a library that we in the Expressive Computation Lab are actively developing!

This guide will walk you through the steps to get your laptop ready for development. Please try to complete the following steps before the first class, we will be expecting everyone to be able to program their board during the first week. Instructors will be present to help resolve any issues with these steps during class.

A. Install Arduino IDE + Teensy Support​

  • Install the Arduino IDE plus Teensy board support (Teensyduino) following the PJRC tutorial: https://www.pjrc.com/teensy/tutorial.html
  • Install ArduinoJson: in Arduino IDE click through the menu Sketch > Include Library > Manage Libraries, search for "ArduinoJson" (ensure you choose ArduinoJson and NOT Arduino_JSON) and click Install.

B. Install Stepdance library​

Because we are actively developing Stepdance, we prefer folks installing it by pulling from the Github repository, as it allows us to easily push fixes if needed. The instructors may tell you sometimes "pull latest changes", and you will greatly appreciate having a quick way to do so, trust me :)

If that option isn't working for you, please reach out and we will help you or work out an alternative on a need basis!

info

Note that git can be used either on the command line or through a desktop app like Github Desktop, and will be required anyways to push your documentation files. If you have never setup git before, you may find these resources helpful: https://docs.github.com/en/get-started

  • Clone the Stepdance repository:
git clone git@github.com:imoyer/stepdance.git
  • Find your Arduino Sketchbook location path through the Arduino IDE: File > Preferences > Sketchbook location or Arduino IDE > Settings > Sketchbook location. Copy that path.
  • Install the Stepdance library to Arduino IDE by creating a symbolic link between the repository and the Arduino library folder:
On Mac/Linux
# 1. Go to the Arduino libraries folder (from previous step)
# The Arduino folder is typically something like /Users/username/Documents/Arduino but may vary
cd <Arduino folder on your laptop>/libaries
# 2. Create the symbolic link
ln -s <folder where you cloned the stepdance repo>/lib stepdance
On Windows (Powershell)
# Open Powershell in admin mode (Right click Powershell app > Run as Administrator)

# 1. Go to the Arduino libraries folder (from previous step)
# The Arduino folder is typically something like C:\Users\username\Documents\Arduino but may vary
cd <Arduino folder on your laptop>\libaries
# 2. Create the symbolic link
New-Item -ItemType SymbolicLink -Path stepdance -Target <folder where you cloned the stepdance repo>\lib
  • Restart Arduino IDE
  • You should now be able to see the Stepdance library examples show up in File > Examples > stepdance (you may have to scroll down all the way to the end of that menu, under Examples from custom libraries)