Arduino Playground is read-only starting December 31st, 2018. For more info please look at this Forum Post 

build_arduino.py - command line build script
Author:  Ben Sasson

This script is intended to build and upload Arduino sketches.

Usage:

  1. Usage: build_arduino.py [options]
  3. Options:
  4. -h, --help show this help message and exit
  5. -d DIRECTORY, --directory=DIRECTORY
  6. project directory
  7. -v, --verbose be verbose
  8. --only-build only build, don't upload
  9. -u DEVICE, --upload-device=DEVICE
  10. use DEVICE to upload code
  11. -i DIRECTORY, --include=DIRECTORY
  12. append DIRECTORY to include list
  13. -l DIRECTORY, --libraries=DIRECTORY
  14. append DIRECTORY to libraries search & build path
  15. -W DIRECTORY, --WProgram-dir=DIRECTORY
  16. DIRECTORY of WProgram.h and the rest of core files
  17. --avr-path=DIRECTORY DIRECTORY where avr* programs located, if not
  18. specified - will assume found in default search path
  19. --dude-conf=FILE avrdude conf file, if not specified - will assume
  20. found in default location
  21. --simulate only simulate commands
  22. --core=CORE device core name [arduino]
  23. --arch=ARCH device architecture name [atmega328p]
  24. --baud=BAUD upload baud rate [57600]
  25. --cpu-clock=Hz target device CPU clock [16000000]
[Get Code]

Code:

  1. #!/usr/bin/env python
  3. #
  4. # build_arduino.py - build, link and upload sketches script for Arduino
  5. # Copyright (c) 2010 Ben Sasson. All right reserved.
  6. #
  7. # This program is free software: you can redistribute it and/or modify
  8. # it under the terms of the GNU General Public License as published by
  9. # the Free Software Foundation, either version 3 of the License, or
  10. # (at your option) any later version.
  11. #
  12. # This program is distributed in the hope that it will be useful,
  13. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. # GNU General Public License for more details.
  16. #
  17. # You should have received a copy of the GNU General Public License
  18. # along with this program. If not, see <https://www.gnu.org/licenses/>.
  19. #
  22. import sys
  23. import os
  24. import optparse
  27. EXITCODE_OK = 0
  28. EXITCODE_NO_UPLOAD_DEVICE = 1
  29. EXITCODE_NO_WPROGRAM = 2
  30. EXITCODE_INVALID_AVR_PATH = 3
  33. CPU_CLOCK = 16000000
  34. ARCH = 'atmega328p'
  35. ENV_VERSION = 18
  36. BAUD = 57600
  37. CORE = 'arduino'
  40. COMPILERS = {
  41. '.c': 'avr-gcc',
  42. '.cpp': 'avr-g++',
  43. }
  46. def _exec(cmdline, debug=True, valid_exitcode=0, simulate=False):
  47. if debug or simulate:
  48. print(cmdline)
  49. if not simulate:
  50. exitcode = os.system(cmdline)
  51. if exitcode != valid_exitcode:
  52. print('-'*20 + ' exitcode %d ' % exitcode + '-'*20)
  53. sys.exit(exitcode)
  56. def compile_source(source, avr_path='', target_dir=None, arch=ARCH, clock=CPU_CLOCK, include_dirs=[], verbose=False, simulate=False):
  57. """
  58. compile a single source file, using compiler selected based on file extension and translating arguments
  59. to valid compiler flags.
  60. """
  62. filename, ext = os.path.splitext(source)
  63. compiler = COMPILERS.get(ext, None)
  64. if compiler is None:
  65. print(source, 'has no known compiler')
  66. return
  68. if target_dir is None:
  69. target_dir = os.path.dirname(source)
  71. target = os.path.join(target_dir, os.path.basename(source) + '.o')
  72. env = dict(source=source, target=target, arch=arch, clock=clock, env_version=ENV_VERSION, compiler=compiler, avr_path=avr_path)
  74. # create include list, don't use set() because order matters
  75. dirs = [os.path.dirname(source)]
  76. for d in include_dirs:
  77. if d not in dirs:
  78. dirs.append(d)
  80. env['include_dirs'] = ' '.join('-I%s' % d for d in dirs)
  81. if verbose:
  82. env['verbose'] = '-v'
  83. else:
  84. env['verbose'] = ''
  85. cmdline = '%(avr_path)s%(compiler)s -c %(verbose)s -g -Os -w -ffunction-sections -fdata-sections -mmcu=%(arch)s -DF_CPU=%(clock)dL -DARDUINO=%(env_version)d %(include_dirs)s %(source)s -o%(target)s' % env
  86. _exec(cmdline, simulate=simulate)
  87. return target
  90. def compile_directory(directory, target_dir=None, include_dirs=[], avr_path='', arch=ARCH, clock=CPU_CLOCK, verbose=False, simulate=False):
  91. """
  92. compile all source files in a given directory, return a list of all .obj files created
  93. """
  95. obj_files = []
  96. for fname in os.listdir(directory):
  97. if os.path.isfile(os.path.join(directory, fname)):
  98. obj_files.append(compile_source(os.path.join(directory, fname), include_dirs=include_dirs, avr_path=avr_path, target_dir=target_dir, arch=arch, clock=clock, verbose=verbose, simulate=simulate))
  100. return filter(lambda o: o, obj_files)
  103. def append_to_archive(obj_file, archive, avr_path='', verbose=False, simulate=False):
  104. """
  105. create an .a archive out of .obj files
  106. """
  108. env = dict(obj_file=obj_file, archive=archive, avr_path=avr_path)
  109. if verbose:
  110. env['verbose'] = 'v'
  111. else:
  112. env['verbose'] = ''
  113. cmdline = '%(avr_path)savr-ar rcs%(verbose)s %(archive)s %(obj_file)s' % env
  114. _exec(cmdline, simulate=simulate)
  117. def link(target, files, arch=ARCH, avr_path='', verbose=False, simulate=False):
  118. """
  119. link .obj files to a single .elf file
  120. """
  122. env = dict(target=target, files=' '.join(files), link_dir=os.path.dirname(target), arch=arch, avr_path=avr_path)
  123. if verbose:
  124. env['verbose'] = '-v'
  125. else:
  126. env['verbose'] = ''
  127. cmdline = '%(avr_path)savr-gcc %(verbose)s -Os -Wl,--gc-sections -mmcu=%(arch)s -o %(target)s %(files)s -L%(link_dir)s -lm' % env
  128. _exec(cmdline, simulate=simulate)
  131. def make_hex(elf, avr_path='', verbose=False, simulate=False):
  132. """
  133. slice elf to .hex (program) end .eep (EEProm) files
  134. """
  136. eeprom_section = os.path.splitext(elf)[0] + '.epp'
  137. hex_section = os.path.splitext(elf)[0] + '.hex'
  138. env = dict(elf=elf, eeprom_section=eeprom_section, hex_section=hex_section, avr_path=avr_path)
  139. if verbose:
  140. env['verbose'] = '-v'
  141. else:
  142. env['verbose'] = ''
  143. cmdline_make_eeprom = '%(avr_path)savr-objcopy %(verbose)s -O ihex -j .eeprom --set-section-flags=.eeprom=alloc,load --no-change-warnings --change-section-lma .eeprom=0 %(elf)s %(eeprom_section)s' % env
  144. _exec(cmdline_make_eeprom, simulate=simulate)
  145. cmdline_make_hex = '%(avr_path)savr-objcopy %(verbose)s -O ihex -R .eeprom %(elf)s %(hex_section)s' % env
  146. _exec(cmdline_make_hex, simulate=simulate)
  147. return hex_section, eeprom_section
  150. def upload(hex_section, dev, avr_path='', dude_conf=None, arch=ARCH, core=CORE, baud=BAUD, verbose=False, simulate=False):
  151. """
  152. Upload .hex file to arduino board
  153. """
  155. env = dict(hex_section=hex_section, dev=dev, arch=arch, core=core, baud=baud, avr_path=avr_path)
  156. if verbose:
  157. env['verbose'] = '-v'
  158. else:
  159. env['verbose'] = ''
  160. if dude_conf is not None:
  161. env['dude_conf'] = '-C' + dude_conf
  162. else:
  163. env['dude_conf'] = ''
  164. cmdline = '%(avr_path)savrdude %(verbose)s %(dude_conf)s -p%(arch)s -c%(core)s -P%(dev)s -b%(baud)d -D -Uflash:w:%(hex_section)s:i' % env
  165. _exec(cmdline, simulate=simulate)
  168. def main(argv):
  169. parser = optparse.OptionParser()
  170. parser.add_option('-d', '--directory', dest='directory', default='.', help='project directory')
  171. parser.add_option('-v', '--verbose', dest='verbose', default=False, action='store_true', help='be verbose')
  172. parser.add_option('--only-build', dest='only_build', default=False, action='store_true', help="only build, don't upload")
  173. parser.add_option('-u', '--upload-device', dest='upload_device', metavar='DEVICE', help='use DEVICE to upload code')
  174. parser.add_option('-i', '--include', dest='include_dirs', default=[], action='append', metavar='DIRECTORY', help='append DIRECTORY to include list')
  175. parser.add_option('-l', '--libraries', dest='libraries', default=[], action='append', metavar='DIRECTORY', help='append DIRECTORY to libraries search & build path')
  176. parser.add_option('-W', '--WProgram-dir', dest='wprogram_directory', metavar='DIRECTORY', help='DIRECTORY of Arduino.h and the rest of core files')
  177. parser.add_option('--avr-path', dest='avr_path', metavar='DIRECTORY', help='DIRECTORY where avr* programs located, if not specified - will assume found in default search path')
  178. parser.add_option('--dude-conf', dest='dude_conf', default=None, metavar='FILE', help='avrdude conf file, if not specified - will assume found in default location')
  179. parser.add_option('--simulate', dest='simulate', default=False, action='store_true', help='only simulate commands')
  180. parser.add_option('--core', dest='core', default=CORE, help='device core name [%s]' % CORE)
  181. parser.add_option('--arch', dest='arch', default=ARCH, help='device architecture name [%s]' % ARCH)
  182. parser.add_option('--baud', dest='baud', default=BAUD, type='int', help='upload baud rate [%d]' % BAUD)
  183. parser.add_option('--cpu-clock', dest='cpu_clock', default=CPU_CLOCK, metavar='Hz', action='store', type='int', help='target device CPU clock [%d]' % CPU_CLOCK)
  185. options, args = parser.parse_args(argv)
  187. if options.wprogram_directory is None or not os.path.exists(options.wprogram_directory) or not os.path.isdir(options.wprogram_directory):
  188. if options.verbose:
  189. print('WProgram directory was not specified or does not exist [%s]' % options.wprogram_directory)
  190. sys.exit(EXITCODE_NO_WPROGRAM)
  192. core_files = options.wprogram_directory
  194. if options.avr_path is not None:
  195. if not os.path.exists(options.avr_path) or not os.path.isdir(options.avr_path):
  196. if options.verbose:
  197. print('avr-path was specified but does not exist or not a directory [%s]' % options.avr_path)
  198. sys.exit(EXITCODE_INVALID_AVR_PATH)
  199. avr_path = os.path.join(options.avr_path, '')
  200. else:
  201. avr_path = ''
  203. # create build directory to store the compilation output files
  204. build_directory = os.path.join(options.directory, '_build')
  205. if not os.path.exists(build_directory):
  206. os.makedirs(build_directory)
  208. # compile arduino core files
  209. core_obj_files = compile_directory(core_files, build_directory, include_dirs=[core_files], avr_path=avr_path, arch=options.arch, clock=options.cpu_clock, verbose=options.verbose, simulate=options.simulate)
  211. # compile directories passed to program
  212. libraries_obj_files = []
  213. for library in options.libraries:
  214. libraries_obj_files.extend(compile_directory(library, build_directory, include_dirs=options.libraries + [core_files], avr_path=avr_path, arch=options.arch, clock=options.cpu_clock, verbose=options.verbose, simulate=options.simulate))
  216. # compile project
  217. project_obj_files = compile_directory(options.directory, build_directory, include_dirs=(options.include_dirs + options.libraries + [core_files]), avr_path=avr_path, arch=options.arch, clock=options.cpu_clock, verbose=options.verbose, simulate=options.simulate)
  219. # link project, libraries and core .obj files to a single .elf
  220. link_output = os.path.join(build_directory, os.path.basename(options.directory) + '.elf')
  221. link(link_output, project_obj_files + libraries_obj_files + core_obj_files, avr_path=avr_path, verbose=options.verbose, simulate=options.simulate)
  223. hex_section, eeprom_section = make_hex(link_output, avr_path=avr_path, verbose=options.verbose, simulate=options.simulate)
  225. # upload .hex file to arduino if needed
  226. if not options.only_build:
  227. if options.upload_device is None:
  228. if options.verbose:
  229. print('no upload device selected')
  230. sys.exit(EXITCODE_NO_UPLOAD_DEVICE)
  231. upload(hex_section, dev=options.upload_device, dude_conf=options.dude_conf, avr_path=avr_path, arch=options.arch, core=options.core, baud=options.baud, verbose=options.verbose, simulate=options.simulate)
  234. if __name__ == '__main__':
  235. main(sys.argv)
[Get Code]