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. 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
49
54
# your ~/.profile by adding something like this:
51
56
# 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:
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
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.
68
75
# Alternatively, if you want to manually specify build variables, create a
69
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
70
77
# (There is no need to define TARGET). Here is an example Makefile:
72
79
# SOURCES := main.cc other.cc
76
83
# 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/)
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.
81
101
# 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.
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.
85
118
# If unspecified, an attempt is made to determine the name of a
86
# connected arduino's serial device.
119
# connected Arduino's serial device.
121
# SOURCES A list of all source files of whatever language. The language
122
# type is determined by the file extension. This is set
123
# automatically if a .ino (or .pde) is found.
88
125
# 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
126
# .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
129
# This makefile also defines the following goals for use on the command line
100
130
# when you run make:
102
132
# all This is the default if no goal is specified. It builds the
103
# target and uploads it.
105
135
# target Builds the target.
107
# upload Uploads the last built target to an attached arduino.
137
# upload Uploads the last built target to an attached Arduino.
109
139
# clean Deletes files created during the build.
111
141
# boards Display a list of available board names, so that you can set the
112
142
# 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.
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.
117
151
# <file> Builds the specified file, either an object file or the target,
118
152
# from those that that would be built for the project.
119
153
#_______________________________________________________________________________
122
# The full path to the arduino software, from arduino.cc
156
# default arduino software directory, check software exists
123
157
ifndef ARDUINODIR
124
ARDUINODIR := $(wildcard ~/opt/arduino)
158
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
127
# check arduino software
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
160
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
129
161
$(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)
133
226
INOFILE := $(wildcard *.ino *.pde)
135
ifneq ($(words $(INOFILE)), 1)
228
ifneq "$(words $(INOFILE))" "1"
136
229
$(error There is more than one .pde or .ino file in this directory!)
232
# automatically determine sources and targeet
138
233
TARGET := $(basename $(INOFILE))
139
234
SOURCES := $(INOFILE) \
140
$(wildcard *.c *.cc *.cpp) \
141
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
142
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
235
$(wildcard *.c *.cc *.cpp *.C) \
236
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
237
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
143
239
# automatically determine included libraries
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
240
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
146
241
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
149
# no target? use default
154
# no serial device? attempt to detect an arduino
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)
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)
264
TARGET := $(if $(TARGET),$(TARGET),a.out)
169
265
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
171
ARDUINOLIB := _arduino.a
172
ARDUINOLIBTMP := _arduino.a.tmp
173
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
174
$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
175
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
176
$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
177
$(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
179
# obtain board parameters from the arduino boards.txt file
180
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
182
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
183
BOARD_BUILD_FCPU := \
184
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
185
BOARD_BUILD_VARIANT := \
186
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
187
BOARD_UPLOAD_SPEED := \
188
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
189
BOARD_UPLOAD_PROTOCOL := \
190
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
197
OBJCOPY := avr-objcopy
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)
201
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
202
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
203
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
204
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
205
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
206
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
207
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
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
293
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
209
294
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
210
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
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"
213
307
.DEFAULT_GOAL := all
215
309
#_______________________________________________________________________________
218
.PHONY: all target upload clean boards monitor
312
.PHONY: all target upload clean boards monitor size bootloader
222
316
target: $(TARGET).hex
225
stty -F $(SERIALDEV) hupcl
319
@echo "\nUploading to board..."
320
@test -n "$(SERIALDEV)" || { \
321
echo "error: SERIALDEV could not be determined automatically." >&2; \
323
@test 0 -eq $(SERIALDEVGUESS) || { \
324
echo "*GUESSING* at serial device:" $(SERIALDEV); \
326
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
327
stty $(STTYFARG) $(SERIALDEV) speed 1200
330
stty $(STTYFARG) $(SERIALDEV) hupcl
226
331
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
230
335
rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
231
rm -rf $(ARDUINOLIBTMP)
234
@echo Available values for BOARD:
235
@sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1 \2/;T' \
236
-e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
339
@echo "Available values for BOARD:"
340
@sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
341
sed -Ee 's/([^.]+)\.name=(.*)/\1 \2/' \
342
-e 's/(.{12}) *(.*)/\1 \2/'
345
@test -n "$(SERIALDEV)" || { \
346
echo "error: SERIALDEV could not be determined automatically." >&2; \
348
@test -n `which screen` || { \
349
echo "error: can't find GNU screen, you might need to install it." >&2 \
351
@test 0 -eq $(SERIALDEVGUESS) || { \
352
echo "*GUESSING* at serial device:" $(SERIALDEV); \
239
354
screen $(SERIALDEV)
357
echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
360
@echo "Burning bootloader to board..."
361
@test -n "$(BOOTLOADERHEX)" || { \
362
echo "error: bootloader file could not be determined." >&2; \
364
@test -n "$(SERIALDEV)" || { \
365
echo "error: SERIALDEV could not be determined automatically." >&2; \
367
@test 0 -eq $(SERIALDEVGUESS) || { \
368
echo "*GUESSING* at serial device:" $(SERIALDEV); \
370
stty $(STTYFARG) $(SERIALDEV) hupcl
371
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
372
$(AVRDUDE) $(AVRDUDEFLAGS) -e -U lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m \
373
-U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m \
374
$(patsubst %, -U efuse:w:%:m, $(BOARD_BOOTLOADER_EFUSES))
375
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
376
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
241
378
# building the target
243
380
$(TARGET).hex: $(TARGET).elf