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
# This makefile can be used as a drop-in replacement for the Arduino IDE's
40
# build system. To use it, save arduino.mk somewhere (I keep mine at
41
# ~/src/arduino.mk) and create a symlink to it in your project directory named
42
# "Makefile". For example:
43
44
# $ ln -s ~/src/arduino.mk Makefile
45
# The Arduino software is required, version 1.0 or later, including version 1.5
46
# (which is in BETA at time of release of this makefile). On GNU/Linux you can
47
# probably install the software from your package manager. If you are using
48
# Debian (or a derivative), try `apt-get install arduino`. Otherwise, you can
49
# download the latest Arduino software manually from http://arduino.cc/. In
50
# case you're unsure, install it at ~/opt/arduino (or /Applications on OS X).
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.
46
# You also need to set up a couple of environment variables. ARDUINODIR should
47
# be set to the path where you unpacked the arduino software from arduino.cc
48
# (it defaults to ~/opt/arduino if unset). You might be best to set this in
49
# your ~/.profile by adding something like this:
51
# export ARDUINODIR=~/somewhere/arduino-1.0
53
# You will also need to set BOARD to the type of arduino you're using. This
54
# can be done when running make (or you could set a default in ~/.profile and
55
# override it as necessary). For example:
64
57
# $ 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.
60
# You may also need to set SERIALDEV if it is not detected correctly.
74
62
# 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.
63
# determine values for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp
64
# files in the project directory (or any "util" or "utility" subdirectories)
65
# are automatically included in the build and are scanned for Arduino libraries
66
# that have been #included. Note, there can only be one .ino (or .pde) file.
83
68
# Alternatively, if you want to manually specify build variables, create a
84
69
# 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:
70
# (There is no need to define TARGET). Here is an example Makefile:
88
72
# SOURCES := main.cc other.cc
89
73
# LIBRARIES := EEPROM
91
74
# 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.
76
# Here is a complete list of configuration parameters:
78
# ARDUINODIR The path where you have installed/unpacked the arduino software
79
# (from http://arduino.cc/)
111
81
# 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.
133
# SOURCES A list of all source files of whatever language. The language
134
# type is determined by the file extension. This is set
135
# automatically if a .ino (or .pde) is found.
84
# SERIALDEV The unix device name of the serial device that is the arduino.
85
# If unspecified, an attempt is made to determine the name of a
86
# connected arduino's serial device.
137
88
# TARGET The name of the target file. This is set automatically if a
138
89
# .ino (or .pde) is found, but it is not necessary to set it
92
# SOURCES A list of all source files of whatever language. The language
93
# type is determined by the file extension. This is set
94
# automatically if a .ino (or .pde) is found.
96
# LIBRARIES A list of arduino libraries to build and include. This is set
97
# automatically if a .ino (or .pde) is found.
141
99
# This makefile also defines the following goals for use on the command line
142
100
# when you run make:
144
102
# all This is the default if no goal is specified. It builds the
103
# target and uploads it.
147
105
# target Builds the target.
149
# upload Uploads the target (building it, as necessary) to an attached
107
# upload Uploads the last built target to an attached arduino.
152
109
# clean Deletes files created during the build.
155
112
# BOARD environment variable appropriately.
157
114
# 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.
115
# equivalent to the arduino serial monitor.
164
117
# <file> Builds the specified file, either an object file or the target,
165
118
# from those that that would be built for the project.
166
119
#_______________________________________________________________________________
169
# default arduino software directory
122
# The full path to the arduino software, from arduino.cc
170
123
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))
124
ARDUINODIR := $(wildcard ~/opt/arduino)
176
# check arduino software exists and determine available backends
177
ifneq "" "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)"
179
else ifneq "" "$(wildcard $(ARDUINODIR)/hardware/arduino/avr/boards.txt)"
180
ARDUINOBACKENDS := /avr /sam
127
# check arduino software
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
182
129
$(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
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
247
133
INOFILE := $(wildcard *.ino *.pde)
249
ifneq "$(words $(INOFILE))" "1"
135
ifneq ($(words $(INOFILE)), 1)
250
136
$(error There is more than one .pde or .ino file in this directory!)
253
# automatically determine sources and target
254
138
TARGET := $(basename $(INOFILE))
255
139
SOURCES := $(INOFILE) \
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 -nre "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))
140
$(wildcard *.c *.cc *.cpp) \
141
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
142
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
143
# automatically determine included libraries
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
146
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
149
# no target? use default
154
# no serial device? attempt to detect an arduino
155
ifeq ($(SERIALDEV), )
156
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
159
# no board? oh dear...
161
ifneq "$(MAKECMDGOALS)" "boards"
162
ifneq "$(MAKECMDGOALS)" "clean"
163
$(error BOARD is unset. Type 'make boards' to see possible values)
287
TARGET := $(if $(TARGET),$(TARGET),a.out)
288
169
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))
299
BUILDTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
300
$(ARDUINODIR)/hardware/tools/avr/bin
301
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(BUILDTOOLSPATH))))
302
CC := $(call findsoftware,avr-gcc)
303
CXX := $(call findsoftware,avr-g++)
304
LD := $(call findsoftware,avr-ld)
305
AR := $(call findsoftware,avr-ar)
306
AS := $(call findsoftware,avr-as)
307
OBJCOPY := $(call findsoftware,avr-objcopy)
308
AVRDUDE := $(call findsoftware,avrdude)
309
AVRSIZE := $(call findsoftware,avr-size)
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
323
ifeq "$(AVRDUDECONF)" ""
324
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
325
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
327
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
171
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
172
ARDUINOLIB := _arduino.a
173
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
174
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
175
$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
176
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
177
$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
178
$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
179
$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
181
# obtain board parameters from the arduino boards.txt file
182
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
184
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
185
BOARD_BUILD_FCPU := \
186
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
187
BOARD_BUILD_VARIANT := \
188
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
189
BOARD_UPLOAD_SPEED := \
190
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
191
BOARD_UPLOAD_PROTOCOL := \
192
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
194
# arduino version (currently fixed)
197
# software (prioritise binaries that came with arduino software)
198
FIND_SOFTWARE = $(firstword $(wildcard \
199
$(ARDUINODIR)/hardware/tools/$(1) \
200
$(ARDUINODIR)/hardware/tools/avr/bin/$(1) \
202
CC := $(call FIND_SOFTWARE,avr-gcc)
203
CXX := $(call FIND_SOFTWARE,avr-g++)
204
LD := $(call FIND_SOFTWARE,avr-ld)
205
AR := $(call FIND_SOFTWARE,avr-ar)
206
OBJCOPY := $(call FIND_SOFTWARE,avr-objcopy)
207
AVRDUDE := $(call FIND_SOFTWARE,avrdude)
332
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
210
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
333
211
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
334
212
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"
213
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOVER)
214
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
215
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
216
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
217
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
218
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
219
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
220
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
221
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
357
224
.DEFAULT_GOAL := all