A Makefile for Arduino Sketches
This is a very simple Makefile which knows how to build Arduino sketches. It defines 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.
- Very robust
- Highly customizable
- Supports all official AVR-based Arduino boards
- Supports chipKIT
- Works on all three major OS (Mac, Linux, Windows)
- Auto detects serial baud rate and libraries used
- Support for
*.pdesketches as well as raw
- Support for Arduino Software versions 1.0.x as well as 0.x. Support for Arduino 1.5.x is still work in progress
- Automatic dependency tracking. Referred libraries are automatically included
in the build process. Changes in
*.hfiles lead to recompilation of sources which include them
If you're using FreeBSD, Debian or Ubuntu, you can find this in the
package and can be installed using
- Download the latest release
- Or clone it from Github using the command
git clone email@example.com:sudar/Arduino-Makefile.git
- Check the usage section in this readme about setting usage options
You need to have the Arduino IDE. You can either install it through the installer or download the distribution zip file and extract it.
The Makefile also delegates resetting the board to a short Python program.
You'll need to install
pySerial to use it though.
On Debian or Ubuntu:
apt-get install python-serial
yum install pyserial
zypper install python-serial
On Mac using MacPorts:
sudo port install py27-serial
pySerial can be downloaded from PyPi
On other systems:
pip install pyserial or easy_install -U pyserial
You can also find more detailed instructions in this guide.
You can also checkout the sample makefiles inside the
examples/ folder or take a look at a real Makefile-example.
Download a copy of this repo some where in your system or install it through a package.
On the Mac you might want to set:
ARDUINO_DIR = /Applications/Arduino.app/Contents/Resources/Java ARDMK_DIR = /usr/local AVR_TOOLS_DIR = /usr MONITOR_PORT = /dev/ttyACM0 BOARD_TAG = mega2560
On Linux (if you have installed through package), you shouldn't need to set anything other than your board type and port:
BOARD_TAG = mega2560 MONITOR_PORT = /dev/ttyACM0
On Windows (using cygwin), you might want to set:
ARDUINO_DIR = ../../arduino ARDMK_DIR = path/to/mkfile MONITOR_PORT = com3 BOARD_TAG = mega2560
BOARD_TAG- Type of board, for a list see boards.txt or
MONITOR_PORT- The port where your Arduino is plugged in, usually
/dev/ttyUSB0in Linux or Mac OS X and
com4, etc. in Windows.
ARDUINO_DIR- Path to Arduino installation. In Cygwin in Windows this path must be relative, not absolute (e.g. "../../arduino" and not "/c/cygwin/Arduino").
ARDMK_DIR- Path where the
*.mkare present. If you installed the package, then it is usually
AVR_TOOLS_DIR- Path where the avr tools chain binaries are present. If you are going to use the binaries that came with Arduino installation, then you don't have to set it.
The list of all variables that can be overridden is available at arduino-mk-vars.md file.
You can specify space separated list of libraries that are needed for your sketch to the variable
ARDUINO_LIBS = Wire SoftwareSerial
The libraries will be searched in the following places in the following order.
/librariesfolder inside your sketchbook folder. Sketchbook folder will be auto detected from your Arduino preference file. You can also manually set it through
/librariesfolder inside your Arduino folder, which is read from
The libraries inside user folder will take precedence over libraries present in Arduino core folder.
The makefile can autodetect the libraries that are included from your sketch and can include them automatically. But it can't detect libraries that are included from other libraries. (see issue #93)
To upload compiled files,
avrdude is used. This Makefile tries to find
avrdude and it's config (
ARDUINO_DIR. If you like to use the one installed on your system instead of the one which came with Arduino, you can try to set the variables
AVRDUDE_CONF. On a typical Linux system these could be set to
AVRDDUDE = /usr/bin/avrdude AVRDUDE_CONF = /etc/avrdude.conf
The current version of the makefile is
1.3.1. You can find the full history in the HISTORY.md file
This project adheres to Semantic Versioning 2.0.
This makefile and the related documentation and examples are free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
All contributions (even documentation) are welcome :) Open a pull request and I would be happy to merge them. Also checkout the contribution guide for more details.
If you are looking for ideas to work on, then check out the following TODO items or the issue tracker.
Limitations / Know Issues / TODO's
- Doesn't work with Arduino 1.5.x yet. Follow issue #45 for progress.
- Since it doesn't do any pre processing like Arduino IDE, you have to declare all methods before you use them (issue #59)
- More than one .ino or .pde file is not supported yet (issue #49)
- When you compile for the first time, it builds all libs inside Arduino directory even if it is not needed. But while linking only the relevant files are linked. (issue #29). Even Arduino IDE does the same thing though.
If you find an issue or have an idea for a feature then log them in the issue tracker
- 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.