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 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, 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:
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. 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.
50
# 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
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.
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
75
58
# Alternatively, if you want to manually specify build variables, create a
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
77
# (There is no need to define TARGET). 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
79
# SOURCES := main.cc other.cc
65
# SOURCES := main.cc foo.cc
80
66
# LIBRARIES := EEPROM
81
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`.
83
84
# Here is a complete list of configuration parameters:
85
# ARDUINODIR The path where the Arduino software is installed on your system.
87
# 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
# AVRDUDEFLAGS Specify any additional flags for avrdude. The usual flags,
95
# required to build the project, will be appended to this.
97
# AVRTOOLSPATH A space-separated list of directories that is searched in order
98
# when looking for the avr build tools. This defaults to PATH,
99
# followed by subdirectories in ARDUINODIR.
101
# BOARD Specify a target board type. Run `make boards` to see available
104
# CPPFLAGS Specify any additional flags for the compiler. The usual flags,
105
# required to build the project, will be appended to this.
107
# LINKFLAGS Specify any additional flags for the linker. The usual flags,
108
# required to build the project, will be appended to this.
110
# LIBRARIES A list of Arduino libraries to build and include. This is set
111
# automatically if a .ino (or .pde) is found.
113
# LIBRARYPATH A space-separated list of directories that is searched in order
114
# when looking for Arduino libraries. This defaults to "libs",
115
# "libraries" and then the Arduino software's libraries directory.
117
# SERIALDEV The unix device name of the serial device that is the Arduino.
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.
118
92
# If unspecified, an attempt is made to determine the name of a
119
# connected Arduino's serial device.
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
121
99
# SOURCES A list of all source files of whatever language. The language
122
100
# type is determined by the file extension. This is set
123
# automatically if a .ino (or .pde) is found.
125
# TARGET The name of the target file. This is set automatically if a
126
# .ino (or .pde) is found, but it is not necessary to set it
129
# This makefile also defines the following goals for use on the command line
132
# all This is the default if no goal is specified. It builds the
135
# target Builds the target.
137
# upload Uploads the last built target to an attached Arduino.
139
# 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.
141
118
# boards Display a list of available board names, so that you can set the
142
119
# BOARD environment variable appropriately.
144
# monitor Start `screen` on the serial device. This is meant to be an
145
# equivalent to the Arduino serial monitor.
147
# size Displays size information about the bulit target.
149
# 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.
151
124
# <file> Builds the specified file, either an object file or the target,
152
125
# from those that that would be built for the project.
153
126
#_______________________________________________________________________________
156
# default arduino software directory, check software exists
129
# The full path to the arduino software, from arduino.cc
157
130
ifndef ARDUINODIR
158
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
131
ARDUINODIR := $(wildcard ~/opt/arduino)
160
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
134
# check arduino software
135
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
161
136
$(error ARDUINODIR is not set correctly; arduino software not found)
164
# default arduino version
167
# default path for avr tools
168
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
169
$(ARDUINODIR)/hardware/tools/avr/bin
171
# default path to find libraries
172
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
174
# default serial device to a poor guess (something that might be an arduino)
177
SERIALDEV := $(firstword $(wildcard \
178
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
184
ifneq "$(MAKECMDGOALS)" "boards"
185
ifneq "$(MAKECMDGOALS)" "clean"
186
$(error BOARD is unset. Type 'make boards' to see possible values)
191
# obtain board parameters from the arduino boards.txt file
192
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
193
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
194
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
195
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
196
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
197
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
198
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
199
BOARD_USB_VID := $(call readboardsparam,build.vid)
200
BOARD_USB_PID := $(call readboardsparam,build.pid)
201
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
202
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
203
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
204
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
205
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
206
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
207
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
209
# obtain preferences from the IDE's preferences.txt
210
PREFERENCESFILE := $(wildcard $(HOME)/.arduino/preferences.txt)
211
ifneq "$(PREFERENCESFILE)" ""
212
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
213
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
217
ifeq "$(BOARD_BUILD_MCU)" ""
218
ifneq "$(MAKECMDGOALS)" "boards"
219
ifneq "$(MAKECMDGOALS)" "clean"
220
$(error BOARD is invalid. Type 'make boards' to see possible values)
226
140
INOFILE := $(wildcard *.ino *.pde)
228
ifneq "$(words $(INOFILE))" "1"
142
ifneq ($(words $(INOFILE)), 1)
229
143
$(error There is more than one .pde or .ino file in this directory!)
232
# automatically determine sources and targeet
233
145
TARGET := $(basename $(INOFILE))
234
146
SOURCES := $(INOFILE) \
235
$(wildcard *.c *.cc *.cpp *.C) \
236
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
237
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
147
$(wildcard *.c *.cc *.cpp) \
148
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
149
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
239
150
# automatically determine included libraries
240
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
151
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
152
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
241
153
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
246
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
247
CC := $(call findsoftware,avr-gcc)
248
CXX := $(call findsoftware,avr-g++)
249
LD := $(call findsoftware,avr-ld)
250
AR := $(call findsoftware,avr-ar)
251
OBJCOPY := $(call findsoftware,avr-objcopy)
252
AVRDUDE := $(call findsoftware,avrdude)
253
AVRSIZE := $(call findsoftware,avr-size)
256
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
257
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
258
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
259
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
261
$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)
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)
264
TARGET := $(if $(TARGET),$(TARGET),a.out)
265
176
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
266
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
267
ARDUINOLIB := .lib/arduino.a
268
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
269
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
270
BOOTLOADERHEX := $(wildcard $(BOOTLOADERDIR)/$(BOARD_BOOTLOADER_FILE))
272
# avrdude confifuration
273
ifeq "$(AVRDUDECONF)" ""
274
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
275
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
277
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
282
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
283
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
284
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
285
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
286
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
287
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
288
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
289
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
290
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
291
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
292
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
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
293
215
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
294
216
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
295
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
297
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
298
STTYFARG := $(shell stty --help 2>&1 | \
299
grep -q 'illegal option' && echo -f || echo -F)
301
# include dependencies
302
ifneq "$(MAKECMDGOALS)" "clean"
217
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
307
220
.DEFAULT_GOAL := all