|
| 1 | +#!/usr/bin/env python |
| 2 | +# -*- coding: utf-8 -*- |
| 3 | +# |
| 4 | +# build.py — build a sketch using arduino-builder |
| 5 | +# |
| 6 | +# Wrapper script around arduino-builder which accepts some ESP8266-specific |
| 7 | +# options and translates them into FQBN |
| 8 | +# |
| 9 | +# Copyright © 2016 Ivan Grokhotkov |
| 10 | +# |
| 11 | +# Permission is hereby granted, free of charge, to any person obtaining a copy |
| 12 | +# of this software and associated documentation files (the "Software"), to deal |
| 13 | +# in the Software without restriction, including without limitation the rights |
| 14 | +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 15 | +# copies of the Software, and to permit persons to whom the Software is |
| 16 | +# furnished to do so, subject to the following conditions: |
| 17 | +# |
| 18 | +# The above copyright notice and this permission notice shall be included in |
| 19 | +# all copies or substantial portions of the Software. |
| 20 | +# |
| 21 | +# |
| 22 | + |
| 23 | + |
| 24 | +from __future__ import print_function |
| 25 | +import sys |
| 26 | +import os |
| 27 | +import argparse |
| 28 | +import subprocess |
| 29 | +import tempfile |
| 30 | +import shutil |
| 31 | + |
| 32 | +def compile(tmp_dir, sketch, tools_dir, hardware_dir, ide_path, f, args): |
| 33 | + cmd = ide_path + '/arduino-builder ' |
| 34 | + cmd += '-compile -logger=human ' |
| 35 | + cmd += '-build-path "' + tmp_dir + '" ' |
| 36 | + cmd += '-tools "' + ide_path + '/tools-builder" ' |
| 37 | + if args.library_path: |
| 38 | + for lib_dir in args.library_path: |
| 39 | + cmd += '-libraries "' + lib_dir + '" ' |
| 40 | + cmd += '-hardware "' + ide_path + '/hardware" ' |
| 41 | + if args.hardware_dir: |
| 42 | + for hw_dir in args.hardware_dir: |
| 43 | + cmd += '-hardware "' + hw_dir + '" ' |
| 44 | + else: |
| 45 | + cmd += '-hardware "' + hardware_dir + '" ' |
| 46 | + # Debug=Serial,DebugLevel=Core____ |
| 47 | + cmd += '-fqbn=espressif:esp32:{board_name}:' \ |
| 48 | + 'FlashFreq={flash_freq},' \ |
| 49 | + 'PartitionScheme=huge_app,' \ |
| 50 | + 'UploadSpeed=921600'.format(**vars(args)) |
| 51 | + cmd += ' ' |
| 52 | + cmd += '-ide-version=10607 ' |
| 53 | + cmd += '-warnings={warnings} '.format(**vars(args)) |
| 54 | + if args.verbose: |
| 55 | + cmd += '-verbose ' |
| 56 | + cmd += sketch |
| 57 | + |
| 58 | + if args.verbose: |
| 59 | + print('Building: ' + cmd, file=f) |
| 60 | + |
| 61 | + cmds = cmd.split(' ') |
| 62 | + p = subprocess.Popen(cmds, stdout=f, stderr=subprocess.STDOUT) |
| 63 | + p.wait() |
| 64 | + return p.returncode |
| 65 | + |
| 66 | +def parse_args(): |
| 67 | + parser = argparse.ArgumentParser(description='Sketch build helper') |
| 68 | + parser.add_argument('-v', '--verbose', help='Enable verbose output', |
| 69 | + action='store_true') |
| 70 | + parser.add_argument('-i', '--ide_path', help='Arduino IDE path') |
| 71 | + parser.add_argument('-p', '--build_path', help='Build directory') |
| 72 | + parser.add_argument('-l', '--library_path', help='Additional library path', |
| 73 | + action='append') |
| 74 | + parser.add_argument('-d', '--hardware_dir', help='Additional hardware path', |
| 75 | + action='append') |
| 76 | + parser.add_argument('-b', '--board_name', help='Board name', default='esp32') |
| 77 | + parser.add_argument('-w', '--warnings', help='Compilation warnings level', |
| 78 | + default='none', choices=['none', 'all', 'more']) |
| 79 | + parser.add_argument('-o', '--output_binary', help='File name for output binary') |
| 80 | + parser.add_argument('-k', '--keep', action='store_true', |
| 81 | + help='Don\'t delete temporary build directory') |
| 82 | + parser.add_argument('--flash_freq', help='Flash frequency', default=40, |
| 83 | + type=int, choices=[40, 80]) |
| 84 | + parser.add_argument('sketch_path', help='Sketch file path') |
| 85 | + return parser.parse_args() |
| 86 | + |
| 87 | +def main(): |
| 88 | + args = parse_args() |
| 89 | + |
| 90 | + ide_path = args.ide_path |
| 91 | + if not ide_path: |
| 92 | + ide_path = os.environ.get('ARDUINO_IDE_PATH') |
| 93 | + if not ide_path: |
| 94 | + print("Please specify Arduino IDE path via --ide_path option" |
| 95 | + "or ARDUINO_IDE_PATH environment variable.", file=sys.stderr) |
| 96 | + return 2 |
| 97 | + |
| 98 | + sketch_path = args.sketch_path |
| 99 | + tmp_dir = args.build_path |
| 100 | + created_tmp_dir = False |
| 101 | + if not tmp_dir: |
| 102 | + tmp_dir = tempfile.mkdtemp() |
| 103 | + created_tmp_dir = True |
| 104 | + |
| 105 | + tools_dir = os.path.dirname(os.path.realpath(__file__)) + '/../tools' |
| 106 | + # this is not the correct hardware folder to add. |
| 107 | + hardware_dir = ide_path + '/hardware' |
| 108 | + |
| 109 | + output_name = tmp_dir + '/' + os.path.basename(sketch_path) + '.bin' |
| 110 | + if args.verbose: |
| 111 | + print("Sketch: ", sketch_path) |
| 112 | + print("Build dir: ", tmp_dir) |
| 113 | + print("Output: ", output_name) |
| 114 | + |
| 115 | + if args.verbose: |
| 116 | + f = sys.stdout |
| 117 | + else: |
| 118 | + f = open(tmp_dir + '/build.log', 'w') |
| 119 | + |
| 120 | + res = compile(tmp_dir, sketch_path, tools_dir, hardware_dir, ide_path, f, args) |
| 121 | + if res != 0: |
| 122 | + return res |
| 123 | + |
| 124 | + if args.output_binary is not None: |
| 125 | + shutil.copy(output_name, args.output_binary) |
| 126 | + |
| 127 | + if created_tmp_dir and not args.keep: |
| 128 | + shutil.rmtree(tmp_dir, ignore_errors=True) |
| 129 | + |
| 130 | +if __name__ == '__main__': |
| 131 | + sys.exit(main()) |
0 commit comments