dominic/Arduino-Makefile

Fork 0

Makefile for Arduino sketches. It defines the workflows for compiling code, flashing it to Arduino and even communicating through Serial. http://hardwarefun.com/tutorials/compiling-arduino-sketches-using-makefile

Find a file

Sudar 05b15fe67e Added ifndef ARDUINO_VAR_PATH for compiling for the attiny		2013-05-31 19:13:17 +05:30
arduino-mk	Added ifndef ARDUINO_VAR_PATH for compiling for the attiny	2013-05-31 19:13:17 +05:30
bin	Added a todo comment for package authors. Fixes #50	2013-05-31 16:57:25 +05:30
examples	removed unnecessary .DS_Store	2013-03-16 00:19:56 -07:00
.gitignore	allow user to choose source files	2012-07-06 15:02:43 +05:30
HISTORY.md	Added ifndef ARDUINO_VAR_PATH for compiling for the attiny	2013-05-31 19:13:17 +05:30
README.md	Added information about the changes that went in v0.10.4	2013-05-31 09:42:44 +05:30

README.md

A Makefile for Arduino Sketches

This is a very simple Makefile which knows how to build Arduino sketches. It defines the entire workflows for compiling code, flashing it to Arduino and even communicating through Serial monitor. You don't need to change anything in the Arduino sketches.

If you're using Debian or Ubuntu, you can find this in the arduino-mk package.

Credits

This makefile was originally created by Martin Oldfield and he maintained it till v0.10.2. From May 2013, it is maintained by Sudar

Usage

Download a copy of this repo some where in your system.

On the Mac you might want to set:

ARDUINO_DIR   = /Applications/Arduino.app/Contents/Resources/Java
ARDMK_DIR     = /usr/local

On Linux, you might prefer:

ARDUINO_DIR   = /usr/share/arduino
ARDMK_DIR     = /usr/local
AVR_TOOLS_DIR = /usr

The Makefile also delegates resetting the board to a short Perl program. You'll need to install Device::SerialPort to use it though. You'll also need the YAML library to run ard-parse-boards.

On Debian or Ubuntu:

   apt-get install libdevice-serialport-perl
   apt-get install libyaml-perl

On Fedora:

   yum install perl-Device-SerialPort
   yum install perl-YAML

On Mac using MacPorts:

   sudo port install p5-device-serialport
   sudo port install p5-YAML

  and use /opt/local/bin/perl5 instead of /usr/bin/perl

On other systems:

   cpanm Device::SerialPort
   cpanm YAML

User Libraries

In order to use Arduino libraries installed in the user's sketchbook folder (the standard location for custom libraries when using the Arduino IDE), you need to set the ARDUINO_SKETCHBOOK variable to point to this directory. By default it is set to $HOME/sketchbook.

Versioning

The current version of the makefile is 0.10.4. You can find the full history in the HISTORY.md file

This project adheres to Semantic Versioning 2.0.

Contribution

All contributions (even documentation) are welcome :) Open a pull request and I would be happy to merge them.

If you are looking for ideas to work on, then check out the following TODO items.

Know Issues / TODO's

Doesn't work with Leonardo yet. There are various fixes (#43, #37, #30) but need to verify them #44.
Doesn't work with Arduino 1.5.x yet.

If you find an issue or have an idea for a feature then log them at https://github.com/sudar/Arduino-Makefile/issues/

Similar works

It's not a derivative of this, but Alan Burlison has written a similar thing.
Alan's Makefile was used in a Pragmatic Programmer's article.
Rei Vilo wrote to tell me that he's using the Makefile ina Xcode 4 template called embedXcode. Apparently it supports many platforms and boards, including AVR-based Arduino, AVR-based Wiring, PIC32-based chipKIT, MSP430-based LaunchPad and ARM3-based Maple.