Getting Started with the Arduboy Dev-Kit ๐Ÿ“„


(Ross) #1

Arduboy Dev-Kit Quick-start Guide

###:exclamation: This guide is outdated. Please see the Kickstarter Quick Start Guide for now.

This guide first explains how to install the Arduboy library for the Arduino IDE using Github. The last section has instructions for running an example sketch from the library on an Arduboy.

Github

The source for the Arduboy library is hosted on Github. If you are new to Github try their Hello World tutorial.

Respository

Requirements

First make sure all of the requirements listed in this section are met.

Arduino IDE

In this guide we will be using the Arduino IDE.

Installing
Use Arduinoโ€™s getting started guide to install the Arduino IDE. The installer will also install the necessary driver files.

Git

Having git installed is not essential to using the Arduboy, but it is used in this guide. Instructions for not using git and instead using a zip file are also given.

Installing
Please see this install guide for git.

Arduboy Library Installation

Plug in Your Arduboy

Once the Arduino IDE is installed, connect the Arduboy to your computer using a mirco-usb cable.
####Does your OS recognize the Arduboy?

Windows

If you look in the Windows Device Manager you should see listed under the Ports section an Arduino Leonardo board followed by a COM port.

If your unit is not recognized, stop and make sure your OS sees the Arduboy. If the Arduboy is found, continue installing the library.

Library Installation

For more detailed instructions see: Installing Additional Arduino Libraries.

Prepare

We will install the Arduboy Library in a place where the Arduino IDE will always know where to find it. The examples below assume you are using a command prompt like a terminal emulator, or in Windows: Powershell or CMD.

Start

First navigate to the Arduino library folder. For each OS, this location is different. These examples use cd from the command line to change your working directory. The > (windows) and $ (unix-like) characters are used to alert you of the fact the commands are to be entered at a command line.

Windows
> cd C:\Users\user\Documents\Arduino\libraries
Linux
$ cd /home/user/Documents/Arduino/libraries/
Mac
$ cd /Users/user/Documents/Arduino/libraries/

Finish

After you have changed your current working directory to the Arduino libraries folder, clone the Arduboy Github repository.*

$ git clone https://github.com/Arduboy/Arduboy.git

*If you are not using git, download the library as a zip file and import it into the Arduino IDE by selecting Sketch > Include Library > Add .ZIP Library... from the IDE menu.

The Arduboy library is now installed and is available to be included in the source you write and compile in the Arduino IDE.

Uploading a Sketch/Game

The process for uploading a sketch is nearly identical for Windows, Linux and Mac.

Open an Example Sketch

Start the Arduino IDE. Examples for the installed libraries can be found by going to the File menu and looking through the Examples sub-menu. User contributed libraries will be at the bottom. For example, to load Floaty Ball, select File > Examples > Arduboy > Floaty Ball.

Select the Leonardo Board and a COM port

  • From the Arduino IDE menu select Tools > Board > Arduino Leonardo.

  • Select the appropriate COM from Tools > Com.

Uploading

In the upper left corner of the Arduino IDE are two buttons used to verify (compile) and upload code to the Arduboy.

To upload a game:

  • Verify the sketch.

  • Upload the sketch.

You are now ready to play!


Downloading Games
I need some help on the basics
$12 Arduboy compatible system
Little Rook Chess on an Arduboy DevKit
Libraries for Arduboy
Getting Started: Development Unit
(Jรฉrรดme (Initgraph)) #6

Thank you for the new game : Floaty Ball
:slight_smile:


(Ross) #8

(Ross) #9