30
30
# This is a general purpose makefile for use with Arduino hardware and
31
# software. It works with the arduino-1.0 software release. To download the
32
# latest version of this makefile, visit the following website, where you can
33
# also find more information and documentation on it's use. The following text
34
# can only really be considered a reference to it's use.
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, save arduino.mk somewhere (I keep mine at
40
# ~/src/arduino.mk) and create a symlink to it in your project directory named
41
# "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. If you are using
46
# Debian (or a derivative), type `apt-get install arduino`. Otherwise, you
47
# will have to download the Arduino software manually from http://arduino.cc/.
48
# It is suggested that you install it at ~/opt/arduino if you are unsure.
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.
50
52
# If you downloaded the Arduino software manually and unpacked it somewhere
51
# other than ~/opt/arduino, you will need to set up ARDUINODIR to be the path
52
# where you unpacked it. (If unset, ARDUINODIR defaults to ~/opt/arduino and
53
# then /usr/share/arduino, in that order.) You might be best to set this in
54
# your ~/.profile by adding something like this:
56
# export ARDUINODIR=~/somewhere/arduino-1.0
58
# You will also need to set BOARD to the type of Arduino you're building for.
59
# Type `make boards` for a list of acceptable values. You could set a default
60
# in your ~/.profile if you want, but it is suggested that you specify this at
61
# build time, especially if you work with different types of Arduino. For
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.
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.
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.
75
83
# Alternatively, if you want to manually specify build variables, create a
76
84
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
77
# (There is no need to define TARGET). Here is an example Makefile:
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:
79
88
# SOURCES := main.cc other.cc
80
89
# LIBRARIES := EEPROM
81
91
# include ~/src/arduino.mk
83
# Here is a complete list of configuration parameters:
93
# Here is a complete list of environment variables that affect the build:
85
# ARDUINODIR The path where the Arduino software is installed on your system.
95
# ARDUINODIR The directory where the Arduino software resides on your system.
87
97
# ARDUINOCONST The Arduino software version, as an integer, used to define the
88
# ARDUINO version constant. This defaults to 100 if undefined.
90
# AVRDUDECONF The avrdude.conf to use. If undefined, this defaults to a guess
91
# based on where the avrdude in use is. If empty, no avrdude.conf
92
# is passed to avrdude (to the system default is used).
94
# AVRTOOLSPATH A space-separated list of directories to search in order when
95
# looking for the avr build tools. This defaults to the system PATH
96
# followed by subdirectories in ARDUINODIR if undefined.
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.
98
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.
101
121
# LIBRARIES A list of Arduino libraries to build and include. This is set
102
122
# automatically if a .ino (or .pde) is found.
104
# SERIALDEV The unix device name of the serial device that is the Arduino.
105
# If unspecified, an attempt is made to determine the name of a
106
# connected Arduino's serial device.
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.
108
133
# SOURCES A list of all source files of whatever language. The language
109
134
# type is determined by the file extension. This is set
131
157
# monitor Start `screen` on the serial device. This is meant to be an
132
158
# equivalent to the Arduino serial monitor.
134
# size Displays size information about the bulit target.
160
# size Displays size information about the built target.
162
# bootloader Burns the bootloader for your board to it.
136
164
# <file> Builds the specified file, either an object file or the target,
137
165
# from those that that would be built for the project.
138
166
#_______________________________________________________________________________
141
# default arduino software directory, check software exists
169
# default arduino software directory
142
170
ifndef ARDUINODIR
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
171
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
172
/Applications/Arduino.app/Contents/Resources/Java \
173
$(HOME)/Applications/Arduino.app/Contents/Resources/Java))
145
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
146
182
$(error ARDUINODIR is not set correctly; arduino software not found)
149
# default arduino version
152
# default path for avr tools
154
AVRTOOLSPATH := $(subst :, , $(PATH))
155
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
156
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
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
readboardsparam = $(firstword \
198
$(shell sed -ne "s/^menu\\.cpu\\.$(BOARD)\\.$(1)=\(.*\)/\1/Ip" \
200
$(shell sed -ne "s/^$(basename $(BOARD))\\.$(1)=\(.*\)/\1/Ip" \
202
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
203
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
204
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
205
BOARD_BUILD_CORE := $(call readboardsparam,build.core)
206
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
207
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
208
BOARD_USB_VID := $(call readboardsparam,build.vid)
209
BOARD_USB_PID := $(call readboardsparam,build.pid)
210
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
211
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
212
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
213
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
214
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
215
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
216
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
219
ifeq "$(BOARD_BUILD_MCU)" ""
220
ifneq "$(MAKECMDGOALS)" "boards"
221
ifneq "$(MAKECMDGOALS)" "clean"
222
$(error BOARD is invalid. Type 'make boards' to see possible values)
227
# obtain preferences from the IDE's preferences.txt
228
PREFERENCESFILE := $(firstword $(wildcard \
229
$(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
230
ifneq "$(PREFERENCESFILE)" ""
231
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
232
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
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
160
247
INOFILE := $(wildcard *.ino *.pde)
163
250
$(error There is more than one .pde or .ino file in this directory!)
166
# automatically determine sources and targeet
253
# automatically determine sources and target
167
254
TARGET := $(basename $(INOFILE))
168
255
SOURCES := $(INOFILE) \
169
$(wildcard *.c *.cc *.cpp) \
170
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
171
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
173
# automatically determine included libraries
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
175
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
179
# no serial device? make a poor attempt to detect an arduino
181
ifeq "$(SERIALDEV)" ""
182
SERIALDEV := $(firstword $(wildcard \
183
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
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))
260
# automatically determine library directories (to pull library sources in from)
261
# by matching included headers in poject 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)
267
$(shell sed -ne "s/^\s*\#\s*include\s*[<\"]\(\S\+\.h\)[>\"].*/\1/p" \
269
reverse = $(if $(1),$(call reverse,$(wordlist 2,$(words $(1)),$(1)))) \
271
LIBRARYHEADERS := $(foreach dir, $(LIBRARYPATH), \
272
$(call reverse, $(sort $(wildcard $(dir)/*))))
273
LIBRARYHEADERS := $(foreach dir, $(LIBRARYHEADERS), $(wildcard $(dir)/*.h))
274
LIBRARYDIRS := $(foreach hdr, $(INCLUDEDHEADERS), $(patsubst %/$(hdr), %, \
275
$(firstword $(filter %/$(hdr), $(LIBRARYHEADERS)))))
279
# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)
280
ifneq "$(LIBRARIES)" ""
281
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
282
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
284
LIBRARYDIRS := $(LIBRARYDIRS) $(addsuffix /utility, $(LIBRARYDIRS))
287
TARGET := $(if $(TARGET),$(TARGET),a.out)
288
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
289
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
290
ARDUINOLIB := .lib/arduino.a
291
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
292
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \
293
*.c *.cc *.cpp *.C *.s *.S))))
294
BOOTLOADERHEX := $(addprefix \
295
$(ARDUINOBACKENDDIR)/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
296
$(BOARD_BOOTLOADER_FILE))
188
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
299
BUILDTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
300
$(ARDUINODIR)/hardware/tools/avr/bin
301
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(BUILDTOOLSPATH))))
189
302
CC := $(call findsoftware,avr-gcc)
190
303
CXX := $(call findsoftware,avr-g++)
191
304
LD := $(call findsoftware,avr-ld)
192
305
AR := $(call findsoftware,avr-ar)
306
AS := $(call findsoftware,avr-as)
193
307
OBJCOPY := $(call findsoftware,avr-objcopy)
194
308
AVRDUDE := $(call findsoftware,avrdude)
195
309
AVRSIZE := $(call findsoftware,avr-size)
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
199
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
200
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
201
ARDUINOLIB := .lib/arduino.a
202
ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries
203
ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \
204
$(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )
205
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \
206
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
311
# default arduino version
312
ARDUINOCONST ?= $(if $(filter /, $(ARDUINOBACKENDS)),100,150)
314
# default serial device to a poor guess (something that might be an arduino)
317
SERIALDEV := $(firstword $(wildcard \
318
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
322
# avrdude confifuration
207
323
ifeq "$(AVRDUDECONF)" ""
208
324
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
209
325
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
217
ifneq "$(MAKECMDGOALS)" "boards"
218
ifneq "$(MAKECMDGOALS)" "clean"
219
$(error BOARD is unset. Type 'make boards' to see possible values)
224
# obtain board parameters from the arduino boards.txt file
225
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
227
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
228
BOARD_BUILD_FCPU := \
229
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
230
BOARD_BUILD_VARIANT := \
231
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
232
BOARD_UPLOAD_SPEED := \
233
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
234
BOARD_UPLOAD_PROTOCOL := \
235
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
238
ifeq "$(BOARD_BUILD_MCU)" ""
239
ifneq "$(MAKECMDGOALS)" "boards"
240
ifneq "$(MAKECMDGOALS)" "clean"
241
$(error BOARD is invalid. Type 'make boards' to see possible values)
247
CPPFLAGS_S := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
248
CPPFLAGS_S += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
249
CPPFLAGS_S += -mmcu=$(BOARD_BUILD_MCU)
250
CPPFLAGS_S += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
251
CPPFLAGS_S += -I. -Iutil -Iutility -I$(ARDUINOCOREDIR)
252
CPPFLAGS_S += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
253
CPPFLAGS_S += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
254
CPPFLAGS_S += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
255
CPPFLAGS = $(CPPFLAGS_S)
256
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
257
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
258
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
259
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
261
# figure out which arg to use with stty
262
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
332
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
333
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
334
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
335
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
336
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
337
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
338
CPPFLAGS += -I $(ARDUINOBACKENDDIR)/variants/$(BOARD_BUILD_VARIANT)/
339
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
340
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
341
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
342
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
343
AVRDUDEFLAGS += -p$(BOARD_BUILD_MCU) -P$(SERIALDEV) -c$(BOARD_UPLOAD_PROTOCOL)
344
AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))
345
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
347
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
348
STTYFARG := $(shell stty --help 2>&1 | \
349
grep -q 'illegal option' && echo -f || echo -F)
351
# include dependencies
352
ifneq "$(MAKECMDGOALS)" "clean"
265
357
.DEFAULT_GOAL := all