43
44
# $ 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
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
54
49
# your ~/.profile by adding something like this:
56
51
# 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
# 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:
64
57
# $ export BOARD=uno
67
60
# 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.
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.
75
68
# Alternatively, if you want to manually specify build variables, create a
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
69
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
77
70
# (There is no need to define TARGET). Here is an example Makefile:
79
72
# SOURCES := main.cc other.cc
83
76
# 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
# 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.
78
# ARDUINODIR The path where you have installed/unpacked the arduino software
79
# (from http://arduino.cc/)
98
81
# BOARD Specify a target board type. Run `make boards` to see available
101
# LIBRARIES A list of Arduino libraries to build and include. This is set
102
# automatically if a .ino (or .pde) is found.
104
# SERIALDEV The unix device name of the serial device that is the Arduino.
84
# SERIALDEV The unix device of the device where the arduino can be found.
105
85
# If unspecified, an attempt is made to determine the name of a
106
# connected Arduino's serial device.
86
# connected arduino's serial device.
88
# 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
108
92
# SOURCES A list of all source files of whatever language. The language
109
93
# type is determined by the file extension. This is set
110
# automatically if a .ino (or .pde) is found.
94
# automatically if a .ino or .pde is found.
112
# TARGET The name of the target file. This is set automatically if a
113
# .ino (or .pde) is found, but it is not necessary to set it
96
# LIBRARIES A list of arduino libraries to build and include. This is set
97
# automatically if a .ino or .pde is found.
116
99
# This makefile also defines the following goals for use on the command line
117
100
# when you run make:
119
102
# all This is the default if no goal is specified. It builds the
103
# target and uploads it.
122
105
# target Builds the target.
124
# upload Uploads the last built target to an attached Arduino.
107
# upload Uploads the last built target to an attached arduino.
126
109
# clean Deletes files created during the build.
128
111
# boards Display a list of available board names, so that you can set the
129
112
# BOARD environment variable appropriately.
131
# monitor Start `screen` on the serial device. This is meant to be an
132
# equivalent to the Arduino serial monitor.
134
# size Displays size information about the bulit target.
114
# monitor Start `screen` on the serial device. It is ment to be an
115
# equivelant to the arduino serial monitor.
136
117
# <file> Builds the specified file, either an object file or the target,
137
118
# from those that that would be built for the project.
138
119
#_______________________________________________________________________________
141
# default arduino software directory, check software exists
122
# The full path to the arduino software, from arduino.cc
142
123
ifndef ARDUINODIR
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
124
ARDUINODIR := $(wildcard ~/opt/arduino)
145
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
127
# check arduino software
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
146
129
$(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
160
133
INOFILE := $(wildcard *.ino *.pde)
162
ifneq "$(words $(INOFILE))" "1"
135
ifneq ($(words $(INOFILE)), 1)
163
136
$(error There is more than one .pde or .ino file in this directory!)
166
# automatically determine sources and targeet
167
138
TARGET := $(basename $(INOFILE))
168
139
SOURCES := $(INOFILE) \
169
140
$(wildcard *.c *.cc *.cpp) \
170
141
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
171
142
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
173
143
# automatically determine included libraries
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
175
146
$(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.usbserial* /dev/tty.usbmodem*))
188
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
189
CC := $(call findsoftware,avr-gcc)
190
CXX := $(call findsoftware,avr-g++)
191
LD := $(call findsoftware,avr-ld)
192
AR := $(call findsoftware,avr-ar)
193
OBJCOPY := $(call findsoftware,avr-objcopy)
194
AVRDUDE := $(call findsoftware,avrdude)
195
AVRSIZE := $(call findsoftware,avr-size)
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)
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
199
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
200
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
201
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
202
ARDUINOLIB := .lib/arduino.a
203
ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries
204
ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \
205
$(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )
206
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \
207
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
208
ifeq "$(AVRDUDECONF)" ""
209
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
210
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
212
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
218
ifneq "$(MAKECMDGOALS)" "boards"
219
ifneq "$(MAKECMDGOALS)" "clean"
220
$(error BOARD is unset. Type 'make boards' to see possible values)
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)) ))))
225
181
# obtain board parameters from the arduino boards.txt file
226
182
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
235
191
BOARD_UPLOAD_PROTOCOL := \
236
192
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
239
ifeq "$(BOARD_BUILD_MCU)" ""
240
ifneq "$(MAKECMDGOALS)" "boards"
241
ifneq "$(MAKECMDGOALS)" "clean"
242
$(error BOARD is invalid. Type 'make boards' to see possible values)
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)
248
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
249
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
250
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
251
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
252
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOCOREDIR)
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)
253
214
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
254
215
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
255
216
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
256
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
257
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
258
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
217
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
259
218
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
260
219
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
261
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
263
# figure out which arg to use with stty
264
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
266
# include dependencies
267
ifneq "$(MAKECMDGOALS)" "clean"
220
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
272
223
.DEFAULT_GOAL := all
274
225
#_______________________________________________________________________________
277
.PHONY: all target upload clean boards monitor size
228
.PHONY: all target upload clean boards monitor
281
232
target: $(TARGET).hex
284
235
@echo "\nUploading to board..."
285
236
@test -n "$(SERIALDEV)" || { \
286
237
echo "error: SERIALDEV could not be determined automatically." >&2; \
288
@test 0 -eq $(SERIALDEVGUESS) || { \
289
echo "*GUESSING* at serial device:" $(SERIALDEV); \
291
stty $(STTYFARG) $(SERIALDEV) hupcl
239
stty -F $(SERIALDEV) hupcl
292
240
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
296
244
rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
245
rm -rf $(ARDUINOLIBTMP)
300
248
@echo Available values for BOARD:
301
@sed -ne '/^#/d; /^[^.]\+\.name=/p' $(BOARDS_FILE) | \
302
sed -e 's/\([^.]\+\)\.name=\(.*\)/\1 \2/' \
303
-e 's/\(.\{12\}\) *\(.*\)/\1 \2/'
249
@sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1 \2/;T' \
250
-e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
306
253
@test -n "$(SERIALDEV)" || { \
307
254
echo "error: SERIALDEV could not be determined automatically." >&2; \
309
@test -n `which screen` || { \
310
echo "error: can't find GNU screen, you might need to install it." >&2 \
312
@test 0 -eq $(SERIALDEVGUESS) || { \
313
echo "*GUESSING* at serial device:" $(SERIALDEV); \
315
256
screen $(SERIALDEV)
318
echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
320
258
# building the target
322
260
$(TARGET).hex: $(TARGET).elf
327
265
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
328
266
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
331
mkdir -p .dep/$(dir $<)
332
$(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
335
mkdir -p .dep/$(dir $<)
336
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
339
mkdir -p .dep/$(dir $<)
340
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
343
mkdir -p .dep/$(dir $<)
344
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
347
mkdir -p .dep/$(dir $<)
348
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
269
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
351
mkdir -p .dep/$(dir $<)
352
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ -x c++ -include $(ARDUINOCOREDIR)/Arduino.h $<
272
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
354
274
# building the arduino library
356
276
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
361
$(COMPILE.c) -o $@ $<
365
$(COMPILE.cpp) -o $@ $<
369
$(COMPILE.cpp) -o $@ $<
278
rm -rf $(ARDUINOLIBTMP)
280
.INTERMEDIATE: $(ARDUINOLIBOBJS)
282
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
283
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
284
$(COMPILE.c) -o $@ $<
286
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
287
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
288
$(COMPILE.cpp) -o $@ $<
290
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
291
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
292
$(COMPILE.c) -o $@ $<
294
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
295
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
296
$(COMPILE.cpp) -o $@ $<
298
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
299
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
300
$(COMPILE.c) -o $@ $<
302
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
303
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
373
304
$(COMPILE.cpp) -o $@ $<