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 release and requires that software
32
# to be downloaded separately (see http://arduino.cc/). To download the latest
33
# version of this makefile, visit the following website, where you can also
34
# find more information and documentation on it's use. The following text can
35
# only really be considered a reference to it's use.
37
37
# 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:
39
# To install, it is suggested that you keep arduino.mk somewhere and either
40
# symlink to it or include it in your make files. I keep mine at
41
# ~/src/arduino.mk. You will need to alter the value of the ARDUINODIR
42
# variable (below) to be the path where you have unpacked the arduino software
45
# This makefile can be used as a drop-in replacement for the Arduino IDE's
46
# build system. Simply create a symlink to it under the name "Makefile" and
47
# run make (remembering to specify an ARDUINODIR and BOARD, as described
48
# below). You would create the symlink like like so:
43
50
# $ 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.
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:
58
# export ARDUINODIR=~/somewhere/arduino-1.0.5
60
# For each project, you will also need to set BOARD to the type of Arduino
61
# you're building for. Type `make boards` for a list of acceptable values.
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.
74
# 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.
52
# The presence of a .ino or .pde file causes the arduino.mk to atuomatically
53
# determine va;ues for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp
54
# files in the project directory (or a "util" or "utility" subdirectory) are
55
# automatically included in the build and are scanned for libraries that have
83
58
# Alternatively, if you want to manually specify build variables, create a
84
# 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
86
# the project has a specific one. Here is an example Makefile:
59
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
60
# (There is no need to define TARGET). You will also be expected to provide a
61
# main() function, for example in main.cc, which may or may not duplicate the
62
# functionality of the default main() that calls init() and loop(). Here is an
88
# SOURCES := main.cc other.cc
65
# SOURCES := main.cc foo.cc
89
66
# LIBRARIES := EEPROM
91
67
# include ~/src/arduino.mk
93
# Here is a complete list of environment variables that affect the build:
95
# ARDUINODIR The directory where the Arduino software resides on your system.
97
# ARDUINOCONST The Arduino software version, as an integer, used to define the
98
# ARDUINO version constant. This defaults to 100 if undefined.
100
# AVRDUDECONF The avrdude.conf to use. If undefined, this defaults to a guess
101
# based on where avrdude is. If set empty, no avrdude.conf is
102
# passed to avrdude (so the system default is used).
104
# AVRDUDEFLAGS Specify any additional flags for avrdude. The usual flags,
105
# required to build the project, will be appended to this.
107
# AVRTOOLSPATH A space-separated list of directories that is searched in order
108
# when looking for the avr build tools. This defaults to PATH,
109
# followed by subdirectories in ARDUINODIR.
111
# BOARD Specify a target board type. Run `make boards` to see available
112
# board types. For Arduino 1.5, you will also need to specify a
113
# processor if the board supports multiple processors (see above).
115
# CPPFLAGS Specify any additional flags for the compiler. The usual flags,
116
# required to build the project, will be appended to this.
118
# LINKFLAGS Specify any additional flags for the linker. The usual flags,
119
# required to build the project, will be appended to this.
121
# LIBRARIES A list of Arduino libraries to build and include. This is set
122
# automatically if a .ino (or .pde) is found.
124
# LIBRARYPATH A space-separated list of directories that is searched in order
125
# when looking for Arduino libraries. This defaults to "libs",
126
# "libraries" (in the project directory), then your sketchbook
127
# "libraries" directory, then the Arduino libraries directory.
129
# SERIALDEV The POSIX device name of the serial device that is the Arduino.
130
# If unspecified, an attempt is made to guess the name of a
131
# connected Arduino's serial device, which may work in some cases.
69
# A complete list of all the settings you can use in your Makefile follows
70
# shortly. It should be noted, however, that some variables are better
71
# specified in the environment (or on the command line) than in your Makefile.
72
# Specifically, the ARDUINODIR, BOARD and, if it is not automatically detected,
75
# When running make, you might want to specify the board and path to your
76
# installation of the arduino software, like this:
78
# $ export ARDUINODIR=~/opt/arduino
79
# $ export BOARD=pro5v
82
# For a list of available board types, run `make boards`.
84
# Here is a complete list of configuration parameters:
86
# ARDUINODIR The path where you have installed/unpacked the arduino software
87
# (from http://arduino.cc/)
89
# BOARD Specify a target board type.
91
# SERIALDEV The unix device of the device where the arduino can be found.
92
# If unspecified, an attempt is made to determine the name of a
93
# connected arduino's serial device.
95
# TARGET The name of the target file. This is set automatically if a
96
# .ino or .pde is found, but it is not neccesary to set it
133
99
# SOURCES A list of all source files of whatever language. The language
134
100
# type is determined by the file extension. This is set
135
# automatically if a .ino (or .pde) is found.
137
# TARGET The name of the target file. This is set automatically if a
138
# .ino (or .pde) is found, but it is not necessary to set it
141
# This makefile also defines the following goals for use on the command line
144
# all This is the default if no goal is specified. It builds the
147
# target Builds the target.
149
# upload Uploads the target (building it, as necessary) to an attached
152
# clean Deletes files created during the build.
101
# automatically if a .ino or .pde is found.
103
# LIBRARIES A list of arduino libraries to build and include. This is set
104
# automatically if a .ino or .pde is found.
106
# This general-purpose makefile also defines the following goals for
107
# use on the command line when you run make:
109
# all This is the default if no goal is specified. It builds the
110
# target and uploads it.
112
# target Builds the target of your Makefile.
114
# upload Uploads the target to an attached arduino.
116
# clean Deletes temporary files.
154
118
# boards Display a list of available board names, so that you can set the
155
119
# BOARD environment variable appropriately.
157
# monitor Start `screen` on the serial device. This is meant to be an
158
# equivalent to the Arduino serial monitor.
160
# size Displays size information about the built target.
162
# bootloader Burns the bootloader for your board to it.
121
# monitor Start `screen` on the serial device. It is ment to be an
122
# equivelant to the arduino serial monitor.
164
124
# <file> Builds the specified file, either an object file or the target,
165
125
# from those that that would be built for the project.
166
126
#_______________________________________________________________________________
169
# default arduino software directory
129
# The full path to the arduino software, from arduino.cc
170
130
ifndef ARDUINODIR
171
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
172
/Applications/Arduino.app/Contents/Resources/Java \
173
$(HOME)/Applications/Arduino.app/Contents/Resources/Java))
131
ARDUINODIR := $(wildcard ~/opt/arduino)
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
134
# check arduino software
135
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
182
136
$(error ARDUINODIR is not set correctly; arduino software not found)
187
ifneq "$(MAKECMDGOALS)" "boards"
188
ifneq "$(MAKECMDGOALS)" "clean"
189
$(error BOARD is unset. Type 'make boards' to see possible values)
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))
213
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
214
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
215
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
216
BOARD_BUILD_CORE := $(call readboardsparam,build.core)
217
BOARD_BUILD_BOARD := $(call readboardsparam,build.board)
218
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
219
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
220
BOARD_USB_VID := $(call readboardsparam,build.vid)
221
BOARD_USB_PID := $(call readboardsparam,build.pid)
222
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
223
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
224
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
225
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
226
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
227
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
228
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
231
ifeq "$(BOARD_BUILD_MCU)" ""
232
ifneq "$(MAKECMDGOALS)" "boards"
233
ifneq "$(MAKECMDGOALS)" "clean"
234
$(error BOARD is invalid. Type 'make boards' to see possible values)
239
# obtain preferences from the IDE's preferences.txt
240
PREFERENCESFILE := $(firstword $(wildcard \
241
$(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
242
ifneq "$(PREFERENCESFILE)" ""
243
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
244
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
260
140
INOFILE := $(wildcard *.ino *.pde)
262
ifneq "$(words $(INOFILE))" "1"
142
ifneq ($(words $(INOFILE)), 1)
263
143
$(error There is more than one .pde or .ino file in this directory!)
266
# automatically determine sources and target
267
145
TARGET := $(basename $(INOFILE))
268
146
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))
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)))))
291
# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)
292
ifneq "$(LIBRARIES)" ""
293
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
294
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
296
LIBRARYDIRS := $(LIBRARYDIRS) \
297
$(addsuffix /utility, $(LIBRARYDIRS)) \
298
$(addsuffix /src, $(LIBRARYDIRS))
147
$(wildcard *.c *.cc *.cpp) \
148
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
149
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
150
# automatically determine included libraries
151
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
152
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
153
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
156
# no target? use default
161
# no serial device? attempt to detect an arduino
163
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
166
# no board? oh dear...
168
ifneq "$(MAKECMDGOALS)" "boards"
169
ifneq "$(MAKECMDGOALS)" "clean"
170
$(error BOARD is unset. Type 'make boards' to see possible values)
301
TARGET := $(if $(TARGET),$(TARGET),a.out)
302
176
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
303
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
304
ARDUINOLIB := .lib/arduino.a
305
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
306
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \
307
*.c *.cc *.cpp *.C *.s *.S))))
308
BOOTLOADERHEX := $(addprefix \
309
$(ARDUINOBACKENDDIR)/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
310
$(BOARD_BOOTLOADER_FILE))
177
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
178
ARDUINOLIB := _arduino.a
179
ARDUINOLIBTMP := _arduino.a.tmp
180
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
181
$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
182
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
183
$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
184
$(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
186
# obtain board parameters from the arduino boards.txt file
187
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
189
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
190
BOARD_BUILD_FCPU := \
191
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
192
BOARD_BUILD_VARIANT := \
193
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
194
BOARD_UPLOAD_SPEED := \
195
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
196
BOARD_UPLOAD_PROTOCOL := \
197
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_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
# avrdude confifuration
337
ifeq "$(AVRDUDECONF)" ""
338
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
339
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
341
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
204
OBJCOPY := avr-objcopy
346
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
347
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
348
CPPFLAGS += -fpermissive -mmcu=$(BOARD_BUILD_MCU)
349
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
350
CPPFLAGS += -DARDUINO_$(BOARD_BUILD_BOARD) -DARDUINO_ARCH_$(ARDUINOBACKENDARCH)
351
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
352
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
353
CPPFLAGS += -I $(ARDUINOBACKENDDIR)/variants/$(BOARD_BUILD_VARIANT)/
354
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
355
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
356
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
357
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
358
AVRDUDEFLAGS += -p$(BOARD_BUILD_MCU) -P$(SERIALDEV) -c$(BOARD_UPLOAD_PROTOCOL)
359
AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))
360
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
362
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
363
STTYFARG := $(shell stty --help 2>&1 | \
364
grep -q 'illegal option' && echo -f || echo -F)
366
# include dependencies
367
ifneq "$(MAKECMDGOALS)" "clean"
208
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
209
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
210
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
211
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
212
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
213
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
214
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
215
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
216
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
217
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
372
220
.DEFAULT_GOAL := all