30
30
# This is a general purpose makefile for use with Arduino hardware and
 
31
 
# software.  It is intended to be a drop-in replacement for the Arduino IDE's
 
32
 
# build system.  It works with the Arduino 1.0 and 1.5 software releases, on
 
33
 
# GNU/Linux and OS X.  To download the latest version of this makefile visit
 
34
 
# the following website where you can also find documentation on it's use.
 
35
 
# (The following text can only really be considered a reference.)
 
 
31
# software.  It works with the arduino-1.0 and later software releases.  It
 
 
32
# should work GNU/Linux and OS X.  To download the latest version of this
 
 
33
# makefile visit the following website where you can also find documentation on
 
 
34
# it's use.  (The following text can only really be considered a reference.)
 
37
36
#   http://ed.am/dev/make/arduino-mk
 
39
 
# To use this makefile, copy arduino.mk in to your project directory.  Or, you
 
40
 
# could save it somewhere (I keep mine at ~/src/arduino.mk) and create a
 
41
 
# symlink to it in your project directory, named "Makefile".  For example:
 
 
38
# This makefile can be used as a drop-in replacement for the Arduino IDE's
 
 
39
# build system.  To use it, just copy arduino.mk in to your project directory.
 
 
40
# Or, you could save it somewhere (I keep mine at ~/src/arduino.mk) and create
 
 
41
# a symlink to it in your project directory, named "Makefile".  For example:
 
43
43
#   $ ln -s ~/src/arduino.mk Makefile
 
45
 
# The Arduino software (version 1.0 or later, including the new 1.5 BETA) is
 
46
 
# required.  On GNU/Linux you can probably install the software from your
 
47
 
# package manager.  If you are using Debian (or a derivative), try `apt-get
 
48
 
# install arduino`.  Otherwise, you can download the Arduino software manually
 
49
 
# from http://arduino.cc/.  It is suggested that you install it at
 
50
 
# ~/opt/arduino (or /Applications on OS X) if you are unsure.
 
 
45
# The Arduino software (version 1.0 or later) is required.  On GNU/Linux you
 
 
46
# can probably install the software from your package manager.  If you are
 
 
47
# using Debian (or a derivative), try `apt-get install arduino`.  Otherwise,
 
 
48
# you can download the Arduino software manually from http://arduino.cc/.  It
 
 
49
# is suggested that you install it at ~/opt/arduino (or /Applications on OS X)
 
52
52
# If you downloaded the Arduino software manually and unpacked it somewhere
 
53
 
# *other* than ~/opt/arduino (or /Applications), you will need to set up the
 
54
 
# ARDUINODIR environment variable to be the directory where you unpacked it.
 
55
 
# (If unset, ARDUINODIR defaults to some sensible places).  You could set this
 
56
 
# in your ~/.profile by adding something like this:
 
 
53
# other than ~/opt/arduino (or /Applications), you will need to set up the
 
 
54
# ARDUINODIR environment variable to be the path where you unpacked it.  (If
 
 
55
# unset, ARDUINODIR defaults to some sensible places).  You could set this in
 
 
56
# your ~/.profile by adding something like this:
 
58
 
#   export ARDUINODIR=~/somewhere/arduino-1.0.5
 
 
58
#   export ARDUINODIR=~/somewhere/arduino-1.0
 
60
60
# For each project, you will also need to set BOARD to the type of Arduino
 
61
61
# you're building for.  Type `make boards` for a list of acceptable values.
 
64
64
#   $ export BOARD=uno
 
66
 
# Note that if you're using the newer 1.5 Arduino software and the board you
 
67
 
# want to use is availble with different processors, you will also need to
 
68
 
# specify one.  For example:
 
70
 
#   $ export BOARD=mini.atmega328
 
72
 
# You may also need to set SERIALDEV if your Arduino is not detected correctly.
 
 
67
# You may also need to set SERIALDEV if it is not detected correctly.
 
74
69
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
 
75
 
# determine values for SOURCES, TARGET and which libraries to pull-in to the
 
76
 
# build (although you can still override thius by setting LIBRARIES).  Any .c,
 
77
 
# .cc and .cpp files in the project directory (or any "util" or "utility"
 
78
 
# subdirectories) are automatically included in the build and are scanned for
 
79
 
# Arduino libraries that have been #included.  Note, there can only be one .ino
 
80
 
# (or .pde) file in a project directory and if you want to be compatible with
 
81
 
# the Arduino IDE, it should be called the same as the directory name.
 
 
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
 
71
# files in the project directory (or any "util" or "utility" subdirectories)
 
 
72
# are automatically included in the build and are scanned for Arduino libraries
 
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file in
 
 
74
# a project directory and if you want to be compatible with the Arduino IDE, it
 
 
75
# should be called the same as the directory name.
 
83
77
# Alternatively, if you want to manually specify build variables, create a
 
84
78
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
 
85
 
# (You don't need to define TARGET).  You can also specify the BOARD here, if
 
 
79
# (There is no need to define TARGET).  You can also specify the BOARD here, if
 
86
80
# the project has a specific one.  Here is an example Makefile:
 
88
82
#   SOURCES := main.cc other.cc
 
 
166
159
#_______________________________________________________________________________
 
169
 
# default arduino software directory
 
 
162
# default arduino software directory, check software exists
 
170
163
ifndef ARDUINODIR
 
171
164
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
 
172
165
        /Applications/Arduino.app/Contents/Resources/Java \
 
173
166
        $(HOME)/Applications/Arduino.app/Contents/Resources/Java))
 
176
 
# check ARDUINODIR (and determine which backends are available)
 
177
 
ifneq "" "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)"
 
179
 
else ifneq "" "$(wildcard $(ARDUINODIR)/hardware/arduino/avr/boards.txt)"
 
180
 
ARDUINOBACKENDS := /avr /sam
 
 
168
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
182
169
$(error ARDUINODIR is not set correctly; arduino software not found)
 
 
172
# default arduino version
 
 
175
# default path for avr tools
 
 
176
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
 
 
177
        $(ARDUINODIR)/hardware/tools/avr/bin
 
 
179
# default path to find libraries
 
 
180
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
 
 
182
# default serial device to a poor guess (something that might be an arduino)
 
 
185
SERIALDEV := $(firstword $(wildcard \
 
 
186
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
 
187
192
ifneq "$(MAKECMDGOALS)" "boards"
 
 
194
 
# obtain board parameters from the arduino boards.txt file(s)
 
195
 
BOARDSFILES := $(foreach dir, $(ARDUINOBACKENDS), \
 
196
 
        $(ARDUINODIR)/hardware/arduino$(dir)/boards.txt)
 
197
 
ifeq "$(ARDUINOBACKENDS)" "/"
 
198
 
readboardsparam = $(shell sed -ne "s/^$(BOARD)\\.$(1)=\(.*\)/\1/p" \
 
201
 
readboardsparam = $(firstword \
 
202
 
        $(call readboardsmenuparam,$(1),$(basename $(BOARD)),$(suffix $(BOARD))) \
 
203
 
        $(shell sed -ne "s/^$(basename $(BOARD))\\.$(1)=\(.*\)/\1/p" \
 
205
 
ifneq "$(wildcard /usr/bin/perl)" ""
 
206
 
readboardsmenuparam = $(shell perl -ne \
 
207
 
        '/^$(2)\.menu\.cpu/ && s/.*$(3)\.$(1)=(.*)/\1/i && print' $(BOARDSFILES))
 
209
 
readboardsmenuparam = $(shell sed -ne '/^$(2)\.menu\.cpu/ {' \
 
210
 
        -e 's/.*$(3)\.$(1)=\(.*\)/\1/p' -e '}' $(BOARDSFILES))
 
 
199
# obtain board parameters from the arduino boards.txt file
 
 
200
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
 
 
201
readboardsparam = $(shell sed -ne "s/^$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
 
213
202
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
 
214
203
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
 
215
204
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
 
216
205
BOARD_BUILD_CORE := $(call readboardsparam,build.core)
 
217
 
BOARD_BUILD_BOARD := $(call readboardsparam,build.board)
 
218
206
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
 
219
207
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
 
220
208
BOARD_USB_VID := $(call readboardsparam,build.vid)
 
 
244
223
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
 
247
 
# arduino directories
 
248
 
ARDUINOBACKENDDIR := $(strip $(foreach dir, $(ARDUINOBACKENDS), \
 
249
 
        $(if $(shell grep ^$(basename $(BOARD))\\.name \
 
250
 
                $(ARDUINODIR)/hardware/arduino$(dir)/boards.txt), \
 
251
 
        $(ARDUINODIR)/hardware/arduino$(dir))))
 
252
 
ARDUINOBACKENDARCH=AVR
 
253
 
ARDUINOCOREDIR := $(ARDUINOBACKENDDIR)/cores/$(BOARD_BUILD_CORE)
 
255
 
# default library path (places to look for libraries)
 
256
 
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries \
 
257
 
        $(ARDUINODIR)/libraries $(ARDUINOBACKENDDIR)/libraries
 
 
227
ifeq "$(BOARD_BUILD_MCU)" ""
 
 
228
ifneq "$(MAKECMDGOALS)" "boards"
 
 
229
ifneq "$(MAKECMDGOALS)" "clean"
 
 
230
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
260
236
INOFILE := $(wildcard *.ino *.pde)
 
 
263
239
$(error There is more than one .pde or .ino file in this directory!)
 
266
 
# automatically determine sources and target
 
 
242
# automatically determine sources and targeet
 
267
243
TARGET := $(basename $(INOFILE))
 
268
244
SOURCES := $(INOFILE) \
 
269
 
        $(wildcard *.c *.cc *.cpp *.C *.s *.S) \
 
270
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C *.s *.S)) \
 
271
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C *.s *.S))
 
 
245
        $(wildcard *.c *.cc *.cpp *.C) \
 
 
246
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
 
 
247
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
 
273
 
# automatically determine library directories (to pull library sources in from)
 
274
 
# by matching included headers in project sources to headers that exist in the
 
275
 
# roots of any library directories, giving priority to libraries in the order
 
276
 
# they're in LIBRARYPATH, and then to the alphabetically-greater named library
 
277
 
# (this is a really stupid way of doing it, but it's how the IDE works -- if
 
278
 
# it's causing problems, you can override it by setting LIBRARIES manually)
 
279
 
INCLUDEDHEADERS := $(shell sed -ne '/^[ \t]*\#[ \t]*include[ \t<"]/ {' \
 
280
 
         -e 's/^.*[<"]\(.*\)[>"].*/\1/p' -e '}' $(SOURCES))
 
281
 
reverse = $(if $(1),$(call reverse,$(wordlist 2,$(words $(1)),$(1)))) \
 
283
 
LIBRARYHEADERS := $(foreach dir, $(LIBRARYPATH), \
 
284
 
        $(call reverse, $(sort $(wildcard $(dir)/*))))
 
285
 
LIBRARYHEADERS := $(foreach dir, $(LIBRARYHEADERS), $(wildcard $(dir)/*.h))
 
286
 
LIBRARYDIRS := $(foreach hdr, $(INCLUDEDHEADERS), $(patsubst %/$(hdr), %, \
 
287
 
        $(firstword $(filter %/$(hdr), $(LIBRARYHEADERS)))))
 
 
249
# automatically determine included libraries
 
 
250
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
 
 
251
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
 
291
 
# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)
 
292
 
ifneq "$(LIBRARIES)" ""
 
 
256
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
 
 
257
CC := $(call findsoftware,avr-gcc)
 
 
258
CXX := $(call findsoftware,avr-g++)
 
 
259
LD := $(call findsoftware,avr-ld)
 
 
260
AR := $(call findsoftware,avr-ar)
 
 
261
OBJCOPY := $(call findsoftware,avr-objcopy)
 
 
262
AVRDUDE := $(call findsoftware,avrdude)
 
 
263
AVRSIZE := $(call findsoftware,avr-size)
 
 
266
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/$(BOARD_BUILD_CORE)
 
293
267
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
294
268
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
296
 
LIBRARYDIRS := $(LIBRARYDIRS) \
 
297
 
        $(addsuffix /utility, $(LIBRARYDIRS)) \
 
298
 
        $(addsuffix /src, $(LIBRARYDIRS))
 
 
269
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
 
301
272
TARGET := $(if $(TARGET),$(TARGET),a.out)
 
 
303
274
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
304
275
ARDUINOLIB := .lib/arduino.a
 
305
276
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
 
306
 
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \
 
307
 
                *.c *.cc *.cpp *.C *.s *.S))))
 
 
277
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
308
278
BOOTLOADERHEX := $(addprefix \
 
309
 
        $(ARDUINOBACKENDDIR)/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
 
 
279
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
 
310
280
        $(BOARD_BOOTLOADER_FILE))
 
313
 
BUILDTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
 
314
 
        $(ARDUINODIR)/hardware/tools/avr/bin
 
315
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(BUILDTOOLSPATH))))
 
316
 
CC := $(call findsoftware,avr-gcc)
 
317
 
CXX := $(call findsoftware,avr-g++)
 
318
 
LD := $(call findsoftware,avr-ld)
 
319
 
AR := $(call findsoftware,avr-ar)
 
320
 
AS := $(call findsoftware,avr-as)
 
321
 
OBJCOPY := $(call findsoftware,avr-objcopy)
 
322
 
AVRDUDE := $(call findsoftware,avrdude)
 
323
 
AVRSIZE := $(call findsoftware,avr-size)
 
325
 
# default arduino version
 
326
 
ARDUINOCONST ?= $(if $(filter /, $(ARDUINOBACKENDS)),100,150)
 
328
 
# default serial device to a poor guess (something that might be an arduino)
 
331
 
SERIALDEV := $(firstword $(wildcard \
 
332
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
 
336
282
# avrdude confifuration
 
337
283
ifeq "$(AVRDUDECONF)" ""
 
338
284
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
 
405
 
        @echo "Available BOARD values:"
 
406
 
        @sed -ne '/[[:alnum:]]*\.name=/p' \
 
407
 
                -e '/^[[:alnum:]]*\.menu\.cpu\.[[:alnum:]]*=/p' $(BOARDSFILES) | \
 
408
 
                sed -e 's/\([[:alnum:]]*\)\.name=\(.*\)/\1                   \2/' \
 
409
 
                        -e 's/^.*\(\.[[:alnum:]]*\)=\(.*\)/  \1                  --\2/' \
 
410
 
                        -e 's/\(.\{19\}\) *\(.*\)/  \1 \2/' -e 's/--/  ...with /'
 
411
 
ifneq "$(ARDUINOBACKENDS)" "/"
 
413
 
        @echo "NOTE: where a board supports multiple CPUs, you must specify" \
 
415
 
        @echo "'uno' is OK, and so is 'pro.16mhzatmega328'.  But 'pro', on" \
 
 
350
        @echo "Available values for BOARD:"
 
 
351
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
 
 
352
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
 
 
353
                        -e 's/(.{12}) *(.*)/\1 \2/'
 
420
356
        @test -n "$(SERIALDEV)" || { \
 
 
461
397
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
 
462
398
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
 
465
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
466
 
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
 
469
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
470
 
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
 
473
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
 
401
        mkdir -p .dep/$(dir $<)
 
474
402
        $(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
 
477
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
 
405
        mkdir -p .dep/$(dir $<)
 
478
406
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
481
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
 
409
        mkdir -p .dep/$(dir $<)
 
482
410
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
485
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
 
413
        mkdir -p .dep/$(dir $<)
 
486
414
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
489
 
        mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
 
490
 
        $(COMPILE.S) $(CPPDEPFLAGS) -o $@ $<
 
 
417
        mkdir -p .dep/$(dir $<)
 
 
418
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
 
 
421
        mkdir -p .dep/$(dir $<)
 
 
422
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
 
492
424
# building the arduino library