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 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.
36
37
# http://ed.am/dev/make/arduino-mk
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
38
45
# 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:
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) 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
56
# your ~/.profile by adding something like this:
58
# export ARDUINODIR=~/somewhere/arduino-1.0
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.
67
# You may also need to set SERIALDEV if it is not detected correctly.
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.
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
77
58
# Alternatively, if you want to manually specify build variables, create a
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:
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
82
# SOURCES := main.cc other.cc
65
# SOURCES := main.cc foo.cc
83
66
# LIBRARIES := EEPROM
85
67
# include ~/src/arduino.mk
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`.
87
84
# Here is a complete list of configuration parameters:
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.
105
# BOARD Specify a target board type. Run `make boards` to see available
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.
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
126
99
# SOURCES A list of all source files of whatever language. The language
127
100
# type is determined by the file extension. This is set
128
# automatically if a .ino (or .pde) is found.
130
# TARGET The name of the target file. This is set automatically if a
131
# .ino (or .pde) is found, but it is not necessary to set it
134
# This makefile also defines the following goals for use on the command line
137
# all This is the default if no goal is specified. It builds the
140
# target Builds the target.
142
# upload Uploads the target (building it, as necessary) to an attached
145
# 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.
147
118
# boards Display a list of available board names, so that you can set the
148
119
# BOARD environment variable appropriately.
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.
121
# monitor Start `screen` on the serial device. It is ment to be an
122
# equivelant to the arduino serial monitor.
157
124
# <file> Builds the specified file, either an object file or the target,
158
125
# from those that that would be built for the project.
159
126
#_______________________________________________________________________________
162
# default arduino software directory, check software exists
129
# The full path to the arduino software, from arduino.cc
163
130
ifndef ARDUINODIR
164
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
165
/Applications/Arduino.app/Contents/Resources/Java \
166
$(HOME)/Applications/Arduino.app/Contents/Resources/Java))
131
ARDUINODIR := $(wildcard ~/opt/arduino)
168
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
134
# check arduino software
135
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
169
136
$(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)
236
140
INOFILE := $(wildcard *.ino *.pde)
238
ifneq "$(words $(INOFILE))" "1"
142
ifneq ($(words $(INOFILE)), 1)
239
143
$(error There is more than one .pde or .ino file in this directory!)
242
# automatically determine sources and targeet
243
145
TARGET := $(basename $(INOFILE))
244
146
SOURCES := $(INOFILE) \
245
$(wildcard *.c *.cc *.cpp *.C *.s *.S) \
246
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C *.s *.S)) \
247
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C *.s *.S))
147
$(wildcard *.c *.cc *.cpp) \
148
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
149
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
249
150
# automatically determine included libraries
250
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
251
$(shell sed -nre "s/^\s*\#\s*include\s*[<\"](\S+)\.h[>\"].*/\1/p" \
257
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
258
CC := $(call findsoftware,avr-gcc)
259
CXX := $(call findsoftware,avr-g++)
260
LD := $(call findsoftware,avr-ld)
261
AR := $(call findsoftware,avr-ar)
262
AS := $(call findsoftware,avr-as)
263
OBJCOPY := $(call findsoftware,avr-objcopy)
264
AVRDUDE := $(call findsoftware,avrdude)
265
AVRSIZE := $(call findsoftware,avr-size)
268
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/$(BOARD_BUILD_CORE)
269
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
270
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
271
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
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)
274
TARGET := $(if $(TARGET),$(TARGET),a.out)
275
176
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
276
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
277
ARDUINOLIB := .lib/arduino.a
278
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
279
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \
280
*.c *.cc *.cpp *.C *.s *.S))))
281
BOOTLOADERHEX := $(addprefix \
282
$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
283
$(BOARD_BOOTLOADER_FILE))
285
# avrdude confifuration
286
ifeq "$(AVRDUDECONF)" ""
287
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
288
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
290
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
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))
204
OBJCOPY := avr-objcopy
295
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
296
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
297
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
298
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
299
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
300
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
301
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
302
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
303
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
304
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
305
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
306
AVRDUDEFLAGS += -p$(BOARD_BUILD_MCU) -P$(SERIALDEV) -c$(BOARD_UPLOAD_PROTOCOL)
307
AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))
308
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
310
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
311
STTYFARG := $(shell stty --help 2>&1 | \
312
grep -q 'illegal option' && echo -f || echo -F)
314
# include dependencies
315
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)
320
220
.DEFAULT_GOAL := all