30
30
# This is a general purpose makefile for use with Arduino hardware and
 
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.
 
 
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
38
# 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:
 
 
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:
 
44
43
#   $ ln -s ~/src/arduino.mk Makefile
 
46
 
# You also need to set up a couple of environment varibales. 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
 
 
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
# 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
 
49
56
# your ~/.profile by adding something like this:
 
51
58
#   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
 
# iverride it as necessary).  For example:
 
 
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.
 
57
64
#   $ export BOARD=uno
 
60
67
# You may also need to set SERIALDEV if it is not detected correctly.
 
62
 
# The presence of a .ino or .pde file causes the arduino.mk to atuomatically
 
63
 
# determine va;ues for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
64
 
# files in the project directory (or any "util" or "utility" subdirectoried)
 
65
 
# are automatically included in the build and are scanned for Atduino libraries
 
66
 
# that have been #included.
 
 
69
# 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.
 
68
77
# Alternatively, if you want to manually specify build variables, create a
 
69
 
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
 
70
 
# (There is no need to define TARGET).  Here is an example Makefile:
 
 
78
# 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
 
 
80
# the project has a specific one.  Here is an example Makefile:
 
72
82
#   SOURCES := main.cc other.cc
 
73
83
#   LIBRARIES := EEPROM
 
74
85
#   include ~/src/arduino.mk
 
76
87
# 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/)
 
 
89
# ARDUINODIR   The path where the Arduino software is installed on your system.
 
 
91
# ARDUINOCONST The Arduino software version, as an integer, used to define the
 
 
92
#              ARDUINO version constant.  This defaults to 100 if undefined.
 
 
94
# AVRDUDECONF  The avrdude.conf to use.  If undefined, this defaults to a guess
 
 
95
#              based on where avrdude is.  If set empty, no avrdude.conf is
 
 
96
#              passed to avrdude (so the system default is used).
 
 
98
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
 
 
99
#              required to build the project, will be appended to this.
 
 
101
# AVRTOOLSPATH A space-separated list of directories that is searched in order
 
 
102
#              when looking for the avr build tools.  This defaults to PATH,
 
 
103
#              followed by subdirectories in ARDUINODIR.
 
81
105
# BOARD        Specify a target board type.  Run `make boards` to see available
 
84
 
# SERIALDEV    The unix device of the device where the arduino can be found.
 
85
 
#              If unspecified, an attempt is made to determine the name of a
 
86
 
#              connected arduino's serial device.
 
 
108
# CPPFLAGS     Specify any additional flags for the compiler.  The usual flags,
 
 
109
#              required to build the project, will be appended to this.
 
 
111
# LINKFLAGS    Specify any additional flags for the linker.  The usual flags,
 
 
112
#              required to build the project, will be appended to this.
 
 
114
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
 
 
115
#              automatically if a .ino (or .pde) is found.
 
 
117
# LIBRARYPATH  A space-separated list of directories that is searched in order
 
 
118
#              when looking for Arduino libraries.  This defaults to "libs",
 
 
119
#              "libraries" (in the project directory), then your sketchbook
 
 
120
#              "libraries" directory, then the Arduino libraries directory.
 
 
122
# SERIALDEV    The POSIX device name of the serial device that is the Arduino.
 
 
123
#              If unspecified, an attempt is made to guess the name of a
 
 
124
#              connected Arduino's serial device, which may work in some cases.
 
 
126
# SOURCES      A list of all source files of whatever language.  The language
 
 
127
#              type is determined by the file extension.  This is set
 
 
128
#              automatically if a .ino (or .pde) is found.
 
88
130
# TARGET       The name of the target file.  This is set automatically if a
 
89
 
#              .ino or .pde is found, but it is not neccesary to set it
 
 
131
#              .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.
 
99
134
# This makefile also defines the following goals for use on the command line
 
100
135
# when you run make:
 
102
137
# all          This is the default if no goal is specified.  It builds the
 
103
 
#              target and uploads it.
 
105
140
# target       Builds the target.
 
107
 
# upload       Uploads the last built target to an attached arduino.
 
 
142
# upload       Uploads the target (building it, as necessary) to an attached
 
109
145
# clean        Deletes files created during the build.
 
111
147
# boards       Display a list of available board names, so that you can set the
 
112
148
#              BOARD environment variable appropriately.
 
114
 
# monitor      Start `screen` on the serial device.  It is ment to be an
 
115
 
#              equivelant to the arduino serial monitor.
 
 
150
# monitor      Start `screen` on the serial device.  This is meant to be an
 
 
151
#              equivalent to the Arduino serial monitor.
 
 
153
# size         Displays size information about the built target.
 
 
155
# bootloader   Burns the bootloader for your board to it.
 
117
157
# <file>       Builds the specified file, either an object file or the target,
 
118
158
#              from those that that would be built for the project.
 
119
159
#_______________________________________________________________________________
 
122
 
# The full path to the arduino software, from arduino.cc
 
 
162
# default arduino software directory, check software exists
 
123
163
ifndef ARDUINODIR
 
124
 
ARDUINODIR := $(wildcard ~/opt/arduino)
 
 
164
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
 
 
165
        /Applications/Arduino.app/Contents/Resources/Java \
 
 
166
        $(HOME)/Applications/Arduino.app/Contents/Resources/Java))
 
127
 
# check arduino software
 
128
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
 
168
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
129
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*))
 
 
192
ifneq "$(MAKECMDGOALS)" "boards"
 
 
193
ifneq "$(MAKECMDGOALS)" "clean"
 
 
194
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
 
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))
 
 
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)
 
 
218
# obtain preferences from the IDE's preferences.txt
 
 
219
PREFERENCESFILE := $(firstword $(wildcard \
 
 
220
        $(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
 
 
221
ifneq "$(PREFERENCESFILE)" ""
 
 
222
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
 
 
223
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
 
 
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)
 
133
236
INOFILE := $(wildcard *.ino *.pde)
 
135
 
ifneq ($(words $(INOFILE)), 1)
 
 
238
ifneq "$(words $(INOFILE))" "1"
 
136
239
$(error There is more than one .pde or .ino file in this directory!)
 
 
242
# automatically determine sources and targeet
 
138
243
TARGET := $(basename $(INOFILE))
 
139
244
SOURCES := $(INOFILE) \
 
140
 
        $(wildcard *.c *.cc *.cpp) \
 
141
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
 
142
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
 
245
        $(wildcard *.c *.cc *.cpp *.C) \
 
 
246
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
 
 
247
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
 
143
249
# automatically determine included libraries
 
144
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
 
145
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
 
250
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
 
146
251
        $(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)
 
 
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)
 
 
267
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
 
268
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
 
269
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
 
 
272
TARGET := $(if $(TARGET),$(TARGET),a.out)
 
169
273
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
 
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
 
# prefer software that comes with arduino
 
195
 
TOOLSDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/)
 
196
 
TOOLSAVRDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/avr/)
 
198
 
# software (prioritise binaries that came with arduino software)
 
199
 
FIND_SOFTWARE = $(firstword $(wildcard \
 
200
 
        $(ARDUINODIR)/hardware/tools/$(1) \
 
201
 
        $(ARDUINODIR)/hardware/tools/avr/bin/$(1) \
 
203
 
CC := $(call FIND_SOFTWARE,avr-gcc)
 
204
 
CXX := $(call FIND_SOFTWARE,avr-g++)
 
205
 
LD := $(call FIND_SOFTWARE,avr-ld)
 
206
 
AR := $(call FIND_SOFTWARE,avr-ar)
 
207
 
OBJCOPY := $(call FIND_SOFTWARE,avr-objcopy)
 
208
 
AVRDUDE := $(call FIND_SOFTWARE,avrdude)
 
 
274
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
 
275
ARDUINOLIB := .lib/arduino.a
 
 
276
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
 
 
277
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
 
278
BOOTLOADERHEX := $(addprefix \
 
 
279
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
 
 
280
        $(BOARD_BOOTLOADER_FILE))
 
 
282
# avrdude confifuration
 
 
283
ifeq "$(AVRDUDECONF)" ""
 
 
284
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
 
285
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
 
287
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
211
 
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
212
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
213
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
214
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
215
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
216
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
217
 
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
 
 
292
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
 
293
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
 
294
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
 
 
295
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
 
 
296
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
 
 
297
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
 
 
298
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
 
299
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
 
 
300
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
 
 
301
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
 
 
302
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
 
218
303
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
 
219
304
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
 
220
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
 
305
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
 
307
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
 
 
308
STTYFARG := $(shell stty --help 2>&1 | \
 
 
309
        grep -q 'illegal option' && echo -f || echo -F)
 
 
311
# include dependencies
 
 
312
ifneq "$(MAKECMDGOALS)" "clean"
 
223
317
.DEFAULT_GOAL := all