/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-01-25 14:24:01 UTC
  • Revision ID: edam@waxworlds.org-20120125142401-t6mwsp0621wd8w6q
fixed URL

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
36
36
#
37
37
#   http://ed.am/dev/make/arduino-mk
38
38
#
 
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
 
43
# from arduino.cc.
 
44
#
39
45
# This makefile can be used as a drop-in replacement for the Arduino IDE's
40
 
# build system.  To use it, save arduino.mk somewhere (I keep mine at
41
 
# ~/src/arduino.mk) and create a symlink to it in your project directory named
42
 
# "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
49
#
44
50
#   $ ln -s ~/src/arduino.mk Makefile
45
51
#
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
49
 
# your ~/.profile by adding something like this:
50
 
#
51
 
#   export ARDUINODIR=~/somewhere/arduino-1.0
52
 
#
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:
56
 
#
57
 
#   $ export BOARD=uno
58
 
#   $ make
59
 
#
60
 
# You may also need to set SERIALDEV if it is not detected correctly.
61
 
#
62
52
# The presence of a .ino or .pde file causes the arduino.mk to atuomatically
63
53
# 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.
 
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
 
56
# been #included.
67
57
#
68
58
# Alternatively, if you want to manually specify build variables, create a
69
59
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
70
 
# (There is no need to define TARGET).  Here is an example Makefile:
 
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
 
63
# example Makefile:
71
64
#
72
 
#   SOURCES := main.cc other.cc
 
65
#   SOURCES := main.cc foo.cc
73
66
#   LIBRARIES := EEPROM
74
67
#   include ~/src/arduino.mk
75
68
#
 
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,
 
73
# SERIALDEV.
 
74
#
 
75
# When running make, you might want to specify the board and path to your
 
76
# installation of the arduino software, like this:
 
77
#
 
78
#   $ export ARDUINODIR=~/opt/arduino
 
79
#   $ export BOARD=pro5v
 
80
#   $ make
 
81
#
 
82
# For a list of available board types, run `make boards`.
 
83
# 
76
84
# Here is a complete list of configuration parameters:
77
85
#
78
86
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
87
#              (from http://arduino.cc/)
80
88
#
81
 
# BOARD        Specify a target board type.  Run `make boards` to see available
82
 
#              board types.
 
89
# BOARD        Specify a target board type.
83
90
#
84
91
# SERIALDEV    The unix device of the device where the arduino can be found.
85
92
#              If unspecified, an attempt is made to determine the name of a
96
103
# LIBRARIES    A list of arduino libraries to build and include.  This is set
97
104
#              automatically if a .ino or .pde is found.
98
105
#
99
 
# This makefile also defines the following goals for use on the command line
100
 
# when you run make:
 
106
# This general-purpose makefile also defines the following goals for
 
107
# use on the command line when you run make:
101
108
#
102
 
# all          This is the default if no goal is specified.  It builds the
 
109
# all          This is the default if no goal is specified. It builds the
103
110
#              target and uploads it.
104
111
#
105
 
# target       Builds the target.
106
 
#
107
 
# upload       Uploads the last built target to an attached arduino.
108
 
#
109
 
# clean        Deletes files created during the build.
 
112
# target       Builds the target of your Makefile.
 
113
#
 
114
# upload       Uploads the target to an attached arduino.
 
115
#
 
116
# clean        Deletes temporary files.
110
117
#
111
118
# boards       Display a list of available board names, so that you can set the
112
119
#              BOARD environment variable appropriately.
222
229
target: $(TARGET).hex
223
230
 
224
231
upload:
225
 
        @echo "\nUploading to board..."
226
 
        @test -n "$(SERIALDEV)" || { \
227
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
228
 
                exit 1; }
229
232
        stty -F $(SERIALDEV) hupcl
230
233
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
231
234
 
240
243
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
241
244
 
242
245
monitor:
243
 
        @test -n "$(SERIALDEV)" || { \
244
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
245
 
                exit 1; }
246
246
        screen $(SERIALDEV)
247
247
 
248
248
# building the target