/make/arduino-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/arduino-mk

« back to all changes in this revision

Viewing changes to arduino.mk

  • Committer: edam
  • Date: 2012-02-21 15:27:09 UTC
  • Revision ID: tim@ed.am-20120221152709-zo3surexmx2789wn
added THANKS, fixed ARDUINODIR default to look in /usr/share/arduino and capitalised the use of "Arduino" where appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
#
3
3
#                         edam's arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                    version 0.1
 
5
#                                                                    version 0.3
6
6
#
7
 
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 1012 Tim Marston <tim@ed.am>.
8
8
#
9
9
# Permission is hereby granted, free of charge, to any person obtaining a copy
10
10
# of this software and associated documentation files (the "Software"), to deal
28
28
#
29
29
#
30
30
# This is a general purpose makefile for use with Arduino hardware and
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.
 
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.
36
35
#
37
36
#   http://ed.am/dev/make/arduino-mk
38
37
#
43
42
#
44
43
#   $ ln -s ~/src/arduino.mk Makefile
45
44
#
46
 
# You also need to set up a couple of environment variables. 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.
 
49
#
 
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:
50
55
#
51
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
52
57
#
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
 
# override it as necessary).  For example:
 
58
# You will also need to set BOARD to the type of Arduino you're building for.
 
59
# You could set a default in your ~/.profile if you want, but it is suggested
 
60
# that you specify this at build time, especially if you work with different
 
61
# types of Arduino.  For example:
56
62
#
57
63
#   $ export BOARD=uno
58
64
#   $ make
75
81
#
76
82
# Here is a complete list of configuration parameters:
77
83
#
78
 
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
 
#              (from http://arduino.cc/)
80
 
#
81
 
# ARDUINOCONST The arduino software version, as an integer, used to define the
82
 
#              ARDUINO version constant. This defaults to 100 if unset.
 
84
# ARDUINODIR   The path where the Arduino software is installed on your system.
 
85
#
 
86
# ARDUINOCONST The Arduino software version, as an integer, used to define the
 
87
#              ARDUINO version constant. This defaults to 100 if undefined.
 
88
#
 
89
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
 
90
#              based on where the avrdude in use is. If empty, no avrdude.conf
 
91
#              is passed to avrdude (to the system default is used).
83
92
#
84
93
# AVRTOOLSPATH A space-separated list of directories to search in order when
85
94
#              lookin for the avr build tools. This defaults to the system PATH
86
 
#              followed by subdirectories in ARDUINODIR if unset.
 
95
#              followed by subdirectories in ARDUINODIR if undefined.
87
96
#
88
97
# BOARD        Specify a target board type.  Run `make boards` to see available
89
98
#              board types.
90
99
#
91
 
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
100
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
92
101
#              automatically if a .ino (or .pde) is found.
93
102
#
94
 
# SERIALDEV    The unix device name of the serial device that is the arduino.
 
103
# SERIALDEV    The unix device name of the serial device that is the Arduino.
95
104
#              If unspecified, an attempt is made to determine the name of a
96
 
#              connected arduino's serial device.
 
105
#              connected Arduino's serial device.
97
106
#
98
107
# SOURCES      A list of all source files of whatever language.  The language
99
108
#              type is determined by the file extension.  This is set
111
120
#
112
121
# target       Builds the target.
113
122
#
114
 
# upload       Uploads the last built target to an attached arduino.
 
123
# upload       Uploads the last built target to an attached Arduino.
115
124
#
116
125
# clean        Deletes files created during the build.
117
126
#
119
128
#              BOARD environment variable appropriately.
120
129
#
121
130
# monitor      Start `screen` on the serial device.  This is meant to be an
122
 
#              equivalent to the arduino serial monitor.
 
131
#              equivalent to the Arduino serial monitor.
123
132
#
124
133
# <file>       Builds the specified file, either an object file or the target,
125
134
#              from those that that would be built for the project.
128
137
 
129
138
# default arduino software directory, check software exists
130
139
ifndef ARDUINODIR
131
 
ARDUINODIR := $(wildcard ~/opt/arduino)
 
140
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
132
141
endif
133
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
142
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
134
143
$(error ARDUINODIR is not set correctly; arduino software not found)
135
144
endif
136
145
 
147
156
# auto mode?
148
157
INOFILE := $(wildcard *.ino *.pde)
149
158
ifdef INOFILE
150
 
ifneq ($(words $(INOFILE)), 1)
 
159
ifneq "$(words $(INOFILE))" "1"
151
160
$(error There is more than one .pde or .ino file in this directory!)
152
161
endif
153
162
 
165
174
 
166
175
endif
167
176
 
168
 
# no board? oh dear...
169
 
ifndef BOARD
170
 
ifneq "$(MAKECMDGOALS)" "boards"
171
 
ifneq "$(MAKECMDGOALS)" "clean"
172
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
173
 
endif
174
 
endif
175
 
endif
176
 
 
177
177
# no serial device? make a poor attempt to detect an arduino
178
 
ifeq ($(SERIALDEV), )
179
 
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
 
178
SERIALDEVGUESS := 0
 
179
ifeq "$(SERIALDEV)" ""
 
180
SERIALDEV := $(firstword $(wildcard \
 
181
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
182
SERIALDEVGUESS := 1
180
183
endif
181
184
 
182
185
# software
189
192
AVRDUDE := $(call findsoftware,avrdude)
190
193
 
191
194
# files
192
 
TARGET := $(if $(TARGET), $(TARGET), a.out)
 
195
TARGET := $(if $(TARGET),$(TARGET),a.out)
193
196
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
194
197
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
195
198
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
201
204
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
205
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
203
206
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
207
ifeq "$(AVRDUDECONF)" ""
 
208
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
209
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
210
else
204
211
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
212
endif
 
213
endif
 
214
 
 
215
# no board?
 
216
ifndef BOARD
 
217
ifneq "$(MAKECMDGOALS)" "boards"
 
218
ifneq "$(MAKECMDGOALS)" "clean"
 
219
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
220
endif
 
221
endif
 
222
endif
205
223
 
206
224
# obtain board parameters from the arduino boards.txt file
207
225
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
216
234
BOARD_UPLOAD_PROTOCOL := \
217
235
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
218
236
 
 
237
# invalid board?
 
238
ifeq "$(BOARD_BUILD_MCU)" ""
 
239
ifneq "$(MAKECMDGOALS)" "boards"
 
240
ifneq "$(MAKECMDGOALS)" "clean"
 
241
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
242
endif
 
243
endif
 
244
endif
 
245
 
219
246
# flags
220
247
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
221
248
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
230
257
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
231
258
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
232
259
 
 
260
# figure out which arg to use with stty
 
261
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
262
 
233
263
# default rule
234
264
.DEFAULT_GOAL := all
235
265
 
247
277
        @test -n "$(SERIALDEV)" || { \
248
278
                echo "error: SERIALDEV could not be determined automatically." >&2; \
249
279
                exit 1; }
250
 
        stty -F $(SERIALDEV) hupcl
 
280
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
281
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
282
                echo; }
 
283
        stty $(STTYFARG) $(SERIALDEV) hupcl
251
284
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
252
285
 
253
286
clean:
267
300
        @test -n `which screen` || { \
268
301
                echo "error: can't find GNU screen, you might need to install it." >&2 \
269
302
                ecit 1; }
 
303
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
304
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
305
                echo; }
270
306
        screen $(SERIALDEV)
271
307
 
272
308
# building the target