/make/arduino-mk : revision 12

21

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

22

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

23

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

24

# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

25

# THE SOFTWARE.

24

# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

25

# SOFTWARE.

26

#

27

#_______________________________________________________________________________

28

#

29

#

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

32

# software to be downloaded separately (see http://arduino.cc/). To

33

# download the latest version of this makefile, visit the following

34

# website, where you can also find more information and documentation

35

# on it's use. The following text can only really be considered a

36

# reference to it's use.

37

#

38

# http://ed.am/dev/make/arduino-makefile

39

#

40

# To install, it is suggested that you keep arduino.mk somewhere and

41

# either symlink to it or include it in your make files. I keep mine

42

# at ~/src/arduino.mk. You will need to alter the value of the

43

# ARDUINODIR variable (below) to be the path where you have unpacked

44

# the arduino software from arduino.cc.

45

#

46

# This makefile can be used as a drop-in replacement for the Arduino

47

# IDE's build system. Simply create a symlink to it under the name

48

# "Makefile" and run make (remembering to specify an ARDUINODIR and

49

# BOARD, as described below). You would create the symlink like like

50

# so:

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

38

#

39

# 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:

51

43

#

52

44

# $ ln -s ~/src/arduino.mk Makefile

53

45

#

54

# The presence of a .ino or .pde file causes the arduino.mk to

55

# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.

56

# Any .c, .cc and .cpp files in the project directory (or a "util" or

57

# "utility" subdirectory) are automatically included in the build and

58

# are scanned for libraries that have been #included.

59

#

60

# Alternatively, if you want to manually specify build variables,

61

# create a Makefile that defines SOURCES and LIBRARARIES and then

62

# includes arduino.mk. (There is no need to define TARGET). You will

63

# also be expected to provide a main() function, for example in

64

# main.cc, which may or may not duplicate the functionality of the

65

# default main() that calls init() and loop(). Here is an example

66

# Makefile:

67

#

68

# SOURCES := main.cc foo.cc

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

# 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.

67

#

68

# Alternatively, if you want to manually specify build variables, create a

69

# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.

70

# (There is no need to define TARGET). Here is an example Makefile:

71

#

72

# SOURCES := main.cc other.cc

69

73

# LIBRARIES := EEPROM

70

74

# include ~/src/arduino.mk

71

75

#

72

# A complete list of all the settings you can use in your Makefile

73

# follows shortly. It should be noted, however, that some variables

74

# are better specified in the environment (or on the command line)

75

# than in your Makefile. Specifically, the ARDUINODIR, BOARD and, if

76

# it is not automatically detected, SERIALDEV.

77

#

78

# When running make, you might want to specify the board and path to

79

# your installation of the arduino software, like this:

80

#

81

# $ export ARDUINODIR=~/opt/arduino-1.0

82

# $ export BOARD=pro5v

83

# $ make

84

#

85

# For a list of available board types, run `make boards`.

86

#

87

76

# Here is a complete list of configuration parameters:

88

77

#

89

# ARDUINODIR The path where you have installed/unpacked the arduino

90

# software (from http://arduino.cc/)

91

#

92

# BOARD Specify a target board type.

93

#

94

# SERIALDEV The unix device of the device where the arduino can be

95

# found. If unspecified, an attempt is made to determine

96

# the name of a connected arduino's serial device.

97

#

98

# TARGET The name of the target file. This is set automatically

99

# if a .ino or .pde is found, but it is not neccesary to

100

# set it otherwise.

101

#

102

# SOURCES A list of all source files of whatever language. The

103

# language type is determined by the file extension.

104

# This is set automatically if a .ino or .pde is found.

105

#

106

# LIBRARIES A list of arduino libraries to build and include. This

107

# is set automatically if a .ino or .pde is found.

108

#

109

# This general-purpose makefile also defines the following goals for

110

# use on the command line when you run make:

111

#

112

# all This is the default if no goal is specified. It builds

113

# the target and uploads it.

114

#

115

# target Builds the target of your Makefile.

116

#

117

# upload Uploads the target to an attached arduino.

118

#

119

# clean Deletes temporary files.

120

#

121

# <file> Builds the specified file, either an object file or the

122

# target, from those that that would be built for the

123

# project.

124

#

125

# boards This is not a real goal. It just displays a list of

126

# available board names, so that you can set the BOARD

127

# environment variable appropriately.

128

#

129

# monitor This is not a real goal. It starts screen on the serial

130

# device. It is ment to be an equivelant to the arduino

131

# serial monitor.

78

# ARDUINODIR The path where you have installed/unpacked the arduino software

79

# (from http://arduino.cc/)

80

#

81

# BOARD Specify a target board type. Run `make boards` to see available

82

# board types.

83

#

84

# SERIALDEV The unix device of the device where the arduino can be found.

85

# If unspecified, an attempt is made to determine the name of a

86

# connected arduino's serial device.

87

#

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

90

# otherwise.

91

#

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.

95

#

96

# LIBRARIES A list of arduino libraries to build and include. This is set

97

# automatically if a .ino or .pde is found.

98

#

99

# This makefile also defines the following goals for use on the command line

100

# when you run make:

101

#

102

# all This is the default if no goal is specified. It builds the

103

# target and uploads it.

104

#

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.

110

#

111

# boards Display a list of available board names, so that you can set the

112

# BOARD environment variable appropriately.

113

#

114

# monitor Start `screen` on the serial device. It is ment to be an

115

# equivelant to the arduino serial monitor.

116

#

117

# <file> Builds the specified file, either an object file or the target,

118

# from those that that would be built for the project.

132

119

#_______________________________________________________________________________

133

120

#

134

121

135

122

# The full path to the arduino software, from arduino.cc

136

123

ifndef ARDUINODIR

137

ARDUINODIR := $(wildcard ~/opt/arduino-1.0)

124

ARDUINODIR := $(wildcard ~/opt/arduino)

138

125

endif

139

126

140

127

# check arduino software