30
30
# This is a general purpose makefile for use with Arduino hardware and
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.)
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.)
36
37
# http://ed.am/dev/make/arduino-mk
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:
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:
43
43
# $ ln -s ~/src/arduino.mk Makefile
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)
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.
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 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:
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:
58
# export ARDUINODIR=~/somewhere/arduino-1.0
58
# export ARDUINODIR=~/somewhere/arduino-1.0.5
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
67
# You may also need to set SERIALDEV if it is not detected correctly.
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.
69
74
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
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.
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.
77
83
# Alternatively, if you want to manually specify build variables, create a
78
84
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
79
# (There is no need to define TARGET). You can also specify the BOARD here, if
85
# (You don't need to define TARGET). You can also specify the BOARD here, if
80
86
# the project has a specific one. Here is an example Makefile:
82
88
# SOURCES := main.cc other.cc
159
166
#_______________________________________________________________________________
162
# default arduino software directory, check software exists
169
# default arduino software directory
163
170
ifndef ARDUINODIR
164
171
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
165
172
/Applications/Arduino.app/Contents/Resources/Java \
166
173
$(HOME)/Applications/Arduino.app/Contents/Resources/Java))
168
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
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
169
182
$(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*))
192
187
ifneq "$(MAKECMDGOALS)" "boards"
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))
194
# obtain board parameters from the arduino boards.txt file(s)
195
BOARDSFILES := $(foreach dir, $(ARDUINOBACKENDS), \
196
$(ARDUINODIR)/hardware/arduino$(dir)/boards.txt)
197
readboardsparam = $(firstword \
198
$(shell sed -ne "s/^menu\\.cpu\\.$(BOARD)\\.$(1)=\(.*\)/\1/p" \
200
$(shell sed -ne "s/^$(basename $(BOARD))\\.$(1)=\(.*\)/\1/p" \
202
202
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
203
203
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
204
204
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
205
BOARD_BUILD_CORE := $(call readboardsparam,build.core)
205
206
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
206
207
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
207
208
BOARD_USB_VID := $(call readboardsparam,build.vid)
222
232
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
226
ifeq "$(BOARD_BUILD_MCU)" ""
227
ifneq "$(MAKECMDGOALS)" "boards"
228
ifneq "$(MAKECMDGOALS)" "clean"
229
$(error BOARD is invalid. Type 'make boards' to see possible values)
235
# arduino directories
236
ARDUINOBACKENDDIR := $(strip $(foreach dir, $(ARDUINOBACKENDS), \
237
$(if $(shell grep ^$(basename $(BOARD))\\.name \
238
$(ARDUINODIR)/hardware/arduino$(dir)/boards.txt), \
239
$(ARDUINODIR)/hardware/arduino$(dir))))
240
ARDUINOCOREDIR := $(ARDUINOBACKENDDIR)/cores/$(BOARD_BUILD_CORE)
242
# default library path (places to look for libraries)
243
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries \
244
$(ARDUINODIR)/libraries $(ARDUINOBACKENDDIR)/libraries
235
247
INOFILE := $(wildcard *.ino *.pde)
238
250
$(error There is more than one .pde or .ino file in this directory!)
241
# automatically determine sources and targeet
253
# automatically determine sources and target
242
254
TARGET := $(basename $(INOFILE))
243
255
SOURCES := $(INOFILE) \
244
$(wildcard *.c *.cc *.cpp *.C) \
245
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
246
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
256
$(wildcard *.c *.cc *.cpp *.C *.s *.S) \
257
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C *.s *.S)) \
258
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C *.s *.S))
248
# automatically determine included libraries
249
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
250
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
260
# automatically determine library directories (to pull library sources in from)
261
# by matching included headers in project sources to headers that exist in the
262
# roots of any library directories, giving priority to libraries in the order
263
# they're in LIBRARYPATH, and then to the alphabetically-greater named library
264
# (this is a really stupid way of doing it, but it's how the IDE works -- if
265
# it's causing problems, you can override it by setting LIBRARIES manually)
266
INCLUDEDHEADERS := $(shell sed -ne "/^[ \t]*\#[ \t]*include[ \t<\"]/ {" \
267
-e "s/^.*[<\"]\(.*\)[>\"].*/\1/" -e "p" -e "}" $(SOURCES))
268
reverse = $(if $(1),$(call reverse,$(wordlist 2,$(words $(1)),$(1)))) \
270
LIBRARYHEADERS := $(foreach dir, $(LIBRARYPATH), \
271
$(call reverse, $(sort $(wildcard $(dir)/*))))
272
LIBRARYHEADERS := $(foreach dir, $(LIBRARYHEADERS), $(wildcard $(dir)/*.h))
273
LIBRARYDIRS := $(foreach hdr, $(INCLUDEDHEADERS), $(patsubst %/$(hdr), %, \
274
$(firstword $(filter %/$(hdr), $(LIBRARYHEADERS)))))
255
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
256
CC := $(call findsoftware,avr-gcc)
257
CXX := $(call findsoftware,avr-g++)
258
LD := $(call findsoftware,avr-ld)
259
AR := $(call findsoftware,avr-ar)
260
OBJCOPY := $(call findsoftware,avr-objcopy)
261
AVRDUDE := $(call findsoftware,avrdude)
262
AVRSIZE := $(call findsoftware,avr-size)
265
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
278
# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)
279
ifneq "$(LIBRARIES)" ""
266
280
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
267
281
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
268
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
283
LIBRARYDIRS := $(LIBRARYDIRS) $(addsuffix /utility, $(LIBRARYDIRS))
271
286
TARGET := $(if $(TARGET),$(TARGET),a.out)
273
288
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
274
289
ARDUINOLIB := .lib/arduino.a
275
290
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
276
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
291
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \
292
*.c *.cc *.cpp *.C *.s *.S))))
277
293
BOOTLOADERHEX := $(addprefix \
278
$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
294
$(ARDUINOBACKENDDIR)/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
279
295
$(BOARD_BOOTLOADER_FILE))
298
BUILDTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
299
$(ARDUINODIR)/hardware/tools/avr/bin
300
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(BUILDTOOLSPATH))))
301
CC := $(call findsoftware,avr-gcc)
302
CXX := $(call findsoftware,avr-g++)
303
LD := $(call findsoftware,avr-ld)
304
AR := $(call findsoftware,avr-ar)
305
AS := $(call findsoftware,avr-as)
306
OBJCOPY := $(call findsoftware,avr-objcopy)
307
AVRDUDE := $(call findsoftware,avrdude)
308
AVRSIZE := $(call findsoftware,avr-size)
310
# default arduino version
311
ARDUINOCONST ?= $(if $(filter /, $(ARDUINOBACKENDS)),100,150)
313
# default serial device to a poor guess (something that might be an arduino)
316
SERIALDEV := $(firstword $(wildcard \
317
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
281
321
# avrdude confifuration
282
322
ifeq "$(AVRDUDECONF)" ""
283
323
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
294
334
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
295
335
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
296
336
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
297
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
337
CPPFLAGS += -I $(ARDUINOBACKENDDIR)/variants/$(BOARD_BUILD_VARIANT)/
298
338
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
299
339
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
300
340
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
301
341
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
302
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
303
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
342
AVRDUDEFLAGS += -p$(BOARD_BUILD_MCU) -P$(SERIALDEV) -c$(BOARD_UPLOAD_PROTOCOL)
343
AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))
304
344
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
306
346
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
348
@echo "Available values for BOARD:"
349
@sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
350
sed -Ee 's/([^.]+)\.name=(.*)/\1 \2/' \
351
-e 's/(.{12}) *(.*)/\1 \2/'
389
@echo "Available BOARD values:"
390
@sed -ne '/[[:alnum:]]*\.name=/p' \
391
-e '/^[[:alnum:]]*\.menu\.cpu\.[[:alnum:]]*=/p' $(BOARDSFILES) | \
392
sed -e 's/\([[:alnum:]]*\)\.name=\(.*\)/\1 \2/' \
393
-e 's/^.*\(\.[[:alnum:]]*\)=\(.*\)/ \1 --\2/' \
394
-e 's/\(.\{19\}\) *\(.*\)/ \1 \2/' -e 's/--/ ...with /'
395
ifneq "$(ARDUINOBACKENDS)" "/"
397
@echo "NOTE: where a board supports multiple CPUs, you must specify" \
399
@echo "'uno' is OK, and so is 'pro.16mhzatmega328'. But 'pro', on" \
354
404
@test -n "$(SERIALDEV)" || { \
395
445
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
396
446
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
449
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
450
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
453
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
454
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
399
mkdir -p .dep/$(dir $<)
457
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
400
458
$(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
403
mkdir -p .dep/$(dir $<)
461
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
404
462
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
407
mkdir -p .dep/$(dir $<)
465
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
408
466
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
411
mkdir -p .dep/$(dir $<)
469
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
412
470
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
415
mkdir -p .dep/$(dir $<)
416
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
419
mkdir -p .dep/$(dir $<)
420
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
473
mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))
474
$(COMPILE.S) $(CPPDEPFLAGS) -o $@ $<
422
476
# building the arduino library