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
# 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.
98
# 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.
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.
105
92
# If unspecified, an attempt is made to determine the name of a
106
# 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
108
99
# SOURCES A list of all source files of whatever language. The language
109
100
# type is determined by the file extension. This is set
110
# 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
116
# This makefile also defines the following goals for use on the command line
119
# all This is the default if no goal is specified. It builds the
122
# target Builds the target.
124
# upload Uploads the last built target to an attached Arduino.
126
# 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.
128
118
# boards Display a list of available board names, so that you can set the
129
119
# 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.
121
# monitor Start `screen` on the serial device. It is ment to be an
122
# equivelant to the arduino serial monitor.
136
124
# <file> Builds the specified file, either an object file or the target,
137
125
# from those that that would be built for the project.
138
126
#_______________________________________________________________________________
141
# default arduino software directory, check software exists
129
# The full path to the arduino software, from arduino.cc
142
130
ifndef ARDUINODIR
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
131
ARDUINODIR := $(wildcard ~/opt/arduino)
145
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
134
# check arduino software
135
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
146
136
$(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
140
INOFILE := $(wildcard *.ino *.pde)
162
ifneq "$(words $(INOFILE))" "1"
142
ifneq ($(words $(INOFILE)), 1)
163
143
$(error There is more than one .pde or .ino file in this directory!)
166
# automatically determine sources and targeet
167
145
TARGET := $(basename $(INOFILE))
168
146
SOURCES := $(INOFILE) \
169
147
$(wildcard *.c *.cc *.cpp) \
170
148
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
171
149
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
173
150
# automatically determine included libraries
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
151
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
152
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
175
153
$(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)
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)
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
199
176
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)
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))))))
225
186
# obtain board parameters from the arduino boards.txt file
226
187
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt