[Tutorial] [Outdated] Just starting out? Let's configure your environment!

OK everyone - I had a bit of an adventure this morning figuring out how to begin.

Searching the forums solved almost all of my issues, but I figured that bringing them together in one place would be helpful to new users. Especially for newbies like me, who haven’t even used an Arduino before!

I’ll be assuming that you’re using Windows 8.1 for the purpose of this tutorial. I’ll be setting this up on Mac OS X as well, so I’ll update this when I’ve got those instructions.

So - just got your new Arduboy in the mail?

Windows 8.1

Step 1. Visit https://www.arduino.cc/en/Main/Software and download the Windows installer. This is your Arduino development environment. Once it’s downloaded, run it and install it, keeping all of the defaults.

Step 2. Plug in your Arduboy to the PC. You should see the following appear in your Device Manager:

Remember “Arduino Leonardo” - that’s technically what type of board you’re using, behind the scenes. Make a note of what COM port your Arduboy shows up under.

Step 3. Visit the Arduboy Github page (https://github.com/Arduboy/Arduboy), and click the “Download” button on the righthand side of the page. Copy this ZIP file to wherever you like - I put in mine in C:\

Step 4. Unzip the ZIP file, but leave your ZIP file where it is. Open the Arduino IDE.

Step 5. Go to Tools->Board->Arduino Leonardo. Right below that, go to Port-> and select the Port that you remembered before, from the device manager.

Step 6. Now we’ll need to let the Arduino IDE know where our Arduboy library files are. Under Sketch->Include Library…->Add .ZIP Library, navigate to where you saved your ZIP file and double click it. To verify that this step worked, make sure that you see “Arduboy” under ‘Contributed Libraries’ in the Sketch->Include Library list. It will usually appear at the bottom.

Step 7. Now navigate to wherever you saved your ZIP file to, and go to the unzipped copy. Navigate to the ‘examples’ directory, and open one of the example .ino files. It’ll open in it’s own window. Test your installation and configuration by going to Sketch->Verify/Compile.

Step 8. If, when compiling, you see this error, go back to step 5 and make sure you selected “Arduino Leonardo”

Step 9. If all goes well, then go to Sketch->Upload, and watch the magic happen!

Mac OS X

OK, so I’ve tested this process on Mac OS 10.11 El Capitan, so if you’re using a more recent version of the OS, you’re likely in good shape. Note that the Arduino application only works on Mac OS 10.7 or later!

Otherwise, the steps are very similar…

Step 1. Visit https://www.arduino.cc/en/Main/Software and download the Mac OS archive. This is your Arduino development environment. Once it’s downloaded, run it. It will simply open, no installation needed. I suggest dragging it to your Applications folder!

Step 2. Visit the Arduboy Github page (https://github.com/Arduboy/Arduboy), and click the “Download” button on the righthand side of the page. Copy this ZIP file to wherever you like - I put in mine in ~/Documents/Arduino, but it really doesn’t matter.

Step 3. Unzip the ZIP file, but leave your ZIP file where it is. Open the Arduino IDE.

Step 4. Go to Tools->Board->Arduino Leonardo.

Step 5. Now we’ll need to let the Arduino IDE know where our Arduboy library files are. Under Sketch->Include Library…->Add .ZIP Library, navigate to where you saved your ZIP file and double click it. To verify that this step worked, make sure that you see “Arduboy” under ‘Contributed Libraries’ in the Sketch->Include Library list. It will usually appear at the bottom.

Step 6. Let’s plug your Arduboy in. Once you do this, Mac OS X will inform you about a new keyboard being connected. Cancel out of the window. Go back to your IDE and check under the Tools->Port menu. See below:

As soon as I plugged the Arduboy in, the Arduino IDE picked up on it and added it under the Port menu. No need to do any configuration for that to happen!

Step 7. Now navigate to wherever you saved your ZIP file to, and go to the unzipped copy. Navigate to the ‘examples’ directory, and open one of the example .ino files. It’ll open in it’s own window. Test your installation and configuration by going to Sketch->Verify/Compile.

Step 8. If all goes well, then go to Sketch->Upload!

3 Likes

Thanks for this :smiley: I’ll be getting my devkit soon and am also completely new to Arduino, this will sure help me get started in no time!

Thanks DSS, if something doesn’t make sense, or something weird happens, let me know!

I just added instructions for Mac OS X El Capitan. I hope this helps!

Wow it looks like your awesome tutorial was covered in this awesome youtube video! Awesome! https://www.youtube.com/watch?v=oJjc_ZxWbeo